Class: SubskribeSandboxClient::SettingsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/subskribe_sandbox/api/settings_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SettingsApi

Returns a new instance of SettingsApi.



19
20
21
 
# File 'lib/subskribe_sandbox/api/settings_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/subskribe_sandbox/api/settings_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

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

Activate unit of measure Activates the specified unit of measure making it available to be attached to charges

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 27

def activate_unit_of_measure(id, opts = {})
  activate_unit_of_measure_with_http_info(id, opts)
  nil
end

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

Activate unit of measure Activates the specified unit of measure making it available to be attached to charges

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
64
65
66
67
68
69
70
71
72
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 37

def activate_unit_of_measure_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.activate_unit_of_measure ...'
  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 SettingsApi.activate_unit_of_measure"
  end
  # resource path
  local_var_path = '/unitsOfMeasure/{id}/activate'.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 = ['ApiKeyAuth']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SettingsApi#activate_unit_of_measure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#add_tax_rate(opts = {}) ⇒ TaxRateJson

Add tax rate Add a new tax rate object

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



78
79
80
81
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 78

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

#add_tax_rate_with_http_info(opts = {}) ⇒ Array<(TaxRateJson, Fixnum, Hash)>

Add tax rate Add a new tax rate object

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    TaxRateJson data, response status code and response headers



88
89
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
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 88

def add_tax_rate_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.add_tax_rate ...'
  end
  # resource path
  local_var_path = '/taxrates'

  # 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(opts[:'body'])
  auth_names = ['ApiKeyAuth']
  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 => 'TaxRateJson')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SettingsApi#add_tax_rate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#add_term_section(opts = {}) ⇒ DocumentSection

Add predefined terms section Adds a predefined terms section.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



128
129
130
131
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 128

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

#add_term_section_with_http_info(opts = {}) ⇒ Array<(DocumentSection, Fixnum, Hash)>

Add predefined terms section Adds a predefined terms section.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    DocumentSection data, response status code and response headers



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 138

def add_term_section_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.add_term_section ...'
  end
  # resource path
  local_var_path = '/termsections'

  # 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 = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['ApiKeyAuth']
  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 => 'DocumentSection')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SettingsApi#add_term_section\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#add_unit_of_measure(opts = {}) ⇒ UnitOfMeasureJson

Add unit of measure Add a new instance of unit of measure as specified by the input

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



176
177
178
179
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 176

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

#add_unit_of_measure_with_http_info(opts = {}) ⇒ Array<(UnitOfMeasureJson, Fixnum, Hash)>

Add unit of measure Add a new instance of unit of measure as specified by the input

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    UnitOfMeasureJson data, response status code and response headers



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 186

def add_unit_of_measure_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.add_unit_of_measure ...'
  end
  # resource path
  local_var_path = '/unitsOfMeasure'

  # 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(opts[:'body'])
  auth_names = ['ApiKeyAuth']
  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 => 'UnitOfMeasureJson')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SettingsApi#add_unit_of_measure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_tax_rate(id, opts = {}) ⇒ TaxRateJson

Delete tax rate Deletes the tax rate object by Id. If successful the deleted tax rate object is returned

Parameters:

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

    the optional parameters

Returns:



226
227
228
229
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 226

def delete_tax_rate(id, opts = {})
  data, _status_code, _headers = delete_tax_rate_with_http_info(id, opts)
  data
end

#delete_tax_rate_with_http_info(id, opts = {}) ⇒ Array<(TaxRateJson, Fixnum, Hash)>

Delete tax rate Deletes the tax rate object by Id. If successful the deleted tax rate object is returned

Parameters:

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

    the optional parameters

Returns:

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

    TaxRateJson data, response status code and response headers



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
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 236

def delete_tax_rate_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.delete_tax_rate ...'
  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 SettingsApi.delete_tax_rate"
  end
  # resource path
  local_var_path = '/taxrates/{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 = ['ApiKeyAuth']
  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 => 'TaxRateJson')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SettingsApi#delete_tax_rate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete predefined terms section Deletes the predefined terms section specified.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


278
279
280
281
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 278

def delete_term_section(id, opts = {})
  delete_term_section_with_http_info(id, opts)
  nil
end

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

Delete predefined terms section Deletes the predefined terms section specified.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 288

def delete_term_section_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.delete_term_section ...'
  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 SettingsApi.delete_term_section"
  end
  # resource path
  local_var_path = '/termsections/{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 = ['ApiKeyAuth']
  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: SettingsApi#delete_term_section\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_unit_of_measure(id, opts = {}) ⇒ UnitOfMeasureJson

Delete unit of measure Delete the unit of measure by Id provided. Returns the deleted unit of measure object if successful.

Parameters:

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

    the optional parameters

Returns:



329
330
331
332
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 329

def delete_unit_of_measure(id, opts = {})
  data, _status_code, _headers = delete_unit_of_measure_with_http_info(id, opts)
  data
end

#delete_unit_of_measure_with_http_info(id, opts = {}) ⇒ Array<(UnitOfMeasureJson, Fixnum, Hash)>

Delete unit of measure Delete the unit of measure by Id provided. Returns the deleted unit of measure object if successful.

Parameters:

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

    the optional parameters

Returns:

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

    UnitOfMeasureJson data, response status code and response headers



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 339

def delete_unit_of_measure_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.delete_unit_of_measure ...'
  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 SettingsApi.delete_unit_of_measure"
  end
  # resource path
  local_var_path = '/unitsOfMeasure/{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 = ['ApiKeyAuth']
  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 => 'UnitOfMeasureJson')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SettingsApi#delete_unit_of_measure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Deprecate unit of measure Deprecates the specified unit of measure making it unavailable to be attached to charges going forward

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


381
382
383
384
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 381

def deprecate_unit_of_measure(id, opts = {})
  deprecate_unit_of_measure_with_http_info(id, opts)
  nil
end

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

Deprecate unit of measure Deprecates the specified unit of measure making it unavailable to be attached to charges going forward

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
423
424
425
426
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 391

def deprecate_unit_of_measure_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.deprecate_unit_of_measure ...'
  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 SettingsApi.deprecate_unit_of_measure"
  end
  # resource path
  local_var_path = '/unitsOfMeasure/{id}/deprecate'.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 = ['ApiKeyAuth']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SettingsApi#deprecate_unit_of_measure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_payment_term_settings(opts = {}) ⇒ nil

Get payment term settings

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


431
432
433
434
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 431

def get_payment_term_settings(opts = {})
  get_payment_term_settings_with_http_info(opts)
  nil
end

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

Get payment term settings

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 440

def get_payment_term_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.get_payment_term_settings ...'
  end
  # resource path
  local_var_path = '/settings/paymentTerms'

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

#get_supported_currencies(opts = {}) ⇒ nil

Get supported currencies Get supported currencies for your tenant

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


476
477
478
479
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 476

def get_supported_currencies(opts = {})
  get_supported_currencies_with_http_info(opts)
  nil
end

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

Get supported currencies Get supported currencies for your tenant

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 485

def get_supported_currencies_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.get_supported_currencies ...'
  end
  # resource path
  local_var_path = '/settings/supportedCurrencies'

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

#get_tax_rate(id, opts = {}) ⇒ TaxRatePaginationResponseJson

Get tax rate by Id Retrieves the tax rate object by Id

Parameters:

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

    the optional parameters

Returns:



522
523
524
525
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 522

def get_tax_rate(id, opts = {})
  data, _status_code, _headers = get_tax_rate_with_http_info(id, opts)
  data
end

#get_tax_rate_with_http_info(id, opts = {}) ⇒ Array<(TaxRatePaginationResponseJson, Fixnum, Hash)>

Get tax rate by Id Retrieves the tax rate object by Id

Parameters:

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

    the optional parameters

Returns:



532
533
534
535
536
537
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
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 532

def get_tax_rate_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.get_tax_rate ...'
  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 SettingsApi.get_tax_rate"
  end
  # resource path
  local_var_path = '/taxrates/{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 = ['ApiKeyAuth']
  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 => 'TaxRatePaginationResponseJson')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SettingsApi#get_tax_rate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tax_rates(opts = {}) ⇒ TaxRatePaginationResponseJson

Get tax rates Get all available tax rates. The result is paginated. To retrieve all results pass the cursor returned from a call to the next call until all results are returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String)
  • :limit (Integer)

Returns:



575
576
577
578
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 575

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

#get_tax_rates_with_http_info(opts = {}) ⇒ Array<(TaxRatePaginationResponseJson, Fixnum, Hash)>

Get tax rates Get all available tax rates. The result is paginated. To retrieve all results pass the cursor returned from a call to the next call until all results are returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String)
  • :limit (Integer)

Returns:



586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 586

def get_tax_rates_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.get_tax_rates ...'
  end
  # resource path
  local_var_path = '/taxrates'

  # query parameters
  query_params = {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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 = ['ApiKeyAuth']
  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 => 'TaxRatePaginationResponseJson')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SettingsApi#get_tax_rates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tenant(opts = {}) ⇒ TenantJson

Get tenant details Get the details of the current tenant

Parameters:

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

    the optional parameters

Returns:



625
626
627
628
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 625

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

#get_tenant_logo(opts = {}) ⇒ nil

Get tenant logo Get the current logo stored

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


671
672
673
674
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 671

def (opts = {})
  get_tenant_logo_with_http_info(opts)
  nil
end

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

Get tenant logo Get the current logo stored

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 680

def get_tenant_logo_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.get_tenant_logo ...'
  end
  # resource path
  local_var_path = '/tenants/logo'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#get_tenant_setting(opts = {}) ⇒ TenantSettingJson

Get tenant settings Returns all tenant settings for your tenant.

Parameters:

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

    the optional parameters

Returns:



716
717
718
719
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 716

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

#get_tenant_setting_with_http_info(opts = {}) ⇒ Array<(TenantSettingJson, Fixnum, Hash)>

Get tenant settings Returns all tenant settings for your tenant.

Parameters:

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

    the optional parameters

Returns:

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

    TenantSettingJson data, response status code and response headers



725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 725

def get_tenant_setting_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.get_tenant_setting ...'
  end
  # resource path
  local_var_path = '/settings'

  # 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 = ['ApiKeyAuth']
  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 => 'TenantSettingJson')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SettingsApi#get_tenant_setting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tenant_with_http_info(opts = {}) ⇒ Array<(TenantJson, Fixnum, Hash)>

Get tenant details Get the details of the current tenant

Parameters:

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

    the optional parameters

Returns:

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

    TenantJson data, response status code and response headers



634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 634

def get_tenant_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.get_tenant ...'
  end
  # resource path
  local_var_path = '/tenants'

  # 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 = ['ApiKeyAuth']
  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 => 'TenantJson')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SettingsApi#get_tenant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_term_section(id, opts = {}) ⇒ DocumentSection

Get predefined terms section detail Returns predefined terms section detail.

Parameters:

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

    the optional parameters

Returns:



763
764
765
766
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 763

def get_term_section(id, opts = {})
  data, _status_code, _headers = get_term_section_with_http_info(id, opts)
  data
end

#get_term_section_with_http_info(id, opts = {}) ⇒ Array<(DocumentSection, Fixnum, Hash)>

Get predefined terms section detail Returns predefined terms section detail.

Parameters:

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

    the optional parameters

Returns:

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

    DocumentSection data, response status code and response headers



773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 773

def get_term_section_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.get_term_section ...'
  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 SettingsApi.get_term_section"
  end
  # resource path
  local_var_path = '/termsections/{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 = ['ApiKeyAuth']
  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 => 'DocumentSection')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SettingsApi#get_term_section\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_term_sections(opts = {}) ⇒ DocumentSection

Get predefined terms sections Returns predefined terms sections.

Parameters:

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

    the optional parameters

Returns:



814
815
816
817
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 814

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

#get_term_sections_with_http_info(opts = {}) ⇒ Array<(DocumentSection, Fixnum, Hash)>

Get predefined terms sections Returns predefined terms sections.

Parameters:

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

    the optional parameters

Returns:

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

    DocumentSection data, response status code and response headers



823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 823

def get_term_sections_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.get_term_sections ...'
  end
  # resource path
  local_var_path = '/termsections'

  # 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 = ['ApiKeyAuth']
  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 => 'DocumentSection')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SettingsApi#get_term_sections\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_units_of_measure(opts = {}) ⇒ UnitOfMeasurePaginationResponseJson

Get units of measure Returns a paginated list of units of measure

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String)
  • :limit (Integer)

Returns:



862
863
864
865
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 862

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

#get_units_of_measure_with_http_info(opts = {}) ⇒ Array<(UnitOfMeasurePaginationResponseJson, Fixnum, Hash)>

Get units of measure Returns a paginated list of units of measure

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String)
  • :limit (Integer)

Returns:



873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 873

def get_units_of_measure_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.get_units_of_measure ...'
  end
  # resource path
  local_var_path = '/unitsOfMeasure'

  # query parameters
  query_params = {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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 = ['ApiKeyAuth']
  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 => 'UnitOfMeasurePaginationResponseJson')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SettingsApi#get_units_of_measure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_payment_term_settings(body, opts = {}) ⇒ nil

Update payment term settings

Parameters:

  • body —

    json representation of the payment term settings

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

    the optional parameters

Returns:

  • (nil) 


913
914
915
916
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 913

def update_payment_term_settings(body, opts = {})
  update_payment_term_settings_with_http_info(body, opts)
  nil
end

#update_payment_term_settings_with_http_info(body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update payment term settings

Parameters:

  • body —

    json representation of the payment term settings

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 923

def update_payment_term_settings_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.update_payment_term_settings ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling SettingsApi.update_payment_term_settings"
  end
  # resource path
  local_var_path = '/settings/paymentTerms'

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

#update_supported_currencies(opts = {}) ⇒ nil

Update supported currencies Update supported currencies for your tenant

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>)

Returns:

  • (nil) 


964
965
966
967
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 964

def update_supported_currencies(opts = {})
  update_supported_currencies_with_http_info(opts)
  nil
end

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

Update supported currencies Update supported currencies for your tenant

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>)

Returns:

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

    nil, response status code and response headers



974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 974

def update_supported_currencies_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.update_supported_currencies ...'
  end
  # resource path
  local_var_path = '/settings/supportedCurrencies'

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

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

Update tax rate Updates the specific tax rate object

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


1012
1013
1014
1015
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 1012

def update_tax_rate(id, opts = {})
  update_tax_rate_with_http_info(id, opts)
  nil
end

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

Update tax rate Updates the specific tax rate object

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 1023

def update_tax_rate_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.update_tax_rate ...'
  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 SettingsApi.update_tax_rate"
  end
  # resource path
  local_var_path = '/taxrates/{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(opts[:'body'])
  auth_names = ['ApiKeyAuth']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SettingsApi#update_tax_rate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_tenant(opts = {}) ⇒ nil

Update tenant details Updates the details of the current tenant based on the input

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


1066
1067
1068
1069
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 1066

def update_tenant(opts = {})
  update_tenant_with_http_info(opts)
  nil
end

#update_tenant_setting(body, opts = {}) ⇒ nil

Update tenant settings Updates settings for your tenant.

Parameters:

  • body —

    json representation of the settings

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

    the optional parameters

Returns:

  • (nil) 


1115
1116
1117
1118
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 1115

def update_tenant_setting(body, opts = {})
  update_tenant_setting_with_http_info(body, opts)
  nil
end

#update_tenant_setting_with_http_info(body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update tenant settings Updates settings for your tenant.

Parameters:

  • body —

    json representation of the settings

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 1125

def update_tenant_setting_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.update_tenant_setting ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling SettingsApi.update_tenant_setting"
  end
  # resource path
  local_var_path = '/settings'

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

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

Update tenant details Updates the details of the current tenant based on the input

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 1076

def update_tenant_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.update_tenant ...'
  end
  # resource path
  local_var_path = '/tenants'

  # 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(opts[:'body'])
  auth_names = ['ApiKeyAuth']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SettingsApi#update_tenant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_term_section(id, opts = {}) ⇒ DocumentSection

Update predefined terms section Updates the predefined terms section specified.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1167
1168
1169
1170
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 1167

def update_term_section(id, opts = {})
  data, _status_code, _headers = update_term_section_with_http_info(id, opts)
  data
end

#update_term_section_with_http_info(id, opts = {}) ⇒ Array<(DocumentSection, Fixnum, Hash)>

Update predefined terms section Updates the predefined terms section specified.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    DocumentSection data, response status code and response headers



1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 1178

def update_term_section_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.update_term_section ...'
  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 SettingsApi.update_term_section"
  end
  # resource path
  local_var_path = '/termsections/{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 = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['ApiKeyAuth']
  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 => 'DocumentSection')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SettingsApi#update_term_section\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_unit_of_measure(id, opts = {}) ⇒ UnitOfMeasureJson

Update unit of measure Update the unit of measure by Id provided.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1221
1222
1223
1224
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 1221

def update_unit_of_measure(id, opts = {})
  data, _status_code, _headers = update_unit_of_measure_with_http_info(id, opts)
  data
end

#update_unit_of_measure_with_http_info(id, opts = {}) ⇒ Array<(UnitOfMeasureJson, Fixnum, Hash)>

Update unit of measure Update the unit of measure by Id provided.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    UnitOfMeasureJson data, response status code and response headers



1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 1232

def update_unit_of_measure_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.update_unit_of_measure ...'
  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 SettingsApi.update_unit_of_measure"
  end
  # resource path
  local_var_path = '/unitsOfMeasure/{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 = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['ApiKeyAuth']
  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 => 'UnitOfMeasureJson')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SettingsApi#update_unit_of_measure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upload_tenant_logo(opts = {}) ⇒ TenantJson

Update tenant logo Updates the logo used in external facing communication such as order forms and invoices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :file (File)

Returns:



1274
1275
1276
1277
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 1274

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

#upload_tenant_logo_with_http_info(opts = {}) ⇒ Array<(TenantJson, Fixnum, Hash)>

Update tenant logo Updates the logo used in external facing communication such as order forms and invoices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :file (File)

Returns:

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

    TenantJson data, response status code and response headers



1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
 
# File 'lib/subskribe_sandbox/api/settings_api.rb', line 1284

def upload_tenant_logo_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.upload_tenant_logo ...'
  end
  # resource path
  local_var_path = '/tenants/logo'

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?

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