Class: ConnectWise::InvoicePaymentsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InvoicePaymentsApi

Returns a new instance of InvoicePaymentsApi.



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

def api_client
  @api_client
end

Instance Method Details

#finance_invoices_id_payments_get(id, opts = {}) ⇒ Array<Payment>

Get Payments

Parameters:

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



23
24
25
26
 
# File 'lib/connectwise-ruby-sdk/api/invoice_payments_api.rb', line 23

def finance_invoices_id_payments_get(id, opts = {})
  data, _status_code, _headers = finance_invoices_id_payments_get_with_http_info(id, opts)
  return data
end

#finance_invoices_id_payments_get_with_http_info(id, opts = {}) ⇒ Array<(Array<Payment>, Fixnum, Hash)>

Get Payments

Parameters:

  • id
  • 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<Payment>, Fixnum, Hash)>) —

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



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

def finance_invoices_id_payments_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicePaymentsApi.finance_invoices_id_payments_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 InvoicePaymentsApi.finance_invoices_id_payments_get"
  end
  # resource path
  local_var_path = "/finance/invoices/{id}/payments".sub('{' + 'id' + '}', id.to_s)

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

#finance_invoices_id_payments_payment_id_delete(id, payment_id, opts = {}) ⇒ nil

Delete Payment By Id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


89
90
91
92
 
# File 'lib/connectwise-ruby-sdk/api/invoice_payments_api.rb', line 89

def finance_invoices_id_payments_payment_id_delete(id, payment_id, opts = {})
  finance_invoices_id_payments_payment_id_delete_with_http_info(id, payment_id, opts)
  return nil
end

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

Delete Payment By Id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
129
130
131
132
133
134
135
136
137
 
# File 'lib/connectwise-ruby-sdk/api/invoice_payments_api.rb', line 100

def finance_invoices_id_payments_payment_id_delete_with_http_info(id, payment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicePaymentsApi.finance_invoices_id_payments_payment_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 InvoicePaymentsApi.finance_invoices_id_payments_payment_id_delete"
  end
  # verify the required parameter 'payment_id' is set
  if @api_client.config.client_side_validation && payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_id' when calling InvoicePaymentsApi.finance_invoices_id_payments_payment_id_delete"
  end
  # resource path
  local_var_path = "/finance/invoices/{id}/payments/{paymentId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'paymentId' + '}', payment_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: InvoicePaymentsApi#finance_invoices_id_payments_payment_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#finance_invoices_id_payments_payment_id_get(id, payment_id, opts = {}) ⇒ Payment

Get Payment By Id

Parameters:

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

    the optional parameters

Returns:



145
146
147
148
 
# File 'lib/connectwise-ruby-sdk/api/invoice_payments_api.rb', line 145

def finance_invoices_id_payments_payment_id_get(id, payment_id, opts = {})
  data, _status_code, _headers = finance_invoices_id_payments_payment_id_get_with_http_info(id, payment_id, opts)
  return data
end

#finance_invoices_id_payments_payment_id_get_with_http_info(id, payment_id, opts = {}) ⇒ Array<(Payment, Fixnum, Hash)>

Get Payment By Id

Parameters:

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

    the optional parameters

Returns:

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

    Payment data, response status code and response headers



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
190
191
192
193
194
195
196
 
# File 'lib/connectwise-ruby-sdk/api/invoice_payments_api.rb', line 156

def finance_invoices_id_payments_payment_id_get_with_http_info(id, payment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicePaymentsApi.finance_invoices_id_payments_payment_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 InvoicePaymentsApi.finance_invoices_id_payments_payment_id_get"
  end
  # verify the required parameter 'payment_id' is set
  if @api_client.config.client_side_validation && payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_id' when calling InvoicePaymentsApi.finance_invoices_id_payments_payment_id_get"
  end
  # resource path
  local_var_path = "/finance/invoices/{id}/payments/{paymentId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'paymentId' + '}', payment_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 => 'Payment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicePaymentsApi#finance_invoices_id_payments_payment_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#finance_invoices_id_payments_payment_id_patch(id, payment_id, operations, opts = {}) ⇒ Payment

Update Payment

Parameters:

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

    the optional parameters

Returns:



205
206
207
208
 
# File 'lib/connectwise-ruby-sdk/api/invoice_payments_api.rb', line 205

def finance_invoices_id_payments_payment_id_patch(id, payment_id, operations, opts = {})
  data, _status_code, _headers = finance_invoices_id_payments_payment_id_patch_with_http_info(id, payment_id, operations, opts)
  return data
end

#finance_invoices_id_payments_payment_id_patch_with_http_info(id, payment_id, operations, opts = {}) ⇒ Array<(Payment, Fixnum, Hash)>

Update Payment

Parameters:

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

    the optional parameters

Returns:

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

    Payment data, response status code and response headers



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
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/connectwise-ruby-sdk/api/invoice_payments_api.rb', line 217

def finance_invoices_id_payments_payment_id_patch_with_http_info(id, payment_id, operations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicePaymentsApi.finance_invoices_id_payments_payment_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 InvoicePaymentsApi.finance_invoices_id_payments_payment_id_patch"
  end
  # verify the required parameter 'payment_id' is set
  if @api_client.config.client_side_validation && payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_id' when calling InvoicePaymentsApi.finance_invoices_id_payments_payment_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 InvoicePaymentsApi.finance_invoices_id_payments_payment_id_patch"
  end
  # resource path
  local_var_path = "/finance/invoices/{id}/payments/{paymentId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'paymentId' + '}', payment_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 => 'Payment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicePaymentsApi#finance_invoices_id_payments_payment_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#finance_invoices_id_payments_payment_id_put(id, payment_id, payment, opts = {}) ⇒ Payment

Replace Payment

Parameters:

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

    the optional parameters

Returns:



272
273
274
275
 
# File 'lib/connectwise-ruby-sdk/api/invoice_payments_api.rb', line 272

def finance_invoices_id_payments_payment_id_put(id, payment_id, payment, opts = {})
  data, _status_code, _headers = finance_invoices_id_payments_payment_id_put_with_http_info(id, payment_id, payment, opts)
  return data
end

#finance_invoices_id_payments_payment_id_put_with_http_info(id, payment_id, payment, opts = {}) ⇒ Array<(Payment, Fixnum, Hash)>

Replace Payment

Parameters:

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

    the optional parameters

Returns:

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

    Payment data, response status code and response headers



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

def finance_invoices_id_payments_payment_id_put_with_http_info(id, payment_id, payment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicePaymentsApi.finance_invoices_id_payments_payment_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 InvoicePaymentsApi.finance_invoices_id_payments_payment_id_put"
  end
  # verify the required parameter 'payment_id' is set
  if @api_client.config.client_side_validation && payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_id' when calling InvoicePaymentsApi.finance_invoices_id_payments_payment_id_put"
  end
  # verify the required parameter 'payment' is set
  if @api_client.config.client_side_validation && payment.nil?
    fail ArgumentError, "Missing the required parameter 'payment' when calling InvoicePaymentsApi.finance_invoices_id_payments_payment_id_put"
  end
  # resource path
  local_var_path = "/finance/invoices/{id}/payments/{paymentId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'paymentId' + '}', payment_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(payment)
  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 => 'Payment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicePaymentsApi#finance_invoices_id_payments_payment_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#finance_invoices_id_payments_post(id, payment, opts = {}) ⇒ Payment

Create Payment

Parameters:

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

    the optional parameters

Returns:



338
339
340
341
 
# File 'lib/connectwise-ruby-sdk/api/invoice_payments_api.rb', line 338

def finance_invoices_id_payments_post(id, payment, opts = {})
  data, _status_code, _headers = finance_invoices_id_payments_post_with_http_info(id, payment, opts)
  return data
end

#finance_invoices_id_payments_post_with_http_info(id, payment, opts = {}) ⇒ Array<(Payment, Fixnum, Hash)>

Create Payment

Parameters:

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

    the optional parameters

Returns:

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

    Payment data, response status code and response headers



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
388
389
390
391
 
# File 'lib/connectwise-ruby-sdk/api/invoice_payments_api.rb', line 349

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