Skip to content

Latest commit

 

History

History
386 lines (263 loc) · 13.7 KB

CampaignSubTypesApi.md

File metadata and controls

386 lines (263 loc) · 13.7 KB
Raw

Spinen\ConnectWise\Clients\Marketing\CampaignSubTypesApi

Spinen's PHP ConnectWise Client for Marketing 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
marketingCampaignsTypesIdSubTypesCountGet GET /marketing/campaigns/types/{id}/subTypes/count
marketingCampaignsTypesIdSubTypesGet GET /marketing/campaigns/types/{id}/subTypes
marketingCampaignsTypesIdSubTypesPost POST /marketing/campaigns/types/{id}/subTypes
marketingCampaignsTypesIdSubTypesSubTypeIdDelete DELETE /marketing/campaigns/types/{id}/subTypes/{subTypeId}
marketingCampaignsTypesIdSubTypesSubTypeIdGet GET /marketing/campaigns/types/{id}/subTypes/{subTypeId}
marketingCampaignsTypesIdSubTypesSubTypeIdPatch PATCH /marketing/campaigns/types/{id}/subTypes/{subTypeId}
marketingCampaignsTypesIdSubTypesSubTypeIdPut PUT /marketing/campaigns/types/{id}/subTypes/{subTypeId}

marketingCampaignsTypesIdSubTypesCountGet

\Spinen\ConnectWise\Clients\Marketing\Model\Count marketingCampaignsTypesIdSubTypesCountGet($id, $conditions)

Get Campaign Sub Types Count

Example

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

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

Parameters

Name Type Description Notes
id int
conditions string [optional]

Return type

\Spinen\ConnectWise\Clients\Marketing\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]

marketingCampaignsTypesIdSubTypesGet

\Spinen\ConnectWise\Clients\Marketing\Model\CampaignSubType[] marketingCampaignsTypesIdSubTypesGet($id, $conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size)

Get Campaign Sub Types

Example

<?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\CampaignSubTypesApi();
$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->marketingCampaignsTypesIdSubTypesGet($id, $conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignSubTypesApi->marketingCampaignsTypesIdSubTypesGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description 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\Marketing\Model\CampaignSubType[]

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]

marketingCampaignsTypesIdSubTypesPost

\Spinen\ConnectWise\Clients\Marketing\Model\CampaignSubType marketingCampaignsTypesIdSubTypesPost($id, $campaign_sub_type)

Create Campaign Sub Type

Example

<?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\CampaignSubTypesApi();
$id = 56; // int | 
$campaign_sub_type = new \Spinen\ConnectWise\Clients\Marketing\Model\CampaignSubType(); // \Spinen\ConnectWise\Clients\Marketing\Model\CampaignSubType | 

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

Parameters

Name Type Description Notes
id int
campaign_sub_type \Spinen\ConnectWise\Clients\Marketing\Model\CampaignSubType

Return type

\Spinen\ConnectWise\Clients\Marketing\Model\CampaignSubType

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]

marketingCampaignsTypesIdSubTypesSubTypeIdDelete

marketingCampaignsTypesIdSubTypesSubTypeIdDelete($id, $sub_type_id)

Delete Campaign Sub Type By Id

Example

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

try {
    $api_instance->marketingCampaignsTypesIdSubTypesSubTypeIdDelete($id, $sub_type_id);
} catch (Exception $e) {
    echo 'Exception when calling CampaignSubTypesApi->marketingCampaignsTypesIdSubTypesSubTypeIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
sub_type_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]

marketingCampaignsTypesIdSubTypesSubTypeIdGet

\Spinen\ConnectWise\Clients\Marketing\Model\CampaignSubType marketingCampaignsTypesIdSubTypesSubTypeIdGet($id, $sub_type_id)

Get Campaign Sub Type By Id

Example

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

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

Parameters

Name Type Description Notes
id int
sub_type_id int

Return type

\Spinen\ConnectWise\Clients\Marketing\Model\CampaignSubType

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]

marketingCampaignsTypesIdSubTypesSubTypeIdPatch

\Spinen\ConnectWise\Clients\Marketing\Model\CampaignSubType marketingCampaignsTypesIdSubTypesSubTypeIdPatch($id, $sub_type_id, $operations)

Update Campaign Sub Type

Example

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

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

Parameters

Name Type Description Notes
id int
sub_type_id int
operations \Spinen\ConnectWise\Clients\Marketing\Model\PatchOperation[]

Return type

\Spinen\ConnectWise\Clients\Marketing\Model\CampaignSubType

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]

marketingCampaignsTypesIdSubTypesSubTypeIdPut

\Spinen\ConnectWise\Clients\Marketing\Model\CampaignSubType marketingCampaignsTypesIdSubTypesSubTypeIdPut($id, $sub_type_id, $campaign_sub_type)

Replace Campaign Sub Type

Example

<?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\CampaignSubTypesApi();
$id = 56; // int | 
$sub_type_id = 56; // int | 
$campaign_sub_type = new \Spinen\ConnectWise\Clients\Marketing\Model\CampaignSubType(); // \Spinen\ConnectWise\Clients\Marketing\Model\CampaignSubType | 

try {
    $result = $api_instance->marketingCampaignsTypesIdSubTypesSubTypeIdPut($id, $sub_type_id, $campaign_sub_type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignSubTypesApi->marketingCampaignsTypesIdSubTypesSubTypeIdPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
sub_type_id int
campaign_sub_type \Spinen\ConnectWise\Clients\Marketing\Model\CampaignSubType

Return type

\Spinen\ConnectWise\Clients\Marketing\Model\CampaignSubType

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]