Class: ConnectWise::OpportunityForecastItemsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OpportunityForecastItemsApi

Returns a new instance of OpportunityForecastItemsApi.



17
18
19
 
# File 'lib/connect_wise/api/opportunity_forecast_items_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_forecast_items_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

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

Delete ForecastItem

Parameters:

  • id (Integer) —

    forecastId

  • parent_id (Integer) —

    opportunityId

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

    the optional parameters

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/connect_wise/api/opportunity_forecast_items_api.rb', line 27

def delete_sales_opportunities_by_parent_id_forecast_by_id(id, parent_id, client_id, opts = {})
  delete_sales_opportunities_by_parent_id_forecast_by_id_with_http_info(id, parent_id, client_id, opts)
  nil
end

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

Delete ForecastItem

Parameters:

  • id (Integer) —

    forecastId

  • 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) 


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
79
80
81
82
 
# File 'lib/connect_wise/api/opportunity_forecast_items_api.rb', line 38

def delete_sales_opportunities_by_parent_id_forecast_by_id_with_http_info(id, parent_id, client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: OpportunityForecastItemsApi.delete_sales_opportunities_by_parent_id_forecast_by_id ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  raise ArgumentError, "Missing the required parameter 'id' when calling OpportunityForecastItemsApi.delete_sales_opportunities_by_parent_id_forecast_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 OpportunityForecastItemsApi.delete_sales_opportunities_by_parent_id_forecast_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 OpportunityForecastItemsApi.delete_sales_opportunities_by_parent_id_forecast_by_id" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/sales/opportunities/{parentId}/forecast/{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] || {}
  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: :'OpportunityForecastItemsApi.delete_sales_opportunities_by_parent_id_forecast_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(:DELETE, local_var_path, new_options)
  @api_client.config.logger.debug "API called: OpportunityForecastItemsApi#delete_sales_opportunities_by_parent_id_forecast_by_id\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_by_id(id, parent_id, client_id, opts = {}) ⇒ ForecastItem

Get ForecastItem

Parameters:

  • id (Integer) —

    forecastId

  • 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:



98
99
100
101
 
# File 'lib/connect_wise/api/opportunity_forecast_items_api.rb', line 98

def get_sales_opportunities_by_parent_id_forecast_by_id(id, parent_id, client_id, opts = {})
  data, _status_code, _headers = get_sales_opportunities_by_parent_id_forecast_by_id_with_http_info(id, parent_id, client_id, opts)
  data
end

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

Get ForecastItem

Parameters:

  • id (Integer) —

    forecastId

  • 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<(ForecastItem, Integer, Hash)>) —

    ForecastItem data, response status code and response headers

Raises:

  • (ArgumentError) 


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
164
165
166
167
168
169
170
171
 
# File 'lib/connect_wise/api/opportunity_forecast_items_api.rb', line 117

def get_sales_opportunities_by_parent_id_forecast_by_id_with_http_info(id, parent_id, client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: OpportunityForecastItemsApi.get_sales_opportunities_by_parent_id_forecast_by_id ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  raise ArgumentError, "Missing the required parameter 'id' when calling OpportunityForecastItemsApi.get_sales_opportunities_by_parent_id_forecast_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 OpportunityForecastItemsApi.get_sales_opportunities_by_parent_id_forecast_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 OpportunityForecastItemsApi.get_sales_opportunities_by_parent_id_forecast_by_id" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/sales/opportunities/{parentId}/forecast/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).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] || 'ForecastItem'

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

  new_options = opts.merge(
    operation: :'OpportunityForecastItemsApi.get_sales_opportunities_by_parent_id_forecast_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(:GET, local_var_path, new_options)
  @api_client.config.logger.debug "API called: OpportunityForecastItemsApi#get_sales_opportunities_by_parent_id_forecast_by_id\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_by_id(id, parent_id, client_id, patch_operation, opts = {}) ⇒ ForecastItem

Patch ForecastItem

Parameters:

  • id (Integer) —

    forecastId

  • parent_id (Integer) —

    opportunityId

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

    List of PatchOperation

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

    the optional parameters

Returns:



180
181
182
183
 
# File 'lib/connect_wise/api/opportunity_forecast_items_api.rb', line 180

def patch_sales_opportunities_by_parent_id_forecast_by_id(id, parent_id, client_id, patch_operation, opts = {})
  data, _status_code, _headers = patch_sales_opportunities_by_parent_id_forecast_by_id_with_http_info(id, parent_id, client_id, patch_operation, opts)
  data
end

#patch_sales_opportunities_by_parent_id_forecast_by_id_with_http_info(id, parent_id, client_id, patch_operation, opts = {}) ⇒ Array<(ForecastItem, Integer, Hash)>

Patch ForecastItem

Parameters:

  • id (Integer) —

    forecastId

  • parent_id (Integer) —

    opportunityId

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

    List of PatchOperation

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

    the optional parameters

Returns:

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

    ForecastItem data, response status code and response headers

Raises:

  • (ArgumentError) 


192
193
194
195
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
 
# File 'lib/connect_wise/api/opportunity_forecast_items_api.rb', line 192

def patch_sales_opportunities_by_parent_id_forecast_by_id_with_http_info(id, parent_id, client_id, patch_operation, opts = {})
  @api_client.config.logger.debug 'Calling API: OpportunityForecastItemsApi.patch_sales_opportunities_by_parent_id_forecast_by_id ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  raise ArgumentError, "Missing the required parameter 'id' when calling OpportunityForecastItemsApi.patch_sales_opportunities_by_parent_id_forecast_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 OpportunityForecastItemsApi.patch_sales_opportunities_by_parent_id_forecast_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 OpportunityForecastItemsApi.patch_sales_opportunities_by_parent_id_forecast_by_id" 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 OpportunityForecastItemsApi.patch_sales_opportunities_by_parent_id_forecast_by_id" if @api_client.config.client_side_validation && patch_operation.nil?

  # resource path
  local_var_path = '/sales/opportunities/{parentId}/forecast/{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'])
  # 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] || 'ForecastItem'

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

  new_options = opts.merge(
    operation: :'OpportunityForecastItemsApi.patch_sales_opportunities_by_parent_id_forecast_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(:PATCH, local_var_path, new_options)
  @api_client.config.logger.debug "API called: OpportunityForecastItemsApi#patch_sales_opportunities_by_parent_id_forecast_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_by_id(id, parent_id, client_id, forecast_item, opts = {}) ⇒ ForecastItem

Post ForecastItem

Parameters:

  • id (Integer) —

    forecastId

  • parent_id (Integer) —

    opportunityId

  • client_id (String)
  • forecast_item (ForecastItem) —

    forecast

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

    the optional parameters

Returns:



252
253
254
255
 
# File 'lib/connect_wise/api/opportunity_forecast_items_api.rb', line 252

def post_sales_opportunities_by_parent_id_forecast_by_id(id, parent_id, client_id, forecast_item, opts = {})
  data, _status_code, _headers = post_sales_opportunities_by_parent_id_forecast_by_id_with_http_info(id, parent_id, client_id, forecast_item, opts)
  data
end

#post_sales_opportunities_by_parent_id_forecast_by_id_with_http_info(id, parent_id, client_id, forecast_item, opts = {}) ⇒ Array<(ForecastItem, Integer, Hash)>

Post ForecastItem

Parameters:

  • id (Integer) —

    forecastId

  • parent_id (Integer) —

    opportunityId

  • client_id (String)
  • forecast_item (ForecastItem) —

    forecast

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

    the optional parameters

Returns:

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

    ForecastItem data, response status code and response headers

Raises:

  • (ArgumentError) 


264
265
266
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
 
# File 'lib/connect_wise/api/opportunity_forecast_items_api.rb', line 264

def post_sales_opportunities_by_parent_id_forecast_by_id_with_http_info(id, parent_id, client_id, forecast_item, opts = {})
  @api_client.config.logger.debug 'Calling API: OpportunityForecastItemsApi.post_sales_opportunities_by_parent_id_forecast_by_id ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  raise ArgumentError, "Missing the required parameter 'id' when calling OpportunityForecastItemsApi.post_sales_opportunities_by_parent_id_forecast_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 OpportunityForecastItemsApi.post_sales_opportunities_by_parent_id_forecast_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 OpportunityForecastItemsApi.post_sales_opportunities_by_parent_id_forecast_by_id" if @api_client.config.client_side_validation && client_id.nil?
  # verify the required parameter 'forecast_item' is set
  raise ArgumentError, "Missing the required parameter 'forecast_item' when calling OpportunityForecastItemsApi.post_sales_opportunities_by_parent_id_forecast_by_id" if @api_client.config.client_side_validation && forecast_item.nil?

  # resource path
  local_var_path = '/sales/opportunities/{parentId}/forecast/{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'])
  # 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_item)

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

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

  new_options = opts.merge(
    operation: :'OpportunityForecastItemsApi.post_sales_opportunities_by_parent_id_forecast_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: OpportunityForecastItemsApi#post_sales_opportunities_by_parent_id_forecast_by_id\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_by_id(id, parent_id, client_id, forecast_item, opts = {}) ⇒ ForecastItem

Put ForecastItem

Parameters:

  • id (Integer) —

    forecastId

  • parent_id (Integer) —

    opportunityId

  • client_id (String)
  • forecast_item (ForecastItem) —

    forecast

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

    the optional parameters

Returns:



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

def put_sales_opportunities_by_parent_id_forecast_by_id(id, parent_id, client_id, forecast_item, opts = {})
  data, _status_code, _headers = put_sales_opportunities_by_parent_id_forecast_by_id_with_http_info(id, parent_id, client_id, forecast_item, opts)
  data
end

#put_sales_opportunities_by_parent_id_forecast_by_id_with_http_info(id, parent_id, client_id, forecast_item, opts = {}) ⇒ Array<(ForecastItem, Integer, Hash)>

Put ForecastItem

Parameters:

  • id (Integer) —

    forecastId

  • parent_id (Integer) —

    opportunityId

  • client_id (String)
  • forecast_item (ForecastItem) —

    forecast

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

    the optional parameters

Returns:

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

    ForecastItem data, response status code and response headers

Raises:

  • (ArgumentError) 


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
385
386
387
 
# File 'lib/connect_wise/api/opportunity_forecast_items_api.rb', line 336

def put_sales_opportunities_by_parent_id_forecast_by_id_with_http_info(id, parent_id, client_id, forecast_item, opts = {})
  @api_client.config.logger.debug 'Calling API: OpportunityForecastItemsApi.put_sales_opportunities_by_parent_id_forecast_by_id ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  raise ArgumentError, "Missing the required parameter 'id' when calling OpportunityForecastItemsApi.put_sales_opportunities_by_parent_id_forecast_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 OpportunityForecastItemsApi.put_sales_opportunities_by_parent_id_forecast_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 OpportunityForecastItemsApi.put_sales_opportunities_by_parent_id_forecast_by_id" if @api_client.config.client_side_validation && client_id.nil?
  # verify the required parameter 'forecast_item' is set
  raise ArgumentError, "Missing the required parameter 'forecast_item' when calling OpportunityForecastItemsApi.put_sales_opportunities_by_parent_id_forecast_by_id" if @api_client.config.client_side_validation && forecast_item.nil?

  # resource path
  local_var_path = '/sales/opportunities/{parentId}/forecast/{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'])
  # 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_item)

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

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

  new_options = opts.merge(
    operation: :'OpportunityForecastItemsApi.put_sales_opportunities_by_parent_id_forecast_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(:PUT, local_var_path, new_options)
  @api_client.config.logger.debug "API called: OpportunityForecastItemsApi#put_sales_opportunities_by_parent_id_forecast_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end