Skip to content

Latest commit

 

History

History
372 lines (249 loc) · 12.3 KB

OpportunityTypesApi.md

File metadata and controls

372 lines (249 loc) · 12.3 KB
Raw

Spinen\ConnectWise\Clients\Sales\OpportunityTypesApi

Spinen's PHP ConnectWise Client for Sales 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
salesOpportunitiesTypesCountGet GET /sales/opportunities/types/count
salesOpportunitiesTypesGet GET /sales/opportunities/types
salesOpportunitiesTypesIdDelete DELETE /sales/opportunities/types/{id}
salesOpportunitiesTypesIdGet GET /sales/opportunities/types/{id}
salesOpportunitiesTypesIdPatch PATCH /sales/opportunities/types/{id}
salesOpportunitiesTypesIdPut PUT /sales/opportunities/types/{id}
salesOpportunitiesTypesPost POST /sales/opportunities/types

salesOpportunitiesTypesCountGet

\Spinen\ConnectWise\Clients\Sales\Model\Count salesOpportunitiesTypesCountGet($conditions)

Get Opportunity Types Count

Example

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

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

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

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

Parameters

Name Type Description Notes
conditions string [optional]

Return type

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

salesOpportunitiesTypesGet

\Spinen\ConnectWise\Clients\Sales\Model\OpportunityType[] salesOpportunitiesTypesGet($conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size)

Get Opportunity Types

Example

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

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

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

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]

salesOpportunitiesTypesIdDelete

salesOpportunitiesTypesIdDelete($id)

Delete Opportunity Type By Id

Example

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

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

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

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

salesOpportunitiesTypesIdGet

\Spinen\ConnectWise\Clients\Sales\Model\OpportunityType salesOpportunitiesTypesIdGet($id)

Get Opportunity Type By Id

Example

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

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

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

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

Parameters

Name Type Description Notes
id int

Return type

\Spinen\ConnectWise\Clients\Sales\Model\OpportunityType

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]

salesOpportunitiesTypesIdPatch

\Spinen\ConnectWise\Clients\Sales\Model\OpportunityType salesOpportunitiesTypesIdPatch($id, $operations)

Update Opportunity Type

Example

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

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

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

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

Parameters

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

Return type

\Spinen\ConnectWise\Clients\Sales\Model\OpportunityType

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]

salesOpportunitiesTypesIdPut

\Spinen\ConnectWise\Clients\Sales\Model\OpportunityType salesOpportunitiesTypesIdPut($id, $opportunity_type)

Replace Opportunity Type

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\Sales\Api\OpportunityTypesApi();
$id = 56; // int | 
$opportunity_type = new \Spinen\ConnectWise\Clients\Sales\Model\OpportunityType(); // \Spinen\ConnectWise\Clients\Sales\Model\OpportunityType | 

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

Parameters

Name Type Description Notes
id int
opportunity_type \Spinen\ConnectWise\Clients\Sales\Model\OpportunityType

Return type

\Spinen\ConnectWise\Clients\Sales\Model\OpportunityType

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]

salesOpportunitiesTypesPost

\Spinen\ConnectWise\Clients\Sales\Model\OpportunityType salesOpportunitiesTypesPost($opportunity_type)

Create Opportunity Type

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\Sales\Api\OpportunityTypesApi();
$opportunity_type = new \Spinen\ConnectWise\Clients\Sales\Model\OpportunityType(); // \Spinen\ConnectWise\Clients\Sales\Model\OpportunityType | 

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

Parameters

Name Type Description Notes
opportunity_type \Spinen\ConnectWise\Clients\Sales\Model\OpportunityType

Return type

\Spinen\ConnectWise\Clients\Sales\Model\OpportunityType

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]