class stcloud::BillingApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/stcloud/api/billing_api.rb, line 16
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

get_detailed_invoice_using_get(service, year, month, opts = {}) click to toggle source

Get invoice details @param service service @param year year @param month month @param [Hash] opts the optional parameters @return [InvoiceResponse]

# 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 = {}) click to toggle source

Get invoice details @param service service @param year year @param month month @param [Hash] opts the optional parameters @return [Array<(InvoiceResponse, Integer, Hash)>] InvoiceResponse data, response status code and response headers

# 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 = {}) click to toggle source

Get available plans @param [Hash] opts the optional parameters @option opts [Integer] :integration_id integrationId @option opts [String] :app_type appType @return [PlansResponse]

# 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 = {}) click to toggle source

Get available plans @param [Hash] opts the optional parameters @option opts [Integer] :integration_id integrationId @option opts [String] :app_type appType @return [Array<(PlansResponse, Integer, Hash)>] PlansResponse data, response status code and response headers

# 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 = {}) click to toggle source

Update plan for an app @param body dto @param app_id appId @param [Hash] opts the optional parameters @return [UpdatePlanResponse]

# 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 = {}) click to toggle source

Update plan for an app @param body dto @param app_id appId @param [Hash] opts the optional parameters @return [Array<(UpdatePlanResponse, Integer, Hash)>] UpdatePlanResponse data, response status code and response headers

# 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