class PureCloud::BillingApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

get_billing_reports_billableusage(start_date, end_date, opts = {}) click to toggle source

Get a report of the billable license usages Report is of the billable usages (e.g. licenses and devices utilized) for a given period. If response's status is InProgress, wait a few seconds, then try the same request again. @param start_date The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ @param end_date The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ @param [Hash] opts the optional parameters @return [BillingUsageReport]

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

Get a report of the billable license usages Report is of the billable usages (e.g. licenses and devices utilized) for a given period. If response&#39;s status is InProgress, wait a few seconds, then try the same request again. @param start_date The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ @param end_date The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ @param [Hash] opts the optional parameters @return [Array<(BillingUsageReport, Fixnum, Hash)>] BillingUsageReport data, response status code and response headers

# File lib/purecloudplatformclientv2/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 OAuth']
  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
get_billing_trusteebillingoverview_trustor_org_id(trustor_org_id, opts = {}) click to toggle source

Get the billing overview for an organization that is managed by a partner. Tax Disclaimer: Prices returned by this API do not include applicable taxes. It is the responsibility of the customer to pay all taxes that are appropriate in their jurisdiction. See the PureCloud API Documentation in the Developer Center for more information about this API: developer.mypurecloud.com/api/rest/v2/ @param trustor_org_id The organization ID of the trustor (customer) organization. @param [Hash] opts the optional parameters @option opts [Integer] :billing_period_index 0 for active period (overview data may change until period closes). 1 for prior completed billing period. 2 for two billing cycles prior, and so on. (default to 0) @return [TrusteeBillingOverview]

# File lib/purecloudplatformclientv2/api/billing_api.rb, line 110
def get_billing_trusteebillingoverview_trustor_org_id(trustor_org_id, opts = {})
  data, _status_code, _headers = get_billing_trusteebillingoverview_trustor_org_id_with_http_info(trustor_org_id, opts)
  return data
end
get_billing_trusteebillingoverview_trustor_org_id_with_http_info(trustor_org_id, opts = {}) click to toggle source

Get the billing overview for an organization that is managed by a partner. Tax Disclaimer: Prices returned by this API do not include applicable taxes. It is the responsibility of the customer to pay all taxes that are appropriate in their jurisdiction. See the PureCloud API Documentation in the Developer Center for more information about this API: developer.mypurecloud.com/api/rest/v2/ @param trustor_org_id The organization ID of the trustor (customer) organization. @param [Hash] opts the optional parameters @option opts [Integer] :billing_period_index 0 for active period (overview data may change until period closes). 1 for prior completed billing period. 2 for two billing cycles prior, and so on. @return [Array<(TrusteeBillingOverview, Fixnum, Hash)>] TrusteeBillingOverview data, response status code and response headers

# File lib/purecloudplatformclientv2/api/billing_api.rb, line 121
def get_billing_trusteebillingoverview_trustor_org_id_with_http_info(trustor_org_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BillingApi.get_billing_trusteebillingoverview_trustor_org_id ..."
  end
  
  
  # verify the required parameter 'trustor_org_id' is set
  fail ArgumentError, "Missing the required parameter 'trustor_org_id' when calling BillingApi.get_billing_trusteebillingoverview_trustor_org_id" if trustor_org_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/billing/trusteebillingoverview/{trustorOrgId}".sub('{format}','json').sub('{' + 'trustorOrgId' + '}', trustor_org_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'billingPeriodIndex'] = opts[:'billing_period_index'] if opts[:'billing_period_index']

  # 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 OAuth']
  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 => 'TrusteeBillingOverview')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#get_billing_trusteebillingoverview_trustor_org_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end