spinen/connectwise-marketing-php-client

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

Or modify your composer.json file:

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

Manual Installation

Download the files and include autoload.php:

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

$api_instance = new Spinen\ConnectWise\Clients\Marketing\Api\CampaignAuditsApi();
$id = 56; // int | 
$audit_id = 56; // int | 

try {
    $api_instance->marketingCampaignsIdAuditsAuditIdDelete($id, $audit_id);
} catch (Exception $e) {
    echo 'Exception when calling CampaignAuditsApi->marketingCampaignsIdAuditsAuditIdDelete: ', $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
CampaignAuditsApi	marketingCampaignsIdAuditsAuditIdDelete	DELETE /marketing/campaigns/{id}/audits/{auditId}
CampaignAuditsApi	marketingCampaignsIdAuditsAuditIdGet	GET /marketing/campaigns/{id}/audits/{auditId}
CampaignAuditsApi	marketingCampaignsIdAuditsAuditIdPatch	PATCH /marketing/campaigns/{id}/audits/{auditId}
CampaignAuditsApi	marketingCampaignsIdAuditsAuditIdPut	PUT /marketing/campaigns/{id}/audits/{auditId}
CampaignAuditsApi	marketingCampaignsIdAuditsCountGet	GET /marketing/campaigns/{id}/audits/count
CampaignAuditsApi	marketingCampaignsIdAuditsGet	GET /marketing/campaigns/{id}/audits
CampaignAuditsApi	marketingCampaignsIdAuditsPost	POST /marketing/campaigns/{id}/audits
CampaignEmailsOpenedApi	marketingCampaignsIdEmailsOpenedCountGet	GET /marketing/campaigns/{id}/emailsOpened/count
CampaignEmailsOpenedApi	marketingCampaignsIdEmailsOpenedEmailOpenedIdDelete	DELETE /marketing/campaigns/{id}/emailsOpened/{emailOpenedId}
CampaignEmailsOpenedApi	marketingCampaignsIdEmailsOpenedEmailOpenedIdGet	GET /marketing/campaigns/{id}/emailsOpened/{emailOpenedId}
CampaignEmailsOpenedApi	marketingCampaignsIdEmailsOpenedEmailOpenedIdPatch	PATCH /marketing/campaigns/{id}/emailsOpened/{emailOpenedId}
CampaignEmailsOpenedApi	marketingCampaignsIdEmailsOpenedEmailOpenedIdPut	PUT /marketing/campaigns/{id}/emailsOpened/{emailOpenedId}
CampaignEmailsOpenedApi	marketingCampaignsIdEmailsOpenedGet	GET /marketing/campaigns/{id}/emailsOpened
CampaignEmailsOpenedApi	marketingCampaignsIdEmailsOpenedPost	POST /marketing/campaigns/{id}/emailsOpened
CampaignFormsSubmittedApi	marketingCampaignsIdFormsSubmittedCountGet	GET /marketing/campaigns/{id}/formsSubmitted/count
CampaignFormsSubmittedApi	marketingCampaignsIdFormsSubmittedFormSubmittedIdDelete	DELETE /marketing/campaigns/{id}/formsSubmitted/{formSubmittedId}
CampaignFormsSubmittedApi	marketingCampaignsIdFormsSubmittedFormSubmittedIdGet	GET /marketing/campaigns/{id}/formsSubmitted/{formSubmittedId}
CampaignFormsSubmittedApi	marketingCampaignsIdFormsSubmittedFormSubmittedIdPatch	PATCH /marketing/campaigns/{id}/formsSubmitted/{formSubmittedId}
CampaignFormsSubmittedApi	marketingCampaignsIdFormsSubmittedFormSubmittedIdPut	PUT /marketing/campaigns/{id}/formsSubmitted/{formSubmittedId}
CampaignFormsSubmittedApi	marketingCampaignsIdFormsSubmittedGet	GET /marketing/campaigns/{id}/formsSubmitted
CampaignFormsSubmittedApi	marketingCampaignsIdFormsSubmittedPost	POST /marketing/campaigns/{id}/formsSubmitted
CampaignLinksClickedApi	marketingCampaignsIdLinksClickedCountGet	GET /marketing/campaigns/{id}/linksClicked/count
CampaignLinksClickedApi	marketingCampaignsIdLinksClickedGet	GET /marketing/campaigns/{id}/linksClicked
CampaignLinksClickedApi	marketingCampaignsIdLinksClickedLinkClickedIdDelete	DELETE /marketing/campaigns/{id}/linksClicked/{linkClickedId}
CampaignLinksClickedApi	marketingCampaignsIdLinksClickedLinkClickedIdGet	GET /marketing/campaigns/{id}/linksClicked/{linkClickedId}
CampaignLinksClickedApi	marketingCampaignsIdLinksClickedLinkClickedIdPatch	PATCH /marketing/campaigns/{id}/linksClicked/{linkClickedId}
CampaignLinksClickedApi	marketingCampaignsIdLinksClickedLinkClickedIdPut	PUT /marketing/campaigns/{id}/linksClicked/{linkClickedId}
CampaignLinksClickedApi	marketingCampaignsIdLinksClickedPost	POST /marketing/campaigns/{id}/linksClicked
CampaignStatusesApi	marketingCampaignsStatusesCountGet	GET /marketing/campaigns/statuses/count
CampaignStatusesApi	marketingCampaignsStatusesGet	GET /marketing/campaigns/statuses
CampaignStatusesApi	marketingCampaignsStatusesIdDelete	DELETE /marketing/campaigns/statuses/{id}
CampaignStatusesApi	marketingCampaignsStatusesIdGet	GET /marketing/campaigns/statuses/{id}
CampaignStatusesApi	marketingCampaignsStatusesIdPatch	PATCH /marketing/campaigns/statuses/{id}
CampaignStatusesApi	marketingCampaignsStatusesIdPut	PUT /marketing/campaigns/statuses/{id}
CampaignStatusesApi	marketingCampaignsStatusesPost	POST /marketing/campaigns/statuses
CampaignSubTypesApi	marketingCampaignsTypesIdSubTypesCountGet	GET /marketing/campaigns/types/{id}/subTypes/count
CampaignSubTypesApi	marketingCampaignsTypesIdSubTypesGet	GET /marketing/campaigns/types/{id}/subTypes
CampaignSubTypesApi	marketingCampaignsTypesIdSubTypesPost	POST /marketing/campaigns/types/{id}/subTypes
CampaignSubTypesApi	marketingCampaignsTypesIdSubTypesSubTypeIdDelete	DELETE /marketing/campaigns/types/{id}/subTypes/{subTypeId}
CampaignSubTypesApi	marketingCampaignsTypesIdSubTypesSubTypeIdGet	GET /marketing/campaigns/types/{id}/subTypes/{subTypeId}
CampaignSubTypesApi	marketingCampaignsTypesIdSubTypesSubTypeIdPatch	PATCH /marketing/campaigns/types/{id}/subTypes/{subTypeId}
CampaignSubTypesApi	marketingCampaignsTypesIdSubTypesSubTypeIdPut	PUT /marketing/campaigns/types/{id}/subTypes/{subTypeId}
CampaignTypesApi	marketingCampaignsTypesCountGet	GET /marketing/campaigns/types/count
CampaignTypesApi	marketingCampaignsTypesGet	GET /marketing/campaigns/types
CampaignTypesApi	marketingCampaignsTypesIdDelete	DELETE /marketing/campaigns/types/{id}
CampaignTypesApi	marketingCampaignsTypesIdGet	GET /marketing/campaigns/types/{id}
CampaignTypesApi	marketingCampaignsTypesIdPatch	PATCH /marketing/campaigns/types/{id}
CampaignTypesApi	marketingCampaignsTypesIdPut	PUT /marketing/campaigns/types/{id}
CampaignTypesApi	marketingCampaignsTypesPost	POST /marketing/campaigns/types
CampaignsApi	marketingCampaignsCountGet	GET /marketing/campaigns/count
CampaignsApi	marketingCampaignsGet	GET /marketing/campaigns
CampaignsApi	marketingCampaignsIdActivitiesCountGet	GET /marketing/campaigns/{id}/activities/count
CampaignsApi	marketingCampaignsIdActivitiesGet	GET /marketing/campaigns/{id}/activities
CampaignsApi	marketingCampaignsIdDelete	DELETE /marketing/campaigns/{id}
CampaignsApi	marketingCampaignsIdGet	GET /marketing/campaigns/{id}
CampaignsApi	marketingCampaignsIdOpportunitiesCountGet	GET /marketing/campaigns/{id}/opportunities/count
CampaignsApi	marketingCampaignsIdOpportunitiesGet	GET /marketing/campaigns/{id}/opportunities
CampaignsApi	marketingCampaignsIdPatch	PATCH /marketing/campaigns/{id}
CampaignsApi	marketingCampaignsIdPut	PUT /marketing/campaigns/{id}
CampaignsApi	marketingCampaignsPost	POST /marketing/campaigns
GroupCompaniesApi	marketingGroupsIdCompaniesCompanyIdDelete	DELETE /marketing/groups/{id}/companies/{companyId}
GroupCompaniesApi	marketingGroupsIdCompaniesCompanyIdGet	GET /marketing/groups/{id}/companies/{companyId}
GroupCompaniesApi	marketingGroupsIdCompaniesCompanyIdPatch	PATCH /marketing/groups/{id}/companies/{companyId}
GroupCompaniesApi	marketingGroupsIdCompaniesCompanyIdPut	PUT /marketing/groups/{id}/companies/{companyId}
GroupCompaniesApi	marketingGroupsIdCompaniesCountGet	GET /marketing/groups/{id}/companies/count
GroupCompaniesApi	marketingGroupsIdCompaniesGet	GET /marketing/groups/{id}/companies
GroupCompaniesApi	marketingGroupsIdCompaniesPost	POST /marketing/groups/{id}/companies
GroupContactsApi	marketingGroupsIdContactsContactIdDelete	DELETE /marketing/groups/{id}/contacts/{contactId}
GroupContactsApi	marketingGroupsIdContactsContactIdGet	GET /marketing/groups/{id}/contacts/{contactId}
GroupContactsApi	marketingGroupsIdContactsContactIdPatch	PATCH /marketing/groups/{id}/contacts/{contactId}
GroupContactsApi	marketingGroupsIdContactsContactIdPut	PUT /marketing/groups/{id}/contacts/{contactId}
GroupContactsApi	marketingGroupsIdContactsCountGet	GET /marketing/groups/{id}/contacts/count
GroupContactsApi	marketingGroupsIdContactsGet	GET /marketing/groups/{id}/contacts
GroupContactsApi	marketingGroupsIdContactsPost	POST /marketing/groups/{id}/contacts
GroupsApi	marketingGroupsCountGet	GET /marketing/groups/count
GroupsApi	marketingGroupsGet	GET /marketing/groups
GroupsApi	marketingGroupsIdDelete	DELETE /marketing/groups/{id}
GroupsApi	marketingGroupsIdGet	GET /marketing/groups/{id}
GroupsApi	marketingGroupsIdPatch	PATCH /marketing/groups/{id}
GroupsApi	marketingGroupsIdPut	PUT /marketing/groups/{id}
GroupsApi	marketingGroupsPost	POST /marketing/groups

Documentation For Models

• ActivityReference
• Campaign
• CampaignAudit
• CampaignStatus
• CampaignStatusReference
• CampaignSubType
• CampaignSubTypeReference
• CampaignType
• CampaignTypeReference
• Count
• EmailOpened
• Error
• FormSubmitted
• Group
• GroupReference
• LinkClicked
• MarketingCompany
• MarketingContact
• MemberReference
• Metadata
• OpportunityReference
• PatchOperation
• ValidationError

Documentation For Authorization

BasicAuth

• Type: HTTP basic authentication