Class: ConnectWise::AgreementsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AgreementsApi

Returns a new instance of AgreementsApi.



8
9
10
 
# File 'lib/connectwise-ruby-sdk/api/agreements_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/agreements_api.rb', line 6

def api_client
  @api_client
end

Instance Method Details

#finance_agreements_count_get(opts = {}) ⇒ Count

Get Agreements 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/agreements_api.rb', line 18

def finance_agreements_count_get(opts = {})
  data, _status_code, _headers = finance_agreements_count_get_with_http_info(opts)
  return data
end

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

Get Agreements 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/agreements_api.rb', line 29

def finance_agreements_count_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AgreementsApi.finance_agreements_count_get ..."
  end
  # resource path
  local_var_path = "/finance/agreements/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: AgreementsApi#finance_agreements_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#finance_agreements_get(opts = {}) ⇒ Array<Agreement>

Get Agreements

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/agreements_api.rb', line 75

def finance_agreements_get(opts = {})
  data, _status_code, _headers = finance_agreements_get_with_http_info(opts)
  return data
end

#finance_agreements_get_with_http_info(opts = {}) ⇒ Array<(Array<Agreement>, Fixnum, Hash)>

Get Agreements

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<Agreement>, Fixnum, Hash)>) —

    Array<Agreement> 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/agreements_api.rb', line 90

def finance_agreements_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AgreementsApi.finance_agreements_get ..."
  end
  # resource path
  local_var_path = "/finance/agreements"

  # 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<Agreement>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgreementsApi#finance_agreements_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#finance_agreements_id_configurations_configuration_id_delete(id, configuration_id, opts = {}) ⇒ nil

Delete Configuration Association

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


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

def finance_agreements_id_configurations_configuration_id_delete(id, configuration_id, opts = {})
  finance_agreements_id_configurations_configuration_id_delete_with_http_info(id, configuration_id, opts)
  return nil
end

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

Delete Configuration Association

Parameters:

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

    the optional parameters

Returns:

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

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

def finance_agreements_id_configurations_configuration_id_delete_with_http_info(id, configuration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AgreementsApi.finance_agreements_id_configurations_configuration_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 AgreementsApi.finance_agreements_id_configurations_configuration_id_delete"
  end
  # verify the required parameter 'configuration_id' is set
  if @api_client.config.client_side_validation && configuration_id.nil?
    fail ArgumentError, "Missing the required parameter 'configuration_id' when calling AgreementsApi.finance_agreements_id_configurations_configuration_id_delete"
  end
  # resource path
  local_var_path = "/finance/agreements/{id}/configurations/{configurationId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'configurationId' + '}', configuration_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: AgreementsApi#finance_agreements_id_configurations_configuration_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#finance_agreements_id_configurations_configuration_id_get(id, configuration_id, opts = {}) ⇒ ConfigurationReference

Get Configuration Association

Parameters:

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

    the optional parameters

Returns:



192
193
194
195
 
# File 'lib/connectwise-ruby-sdk/api/agreements_api.rb', line 192

def finance_agreements_id_configurations_configuration_id_get(id, configuration_id, opts = {})
  data, _status_code, _headers = finance_agreements_id_configurations_configuration_id_get_with_http_info(id, configuration_id, opts)
  return data
end

#finance_agreements_id_configurations_configuration_id_get_with_http_info(id, configuration_id, opts = {}) ⇒ Array<(ConfigurationReference, Fixnum, Hash)>

Get Configuration Association

Parameters:

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

    the optional parameters

Returns:

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

    ConfigurationReference data, response status code and response headers



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/connectwise-ruby-sdk/api/agreements_api.rb', line 203

def finance_agreements_id_configurations_configuration_id_get_with_http_info(id, configuration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AgreementsApi.finance_agreements_id_configurations_configuration_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 AgreementsApi.finance_agreements_id_configurations_configuration_id_get"
  end
  # verify the required parameter 'configuration_id' is set
  if @api_client.config.client_side_validation && configuration_id.nil?
    fail ArgumentError, "Missing the required parameter 'configuration_id' when calling AgreementsApi.finance_agreements_id_configurations_configuration_id_get"
  end
  # resource path
  local_var_path = "/finance/agreements/{id}/configurations/{configurationId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'configurationId' + '}', configuration_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 => 'ConfigurationReference')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgreementsApi#finance_agreements_id_configurations_configuration_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#finance_agreements_id_configurations_count_get(id, opts = {}) ⇒ Count

Get Agreement Configurations Count

Parameters:

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

    the optional parameters

Returns:



250
251
252
253
 
# File 'lib/connectwise-ruby-sdk/api/agreements_api.rb', line 250

def finance_agreements_id_configurations_count_get(id, opts = {})
  data, _status_code, _headers = finance_agreements_id_configurations_count_get_with_http_info(id, opts)
  return data
end

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

Get Agreement Configurations Count

Parameters:

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

    the optional parameters

Returns:

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

    Count data, response status code and response headers



260
261
262
263
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
 
# File 'lib/connectwise-ruby-sdk/api/agreements_api.rb', line 260

def finance_agreements_id_configurations_count_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AgreementsApi.finance_agreements_id_configurations_count_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 AgreementsApi.finance_agreements_id_configurations_count_get"
  end
  # resource path
  local_var_path = "/finance/agreements/{id}/configurations/count".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 => 'Count')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgreementsApi#finance_agreements_id_configurations_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#finance_agreements_id_configurations_get(id, opts = {}) ⇒ Array<ConfigurationReference>

Get Agreement Configurations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :page_size (Integer)

Returns:



305
306
307
308
 
# File 'lib/connectwise-ruby-sdk/api/agreements_api.rb', line 305

def finance_agreements_id_configurations_get(id, opts = {})
  data, _status_code, _headers = finance_agreements_id_configurations_get_with_http_info(id, opts)
  return data
end

#finance_agreements_id_configurations_get_with_http_info(id, opts = {}) ⇒ Array<(Array<ConfigurationReference>, Fixnum, Hash)>

Get Agreement Configurations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :page_size (Integer)

Returns:

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

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



317
318
319
320
321
322
323
324
325
326
327
328
329
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
 
# File 'lib/connectwise-ruby-sdk/api/agreements_api.rb', line 317

def finance_agreements_id_configurations_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AgreementsApi.finance_agreements_id_configurations_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 AgreementsApi.finance_agreements_id_configurations_get"
  end
  # resource path
  local_var_path = "/finance/agreements/{id}/configurations".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  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<ConfigurationReference>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgreementsApi#finance_agreements_id_configurations_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#finance_agreements_id_configurations_post(id, configuration, opts = {}) ⇒ ConfigurationReference

Create Configuration Association

Parameters:

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

    the optional parameters

Returns:



363
364
365
366
 
# File 'lib/connectwise-ruby-sdk/api/agreements_api.rb', line 363

def finance_agreements_id_configurations_post(id, configuration, opts = {})
  data, _status_code, _headers = finance_agreements_id_configurations_post_with_http_info(id, configuration, opts)
  return data
end

#finance_agreements_id_configurations_post_with_http_info(id, configuration, opts = {}) ⇒ Array<(ConfigurationReference, Fixnum, Hash)>

Create Configuration Association

Parameters:

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

    the optional parameters

Returns:

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

    ConfigurationReference data, response status code and response headers



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
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
 
# File 'lib/connectwise-ruby-sdk/api/agreements_api.rb', line 374

def finance_agreements_id_configurations_post_with_http_info(id, configuration, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AgreementsApi.finance_agreements_id_configurations_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 AgreementsApi.finance_agreements_id_configurations_post"
  end
  # verify the required parameter 'configuration' is set
  if @api_client.config.client_side_validation && configuration.nil?
    fail ArgumentError, "Missing the required parameter 'configuration' when calling AgreementsApi.finance_agreements_id_configurations_post"
  end
  # resource path
  local_var_path = "/finance/agreements/{id}/configurations".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(configuration)
  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 => 'ConfigurationReference')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgreementsApi#finance_agreements_id_configurations_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete Agreement By Id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


423
424
425
426
 
# File 'lib/connectwise-ruby-sdk/api/agreements_api.rb', line 423

def finance_agreements_id_delete(id, opts = {})
  finance_agreements_id_delete_with_http_info(id, opts)
  return nil
end

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

Delete Agreement By Id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



433
434
435
436
437
438
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
 
# File 'lib/connectwise-ruby-sdk/api/agreements_api.rb', line 433

def finance_agreements_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AgreementsApi.finance_agreements_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 AgreementsApi.finance_agreements_id_delete"
  end
  # resource path
  local_var_path = "/finance/agreements/{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: AgreementsApi#finance_agreements_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#finance_agreements_id_get(id, opts = {}) ⇒ Agreement

Get Agreement By Id

Parameters:

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

    the optional parameters

Returns:



473
474
475
476
 
# File 'lib/connectwise-ruby-sdk/api/agreements_api.rb', line 473

def finance_agreements_id_get(id, opts = {})
  data, _status_code, _headers = finance_agreements_id_get_with_http_info(id, opts)
  return data
end

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

Get Agreement By Id

Parameters:

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

    the optional parameters

Returns:

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

    Agreement data, response status code and response headers



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
518
519
 
# File 'lib/connectwise-ruby-sdk/api/agreements_api.rb', line 483

def finance_agreements_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AgreementsApi.finance_agreements_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 AgreementsApi.finance_agreements_id_get"
  end
  # resource path
  local_var_path = "/finance/agreements/{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 => 'Agreement')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgreementsApi#finance_agreements_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#finance_agreements_id_patch(id, operations, opts = {}) ⇒ Agreement

Update Agreement

Parameters:

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

    the optional parameters

Returns:



527
528
529
530
 
# File 'lib/connectwise-ruby-sdk/api/agreements_api.rb', line 527

def finance_agreements_id_patch(id, operations, opts = {})
  data, _status_code, _headers = finance_agreements_id_patch_with_http_info(id, operations, opts)
  return data
end

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

Update Agreement

Parameters:

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

    the optional parameters

Returns:

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

    Agreement data, response status code and response headers



538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
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
 
# File 'lib/connectwise-ruby-sdk/api/agreements_api.rb', line 538

def finance_agreements_id_patch_with_http_info(id, operations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AgreementsApi.finance_agreements_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 AgreementsApi.finance_agreements_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 AgreementsApi.finance_agreements_id_patch"
  end
  # resource path
  local_var_path = "/finance/agreements/{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 => 'Agreement')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgreementsApi#finance_agreements_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#finance_agreements_id_put(id, agreement, opts = {}) ⇒ Agreement

Replace Agreement

Parameters:

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

    the optional parameters

Returns:



588
589
590
591
 
# File 'lib/connectwise-ruby-sdk/api/agreements_api.rb', line 588

def finance_agreements_id_put(id, agreement, opts = {})
  data, _status_code, _headers = finance_agreements_id_put_with_http_info(id, agreement, opts)
  return data
end

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

Replace Agreement

Parameters:

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

    the optional parameters

Returns:

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

    Agreement data, response status code and response headers



599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
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
 
# File 'lib/connectwise-ruby-sdk/api/agreements_api.rb', line 599

def finance_agreements_id_put_with_http_info(id, agreement, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AgreementsApi.finance_agreements_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 AgreementsApi.finance_agreements_id_put"
  end
  # verify the required parameter 'agreement' is set
  if @api_client.config.client_side_validation && agreement.nil?
    fail ArgumentError, "Missing the required parameter 'agreement' when calling AgreementsApi.finance_agreements_id_put"
  end
  # resource path
  local_var_path = "/finance/agreements/{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(agreement)
  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 => 'Agreement')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgreementsApi#finance_agreements_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#finance_agreements_post(agreement, opts = {}) ⇒ Agreement

Create Agreement

Parameters:

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

    the optional parameters

Returns:



648
649
650
651
 
# File 'lib/connectwise-ruby-sdk/api/agreements_api.rb', line 648

def finance_agreements_post(agreement, opts = {})
  data, _status_code, _headers = finance_agreements_post_with_http_info(agreement, opts)
  return data
end

#finance_agreements_post_with_http_info(agreement, opts = {}) ⇒ Array<(Agreement, Fixnum, Hash)>

Create Agreement

Parameters:

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

    the optional parameters

Returns:

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

    Agreement data, response status code and response headers



658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
 
# File 'lib/connectwise-ruby-sdk/api/agreements_api.rb', line 658

def finance_agreements_post_with_http_info(agreement, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AgreementsApi.finance_agreements_post ..."
  end
  # verify the required parameter 'agreement' is set
  if @api_client.config.client_side_validation && agreement.nil?
    fail ArgumentError, "Missing the required parameter 'agreement' when calling AgreementsApi.finance_agreements_post"
  end
  # resource path
  local_var_path = "/finance/agreements"

  # 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(agreement)
  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: AgreementsApi#finance_agreements_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end