Skip to content

Latest commit

 

History

History
505 lines (362 loc) · 15.8 KB

OpportunityForecastsApi.md

File metadata and controls

505 lines (362 loc) · 15.8 KB

ConnectWise::OpportunityForecastsApi

All URIs are relative to http://cloud.na.myconnectwise.net/v4_6_development/apis/3.0

Method HTTP request Description
delete_sales_opportunities_by_parent_id_forecast DELETE /sales/opportunities/{parentId}/forecast/ Delete Forecast
get_sales_opportunities_by_parent_id_forecast GET /sales/opportunities/{parentId}/forecast Get List of Forecast
get_sales_opportunities_by_parent_id_forecast_count GET /sales/opportunities/{parentId}/forecast/count Get Count of Forecast
patch_sales_opportunities_by_parent_id_forecast PATCH /sales/opportunities/{parentId}/forecast/ Patch Forecast
post_sales_opportunities_by_parent_id_forecast POST /sales/opportunities/{parentId}/forecast Post Forecast
post_sales_opportunities_by_parent_id_forecast_copy_by_id POST /sales/opportunities/{parentId}/forecast/copy/{id} Post SuccessResponse
put_sales_opportunities_by_parent_id_forecast PUT /sales/opportunities/{parentId}/forecast/ Put Forecast

delete_sales_opportunities_by_parent_id_forecast

delete_sales_opportunities_by_parent_id_forecast(parent_id, client_id)

Delete Forecast

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::OpportunityForecastsApi.new
parent_id = 56 # Integer | opportunityId
client_id = 'client_id_example' # String | 

begin
  # Delete Forecast
  api_instance.delete_sales_opportunities_by_parent_id_forecast(parent_id, client_id)
rescue ConnectWise::ApiError => e
  puts "Error when calling OpportunityForecastsApi->delete_sales_opportunities_by_parent_id_forecast: #{e}"
end

Using the delete_sales_opportunities_by_parent_id_forecast_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> delete_sales_opportunities_by_parent_id_forecast_with_http_info(parent_id, client_id)

begin
  # Delete Forecast
  data, status_code, headers = api_instance.delete_sales_opportunities_by_parent_id_forecast_with_http_info(parent_id, client_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue ConnectWise::ApiError => e
  puts "Error when calling OpportunityForecastsApi->delete_sales_opportunities_by_parent_id_forecast_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
parent_id Integer opportunityId
client_id String

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

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

get_sales_opportunities_by_parent_id_forecast

<Array> get_sales_opportunities_by_parent_id_forecast(parent_id, client_id, opts)

Get List of Forecast

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::OpportunityForecastsApi.new
parent_id = 56 # Integer | opportunityId
client_id = 'client_id_example' # String | 
opts = {
  conditions: 'conditions_example', # String | 
  child_conditions: 'child_conditions_example', # String | 
  custom_field_conditions: 'custom_field_conditions_example', # String | 
  order_by: 'order_by_example', # String | 
  fields: 'fields_example', # String | 
  page: 56, # Integer | 
  page_size: 56, # Integer | 
  page_id: 56 # Integer | 
}

begin
  # Get List of Forecast
  result = api_instance.get_sales_opportunities_by_parent_id_forecast(parent_id, client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling OpportunityForecastsApi->get_sales_opportunities_by_parent_id_forecast: #{e}"
end

Using the get_sales_opportunities_by_parent_id_forecast_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<Array>, Integer, Hash)> get_sales_opportunities_by_parent_id_forecast_with_http_info(parent_id, client_id, opts)

begin
  # Get List of Forecast
  data, status_code, headers = api_instance.get_sales_opportunities_by_parent_id_forecast_with_http_info(parent_id, client_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<Forecast>>
rescue ConnectWise::ApiError => e
  puts "Error when calling OpportunityForecastsApi->get_sales_opportunities_by_parent_id_forecast_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
parent_id Integer opportunityId
client_id String
conditions String [optional]
child_conditions String [optional]
custom_field_conditions String [optional]
order_by String [optional]
fields String [optional]
page Integer [optional]
page_size Integer [optional]
page_id Integer [optional]

Return type

Array<Forecast>

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.connectwise.com+json; version=2022.1

get_sales_opportunities_by_parent_id_forecast_count

get_sales_opportunities_by_parent_id_forecast_count(parent_id, client_id, opts)

Get Count of Forecast

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::OpportunityForecastsApi.new
parent_id = 56 # Integer | opportunityId
client_id = 'client_id_example' # String | 
opts = {
  conditions: 'conditions_example', # String | 
  child_conditions: 'child_conditions_example', # String | 
  custom_field_conditions: 'custom_field_conditions_example', # String | 
  order_by: 'order_by_example', # String | 
  fields: 'fields_example', # String | 
  page: 56, # Integer | 
  page_size: 56, # Integer | 
  page_id: 56 # Integer | 
}

begin
  # Get Count of Forecast
  result = api_instance.get_sales_opportunities_by_parent_id_forecast_count(parent_id, client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling OpportunityForecastsApi->get_sales_opportunities_by_parent_id_forecast_count: #{e}"
end

Using the get_sales_opportunities_by_parent_id_forecast_count_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_sales_opportunities_by_parent_id_forecast_count_with_http_info(parent_id, client_id, opts)

begin
  # Get Count of Forecast
  data, status_code, headers = api_instance.get_sales_opportunities_by_parent_id_forecast_count_with_http_info(parent_id, client_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Count>
rescue ConnectWise::ApiError => e
  puts "Error when calling OpportunityForecastsApi->get_sales_opportunities_by_parent_id_forecast_count_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
parent_id Integer opportunityId
client_id String
conditions String [optional]
child_conditions String [optional]
custom_field_conditions String [optional]
order_by String [optional]
fields String [optional]
page Integer [optional]
page_size Integer [optional]
page_id Integer [optional]

Return type

Count

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.connectwise.com+json; version=2022.1

patch_sales_opportunities_by_parent_id_forecast

patch_sales_opportunities_by_parent_id_forecast(parent_id, client_id, patch_operation)

Patch Forecast

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::OpportunityForecastsApi.new
parent_id = 56 # Integer | opportunityId
client_id = 'client_id_example' # String | 
patch_operation = [ConnectWise::PatchOperation.new] # Array<PatchOperation> | List of PatchOperation

begin
  # Patch Forecast
  result = api_instance.patch_sales_opportunities_by_parent_id_forecast(parent_id, client_id, patch_operation)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling OpportunityForecastsApi->patch_sales_opportunities_by_parent_id_forecast: #{e}"
end

Using the patch_sales_opportunities_by_parent_id_forecast_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> patch_sales_opportunities_by_parent_id_forecast_with_http_info(parent_id, client_id, patch_operation)

begin
  # Patch Forecast
  data, status_code, headers = api_instance.patch_sales_opportunities_by_parent_id_forecast_with_http_info(parent_id, client_id, patch_operation)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Forecast>
rescue ConnectWise::ApiError => e
  puts "Error when calling OpportunityForecastsApi->patch_sales_opportunities_by_parent_id_forecast_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
parent_id Integer opportunityId
client_id String
patch_operation Array<PatchOperation> List of PatchOperation

Return type

Forecast

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.connectwise.com+json; version=2022.1

post_sales_opportunities_by_parent_id_forecast

post_sales_opportunities_by_parent_id_forecast(parent_id, client_id, forecast)

Post Forecast

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::OpportunityForecastsApi.new
parent_id = 56 # Integer | opportunityId
client_id = 'client_id_example' # String | 
forecast = ConnectWise::Forecast.new # Forecast | forecast

begin
  # Post Forecast
  result = api_instance.post_sales_opportunities_by_parent_id_forecast(parent_id, client_id, forecast)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling OpportunityForecastsApi->post_sales_opportunities_by_parent_id_forecast: #{e}"
end

Using the post_sales_opportunities_by_parent_id_forecast_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> post_sales_opportunities_by_parent_id_forecast_with_http_info(parent_id, client_id, forecast)

begin
  # Post Forecast
  data, status_code, headers = api_instance.post_sales_opportunities_by_parent_id_forecast_with_http_info(parent_id, client_id, forecast)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Forecast>
rescue ConnectWise::ApiError => e
  puts "Error when calling OpportunityForecastsApi->post_sales_opportunities_by_parent_id_forecast_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
parent_id Integer opportunityId
client_id String
forecast Forecast forecast

Return type

Forecast

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.connectwise.com+json; version=2022.1

post_sales_opportunities_by_parent_id_forecast_copy_by_id

post_sales_opportunities_by_parent_id_forecast_copy_by_id(id, parent_id, client_id)

Post SuccessResponse

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::OpportunityForecastsApi.new
id = 56 # Integer | copyId
parent_id = 56 # Integer | opportunityId
client_id = 'client_id_example' # String | 

begin
  # Post SuccessResponse
  result = api_instance.post_sales_opportunities_by_parent_id_forecast_copy_by_id(id, parent_id, client_id)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling OpportunityForecastsApi->post_sales_opportunities_by_parent_id_forecast_copy_by_id: #{e}"
end

Using the post_sales_opportunities_by_parent_id_forecast_copy_by_id_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> post_sales_opportunities_by_parent_id_forecast_copy_by_id_with_http_info(id, parent_id, client_id)

begin
  # Post SuccessResponse
  data, status_code, headers = api_instance.post_sales_opportunities_by_parent_id_forecast_copy_by_id_with_http_info(id, parent_id, client_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <SuccessResponse>
rescue ConnectWise::ApiError => e
  puts "Error when calling OpportunityForecastsApi->post_sales_opportunities_by_parent_id_forecast_copy_by_id_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id Integer copyId
parent_id Integer opportunityId
client_id String

Return type

SuccessResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.connectwise.com+json; version=2022.1

put_sales_opportunities_by_parent_id_forecast

put_sales_opportunities_by_parent_id_forecast(parent_id, client_id, forecast)

Put Forecast

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::OpportunityForecastsApi.new
parent_id = 56 # Integer | opportunityId
client_id = 'client_id_example' # String | 
forecast = ConnectWise::Forecast.new # Forecast | forecast

begin
  # Put Forecast
  result = api_instance.put_sales_opportunities_by_parent_id_forecast(parent_id, client_id, forecast)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling OpportunityForecastsApi->put_sales_opportunities_by_parent_id_forecast: #{e}"
end

Using the put_sales_opportunities_by_parent_id_forecast_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> put_sales_opportunities_by_parent_id_forecast_with_http_info(parent_id, client_id, forecast)

begin
  # Put Forecast
  data, status_code, headers = api_instance.put_sales_opportunities_by_parent_id_forecast_with_http_info(parent_id, client_id, forecast)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Forecast>
rescue ConnectWise::ApiError => e
  puts "Error when calling OpportunityForecastsApi->put_sales_opportunities_by_parent_id_forecast_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
parent_id Integer opportunityId
client_id String
forecast Forecast forecast

Return type

Forecast

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.connectwise.com+json; version=2022.1