Class: BillingApi::RatedUsageApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pnap_billing_api/api/rated_usage_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RatedUsageApi

Returns a new instance of RatedUsageApi.



19
20
21
 
# File 'lib/pnap_billing_api/api/rated_usage_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/pnap_billing_api/api/rated_usage_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#rated_usage_get(from_year_month, to_year_month, opts = {}) ⇒ Array<RatedUsageGet200ResponseInner>

List the rated usage. Retrieves all rated usage for given time period. The information is presented as a list of rated usage records. Every record corresponds to a charge. All date & times are in UTC.

Parameters:

  • from_year_month (String) —

    From year month (inclusive) to filter rated usage records by.

  • to_year_month (String) —

    To year month (inclusive) to filter rated usage records by.

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

    the optional parameters

Options Hash (opts):

Returns:



29
30
31
32
 
# File 'lib/pnap_billing_api/api/rated_usage_api.rb', line 29

def rated_usage_get(from_year_month, to_year_month, opts = {})
  data, _status_code, _headers = rated_usage_get_with_http_info(from_year_month, to_year_month, opts)
  data
end

#rated_usage_get_with_http_info(from_year_month, to_year_month, opts = {}) ⇒ Array<(Array<RatedUsageGet200ResponseInner>, Integer, Hash)>

List the rated usage. Retrieves all rated usage for given time period. The information is presented as a list of rated usage records. Every record corresponds to a charge. All date &amp; times are in UTC.

Parameters:

  • from_year_month (String) —

    From year month (inclusive) to filter rated usage records by.

  • to_year_month (String) —

    To year month (inclusive) to filter rated usage records by.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Array<RatedUsageGet200ResponseInner>, Integer, Hash)>) —

    Array<RatedUsageGet200ResponseInner> data, response status code and response headers



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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/pnap_billing_api/api/rated_usage_api.rb', line 41

def rated_usage_get_with_http_info(from_year_month, to_year_month, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RatedUsageApi.rated_usage_get ...'
  end
  # verify the required parameter 'from_year_month' is set
  if @api_client.config.client_side_validation && from_year_month.nil?
    fail ArgumentError, "Missing the required parameter 'from_year_month' when calling RatedUsageApi.rated_usage_get"
  end
  # verify the required parameter 'to_year_month' is set
  if @api_client.config.client_side_validation && to_year_month.nil?
    fail ArgumentError, "Missing the required parameter 'to_year_month' when calling RatedUsageApi.rated_usage_get"
  end
  # resource path
  local_var_path = '/rated-usage'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fromYearMonth'] = from_year_month
  query_params[:'toYearMonth'] = to_year_month
  query_params[:'productCategory'] = opts[:'product_category'] if !opts[:'product_category'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<RatedUsageGet200ResponseInner>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2']

  new_options = opts.merge(
    :operation => :"RatedUsageApi.rated_usage_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RatedUsageApi#rated_usage_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#rated_usage_month_to_date_get(opts = {}) ⇒ Array<RatedUsageGet200ResponseInner>

List the rated usage records for the current calendar month. Retrieves all rated usage for the current calendar month. The information is presented as a list of rated usage records. Every record corresponds to a charge. All date & times are in UTC.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



101
102
103
104
 
# File 'lib/pnap_billing_api/api/rated_usage_api.rb', line 101

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

#rated_usage_month_to_date_get_with_http_info(opts = {}) ⇒ Array<(Array<RatedUsageGet200ResponseInner>, Integer, Hash)>

List the rated usage records for the current calendar month. Retrieves all rated usage for the current calendar month. The information is presented as a list of rated usage records. Every record corresponds to a charge. All date &amp; times are in UTC.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Array<RatedUsageGet200ResponseInner>, Integer, Hash)>) —

    Array<RatedUsageGet200ResponseInner> data, response status code and response headers



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
 
# File 'lib/pnap_billing_api/api/rated_usage_api.rb', line 111

def rated_usage_month_to_date_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RatedUsageApi.rated_usage_month_to_date_get ...'
  end
  # resource path
  local_var_path = '/rated-usage/month-to-date'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'productCategory'] = opts[:'product_category'] if !opts[:'product_category'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<RatedUsageGet200ResponseInner>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2']

  new_options = opts.merge(
    :operation => :"RatedUsageApi.rated_usage_month_to_date_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RatedUsageApi#rated_usage_month_to_date_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end