Class: ConnectWise::OpportunitiesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/connectwise-ruby-sdk/api/opportunities_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OpportunitiesApi

Returns a new instance of OpportunitiesApi.



8
9
10
 
# File 'lib/connectwise-ruby-sdk/api/opportunities_api.rb', line 8

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



6
7
8
 
# File 'lib/connectwise-ruby-sdk/api/opportunities_api.rb', line 6

def api_client
  @api_client
end

Instance Method Details

#sales_opportunities_count_get(opts = {}) ⇒ Count

Get Opportunities Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :custom_field_conditions (String)

Returns:



18
19
20
21
 
# File 'lib/connectwise-ruby-sdk/api/opportunities_api.rb', line 18

def sales_opportunities_count_get(opts = {})
  data, _status_code, _headers = sales_opportunities_count_get_with_http_info(opts)
  return data
end

#sales_opportunities_count_get_with_http_info(opts = {}) ⇒ Array<(Count, Fixnum, Hash)>

Get Opportunities Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :custom_field_conditions (String)

Returns:

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

    Count data, response status code and response headers



29
30
31
32
33
34
35
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
 
# File 'lib/connectwise-ruby-sdk/api/opportunities_api.rb', line 29

def sales_opportunities_count_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OpportunitiesApi.sales_opportunities_count_get ..."
  end
  # resource path
  local_var_path = "/sales/opportunities/count"

  # query parameters
  query_params = {}
  query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].nil?
  query_params[:'customFieldConditions'] = opts[:'custom_field_conditions'] if !opts[:'custom_field_conditions'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Count')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OpportunitiesApi#sales_opportunities_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sales_opportunities_get(opts = {}) ⇒ Array<Opportunity>

Get Opportunities

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :order_by (String)
  • :childconditions (String)
  • :customfieldconditions (String)
  • :page (Integer)
  • :page_size (Integer)

Returns:



75
76
77
78
 
# File 'lib/connectwise-ruby-sdk/api/opportunities_api.rb', line 75

def sales_opportunities_get(opts = {})
  data, _status_code, _headers = sales_opportunities_get_with_http_info(opts)
  return data
end

#sales_opportunities_get_with_http_info(opts = {}) ⇒ Array<(Array<Opportunity>, Fixnum, Hash)>

Get Opportunities

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :order_by (String)
  • :childconditions (String)
  • :customfieldconditions (String)
  • :page (Integer)
  • :page_size (Integer)

Returns:

  • (Array<(Array<Opportunity>, Fixnum, Hash)>) —

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



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/connectwise-ruby-sdk/api/opportunities_api.rb', line 90

def sales_opportunities_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OpportunitiesApi.sales_opportunities_get ..."
  end
  # resource path
  local_var_path = "/sales/opportunities"

  # query parameters
  query_params = {}
  query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'childconditions'] = opts[:'childconditions'] if !opts[:'childconditions'].nil?
  query_params[:'customfieldconditions'] = opts[:'customfieldconditions'] if !opts[:'customfieldconditions'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Opportunity>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OpportunitiesApi#sales_opportunities_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sales_opportunities_id_convert_to_agreement_post(id, conversion, opts = {}) ⇒ Agreement

Convert Opportunity To Agreement

Parameters:

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

    the optional parameters

Returns:



136
137
138
139
 
# File 'lib/connectwise-ruby-sdk/api/opportunities_api.rb', line 136

def sales_opportunities_id_convert_to_agreement_post(id, conversion, opts = {})
  data, _status_code, _headers = sales_opportunities_id_convert_to_agreement_post_with_http_info(id, conversion, opts)
  return data
end

#sales_opportunities_id_convert_to_agreement_post_with_http_info(id, conversion, opts = {}) ⇒ Array<(Agreement, Fixnum, Hash)>

Convert Opportunity To Agreement

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Agreement, Fixnum, Hash)>) —

    Agreement data, response status code and response headers



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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/connectwise-ruby-sdk/api/opportunities_api.rb', line 147

def sales_opportunities_id_convert_to_agreement_post_with_http_info(id, conversion, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OpportunitiesApi.sales_opportunities_id_convert_to_agreement_post ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling OpportunitiesApi.sales_opportunities_id_convert_to_agreement_post"
  end
  # verify the required parameter 'conversion' is set
  if @api_client.config.client_side_validation && conversion.nil?
    fail ArgumentError, "Missing the required parameter 'conversion' when calling OpportunitiesApi.sales_opportunities_id_convert_to_agreement_post"
  end
  # resource path
  local_var_path = "/sales/opportunities/{id}/convertToAgreement".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(conversion)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Agreement')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OpportunitiesApi#sales_opportunities_id_convert_to_agreement_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sales_opportunities_id_convert_to_project_post(id, conversion, opts = {}) ⇒ Project

Convert Opportunity To Project

Parameters:

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

    the optional parameters

Returns:



197
198
199
200
 
# File 'lib/connectwise-ruby-sdk/api/opportunities_api.rb', line 197

def sales_opportunities_id_convert_to_project_post(id, conversion, opts = {})
  data, _status_code, _headers = sales_opportunities_id_convert_to_project_post_with_http_info(id, conversion, opts)
  return data
end

#sales_opportunities_id_convert_to_project_post_with_http_info(id, conversion, opts = {}) ⇒ Array<(Project, Fixnum, Hash)>

Convert Opportunity To Project

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Project, Fixnum, Hash)>) —

    Project data, response status code and response headers



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
249
250
 
# File 'lib/connectwise-ruby-sdk/api/opportunities_api.rb', line 208

def sales_opportunities_id_convert_to_project_post_with_http_info(id, conversion, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OpportunitiesApi.sales_opportunities_id_convert_to_project_post ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling OpportunitiesApi.sales_opportunities_id_convert_to_project_post"
  end
  # verify the required parameter 'conversion' is set
  if @api_client.config.client_side_validation && conversion.nil?
    fail ArgumentError, "Missing the required parameter 'conversion' when calling OpportunitiesApi.sales_opportunities_id_convert_to_project_post"
  end
  # resource path
  local_var_path = "/sales/opportunities/{id}/convertToProject".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(conversion)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Project')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OpportunitiesApi#sales_opportunities_id_convert_to_project_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sales_opportunities_id_convert_to_sales_order_post(id, conversion, opts = {}) ⇒ Order

Convert Opportunity To Sales Order

Parameters:

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

    the optional parameters

Returns:



258
259
260
261
 
# File 'lib/connectwise-ruby-sdk/api/opportunities_api.rb', line 258

def sales_opportunities_id_convert_to_sales_order_post(id, conversion, opts = {})
  data, _status_code, _headers = sales_opportunities_id_convert_to_sales_order_post_with_http_info(id, conversion, opts)
  return data
end

#sales_opportunities_id_convert_to_sales_order_post_with_http_info(id, conversion, opts = {}) ⇒ Array<(Order, Fixnum, Hash)>

Convert Opportunity To Sales Order

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Order, Fixnum, Hash)>) —

    Order data, response status code and response headers



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
 
# File 'lib/connectwise-ruby-sdk/api/opportunities_api.rb', line 269

def sales_opportunities_id_convert_to_sales_order_post_with_http_info(id, conversion, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OpportunitiesApi.sales_opportunities_id_convert_to_sales_order_post ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling OpportunitiesApi.sales_opportunities_id_convert_to_sales_order_post"
  end
  # verify the required parameter 'conversion' is set
  if @api_client.config.client_side_validation && conversion.nil?
    fail ArgumentError, "Missing the required parameter 'conversion' when calling OpportunitiesApi.sales_opportunities_id_convert_to_sales_order_post"
  end
  # resource path
  local_var_path = "/sales/opportunities/{id}/convertToSalesOrder".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(conversion)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Order')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OpportunitiesApi#sales_opportunities_id_convert_to_sales_order_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sales_opportunities_id_convert_to_service_ticket_post(id, conversion, opts = {}) ⇒ Ticket

Convert Opportunity To Service Ticket

Parameters:

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

    the optional parameters

Returns:



319
320
321
322
 
# File 'lib/connectwise-ruby-sdk/api/opportunities_api.rb', line 319

def sales_opportunities_id_convert_to_service_ticket_post(id, conversion, opts = {})
  data, _status_code, _headers = sales_opportunities_id_convert_to_service_ticket_post_with_http_info(id, conversion, opts)
  return data
end

#sales_opportunities_id_convert_to_service_ticket_post_with_http_info(id, conversion, opts = {}) ⇒ Array<(Ticket, Fixnum, Hash)>

Convert Opportunity To Service Ticket

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Ticket, Fixnum, Hash)>) —

    Ticket data, response status code and response headers



330
331
332
333
334
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
 
# File 'lib/connectwise-ruby-sdk/api/opportunities_api.rb', line 330

def sales_opportunities_id_convert_to_service_ticket_post_with_http_info(id, conversion, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OpportunitiesApi.sales_opportunities_id_convert_to_service_ticket_post ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling OpportunitiesApi.sales_opportunities_id_convert_to_service_ticket_post"
  end
  # verify the required parameter 'conversion' is set
  if @api_client.config.client_side_validation && conversion.nil?
    fail ArgumentError, "Missing the required parameter 'conversion' when calling OpportunitiesApi.sales_opportunities_id_convert_to_service_ticket_post"
  end
  # resource path
  local_var_path = "/sales/opportunities/{id}/convertToServiceTicket".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(conversion)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Ticket')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OpportunitiesApi#sales_opportunities_id_convert_to_service_ticket_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sales_opportunities_id_delete(id, opts = {}) ⇒ nil

Delete Opportunity By Id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


379
380
381
382
 
# File 'lib/connectwise-ruby-sdk/api/opportunities_api.rb', line 379

def sales_opportunities_id_delete(id, opts = {})
  sales_opportunities_id_delete_with_http_info(id, opts)
  return nil
end

#sales_opportunities_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete Opportunity By Id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/connectwise-ruby-sdk/api/opportunities_api.rb', line 389

def sales_opportunities_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OpportunitiesApi.sales_opportunities_id_delete ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling OpportunitiesApi.sales_opportunities_id_delete"
  end
  # resource path
  local_var_path = "/sales/opportunities/{id}".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OpportunitiesApi#sales_opportunities_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sales_opportunities_id_get(id, opts = {}) ⇒ Opportunity

Get Opportunity By Id

Parameters:

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

    the optional parameters

Returns:



429
430
431
432
 
# File 'lib/connectwise-ruby-sdk/api/opportunities_api.rb', line 429

def sales_opportunities_id_get(id, opts = {})
  data, _status_code, _headers = sales_opportunities_id_get_with_http_info(id, opts)
  return data
end

#sales_opportunities_id_get_with_http_info(id, opts = {}) ⇒ Array<(Opportunity, Fixnum, Hash)>

Get Opportunity By Id

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Opportunity, Fixnum, Hash)>) —

    Opportunity data, response status code and response headers



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/connectwise-ruby-sdk/api/opportunities_api.rb', line 439

def sales_opportunities_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OpportunitiesApi.sales_opportunities_id_get ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling OpportunitiesApi.sales_opportunities_id_get"
  end
  # resource path
  local_var_path = "/sales/opportunities/{id}".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Opportunity')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OpportunitiesApi#sales_opportunities_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sales_opportunities_id_patch(id, operations, opts = {}) ⇒ Opportunity

Update Opportunity

Parameters:

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

    the optional parameters

Returns:



483
484
485
486
 
# File 'lib/connectwise-ruby-sdk/api/opportunities_api.rb', line 483

def sales_opportunities_id_patch(id, operations, opts = {})
  data, _status_code, _headers = sales_opportunities_id_patch_with_http_info(id, operations, opts)
  return data
end

#sales_opportunities_id_patch_with_http_info(id, operations, opts = {}) ⇒ Array<(Opportunity, Fixnum, Hash)>

Update Opportunity

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Opportunity, Fixnum, Hash)>) —

    Opportunity data, response status code and response headers



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/connectwise-ruby-sdk/api/opportunities_api.rb', line 494

def sales_opportunities_id_patch_with_http_info(id, operations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OpportunitiesApi.sales_opportunities_id_patch ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling OpportunitiesApi.sales_opportunities_id_patch"
  end
  # verify the required parameter 'operations' is set
  if @api_client.config.client_side_validation && operations.nil?
    fail ArgumentError, "Missing the required parameter 'operations' when calling OpportunitiesApi.sales_opportunities_id_patch"
  end
  # resource path
  local_var_path = "/sales/opportunities/{id}".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(operations)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Opportunity')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OpportunitiesApi#sales_opportunities_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sales_opportunities_id_put(id, opportunity, opts = {}) ⇒ Opportunity

Replace Opportunity

Parameters:

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

    the optional parameters

Returns:



544
545
546
547
 
# File 'lib/connectwise-ruby-sdk/api/opportunities_api.rb', line 544

def sales_opportunities_id_put(id, opportunity, opts = {})
  data, _status_code, _headers = sales_opportunities_id_put_with_http_info(id, opportunity, opts)
  return data
end

#sales_opportunities_id_put_with_http_info(id, opportunity, opts = {}) ⇒ Array<(Opportunity, Fixnum, Hash)>

Replace Opportunity

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Opportunity, Fixnum, Hash)>) —

    Opportunity data, response status code and response headers



555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
 
# File 'lib/connectwise-ruby-sdk/api/opportunities_api.rb', line 555

def sales_opportunities_id_put_with_http_info(id, opportunity, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OpportunitiesApi.sales_opportunities_id_put ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling OpportunitiesApi.sales_opportunities_id_put"
  end
  # verify the required parameter 'opportunity' is set
  if @api_client.config.client_side_validation && opportunity.nil?
    fail ArgumentError, "Missing the required parameter 'opportunity' when calling OpportunitiesApi.sales_opportunities_id_put"
  end
  # resource path
  local_var_path = "/sales/opportunities/{id}".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opportunity)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Opportunity')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OpportunitiesApi#sales_opportunities_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sales_opportunities_post(opportunity, opts = {}) ⇒ Opportunity

Create Opportunity

Parameters:

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

    the optional parameters

Returns:



604
605
606
607
 
# File 'lib/connectwise-ruby-sdk/api/opportunities_api.rb', line 604

def sales_opportunities_post(opportunity, opts = {})
  data, _status_code, _headers = sales_opportunities_post_with_http_info(opportunity, opts)
  return data
end

#sales_opportunities_post_with_http_info(opportunity, opts = {}) ⇒ Array<(Opportunity, Fixnum, Hash)>

Create Opportunity

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Opportunity, Fixnum, Hash)>) —

    Opportunity data, response status code and response headers



614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
 
# File 'lib/connectwise-ruby-sdk/api/opportunities_api.rb', line 614

def sales_opportunities_post_with_http_info(opportunity, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OpportunitiesApi.sales_opportunities_post ..."
  end
  # verify the required parameter 'opportunity' is set
  if @api_client.config.client_side_validation && opportunity.nil?
    fail ArgumentError, "Missing the required parameter 'opportunity' when calling OpportunitiesApi.sales_opportunities_post"
  end
  # resource path
  local_var_path = "/sales/opportunities"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opportunity)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Opportunity')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OpportunitiesApi#sales_opportunities_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end