spinen/connectwise-company-php-client

Spinen's PHP ConnectWise Client for Company 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 Company 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-company-php-client

Or modify your composer.json file:

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

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/connectwise-company-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\Company\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Company\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Company\Api\CompaniesApi();
$conditions = "conditions_example"; // string | 
$custom_field_conditions = "custom_field_conditions_example"; // string | 

try {
    $result = $api_instance->companyCompaniesCountGet($conditions, $custom_field_conditions);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompaniesApi->companyCompaniesCountGet: ', $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
CompaniesApi	companyCompaniesCountGet	GET /company/companies/count
CompaniesApi	companyCompaniesGet	GET /company/companies
CompaniesApi	companyCompaniesIdDelete	DELETE /company/companies/{id}
CompaniesApi	companyCompaniesIdGet	GET /company/companies/{id}
CompaniesApi	companyCompaniesIdMergePost	POST /company/companies/{id}/merge
CompaniesApi	companyCompaniesIdPatch	PATCH /company/companies/{id}
CompaniesApi	companyCompaniesIdPut	PUT /company/companies/{id}
CompaniesApi	companyCompaniesPost	POST /company/companies
CompanyCustomNotesApi	companyCompaniesIdCustomStatusNotesCountGet	GET /company/companies/{id}/customStatusNotes/count
CompanyCustomNotesApi	companyCompaniesIdCustomStatusNotesCustomNoteIdDelete	DELETE /company/companies/{id}/customStatusNotes/{customNoteId}
CompanyCustomNotesApi	companyCompaniesIdCustomStatusNotesCustomNoteIdGet	GET /company/companies/{id}/customStatusNotes/{customNoteId}
CompanyCustomNotesApi	companyCompaniesIdCustomStatusNotesCustomNoteIdPatch	PATCH /company/companies/{id}/customStatusNotes/{customNoteId}
CompanyCustomNotesApi	companyCompaniesIdCustomStatusNotesCustomNoteIdPut	PUT /company/companies/{id}/customStatusNotes/{customNoteId}
CompanyCustomNotesApi	companyCompaniesIdCustomStatusNotesGet	GET /company/companies/{id}/customStatusNotes
CompanyCustomNotesApi	companyCompaniesIdCustomStatusNotesPost	POST /company/companies/{id}/customStatusNotes
CompanyManagementSummaryReportsApi	companyCompaniesIdManagementSummaryReportsCountGet	GET /company/companies/{id}/managementSummaryReports/count
CompanyManagementSummaryReportsApi	companyCompaniesIdManagementSummaryReportsGet	GET /company/companies/{id}/managementSummaryReports
CompanyManagementSummaryReportsApi	companyCompaniesIdManagementSummaryReportsPost	POST /company/companies/{id}/managementSummaryReports
CompanyManagementSummaryReportsApi	companyCompaniesIdManagementSummaryReportsReportIdDelete	DELETE /company/companies/{id}/managementSummaryReports/{reportId}
CompanyManagementSummaryReportsApi	companyCompaniesIdManagementSummaryReportsReportIdGet	GET /company/companies/{id}/managementSummaryReports/{reportId}
CompanyManagementSummaryReportsApi	companyCompaniesIdManagementSummaryReportsReportIdPatch	PATCH /company/companies/{id}/managementSummaryReports/{reportId}
CompanyManagementSummaryReportsApi	companyCompaniesIdManagementSummaryReportsReportIdPut	PUT /company/companies/{id}/managementSummaryReports/{reportId}
CompanyNoteTypesApi	companyNoteTypesCountGet	GET /company/noteTypes/count
CompanyNoteTypesApi	companyNoteTypesGet	GET /company/noteTypes
CompanyNoteTypesApi	companyNoteTypesIdDelete	DELETE /company/noteTypes/{id}
CompanyNoteTypesApi	companyNoteTypesIdGet	GET /company/noteTypes/{id}
CompanyNoteTypesApi	companyNoteTypesIdPatch	PATCH /company/noteTypes/{id}
CompanyNoteTypesApi	companyNoteTypesIdPut	PUT /company/noteTypes/{id}
CompanyNoteTypesApi	companyNoteTypesPost	POST /company/noteTypes
CompanyNotesApi	companyCompaniesIdNotesCountGet	GET /company/companies/{id}/notes/count
CompanyNotesApi	companyCompaniesIdNotesGet	GET /company/companies/{id}/notes
CompanyNotesApi	companyCompaniesIdNotesNoteIdDelete	DELETE /company/companies/{id}/notes/{noteId}
CompanyNotesApi	companyCompaniesIdNotesNoteIdGet	GET /company/companies/{id}/notes/{noteId}
CompanyNotesApi	companyCompaniesIdNotesNoteIdPatch	PATCH /company/companies/{id}/notes/{noteId}
CompanyNotesApi	companyCompaniesIdNotesNoteIdPut	PUT /company/companies/{id}/notes/{noteId}
CompanyNotesApi	companyCompaniesIdNotesPost	POST /company/companies/{id}/notes
CompanySitesApi	companyCompaniesIdSitesCountGet	GET /company/companies/{id}/sites/count
CompanySitesApi	companyCompaniesIdSitesGet	GET /company/companies/{id}/sites
CompanySitesApi	companyCompaniesIdSitesPost	POST /company/companies/{id}/sites
CompanySitesApi	companyCompaniesIdSitesSiteIdDelete	DELETE /company/companies/{id}/sites/{siteId}
CompanySitesApi	companyCompaniesIdSitesSiteIdGet	GET /company/companies/{id}/sites/{siteId}
CompanySitesApi	companyCompaniesIdSitesSiteIdPatch	PATCH /company/companies/{id}/sites/{siteId}
CompanySitesApi	companyCompaniesIdSitesSiteIdPut	PUT /company/companies/{id}/sites/{siteId}
CompanyStatusesApi	companyCompaniesStatusesCountGet	GET /company/companies/statuses/count
CompanyStatusesApi	companyCompaniesStatusesGet	GET /company/companies/statuses
CompanyStatusesApi	companyCompaniesStatusesIdDelete	DELETE /company/companies/statuses/{id}
CompanyStatusesApi	companyCompaniesStatusesIdGet	GET /company/companies/statuses/{id}
CompanyStatusesApi	companyCompaniesStatusesIdPatch	PATCH /company/companies/statuses/{id}
CompanyStatusesApi	companyCompaniesStatusesIdPut	PUT /company/companies/statuses/{id}
CompanyStatusesApi	companyCompaniesStatusesPost	POST /company/companies/statuses
CompanyTeamsApi	companyCompaniesIdTeamsCountGet	GET /company/companies/{id}/teams/count
CompanyTeamsApi	companyCompaniesIdTeamsGet	GET /company/companies/{id}/teams
CompanyTeamsApi	companyCompaniesIdTeamsPost	POST /company/companies/{id}/teams
CompanyTeamsApi	companyCompaniesIdTeamsTeamIdDelete	DELETE /company/companies/{id}/teams/{teamId}
CompanyTeamsApi	companyCompaniesIdTeamsTeamIdGet	GET /company/companies/{id}/teams/{teamId}
CompanyTeamsApi	companyCompaniesIdTeamsTeamIdPatch	PATCH /company/companies/{id}/teams/{teamId}
CompanyTeamsApi	companyCompaniesIdTeamsTeamIdPut	PUT /company/companies/{id}/teams/{teamId}
CompanyTypesApi	companyCompaniesTypesCountGet	GET /company/companies/types/count
CompanyTypesApi	companyCompaniesTypesGet	GET /company/companies/types
CompanyTypesApi	companyCompaniesTypesIdDelete	DELETE /company/companies/types/{id}
CompanyTypesApi	companyCompaniesTypesIdGet	GET /company/companies/types/{id}
CompanyTypesApi	companyCompaniesTypesIdPatch	PATCH /company/companies/types/{id}
CompanyTypesApi	companyCompaniesTypesIdPut	PUT /company/companies/types/{id}
CompanyTypesApi	companyCompaniesTypesPost	POST /company/companies/types
ConfigurationStatusesApi	companyConfigurationsStatusesCountGet	GET /company/configurations/statuses/count
ConfigurationStatusesApi	companyConfigurationsStatusesGet	GET /company/configurations/statuses
ConfigurationStatusesApi	companyConfigurationsStatusesIdDelete	DELETE /company/configurations/statuses/{id}
ConfigurationStatusesApi	companyConfigurationsStatusesIdGet	GET /company/configurations/statuses/{id}
ConfigurationStatusesApi	companyConfigurationsStatusesIdPatch	PATCH /company/configurations/statuses/{id}
ConfigurationStatusesApi	companyConfigurationsStatusesIdPut	PUT /company/configurations/statuses/{id}
ConfigurationStatusesApi	companyConfigurationsStatusesPost	POST /company/configurations/statuses
ConfigurationTypeQuestionsApi	companyConfigurationsTypesIdQuestionsCountGet	GET /company/configurations/types/{id}/questions/count
ConfigurationTypeQuestionsApi	companyConfigurationsTypesIdQuestionsGet	GET /company/configurations/types/{id}/questions
ConfigurationTypeQuestionsApi	companyConfigurationsTypesIdQuestionsPost	POST /company/configurations/types/{id}/questions
ConfigurationTypeQuestionsApi	companyConfigurationsTypesIdQuestionsQuestionIdDelete	DELETE /company/configurations/types/{id}/questions/{questionId}
ConfigurationTypeQuestionsApi	companyConfigurationsTypesIdQuestionsQuestionIdGet	GET /company/configurations/types/{id}/questions/{questionId}
ConfigurationTypeQuestionsApi	companyConfigurationsTypesIdQuestionsQuestionIdPatch	PATCH /company/configurations/types/{id}/questions/{questionId}
ConfigurationTypeQuestionsApi	companyConfigurationsTypesIdQuestionsQuestionIdPut	PUT /company/configurations/types/{id}/questions/{questionId}
ConfigurationTypesApi	companyConfigurationsTypesCountGet	GET /company/configurations/types/count
ConfigurationTypesApi	companyConfigurationsTypesGet	GET /company/configurations/types
ConfigurationTypesApi	companyConfigurationsTypesIdDelete	DELETE /company/configurations/types/{id}
ConfigurationTypesApi	companyConfigurationsTypesIdGet	GET /company/configurations/types/{id}
ConfigurationTypesApi	companyConfigurationsTypesIdPatch	PATCH /company/configurations/types/{id}
ConfigurationTypesApi	companyConfigurationsTypesIdPut	PUT /company/configurations/types/{id}
ConfigurationTypesApi	companyConfigurationsTypesPost	POST /company/configurations/types
ConfigurationsApi	companyConfigurationsCountGet	GET /company/configurations/count
ConfigurationsApi	companyConfigurationsGet	GET /company/configurations
ConfigurationsApi	companyConfigurationsIdDelete	DELETE /company/configurations/{id}
ConfigurationsApi	companyConfigurationsIdGet	GET /company/configurations/{id}
ConfigurationsApi	companyConfigurationsIdPatch	PATCH /company/configurations/{id}
ConfigurationsApi	companyConfigurationsIdPut	PUT /company/configurations/{id}
ConfigurationsApi	companyConfigurationsPost	POST /company/configurations
ContactCommunicationsApi	companyContactsIdCommunicationsCommunicationIdDelete	DELETE /company/contacts/{id}/communications/{communicationId}
ContactCommunicationsApi	companyContactsIdCommunicationsCommunicationIdGet	GET /company/contacts/{id}/communications/{communicationId}
ContactCommunicationsApi	companyContactsIdCommunicationsCommunicationIdPatch	PATCH /company/contacts/{id}/communications/{communicationId}
ContactCommunicationsApi	companyContactsIdCommunicationsCommunicationIdPut	PUT /company/contacts/{id}/communications/{communicationId}
ContactCommunicationsApi	companyContactsIdCommunicationsCountGet	GET /company/contacts/{id}/communications/count
ContactCommunicationsApi	companyContactsIdCommunicationsGet	GET /company/contacts/{id}/communications
ContactCommunicationsApi	companyContactsIdCommunicationsPost	POST /company/contacts/{id}/communications
ContactDepartmentsApi	companyContactsDepartmentsCountGet	GET /company/contacts/departments/count
ContactDepartmentsApi	companyContactsDepartmentsGet	GET /company/contacts/departments
ContactDepartmentsApi	companyContactsDepartmentsIdDelete	DELETE /company/contacts/departments/{id}
ContactDepartmentsApi	companyContactsDepartmentsIdGet	GET /company/contacts/departments/{id}
ContactDepartmentsApi	companyContactsDepartmentsIdPatch	PATCH /company/contacts/departments/{id}
ContactDepartmentsApi	companyContactsDepartmentsIdPut	PUT /company/contacts/departments/{id}
ContactDepartmentsApi	companyContactsDepartmentsPost	POST /company/contacts/departments
ContactNotesApi	companyContactsIdNotesCountGet	GET /company/contacts/{id}/notes/count
ContactNotesApi	companyContactsIdNotesGet	GET /company/contacts/{id}/notes
ContactNotesApi	companyContactsIdNotesNoteIdDelete	DELETE /company/contacts/{id}/notes/{noteId}
ContactNotesApi	companyContactsIdNotesNoteIdGet	GET /company/contacts/{id}/notes/{noteId}
ContactNotesApi	companyContactsIdNotesNoteIdPatch	PATCH /company/contacts/{id}/notes/{noteId}
ContactNotesApi	companyContactsIdNotesNoteIdPut	PUT /company/contacts/{id}/notes/{noteId}
ContactNotesApi	companyContactsIdNotesPost	POST /company/contacts/{id}/notes
ContactRelationshipsApi	companyContactsRelationshipsCountGet	GET /company/contacts/relationships/count
ContactRelationshipsApi	companyContactsRelationshipsGet	GET /company/contacts/relationships
ContactRelationshipsApi	companyContactsRelationshipsIdDelete	DELETE /company/contacts/relationships/{id}
ContactRelationshipsApi	companyContactsRelationshipsIdGet	GET /company/contacts/relationships/{id}
ContactRelationshipsApi	companyContactsRelationshipsIdPatch	PATCH /company/contacts/relationships/{id}
ContactRelationshipsApi	companyContactsRelationshipsIdPut	PUT /company/contacts/relationships/{id}
ContactRelationshipsApi	companyContactsRelationshipsPost	POST /company/contacts/relationships
ContactTracksApi	companyContactsIdTracksCountGet	GET /company/contacts/{id}/tracks/count
ContactTracksApi	companyContactsIdTracksGet	GET /company/contacts/{id}/tracks
ContactTracksApi	companyContactsIdTracksPost	POST /company/contacts/{id}/tracks
ContactTracksApi	companyContactsIdTracksTrackIdDelete	DELETE /company/contacts/{id}/tracks/{trackId}
ContactTracksApi	companyContactsIdTracksTrackIdGet	GET /company/contacts/{id}/tracks/{trackId}
ContactTypesApi	companyContactsTypesCountGet	GET /company/contacts/types/count
ContactTypesApi	companyContactsTypesGet	GET /company/contacts/types
ContactTypesApi	companyContactsTypesIdDelete	DELETE /company/contacts/types/{id}
ContactTypesApi	companyContactsTypesIdGet	GET /company/contacts/types/{id}
ContactTypesApi	companyContactsTypesIdPatch	PATCH /company/contacts/types/{id}
ContactTypesApi	companyContactsTypesIdPut	PUT /company/contacts/types/{id}
ContactTypesApi	companyContactsTypesPost	POST /company/contacts/types
ContactsApi	companyContactsCountGet	GET /company/contacts/count
ContactsApi	companyContactsGet	GET /company/contacts
ContactsApi	companyContactsIdDelete	DELETE /company/contacts/{id}
ContactsApi	companyContactsIdGet	GET /company/contacts/{id}
ContactsApi	companyContactsIdImageGet	GET /company/contacts/{id}/image
ContactsApi	companyContactsIdPatch	PATCH /company/contacts/{id}
ContactsApi	companyContactsIdPortalSecurityGet	GET /company/contacts/{id}/portalSecurity
ContactsApi	companyContactsIdPut	PUT /company/contacts/{id}
ContactsApi	companyContactsPost	POST /company/contacts
ContactsApi	companyContactsRequestPasswordPost	POST /company/contacts/requestPassword
ContactsApi	companyContactsValidatePortalCredentialsPost	POST /company/contacts/validatePortalCredentials
ManagementBackupsApi	companyManagementBackupsCountGet	GET /company/managementBackups/count
ManagementBackupsApi	companyManagementBackupsGet	GET /company/managementBackups
ManagementBackupsApi	companyManagementBackupsIdDelete	DELETE /company/managementBackups/{id}
ManagementBackupsApi	companyManagementBackupsIdGet	GET /company/managementBackups/{id}
ManagementBackupsApi	companyManagementBackupsIdPatch	PATCH /company/managementBackups/{id}
ManagementBackupsApi	companyManagementBackupsIdPut	PUT /company/managementBackups/{id}
ManagementBackupsApi	companyManagementBackupsPost	POST /company/managementBackups
ManagementEmailsApi	companyManagementEmailsCountGet	GET /company/managementEmails/count
ManagementEmailsApi	companyManagementEmailsGet	GET /company/managementEmails
ManagementEmailsApi	companyManagementEmailsIdDelete	DELETE /company/managementEmails/{id}
ManagementEmailsApi	companyManagementEmailsIdGet	GET /company/managementEmails/{id}
ManagementEmailsApi	companyManagementEmailsIdPatch	PATCH /company/managementEmails/{id}
ManagementEmailsApi	companyManagementEmailsIdPut	PUT /company/managementEmails/{id}
ManagementEmailsApi	companyManagementEmailsPost	POST /company/managementEmails
MarketDescriptionsApi	companyMarketDescriptionsCountGet	GET /company/marketDescriptions/count
MarketDescriptionsApi	companyMarketDescriptionsGet	GET /company/marketDescriptions
MarketDescriptionsApi	companyMarketDescriptionsIdDelete	DELETE /company/marketDescriptions/{id}
MarketDescriptionsApi	companyMarketDescriptionsIdGet	GET /company/marketDescriptions/{id}
MarketDescriptionsApi	companyMarketDescriptionsIdPatch	PATCH /company/marketDescriptions/{id}
MarketDescriptionsApi	companyMarketDescriptionsIdPut	PUT /company/marketDescriptions/{id}
MarketDescriptionsApi	companyMarketDescriptionsPost	POST /company/marketDescriptions
OwnershipTypesApi	companyOwnershipTypesCountGet	GET /company/ownershipTypes/count
OwnershipTypesApi	companyOwnershipTypesGet	GET /company/ownershipTypes
OwnershipTypesApi	companyOwnershipTypesIdDelete	DELETE /company/ownershipTypes/{id}
OwnershipTypesApi	companyOwnershipTypesIdGet	GET /company/ownershipTypes/{id}
OwnershipTypesApi	companyOwnershipTypesIdPatch	PATCH /company/ownershipTypes/{id}
OwnershipTypesApi	companyOwnershipTypesIdPut	PUT /company/ownershipTypes/{id}
OwnershipTypesApi	companyOwnershipTypesPost	POST /company/ownershipTypes
TeamRolesApi	companyTeamRolesCountGet	GET /company/teamRoles/count
TeamRolesApi	companyTeamRolesGet	GET /company/teamRoles
TeamRolesApi	companyTeamRolesIdDelete	DELETE /company/teamRoles/{id}
TeamRolesApi	companyTeamRolesIdGet	GET /company/teamRoles/{id}
TeamRolesApi	companyTeamRolesIdPatch	PATCH /company/teamRoles/{id}
TeamRolesApi	companyTeamRolesIdPut	PUT /company/teamRoles/{id}
TeamRolesApi	companyTeamRolesPost	POST /company/teamRoles

Documentation For Models

• AgreementReference
• AgreementTypeReference
• BillingDeliveryReference
• BillingTermsReference
• CalendarReference
• CatalogItemReference
• CommunicationTypeReference
• Company
• CompanyCustomNote
• CompanyManagementSummary
• CompanyMerge
• CompanyNote
• CompanyReference
• CompanySite
• CompanyStatus
• CompanyStatusReference
• CompanyTeam
• CompanyType
• CompanyTypeReference
• Configuration
• ConfigurationQuestion
• ConfigurationStatus
• ConfigurationStatusReference
• ConfigurationType
• ConfigurationTypeQuestion
• ConfigurationTypeReference
• Contact
• ContactCommunication
• ContactCommunicationItem
• ContactDepartment
• ContactDepartmentReference
• ContactNote
• ContactReference
• ContactRelationship
• ContactType
• ContactTypeReference
• Count
• CountryReference
• CurrencyReference
• CustomFieldValue
• EntityTypeReference
• Error
• Guid
• InvoiceTemplateReference
• ManagementBackup
• ManagementEmail
• ManagementSolutionReference
• ManufacturerReference
• MarketDescription
• MemberReference
• Metadata
• NoteType
• NoteTypeReference
• OwnershipType
• OwnershipTypeReference
• PatchOperation
• PortalSecurity
• PricingScheduleReference
• RelationshipReference
• RequestPasswordRequest
• SLAReference
• SicCodeReference
• SiteReference
• SuccessResponse
• TaxCodeReference
• TeamRole
• TeamRoleReference
• TimeZoneReference
• Track
• TrackReference
• ValidatePortalRequest
• ValidatePortalResponse
• ValidationError

Documentation For Authorization

BasicAuth

• Type: HTTP basic authentication