Class: ConnectWise::OpportunityForecastsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/connect_wise/api/opportunity_forecasts_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OpportunityForecastsApi

Returns a new instance of OpportunityForecastsApi.



17
18
19
 
# File 'lib/connect_wise/api/opportunity_forecasts_api.rb', line 17

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/connect_wise/api/opportunity_forecasts_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#delete_sales_opportunities_by_parent_id_forecast(parent_id, client_id, opts = {}) ⇒ nil

Delete Forecast

Parameters:

  • parent_id (Integer) —

    opportunityId

  • client_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


26
27
28
29
 
# File 'lib/connect_wise/api/opportunity_forecasts_api.rb', line 26

def delete_sales_opportunities_by_parent_id_forecast(parent_id, client_id, opts = {})
  delete_sales_opportunities_by_parent_id_forecast_with_http_info(parent_id, client_id, opts)
  nil
end

#delete_sales_opportunities_by_parent_id_forecast_with_http_info(parent_id, client_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Forecast

Parameters:

  • parent_id (Integer) —

    opportunityId

  • client_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers

Raises:

  • (ArgumentError) 


36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/connect_wise/api/opportunity_forecasts_api.rb', line 36

def delete_sales_opportunities_by_parent_id_forecast_with_http_info(parent_id, client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: OpportunityForecastsApi.delete_sales_opportunities_by_parent_id_forecast ...' if @api_client.config.debugging
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling OpportunityForecastsApi.delete_sales_opportunities_by_parent_id_forecast" if @api_client.config.client_side_validation && parent_id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling OpportunityForecastsApi.delete_sales_opportunities_by_parent_id_forecast" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/sales/opportunities/{parentId}/forecast/'.sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'OpportunityForecastsApi.delete_sales_opportunities_by_parent_id_forecast',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  @api_client.config.logger.debug "API called: OpportunityForecastsApi#delete_sales_opportunities_by_parent_id_forecast\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_sales_opportunities_by_parent_id_forecast(parent_id, client_id, opts = {}) ⇒ Array<Forecast>

Get List of Forecast

Parameters:

  • parent_id (Integer) —

    opportunityId

  • client_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:



93
94
95
96
 
# File 'lib/connect_wise/api/opportunity_forecasts_api.rb', line 93

def get_sales_opportunities_by_parent_id_forecast(parent_id, client_id, opts = {})
  data, _status_code, _headers = get_sales_opportunities_by_parent_id_forecast_with_http_info(parent_id, client_id, opts)
  data
end

#get_sales_opportunities_by_parent_id_forecast_count(parent_id, client_id, opts = {}) ⇒ Count

Get Count of Forecast

Parameters:

  • parent_id (Integer) —

    opportunityId

  • client_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:



178
179
180
181
 
# File 'lib/connect_wise/api/opportunity_forecasts_api.rb', line 178

def get_sales_opportunities_by_parent_id_forecast_count(parent_id, client_id, opts = {})
  data, _status_code, _headers = get_sales_opportunities_by_parent_id_forecast_count_with_http_info(parent_id, client_id, opts)
  data
end

#get_sales_opportunities_by_parent_id_forecast_count_with_http_info(parent_id, client_id, opts = {}) ⇒ Array<(Count, Integer, Hash)>

Get Count of Forecast

Parameters:

  • parent_id (Integer) —

    opportunityId

  • client_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:

  • (Array<(Count, Integer, Hash)>) —

    Count data, response status code and response headers

Raises:

  • (ArgumentError) 


196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/connect_wise/api/opportunity_forecasts_api.rb', line 196

def get_sales_opportunities_by_parent_id_forecast_count_with_http_info(parent_id, client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: OpportunityForecastsApi.get_sales_opportunities_by_parent_id_forecast_count ...' if @api_client.config.debugging
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling OpportunityForecastsApi.get_sales_opportunities_by_parent_id_forecast_count" if @api_client.config.client_side_validation && parent_id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling OpportunityForecastsApi.get_sales_opportunities_by_parent_id_forecast_count" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/sales/opportunities/{parentId}/forecast/count'.sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:conditions] = opts[:conditions] unless opts[:conditions].nil?
  query_params[:childConditions] = opts[:child_conditions] unless opts[:child_conditions].nil?
  query_params[:customFieldConditions] = opts[:custom_field_conditions] unless opts[:custom_field_conditions].nil?
  query_params[:orderBy] = opts[:order_by] unless opts[:order_by].nil?
  query_params[:fields] = opts[:fields] unless opts[:fields].nil?
  query_params[:page] = opts[:page] unless opts[:page].nil?
  query_params[:pageSize] = opts[:page_size] unless opts[:page_size].nil?
  query_params[:pageId] = opts[:page_id] unless opts[:page_id].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Count'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'OpportunityForecastsApi.get_sales_opportunities_by_parent_id_forecast_count',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  @api_client.config.logger.debug "API called: OpportunityForecastsApi#get_sales_opportunities_by_parent_id_forecast_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_sales_opportunities_by_parent_id_forecast_with_http_info(parent_id, client_id, opts = {}) ⇒ Array<(Array<Forecast>, Integer, Hash)>

Get List of Forecast

Parameters:

  • parent_id (Integer) —

    opportunityId

  • client_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:

  • (Array<(Array<Forecast>, Integer, Hash)>) —

    Array<Forecast> data, response status code and response headers

Raises:

  • (ArgumentError) 


111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/connect_wise/api/opportunity_forecasts_api.rb', line 111

def get_sales_opportunities_by_parent_id_forecast_with_http_info(parent_id, client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: OpportunityForecastsApi.get_sales_opportunities_by_parent_id_forecast ...' if @api_client.config.debugging
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling OpportunityForecastsApi.get_sales_opportunities_by_parent_id_forecast" if @api_client.config.client_side_validation && parent_id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling OpportunityForecastsApi.get_sales_opportunities_by_parent_id_forecast" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/sales/opportunities/{parentId}/forecast'.sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:conditions] = opts[:conditions] unless opts[:conditions].nil?
  query_params[:childConditions] = opts[:child_conditions] unless opts[:child_conditions].nil?
  query_params[:customFieldConditions] = opts[:custom_field_conditions] unless opts[:custom_field_conditions].nil?
  query_params[:orderBy] = opts[:order_by] unless opts[:order_by].nil?
  query_params[:fields] = opts[:fields] unless opts[:fields].nil?
  query_params[:page] = opts[:page] unless opts[:page].nil?
  query_params[:pageSize] = opts[:page_size] unless opts[:page_size].nil?
  query_params[:pageId] = opts[:page_id] unless opts[:page_id].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Forecast>'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'OpportunityForecastsApi.get_sales_opportunities_by_parent_id_forecast',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  @api_client.config.logger.debug "API called: OpportunityForecastsApi#get_sales_opportunities_by_parent_id_forecast\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#patch_sales_opportunities_by_parent_id_forecast(parent_id, client_id, patch_operation, opts = {}) ⇒ Forecast

Patch Forecast

Parameters:

  • parent_id (Integer) —

    opportunityId

  • client_id (String)
  • patch_operation (Array<PatchOperation>) —

    List of PatchOperation

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



256
257
258
259
 
# File 'lib/connect_wise/api/opportunity_forecasts_api.rb', line 256

def patch_sales_opportunities_by_parent_id_forecast(parent_id, client_id, patch_operation, opts = {})
  data, _status_code, _headers = patch_sales_opportunities_by_parent_id_forecast_with_http_info(parent_id, client_id, patch_operation, opts)
  data
end

#patch_sales_opportunities_by_parent_id_forecast_with_http_info(parent_id, client_id, patch_operation, opts = {}) ⇒ Array<(Forecast, Integer, Hash)>

Patch Forecast

Parameters:

  • parent_id (Integer) —

    opportunityId

  • client_id (String)
  • patch_operation (Array<PatchOperation>) —

    List of PatchOperation

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Forecast, Integer, Hash)>) —

    Forecast data, response status code and response headers

Raises:

  • (ArgumentError) 


267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/connect_wise/api/opportunity_forecasts_api.rb', line 267

def patch_sales_opportunities_by_parent_id_forecast_with_http_info(parent_id, client_id, patch_operation, opts = {})
  @api_client.config.logger.debug 'Calling API: OpportunityForecastsApi.patch_sales_opportunities_by_parent_id_forecast ...' if @api_client.config.debugging
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling OpportunityForecastsApi.patch_sales_opportunities_by_parent_id_forecast" if @api_client.config.client_side_validation && parent_id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling OpportunityForecastsApi.patch_sales_opportunities_by_parent_id_forecast" if @api_client.config.client_side_validation && client_id.nil?
  # verify the required parameter 'patch_operation' is set
  raise ArgumentError, "Missing the required parameter 'patch_operation' when calling OpportunityForecastsApi.patch_sales_opportunities_by_parent_id_forecast" if @api_client.config.client_side_validation && patch_operation.nil?

  # resource path
  local_var_path = '/sales/opportunities/{parentId}/forecast/'.sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  header_params['Content-Type'] = content_type unless content_type.nil?
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_operation)

  # return_type
  return_type = opts[:debug_return_type] || 'Forecast'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'OpportunityForecastsApi.patch_sales_opportunities_by_parent_id_forecast',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  @api_client.config.logger.debug "API called: OpportunityForecastsApi#patch_sales_opportunities_by_parent_id_forecast\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#post_sales_opportunities_by_parent_id_forecast(parent_id, client_id, forecast, opts = {}) ⇒ Forecast

Post Forecast

Parameters:

  • parent_id (Integer) —

    opportunityId

  • client_id (String)
  • forecast (Forecast) —

    forecast

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



324
325
326
327
 
# File 'lib/connect_wise/api/opportunity_forecasts_api.rb', line 324

def post_sales_opportunities_by_parent_id_forecast(parent_id, client_id, forecast, opts = {})
  data, _status_code, _headers = post_sales_opportunities_by_parent_id_forecast_with_http_info(parent_id, client_id, forecast, opts)
  data
end

#post_sales_opportunities_by_parent_id_forecast_copy_by_id(id, parent_id, client_id, opts = {}) ⇒ SuccessResponse

Post SuccessResponse

Parameters:

  • id (Integer) —

    copyId

  • parent_id (Integer) —

    opportunityId

  • client_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



392
393
394
395
 
# File 'lib/connect_wise/api/opportunity_forecasts_api.rb', line 392

def post_sales_opportunities_by_parent_id_forecast_copy_by_id(id, parent_id, client_id, opts = {})
  data, _status_code, _headers = post_sales_opportunities_by_parent_id_forecast_copy_by_id_with_http_info(id, parent_id, client_id, opts)
  data
end

#post_sales_opportunities_by_parent_id_forecast_copy_by_id_with_http_info(id, parent_id, client_id, opts = {}) ⇒ Array<(SuccessResponse, Integer, Hash)>

Post SuccessResponse

Parameters:

  • id (Integer) —

    copyId

  • parent_id (Integer) —

    opportunityId

  • client_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SuccessResponse, Integer, Hash)>) —

    SuccessResponse data, response status code and response headers

Raises:

  • (ArgumentError) 


403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/connect_wise/api/opportunity_forecasts_api.rb', line 403

def post_sales_opportunities_by_parent_id_forecast_copy_by_id_with_http_info(id, parent_id, client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: OpportunityForecastsApi.post_sales_opportunities_by_parent_id_forecast_copy_by_id ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  raise ArgumentError, "Missing the required parameter 'id' when calling OpportunityForecastsApi.post_sales_opportunities_by_parent_id_forecast_copy_by_id" if @api_client.config.client_side_validation && id.nil?
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling OpportunityForecastsApi.post_sales_opportunities_by_parent_id_forecast_copy_by_id" if @api_client.config.client_side_validation && parent_id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling OpportunityForecastsApi.post_sales_opportunities_by_parent_id_forecast_copy_by_id" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/sales/opportunities/{parentId}/forecast/copy/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SuccessResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'OpportunityForecastsApi.post_sales_opportunities_by_parent_id_forecast_copy_by_id',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  @api_client.config.logger.debug "API called: OpportunityForecastsApi#post_sales_opportunities_by_parent_id_forecast_copy_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#post_sales_opportunities_by_parent_id_forecast_with_http_info(parent_id, client_id, forecast, opts = {}) ⇒ Array<(Forecast, Integer, Hash)>

Post Forecast

Parameters:

  • parent_id (Integer) —

    opportunityId

  • client_id (String)
  • forecast (Forecast) —

    forecast

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Forecast, Integer, Hash)>) —

    Forecast data, response status code and response headers

Raises:

  • (ArgumentError) 


335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/connect_wise/api/opportunity_forecasts_api.rb', line 335

def post_sales_opportunities_by_parent_id_forecast_with_http_info(parent_id, client_id, forecast, opts = {})
  @api_client.config.logger.debug 'Calling API: OpportunityForecastsApi.post_sales_opportunities_by_parent_id_forecast ...' if @api_client.config.debugging
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling OpportunityForecastsApi.post_sales_opportunities_by_parent_id_forecast" if @api_client.config.client_side_validation && parent_id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling OpportunityForecastsApi.post_sales_opportunities_by_parent_id_forecast" if @api_client.config.client_side_validation && client_id.nil?
  # verify the required parameter 'forecast' is set
  raise ArgumentError, "Missing the required parameter 'forecast' when calling OpportunityForecastsApi.post_sales_opportunities_by_parent_id_forecast" if @api_client.config.client_side_validation && forecast.nil?

  # resource path
  local_var_path = '/sales/opportunities/{parentId}/forecast'.sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  header_params['Content-Type'] = content_type unless content_type.nil?
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(forecast)

  # return_type
  return_type = opts[:debug_return_type] || 'Forecast'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'OpportunityForecastsApi.post_sales_opportunities_by_parent_id_forecast',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  @api_client.config.logger.debug "API called: OpportunityForecastsApi#post_sales_opportunities_by_parent_id_forecast\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#put_sales_opportunities_by_parent_id_forecast(parent_id, client_id, forecast, opts = {}) ⇒ Forecast

Put Forecast

Parameters:

  • parent_id (Integer) —

    opportunityId

  • client_id (String)
  • forecast (Forecast) —

    forecast

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



457
458
459
460
 
# File 'lib/connect_wise/api/opportunity_forecasts_api.rb', line 457

def put_sales_opportunities_by_parent_id_forecast(parent_id, client_id, forecast, opts = {})
  data, _status_code, _headers = put_sales_opportunities_by_parent_id_forecast_with_http_info(parent_id, client_id, forecast, opts)
  data
end

#put_sales_opportunities_by_parent_id_forecast_with_http_info(parent_id, client_id, forecast, opts = {}) ⇒ Array<(Forecast, Integer, Hash)>

Put Forecast

Parameters:

  • parent_id (Integer) —

    opportunityId

  • client_id (String)
  • forecast (Forecast) —

    forecast

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Forecast, Integer, Hash)>) —

    Forecast data, response status code and response headers

Raises:

  • (ArgumentError) 


468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/connect_wise/api/opportunity_forecasts_api.rb', line 468

def put_sales_opportunities_by_parent_id_forecast_with_http_info(parent_id, client_id, forecast, opts = {})
  @api_client.config.logger.debug 'Calling API: OpportunityForecastsApi.put_sales_opportunities_by_parent_id_forecast ...' if @api_client.config.debugging
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling OpportunityForecastsApi.put_sales_opportunities_by_parent_id_forecast" if @api_client.config.client_side_validation && parent_id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling OpportunityForecastsApi.put_sales_opportunities_by_parent_id_forecast" if @api_client.config.client_side_validation && client_id.nil?
  # verify the required parameter 'forecast' is set
  raise ArgumentError, "Missing the required parameter 'forecast' when calling OpportunityForecastsApi.put_sales_opportunities_by_parent_id_forecast" if @api_client.config.client_side_validation && forecast.nil?

  # resource path
  local_var_path = '/sales/opportunities/{parentId}/forecast/'.sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  header_params['Content-Type'] = content_type unless content_type.nil?
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(forecast)

  # return_type
  return_type = opts[:debug_return_type] || 'Forecast'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'OpportunityForecastsApi.put_sales_opportunities_by_parent_id_forecast',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  @api_client.config.logger.debug "API called: OpportunityForecastsApi#put_sales_opportunities_by_parent_id_forecast\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end