Skip to content

Latest commit

 

History

History
372 lines (249 loc) · 12.5 KB

ManufacturersApi.md

File metadata and controls

372 lines (249 loc) · 12.5 KB
Raw

Spinen\ConnectWise\Clients\Procurement\ManufacturersApi

Spinen's PHP ConnectWise Client for Procurement 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
procurementManufacturersCountGet GET /procurement/manufacturers/count
procurementManufacturersGet GET /procurement/manufacturers
procurementManufacturersIdDelete DELETE /procurement/manufacturers/{id}
procurementManufacturersIdGet GET /procurement/manufacturers/{id}
procurementManufacturersIdPatch PATCH /procurement/manufacturers/{id}
procurementManufacturersIdPut PUT /procurement/manufacturers/{id}
procurementManufacturersPost POST /procurement/manufacturers

procurementManufacturersCountGet

\Spinen\ConnectWise\Clients\Procurement\Model\Count procurementManufacturersCountGet($conditions)

Get Manufacturers Count

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Procurement\Api\ManufacturersApi();
$conditions = "conditions_example"; // string | 

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

Parameters

Name Type Description Notes
conditions string [optional]

Return type

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

procurementManufacturersGet

\Spinen\ConnectWise\Clients\Procurement\Model\Manufacturer[] procurementManufacturersGet($conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size)

Get Manufacturers

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Procurement\Api\ManufacturersApi();
$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->procurementManufacturersGet($conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManufacturersApi->procurementManufacturersGet: ', $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\Procurement\Model\Manufacturer[]

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]

procurementManufacturersIdDelete

procurementManufacturersIdDelete($id)

Delete Manufacturer By Id

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Procurement\Api\ManufacturersApi();
$id = 56; // int | 

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

procurementManufacturersIdGet

\Spinen\ConnectWise\Clients\Procurement\Model\Manufacturer procurementManufacturersIdGet($id)

Get Manufacturer By Id

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Procurement\Api\ManufacturersApi();
$id = 56; // int | 

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

Parameters

Name Type Description Notes
id int

Return type

\Spinen\ConnectWise\Clients\Procurement\Model\Manufacturer

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]

procurementManufacturersIdPatch

\Spinen\ConnectWise\Clients\Procurement\Model\Manufacturer procurementManufacturersIdPatch($id, $operations)

Update Manufacturer

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Procurement\Api\ManufacturersApi();
$id = 56; // int | 
$operations = array(new PatchOperation()); // \Spinen\ConnectWise\Clients\Procurement\Model\PatchOperation[] | 

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

Parameters

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

Return type

\Spinen\ConnectWise\Clients\Procurement\Model\Manufacturer

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]

procurementManufacturersIdPut

\Spinen\ConnectWise\Clients\Procurement\Model\Manufacturer procurementManufacturersIdPut($id, $manufacturer)

Replace Manufacturer

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Procurement\Api\ManufacturersApi();
$id = 56; // int | 
$manufacturer = new \Spinen\ConnectWise\Clients\Procurement\Model\Manufacturer(); // \Spinen\ConnectWise\Clients\Procurement\Model\Manufacturer | 

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

Parameters

Name Type Description Notes
id int
manufacturer \Spinen\ConnectWise\Clients\Procurement\Model\Manufacturer

Return type

\Spinen\ConnectWise\Clients\Procurement\Model\Manufacturer

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]

procurementManufacturersPost

\Spinen\ConnectWise\Clients\Procurement\Model\Manufacturer procurementManufacturersPost($manufacturer)

Create Manufacturer

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Procurement\Api\ManufacturersApi();
$manufacturer = new \Spinen\ConnectWise\Clients\Procurement\Model\Manufacturer(); // \Spinen\ConnectWise\Clients\Procurement\Model\Manufacturer | 

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

Parameters

Name Type Description Notes
manufacturer \Spinen\ConnectWise\Clients\Procurement\Model\Manufacturer

Return type

\Spinen\ConnectWise\Clients\Procurement\Model\Manufacturer

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]