##
# This code was generated by
# \ / _ _ _| _ _
# | (_)\/(_)(_|\/| |(/_ v1.0.0
# / /
#
# frozen_string_literal: true
module Twilio
module REST
class Wireless < Domain
class V1 < Version
class SimList < ListResource
##
# Initialize the SimList
# @param [Version] version Version that contains the resource
# @return [SimList] SimList
def initialize(version)
super(version)
# Path Solution
@solution = {}
@uri = "/Sims"
end
##
# Lists SimInstance records from the API as a list.
# Unlike stream(), this operation is eager and will load `limit` records into
# memory before returning.
# @param [sim.Status] status Only return Sims with this status.
# @param [String] iccid Return Sims with this Iccid. Currently this should be a
# list with maximum size 1.
# @param [String] rate_plan Only return Sims with this Rate Plan.
# @param [String] e_id The e_id
# @param [String] sim_registration_code The sim_registration_code
# @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(status: :unset, iccid: :unset, rate_plan: :unset, e_id: :unset, sim_registration_code: :unset, limit: nil, page_size: nil)
self.stream(
status: status,
iccid: iccid,
rate_plan: rate_plan,
e_id: e_id,
sim_registration_code: sim_registration_code,
limit: limit,
page_size: page_size
).entries
end
##
# Streams SimInstance records from the API as an Enumerable.
# This operation lazily loads records as efficiently as possible until the limit
# is reached.
# @param [sim.Status] status Only return Sims with this status.
# @param [String] iccid Return Sims with this Iccid. Currently this should be a
# list with maximum size 1.
# @param [String] rate_plan Only return Sims with this Rate Plan.
# @param [String] e_id The e_id
# @param [String] sim_registration_code The sim_registration_code
# @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(status: :unset, iccid: :unset, rate_plan: :unset, e_id: :unset, sim_registration_code: :unset, limit: nil, page_size: nil)
limits = @version.read_limits(limit, page_size)
page = self.page(
status: status,
iccid: iccid,
rate_plan: rate_plan,
e_id: e_id,
sim_registration_code: sim_registration_code,
page_size: limits[:page_size],
)
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end
##
# When passed a block, yields SimInstance 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 SimInstance records from the API.
# Request is executed immediately.
# @param [sim.Status] status Only return Sims with this status.
# @param [String] iccid Return Sims with this Iccid. Currently this should be a
# list with maximum size 1.
# @param [String] rate_plan Only return Sims with this Rate Plan.
# @param [String] e_id The e_id
# @param [String] sim_registration_code The sim_registration_code
# @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 SimInstance
def page(status: :unset, iccid: :unset, rate_plan: :unset, e_id: :unset, sim_registration_code: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
params = Twilio::Values.of({
'Status' => status,
'Iccid' => iccid,
'RatePlan' => rate_plan,
'EId' => e_id,
'SimRegistrationCode' => sim_registration_code,
'PageToken' => page_token,
'Page' => page_number,
'PageSize' => page_size,
})
response = @version.page(
'GET',
@uri,
params
)
SimPage.new(@version, response, @solution)
end
##
# Retrieve a single page of SimInstance records from the API.
# Request is executed immediately.
# @param [String] target_url API-generated URL for the requested results page
# @return [Page] Page of SimInstance
def get_page(target_url)
response = @version.domain.request(
'GET',
target_url
)
SimPage.new(@version, response, @solution)
end
##
# Provide a user friendly representation
def to_s
'#<Twilio.Wireless.V1.SimList>'
end
end
class SimPage < Page
##
# Initialize the SimPage
# @param [Version] version Version that contains the resource
# @param [Response] response Response from the API
# @param [Hash] solution Path solution for the resource
# @return [SimPage] SimPage
def initialize(version, response, solution)
super(version, response)
# Path Solution
@solution = solution
end
##
# Build an instance of SimInstance
# @param [Hash] payload Payload response from the API
# @return [SimInstance] SimInstance
def get_instance(payload)
SimInstance.new(@version, payload, )
end
##
# Provide a user friendly representation
def to_s
'<Twilio.Wireless.V1.SimPage>'
end
end
class SimContext < InstanceContext
##
# Initialize the SimContext
# @param [Version] version Version that contains the resource
# @param [String] sid The sid
# @return [SimContext] SimContext
def initialize(version, sid)
super(version)
# Path Solution
@solution = {sid: sid, }
@uri = "/Sims/#{@solution[:sid]}"
# Dependents
@usage_records = nil
@data_sessions = nil
end
##
# Fetch a SimInstance
# @return [SimInstance] Fetched SimInstance
def fetch
params = Twilio::Values.of({})
payload = @version.fetch(
'GET',
@uri,
params,
)
SimInstance.new(@version, payload, sid: @solution[:sid], )
end
##
# Update the SimInstance
# @param [String] unique_name A user-provided string that uniquely identifies this
# resource as an alternative to the `Sid`.
# @param [String] callback_method The HTTP method Twilio will use when making a
# request to the callback URL (valid options are GET or POST). Defaults to POST.
# @param [String] callback_url Twilio will make a request to this URL when the Sim
# has finished updating. In the case of a transition from the Sim's `new` status
# to its `ready` status, or from any status to its `deactivated` status, you will
# receive two callbacks. One when the Sim moves to its intermediary status
# (`ready` or `deactivated`), and a second when it transitions to its final status
# (`active` or `canceled`).
# @param [String] friendly_name A user-provided string that identifies this
# resource. Non-unique.
# @param [String] rate_plan The Sid or UniqueName of the
# [RatePlan](https://www.twilio.com/docs/api/wireless/rest-api/rate-plan) that
# this Sim should use. *Note:* the RatePlan of a Sim can only be modified when the
# Sim has a `suspended` or `deactivated` status.
# @param [sim.Status] status A string representing the status of the Sim. Valid
# options depend on the current state of the Sim, but may include `ready`,
# `active`, `suspended` or `deactivated`.
# @param [String] commands_callback_method A string representing the HTTP method
# to use when making a request to `CommandsCallbackUrl`. Can be one of `POST` or
# `GET`. Defaults to `POST`.
# @param [String] commands_callback_url The URL that will receive a webhook when
# this Sim originates a
# [Command](https://www.twilio.com/docs/api/wireless/rest-api/command). Your
# server should respond with an HTTP status code in the 200 range; any response
# body will be ignored.
# @param [String] sms_fallback_method The HTTP method Twilio will use when
# requesting the sms_fallback_url. Either `GET` or `POST`.
# @param [String] sms_fallback_url The URL that Twilio will request if an error
# occurs retrieving or executing the TwiML requested by `sms_url`.
# @param [String] sms_method The HTTP method Twilio will use when requesting the
# above Url. Either `GET` or `POST`.
# @param [String] sms_url The URL Twilio will request when the SIM-connected
# device sends an SMS message that is not a
# [Command](https://www.twilio.com/docs/api/wireless/rest-api/command).
# @param [String] voice_fallback_method The HTTP method Twilio will use when
# requesting the voice_fallback_url. Either `GET` or `POST`.
# @param [String] voice_fallback_url The URL that Twilio will request if an error
# occurs retrieving or executing the TwiML requested by `voice_url`.
# @param [String] voice_method The HTTP method Twilio will use when requesting the
# above Url. Either `GET` or `POST`.
# @param [String] voice_url The URL Twilio will request when the SIM-connected
# device makes a call.
# @return [SimInstance] Updated SimInstance
def update(unique_name: :unset, callback_method: :unset, callback_url: :unset, friendly_name: :unset, rate_plan: :unset, status: :unset, commands_callback_method: :unset, commands_callback_url: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset)
data = Twilio::Values.of({
'UniqueName' => unique_name,
'CallbackMethod' => callback_method,
'CallbackUrl' => callback_url,
'FriendlyName' => friendly_name,
'RatePlan' => rate_plan,
'Status' => status,
'CommandsCallbackMethod' => commands_callback_method,
'CommandsCallbackUrl' => commands_callback_url,
'SmsFallbackMethod' => sms_fallback_method,
'SmsFallbackUrl' => sms_fallback_url,
'SmsMethod' => sms_method,
'SmsUrl' => sms_url,
'VoiceFallbackMethod' => voice_fallback_method,
'VoiceFallbackUrl' => voice_fallback_url,
'VoiceMethod' => voice_method,
'VoiceUrl' => voice_url,
})
payload = @version.update(
'POST',
@uri,
data: data,
)
SimInstance.new(@version, payload, sid: @solution[:sid], )
end
##
# Access the usage_records
# @return [UsageRecordList]
# @return [UsageRecordContext]
def usage_records
unless @usage_records
@usage_records = UsageRecordList.new(@version, sim_sid: @solution[:sid], )
end
@usage_records
end
##
# Access the data_sessions
# @return [DataSessionList]
# @return [DataSessionContext]
def data_sessions
unless @data_sessions
@data_sessions = DataSessionList.new(@version, sim_sid: @solution[:sid], )
end
@data_sessions
end
##
# Provide a user friendly representation
def to_s
context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
"#<Twilio.Wireless.V1.SimContext #{context}>"
end
end
class SimInstance < InstanceResource
##
# Initialize the SimInstance
# @param [Version] version Version that contains the resource
# @param [Hash] payload payload that contains response from Twilio
# @param [String] sid The sid
# @return [SimInstance] SimInstance
def initialize(version, payload, sid: nil)
super(version)
# Marshaled Properties
@properties = {
'sid' => payload['sid'],
'unique_name' => payload['unique_name'],
'account_sid' => payload['account_sid'],
'rate_plan_sid' => payload['rate_plan_sid'],
'friendly_name' => payload['friendly_name'],
'iccid' => payload['iccid'],
'e_id' => payload['e_id'],
'status' => payload['status'],
'commands_callback_url' => payload['commands_callback_url'],
'commands_callback_method' => payload['commands_callback_method'],
'sms_fallback_method' => payload['sms_fallback_method'],
'sms_fallback_url' => payload['sms_fallback_url'],
'sms_method' => payload['sms_method'],
'sms_url' => payload['sms_url'],
'voice_fallback_method' => payload['voice_fallback_method'],
'voice_fallback_url' => payload['voice_fallback_url'],
'voice_method' => payload['voice_method'],
'voice_url' => payload['voice_url'],
'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
'url' => payload['url'],
'links' => payload['links'],
'ip_address' => payload['ip_address'],
}
# Context
@instance_context = nil
@params = {'sid' => sid || @properties['sid'], }
end
##
# Generate an instance context for the instance, the context is capable of
# performing various actions. All instance actions are proxied to the context
# @return [SimContext] SimContext for this SimInstance
def context
unless @instance_context
@instance_context = SimContext.new(@version, @params['sid'], )
end
@instance_context
end
##
# @return [String] A 34 character string that uniquely identifies this resource.
def sid
@properties['sid']
end
##
# @return [String] A user-provided string that uniquely identifies this resource as an alternative to the sid.
def unique_name
@properties['unique_name']
end
##
# @return [String] The unique id of the Account that this Sim belongs to.
def account_sid
@properties['account_sid']
end
##
# @return [String] The unique ID of the Rate Plan configured for this Sim.
def rate_plan_sid
@properties['rate_plan_sid']
end
##
# @return [String] A user-provided string that identifies this resource.
def friendly_name
@properties['friendly_name']
end
##
# @return [String] The ICCID associated with the SIM.
def iccid
@properties['iccid']
end
##
# @return [String] The e_id
def e_id
@properties['e_id']
end
##
# @return [sim.Status] A string representing the status of the Sim.
def status
@properties['status']
end
##
# @return [String] The URL that will receive a webhook when this Sim originates a machine-to-machine Command.
def commands_callback_url
@properties['commands_callback_url']
end
##
# @return [String] A string representing the HTTP method to use when making a request to commands_callback_url.
def commands_callback_method
@properties['commands_callback_method']
end
##
# @return [String] The HTTP method Twilio will use when requesting the sms_fallback_url.
def sms_fallback_method
@properties['sms_fallback_method']
end
##
# @return [String] The URL that Twilio will request if an error occurs retrieving or executing the TwiML requested by sms_url.
def sms_fallback_url
@properties['sms_fallback_url']
end
##
# @return [String] The HTTP method Twilio will use when requesting the above Url.
def sms_method
@properties['sms_method']
end
##
# @return [String] The URL Twilio will request when the SIM-connected device send an SMS that is not a Command.
def sms_url
@properties['sms_url']
end
##
# @return [String] The HTTP method Twilio will use when requesting the voice_fallback_url.
def voice_fallback_method
@properties['voice_fallback_method']
end
##
# @return [String] The URL that Twilio will request if an error occurs retrieving or executing the TwiML requested by voice_url.
def voice_fallback_url
@properties['voice_fallback_url']
end
##
# @return [String] The HTTP method Twilio will use when requesting the above Url.
def voice_method
@properties['voice_method']
end
##
# @return [String] The URL Twilio will request when the SIM-connected device makes a call.
def voice_url
@properties['voice_url']
end
##
# @return [Time] The date that this resource was created, given as GMT in ISO 8601 format.
def date_created
@properties['date_created']
end
##
# @return [Time] The date that this resource was last updated, given as GMT in ISO 8601 format.
def date_updated
@properties['date_updated']
end
##
# @return [String] The URL for this resource.
def url
@properties['url']
end
##
# @return [String] Each Sim instance resource supports a few subresources, listed here for convenience.
def links
@properties['links']
end
##
# @return [String] The ip_address
def ip_address
@properties['ip_address']
end
##
# Fetch a SimInstance
# @return [SimInstance] Fetched SimInstance
def fetch
context.fetch
end
##
# Update the SimInstance
# @param [String] unique_name A user-provided string that uniquely identifies this
# resource as an alternative to the `Sid`.
# @param [String] callback_method The HTTP method Twilio will use when making a
# request to the callback URL (valid options are GET or POST). Defaults to POST.
# @param [String] callback_url Twilio will make a request to this URL when the Sim
# has finished updating. In the case of a transition from the Sim's `new` status
# to its `ready` status, or from any status to its `deactivated` status, you will
# receive two callbacks. One when the Sim moves to its intermediary status
# (`ready` or `deactivated`), and a second when it transitions to its final status
# (`active` or `canceled`).
# @param [String] friendly_name A user-provided string that identifies this
# resource. Non-unique.
# @param [String] rate_plan The Sid or UniqueName of the
# [RatePlan](https://www.twilio.com/docs/api/wireless/rest-api/rate-plan) that
# this Sim should use. *Note:* the RatePlan of a Sim can only be modified when the
# Sim has a `suspended` or `deactivated` status.
# @param [sim.Status] status A string representing the status of the Sim. Valid
# options depend on the current state of the Sim, but may include `ready`,
# `active`, `suspended` or `deactivated`.
# @param [String] commands_callback_method A string representing the HTTP method
# to use when making a request to `CommandsCallbackUrl`. Can be one of `POST` or
# `GET`. Defaults to `POST`.
# @param [String] commands_callback_url The URL that will receive a webhook when
# this Sim originates a
# [Command](https://www.twilio.com/docs/api/wireless/rest-api/command). Your
# server should respond with an HTTP status code in the 200 range; any response
# body will be ignored.
# @param [String] sms_fallback_method The HTTP method Twilio will use when
# requesting the sms_fallback_url. Either `GET` or `POST`.
# @param [String] sms_fallback_url The URL that Twilio will request if an error
# occurs retrieving or executing the TwiML requested by `sms_url`.
# @param [String] sms_method The HTTP method Twilio will use when requesting the
# above Url. Either `GET` or `POST`.
# @param [String] sms_url The URL Twilio will request when the SIM-connected
# device sends an SMS message that is not a
# [Command](https://www.twilio.com/docs/api/wireless/rest-api/command).
# @param [String] voice_fallback_method The HTTP method Twilio will use when
# requesting the voice_fallback_url. Either `GET` or `POST`.
# @param [String] voice_fallback_url The URL that Twilio will request if an error
# occurs retrieving or executing the TwiML requested by `voice_url`.
# @param [String] voice_method The HTTP method Twilio will use when requesting the
# above Url. Either `GET` or `POST`.
# @param [String] voice_url The URL Twilio will request when the SIM-connected
# device makes a call.
# @return [SimInstance] Updated SimInstance
def update(unique_name: :unset, callback_method: :unset, callback_url: :unset, friendly_name: :unset, rate_plan: :unset, status: :unset, commands_callback_method: :unset, commands_callback_url: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset)
context.update(
unique_name: unique_name,
callback_method: callback_method,
callback_url: callback_url,
friendly_name: friendly_name,
rate_plan: rate_plan,
status: status,
commands_callback_method: commands_callback_method,
commands_callback_url: commands_callback_url,
sms_fallback_method: sms_fallback_method,
sms_fallback_url: sms_fallback_url,
sms_method: sms_method,
sms_url: sms_url,
voice_fallback_method: voice_fallback_method,
voice_fallback_url: voice_fallback_url,
voice_method: voice_method,
voice_url: voice_url,
)
end
##
# Access the usage_records
# @return [usage_records] usage_records
def usage_records
context.usage_records
end
##
# Access the data_sessions
# @return [data_sessions] data_sessions
def data_sessions
context.data_sessions
end
##
# Provide a user friendly representation
def to_s
values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
"<Twilio.Wireless.V1.SimInstance #{values}>"
end
##
# Provide a detailed, user friendly representation
def inspect
values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
"<Twilio.Wireless.V1.SimInstance #{values}>"
end
end
end
end
end
end