Class: Bfwd::AmendmentsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AmendmentsApi

Returns a new instance of AmendmentsApi.



19
20
21
 
# File 'lib/bf_ruby2/api/amendments_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/amendments_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_amendment(amendment, opts = {}) ⇒ AmendmentPagedMetadata

Create an amendment. {"nickname":"Create a new amendment","request":"createAmendmentRequest.html","response":"createAmendmentResponse.html" }

Parameters:

  • amendment —

    The amendment object to be created.

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

    the optional parameters

Returns:



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

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

#create_amendment_with_http_info(amendment, opts = {}) ⇒ Array<(AmendmentPagedMetadata, Fixnum, Hash)>

Create an amendment. {&quot;nickname&quot;:&quot;Create a new amendment&quot;,&quot;request&quot;:&quot;createAmendmentRequest.html&quot;,&quot;response&quot;:&quot;createAmendmentResponse.html&quot; }

Parameters:

  • amendment —

    The amendment object to be created.

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

    the optional parameters

Returns:

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

    AmendmentPagedMetadata 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/amendments_api.rb', line 38

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

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

#get_all_amendments(opts = {}) ⇒ AmendmentPagedMetadata

Returns a collection of all amendments. By default 10 values are returned. Records are returned in natural order. all amendments","response":"getAmendmentAll.html"

Parameters:

  • 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 amendment to return. (default to 0)

  • :records (Integer) —

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

  • :order_by (String) —

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

  • :order (String) —

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

  • :invoice_id (String) —

    Ihe invoice ID associated with the amendment.

  • :state (String) —

    Ihe state of the amendment.

  • :type (String) —

    Ihe type of amendment.

Returns:



90
91
92
93
 
# File 'lib/bf_ruby2/api/amendments_api.rb', line 90

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

#get_all_amendments_with_http_info(opts = {}) ⇒ Array<(AmendmentPagedMetadata, Fixnum, Hash)>

Returns a collection of all amendments. By default 10 values are returned. Records are returned in natural order. all amendments&quot;,&quot;response&quot;:&quot;getAmendmentAll.html&quot;

Parameters:

  • 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 amendment to return.

  • :records (Integer) —

    The maximum number of amendments 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.

  • :invoice_id (String) —

    Ihe invoice ID associated with the amendment.

  • :state (String) —

    Ihe state of the amendment.

  • :type (String) —

    Ihe type of amendment.

Returns:

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

    AmendmentPagedMetadata data, response status code and response headers



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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/bf_ruby2/api/amendments_api.rb', line 107

def get_all_amendments_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AmendmentsApi.get_all_amendments ..."
  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
  if @api_client.config.client_side_validation && opts[:'state'] && !['Pending', 'Succeeded', 'Failed', 'Discarded'].include?(opts[:'state'])
    fail ArgumentError, 'invalid value for "state", must be one of Pending, Succeeded, Failed, Discarded'
  end
  if @api_client.config.client_side_validation && opts[:'type'] && !['InvoiceNextExecutionAttempt', 'Cancellation', 'PricingComponentValue', 'AmendmentDiscard', 'Compound', 'FixedTermExpiry', 'InvoiceRecalculation', 'EndTrial', 'InvoiceOutstandingCharges', 'IssueInvoice', 'ProductRatePlanMigration', 'UpdateComponentValue', 'ServiceEnd', 'ResumeSubscription', 'CreateSubscriptionCharge', 'Timer'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of InvoiceNextExecutionAttempt, Cancellation, PricingComponentValue, AmendmentDiscard, Compound, FixedTermExpiry, InvoiceRecalculation, EndTrial, InvoiceOutstandingCharges, IssueInvoice, ProductRatePlanMigration, UpdateComponentValue, ServiceEnd, ResumeSubscription, CreateSubscriptionCharge, Timer'
  end
  # resource path
  local_var_path = "/amendments"

  # 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?
  query_params[:'invoice_id'] = opts[:'invoice_id'] if !opts[:'invoice_id'].nil?
  query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?

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

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

#get_amendment_by_id(amendment_id, opts = {}) ⇒ AmendmentPagedMetadata

Returns a single amendment, specified by the amendment-ID parameter. an existing amendment","response":"getAmendmentByID.html"

Parameters:

  • amendment_id —

    The unique string-ID of the amendment.

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



164
165
166
167
 
# File 'lib/bf_ruby2/api/amendments_api.rb', line 164

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

#get_amendment_by_id_with_http_info(amendment_id, opts = {}) ⇒ Array<(AmendmentPagedMetadata, Fixnum, Hash)>

Returns a single amendment, specified by the amendment-ID parameter. an existing amendment&quot;,&quot;response&quot;:&quot;getAmendmentByID.html&quot;

Parameters:

  • amendment_id —

    The unique string-ID of the amendment.

  • 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<(AmendmentPagedMetadata, Fixnum, Hash)>) —

    AmendmentPagedMetadata data, response status code and response headers



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
208
209
210
211
212
213
214
 
# File 'lib/bf_ruby2/api/amendments_api.rb', line 175

def get_amendment_by_id_with_http_info(amendment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AmendmentsApi.get_amendment_by_id ..."
  end
  # verify the required parameter 'amendment_id' is set
  if @api_client.config.client_side_validation && amendment_id.nil?
    fail ArgumentError, "Missing the required parameter 'amendment_id' when calling AmendmentsApi.get_amendment_by_id"
  end
  # resource path
  local_var_path = "/amendments/{amendment-ID}".sub('{' + 'amendment-ID' + '}', amendment_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 => 'AmendmentPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AmendmentsApi#get_amendment_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_amendment_by_state(state, opts = {}) ⇒ AmendmentPagedMetadata

Returns a collection of amendments, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. by state","response":"getAmendmentsByState.html"

Parameters:

  • state —

    The current state of the amendment, either pending, succeeded, failed or discarded

  • 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 amendment to return. (default to 0)

  • :records (Integer) —

    The maximum number of amendments 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:



226
227
228
229
 
# File 'lib/bf_ruby2/api/amendments_api.rb', line 226

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

#get_amendment_by_state_with_http_info(state, opts = {}) ⇒ Array<(AmendmentPagedMetadata, Fixnum, Hash)>

Returns a collection of amendments, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. by state&quot;,&quot;response&quot;:&quot;getAmendmentsByState.html&quot;

Parameters:

  • state —

    The current state of the amendment, either pending, succeeded, failed or discarded

  • 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 amendment to return.

  • :records (Integer) —

    The maximum number of amendments 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<(AmendmentPagedMetadata, Fixnum, Hash)>) —

    AmendmentPagedMetadata data, response status code and response headers



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
281
282
283
284
285
286
287
288
289
 
# File 'lib/bf_ruby2/api/amendments_api.rb', line 241

def get_amendment_by_state_with_http_info(state, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AmendmentsApi.get_amendment_by_state ..."
  end
  # verify the required parameter 'state' is set
  if @api_client.config.client_side_validation && state.nil?
    fail ArgumentError, "Missing the required parameter 'state' when calling AmendmentsApi.get_amendment_by_state"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Pending', 'Succeeded', 'Failed', 'Discarded'].include?(state)
    fail ArgumentError, "invalid value for 'state', must be one of Pending, Succeeded, Failed, Discarded"
  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 = "/amendments/state/{state}".sub('{' + 'state' + '}', state.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'])

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

#get_amendment_by_subscription_id(subscription_id, opts = {}) ⇒ AmendmentPagedMetadata

Returns a collection of amendments, specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. by subscription","response":"getAmendmentsBySubscription.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 amendment to return. (default to 0)

  • :records (Integer) —

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

  • :order_by (String) —

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

  • :order (String) —

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

Returns:



301
302
303
304
 
# File 'lib/bf_ruby2/api/amendments_api.rb', line 301

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

#get_amendment_by_subscription_id_with_http_info(subscription_id, opts = {}) ⇒ Array<(AmendmentPagedMetadata, Fixnum, Hash)>

Returns a collection of amendments, specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. by subscription&quot;,&quot;response&quot;:&quot;getAmendmentsBySubscription.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 amendment to return.

  • :records (Integer) —

    The maximum number of amendments to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    The direction of any ordering, either ASC or DESC.

Returns:

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

    AmendmentPagedMetadata data, response status code and response headers



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
354
355
356
357
358
359
360
361
362
 
# File 'lib/bf_ruby2/api/amendments_api.rb', line 316

def get_amendment_by_subscription_id_with_http_info(subscription_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AmendmentsApi.get_amendment_by_subscription_id ..."
  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 AmendmentsApi.get_amendment_by_subscription_id"
  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 = "/amendments/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 => 'AmendmentPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AmendmentsApi#get_amendment_by_subscription_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_amendment_swagger(query_string, opts = {}) ⇒ SwaggerTypeList

"nickname":"","response":""

Parameters:

  • query_string —

    The query string used to search.

  • 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 starting index of the search results. (default to 0)

  • :records (Integer) —

    The number of search results to return. (default to 10)

  • :wildcard (BOOLEAN) —

    Toggle if we search for full words or whether a wildcard is used. (default to false)

  • :entity (BOOLEAN) —

    Is an entity returned with the search results. (default to false)

Returns:



374
375
376
377
 
# File 'lib/bf_ruby2/api/amendments_api.rb', line 374

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

#get_amendment_swagger_with_http_info(query_string, opts = {}) ⇒ Array<(SwaggerTypeList, Fixnum, Hash)>

&quot;nickname&quot;:&quot;&quot;,&quot;response&quot;:&quot;&quot;

Parameters:

  • query_string —

    The query string used to search.

  • 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 starting index of the search results.

  • :records (Integer) —

    The number of search results to return.

  • :wildcard (BOOLEAN) —

    Toggle if we search for full words or whether a wildcard is used.

  • :entity (BOOLEAN) —

    Is an entity returned with the search results.

Returns:

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

    SwaggerTypeList data, response status code and response headers



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/bf_ruby2/api/amendments_api.rb', line 389

def get_amendment_swagger_with_http_info(query_string, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AmendmentsApi.get_amendment_swagger ..."
  end
  # verify the required parameter 'query_string' is set
  if @api_client.config.client_side_validation && query_string.nil?
    fail ArgumentError, "Missing the required parameter 'query_string' when calling AmendmentsApi.get_amendment_swagger"
  end
  # resource path
  local_var_path = "/amendments/swagger-end-point/{query-string}".sub('{' + 'query-string' + '}', query_string.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[:'wildcard'] = opts[:'wildcard'] if !opts[:'wildcard'].nil?
  query_params[:'entity'] = opts[:'entity'] if !opts[:'entity'].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 => 'SwaggerTypeList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AmendmentsApi#get_amendment_swagger\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_amendments_by_actioning_time(lower_threshold, upper_threshold, opts = {}) ⇒ AmendmentPagedMetadata

Returns a collection of amendment objects with an actioning-time within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. by actioning","response":"getAmendmentByActioningTime.html"

Parameters:

  • lower_threshold —

    The UTC DateTime specifying the start of the result period.

  • upper_threshold —

    The UTC DateTime specifying the end of the result period.

  • 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 amendment to return. (default to 0)

  • :records (Integer) —

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

  • :order_by (String) —

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

  • :order (String) —

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

Returns:



445
446
447
448
 
# File 'lib/bf_ruby2/api/amendments_api.rb', line 445

def get_amendments_by_actioning_time(lower_threshold, upper_threshold, opts = {})
  data, _status_code, _headers = get_amendments_by_actioning_time_with_http_info(lower_threshold, upper_threshold, opts)
  return data
end

#get_amendments_by_actioning_time_with_http_info(lower_threshold, upper_threshold, opts = {}) ⇒ Array<(AmendmentPagedMetadata, Fixnum, Hash)>

Returns a collection of amendment objects with an actioning-time within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. by actioning&quot;,&quot;response&quot;:&quot;getAmendmentByActioningTime.html&quot;

Parameters:

  • lower_threshold —

    The UTC DateTime specifying the start of the result period.

  • upper_threshold —

    The UTC DateTime specifying the end of the result period.

  • 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 amendment to return.

  • :records (Integer) —

    The maximum number of amendments 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<(AmendmentPagedMetadata, Fixnum, Hash)>) —

    AmendmentPagedMetadata data, response status code and response headers



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
 
# File 'lib/bf_ruby2/api/amendments_api.rb', line 461

def get_amendments_by_actioning_time_with_http_info(lower_threshold, upper_threshold, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AmendmentsApi.get_amendments_by_actioning_time ..."
  end
  # verify the required parameter 'lower_threshold' is set
  if @api_client.config.client_side_validation && lower_threshold.nil?
    fail ArgumentError, "Missing the required parameter 'lower_threshold' when calling AmendmentsApi.get_amendments_by_actioning_time"
  end
  # verify the required parameter 'upper_threshold' is set
  if @api_client.config.client_side_validation && upper_threshold.nil?
    fail ArgumentError, "Missing the required parameter 'upper_threshold' when calling AmendmentsApi.get_amendments_by_actioning_time"
  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 = "/amendments/actioning-time/{lower-threshold}/{upper-threshold}".sub('{' + 'lower-threshold' + '}', lower_threshold.to_s).sub('{' + 'upper-threshold' + '}', upper_threshold.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'])

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

#get_amendments_by_created_date(lower_threshold, upper_threshold, opts = {}) ⇒ AmendmentPagedMetadata

Returns a collection of amendment objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. by creation","response":"getAmendmentByCreated.html"

Parameters:

  • lower_threshold —

    The UTC DateTime specifying the start of the result period.

  • upper_threshold —

    The UTC DateTime specifying the end of the result period.

  • 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 amendment to return. (default to 0)

  • :records (Integer) —

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

  • :order_by (String) —

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

  • :order (String) —

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

Returns:



522
523
524
525
 
# File 'lib/bf_ruby2/api/amendments_api.rb', line 522

def get_amendments_by_created_date(lower_threshold, upper_threshold, opts = {})
  data, _status_code, _headers = get_amendments_by_created_date_with_http_info(lower_threshold, upper_threshold, opts)
  return data
end

#get_amendments_by_created_date_with_http_info(lower_threshold, upper_threshold, opts = {}) ⇒ Array<(AmendmentPagedMetadata, Fixnum, Hash)>

Returns a collection of amendment objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. by creation&quot;,&quot;response&quot;:&quot;getAmendmentByCreated.html&quot;

Parameters:

  • lower_threshold —

    The UTC DateTime specifying the start of the result period.

  • upper_threshold —

    The UTC DateTime specifying the end of the result period.

  • 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 amendment to return.

  • :records (Integer) —

    The maximum number of amendments 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<(AmendmentPagedMetadata, Fixnum, Hash)>) —

    AmendmentPagedMetadata data, response status code and response headers



538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
 
# File 'lib/bf_ruby2/api/amendments_api.rb', line 538

def get_amendments_by_created_date_with_http_info(lower_threshold, upper_threshold, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AmendmentsApi.get_amendments_by_created_date ..."
  end
  # verify the required parameter 'lower_threshold' is set
  if @api_client.config.client_side_validation && lower_threshold.nil?
    fail ArgumentError, "Missing the required parameter 'lower_threshold' when calling AmendmentsApi.get_amendments_by_created_date"
  end
  # verify the required parameter 'upper_threshold' is set
  if @api_client.config.client_side_validation && upper_threshold.nil?
    fail ArgumentError, "Missing the required parameter 'upper_threshold' when calling AmendmentsApi.get_amendments_by_created_date"
  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 = "/amendments/created/{lower-threshold}/{upper-threshold}".sub('{' + 'lower-threshold' + '}', lower_threshold.to_s).sub('{' + 'upper-threshold' + '}', upper_threshold.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'])

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

#get_amendments_by_updated_date(lower_threshold, upper_threshold, opts = {}) ⇒ AmendmentPagedMetadata

Returns a collection of amendment objects with updated times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. by updated","response":"getAmendmentByUpdated.html"

Parameters:

  • lower_threshold —

    The UTC DateTime specifying the start of the result period.

  • upper_threshold —

    The UTC DateTime specifying the end of the result period.

  • 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 amendment to return. (default to 0)

  • :records (Integer) —

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

  • :order_by (String) —

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

  • :order (String) —

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

Returns:



599
600
601
602
 
# File 'lib/bf_ruby2/api/amendments_api.rb', line 599

def get_amendments_by_updated_date(lower_threshold, upper_threshold, opts = {})
  data, _status_code, _headers = get_amendments_by_updated_date_with_http_info(lower_threshold, upper_threshold, opts)
  return data
end

#get_amendments_by_updated_date_with_http_info(lower_threshold, upper_threshold, opts = {}) ⇒ Array<(AmendmentPagedMetadata, Fixnum, Hash)>

Returns a collection of amendment objects with updated times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. by updated&quot;,&quot;response&quot;:&quot;getAmendmentByUpdated.html&quot;

Parameters:

  • lower_threshold —

    The UTC DateTime specifying the start of the result period.

  • upper_threshold —

    The UTC DateTime specifying the end of the result period.

  • 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 amendment to return.

  • :records (Integer) —

    The maximum number of amendments 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<(AmendmentPagedMetadata, Fixnum, Hash)>) —

    AmendmentPagedMetadata data, response status code and response headers



615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
 
# File 'lib/bf_ruby2/api/amendments_api.rb', line 615

def get_amendments_by_updated_date_with_http_info(lower_threshold, upper_threshold, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AmendmentsApi.get_amendments_by_updated_date ..."
  end
  # verify the required parameter 'lower_threshold' is set
  if @api_client.config.client_side_validation && lower_threshold.nil?
    fail ArgumentError, "Missing the required parameter 'lower_threshold' when calling AmendmentsApi.get_amendments_by_updated_date"
  end
  # verify the required parameter 'upper_threshold' is set
  if @api_client.config.client_side_validation && upper_threshold.nil?
    fail ArgumentError, "Missing the required parameter 'upper_threshold' when calling AmendmentsApi.get_amendments_by_updated_date"
  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 = "/amendments/updated/{lower-threshold}/{upper-threshold}".sub('{' + 'lower-threshold' + '}', lower_threshold.to_s).sub('{' + 'upper-threshold' + '}', upper_threshold.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'])

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

#retire_amendment(amendment_id, organizations, opts = {}) ⇒ AmendmentPagedMetadata

Retires the amendment specified by the amendment-ID parameter. Retiring a amendment causes it to cancel based on the specificed retirement settings for the product. an amendment","response":"deleteAmendment.html"

Parameters:

  • amendment_id —

    ID of the amendment.

  • organizations —

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

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

    the optional parameters

Returns:



671
672
673
674
 
# File 'lib/bf_ruby2/api/amendments_api.rb', line 671

def retire_amendment(amendment_id, organizations, opts = {})
  data, _status_code, _headers = retire_amendment_with_http_info(amendment_id, organizations, opts)
  return data
end

#retire_amendment_with_http_info(amendment_id, organizations, opts = {}) ⇒ Array<(AmendmentPagedMetadata, Fixnum, Hash)>

Retires the amendment specified by the amendment-ID parameter. Retiring a amendment causes it to cancel based on the specificed retirement settings for the product. an amendment&quot;,&quot;response&quot;:&quot;deleteAmendment.html&quot;

Parameters:

  • amendment_id —

    ID of the amendment.

  • organizations —

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

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

    the optional parameters

Returns:

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

    AmendmentPagedMetadata data, response status code and response headers



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
712
713
714
715
716
717
718
719
720
721
722
723
724
725
 
# File 'lib/bf_ruby2/api/amendments_api.rb', line 682

def retire_amendment_with_http_info(amendment_id, organizations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AmendmentsApi.retire_amendment ..."
  end
  # verify the required parameter 'amendment_id' is set
  if @api_client.config.client_side_validation && amendment_id.nil?
    fail ArgumentError, "Missing the required parameter 'amendment_id' when calling AmendmentsApi.retire_amendment"
  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 AmendmentsApi.retire_amendment"
  end
  # resource path
  local_var_path = "/amendments/{amendment-ID}".sub('{' + 'amendment-ID' + '}', amendment_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 => 'AmendmentPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AmendmentsApi#retire_amendment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_amendment(amendment, opts = {}) ⇒ AmendmentPagedMetadata

Update an amendment. {"nickname":"Update an amendment","request":"updateAmendmentRequest.html","response":"updateAmendmentResponse.html" }

Parameters:

  • amendment —

    The amendment object to be updated.

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

    the optional parameters

Returns:



732
733
734
735
 
# File 'lib/bf_ruby2/api/amendments_api.rb', line 732

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

#update_amendment_with_http_info(amendment, opts = {}) ⇒ Array<(AmendmentPagedMetadata, Fixnum, Hash)>

Update an amendment. {&quot;nickname&quot;:&quot;Update an amendment&quot;,&quot;request&quot;:&quot;updateAmendmentRequest.html&quot;,&quot;response&quot;:&quot;updateAmendmentResponse.html&quot; }

Parameters:

  • amendment —

    The amendment object to be updated.

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

    the optional parameters

Returns:

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

    AmendmentPagedMetadata data, response status code and response headers



742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/bf_ruby2/api/amendments_api.rb', line 742

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

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