Class: PureCloud::BillingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/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.



23
24
25
 
# File 'lib/purecloudclient_v2a/api/billing_api.rb', line 23

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/purecloudclient_v2a/api/billing_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#get_billing_reports_billableusage(start_date, end_date, opts = {}) ⇒ BillingUsageReport

Get a report of the billable usages (e.g. licenses and devices utilized) for a given period.

Parameters:

  • start_date —

    The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

  • end_date —

    The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

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

    the optional parameters

Returns:



33
34
35
36
 
# File 'lib/purecloudclient_v2a/api/billing_api.rb', line 33

def get_billing_reports_billableusage(start_date, end_date, opts = {})
  data, _status_code, _headers = get_billing_reports_billableusage_with_http_info(start_date, end_date, opts)
  return data
end

#get_billing_reports_billableusage_with_http_info(start_date, end_date, opts = {}) ⇒ Array<(BillingUsageReport, Fixnum, Hash)>

Get a report of the billable usages (e.g. licenses and devices utilized) for a given period.

Parameters:

  • start_date —

    The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

  • end_date —

    The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

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

    the optional parameters

Returns:

  • (Array<(BillingUsageReport, Fixnum, Hash)>) —

    BillingUsageReport data, response status code and response headers



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
95
96
97
98
99
100
101
102
 
# File 'lib/purecloudclient_v2a/api/billing_api.rb', line 44

def get_billing_reports_billableusage_with_http_info(start_date, end_date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BillingApi.get_billing_reports_billableusage ..."
  end
  
  
  # verify the required parameter 'start_date' is set
  fail ArgumentError, "Missing the required parameter 'start_date' when calling BillingApi.get_billing_reports_billableusage" if start_date.nil?
  
  
  
  
  
  
  # verify the required parameter 'end_date' is set
  fail ArgumentError, "Missing the required parameter 'end_date' when calling BillingApi.get_billing_reports_billableusage" if end_date.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/billing/reports/billableusage".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'startDate'] = start_date
  query_params[:'endDate'] = end_date

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'BillingUsageReport')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#get_billing_reports_billableusage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end