Skip to content

Latest commit

 

History

History
231 lines (168 loc) · 7.84 KB

PhoneApi.md

File metadata and controls

231 lines (168 loc) · 7.84 KB
Raw

VereTech\SyncroMSP_PHPclient\Client\PhoneApi

All URIs are relative to https://{subdomain}.syncromsp.com/api/v1

Method HTTP request Description
customersCustomerIdPhonesGet GET /customers/{customer_id}/phones Returns a paginated list of Phones
customersCustomerIdPhonesIdDelete DELETE /customers/{customer_id}/phones/{id} Deletes a Phone by ID
customersCustomerIdPhonesIdPut PUT /customers/{customer_id}/phones/{id} Updates an existing Phone by ID
customersCustomerIdPhonesPost POST /customers/{customer_id}/phones Creates a Phone

customersCustomerIdPhonesGet

customersCustomerIdPhonesGet($customer_id)

Returns a paginated list of Phones

Required permission: Customers - View Detail Single-Customer Users can only access own.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\PhoneApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customer_id = 56; // int | 

try {
    $apiInstance->customersCustomerIdPhonesGet($customer_id);
} catch (Exception $e) {
    echo 'Exception when calling PhoneApi->customersCustomerIdPhonesGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
customer_id int

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

customersCustomerIdPhonesIdDelete

customersCustomerIdPhonesIdDelete($customer_id, $id)

Deletes a Phone by ID

Required permission: Customers - Edit Single-Customer Users can only access own.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\PhoneApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customer_id = 56; // int | 
$id = 56; // int | 

try {
    $apiInstance->customersCustomerIdPhonesIdDelete($customer_id, $id);
} catch (Exception $e) {
    echo 'Exception when calling PhoneApi->customersCustomerIdPhonesIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
customer_id int
id int

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

customersCustomerIdPhonesIdPut

customersCustomerIdPhonesIdPut($customer_id, $id, $body)

Updates an existing Phone by ID

Required permission: Customers - Edit Single-Customer Users can only access own.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\PhoneApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customer_id = 56; // int | 
$id = 56; // int | 
$body = new \stdClass; // object | 

try {
    $apiInstance->customersCustomerIdPhonesIdPut($customer_id, $id, $body);
} catch (Exception $e) {
    echo 'Exception when calling PhoneApi->customersCustomerIdPhonesIdPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
customer_id int
id int
body object [optional]

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

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

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

customersCustomerIdPhonesPost

customersCustomerIdPhonesPost($customer_id, $body)

Creates a Phone

Required permission: Customers - Edit Single-Customer Users can only access own.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\PhoneApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customer_id = 56; // int | 
$body = new \stdClass; // object | 

try {
    $apiInstance->customersCustomerIdPhonesPost($customer_id, $body);
} catch (Exception $e) {
    echo 'Exception when calling PhoneApi->customersCustomerIdPhonesPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
customer_id int
body object [optional]

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

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

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