Class: Bfwd::CreditnotesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/bf_ruby2/api/creditnotes_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CreditnotesApi

Returns a new instance of CreditnotesApi.



19
20
21
 
# File 'lib/bf_ruby2/api/creditnotes_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/bf_ruby2/api/creditnotes_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_credit_note(credit_note, opts = {}) ⇒ CreditNotePagedMetadata

Create a credit note. a new credit note","request":"createCreditNoteRequest.html","response":"createCreditNoteResponse.html"

Parameters:

  • credit_note —

    The credit note object to be created.

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/bf_ruby2/api/creditnotes_api.rb', line 28

def create_credit_note(credit_note, opts = {})
  data, _status_code, _headers = create_credit_note_with_http_info(credit_note, opts)
  return data
end

#create_credit_note_with_http_info(credit_note, opts = {}) ⇒ Array<(CreditNotePagedMetadata, Fixnum, Hash)>

Create a credit note. a new credit note&quot;,&quot;request&quot;:&quot;createCreditNoteRequest.html&quot;,&quot;response&quot;:&quot;createCreditNoteResponse.html&quot;

Parameters:

  • credit_note —

    The credit note object to be created.

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

    the optional parameters

Returns:

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

    CreditNotePagedMetadata data, response status code and response headers



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
 
# File 'lib/bf_ruby2/api/creditnotes_api.rb', line 38

def create_credit_note_with_http_info(credit_note, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CreditnotesApi.create_credit_note ..."
  end
  # verify the required parameter 'credit_note' is set
  if @api_client.config.client_side_validation && credit_note.nil?
    fail ArgumentError, "Missing the required parameter 'credit_note' when calling CreditnotesApi.create_credit_note"
  end
  # resource path
  local_var_path = "/credit-notes"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(credit_note)
  auth_names = []
  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 => 'CreditNotePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CreditnotesApi#create_credit_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_credit_note_by_id(credit_note_id, opts = {}) ⇒ CreditNotePagedMetadata

Returns a single credit-note, specified by the ID parameter. an existing credit note","response":"getCreditNoteByID.html"

Parameters:

  • credit_note_id —

    ID of the credit-note.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



84
85
86
87
 
# File 'lib/bf_ruby2/api/creditnotes_api.rb', line 84

def get_credit_note_by_id(credit_note_id, opts = {})
  data, _status_code, _headers = get_credit_note_by_id_with_http_info(credit_note_id, opts)
  return data
end

#get_credit_note_by_id_with_http_info(credit_note_id, opts = {}) ⇒ Array<(CreditNotePagedMetadata, Fixnum, Hash)>

Returns a single credit-note, specified by the ID parameter. an existing credit note&quot;,&quot;response&quot;:&quot;getCreditNoteByID.html&quot;

Parameters:

  • credit_note_id —

    ID of the credit-note.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:

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

    CreditNotePagedMetadata data, response status code and response headers



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
129
130
131
132
133
134
 
# File 'lib/bf_ruby2/api/creditnotes_api.rb', line 95

def get_credit_note_by_id_with_http_info(credit_note_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CreditnotesApi.get_credit_note_by_id ..."
  end
  # verify the required parameter 'credit_note_id' is set
  if @api_client.config.client_side_validation && credit_note_id.nil?
    fail ArgumentError, "Missing the required parameter 'credit_note_id' when calling CreditnotesApi.get_credit_note_by_id"
  end
  # resource path
  local_var_path = "/credit-notes/{credit-note-ID}".sub('{' + 'credit-note-ID' + '}', credit_note_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'CreditNotePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CreditnotesApi#get_credit_note_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_credit_note_for_account(account_id, opts = {}) ⇒ CreditNotePagedMetadata

Returns credit notes for an account. by account","response":"getCreditNotesByAccount.html"

Parameters:

  • account_id —

    ID of the account.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first payment to return. (default to 0)

  • :records (Integer) —

    The maximum number of payments to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to id)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

Returns:



146
147
148
149
 
# File 'lib/bf_ruby2/api/creditnotes_api.rb', line 146

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

#get_credit_note_for_account_with_http_info(account_id, opts = {}) ⇒ Array<(CreditNotePagedMetadata, Fixnum, Hash)>

Returns credit notes for an account. by account&quot;,&quot;response&quot;:&quot;getCreditNotesByAccount.html&quot;

Parameters:

  • account_id —

    ID of the account.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first payment to return.

  • :records (Integer) —

    The maximum number of payments to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

Returns:

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

    CreditNotePagedMetadata data, response status code and response headers



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
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/bf_ruby2/api/creditnotes_api.rb', line 161

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CreditnotesApi.get_credit_note_for_account ..."
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling CreditnotesApi.get_credit_note_for_account"
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/credit-notes/account/{account-ID}".sub('{' + 'account-ID' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'CreditNotePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CreditnotesApi#get_credit_note_for_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_credit_note_for_invoice(invoice_id, opts = {}) ⇒ CreditNotePagedMetadata

Returns credit notes for an invoice. by invoice","response":"getCreditNotesByInvoice.html"

Parameters:

  • invoice_id —

    ID of the Invoice.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first payment to return. (default to 0)

  • :records (Integer) —

    The maximum number of payments to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to id)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

Returns:



219
220
221
222
 
# File 'lib/bf_ruby2/api/creditnotes_api.rb', line 219

def get_credit_note_for_invoice(invoice_id, opts = {})
  data, _status_code, _headers = get_credit_note_for_invoice_with_http_info(invoice_id, opts)
  return data
end

#get_credit_note_for_invoice_with_http_info(invoice_id, opts = {}) ⇒ Array<(CreditNotePagedMetadata, Fixnum, Hash)>

Returns credit notes for an invoice. by invoice&quot;,&quot;response&quot;:&quot;getCreditNotesByInvoice.html&quot;

Parameters:

  • invoice_id —

    ID of the Invoice.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first payment to return.

  • :records (Integer) —

    The maximum number of payments to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

Returns:

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

    CreditNotePagedMetadata data, response status code and response headers



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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/bf_ruby2/api/creditnotes_api.rb', line 234

def get_credit_note_for_invoice_with_http_info(invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CreditnotesApi.get_credit_note_for_invoice ..."
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling CreditnotesApi.get_credit_note_for_invoice"
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/credit-notes/invoice/{invoice-ID}".sub('{' + 'invoice-ID' + '}', invoice_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'CreditNotePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CreditnotesApi#get_credit_note_for_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_credit_note_for_subscription(subscription_id, opts = {}) ⇒ CreditNotePagedMetadata

Returns credit notes for an subscription. by subscription","response":"getCreditNotesSubscription.html"

Parameters:

  • subscription_id —

    ID of the subscription.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first payment to return. (default to 0)

  • :records (Integer) —

    The maximum number of payments to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to id)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

Returns:



292
293
294
295
 
# File 'lib/bf_ruby2/api/creditnotes_api.rb', line 292

def get_credit_note_for_subscription(subscription_id, opts = {})
  data, _status_code, _headers = get_credit_note_for_subscription_with_http_info(subscription_id, opts)
  return data
end

#get_credit_note_for_subscription_with_http_info(subscription_id, opts = {}) ⇒ Array<(CreditNotePagedMetadata, Fixnum, Hash)>

Returns credit notes for an subscription. by subscription&quot;,&quot;response&quot;:&quot;getCreditNotesSubscription.html&quot;

Parameters:

  • subscription_id —

    ID of the subscription.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first payment to return.

  • :records (Integer) —

    The maximum number of payments to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

Returns:

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

    CreditNotePagedMetadata data, response status code and response headers



307
308
309
310
311
312
313
314
315
316
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
 
# File 'lib/bf_ruby2/api/creditnotes_api.rb', line 307

def get_credit_note_for_subscription_with_http_info(subscription_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CreditnotesApi.get_credit_note_for_subscription ..."
  end
  # verify the required parameter 'subscription_id' is set
  if @api_client.config.client_side_validation && subscription_id.nil?
    fail ArgumentError, "Missing the required parameter 'subscription_id' when calling CreditnotesApi.get_credit_note_for_subscription"
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/credit-notes/subscription/{subscription-ID}".sub('{' + 'subscription-ID' + '}', subscription_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'CreditNotePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CreditnotesApi#get_credit_note_for_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retire_credit_note(credit_note_id, organizations, opts = {}) ⇒ CreditNotePagedMetadata

Removes any remaining value from credit note remaining value from credit note","response":"deleteCreditNote.html"

Parameters:

  • credit_note_id —

    ID of the credit-note.

  • organizations —

    A list of organization-IDs used to restrict the scope of API calls.

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

    the optional parameters

Returns:



361
362
363
364
 
# File 'lib/bf_ruby2/api/creditnotes_api.rb', line 361

def retire_credit_note(credit_note_id, organizations, opts = {})
  data, _status_code, _headers = retire_credit_note_with_http_info(credit_note_id, organizations, opts)
  return data
end

#retire_credit_note_with_http_info(credit_note_id, organizations, opts = {}) ⇒ Array<(CreditNotePagedMetadata, Fixnum, Hash)>

Removes any remaining value from credit note remaining value from credit note&quot;,&quot;response&quot;:&quot;deleteCreditNote.html&quot;

Parameters:

  • credit_note_id —

    ID of the credit-note.

  • organizations —

    A list of organization-IDs used to restrict the scope of API calls.

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

    the optional parameters

Returns:

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

    CreditNotePagedMetadata data, response status code and response headers



372
373
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
 
# File 'lib/bf_ruby2/api/creditnotes_api.rb', line 372

def retire_credit_note_with_http_info(credit_note_id, organizations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CreditnotesApi.retire_credit_note ..."
  end
  # verify the required parameter 'credit_note_id' is set
  if @api_client.config.client_side_validation && credit_note_id.nil?
    fail ArgumentError, "Missing the required parameter 'credit_note_id' when calling CreditnotesApi.retire_credit_note"
  end
  # verify the required parameter 'organizations' is set
  if @api_client.config.client_side_validation && organizations.nil?
    fail ArgumentError, "Missing the required parameter 'organizations' when calling CreditnotesApi.retire_credit_note"
  end
  # resource path
  local_var_path = "/credit-notes/{credit-note-ID}".sub('{' + 'credit-note-ID' + '}', credit_note_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(organizations, :multi)

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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,
    :return_type => 'CreditNotePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CreditnotesApi#retire_credit_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end