Skip to content

Latest commit

 

History

History
372 lines (249 loc) · 11.6 KB

MemberTypesApi.md

File metadata and controls

372 lines (249 loc) · 11.6 KB
Raw

Spinen\ConnectWise\Clients\System\MemberTypesApi

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
systemMembersTypesCountGet GET /system/members/types/count
systemMembersTypesGet GET /system/members/types
systemMembersTypesIdDelete DELETE /system/members/types/{id}
systemMembersTypesIdGet GET /system/members/types/{id}
systemMembersTypesIdPatch PATCH /system/members/types/{id}
systemMembersTypesIdPut PUT /system/members/types/{id}
systemMembersTypesPost POST /system/members/types

systemMembersTypesCountGet

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

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

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

systemMembersTypesGet

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

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

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]

systemMembersTypesIdDelete

systemMembersTypesIdDelete($id)

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

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

systemMembersTypesIdGet

\Spinen\ConnectWise\Clients\System\Model\Type systemMembersTypesIdGet($id)

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

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

Parameters

Name Type Description Notes
id int

Return type

\Spinen\ConnectWise\Clients\System\Model\Type

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]

systemMembersTypesIdPatch

\Spinen\ConnectWise\Clients\System\Model\Type systemMembersTypesIdPatch($id, $operations)

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

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

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]

systemMembersTypesIdPut

\Spinen\ConnectWise\Clients\System\Model\Type systemMembersTypesIdPut($id, $type)

Replace 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\MemberTypesApi();
$id = 56; // int | 
$type = new \Spinen\ConnectWise\Clients\System\Model\Type(); // \Spinen\ConnectWise\Clients\System\Model\Type | 

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

Parameters

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

Return type

\Spinen\ConnectWise\Clients\System\Model\Type

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]

systemMembersTypesPost

\Spinen\ConnectWise\Clients\System\Model\Type systemMembersTypesPost($type)

Create 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\MemberTypesApi();
$type = new \Spinen\ConnectWise\Clients\System\Model\Type(); // \Spinen\ConnectWise\Clients\System\Model\Type | 

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

Parameters

Name Type Description Notes
type \Spinen\ConnectWise\Clients\System\Model\Type

Return type

\Spinen\ConnectWise\Clients\System\Model\Type

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]