class Twilio::UsageApi

Defined in:

twilio/api/usage_api.cr

Constant Summary

CREATE_USAGE_TRIGGER_MAX_LENGTH_FOR_ACCOUNT_SID = 34
CREATE_USAGE_TRIGGER_MIN_LENGTH_FOR_ACCOUNT_SID = 34
CREATE_USAGE_TRIGGER_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
DELETE_USAGE_TRIGGER_MAX_LENGTH_FOR_ACCOUNT_SID = 34
DELETE_USAGE_TRIGGER_MAX_LENGTH_FOR_SID = 34
DELETE_USAGE_TRIGGER_MIN_LENGTH_FOR_ACCOUNT_SID = 34
DELETE_USAGE_TRIGGER_MIN_LENGTH_FOR_SID = 34
DELETE_USAGE_TRIGGER_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
DELETE_USAGE_TRIGGER_PATTERN_FOR_SID = /^UT[0-9a-fA-F]{32}$/
FETCH_USAGE_TRIGGER_MAX_LENGTH_FOR_ACCOUNT_SID = 34
FETCH_USAGE_TRIGGER_MAX_LENGTH_FOR_SID = 34
FETCH_USAGE_TRIGGER_MIN_LENGTH_FOR_ACCOUNT_SID = 34
FETCH_USAGE_TRIGGER_MIN_LENGTH_FOR_SID = 34
FETCH_USAGE_TRIGGER_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
FETCH_USAGE_TRIGGER_PATTERN_FOR_SID = /^UT[0-9a-fA-F]{32}$/
LIST_USAGE_RECORD_ALL_TIME_MAX_FOR_PAGE_SIZE = Int32.new("1000")
LIST_USAGE_RECORD_ALL_TIME_MAX_LENGTH_FOR_ACCOUNT_SID = 34
LIST_USAGE_RECORD_ALL_TIME_MIN_FOR_PAGE_SIZE = Int32.new("1")
LIST_USAGE_RECORD_ALL_TIME_MIN_LENGTH_FOR_ACCOUNT_SID = 34
LIST_USAGE_RECORD_ALL_TIME_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
LIST_USAGE_RECORD_DAILY_MAX_FOR_PAGE_SIZE = Int32.new("1000")
LIST_USAGE_RECORD_DAILY_MAX_LENGTH_FOR_ACCOUNT_SID = 34
LIST_USAGE_RECORD_DAILY_MIN_FOR_PAGE_SIZE = Int32.new("1")
LIST_USAGE_RECORD_DAILY_MIN_LENGTH_FOR_ACCOUNT_SID = 34
LIST_USAGE_RECORD_DAILY_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
LIST_USAGE_RECORD_LAST_MONTH_MAX_FOR_PAGE_SIZE = Int32.new("1000")
LIST_USAGE_RECORD_LAST_MONTH_MAX_LENGTH_FOR_ACCOUNT_SID = 34
LIST_USAGE_RECORD_LAST_MONTH_MIN_FOR_PAGE_SIZE = Int32.new("1")
LIST_USAGE_RECORD_LAST_MONTH_MIN_LENGTH_FOR_ACCOUNT_SID = 34
LIST_USAGE_RECORD_LAST_MONTH_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
LIST_USAGE_RECORD_MAX_FOR_PAGE_SIZE = Int32.new("1000")
LIST_USAGE_RECORD_MAX_LENGTH_FOR_ACCOUNT_SID = 34
LIST_USAGE_RECORD_MIN_FOR_PAGE_SIZE = Int32.new("1")
LIST_USAGE_RECORD_MIN_LENGTH_FOR_ACCOUNT_SID = 34
LIST_USAGE_RECORD_MONTHLY_MAX_FOR_PAGE_SIZE = Int32.new("1000")
LIST_USAGE_RECORD_MONTHLY_MAX_LENGTH_FOR_ACCOUNT_SID = 34
LIST_USAGE_RECORD_MONTHLY_MIN_FOR_PAGE_SIZE = Int32.new("1")
LIST_USAGE_RECORD_MONTHLY_MIN_LENGTH_FOR_ACCOUNT_SID = 34
LIST_USAGE_RECORD_MONTHLY_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
LIST_USAGE_RECORD_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
LIST_USAGE_RECORD_THIS_MONTH_MAX_FOR_PAGE_SIZE = Int32.new("1000")
LIST_USAGE_RECORD_THIS_MONTH_MAX_LENGTH_FOR_ACCOUNT_SID = 34
LIST_USAGE_RECORD_THIS_MONTH_MIN_FOR_PAGE_SIZE = Int32.new("1")
LIST_USAGE_RECORD_THIS_MONTH_MIN_LENGTH_FOR_ACCOUNT_SID = 34
LIST_USAGE_RECORD_THIS_MONTH_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
LIST_USAGE_RECORD_TODAY_MAX_FOR_PAGE_SIZE = Int32.new("1000")
LIST_USAGE_RECORD_TODAY_MAX_LENGTH_FOR_ACCOUNT_SID = 34
LIST_USAGE_RECORD_TODAY_MIN_FOR_PAGE_SIZE = Int32.new("1")
LIST_USAGE_RECORD_TODAY_MIN_LENGTH_FOR_ACCOUNT_SID = 34
LIST_USAGE_RECORD_TODAY_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
LIST_USAGE_RECORD_YEARLY_MAX_FOR_PAGE_SIZE = Int32.new("1000")
LIST_USAGE_RECORD_YEARLY_MAX_LENGTH_FOR_ACCOUNT_SID = 34
LIST_USAGE_RECORD_YEARLY_MIN_FOR_PAGE_SIZE = Int32.new("1")
LIST_USAGE_RECORD_YEARLY_MIN_LENGTH_FOR_ACCOUNT_SID = 34
LIST_USAGE_RECORD_YEARLY_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
LIST_USAGE_RECORD_YESTERDAY_MAX_FOR_PAGE_SIZE = Int32.new("1000")
LIST_USAGE_RECORD_YESTERDAY_MAX_LENGTH_FOR_ACCOUNT_SID = 34
LIST_USAGE_RECORD_YESTERDAY_MIN_FOR_PAGE_SIZE = Int32.new("1")
LIST_USAGE_RECORD_YESTERDAY_MIN_LENGTH_FOR_ACCOUNT_SID = 34
LIST_USAGE_RECORD_YESTERDAY_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
LIST_USAGE_TRIGGER_MAX_FOR_PAGE_SIZE = Int32.new("1000")
LIST_USAGE_TRIGGER_MAX_LENGTH_FOR_ACCOUNT_SID = 34
LIST_USAGE_TRIGGER_MIN_FOR_PAGE_SIZE = Int32.new("1")
LIST_USAGE_TRIGGER_MIN_LENGTH_FOR_ACCOUNT_SID = 34
LIST_USAGE_TRIGGER_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
UPDATE_USAGE_TRIGGER_MAX_LENGTH_FOR_ACCOUNT_SID = 34
UPDATE_USAGE_TRIGGER_MAX_LENGTH_FOR_SID = 34
UPDATE_USAGE_TRIGGER_MIN_LENGTH_FOR_ACCOUNT_SID = 34
UPDATE_USAGE_TRIGGER_MIN_LENGTH_FOR_SID = 34
UPDATE_USAGE_TRIGGER_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
UPDATE_USAGE_TRIGGER_PATTERN_FOR_SID = /^UT[0-9a-fA-F]{32}$/

Constructors

Instance Method Summary

Constructor Detail

def self.new(api_client : Twilio::ApiClient = ApiClient.default) #

[View source]

Instance Method Detail

def account_sid : String #

[View source]
def account_sid=(account_sid : String) #

[View source]
def api_client : ApiClient #

[View source]
def api_client=(api_client : ApiClient) #

[View source]
def build_api_request_for_create_usage_trigger(*, account_sid : String | Nil = @account_sid, callback_url : String | Nil = nil, trigger_value : String | Nil = nil, usage_category : Twilio::UsageRecordEnumCategory | Nil = nil, callback_method : Twilio::HttpMethod | Nil = nil, friendly_name : String | Nil = nil, recurring : Twilio::UsageTriggerEnumRecurring | Nil = nil, trigger_by : Twilio::UsageTriggerEnumTriggerField | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_delete_usage_trigger(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_fetch_usage_trigger(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_list_usage_record(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_list_usage_record_all_time(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_list_usage_record_daily(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_list_usage_record_last_month(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_list_usage_record_monthly(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_list_usage_record_this_month(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_list_usage_record_today(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_list_usage_record_yearly(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_list_usage_record_yesterday(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_list_usage_trigger(*, account_sid : String | Nil = @account_sid, recurring : Twilio::UsageTriggerEnumRecurring | Nil = nil, trigger_by : Twilio::UsageTriggerEnumTriggerField | Nil = nil, usage_category : Twilio::UsageRecordEnumCategory | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_update_usage_trigger(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, callback_method : Twilio::HttpMethod | Nil = nil, callback_url : String | Nil = nil, friendly_name : String | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def client_side_validation?(*args, **options) #

[View source]
def client_side_validation?(*args, **options, &) #

[View source]
def create_usage_trigger(*, account_sid : String | Nil = @account_sid, callback_url : String | Nil = nil, trigger_value : String | Nil = nil, usage_category : Twilio::UsageRecordEnumCategory | Nil = nil, callback_method : Twilio::HttpMethod | Nil = nil, friendly_name : String | Nil = nil, recurring : Twilio::UsageTriggerEnumRecurring | Nil = nil, trigger_by : Twilio::UsageTriggerEnumTriggerField | Nil = nil) : Twilio::UsageUsageTrigger #

Create a new UsageTrigger @required @param account_sid [String?] The SID of the Account that will create the resource. @required @param callback_url [String?] The URL we should call using callback_method when the trigger fires. @required @param trigger_value [String?] The usage value at which the trigger should fire. For convenience, you can use an offset value such as +30 to specify a trigger_value that is 30 units more than the current usage value. Be sure to urlencode a + as %2B. @required @param usage_category [Twilio::UsageRecordEnumCategory?] @optional @param callback_method [Twilio::HttpMethod?] @optional @param friendly_name [String?] A descriptive string that you create to describe the resource. It can be up to 64 characters long. @optional @param recurring [Twilio::UsageTriggerEnumRecurring?] @optional @param trigger_by [Twilio::UsageTriggerEnumTriggerField?] @return [Twilio::UsageUsageTrigger]


[View source]
def create_usage_trigger(*, account_sid : String | Nil = @account_sid, callback_url : String | Nil = nil, trigger_value : String | Nil = nil, usage_category : Twilio::UsageRecordEnumCategory | Nil = nil, callback_method : Twilio::HttpMethod | Nil = nil, friendly_name : String | Nil = nil, recurring : Twilio::UsageTriggerEnumRecurring | Nil = nil, trigger_by : Twilio::UsageTriggerEnumTriggerField | Nil = nil, &block : Crest::Response -> ) : Nil #

Create a new UsageTrigger @required @param account_sid [String?] The SID of the Account that will create the resource. @required @param callback_url [String?] The URL we should call using callback_method when the trigger fires. @required @param trigger_value [String?] The usage value at which the trigger should fire. For convenience, you can use an offset value such as +30 to specify a trigger_value that is 30 units more than the current usage value. Be sure to urlencode a + as %2B. @required @param usage_category [Twilio::UsageRecordEnumCategory?] @optional @param callback_method [Twilio::HttpMethod?] @optional @param friendly_name [String?] A descriptive string that you create to describe the resource. It can be up to 64 characters long. @optional @param recurring [Twilio::UsageTriggerEnumRecurring?] @optional @param trigger_by [Twilio::UsageTriggerEnumTriggerField?] @return nil


[View source]
def create_usage_trigger_with_http_info(*, account_sid : String | Nil = @account_sid, callback_url : String | Nil = nil, trigger_value : String | Nil = nil, usage_category : Twilio::UsageRecordEnumCategory | Nil = nil, callback_method : Twilio::HttpMethod | Nil = nil, friendly_name : String | Nil = nil, recurring : Twilio::UsageTriggerEnumRecurring | Nil = nil, trigger_by : Twilio::UsageTriggerEnumTriggerField | Nil = nil) : Tuple(Twilio::UsageUsageTrigger, Int32, Hash(String, Array(String) | String)) #

Create a new UsageTrigger @required @param account_sid [String?] The SID of the Account that will create the resource. @required @param callback_url [String?] The URL we should call using callback_method when the trigger fires. @required @param trigger_value [String?] The usage value at which the trigger should fire. For convenience, you can use an offset value such as +30 to specify a trigger_value that is 30 units more than the current usage value. Be sure to urlencode a + as %2B. @required @param usage_category [Twilio::UsageRecordEnumCategory?] @optional @param callback_method [Twilio::HttpMethod?] @optional @param friendly_name [String?] A descriptive string that you create to describe the resource. It can be up to 64 characters long. @optional @param recurring [Twilio::UsageTriggerEnumRecurring?] @optional @param trigger_by [Twilio::UsageTriggerEnumTriggerField?] @return [Tuple(Twilio::UsageUsageTrigger, Integer, Hash)] Twilio::UsageUsageTrigger, response status code and response headers


[View source]
def debugging?(*args, **options) #

[View source]
def debugging?(*args, **options, &) #

[View source]
def delete_usage_trigger(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Nil #

@required @param account_sid [String?] The SID of the Account that created the UsageTrigger resources to delete. @required @param sid [String?] The Twilio-provided string that uniquely identifies the UsageTrigger resource to delete. @return [Nil]


[View source]
def delete_usage_trigger(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, &block : Crest::Response -> ) : Nil #

@required @param account_sid [String?] The SID of the Account that created the UsageTrigger resources to delete. @required @param sid [String?] The Twilio-provided string that uniquely identifies the UsageTrigger resource to delete. @return nil


[View source]
def delete_usage_trigger_with_http_info(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Tuple(Nil, Int32, Hash(String, Array(String) | String)) #

@required @param account_sid [String?] The SID of the Account that created the UsageTrigger resources to delete. @required @param sid [String?] The Twilio-provided string that uniquely identifies the UsageTrigger resource to delete. @return [Tuple(Nil, Integer, Hash)] Nil, response status code and response headers


[View source]
def fetch_usage_trigger(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Twilio::UsageUsageTrigger #

Fetch and instance of a usage-trigger @required @param account_sid [String?] The SID of the Account that created the UsageTrigger resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the UsageTrigger resource to fetch. @return [Twilio::UsageUsageTrigger]


[View source]
def fetch_usage_trigger(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, &block : Crest::Response -> ) : Nil #

Fetch and instance of a usage-trigger @required @param account_sid [String?] The SID of the Account that created the UsageTrigger resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the UsageTrigger resource to fetch. @return nil


[View source]
def fetch_usage_trigger_with_http_info(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Tuple(Twilio::UsageUsageTrigger, Int32, Hash(String, Array(String) | String)) #

Fetch and instance of a usage-trigger @required @param account_sid [String?] The SID of the Account that created the UsageTrigger resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the UsageTrigger resource to fetch. @return [Tuple(Twilio::UsageUsageTrigger, Integer, Hash)] Twilio::UsageUsageTrigger, response status code and response headers


[View source]
def list_usage_record(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListUsageRecordResponse #

Retrieve a list of usage-records belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Twilio::ListUsageRecordResponse]


[View source]
def list_usage_record(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil #

Retrieve a list of usage-records belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return nil


[View source]
def list_usage_record_all_time(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListUsageRecordAllTimeResponse #

@required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Twilio::ListUsageRecordAllTimeResponse]


[View source]
def list_usage_record_all_time(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil #

@required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return nil


[View source]
def list_usage_record_all_time_with_http_info(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListUsageRecordAllTimeResponse, Int32, Hash(String, Array(String) | String)) #

@required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Tuple(Twilio::ListUsageRecordAllTimeResponse, Integer, Hash)] Twilio::ListUsageRecordAllTimeResponse, response status code and response headers


[View source]
def list_usage_record_daily(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListUsageRecordDailyResponse #

@required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Twilio::ListUsageRecordDailyResponse]


[View source]
def list_usage_record_daily(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil #

@required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return nil


[View source]
def list_usage_record_daily_with_http_info(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListUsageRecordDailyResponse, Int32, Hash(String, Array(String) | String)) #

@required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Tuple(Twilio::ListUsageRecordDailyResponse, Integer, Hash)] Twilio::ListUsageRecordDailyResponse, response status code and response headers


[View source]
def list_usage_record_last_month(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListUsageRecordLastMonthResponse #

@required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Twilio::ListUsageRecordLastMonthResponse]


[View source]
def list_usage_record_last_month(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil #

@required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return nil


[View source]
def list_usage_record_last_month_with_http_info(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListUsageRecordLastMonthResponse, Int32, Hash(String, Array(String) | String)) #

@required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Tuple(Twilio::ListUsageRecordLastMonthResponse, Integer, Hash)] Twilio::ListUsageRecordLastMonthResponse, response status code and response headers


[View source]
def list_usage_record_monthly(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListUsageRecordMonthlyResponse #

@required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Twilio::ListUsageRecordMonthlyResponse]


[View source]
def list_usage_record_monthly(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil #

@required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return nil


[View source]
def list_usage_record_monthly_with_http_info(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListUsageRecordMonthlyResponse, Int32, Hash(String, Array(String) | String)) #

@required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Tuple(Twilio::ListUsageRecordMonthlyResponse, Integer, Hash)] Twilio::ListUsageRecordMonthlyResponse, response status code and response headers


[View source]
def list_usage_record_this_month(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListUsageRecordThisMonthResponse #

@required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Twilio::ListUsageRecordThisMonthResponse]


[View source]
def list_usage_record_this_month(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil #

@required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return nil


[View source]
def list_usage_record_this_month_with_http_info(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListUsageRecordThisMonthResponse, Int32, Hash(String, Array(String) | String)) #

@required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Tuple(Twilio::ListUsageRecordThisMonthResponse, Integer, Hash)] Twilio::ListUsageRecordThisMonthResponse, response status code and response headers


[View source]
def list_usage_record_today(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListUsageRecordTodayResponse #

@required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Twilio::ListUsageRecordTodayResponse]


[View source]
def list_usage_record_today(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil #

@required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return nil


[View source]
def list_usage_record_today_with_http_info(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListUsageRecordTodayResponse, Int32, Hash(String, Array(String) | String)) #

@required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Tuple(Twilio::ListUsageRecordTodayResponse, Integer, Hash)] Twilio::ListUsageRecordTodayResponse, response status code and response headers


[View source]
def list_usage_record_with_http_info(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListUsageRecordResponse, Int32, Hash(String, Array(String) | String)) #

Retrieve a list of usage-records belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Tuple(Twilio::ListUsageRecordResponse, Integer, Hash)] Twilio::ListUsageRecordResponse, response status code and response headers


[View source]
def list_usage_record_yearly(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListUsageRecordYearlyResponse #

@required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Twilio::ListUsageRecordYearlyResponse]


[View source]
def list_usage_record_yearly(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil #

@required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return nil


[View source]
def list_usage_record_yearly_with_http_info(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListUsageRecordYearlyResponse, Int32, Hash(String, Array(String) | String)) #

@required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Tuple(Twilio::ListUsageRecordYearlyResponse, Integer, Hash)] Twilio::ListUsageRecordYearlyResponse, response status code and response headers


[View source]
def list_usage_record_yesterday(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListUsageRecordYesterdayResponse #

@required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Twilio::ListUsageRecordYesterdayResponse]


[View source]
def list_usage_record_yesterday(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil #

@required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return nil


[View source]
def list_usage_record_yesterday_with_http_info(*, account_sid : String | Nil = @account_sid, category : Twilio::UsageRecordEnumCategory | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, include_subaccounts : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListUsageRecordYesterdayResponse, Int32, Hash(String, Array(String) | String)) #

@required @param account_sid [String?] The SID of the Account that created the UsageRecord resources to read. @optional @param category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. @optional @param start_date [Time?] Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date. @optional @param end_date [Time?] Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date. @optional @param include_subaccounts [Bool?] Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Tuple(Twilio::ListUsageRecordYesterdayResponse, Integer, Hash)] Twilio::ListUsageRecordYesterdayResponse, response status code and response headers


[View source]
def list_usage_trigger(*, account_sid : String | Nil = @account_sid, recurring : Twilio::UsageTriggerEnumRecurring | Nil = nil, trigger_by : Twilio::UsageTriggerEnumTriggerField | Nil = nil, usage_category : Twilio::UsageRecordEnumCategory | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListUsageTriggerResponse #

Retrieve a list of usage-triggers belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the UsageTrigger resources to read. @optional @param recurring [Twilio::UsageTriggerEnumRecurring?] The frequency of recurring UsageTriggers to read. Can be: daily, monthly, or yearly to read recurring UsageTriggers. An empty value or a value of alltime reads non-recurring UsageTriggers. @optional @param trigger_by [Twilio::UsageTriggerEnumTriggerField?] The trigger field of the UsageTriggers to read. Can be: count, usage, or price as described in the UsageRecords documentation. @optional @param usage_category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageTriggers to read. Must be a supported usage categories. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Twilio::ListUsageTriggerResponse]


[View source]
def list_usage_trigger(*, account_sid : String | Nil = @account_sid, recurring : Twilio::UsageTriggerEnumRecurring | Nil = nil, trigger_by : Twilio::UsageTriggerEnumTriggerField | Nil = nil, usage_category : Twilio::UsageRecordEnumCategory | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil #

Retrieve a list of usage-triggers belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the UsageTrigger resources to read. @optional @param recurring [Twilio::UsageTriggerEnumRecurring?] The frequency of recurring UsageTriggers to read. Can be: daily, monthly, or yearly to read recurring UsageTriggers. An empty value or a value of alltime reads non-recurring UsageTriggers. @optional @param trigger_by [Twilio::UsageTriggerEnumTriggerField?] The trigger field of the UsageTriggers to read. Can be: count, usage, or price as described in the UsageRecords documentation. @optional @param usage_category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageTriggers to read. Must be a supported usage categories. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return nil


[View source]
def list_usage_trigger_with_http_info(*, account_sid : String | Nil = @account_sid, recurring : Twilio::UsageTriggerEnumRecurring | Nil = nil, trigger_by : Twilio::UsageTriggerEnumTriggerField | Nil = nil, usage_category : Twilio::UsageRecordEnumCategory | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListUsageTriggerResponse, Int32, Hash(String, Array(String) | String)) #

Retrieve a list of usage-triggers belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the UsageTrigger resources to read. @optional @param recurring [Twilio::UsageTriggerEnumRecurring?] The frequency of recurring UsageTriggers to read. Can be: daily, monthly, or yearly to read recurring UsageTriggers. An empty value or a value of alltime reads non-recurring UsageTriggers. @optional @param trigger_by [Twilio::UsageTriggerEnumTriggerField?] The trigger field of the UsageTriggers to read. Can be: count, usage, or price as described in the UsageRecords documentation. @optional @param usage_category [Twilio::UsageRecordEnumCategory?] The usage category of the UsageTriggers to read. Must be a supported usage categories. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Tuple(Twilio::ListUsageTriggerResponse, Integer, Hash)] Twilio::ListUsageTriggerResponse, response status code and response headers


[View source]
def update_usage_trigger(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, callback_method : Twilio::HttpMethod | Nil = nil, callback_url : String | Nil = nil, friendly_name : String | Nil = nil) : Twilio::UsageUsageTrigger #

Update an instance of a usage trigger @required @param account_sid [String?] The SID of the Account that created the UsageTrigger resources to update. @required @param sid [String?] The Twilio-provided string that uniquely identifies the UsageTrigger resource to update. @optional @param callback_method [Twilio::HttpMethod?] @optional @param callback_url [String?] The URL we should call using callback_method when the trigger fires. @optional @param friendly_name [String?] A descriptive string that you create to describe the resource. It can be up to 64 characters long. @return [Twilio::UsageUsageTrigger]


[View source]
def update_usage_trigger(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, callback_method : Twilio::HttpMethod | Nil = nil, callback_url : String | Nil = nil, friendly_name : String | Nil = nil, &block : Crest::Response -> ) : Nil #

Update an instance of a usage trigger @required @param account_sid [String?] The SID of the Account that created the UsageTrigger resources to update. @required @param sid [String?] The Twilio-provided string that uniquely identifies the UsageTrigger resource to update. @optional @param callback_method [Twilio::HttpMethod?] @optional @param callback_url [String?] The URL we should call using callback_method when the trigger fires. @optional @param friendly_name [String?] A descriptive string that you create to describe the resource. It can be up to 64 characters long. @return nil


[View source]
def update_usage_trigger_with_http_info(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, callback_method : Twilio::HttpMethod | Nil = nil, callback_url : String | Nil = nil, friendly_name : String | Nil = nil) : Tuple(Twilio::UsageUsageTrigger, Int32, Hash(String, Array(String) | String)) #

Update an instance of a usage trigger @required @param account_sid [String?] The SID of the Account that created the UsageTrigger resources to update. @required @param sid [String?] The Twilio-provided string that uniquely identifies the UsageTrigger resource to update. @optional @param callback_method [Twilio::HttpMethod?] @optional @param callback_url [String?] The URL we should call using callback_method when the trigger fires. @optional @param friendly_name [String?] A descriptive string that you create to describe the resource. It can be up to 64 characters long. @return [Tuple(Twilio::UsageUsageTrigger, Integer, Hash)] Twilio::UsageUsageTrigger, response status code and response headers


[View source]