Skip to content

Latest commit

 

History

History
372 lines (249 loc) · 11.7 KB

InOutTypesApi.md

File metadata and controls

372 lines (249 loc) · 11.7 KB
Raw

Spinen\ConnectWise\Clients\System\InOutTypesApi

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
systemInOutTypesCountGet GET /system/inOutTypes/count
systemInOutTypesGet GET /system/inOutTypes
systemInOutTypesIdDelete DELETE /system/inOutTypes/{id}
systemInOutTypesIdGet GET /system/inOutTypes/{id}
systemInOutTypesIdPatch PATCH /system/inOutTypes/{id}
systemInOutTypesIdPut PUT /system/inOutTypes/{id}
systemInOutTypesPost POST /system/inOutTypes

systemInOutTypesCountGet

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

Get In Out Type 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\InOutTypesApi();
$conditions = "conditions_example"; // string | 

try {
    $result = $api_instance->systemInOutTypesCountGet($conditions);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InOutTypesApi->systemInOutTypesCountGet: ', $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]

systemInOutTypesGet

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

Get In Out Type

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\InOutTypesApi();
$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->systemInOutTypesGet($conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InOutTypesApi->systemInOutTypesGet: ', $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\InOutType[]

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]

systemInOutTypesIdDelete

systemInOutTypesIdDelete($id)

Delete In Out Type 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\InOutTypesApi();
$id = 56; // int | 

try {
    $api_instance->systemInOutTypesIdDelete($id);
} catch (Exception $e) {
    echo 'Exception when calling InOutTypesApi->systemInOutTypesIdDelete: ', $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]

systemInOutTypesIdGet

\Spinen\ConnectWise\Clients\System\Model\InOutType systemInOutTypesIdGet($id)

Get In Out Type 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\InOutTypesApi();
$id = 56; // int | 

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

Parameters

Name Type Description Notes
id int

Return type

\Spinen\ConnectWise\Clients\System\Model\InOutType

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]

systemInOutTypesIdPatch

\Spinen\ConnectWise\Clients\System\Model\InOutType systemInOutTypesIdPatch($id, $operations)

Update In Out Type

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

try {
    $result = $api_instance->systemInOutTypesIdPatch($id, $operations);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InOutTypesApi->systemInOutTypesIdPatch: ', $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\InOutType

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]

systemInOutTypesIdPut

\Spinen\ConnectWise\Clients\System\Model\InOutType systemInOutTypesIdPut($id, $in_out_type)

Replace In Out Type

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\InOutTypesApi();
$id = 56; // int | 
$in_out_type = new \Spinen\ConnectWise\Clients\System\Model\InOutType(); // \Spinen\ConnectWise\Clients\System\Model\InOutType | 

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

Parameters

Name Type Description Notes
id int
in_out_type \Spinen\ConnectWise\Clients\System\Model\InOutType

Return type

\Spinen\ConnectWise\Clients\System\Model\InOutType

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]

systemInOutTypesPost

\Spinen\ConnectWise\Clients\System\Model\InOutType systemInOutTypesPost($in_out_type)

Create In Out Type

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\InOutTypesApi();
$in_out_type = new \Spinen\ConnectWise\Clients\System\Model\InOutType(); // \Spinen\ConnectWise\Clients\System\Model\InOutType | 

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

Parameters

Name Type Description Notes
in_out_type \Spinen\ConnectWise\Clients\System\Model\InOutType

Return type

\Spinen\ConnectWise\Clients\System\Model\InOutType

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]