Class: Bfwd::PricingcomponentvaluechangesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PricingcomponentvaluechangesApi

Returns a new instance of PricingcomponentvaluechangesApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_pricing_component_value_change(pricing_component_value_change, opts = {}) ⇒ PricingComponentValueChangePagedMetadata

Create a pricing-component-value-change. Bfwd::PricingcomponentvaluechangesApi."nickname":"Create","request":"createPricingComponentValueChangeRequest.html","response":"createPricingComponentValueChangeResponse"nickname":"Create","request":"createPricingComponentValueChangeRequest.html","response":"createPricingComponentValueChangeResponse.html"

Parameters:

  • pricing_component_value_change —

    The pricing-component-value-change object to be updated.

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

    the optional parameters

Returns:



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

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

#create_pricing_component_value_change_with_http_info(pricing_component_value_change, opts = {}) ⇒ Array<(PricingComponentValueChangePagedMetadata, Fixnum, Hash)>

Create a pricing-component-value-change. Bfwd::PricingcomponentvaluechangesApi.&quot;nickname&quot;:&quot;Create&quot;,&quot;request&quot;:&quot;createPricingComponentValueChangeRequest.html&quot;,&quot;response&quot;:&quot;createPricingComponentValueChangeResponse&quot;nickname&quot;:&quot;Create&quot;,&quot;request&quot;:&quot;createPricingComponentValueChangeRequest.html&quot;,&quot;response&quot;:&quot;createPricingComponentValueChangeResponse.html&quot;

Parameters:

  • pricing_component_value_change —

    The pricing-component-value-change object to be updated.

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

    the optional parameters

Returns:



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

def create_pricing_component_value_change_with_http_info(pricing_component_value_change, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PricingcomponentvaluechangesApi.create_pricing_component_value_change ..."
  end
  # verify the required parameter 'pricing_component_value_change' is set
  if @api_client.config.client_side_validation && pricing_component_value_change.nil?
    fail ArgumentError, "Missing the required parameter 'pricing_component_value_change' when calling PricingcomponentvaluechangesApi.create_pricing_component_value_change"
  end
  # resource path
  local_var_path = "/pricing-component-value-changes"

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

#get_all_pricing_component_value_changes(opts = {}) ⇒ PricingComponentValueChangePagedMetadata

Returns a collection of pricing-component-value-changes. By default 10 values are returned. Records are returned in natural order. All","response":"getPricingComponentValueChangeAll.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 pricing-component-value-change to return. (default to 0)

  • :records (Integer) —

    The maximum number of pricing-component-value-changes 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:



87
88
89
90
 
# File 'lib/bf_ruby2/api/pricingcomponentvaluechanges_api.rb', line 87

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

#get_all_pricing_component_value_changes_with_http_info(opts = {}) ⇒ Array<(PricingComponentValueChangePagedMetadata, Fixnum, Hash)>

Returns a collection of pricing-component-value-changes. By default 10 values are returned. Records are returned in natural order. All&quot;,&quot;response&quot;:&quot;getPricingComponentValueChangeAll.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 pricing-component-value-change to return.

  • :records (Integer) —

    The maximum number of pricing-component-value-changes 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:



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/bf_ruby2/api/pricingcomponentvaluechanges_api.rb', line 101

def get_all_pricing_component_value_changes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PricingcomponentvaluechangesApi.get_all_pricing_component_value_changes ..."
  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 = "/pricing-component-value-changes"

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

#get_pricing_component_value_change(id, opts = {}) ⇒ PricingComponentValueChangePagedMetadata

Returns a single pricing-component-value-changes, specified by the ID parameter. by id","response":"getPricingComponentValueChangeByID.html"

Parameters:

  • id —

    The string ID of the pricing-component-value-change.

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



149
150
151
152
 
# File 'lib/bf_ruby2/api/pricingcomponentvaluechanges_api.rb', line 149

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

#get_pricing_component_value_change_by_component_id(pricing_component_id, opts = {}) ⇒ PricingComponentValueChangePagedMetadata

Returns a collection of pricing-component-value-changes, specified by the pricing-component-value-ID parameter. By default 10 values are returned. Records are returned in natural order. by Component-ID","response":"getPricingComponentValueChangeByID.html"

Parameters:

  • pricing_component_id —

    The string ID of the pricing-component-value.

  • 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 pricing-component-value-change to return. (default to 0)

  • :records (Integer) —

    The maximum number of pricing-component-value-changes 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:



211
212
213
214
 
# File 'lib/bf_ruby2/api/pricingcomponentvaluechanges_api.rb', line 211

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

#get_pricing_component_value_change_by_component_id_with_http_info(pricing_component_id, opts = {}) ⇒ Array<(PricingComponentValueChangePagedMetadata, Fixnum, Hash)>

Returns a collection of pricing-component-value-changes, specified by the pricing-component-value-ID parameter. By default 10 values are returned. Records are returned in natural order. by Component-ID&quot;,&quot;response&quot;:&quot;getPricingComponentValueChangeByID.html&quot;

Parameters:

  • pricing_component_id —

    The string ID of the pricing-component-value.

  • 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 pricing-component-value-change to return.

  • :records (Integer) —

    The maximum number of pricing-component-value-changes 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:



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/bf_ruby2/api/pricingcomponentvaluechanges_api.rb', line 226

def get_pricing_component_value_change_by_component_id_with_http_info(pricing_component_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PricingcomponentvaluechangesApi.get_pricing_component_value_change_by_component_id ..."
  end
  # verify the required parameter 'pricing_component_id' is set
  if @api_client.config.client_side_validation && pricing_component_id.nil?
    fail ArgumentError, "Missing the required parameter 'pricing_component_id' when calling PricingcomponentvaluechangesApi.get_pricing_component_value_change_by_component_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 = "/pricing-component-value-changes/component-ID/{pricing-component-ID}".sub('{' + 'pricing-component-ID' + '}', pricing_component_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 => 'PricingComponentValueChangePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PricingcomponentvaluechangesApi#get_pricing_component_value_change_by_component_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pricing_component_value_change_by_invoice_id(invoice_id, opts = {}) ⇒ PricingComponentValueChangePagedMetadata

Returns a collection of pricing-component-value-changes, specified by the invoice-ID parameter. By default 10 values are returned. Records are returned in natural order. by Invoice-ID","response":"getPricingComponentValueChangeByInvoiceID.html"

Parameters:

  • invoice_id —

    The string invoice-ID of the pricing-component-value-change.

  • 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 pricing-component-value-change to return. (default to 0)

  • :records (Integer) —

    The maximum number of pricing-component-value-changes 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:



284
285
286
287
 
# File 'lib/bf_ruby2/api/pricingcomponentvaluechanges_api.rb', line 284

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

#get_pricing_component_value_change_by_invoice_id_with_http_info(invoice_id, opts = {}) ⇒ Array<(PricingComponentValueChangePagedMetadata, Fixnum, Hash)>

Returns a collection of pricing-component-value-changes, specified by the invoice-ID parameter. By default 10 values are returned. Records are returned in natural order. by Invoice-ID&quot;,&quot;response&quot;:&quot;getPricingComponentValueChangeByInvoiceID.html&quot;

Parameters:

  • invoice_id —

    The string invoice-ID of the pricing-component-value-change.

  • 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 pricing-component-value-change to return.

  • :records (Integer) —

    The maximum number of pricing-component-value-changes 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:



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/bf_ruby2/api/pricingcomponentvaluechanges_api.rb', line 299

def get_pricing_component_value_change_by_invoice_id_with_http_info(invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PricingcomponentvaluechangesApi.get_pricing_component_value_change_by_invoice_id ..."
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling PricingcomponentvaluechangesApi.get_pricing_component_value_change_by_invoice_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 = "/pricing-component-value-changes/invoice/{invoice-ID}".sub('{' + 'invoice-ID' + '}', invoice_id.to_s)

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PricingComponentValueChangePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PricingcomponentvaluechangesApi#get_pricing_component_value_change_by_invoice_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pricing_component_value_change_by_subscription_id(subscription_id, opts = {}) ⇒ PricingComponentValueChangePagedMetadata

Returns a collection of pricing-component-value-changes, specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. by Subscription-ID","response":"getPricingComponentValueChangeBySubscriptionID.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 pricing-component-value-change to return. (default to 0)

  • :records (Integer) —

    The maximum number of pricing-component-value-changes 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:



357
358
359
360
 
# File 'lib/bf_ruby2/api/pricingcomponentvaluechanges_api.rb', line 357

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

#get_pricing_component_value_change_by_subscription_id_with_http_info(subscription_id, opts = {}) ⇒ Array<(PricingComponentValueChangePagedMetadata, Fixnum, Hash)>

Returns a collection of pricing-component-value-changes, specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. by Subscription-ID&quot;,&quot;response&quot;:&quot;getPricingComponentValueChangeBySubscriptionID.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 pricing-component-value-change to return.

  • :records (Integer) —

    The maximum number of pricing-component-value-changes 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:



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/bf_ruby2/api/pricingcomponentvaluechanges_api.rb', line 372

def get_pricing_component_value_change_by_subscription_id_with_http_info(subscription_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PricingcomponentvaluechangesApi.get_pricing_component_value_change_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 PricingcomponentvaluechangesApi.get_pricing_component_value_change_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 = "/pricing-component-value-changes/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 => 'PricingComponentValueChangePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PricingcomponentvaluechangesApi#get_pricing_component_value_change_by_subscription_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pricing_component_value_change_with_http_info(id, opts = {}) ⇒ Array<(PricingComponentValueChangePagedMetadata, Fixnum, Hash)>

Returns a single pricing-component-value-changes, specified by the ID parameter. by id&quot;,&quot;response&quot;:&quot;getPricingComponentValueChangeByID.html&quot;

Parameters:

  • id —

    The string ID of the pricing-component-value-change.

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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/bf_ruby2/api/pricingcomponentvaluechanges_api.rb', line 160

def get_pricing_component_value_change_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PricingcomponentvaluechangesApi.get_pricing_component_value_change ..."
  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 PricingcomponentvaluechangesApi.get_pricing_component_value_change"
  end
  # resource path
  local_var_path = "/pricing-component-value-changes/{ID}".sub('{' + 'ID' + '}', 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 => 'PricingComponentValueChangePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PricingcomponentvaluechangesApi#get_pricing_component_value_change\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end