spinen/connectwise-project-php-client

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

Or modify your composer.json file:

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

Manual Installation

Download the files and include autoload.php:

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

$api_instance = new Spinen\ConnectWise\Clients\Project\Api\ProjectContactsApi();
$id = 56; // int | 
$contact_id = 56; // int | 

try {
    $api_instance->projectProjectsIdContactsContactIdDelete($id, $contact_id);
} catch (Exception $e) {
    echo 'Exception when calling ProjectContactsApi->projectProjectsIdContactsContactIdDelete: ', $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
ProjectContactsApi	projectProjectsIdContactsContactIdDelete	DELETE /project/projects/{id}/contacts/{contactId}
ProjectContactsApi	projectProjectsIdContactsContactIdGet	GET /project/projects/{id}/contacts/{contactId}
ProjectContactsApi	projectProjectsIdContactsGet	GET /project/projects/{id}/contacts
ProjectContactsApi	projectProjectsIdContactsPost	POST /project/projects/{id}/contacts
ProjectNotesApi	projectProjectsIdNotesCountGet	GET /project/projects/{id}/notes/count
ProjectNotesApi	projectProjectsIdNotesGet	GET /project/projects/{id}/notes
ProjectNotesApi	projectProjectsIdNotesNoteIdDelete	DELETE /project/projects/{id}/notes/{noteId}
ProjectNotesApi	projectProjectsIdNotesNoteIdGet	GET /project/projects/{id}/notes/{noteId}
ProjectNotesApi	projectProjectsIdNotesNoteIdPatch	PATCH /project/projects/{id}/notes/{noteId}
ProjectNotesApi	projectProjectsIdNotesNoteIdPut	PUT /project/projects/{id}/notes/{noteId}
ProjectNotesApi	projectProjectsIdNotesPost	POST /project/projects/{id}/notes
ProjectPhasesApi	projectProjectsIdPhasesCountGet	GET /project/projects/{id}/phases/count
ProjectPhasesApi	projectProjectsIdPhasesGet	GET /project/projects/{id}/phases
ProjectPhasesApi	projectProjectsIdPhasesPhaseIdDelete	DELETE /project/projects/{id}/phases/{phaseId}
ProjectPhasesApi	projectProjectsIdPhasesPhaseIdGet	GET /project/projects/{id}/phases/{phaseId}
ProjectPhasesApi	projectProjectsIdPhasesPhaseIdPatch	PATCH /project/projects/{id}/phases/{phaseId}
ProjectPhasesApi	projectProjectsIdPhasesPhaseIdPut	PUT /project/projects/{id}/phases/{phaseId}
ProjectPhasesApi	projectProjectsIdPhasesPost	POST /project/projects/{id}/phases
ProjectsApi	projectProjectsCountGet	GET /project/projects/count
ProjectsApi	projectProjectsGet	GET /project/projects
ProjectsApi	projectProjectsIdDelete	DELETE /project/projects/{id}
ProjectsApi	projectProjectsIdGet	GET /project/projects/{id}
ProjectsApi	projectProjectsIdPatch	PATCH /project/projects/{id}
ProjectsApi	projectProjectsIdPut	PUT /project/projects/{id}
ProjectsApi	projectProjectsPost	POST /project/projects
ProjectsTeammembersApi	projectProjectsIdTeamMembersCountGet	GET /project/projects/{id}/teamMembers/count
ProjectsTeammembersApi	projectProjectsIdTeamMembersGet	GET /project/projects/{id}/teamMembers
ProjectsTeammembersApi	projectProjectsIdTeamMembersPost	POST /project/projects/{id}/teamMembers
ProjectsTeammembersApi	projectProjectsIdTeamMembersTeamMemberIdDelete	DELETE /project/projects/{id}/teamMembers/{teamMemberId}
ProjectsTeammembersApi	projectProjectsIdTeamMembersTeamMemberIdGet	GET /project/projects/{id}/teamMembers/{teamMemberId}
ProjectsTeammembersApi	projectProjectsIdTeamMembersTeamMemberIdPatch	PATCH /project/projects/{id}/teamMembers/{teamMemberId}
ProjectsTeammembersApi	projectProjectsIdTeamMembersTeamMemberIdPut	PUT /project/projects/{id}/teamMembers/{teamMemberId}

Documentation For Models

• AgreementReference
• BillingTermsReference
• CompanyReference
• ContactReference
• Count
• Error
• MemberReference
• Metadata
• NoteTypeReference
• OpportunityReference
• PatchOperation
• PhaseStatusReference
• Project
• ProjectBoardReference
• ProjectContact
• ProjectNote
• ProjectPhase
• ProjectPhaseReference
• ProjectRoleReference
• ProjectStatusReference
• ProjectTeammember
• ProjectTypeReference
• SiteReference
• TaxCodeReference
• ValidationError
• WorkRoleReference

Documentation For Authorization

BasicAuth

• Type: HTTP basic authentication