Skip to content

Latest commit

 

History

History
372 lines (249 loc) · 12.6 KB

OpportunityRatingsApi.md

File metadata and controls

372 lines (249 loc) · 12.6 KB
Raw

Spinen\ConnectWise\Clients\Sales\OpportunityRatingsApi

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
salesOpportunitiesRatingsCountGet GET /sales/opportunities/ratings/count
salesOpportunitiesRatingsGet GET /sales/opportunities/ratings
salesOpportunitiesRatingsIdDelete DELETE /sales/opportunities/ratings/{id}
salesOpportunitiesRatingsIdGet GET /sales/opportunities/ratings/{id}
salesOpportunitiesRatingsIdPatch PATCH /sales/opportunities/ratings/{id}
salesOpportunitiesRatingsIdPut PUT /sales/opportunities/ratings/{id}
salesOpportunitiesRatingsPost POST /sales/opportunities/ratings

salesOpportunitiesRatingsCountGet

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

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

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

salesOpportunitiesRatingsGet

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

Get Opportunity Ratings

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

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]

salesOpportunitiesRatingsIdDelete

salesOpportunitiesRatingsIdDelete($id)

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

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

salesOpportunitiesRatingsIdGet

\Spinen\ConnectWise\Clients\Sales\Model\OpportunityRating salesOpportunitiesRatingsIdGet($id)

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

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

Parameters

Name Type Description Notes
id int

Return type

\Spinen\ConnectWise\Clients\Sales\Model\OpportunityRating

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]

salesOpportunitiesRatingsIdPatch

\Spinen\ConnectWise\Clients\Sales\Model\OpportunityRating salesOpportunitiesRatingsIdPatch($id, $operations)

Update Opportunity Rating

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

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

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]

salesOpportunitiesRatingsIdPut

\Spinen\ConnectWise\Clients\Sales\Model\OpportunityRating salesOpportunitiesRatingsIdPut($id, $opportunity_rating)

Replace Opportunity Rating

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

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

Parameters

Name Type Description Notes
id int
opportunity_rating \Spinen\ConnectWise\Clients\Sales\Model\OpportunityRating

Return type

\Spinen\ConnectWise\Clients\Sales\Model\OpportunityRating

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]

salesOpportunitiesRatingsPost

\Spinen\ConnectWise\Clients\Sales\Model\OpportunityRating salesOpportunitiesRatingsPost($opportunity_rating)

Create Opportunity Rating

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\OpportunityRatingsApi();
$opportunity_rating = new \Spinen\ConnectWise\Clients\Sales\Model\OpportunityRating(); // \Spinen\ConnectWise\Clients\Sales\Model\OpportunityRating | 

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

Parameters

Name Type Description Notes
opportunity_rating \Spinen\ConnectWise\Clients\Sales\Model\OpportunityRating

Return type

\Spinen\ConnectWise\Clients\Sales\Model\OpportunityRating

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]