Skip to content

Latest commit

 

History

History
372 lines (249 loc) · 11.6 KB

OpportunityStagesApi.md

File metadata and controls

372 lines (249 loc) · 11.6 KB
Raw

Spinen\ConnectWise\Clients\Sales\OpportunityStagesApi

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
salesStagesCountGet GET /sales/stages/count
salesStagesGet GET /sales/stages
salesStagesIdDelete DELETE /sales/stages/{id}
salesStagesIdGet GET /sales/stages/{id}
salesStagesIdPatch PATCH /sales/stages/{id}
salesStagesIdPut PUT /sales/stages/{id}
salesStagesPost POST /sales/stages

salesStagesCountGet

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

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

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

salesStagesGet

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

Get Stage

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

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]

salesStagesIdDelete

salesStagesIdDelete($id)

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

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

salesStagesIdGet

\Spinen\ConnectWise\Clients\Sales\Model\OpportunityStage salesStagesIdGet($id)

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

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

Parameters

Name Type Description Notes
id int

Return type

\Spinen\ConnectWise\Clients\Sales\Model\OpportunityStage

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]

salesStagesIdPatch

\Spinen\ConnectWise\Clients\Sales\Model\OpportunityStage salesStagesIdPatch($id, $operations)

Update Stage

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

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

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]

salesStagesIdPut

\Spinen\ConnectWise\Clients\Sales\Model\OpportunityStage salesStagesIdPut($id, $stage)

Replace Stage

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\OpportunityStagesApi();
$id = 56; // int | 
$stage = new \Spinen\ConnectWise\Clients\Sales\Model\OpportunityStage(); // \Spinen\ConnectWise\Clients\Sales\Model\OpportunityStage | 

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

Parameters

Name Type Description Notes
id int
stage \Spinen\ConnectWise\Clients\Sales\Model\OpportunityStage

Return type

\Spinen\ConnectWise\Clients\Sales\Model\OpportunityStage

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]

salesStagesPost

\Spinen\ConnectWise\Clients\Sales\Model\OpportunityStage salesStagesPost($stage)

Create Stage

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\OpportunityStagesApi();
$stage = new \Spinen\ConnectWise\Clients\Sales\Model\OpportunityStage(); // \Spinen\ConnectWise\Clients\Sales\Model\OpportunityStage | 

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

Parameters

Name Type Description Notes
stage \Spinen\ConnectWise\Clients\Sales\Model\OpportunityStage

Return type

\Spinen\ConnectWise\Clients\Sales\Model\OpportunityStage

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]