twilio-ruby 5.6.0 → 5.33.1

data/lib/twilio-ruby/rest/wireless/v1/sim.rb

@@ -3,13 +3,13 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
     class Wireless < Domain
       class V1 < Version
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class SimList < ListResource
           ##
           # Initialize the SimList
@@ -27,11 +27,15 @@ module Twilio
           # 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 The status
-          # @param [String] iccid The iccid
-          # @param [String] rate_plan The rate_plan
-          # @param [String] e_id The e_id
-          # @param [String] sim_registration_code The sim_registration_code
+          # @param [sim.Status] status Only return Sim resources with this status.
+          # @param [String] iccid Only return Sim resources with this ICCID. This will
+          #   return a list with a maximum size of 1.
+          # @param [String] rate_plan The SID or unique name of a [RatePlan
+          #   resource](https://www.twilio.com/docs/wireless/api/rateplan-resource). Only
+          #   return Sim resources assigned to this RatePlan resource.
+          # @param [String] e_id Deprecated.
+          # @param [String] sim_registration_code Only return Sim resources with this
+          #   registration code. This will return a list with a maximum size of 1.
           # @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
@@ -55,11 +59,15 @@ module Twilio
           # 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 The status
-          # @param [String] iccid The iccid
-          # @param [String] rate_plan The rate_plan
-          # @param [String] e_id The e_id
-          # @param [String] sim_registration_code The sim_registration_code
+          # @param [sim.Status] status Only return Sim resources with this status.
+          # @param [String] iccid Only return Sim resources with this ICCID. This will
+          #   return a list with a maximum size of 1.
+          # @param [String] rate_plan The SID or unique name of a [RatePlan
+          #   resource](https://www.twilio.com/docs/wireless/api/rateplan-resource). Only
+          #   return Sim resources assigned to this RatePlan resource.
+          # @param [String] e_id Deprecated.
+          # @param [String] sim_registration_code Only return Sim resources with this
+          #   registration code. This will return a list with a maximum size of 1.
           # @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
@@ -89,7 +97,7 @@ module Twilio
           def each
             limits = @version.read_limits
 
-            page = self.page(page_size: limits[:page_size])
+            page = self.page(page_size: limits[:page_size], )
 
             @version.stream(page,
                             limit: limits[:limit],
@@ -99,11 +107,15 @@ module Twilio
           ##
           # Retrieve a single page of SimInstance records from the API.
           # Request is executed immediately.
-          # @param [sim.Status] status The status
-          # @param [String] iccid The iccid
-          # @param [String] rate_plan The rate_plan
-          # @param [String] e_id The e_id
-          # @param [String] sim_registration_code The sim_registration_code
+          # @param [sim.Status] status Only return Sim resources with this status.
+          # @param [String] iccid Only return Sim resources with this ICCID. This will
+          #   return a list with a maximum size of 1.
+          # @param [String] rate_plan The SID or unique name of a [RatePlan
+          #   resource](https://www.twilio.com/docs/wireless/api/rateplan-resource). Only
+          #   return Sim resources assigned to this RatePlan resource.
+          # @param [String] e_id Deprecated.
+          # @param [String] sim_registration_code Only return Sim resources with this
+          #   registration code. This will return a list with a maximum size of 1.
           # @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
@@ -147,8 +159,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class SimPage < Page
           ##
           # Initialize the SimPage
@@ -168,7 +178,7 @@ module Twilio
           # @param [Hash] payload Payload response from the API
           # @return [SimInstance] SimInstance
           def get_instance(payload)
-            SimInstance.new(@version, payload)
+            SimInstance.new(@version, payload, )
           end
 
           ##
@@ -178,19 +188,17 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class SimContext < InstanceContext
           ##
           # Initialize the SimContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The sid
+          # @param [String] sid The SID or the `unique_name` of the Sim resource to fetch.
           # @return [SimContext] SimContext
           def initialize(version, sid)
             super(version)
 
             # Path Solution
-            @solution = {sid: sid}
+            @solution = {sid: sid, }
             @uri = "/Sims/#{@solution[:sid]}"
 
             # Dependents
@@ -210,29 +218,66 @@ module Twilio
                 params,
             )
 
-            SimInstance.new(@version, payload, sid: @solution[:sid])
+            SimInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
           # Update the SimInstance
-          # @param [String] unique_name The unique_name
-          # @param [String] callback_method The callback_method
-          # @param [String] callback_url The callback_url
-          # @param [String] friendly_name The friendly_name
-          # @param [String] rate_plan The rate_plan
-          # @param [sim.Status] status The status
-          # @param [String] commands_callback_method The commands_callback_method
-          # @param [String] commands_callback_url The commands_callback_url
-          # @param [String] sms_fallback_method The sms_fallback_method
-          # @param [String] sms_fallback_url The sms_fallback_url
-          # @param [String] sms_method The sms_method
-          # @param [String] sms_url The sms_url
-          # @param [String] voice_fallback_method The voice_fallback_method
-          # @param [String] voice_fallback_url The voice_fallback_url
-          # @param [String] voice_method The voice_method
-          # @param [String] voice_url The voice_url
+          # @param [String] unique_name An application-defined string that uniquely
+          #   identifies the resource. It can be used in place of the `sid` in the URL path to
+          #   address the resource.
+          # @param [String] callback_method The HTTP method we should use to call
+          #   `callback_url`. Can be: `POST` or `GET`. The default is `POST`.
+          # @param [String] callback_url The URL we should call using the `callback_url`
+          #   when the SIM has finished updating. When the SIM transitions from `new` to
+          #   `ready` or from any status to `deactivated`, we call this URL when the status
+          #   changes to an intermediate status (`ready` or `deactivated`) and again when the
+          #   status changes to its final status (`active` or `canceled`).
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the Sim resource. It does not need to be unique.
+          # @param [String] rate_plan The SID or unique name of the [RatePlan
+          #   resource](https://www.twilio.com/docs/wireless/api/rateplan-resource) to which
+          #   the Sim resource should be assigned.
+          # @param [sim.Status] status The new status of the Sim resource. Can be: `ready`,
+          #   `active`, `suspended`, or `deactivated`.
+          # @param [String] commands_callback_method The HTTP method we should use to call
+          #   `commands_callback_url`. Can be: `POST` or `GET`. The default is `POST`.
+          # @param [String] commands_callback_url The URL we should call using the
+          #   `commands_callback_method` when the SIM sends a
+          #   [Command](https://www.twilio.com/docs/wireless/api/command-resource). Your
+          #   server should respond with an HTTP status code in the 200 range; any response
+          #   body is ignored.
+          # @param [String] sms_fallback_method The HTTP method we should use to call
+          #   `sms_fallback_url`. Can be: `GET` or `POST`. Default is `POST`.
+          # @param [String] sms_fallback_url The URL we should call using the
+          #   `sms_fallback_method` when an error occurs while retrieving or executing the
+          #   TwiML requested from `sms_url`.
+          # @param [String] sms_method The HTTP method we should use to call `sms_url`. Can
+          #   be: `GET` or `POST`. Default is `POST`.
+          # @param [String] sms_url The URL we should call using the `sms_method` when the
+          #   SIM-connected device sends an SMS message that is not a
+          #   [Command](https://www.twilio.com/docs/wireless/api/command-resource).
+          # @param [String] voice_fallback_method The HTTP method we should use to call
+          #   `voice_fallback_url`. Can be: `GET` or `POST`.
+          # @param [String] voice_fallback_url The URL we should call using the
+          #   `voice_fallback_method` when an error occurs while retrieving or executing the
+          #   TwiML requested from `voice_url`.
+          # @param [String] voice_method The HTTP method we should use when we call
+          #   `voice_url`. Can be: `GET` or `POST`.
+          # @param [String] voice_url The URL we should call using the `voice_method` when
+          #   the SIM-connected device makes a voice call.
+          # @param [sim.ResetStatus] reset_status Initiate a connectivity reset on the SIM.
+          #   Set to `resetting` to initiate a connectivity reset on the SIM. No other value
+          #   is valid.
+          # @param [String] account_sid The SID of the
+          #   [Account](https://www.twilio.com/docs/iam/api/account) to which the Sim resource
+          #   should belong. The Account SID can only be that of the requesting Account or
+          #   that of a [Subaccount](https://www.twilio.com/docs/iam/api/subaccounts) of the
+          #   requesting Account. Only valid when the Sim resource's status is `new`. For more
+          #   information, see the [Move SIMs between Subaccounts
+          #   documentation](https://www.twilio.com/docs/wireless/api/sim-resource#move-sims-between-subaccounts).
           # @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)
+          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, reset_status: :unset, account_sid: :unset)
             data = Twilio::Values.of({
                 'UniqueName' => unique_name,
                 'CallbackMethod' => callback_method,
@@ -250,6 +295,8 @@ module Twilio
                 'VoiceFallbackUrl' => voice_fallback_url,
                 'VoiceMethod' => voice_method,
                 'VoiceUrl' => voice_url,
+                'ResetStatus' => reset_status,
+                'AccountSid' => account_sid,
             })
 
             payload = @version.update(
@@ -258,7 +305,14 @@ module Twilio
                 data: data,
             )
 
-            SimInstance.new(@version, payload, sid: @solution[:sid])
+            SimInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Deletes the SimInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
+          def delete
+            @version.delete('delete', @uri)
           end
 
           ##
@@ -267,7 +321,7 @@ module Twilio
           # @return [UsageRecordContext]
           def usage_records
             unless @usage_records
-              @usage_records = UsageRecordList.new(@version, sim_sid: @solution[:sid])
+              @usage_records = UsageRecordList.new(@version, sim_sid: @solution[:sid], )
             end
 
             @usage_records
@@ -279,7 +333,7 @@ module Twilio
           # @return [DataSessionContext]
           def data_sessions
             unless @data_sessions
-              @data_sessions = DataSessionList.new(@version, sim_sid: @solution[:sid])
+              @data_sessions = DataSessionList.new(@version, sim_sid: @solution[:sid], )
             end
 
             @data_sessions
@@ -291,16 +345,21 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Wireless.V1.SimContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Wireless.V1.SimContext #{context}>"
+          end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         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
+          # @param [String] sid The SID or the `unique_name` of the Sim resource to fetch.
           # @return [SimInstance] SimInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -315,6 +374,7 @@ module Twilio
                 'iccid' => payload['iccid'],
                 'e_id' => payload['e_id'],
                 'status' => payload['status'],
+                'reset_status' => payload['reset_status'],
                 'commands_callback_url' => payload['commands_callback_url'],
                 'commands_callback_method' => payload['commands_callback_method'],
                 'sms_fallback_method' => payload['sms_fallback_method'],
@@ -334,7 +394,7 @@ module Twilio
 
             # Context
             @instance_context = nil
-            @params = {'sid' => sid || @properties['sid']}
+            @params = {'sid' => sid || @properties['sid'], }
           end
 
           ##
@@ -343,145 +403,151 @@ module Twilio
           # @return [SimContext] SimContext for this SimInstance
           def context
             unless @instance_context
-              @instance_context = SimContext.new(@version, @params['sid'])
+              @instance_context = SimContext.new(@version, @params['sid'], )
             end
             @instance_context
           end
 
           ##
-          # @return [String] The sid
+          # @return [String] The unique string that identifies the Sim resource
           def sid
             @properties['sid']
           end
 
           ##
-          # @return [String] The unique_name
+          # @return [String] An application-defined string that uniquely identifies the resource
           def unique_name
             @properties['unique_name']
           end
 
           ##
-          # @return [String] The account_sid
+          # @return [String] The SID of the Account to which the Sim resource belongs
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [String] The rate_plan_sid
+          # @return [String] The SID of the RatePlan resource to which the Sim resource is assigned.
           def rate_plan_sid
             @properties['rate_plan_sid']
           end
 
           ##
-          # @return [String] The friendly_name
+          # @return [String] The string that you assigned to describe the Sim resource
           def friendly_name
             @properties['friendly_name']
           end
 
           ##
-          # @return [String] The iccid
+          # @return [String] The ICCID associated with the SIM
           def iccid
             @properties['iccid']
           end
 
           ##
-          # @return [String] The e_id
+          # @return [String] Deprecated
           def e_id
             @properties['e_id']
           end
 
           ##
-          # @return [sim.Status] The status
+          # @return [sim.Status] The status of the Sim resource
           def status
             @properties['status']
           end
 
           ##
-          # @return [String] The commands_callback_url
+          # @return [sim.ResetStatus] The connectivity reset status of the SIM
+          def reset_status
+            @properties['reset_status']
+          end
+
+          ##
+          # @return [String] The URL we call when the SIM originates a machine-to-machine Command
           def commands_callback_url
             @properties['commands_callback_url']
           end
 
           ##
-          # @return [String] The commands_callback_method
+          # @return [String] The HTTP method we use to call commands_callback_url
           def commands_callback_method
             @properties['commands_callback_method']
           end
 
           ##
-          # @return [String] The sms_fallback_method
+          # @return [String] The HTTP method we use to call sms_fallback_url
           def sms_fallback_method
             @properties['sms_fallback_method']
           end
 
           ##
-          # @return [String] The sms_fallback_url
+          # @return [String] The URL we call when an error occurs while retrieving or executing the TwiML requested from the sms_url
           def sms_fallback_url
             @properties['sms_fallback_url']
           end
 
           ##
-          # @return [String] The sms_method
+          # @return [String] The HTTP method we use to call sms_url
           def sms_method
             @properties['sms_method']
           end
 
           ##
-          # @return [String] The sms_url
+          # @return [String] The URL we call when the SIM-connected device sends an SMS message that is not a Command
           def sms_url
             @properties['sms_url']
           end
 
           ##
-          # @return [String] The voice_fallback_method
+          # @return [String] The HTTP method we use to call voice_fallback_url
           def voice_fallback_method
             @properties['voice_fallback_method']
           end
 
           ##
-          # @return [String] The voice_fallback_url
+          # @return [String] The URL we call when an error occurs while retrieving or executing the TwiML requested from voice_url
           def voice_fallback_url
             @properties['voice_fallback_url']
           end
 
           ##
-          # @return [String] The voice_method
+          # @return [String] The HTTP method we use to call voice_url
           def voice_method
             @properties['voice_method']
           end
 
           ##
-          # @return [String] The voice_url
+          # @return [String] The URL we call when the SIM-connected device makes a voice call
           def voice_url
             @properties['voice_url']
           end
 
           ##
-          # @return [Time] The date_created
+          # @return [Time] The ISO 8601 date and time in GMT when the resource was created
           def date_created
             @properties['date_created']
           end
 
           ##
-          # @return [Time] The date_updated
+          # @return [Time] The ISO 8601 date and time in GMT when the Sim resource was last updated
           def date_updated
             @properties['date_updated']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The absolute URL of the resource
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] The links
+          # @return [String] The URLs of related subresources
           def links
             @properties['links']
           end
 
           ##
-          # @return [String] The ip_address
+          # @return [String] Deprecated
           def ip_address
             @properties['ip_address']
           end
@@ -495,24 +561,61 @@ module Twilio
 
           ##
           # Update the SimInstance
-          # @param [String] unique_name The unique_name
-          # @param [String] callback_method The callback_method
-          # @param [String] callback_url The callback_url
-          # @param [String] friendly_name The friendly_name
-          # @param [String] rate_plan The rate_plan
-          # @param [sim.Status] status The status
-          # @param [String] commands_callback_method The commands_callback_method
-          # @param [String] commands_callback_url The commands_callback_url
-          # @param [String] sms_fallback_method The sms_fallback_method
-          # @param [String] sms_fallback_url The sms_fallback_url
-          # @param [String] sms_method The sms_method
-          # @param [String] sms_url The sms_url
-          # @param [String] voice_fallback_method The voice_fallback_method
-          # @param [String] voice_fallback_url The voice_fallback_url
-          # @param [String] voice_method The voice_method
-          # @param [String] voice_url The voice_url
+          # @param [String] unique_name An application-defined string that uniquely
+          #   identifies the resource. It can be used in place of the `sid` in the URL path to
+          #   address the resource.
+          # @param [String] callback_method The HTTP method we should use to call
+          #   `callback_url`. Can be: `POST` or `GET`. The default is `POST`.
+          # @param [String] callback_url The URL we should call using the `callback_url`
+          #   when the SIM has finished updating. When the SIM transitions from `new` to
+          #   `ready` or from any status to `deactivated`, we call this URL when the status
+          #   changes to an intermediate status (`ready` or `deactivated`) and again when the
+          #   status changes to its final status (`active` or `canceled`).
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the Sim resource. It does not need to be unique.
+          # @param [String] rate_plan The SID or unique name of the [RatePlan
+          #   resource](https://www.twilio.com/docs/wireless/api/rateplan-resource) to which
+          #   the Sim resource should be assigned.
+          # @param [sim.Status] status The new status of the Sim resource. Can be: `ready`,
+          #   `active`, `suspended`, or `deactivated`.
+          # @param [String] commands_callback_method The HTTP method we should use to call
+          #   `commands_callback_url`. Can be: `POST` or `GET`. The default is `POST`.
+          # @param [String] commands_callback_url The URL we should call using the
+          #   `commands_callback_method` when the SIM sends a
+          #   [Command](https://www.twilio.com/docs/wireless/api/command-resource). Your
+          #   server should respond with an HTTP status code in the 200 range; any response
+          #   body is ignored.
+          # @param [String] sms_fallback_method The HTTP method we should use to call
+          #   `sms_fallback_url`. Can be: `GET` or `POST`. Default is `POST`.
+          # @param [String] sms_fallback_url The URL we should call using the
+          #   `sms_fallback_method` when an error occurs while retrieving or executing the
+          #   TwiML requested from `sms_url`.
+          # @param [String] sms_method The HTTP method we should use to call `sms_url`. Can
+          #   be: `GET` or `POST`. Default is `POST`.
+          # @param [String] sms_url The URL we should call using the `sms_method` when the
+          #   SIM-connected device sends an SMS message that is not a
+          #   [Command](https://www.twilio.com/docs/wireless/api/command-resource).
+          # @param [String] voice_fallback_method The HTTP method we should use to call
+          #   `voice_fallback_url`. Can be: `GET` or `POST`.
+          # @param [String] voice_fallback_url The URL we should call using the
+          #   `voice_fallback_method` when an error occurs while retrieving or executing the
+          #   TwiML requested from `voice_url`.
+          # @param [String] voice_method The HTTP method we should use when we call
+          #   `voice_url`. Can be: `GET` or `POST`.
+          # @param [String] voice_url The URL we should call using the `voice_method` when
+          #   the SIM-connected device makes a voice call.
+          # @param [sim.ResetStatus] reset_status Initiate a connectivity reset on the SIM.
+          #   Set to `resetting` to initiate a connectivity reset on the SIM. No other value
+          #   is valid.
+          # @param [String] account_sid The SID of the
+          #   [Account](https://www.twilio.com/docs/iam/api/account) to which the Sim resource
+          #   should belong. The Account SID can only be that of the requesting Account or
+          #   that of a [Subaccount](https://www.twilio.com/docs/iam/api/subaccounts) of the
+          #   requesting Account. Only valid when the Sim resource's status is `new`. For more
+          #   information, see the [Move SIMs between Subaccounts
+          #   documentation](https://www.twilio.com/docs/wireless/api/sim-resource#move-sims-between-subaccounts).
           # @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)
+          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, reset_status: :unset, account_sid: :unset)
             context.update(
                 unique_name: unique_name,
                 callback_method: callback_method,
@@ -530,9 +633,18 @@ module Twilio
                 voice_fallback_url: voice_fallback_url,
                 voice_method: voice_method,
                 voice_url: voice_url,
+                reset_status: reset_status,
+                account_sid: account_sid,
             )
           end
 
+          ##
+          # Deletes the SimInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
+          def delete
+            context.delete
+          end
+
           ##
           # Access the usage_records
           # @return [usage_records] usage_records