spinen/connectwise-service-php-client

Spinen's PHP ConnectWise Client for Service API generated by Swagger Code Generator.

dev-master 2017-09-06 18:29 UTC

Requires

• php: >=5.6
• ext-curl: *
• ext-json: *
• ext-mbstring: *

Requires (Dev)

• friendsofphp/php-cs-fixer: ~1.12
• phpunit/phpunit: ~4.8
• satooshi/php-coveralls: ~1.0
• squizlabs/php_codesniffer: ~2.6

mit

• Spinen
• Swagger and contributors

• api
• client
• sdk
• spinen
• connectwise

README

ConnectWise Service API

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 3.0.0-beta
• Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.6.0 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

composer require spinen/connectwise-service-php-client

Or modify your composer.json file:

{
    "require": {
        "spinen/connectwise-service-php-client": "^3.0.0-beta"
    }
}

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/connectwise-service-php-client/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Service\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Service\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Service\Api\BoardExcludedMembersApi();
$id = 56; // int | 
$conditions = "conditions_example"; // string | 

try {
    $result = $api_instance->serviceBoardsIdExcludedMembersCountGet($id, $conditions);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardExcludedMembersApi->serviceBoardsIdExcludedMembersCountGet: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api-na.myconnectwise.net/v4_6_release/apis/3.0

Class	Method	HTTP request	Description
BoardExcludedMembersApi	serviceBoardsIdExcludedMembersCountGet	GET /service/boards/{id}/excludedMembers/count
BoardExcludedMembersApi	serviceBoardsIdExcludedMembersExcludedMemberIdDelete	DELETE /service/boards/{id}/excludedMembers/{excludedMemberId}
BoardExcludedMembersApi	serviceBoardsIdExcludedMembersExcludedMemberIdGet	GET /service/boards/{id}/excludedMembers/{excludedMemberId}
BoardExcludedMembersApi	serviceBoardsIdExcludedMembersGet	GET /service/boards/{id}/excludedMembers
BoardExcludedMembersApi	serviceBoardsIdExcludedMembersPost	POST /service/boards/{id}/excludedMembers
BoardItemsApi	serviceBoardsIdItemsCountGet	GET /service/boards/{id}/items/count
BoardItemsApi	serviceBoardsIdItemsGet	GET /service/boards/{id}/items
BoardItemsApi	serviceBoardsIdItemsItemIdDelete	DELETE /service/boards/{id}/items/{itemId}
BoardItemsApi	serviceBoardsIdItemsItemIdGet	GET /service/boards/{id}/items/{itemId}
BoardItemsApi	serviceBoardsIdItemsItemIdPatch	PATCH /service/boards/{id}/items/{itemId}
BoardItemsApi	serviceBoardsIdItemsItemIdPut	PUT /service/boards/{id}/items/{itemId}
BoardItemsApi	serviceBoardsIdItemsPost	POST /service/boards/{id}/items
BoardStatusesApi	serviceBoardsIdStatusesCountGet	GET /service/boards/{id}/statuses/count
BoardStatusesApi	serviceBoardsIdStatusesGet	GET /service/boards/{id}/statuses
BoardStatusesApi	serviceBoardsIdStatusesPost	POST /service/boards/{id}/statuses
BoardStatusesApi	serviceBoardsIdStatusesStatusIdDelete	DELETE /service/boards/{id}/statuses/{statusId}
BoardStatusesApi	serviceBoardsIdStatusesStatusIdGet	GET /service/boards/{id}/statuses/{statusId}
BoardStatusesApi	serviceBoardsIdStatusesStatusIdPatch	PATCH /service/boards/{id}/statuses/{statusId}
BoardStatusesApi	serviceBoardsIdStatusesStatusIdPut	PUT /service/boards/{id}/statuses/{statusId}
BoardSubTypesApi	serviceBoardsIdSubtypesCountGet	GET /service/boards/{id}/subtypes/count
BoardSubTypesApi	serviceBoardsIdSubtypesGet	GET /service/boards/{id}/subtypes
BoardSubTypesApi	serviceBoardsIdSubtypesPost	POST /service/boards/{id}/subtypes
BoardSubTypesApi	serviceBoardsIdSubtypesSubtypeIdDelete	DELETE /service/boards/{id}/subtypes/{subtypeId}
BoardSubTypesApi	serviceBoardsIdSubtypesSubtypeIdGet	GET /service/boards/{id}/subtypes/{subtypeId}
BoardSubTypesApi	serviceBoardsIdSubtypesSubtypeIdPatch	PATCH /service/boards/{id}/subtypes/{subtypeId}
BoardSubTypesApi	serviceBoardsIdSubtypesSubtypeIdPut	PUT /service/boards/{id}/subtypes/{subtypeId}
BoardSubtypeAssociationsApi	serviceBoardsBoardIdSubTypesSubtypeIdAssociationsAssociationIdDelete	DELETE /service/boards/{boardId}/subTypes/{subtypeId}/associations/{associationId}
BoardSubtypeAssociationsApi	serviceBoardsBoardIdSubTypesSubtypeIdAssociationsAssociationIdGet	GET /service/boards/{boardId}/subTypes/{subtypeId}/associations/{associationId}
BoardSubtypeAssociationsApi	serviceBoardsBoardIdSubTypesSubtypeIdAssociationsCountGet	GET /service/boards/{boardId}/subTypes/{subtypeId}/associations/count
BoardSubtypeAssociationsApi	serviceBoardsBoardIdSubTypesSubtypeIdAssociationsGet	GET /service/boards/{boardId}/subTypes/{subtypeId}/associations
BoardSubtypeAssociationsApi	serviceBoardsBoardIdSubTypesSubtypeIdAssociationsPost	POST /service/boards/{boardId}/subTypes/{subtypeId}/associations
BoardTeamsApi	serviceBoardsIdTeamsCountGet	GET /service/boards/{id}/teams/count
BoardTeamsApi	serviceBoardsIdTeamsGet	GET /service/boards/{id}/teams
BoardTeamsApi	serviceBoardsIdTeamsPost	POST /service/boards/{id}/teams
BoardTeamsApi	serviceBoardsIdTeamsTeamIdDelete	DELETE /service/boards/{id}/teams/{teamId}
BoardTeamsApi	serviceBoardsIdTeamsTeamIdGet	GET /service/boards/{id}/teams/{teamId}
BoardTeamsApi	serviceBoardsIdTeamsTeamIdPatch	PATCH /service/boards/{id}/teams/{teamId}
BoardTeamsApi	serviceBoardsIdTeamsTeamIdPut	PUT /service/boards/{id}/teams/{teamId}
BoardTypesApi	serviceBoardsIdTypesCountGet	GET /service/boards/{id}/types/count
BoardTypesApi	serviceBoardsIdTypesGet	GET /service/boards/{id}/types
BoardTypesApi	serviceBoardsIdTypesPost	POST /service/boards/{id}/types
BoardTypesApi	serviceBoardsIdTypesTypeIdDelete	DELETE /service/boards/{id}/types/{typeId}
BoardTypesApi	serviceBoardsIdTypesTypeIdGet	GET /service/boards/{id}/types/{typeId}
BoardTypesApi	serviceBoardsIdTypesTypeIdPatch	PATCH /service/boards/{id}/types/{typeId}
BoardTypesApi	serviceBoardsIdTypesTypeIdPut	PUT /service/boards/{id}/types/{typeId}
BoardTypesApi	serviceBoardsIdTypesTypeIdSubTypeAssociationGet	GET /service/boards/{id}/types/{typeId}/subTypeAssociation
BoardsApi	serviceBoardsCountGet	GET /service/boards/count
BoardsApi	serviceBoardsGet	GET /service/boards
BoardsApi	serviceBoardsIdDelete	DELETE /service/boards/{id}
BoardsApi	serviceBoardsIdGet	GET /service/boards/{id}
BoardsApi	serviceBoardsIdPatch	PATCH /service/boards/{id}
BoardsApi	serviceBoardsIdPut	PUT /service/boards/{id}
BoardsApi	serviceBoardsPost	POST /service/boards
CodesApi	serviceCodesCountGet	GET /service/codes/count
CodesApi	serviceCodesGet	GET /service/codes
CodesApi	serviceCodesIdDelete	DELETE /service/codes/{id}
CodesApi	serviceCodesIdGet	GET /service/codes/{id}
CodesApi	serviceCodesIdPatch	PATCH /service/codes/{id}
CodesApi	serviceCodesIdPut	PUT /service/codes/{id}
CodesApi	serviceCodesPost	POST /service/codes
KnowledgeBaseArticlesApi	serviceKnowledgeBaseArticlesCountGet	GET /service/knowledgeBaseArticles/count
KnowledgeBaseArticlesApi	serviceKnowledgeBaseArticlesGet	GET /service/knowledgeBaseArticles
KnowledgeBaseArticlesApi	serviceKnowledgeBaseArticlesIdDelete	DELETE /service/knowledgeBaseArticles/{id}
KnowledgeBaseArticlesApi	serviceKnowledgeBaseArticlesIdGet	GET /service/knowledgeBaseArticles/{id}
KnowledgeBaseArticlesApi	serviceKnowledgeBaseArticlesIdPatch	PATCH /service/knowledgeBaseArticles/{id}
KnowledgeBaseArticlesApi	serviceKnowledgeBaseArticlesIdPut	PUT /service/knowledgeBaseArticles/{id}
KnowledgeBaseArticlesApi	serviceKnowledgeBaseArticlesPost	POST /service/knowledgeBaseArticles
LocationsApi	serviceLocationsCountGet	GET /service/locations/count
LocationsApi	serviceLocationsGet	GET /service/locations
LocationsApi	serviceLocationsIdDelete	DELETE /service/locations/{id}
LocationsApi	serviceLocationsIdGet	GET /service/locations/{id}
LocationsApi	serviceLocationsIdPatch	PATCH /service/locations/{id}
LocationsApi	serviceLocationsIdPut	PUT /service/locations/{id}
LocationsApi	serviceLocationsPost	POST /service/locations
PrioritiesApi	servicePrioritiesCountGet	GET /service/priorities/count
PrioritiesApi	servicePrioritiesGet	GET /service/priorities
PrioritiesApi	servicePrioritiesIdDelete	DELETE /service/priorities/{id}
PrioritiesApi	servicePrioritiesIdGet	GET /service/priorities/{id}
PrioritiesApi	servicePrioritiesIdImageGet	GET /service/priorities/{id}/image
PrioritiesApi	servicePrioritiesIdPatch	PATCH /service/priorities/{id}
PrioritiesApi	servicePrioritiesIdPut	PUT /service/priorities/{id}
PrioritiesApi	servicePrioritiesPost	POST /service/priorities
SourcesApi	serviceSourcesCountGet	GET /service/sources/count
SourcesApi	serviceSourcesGet	GET /service/sources
SourcesApi	serviceSourcesIdDelete	DELETE /service/sources/{id}
SourcesApi	serviceSourcesIdGet	GET /service/sources/{id}
SourcesApi	serviceSourcesIdPatch	PATCH /service/sources/{id}
SourcesApi	serviceSourcesIdPut	PUT /service/sources/{id}
SourcesApi	serviceSourcesPost	POST /service/sources
SurveyQuestionsApi	serviceSurveysIdQuestionsCountGet	GET /service/surveys/{id}/questions/count
SurveyQuestionsApi	serviceSurveysIdQuestionsGet	GET /service/surveys/{id}/questions
SurveyQuestionsApi	serviceSurveysIdQuestionsPost	POST /service/surveys/{id}/questions
SurveyQuestionsApi	serviceSurveysIdQuestionsQuestionIdDelete	DELETE /service/surveys/{id}/questions/{questionId}
SurveyQuestionsApi	serviceSurveysIdQuestionsQuestionIdGet	GET /service/surveys/{id}/questions/{questionId}
SurveyQuestionsApi	serviceSurveysIdQuestionsQuestionIdPatch	PATCH /service/surveys/{id}/questions/{questionId}
SurveyQuestionsApi	serviceSurveysIdQuestionsQuestionIdPut	PUT /service/surveys/{id}/questions/{questionId}
SurveyResultsApi	serviceSurveysIdResultsCountGet	GET /service/surveys/{id}/results/count
SurveyResultsApi	serviceSurveysIdResultsGet	GET /service/surveys/{id}/results
SurveyResultsApi	serviceSurveysIdResultsPost	POST /service/surveys/{id}/results
SurveyResultsApi	serviceSurveysIdResultsResultIdDelete	DELETE /service/surveys/{id}/results/{resultId}
SurveyResultsApi	serviceSurveysIdResultsResultIdGet	GET /service/surveys/{id}/results/{resultId}
SurveyResultsApi	serviceSurveysIdResultsResultIdPatch	PATCH /service/surveys/{id}/results/{resultId}
SurveyResultsApi	serviceSurveysIdResultsResultIdPut	PUT /service/surveys/{id}/results/{resultId}
SurveysApi	serviceSurveysCountGet	GET /service/surveys/count
SurveysApi	serviceSurveysGet	GET /service/surveys
SurveysApi	serviceSurveysIdDelete	DELETE /service/surveys/{id}
SurveysApi	serviceSurveysIdGet	GET /service/surveys/{id}
SurveysApi	serviceSurveysIdPatch	PATCH /service/surveys/{id}
SurveysApi	serviceSurveysIdPut	PUT /service/surveys/{id}
SurveysApi	serviceSurveysPost	POST /service/surveys
TicketNotesApi	serviceTicketsIdNotesCountGet	GET /service/tickets/{id}/notes/count
TicketNotesApi	serviceTicketsIdNotesGet	GET /service/tickets/{id}/notes
TicketNotesApi	serviceTicketsIdNotesNoteIdDelete	DELETE /service/tickets/{id}/notes/{noteId}
TicketNotesApi	serviceTicketsIdNotesNoteIdGet	GET /service/tickets/{id}/notes/{noteId}
TicketNotesApi	serviceTicketsIdNotesNoteIdPatch	PATCH /service/tickets/{id}/notes/{noteId}
TicketNotesApi	serviceTicketsIdNotesNoteIdPut	PUT /service/tickets/{id}/notes/{noteId}
TicketNotesApi	serviceTicketsIdNotesPost	POST /service/tickets/{id}/notes
TicketTasksApi	serviceTicketsIdTasksCountGet	GET /service/tickets/{id}/tasks/count
TicketTasksApi	serviceTicketsIdTasksGet	GET /service/tickets/{id}/tasks
TicketTasksApi	serviceTicketsIdTasksPost	POST /service/tickets/{id}/tasks
TicketTasksApi	serviceTicketsIdTasksTaskIdDelete	DELETE /service/tickets/{id}/tasks/{taskId}
TicketTasksApi	serviceTicketsIdTasksTaskIdGet	GET /service/tickets/{id}/tasks/{taskId}
TicketTasksApi	serviceTicketsIdTasksTaskIdPatch	PATCH /service/tickets/{id}/tasks/{taskId}
TicketTasksApi	serviceTicketsIdTasksTaskIdPut	PUT /service/tickets/{id}/tasks/{taskId}
TicketsApi	serviceTicketsCountGet	GET /service/tickets/count
TicketsApi	serviceTicketsGet	GET /service/tickets
TicketsApi	serviceTicketsIdActivitiesCountGet	GET /service/tickets/{id}/activities/count
TicketsApi	serviceTicketsIdActivitiesGet	GET /service/tickets/{id}/activities
TicketsApi	serviceTicketsIdConfigurationsConfigIdDelete	DELETE /service/tickets/{id}/configurations/{configId}
TicketsApi	serviceTicketsIdConfigurationsConfigIdGet	GET /service/tickets/{id}/configurations/{configId}
TicketsApi	serviceTicketsIdConfigurationsCountGet	GET /service/tickets/{id}/configurations/count
TicketsApi	serviceTicketsIdConfigurationsGet	GET /service/tickets/{id}/configurations
TicketsApi	serviceTicketsIdConfigurationsPost	POST /service/tickets/{id}/configurations
TicketsApi	serviceTicketsIdDelete	DELETE /service/tickets/{id}
TicketsApi	serviceTicketsIdDocumentsCountGet	GET /service/tickets/{id}/documents/count
TicketsApi	serviceTicketsIdDocumentsGet	GET /service/tickets/{id}/documents
TicketsApi	serviceTicketsIdGet	GET /service/tickets/{id}
TicketsApi	serviceTicketsIdMergePost	POST /service/tickets/{id}/merge
TicketsApi	serviceTicketsIdPatch	PATCH /service/tickets/{id}
TicketsApi	serviceTicketsIdProductsCountGet	GET /service/tickets/{id}/products/count
TicketsApi	serviceTicketsIdProductsGet	GET /service/tickets/{id}/products
TicketsApi	serviceTicketsIdPut	PUT /service/tickets/{id}
TicketsApi	serviceTicketsIdScheduleentriesCountGet	GET /service/tickets/{id}/scheduleentries/count
TicketsApi	serviceTicketsIdScheduleentriesGet	GET /service/tickets/{id}/scheduleentries
TicketsApi	serviceTicketsIdTimeentriesCountGet	GET /service/tickets/{id}/timeentries/count
TicketsApi	serviceTicketsIdTimeentriesGet	GET /service/tickets/{id}/timeentries
TicketsApi	serviceTicketsPost	POST /service/tickets
TicketsApi	serviceTicketsSearchPost	POST /service/tickets/search

Documentation For Models

• ActivityReference
• AgreementReference
• Board
• BoardReference
• Code
• CompanyReference
• ConfigurationReference
• ContactReference
• Count
• CountryReference
• CustomFieldValue
• DocumentReference
• Error
• ExcludedMember
• FilterValues
• GenericIdIdentifierReference
• Guid
• Item
• KnowledgeBaseArticle
• Location
• MemberReference
• Metadata
• OpportunityReference
• PatchOperation
• Priority
• PriorityReference
• ProductReference
• ProjectPhaseReference
• ProjectReference
• SLAReference
• ScheduleEntryReference
• ServiceCodeReference
• ServiceItemReference
• ServiceLocationReference
• ServiceNote
• ServiceSignoffReference
• ServiceSourceReference
• ServiceStatusReference
• ServiceSubTypeReference
• ServiceTeamReference
• ServiceTypeReference
• SiteReference
• Source
• Status
• SubType
• SubtypeAssociation
• SuccessResponse
• Survey
• SurveyQuestion
• SurveyQuestionOption
• SurveyResult
• SurveyResultDetail
• Task
• Team
• Ticket
• TicketMerge
• TimeEntryReference
• Type
• TypeAssociations
• ValidationError

Documentation For Authorization

BasicAuth

• Type: HTTP basic authentication