##
# This code was generated by
# \ / _ _ _| _ _
# | (_)\/(_)(_|\/| |(/_ v1.0.0
# / /
module Twilio
module REST
class Wireless < Domain
class V1 < Version
class SimContext < InstanceContext
##
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
class UsageRecordList < ListResource
##
# Initialize the UsageRecordList
# @param [Version] version Version that contains the resource
# @param [String] sim_sid The sim_sid
# @return [UsageRecordList] UsageRecordList
def initialize(version, sim_sid: nil)
super(version)
# Path Solution
@solution = {sim_sid: sim_sid}
@uri = "/Sims/#{@solution[:sim_sid]}/UsageRecords"
end
##
# Lists UsageRecordInstance records from the API as a list.
# Unlike stream(), this operation is eager and will load `limit` records into
# memory before returning.
# @param [Time] end_ The end
# @param [Time] start The start
# @param [usage_record.Granularity] granularity The granularity
# @param [Integer] limit Upper limit for the number of records to return. stream()
# guarantees to never return more than limit. Default is no limit
# @param [Integer] page_size Number of records to fetch per request, when
# not set will use the default value of 50 records. If no page_size is defined
# but a limit is defined, stream() will attempt to read the limit with the most
# efficient page size, i.e. min(limit, 1000)
# @return [Array] Array of up to limit results
def list(end_: :unset, start: :unset, granularity: :unset, limit: nil, page_size: nil)
self.stream(
end_: end_,
start: start,
granularity: granularity,
limit: limit,
page_size: page_size
).entries
end
##
# Streams UsageRecordInstance records from the API as an Enumerable.
# This operation lazily loads records as efficiently as possible until the limit
# is reached.
# @param [Time] end_ The end
# @param [Time] start The start
# @param [usage_record.Granularity] granularity The granularity
# @param [Integer] limit Upper limit for the number of records to return. stream()
# guarantees to never return more than limit. Default is no limit.
# @param [Integer] page_size Number of records to fetch per request, when
# not set will use the default value of 50 records. If no page_size is defined
# but a limit is defined, stream() will attempt to read the limit with the most
# efficient page size, i.e. min(limit, 1000)
# @return [Enumerable] Enumerable that will yield up to limit results
def stream(end_: :unset, start: :unset, granularity: :unset, limit: nil, page_size: nil)
limits = @version.read_limits(limit, page_size)
page = self.page(end_: end_, start: start, granularity: granularity, page_size: limits[:page_size],)
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end
##
# When passed a block, yields UsageRecordInstance records from the API.
# This operation lazily loads records as efficiently as possible until the limit
# is reached.
def each
limits = @version.read_limits
page = self.page(page_size: limits[:page_size],)
@version.stream(page,
limit: limits[:limit],
page_limit: limits[:page_limit]).each {|x| yield x}
end
##
# Retrieve a single page of UsageRecordInstance records from the API.
# Request is executed immediately.
# @param [Time] end_ The end
# @param [Time] start The start
# @param [usage_record.Granularity] granularity The granularity
# @param [String] page_token PageToken provided by the API
# @param [Integer] page_number Page Number, this value is simply for client state
# @param [Integer] page_size Number of records to return, defaults to 50
# @return [Page] Page of UsageRecordInstance
def page(end_: :unset, start: :unset, granularity: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
params = Twilio::Values.of({
'End' => Twilio.serialize_iso8601_datetime(end_),
'Start' => Twilio.serialize_iso8601_datetime(start),
'Granularity' => granularity,
'PageToken' => page_token,
'Page' => page_number,
'PageSize' => page_size,
})
response = @version.page(
'GET',
@uri,
params
)
UsageRecordPage.new(@version, response, @solution)
end
##
# Retrieve a single page of UsageRecordInstance records from the API.
# Request is executed immediately.
# @param [String] target_url API-generated URL for the requested results page
# @return [Page] Page of UsageRecordInstance
def get_page(target_url)
response = @version.domain.request(
'GET',
target_url
)
UsageRecordPage.new(@version, response, @solution)
end
##
# Provide a user friendly representation
def to_s
'#<Twilio.Wireless.V1.UsageRecordList>'
end
end
##
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
class UsageRecordPage < Page
##
# Initialize the UsageRecordPage
# @param [Version] version Version that contains the resource
# @param [Response] response Response from the API
# @param [Hash] solution Path solution for the resource
# @return [UsageRecordPage] UsageRecordPage
def initialize(version, response, solution)
super(version, response)
# Path Solution
@solution = solution
end
##
# Build an instance of UsageRecordInstance
# @param [Hash] payload Payload response from the API
# @return [UsageRecordInstance] UsageRecordInstance
def get_instance(payload)
UsageRecordInstance.new(@version, payload, sim_sid: @solution[:sim_sid],)
end
##
# Provide a user friendly representation
def to_s
'<Twilio.Wireless.V1.UsageRecordPage>'
end
end
##
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
class UsageRecordInstance < InstanceResource
##
# Initialize the UsageRecordInstance
# @param [Version] version Version that contains the resource
# @param [Hash] payload payload that contains response from Twilio
# @param [String] sim_sid The sim_sid
# @return [UsageRecordInstance] UsageRecordInstance
def initialize(version, payload, sim_sid: nil)
super(version)
# Marshaled Properties
@properties = {
'sim_sid' => payload['sim_sid'],
'account_sid' => payload['account_sid'],
'period' => payload['period'],
'commands' => payload['commands'],
'data' => payload['data'],
}
end
##
# @return [String] The sim_sid
def sim_sid
@properties['sim_sid']
end
##
# @return [String] The account_sid
def account_sid
@properties['account_sid']
end
##
# @return [Hash] The period
def period
@properties['period']
end
##
# @return [Hash] The commands
def commands
@properties['commands']
end
##
# @return [Hash] The data
def data
@properties['data']
end
##
# Provide a user friendly representation
def to_s
"<Twilio.Wireless.V1.UsageRecordInstance>"
end
##
# Provide a detailed, user friendly representation
def inspect
"<Twilio.Wireless.V1.UsageRecordInstance>"
end
end
end
end
end
end
end