Skip to content

Latest commit

 

History

History
372 lines (249 loc) · 13.1 KB

ConnectWiseHostedSetupsApi.md

File metadata and controls

372 lines (249 loc) · 13.1 KB
Raw

Spinen\ConnectWise\Clients\System\ConnectWiseHostedSetupsApi

Spinen's PHP ConnectWise Client for System 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
systemConnectwisehostedsetupsCountGet GET /system/connectwisehostedsetups/count
systemConnectwisehostedsetupsGet GET /system/connectwisehostedsetups
systemConnectwisehostedsetupsIdDelete DELETE /system/connectwisehostedsetups/{id}
systemConnectwisehostedsetupsIdGet GET /system/connectwisehostedsetups/{id}
systemConnectwisehostedsetupsIdPatch PATCH /system/connectwisehostedsetups/{id}
systemConnectwisehostedsetupsIdPut PUT /system/connectwisehostedsetups/{id}
systemConnectwisehostedsetupsPost POST /system/connectwisehostedsetups

systemConnectwisehostedsetupsCountGet

\Spinen\ConnectWise\Clients\System\Model\Count systemConnectwisehostedsetupsCountGet($conditions)

Get Connect Wise Hosted Setups Count

Example

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

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

Parameters

Name Type Description Notes
conditions string [optional]

Return type

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

systemConnectwisehostedsetupsGet

\Spinen\ConnectWise\Clients\System\Model\ConnectWiseHostedSetup[] systemConnectwisehostedsetupsGet($conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size)

Get Connect Wise Hosted Setups

Example

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

Parameters

Name Type Description Notes
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\System\Model\ConnectWiseHostedSetup[]

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]

systemConnectwisehostedsetupsIdDelete

systemConnectwisehostedsetupsIdDelete($id)

Delete Connect Wise Hosted Setup By Id

Example

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

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

Parameters

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

systemConnectwisehostedsetupsIdGet

\Spinen\ConnectWise\Clients\System\Model\ConnectWiseHostedSetup systemConnectwisehostedsetupsIdGet($id)

Get Connect Wise Hosted Setup By Id

Example

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

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

Parameters

Name Type Description Notes
id int

Return type

\Spinen\ConnectWise\Clients\System\Model\ConnectWiseHostedSetup

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]

systemConnectwisehostedsetupsIdPatch

\Spinen\ConnectWise\Clients\System\Model\ConnectWiseHostedSetup systemConnectwisehostedsetupsIdPatch($id, $operations)

Update Connect Wise Hosted Setup

Example

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

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

Parameters

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

Return type

\Spinen\ConnectWise\Clients\System\Model\ConnectWiseHostedSetup

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]

systemConnectwisehostedsetupsIdPut

\Spinen\ConnectWise\Clients\System\Model\ConnectWiseHostedSetup systemConnectwisehostedsetupsIdPut($id, $connect_wise_hosted_setup)

Replace Connect Wise Hosted Setup

Example

<?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\ConnectWiseHostedSetupsApi();
$id = 56; // int | 
$connect_wise_hosted_setup = new \Spinen\ConnectWise\Clients\System\Model\ConnectWiseHostedSetup(); // \Spinen\ConnectWise\Clients\System\Model\ConnectWiseHostedSetup | 

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

Parameters

Name Type Description Notes
id int
connect_wise_hosted_setup \Spinen\ConnectWise\Clients\System\Model\ConnectWiseHostedSetup

Return type

\Spinen\ConnectWise\Clients\System\Model\ConnectWiseHostedSetup

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]

systemConnectwisehostedsetupsPost

\Spinen\ConnectWise\Clients\System\Model\ConnectWiseHostedSetup systemConnectwisehostedsetupsPost($connect_wise_hosted_setup)

Create Connect Wise Hosted Setup

Example

<?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\ConnectWiseHostedSetupsApi();
$connect_wise_hosted_setup = new \Spinen\ConnectWise\Clients\System\Model\ConnectWiseHostedSetup(); // \Spinen\ConnectWise\Clients\System\Model\ConnectWiseHostedSetup | 

try {
    $result = $api_instance->systemConnectwisehostedsetupsPost($connect_wise_hosted_setup);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConnectWiseHostedSetupsApi->systemConnectwisehostedsetupsPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
connect_wise_hosted_setup \Spinen\ConnectWise\Clients\System\Model\ConnectWiseHostedSetup

Return type

\Spinen\ConnectWise\Clients\System\Model\ConnectWiseHostedSetup

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]