Class: Bfwd::PricingcomponentvaluesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PricingcomponentvaluesApi

Returns a new instance of PricingcomponentvaluesApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_pricing_component_value(pricing_component_value, opts = {}) ⇒ PricingComponentValuePagedMetadata

Create a pricing-component-value. a new value","request":"createPricingComponentValueRequest.html","response":"createPricingComponentValueResponse.html"

Parameters:

  • pricing_component_value —

    The pricing-component-value object to be updated.

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

    the optional parameters

Returns:



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

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

#create_pricing_component_value_with_http_info(pricing_component_value, opts = {}) ⇒ Array<(PricingComponentValuePagedMetadata, Fixnum, Hash)>

Create a pricing-component-value. a new value&quot;,&quot;request&quot;:&quot;createPricingComponentValueRequest.html&quot;,&quot;response&quot;:&quot;createPricingComponentValueResponse.html&quot;

Parameters:

  • pricing_component_value —

    The pricing-component-value 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/pricingcomponentvalues_api.rb', line 38

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

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

#get_all_pricing_component_values(opts = {}) ⇒ PricingComponentValuePagedMetadata

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

  • :records (Integer) —

    The maximum number of pricing-component-values 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)

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned. (default to true)

Returns:



88
89
90
91
 
# File 'lib/bf_ruby2/api/pricingcomponentvalues_api.rb', line 88

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

#get_all_pricing_component_values_with_http_info(opts = {}) ⇒ Array<(PricingComponentValuePagedMetadata, Fixnum, Hash)>

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

  • :records (Integer) —

    The maximum number of pricing-component-values 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.

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned.

Returns:



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
142
143
144
 
# File 'lib/bf_ruby2/api/pricingcomponentvalues_api.rb', line 103

def get_all_pricing_component_values_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PricingcomponentvaluesApi.get_all_pricing_component_values ..."
  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-values"

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

#get_pricing_component_value(pricing_component_id, opts = {}) ⇒ PricingComponentValuePagedMetadata

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

  • :records (Integer) —

    The maximum number of pricing-component-values 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)

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned. (default to true)

Returns:



157
158
159
160
 
# File 'lib/bf_ruby2/api/pricingcomponentvalues_api.rb', line 157

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

#get_pricing_component_value_by_subscription_id(subscription_id, opts = {}) ⇒ PricingComponentValuePagedMetadata

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

Parameters:

  • subscription_id —

    The string subscription-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 to return. (default to 0)

  • :records (Integer) —

    The maximum number of pricing-component-values 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)

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned. (default to true)

Returns:



233
234
235
236
 
# File 'lib/bf_ruby2/api/pricingcomponentvalues_api.rb', line 233

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

#get_pricing_component_value_by_subscription_id_with_http_info(subscription_id, opts = {}) ⇒ Array<(PricingComponentValuePagedMetadata, Fixnum, Hash)>

Returns a collection of pricing-component-values, 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;getPricingComponentValueBySubscriptionID.html&quot;

Parameters:

  • subscription_id —

    The string subscription-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 to return.

  • :records (Integer) —

    The maximum number of pricing-component-values 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.

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned.

Returns:



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
290
291
292
293
294
295
296
 
# File 'lib/bf_ruby2/api/pricingcomponentvalues_api.rb', line 249

def get_pricing_component_value_by_subscription_id_with_http_info(subscription_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PricingcomponentvaluesApi.get_pricing_component_value_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 PricingcomponentvaluesApi.get_pricing_component_value_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-values/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?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].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 => 'PricingComponentValuePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PricingcomponentvaluesApi#get_pricing_component_value_by_subscription_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pricing_component_value_with_http_info(pricing_component_id, opts = {}) ⇒ Array<(PricingComponentValuePagedMetadata, Fixnum, Hash)>

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

  • :records (Integer) —

    The maximum number of pricing-component-values 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.

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned.

Returns:



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/bf_ruby2/api/pricingcomponentvalues_api.rb', line 173

def get_pricing_component_value_with_http_info(pricing_component_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PricingcomponentvaluesApi.get_pricing_component_value ..."
  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 PricingcomponentvaluesApi.get_pricing_component_value"
  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-values/{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?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].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 => 'PricingComponentValuePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PricingcomponentvaluesApi#get_pricing_component_value\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_pricing_component_value(pricing_component_value, opts = {}) ⇒ PricingComponentValuePagedMetadata

Update a pricing-component-value. a value","request":"updatePricingComponentValueRequest.html","response":"updatePricingComponentValueResponse.html"

Parameters:

  • pricing_component_value —

    The pricing-component-value object to be updated.

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

    the optional parameters

Returns:



303
304
305
306
 
# File 'lib/bf_ruby2/api/pricingcomponentvalues_api.rb', line 303

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

#update_pricing_component_value_with_http_info(pricing_component_value, opts = {}) ⇒ Array<(PricingComponentValuePagedMetadata, Fixnum, Hash)>

Update a pricing-component-value. a value&quot;,&quot;request&quot;:&quot;updatePricingComponentValueRequest.html&quot;,&quot;response&quot;:&quot;updatePricingComponentValueResponse.html&quot;

Parameters:

  • pricing_component_value —

    The pricing-component-value object to be updated.

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

    the optional parameters

Returns:



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/bf_ruby2/api/pricingcomponentvalues_api.rb', line 313

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

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