Class: stcloud::BillingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/stcloud/api/billing_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BillingApi

Returns a new instance of BillingApi.



16
17
18
 
# File 'lib/stcloud/api/billing_api.rb', line 16

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/stcloud/api/billing_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#get_detailed_invoice_using_get(service, year, month, opts = {}) ⇒ InvoiceResponse

Get invoice details

Parameters:

  • service —

    service

  • year —

    year

  • month —

    month

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

    the optional parameters

Returns:



25
26
27
28
 
# File 'lib/stcloud/api/billing_api.rb', line 25

def get_detailed_invoice_using_get(service, year, month, opts = {})
  data, _status_code, _headers = get_detailed_invoice_using_get_with_http_info(service, year, month, opts)
  data
end

#get_detailed_invoice_using_get_with_http_info(service, year, month, opts = {}) ⇒ Array<(InvoiceResponse, Integer, Hash)>

Get invoice details

Parameters:

  • service —

    service

  • year —

    year

  • month —

    month

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

    the optional parameters

Returns:

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

    InvoiceResponse data, response status code and response headers



36
37
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
77
78
79
80
81
82
83
84
 
# File 'lib/stcloud/api/billing_api.rb', line 36

def get_detailed_invoice_using_get_with_http_info(service, year, month, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingApi.get_detailed_invoice_using_get ...'
  end
  # verify the required parameter 'service' is set
  if @api_client.config.client_side_validation && service.nil?
    fail ArgumentError, "Missing the required parameter 'service' when calling BillingApi.get_detailed_invoice_using_get"
  end
  # verify the required parameter 'year' is set
  if @api_client.config.client_side_validation && year.nil?
    fail ArgumentError, "Missing the required parameter 'year' when calling BillingApi.get_detailed_invoice_using_get"
  end
  # verify the required parameter 'month' is set
  if @api_client.config.client_side_validation && month.nil?
    fail ArgumentError, "Missing the required parameter 'month' when calling BillingApi.get_detailed_invoice_using_get"
  end
  # resource path
  local_var_path = '/users-web/api/v3/billing/invoice/{service}/{year}/{month}'.sub('{' + 'service' + '}', service.to_s).sub('{' + 'year' + '}', year.to_s).sub('{' + 'month' + '}', month.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # 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[:body] 

  return_type = opts[:return_type] || 'InvoiceResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#get_detailed_invoice_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_available_plans_using_get1(opts = {}) ⇒ PlansResponse

Get available plans

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :integration_id (Integer) —

    integrationId

  • :app_type (String) —

    appType

Returns:



90
91
92
93
 
# File 'lib/stcloud/api/billing_api.rb', line 90

def list_available_plans_using_get1(opts = {})
  data, _status_code, _headers = list_available_plans_using_get1_with_http_info(opts)
  data
end

#list_available_plans_using_get1_with_http_info(opts = {}) ⇒ Array<(PlansResponse, Integer, Hash)>

Get available plans

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :integration_id (Integer) —

    integrationId

  • :app_type (String) —

    appType

Returns:

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

    PlansResponse data, response status code and response headers



100
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
 
# File 'lib/stcloud/api/billing_api.rb', line 100

def list_available_plans_using_get1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingApi.list_available_plans_using_get1 ...'
  end
  # resource path
  local_var_path = '/users-web/api/v3/billing/availablePlans'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'integrationId'] = opts[:'integration_id'] if !opts[:'integration_id'].nil?
  query_params[:'appType'] = opts[:'app_type'] if !opts[:'app_type'].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[:body] 

  return_type = opts[:return_type] || 'PlansResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#list_available_plans_using_get1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_plan_using_put1(body, app_id, opts = {}) ⇒ UpdatePlanResponse

Update plan for an app

Parameters:

  • body —

    dto

  • app_id —

    appId

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

    the optional parameters

Returns:



144
145
146
147
 
# File 'lib/stcloud/api/billing_api.rb', line 144

def update_plan_using_put1(body, app_id, opts = {})
  data, _status_code, _headers = update_plan_using_put1_with_http_info(body, app_id, opts)
  data
end

#update_plan_using_put1_with_http_info(body, app_id, opts = {}) ⇒ Array<(UpdatePlanResponse, Integer, Hash)>

Update plan for an app

Parameters:

  • body —

    dto

  • app_id —

    appId

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

    the optional parameters

Returns:

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

    UpdatePlanResponse data, response status code and response headers



154
155
156
157
158
159
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
200
 
# File 'lib/stcloud/api/billing_api.rb', line 154

def update_plan_using_put1_with_http_info(body, app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingApi.update_plan_using_put1 ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling BillingApi.update_plan_using_put1"
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling BillingApi.update_plan_using_put1"
  end
  # resource path
  local_var_path = '/users-web/api/v3/billing/info/{appId}'.sub('{' + 'appId' + '}', app_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

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

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'UpdatePlanResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#update_plan_using_put1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end