spinen/connectwise-system-php-client

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

Maintainers

Details

github.com/spinen/connectwise-system-php-client

Homepage

Source

Issues

Installs: 173

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 0

Open Issues: 0

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

Requires

Requires (Dev)

mit 0ef2797cd4735e5d42a5c616003c0e65b46231a4

apiclientsdkspinenconnectwise

This package is auto-updated.

Last update: 2024-03-22 01:04:52 UTC

README

ConnectWise System 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-system-php-client

Or modify your composer.json file:

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

Manual Installation

Download the files and include autoload.php:

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

$api_instance = new Spinen\ConnectWise\Clients\System\Api\AuditTrailApi();
$type = "type_example"; // string | 
$id = 56; // int | 
$device_identifier = "device_identifier_example"; // string | 

try {
    $result = $api_instance->systemAudittrailCountGet($type, $id, $device_identifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuditTrailApi->systemAudittrailCountGet: ', $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
AuditTrailApi systemAudittrailCountGet GET /system/audittrail/count
AuditTrailApi systemAudittrailGet GET /system/audittrail
BatchApi systemBatchPost POST /system/batch
CallbacksApi systemCallbacksCountGet GET /system/callbacks/count
CallbacksApi systemCallbacksGet GET /system/callbacks
CallbacksApi systemCallbacksIdDelete DELETE /system/callbacks/{id}
CallbacksApi systemCallbacksIdGet GET /system/callbacks/{id}
CallbacksApi systemCallbacksIdPatch PATCH /system/callbacks/{id}
CallbacksApi systemCallbacksIdPut PUT /system/callbacks/{id}
CallbacksApi systemCallbacksPost POST /system/callbacks
CertificationsApi systemCertificationsCountGet GET /system/certifications/count
CertificationsApi systemCertificationsGet GET /system/certifications
CertificationsApi systemCertificationsIdDelete DELETE /system/certifications/{id}
CertificationsApi systemCertificationsIdGet GET /system/certifications/{id}
CertificationsApi systemCertificationsIdPatch PATCH /system/certifications/{id}
CertificationsApi systemCertificationsIdPut PUT /system/certifications/{id}
CertificationsApi systemCertificationsPost POST /system/certifications
ConnectWiseHostedSetupsApi systemConnectwisehostedsetupsCountGet GET /system/connectwisehostedsetups/count
ConnectWiseHostedSetupsApi systemConnectwisehostedsetupsGet GET /system/connectwisehostedsetups
ConnectWiseHostedSetupsApi systemConnectwisehostedsetupsIdDelete DELETE /system/connectwisehostedsetups/{id}
ConnectWiseHostedSetupsApi systemConnectwisehostedsetupsIdGet GET /system/connectwisehostedsetups/{id}
ConnectWiseHostedSetupsApi systemConnectwisehostedsetupsIdPatch PATCH /system/connectwisehostedsetups/{id}
ConnectWiseHostedSetupsApi systemConnectwisehostedsetupsIdPut PUT /system/connectwisehostedsetups/{id}
ConnectWiseHostedSetupsApi systemConnectwisehostedsetupsPost POST /system/connectwisehostedsetups
DocumentsApi systemDocumentsCountGet GET /system/documents/count
DocumentsApi systemDocumentsGet GET /system/documents
DocumentsApi systemDocumentsIdDelete DELETE /system/documents/{id}
DocumentsApi systemDocumentsIdDownloadGet GET /system/documents/{id}/download
DocumentsApi systemDocumentsIdGet GET /system/documents/{id}
DocumentsApi systemDocumentsIdPost POST /system/documents/{id}
DocumentsApi systemDocumentsPost POST /system/documents
DocumentsApi systemDocumentsUploadsampleGet GET /system/documents/uploadsample
InOutBoardsApi systemInOutBoardsCountGet GET /system/inOutBoards/count
InOutBoardsApi systemInOutBoardsGet GET /system/inOutBoards
InOutBoardsApi systemInOutBoardsIdDelete DELETE /system/inOutBoards/{id}
InOutBoardsApi systemInOutBoardsIdGet GET /system/inOutBoards/{id}
InOutBoardsApi systemInOutBoardsIdPatch PATCH /system/inOutBoards/{id}
InOutBoardsApi systemInOutBoardsIdPut PUT /system/inOutBoards/{id}
InOutBoardsApi systemInOutBoardsPost POST /system/inOutBoards
InOutTypesApi systemInOutTypesCountGet GET /system/inOutTypes/count
InOutTypesApi systemInOutTypesGet GET /system/inOutTypes
InOutTypesApi systemInOutTypesIdDelete DELETE /system/inOutTypes/{id}
InOutTypesApi systemInOutTypesIdGet GET /system/inOutTypes/{id}
InOutTypesApi systemInOutTypesIdPatch PATCH /system/inOutTypes/{id}
InOutTypesApi systemInOutTypesIdPut PUT /system/inOutTypes/{id}
InOutTypesApi systemInOutTypesPost POST /system/inOutTypes
InfoApi systemInfoGet GET /system/info
LinksApi systemLinksCountGet GET /system/links/count
LinksApi systemLinksGet GET /system/links
LinksApi systemLinksIdDelete DELETE /system/links/{id}
LinksApi systemLinksIdGet GET /system/links/{id}
LinksApi systemLinksIdPatch PATCH /system/links/{id}
LinksApi systemLinksIdPut PUT /system/links/{id}
LinksApi systemLinksPost POST /system/links
MemberTypesApi systemMembersTypesCountGet GET /system/members/types/count
MemberTypesApi systemMembersTypesGet GET /system/members/types
MemberTypesApi systemMembersTypesIdDelete DELETE /system/members/types/{id}
MemberTypesApi systemMembersTypesIdGet GET /system/members/types/{id}
MemberTypesApi systemMembersTypesIdPatch PATCH /system/members/types/{id}
MemberTypesApi systemMembersTypesIdPut PUT /system/members/types/{id}
MemberTypesApi systemMembersTypesPost POST /system/members/types
MembersApi systemMembersCountGet GET /system/members/count
MembersApi systemMembersGet GET /system/members
MembersApi systemMembersMemberIdentifierGet GET /system/members/{memberIdentifier}
MembersApi systemMembersMemberIdentifierImageGet GET /system/members/{memberIdentifier}/image
MembersApi systemMembersMemberIdentifierTokensPost POST /system/members/{memberIdentifier}/tokens
MenuEntriesApi systemMenuentriesCountGet GET /system/menuentries/count
MenuEntriesApi systemMenuentriesGet GET /system/menuentries
MenuEntriesApi systemMenuentriesIdDelete DELETE /system/menuentries/{id}
MenuEntriesApi systemMenuentriesIdGet GET /system/menuentries/{id}
MenuEntriesApi systemMenuentriesIdImageGet GET /system/menuentries/{id}/image
MenuEntriesApi systemMenuentriesIdImagePost POST /system/menuentries/{id}/image
MenuEntriesApi systemMenuentriesIdPatch PATCH /system/menuentries/{id}
MenuEntriesApi systemMenuentriesIdPut PUT /system/menuentries/{id}
MenuEntriesApi systemMenuentriesPost POST /system/menuentries
ReportsApi systemReportsGet GET /system/reports
ReportsApi systemReportsReportNameColumnsGet GET /system/reports/{reportName}/columns
ReportsApi systemReportsReportNameCountGet GET /system/reports/{reportName}/count
ReportsApi systemReportsReportNameGet GET /system/reports/{reportName}
SkillCategoriesApi systemSkillCategoriesCountGet GET /system/skillCategories/count
SkillCategoriesApi systemSkillCategoriesGet GET /system/skillCategories
SkillCategoriesApi systemSkillCategoriesIdDelete DELETE /system/skillCategories/{id}
SkillCategoriesApi systemSkillCategoriesIdGet GET /system/skillCategories/{id}
SkillCategoriesApi systemSkillCategoriesIdPatch PATCH /system/skillCategories/{id}
SkillCategoriesApi systemSkillCategoriesIdPut PUT /system/skillCategories/{id}
SkillCategoriesApi systemSkillCategoriesPost POST /system/skillCategories
SkillsApi systemSkillsCountGet GET /system/skills/count
SkillsApi systemSkillsGet GET /system/skills
SkillsApi systemSkillsIdDelete DELETE /system/skills/{id}
SkillsApi systemSkillsIdGet GET /system/skills/{id}
SkillsApi systemSkillsIdPatch PATCH /system/skills/{id}
SkillsApi systemSkillsIdPut PUT /system/skills/{id}
SkillsApi systemSkillsPost POST /system/skills
TodayPageCategoriesApi systemTodayPageCategoriesCountGet GET /system/todayPageCategories/count
TodayPageCategoriesApi systemTodayPageCategoriesGet GET /system/todayPageCategories
TodayPageCategoriesApi systemTodayPageCategoriesIdDelete DELETE /system/todayPageCategories/{id}
TodayPageCategoriesApi systemTodayPageCategoriesIdGet GET /system/todayPageCategories/{id}
TodayPageCategoriesApi systemTodayPageCategoriesIdPatch PATCH /system/todayPageCategories/{id}
TodayPageCategoriesApi systemTodayPageCategoriesIdPut PUT /system/todayPageCategories/{id}
TodayPageCategoriesApi systemTodayPageCategoriesPost POST /system/todayPageCategories
UserDefinedFieldsApi systemUserDefinedFieldsCountGet GET /system/userDefinedFields/count
UserDefinedFieldsApi systemUserDefinedFieldsGet GET /system/userDefinedFields
UserDefinedFieldsApi systemUserDefinedFieldsIdDelete DELETE /system/userDefinedFields/{id}
UserDefinedFieldsApi systemUserDefinedFieldsIdGet GET /system/userDefinedFields/{id}
UserDefinedFieldsApi systemUserDefinedFieldsIdPatch PATCH /system/userDefinedFields/{id}
UserDefinedFieldsApi systemUserDefinedFieldsIdPut PUT /system/userDefinedFields/{id}
UserDefinedFieldsApi systemUserDefinedFieldsPost POST /system/userDefinedFields

Documentation For Models

Documentation For Authorization

BasicAuth

  • Type: HTTP basic authentication