Class: Bfwd::UsageroundingstrategiesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UsageroundingstrategiesApi 



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

def api_client
  @api_client
end

Instance Method Details

#create_usage_rounding_strategy(usage_rounding_strategy, opts = {}) ⇒ UsageRoundingStrategyPagedMetadata

Create a new rounding strategy a new rounding strategy","request":"createUsageRoundingStrategiesRequest.html","response":"createUsageRoundingStrategiesResponse.html"



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

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

#create_usage_rounding_strategy_with_http_info(usage_rounding_strategy, opts = {}) ⇒ Array<(UsageRoundingStrategyPagedMetadata, Fixnum, Hash)>

Create a new rounding strategy a new rounding strategy&quot;,&quot;request&quot;:&quot;createUsageRoundingStrategiesRequest.html&quot;,&quot;response&quot;:&quot;createUsageRoundingStrategiesResponse.html&quot;



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

def create_usage_rounding_strategy_with_http_info(usage_rounding_strategy, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsageroundingstrategiesApi.create_usage_rounding_strategy ..."
  end
  # verify the required parameter 'usage_rounding_strategy' is set
  if @api_client.config.client_side_validation && usage_rounding_strategy.nil?
    fail ArgumentError, "Missing the required parameter 'usage_rounding_strategy' when calling UsageroundingstrategiesApi.create_usage_rounding_strategy"
  end
  # resource path
  local_var_path = "/usage-rounding-strategies"

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

#get_usage_rounding_strategy_by_id(usage_rounding_strategies_id, opts = {}) ⇒ UsageRoundingStrategyPagedMetadata

Returns a collection of usage-rounding-strategies, specified by the usage-rounding-strategies-id parameter. By default 10 values are returned. Records are returned in natural order. an existing round strategy","response":"getUsageRoundingStrategiesByID.html"

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

  • :records (Integer) —

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



89
90
91
92
 
# File 'lib/bf_ruby2/api/usageroundingstrategies_api.rb', line 89

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

#get_usage_rounding_strategy_by_id_with_http_info(usage_rounding_strategies_id, opts = {}) ⇒ Array<(UsageRoundingStrategyPagedMetadata, Fixnum, Hash)>

Returns a collection of usage-rounding-strategies, specified by the usage-rounding-strategies-id parameter. By default 10 values are returned. Records are returned in natural order. an existing round strategy&quot;,&quot;response&quot;:&quot;getUsageRoundingStrategiesByID.html&quot;

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

  • :records (Integer) —

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



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
145
146
147
148
149
150
151
152
 
# File 'lib/bf_ruby2/api/usageroundingstrategies_api.rb', line 105

def get_usage_rounding_strategy_by_id_with_http_info(usage_rounding_strategies_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsageroundingstrategiesApi.get_usage_rounding_strategy_by_id ..."
  end
  # verify the required parameter 'usage_rounding_strategies_id' is set
  if @api_client.config.client_side_validation && usage_rounding_strategies_id.nil?
    fail ArgumentError, "Missing the required parameter 'usage_rounding_strategies_id' when calling UsageroundingstrategiesApi.get_usage_rounding_strategy_by_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 = "/usage-rounding-strategies/{usage-rounding-strategies-ID}".sub('{' + 'usage-rounding-strategies-ID' + '}', usage_rounding_strategies_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 => 'UsageRoundingStrategyPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsageroundingstrategiesApi#get_usage_rounding_strategy_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_usage_rounding_strategy_by_pricing_component_id(pricing_component_id, opts = {}) ⇒ UsageRoundingStrategyPagedMetadata

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

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

  • :records (Integer) —

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



165
166
167
168
 
# File 'lib/bf_ruby2/api/usageroundingstrategies_api.rb', line 165

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

#get_usage_rounding_strategy_by_pricing_component_id_with_http_info(pricing_component_id, opts = {}) ⇒ Array<(UsageRoundingStrategyPagedMetadata, Fixnum, Hash)>

Returns a collection of usage-rounding-strategies, specified by the pricing-component-ID parameter. By default 10 values are returned. Records are returned in natural order. by pricing component&quot;,&quot;response&quot;:&quot;getUsageRoundingStrategiesByPricingComponent.html&quot;

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

  • :records (Integer) —

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



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
221
222
223
224
225
226
227
228
 
# File 'lib/bf_ruby2/api/usageroundingstrategies_api.rb', line 181

def get_usage_rounding_strategy_by_pricing_component_id_with_http_info(pricing_component_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsageroundingstrategiesApi.get_usage_rounding_strategy_by_pricing_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 UsageroundingstrategiesApi.get_usage_rounding_strategy_by_pricing_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 = "/usage-rounding-strategies/pricing-component/{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 => 'UsageRoundingStrategyPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsageroundingstrategiesApi#get_usage_rounding_strategy_by_pricing_component_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_usage_rounding_strategy(usage_rounding_strategy, opts = {}) ⇒ UsageRoundingStrategyPagedMetadata

Update a rounding strategy a rounding strategy","request":"updateUsageRoundingStrategiesRequest.html","response":"updateUsageRoundingStrategiesResponse.html"



235
236
237
238
 
# File 'lib/bf_ruby2/api/usageroundingstrategies_api.rb', line 235

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

#update_usage_rounding_strategy_with_http_info(usage_rounding_strategy, opts = {}) ⇒ Array<(UsageRoundingStrategyPagedMetadata, Fixnum, Hash)>

Update a rounding strategy a rounding strategy&quot;,&quot;request&quot;:&quot;updateUsageRoundingStrategiesRequest.html&quot;,&quot;response&quot;:&quot;updateUsageRoundingStrategiesResponse.html&quot;



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

def update_usage_rounding_strategy_with_http_info(usage_rounding_strategy, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsageroundingstrategiesApi.update_usage_rounding_strategy ..."
  end
  # verify the required parameter 'usage_rounding_strategy' is set
  if @api_client.config.client_side_validation && usage_rounding_strategy.nil?
    fail ArgumentError, "Missing the required parameter 'usage_rounding_strategy' when calling UsageroundingstrategiesApi.update_usage_rounding_strategy"
  end
  # resource path
  local_var_path = "/usage-rounding-strategies"

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