Class: PlatformAPI::EnterpriseAccountUsageMonthly

Inherits:

Object

• Object
• PlatformAPI::EnterpriseAccountUsageMonthly

Defined in:

lib/platform-api/client.rb

Overview

Usage for an enterprise account at a monthly resolution.

Instance Method Summary

• #info(enterprise_account_id) ⇒ Object

  Retrieves usage for an enterprise account for a range of months.

• #initialize(client) ⇒ EnterpriseAccountUsageMonthly constructor

  A new instance of EnterpriseAccountUsageMonthly.

Constructor Details

#initialize(client) ⇒ EnterpriseAccountUsageMonthly

Returns a new instance of EnterpriseAccountUsageMonthly.

# File 'lib/platform-api/client.rb', line 1806

def initialize(client)
  @client = client
end

Instance Method Details

#info(enterprise_account_id) ⇒ Object

Retrieves usage for an enterprise account for a range of months. Start and end dates can be specified as query parameters using the date format, YYYY-MM format. For example, '/enterprise-accounts/example-account/usage/monthly?start=2019-01&end=2019-02' specifies usage in January and February for 2019. If no end date is specified, one month of usage is returned.

Parameters:

• enterprise_account_id: —

  unique identifier of the enterprise account

# File 'lib/platform-api/client.rb', line 1813

def info(enterprise_account_id)
  @client.enterprise_account_usage_monthly.info(enterprise_account_id)
end