Spinen\ConnectWise\Clients\Company\ContactCommunicationsApi

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

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

Method	HTTP request	Description
companyContactsIdCommunicationsCommunicationIdDelete	DELETE /company/contacts/{id}/communications/{communicationId}
companyContactsIdCommunicationsCommunicationIdGet	GET /company/contacts/{id}/communications/{communicationId}
companyContactsIdCommunicationsCommunicationIdPatch	PATCH /company/contacts/{id}/communications/{communicationId}
companyContactsIdCommunicationsCommunicationIdPut	PUT /company/contacts/{id}/communications/{communicationId}
companyContactsIdCommunicationsCountGet	GET /company/contacts/{id}/communications/count
companyContactsIdCommunicationsGet	GET /company/contacts/{id}/communications
companyContactsIdCommunicationsPost	POST /company/contacts/{id}/communications

companyContactsIdCommunicationsCommunicationIdDelete

companyContactsIdCommunicationsCommunicationIdDelete($id, $communication_id)

Delete Contact Communication By Id

Example

<?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\ContactCommunicationsApi();
$id = 56; // int | 
$communication_id = 56; // int | 

try {
    $api_instance->companyContactsIdCommunicationsCommunicationIdDelete($id, $communication_id);
} catch (Exception $e) {
    echo 'Exception when calling ContactCommunicationsApi->companyContactsIdCommunicationsCommunicationIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int
communication_id	int

Return type

void (empty response body)

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

companyContactsIdCommunicationsCommunicationIdGet

\Spinen\ConnectWise\Clients\Company\Model\ContactCommunication companyContactsIdCommunicationsCommunicationIdGet($id, $communication_id)

Get Contact Communication By Id

Example

<?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\ContactCommunicationsApi();
$id = 56; // int | 
$communication_id = 56; // int | 

try {
    $result = $api_instance->companyContactsIdCommunicationsCommunicationIdGet($id, $communication_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactCommunicationsApi->companyContactsIdCommunicationsCommunicationIdGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int
communication_id	int

Return type

\Spinen\ConnectWise\Clients\Company\Model\ContactCommunication

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

companyContactsIdCommunicationsCommunicationIdPatch

\Spinen\ConnectWise\Clients\Company\Model\ContactCommunication companyContactsIdCommunicationsCommunicationIdPatch($id, $communication_id, $operations)

Update Contact Communication

Example

<?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\ContactCommunicationsApi();
$id = 56; // int | 
$communication_id = 56; // int | 
$operations = array(new PatchOperation()); // \Spinen\ConnectWise\Clients\Company\Model\PatchOperation[] | 

try {
    $result = $api_instance->companyContactsIdCommunicationsCommunicationIdPatch($id, $communication_id, $operations);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactCommunicationsApi->companyContactsIdCommunicationsCommunicationIdPatch: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int
communication_id	int
operations	\Spinen\ConnectWise\Clients\Company\Model\PatchOperation[]

Return type

\Spinen\ConnectWise\Clients\Company\Model\ContactCommunication

Authorization

BasicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

companyContactsIdCommunicationsCommunicationIdPut

\Spinen\ConnectWise\Clients\Company\Model\ContactCommunication companyContactsIdCommunicationsCommunicationIdPut($id, $communication_id, $contact_communication)

Replace Contact Communication

Example

<?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\ContactCommunicationsApi();
$id = 56; // int | 
$communication_id = 56; // int | 
$contact_communication = new \Spinen\ConnectWise\Clients\Company\Model\ContactCommunication(); // \Spinen\ConnectWise\Clients\Company\Model\ContactCommunication | 

try {
    $result = $api_instance->companyContactsIdCommunicationsCommunicationIdPut($id, $communication_id, $contact_communication);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactCommunicationsApi->companyContactsIdCommunicationsCommunicationIdPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int
communication_id	int
contact_communication	\Spinen\ConnectWise\Clients\Company\Model\ContactCommunication

Return type

\Spinen\ConnectWise\Clients\Company\Model\ContactCommunication

Authorization

BasicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

companyContactsIdCommunicationsCountGet

\Spinen\ConnectWise\Clients\Company\Model\Count companyContactsIdCommunicationsCountGet($id, $conditions)

Get Contact Communications Count

Example

<?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\ContactCommunicationsApi();
$id = 56; // int | 
$conditions = "conditions_example"; // string | 

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

Parameters

Name	Type	Description	Notes
id	int
conditions	string		[optional]

Return type

\Spinen\ConnectWise\Clients\Company\Model\Count

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

companyContactsIdCommunicationsGet

\Spinen\ConnectWise\Clients\Company\Model\ContactCommunication[] companyContactsIdCommunicationsGet($id, $conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size)

Get Contact Communications

Example

<?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\ContactCommunicationsApi();
$id = 56; // int | 
$conditions = "conditions_example"; // string | 
$order_by = "order_by_example"; // string | 
$childconditions = "childconditions_example"; // string | 
$customfieldconditions = "customfieldconditions_example"; // string | 
$page = 56; // int | 
$page_size = 56; // int | 

try {
    $result = $api_instance->companyContactsIdCommunicationsGet($id, $conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactCommunicationsApi->companyContactsIdCommunicationsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
id	int
conditions	string	[optional]
order_by	string	[optional]
childconditions	string	[optional]
customfieldconditions	string	[optional]
page	int	[optional]
page_size	int	[optional]

Return type

\Spinen\ConnectWise\Clients\Company\Model\ContactCommunication[]

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

companyContactsIdCommunicationsPost

\Spinen\ConnectWise\Clients\Company\Model\ContactCommunication companyContactsIdCommunicationsPost($id, $contact_communication)

Create Contact Communication

Example

<?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\ContactCommunicationsApi();
$id = 56; // int | 
$contact_communication = new \Spinen\ConnectWise\Clients\Company\Model\ContactCommunication(); // \Spinen\ConnectWise\Clients\Company\Model\ContactCommunication | 

try {
    $result = $api_instance->companyContactsIdCommunicationsPost($id, $contact_communication);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactCommunicationsApi->companyContactsIdCommunicationsPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int
contact_communication	\Spinen\ConnectWise\Clients\Company\Model\ContactCommunication

Return type

\Spinen\ConnectWise\Clients\Company\Model\ContactCommunication

Authorization

BasicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ContactCommunicationsApi.md

Latest commit

History

ContactCommunicationsApi.md

File metadata and controls

Spinen\ConnectWise\Clients\Company\ContactCommunicationsApi

companyContactsIdCommunicationsCommunicationIdDelete

Example

Parameters

Return type

Authorization

HTTP request headers

companyContactsIdCommunicationsCommunicationIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

companyContactsIdCommunicationsCommunicationIdPatch

Example

Parameters

Return type

Authorization

HTTP request headers

companyContactsIdCommunicationsCommunicationIdPut

Example

Parameters

Return type

Authorization

HTTP request headers

companyContactsIdCommunicationsCountGet

Example

Parameters

Return type

Authorization

HTTP request headers

companyContactsIdCommunicationsGet

Example

Parameters

Return type

Authorization

HTTP request headers

companyContactsIdCommunicationsPost

Example

Parameters

Return type

Authorization

HTTP request headers