twilio-ruby 5.6.0 → 5.33.0

data/lib/twilio-ruby/rest/wireless/v1/rate_plan.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 RatePlanList < ListResource
           ##
           # Initialize the RatePlanList
@@ -52,7 +52,7 @@ module Twilio
           def stream(limit: nil, page_size: nil)
             limits = @version.read_limits(limit, page_size)
 
-            page = self.page(page_size: limits[:page_size])
+            page = self.page(page_size: limits[:page_size], )
 
             @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
           end
@@ -64,7 +64,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],
@@ -108,18 +108,40 @@ module Twilio
           ##
           # Retrieve a single page of RatePlanInstance records from the API.
           # Request is executed immediately.
-          # @param [String] unique_name The unique_name
-          # @param [String] friendly_name The friendly_name
-          # @param [Boolean] data_enabled The data_enabled
-          # @param [String] data_limit The data_limit
-          # @param [String] data_metering The data_metering
-          # @param [Boolean] messaging_enabled The messaging_enabled
-          # @param [Boolean] voice_enabled The voice_enabled
-          # @param [Boolean] national_roaming_enabled The national_roaming_enabled
-          # @param [String] international_roaming The international_roaming
-          # @param [String] national_roaming_data_limit The national_roaming_data_limit
-          # @param [String] international_roaming_data_limit The
-          #   international_roaming_data_limit
+          # @param [String] unique_name An application-defined string that uniquely
+          #   identifies the resource. It can be used in place of the resource's `sid` in the
+          #   URL to address the resource.
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource. It does not have to be unique.
+          # @param [Boolean] data_enabled Whether SIMs can use GPRS/3G/4G/LTE data
+          #   connectivity.
+          # @param [String] data_limit The total data usage (download and upload combined)
+          #   in Megabytes that the Network allows during one month on the home network
+          #   (T-Mobile USA). The metering period begins the day of activation and ends on the
+          #   same day in the following month. Can be up to 2TB and the default value is
+          #   `1000`.
+          # @param [String] data_metering The model used to meter data usage. Can be: `payg`
+          #   and `quota-1`, `quota-10`, and `quota-50`. Learn more about the available [data
+          #   metering
+          #   models](https://www.twilio.com/docs/wireless/api/rateplan-resource#payg-vs-quota-data-plans).
+          # @param [Boolean] messaging_enabled Whether SIMs can make, send, and receive SMS
+          #   using [Commands](https://www.twilio.com/docs/wireless/api/command-resource).
+          # @param [Boolean] voice_enabled Whether SIMs can make and receive voice calls.
+          # @param [Boolean] national_roaming_enabled Whether SIMs can roam on networks
+          #   other than the home network (T-Mobile USA) in the United States. See [national
+          #   roaming](https://www.twilio.com/docs/wireless/api/rateplan-resource#national-roaming).
+          # @param [String] international_roaming The list of services that SIMs capable of
+          #   using GPRS/3G/4G/LTE data connectivity can use outside of the United States. Can
+          #   be: `data`, `voice`, and `messaging`.
+          # @param [String] national_roaming_data_limit The total data usage (download and
+          #   upload combined) in Megabytes that the Network allows during one month on
+          #   non-home networks in the United States. The metering period begins the day of
+          #   activation and ends on the same day in the following month. Can be up to 2TB.
+          #   See [national
+          #   roaming](https://www.twilio.com/docs/wireless/api/rateplan-resource#national-roaming) for more info.
+          # @param [String] international_roaming_data_limit The total data usage (download
+          #   and upload combined) in Megabytes that the Network allows during one month when
+          #   roaming outside the United States. Can be up to 2TB.
           # @return [RatePlanInstance] Newly created RatePlanInstance
           def create(unique_name: :unset, friendly_name: :unset, data_enabled: :unset, data_limit: :unset, data_metering: :unset, messaging_enabled: :unset, voice_enabled: :unset, national_roaming_enabled: :unset, international_roaming: :unset, national_roaming_data_limit: :unset, international_roaming_data_limit: :unset)
             data = Twilio::Values.of({
@@ -142,7 +164,7 @@ module Twilio
                 data: data
             )
 
-            RatePlanInstance.new(@version, payload)
+            RatePlanInstance.new(@version, payload, )
           end
 
           ##
@@ -152,8 +174,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class RatePlanPage < Page
           ##
           # Initialize the RatePlanPage
@@ -173,7 +193,7 @@ module Twilio
           # @param [Hash] payload Payload response from the API
           # @return [RatePlanInstance] RatePlanInstance
           def get_instance(payload)
-            RatePlanInstance.new(@version, payload)
+            RatePlanInstance.new(@version, payload, )
           end
 
           ##
@@ -183,19 +203,17 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class RatePlanContext < InstanceContext
           ##
           # Initialize the RatePlanContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The sid
+          # @param [String] sid The SID of the RatePlan resource to fetch.
           # @return [RatePlanContext] RatePlanContext
           def initialize(version, sid)
             super(version)
 
             # Path Solution
-            @solution = {sid: sid}
+            @solution = {sid: sid, }
             @uri = "/RatePlans/#{@solution[:sid]}"
           end
 
@@ -211,16 +229,19 @@ module Twilio
                 params,
             )
 
-            RatePlanInstance.new(@version, payload, sid: @solution[:sid])
+            RatePlanInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
           # Update the RatePlanInstance
-          # @param [String] unique_name The unique_name
-          # @param [String] friendly_name The friendly_name
+          # @param [String] unique_name An application-defined string that uniquely
+          #   identifies the resource. It can be used in place of the resource's `sid` in the
+          #   URL to address the resource.
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource. It does not have to be unique.
           # @return [RatePlanInstance] Updated RatePlanInstance
           def update(unique_name: :unset, friendly_name: :unset)
-            data = Twilio::Values.of({'UniqueName' => unique_name, 'FriendlyName' => friendly_name})
+            data = Twilio::Values.of({'UniqueName' => unique_name, 'FriendlyName' => friendly_name, })
 
             payload = @version.update(
                 'POST',
@@ -228,12 +249,12 @@ module Twilio
                 data: data,
             )
 
-            RatePlanInstance.new(@version, payload, sid: @solution[:sid])
+            RatePlanInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
           # Deletes the RatePlanInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             @version.delete('delete', @uri)
           end
@@ -244,16 +265,21 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Wireless.V1.RatePlanContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Wireless.V1.RatePlanContext #{context}>"
+          end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class RatePlanInstance < InstanceResource
           ##
           # Initialize the RatePlanInstance
           # @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 of the RatePlan resource to fetch.
           # @return [RatePlanInstance] RatePlanInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -280,7 +306,7 @@ module Twilio
 
             # Context
             @instance_context = nil
-            @params = {'sid' => sid || @properties['sid']}
+            @params = {'sid' => sid || @properties['sid'], }
           end
 
           ##
@@ -289,103 +315,103 @@ module Twilio
           # @return [RatePlanContext] RatePlanContext for this RatePlanInstance
           def context
             unless @instance_context
-              @instance_context = RatePlanContext.new(@version, @params['sid'])
+              @instance_context = RatePlanContext.new(@version, @params['sid'], )
             end
             @instance_context
           end
 
           ##
-          # @return [String] The sid
+          # @return [String] The unique string that identifies the 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 that created the resource
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [String] The friendly_name
+          # @return [String] The string that you assigned to describe the resource
           def friendly_name
             @properties['friendly_name']
           end
 
           ##
-          # @return [Boolean] The data_enabled
+          # @return [Boolean] Whether SIMs can use GPRS/3G/4G/LTE data connectivity
           def data_enabled
             @properties['data_enabled']
           end
 
           ##
-          # @return [String] The data_metering
+          # @return [String] The model used to meter data usage
           def data_metering
             @properties['data_metering']
           end
 
           ##
-          # @return [String] The data_limit
+          # @return [String] The total data usage in Megabytes that the Network allows during one month on the home network
           def data_limit
             @properties['data_limit']
           end
 
           ##
-          # @return [Boolean] The messaging_enabled
+          # @return [Boolean] Whether SIMs can make, send, and receive SMS using Commands
           def messaging_enabled
             @properties['messaging_enabled']
           end
 
           ##
-          # @return [Boolean] The voice_enabled
+          # @return [Boolean] Whether SIMs can make and receive voice calls
           def voice_enabled
             @properties['voice_enabled']
           end
 
           ##
-          # @return [Boolean] The national_roaming_enabled
+          # @return [Boolean] Whether SIMs can roam on networks other than the home network in the United States
           def national_roaming_enabled
             @properties['national_roaming_enabled']
           end
 
           ##
-          # @return [String] The national_roaming_data_limit
+          # @return [String] The total data usage in Megabytes that the Network allows during one month on non-home networks in the United States
           def national_roaming_data_limit
             @properties['national_roaming_data_limit']
           end
 
           ##
-          # @return [String] The international_roaming
+          # @return [String] The services that SIMs capable of using GPRS/3G/4G/LTE data connectivity can use outside of the United States
           def international_roaming
             @properties['international_roaming']
           end
 
           ##
-          # @return [String] The international_roaming_data_limit
+          # @return [String] The total data usage (download and upload combined) in Megabytes that the Network allows during one month when roaming outside the United States
           def international_roaming_data_limit
             @properties['international_roaming_data_limit']
           end
 
           ##
-          # @return [Time] The date_created
+          # @return [Time] The date when the resource was created, given as GMT in ISO 8601 format
           def date_created
             @properties['date_created']
           end
 
           ##
-          # @return [Time] The date_updated
+          # @return [Time] The date when the resource was last updated, given as GMT in ISO 8601 format
           def date_updated
             @properties['date_updated']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The absolute URL of the resource
           def url
             @properties['url']
           end
@@ -399,16 +425,19 @@ module Twilio
 
           ##
           # Update the RatePlanInstance
-          # @param [String] unique_name The unique_name
-          # @param [String] friendly_name The friendly_name
+          # @param [String] unique_name An application-defined string that uniquely
+          #   identifies the resource. It can be used in place of the resource's `sid` in the
+          #   URL to address the resource.
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource. It does not have to be unique.
           # @return [RatePlanInstance] Updated RatePlanInstance
           def update(unique_name: :unset, friendly_name: :unset)
-            context.update(unique_name: unique_name, friendly_name: friendly_name)
+            context.update(unique_name: unique_name, friendly_name: friendly_name, )
           end
 
           ##
           # Deletes the RatePlanInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
           end

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

@@ -3,19 +3,21 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 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 DataSessionList < ListResource
             ##
             # Initialize the DataSessionList
             # @param [Version] version Version that contains the resource
-            # @param [String] sim_sid The sim_sid
+            # @param [String] sim_sid The SID of the [Sim
+            #   resource](https://www.twilio.com/docs/wireless/api/sim-resource) that the Data
+            #   Session is for.
             # @return [DataSessionList] DataSessionList
             def initialize(version, sim_sid: nil)
               super(version)
@@ -29,8 +31,10 @@ module Twilio
             # Lists DataSessionInstance 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 [Time] end_ The date that the record ended, given as GMT in [ISO
+            #   8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+            # @param [Time] start The date that the Data Session started, given as GMT in [ISO
+            #   8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
             # @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
@@ -46,8 +50,10 @@ module Twilio
             # Streams DataSessionInstance 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 [Time] end_ The date that the record ended, given as GMT in [ISO
+            #   8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+            # @param [Time] start The date that the Data Session started, given as GMT in [ISO
+            #   8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
             # @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
@@ -58,7 +64,7 @@ module Twilio
             def stream(end_: :unset, start: :unset, limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(end_: end_, start: start, page_size: limits[:page_size])
+              page = self.page(end_: end_, start: start, page_size: limits[:page_size], )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -70,7 +76,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],
@@ -80,8 +86,10 @@ module Twilio
             ##
             # Retrieve a single page of DataSessionInstance records from the API.
             # Request is executed immediately.
-            # @param [Time] end_ The end
-            # @param [Time] start The start
+            # @param [Time] end_ The date that the record ended, given as GMT in [ISO
+            #   8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+            # @param [Time] start The date that the Data Session started, given as GMT in [ISO
+            #   8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
             # @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
@@ -122,8 +130,6 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class DataSessionPage < Page
             ##
             # Initialize the DataSessionPage
@@ -143,7 +149,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [DataSessionInstance] DataSessionInstance
             def get_instance(payload)
-              DataSessionInstance.new(@version, payload, sim_sid: @solution[:sim_sid])
+              DataSessionInstance.new(@version, payload, sim_sid: @solution[:sim_sid], )
             end
 
             ##
@@ -153,14 +159,14 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class DataSessionInstance < InstanceResource
             ##
             # Initialize the DataSessionInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] sim_sid The sim_sid
+            # @param [String] sim_sid The SID of the [Sim
+            #   resource](https://www.twilio.com/docs/wireless/api/sim-resource) that the Data
+            #   Session is for.
             # @return [DataSessionInstance] DataSessionInstance
             def initialize(version, payload, sim_sid: nil)
               super(version)
@@ -182,99 +188,106 @@ module Twilio
                   'last_updated' => Twilio.deserialize_iso8601_datetime(payload['last_updated']),
                   'start' => Twilio.deserialize_iso8601_datetime(payload['start']),
                   'end_' => Twilio.deserialize_iso8601_datetime(payload['end']),
+                  'imei' => payload['imei'],
               }
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The sim_sid
+            # @return [String] The SID of the Sim resource that the Data Session is for
             def sim_sid
               @properties['sim_sid']
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The radio_link
+            # @return [String] The generation of wireless technology that the device was using
             def radio_link
               @properties['radio_link']
             end
 
             ##
-            # @return [String] The operator_mcc
+            # @return [String] The 'mobile country code' is the unique ID of the home country where the Data Session took place
             def operator_mcc
               @properties['operator_mcc']
             end
 
             ##
-            # @return [String] The operator_mnc
+            # @return [String] The 'mobile network code' is the unique ID specific to the mobile operator network where the Data Session took place
             def operator_mnc
               @properties['operator_mnc']
             end
 
             ##
-            # @return [String] The operator_country
+            # @return [String] The three letter country code representing where the device's Data Session took place
             def operator_country
               @properties['operator_country']
             end
 
             ##
-            # @return [String] The operator_name
+            # @return [String] The friendly name of the mobile operator network that the SIM-connected device is attached to
             def operator_name
               @properties['operator_name']
             end
 
             ##
-            # @return [String] The cell_id
+            # @return [String] The unique ID of the cellular tower that the device was attached to at the moment when the Data Session was last updated
             def cell_id
               @properties['cell_id']
             end
 
             ##
-            # @return [Hash] The cell_location_estimate
+            # @return [Hash] An object with the estimated location where the device's Data Session took place
             def cell_location_estimate
               @properties['cell_location_estimate']
             end
 
             ##
-            # @return [String] The packets_uploaded
+            # @return [String] The number of packets uploaded by the device between the start time and when the Data Session was last updated
             def packets_uploaded
               @properties['packets_uploaded']
             end
 
             ##
-            # @return [String] The packets_downloaded
+            # @return [String] The number of packets downloaded by the device between the start time and when the Data Session was last updated
             def packets_downloaded
               @properties['packets_downloaded']
             end
 
             ##
-            # @return [Time] The last_updated
+            # @return [Time] The date that the resource was last updated, given as GMT in ISO 8601 format
             def last_updated
               @properties['last_updated']
             end
 
             ##
-            # @return [Time] The start
+            # @return [Time] The date that the Data Session started, given as GMT in ISO 8601 format
             def start
               @properties['start']
             end
 
             ##
-            # @return [Time] The end
+            # @return [Time] The date that the record ended, given as GMT in ISO 8601 format
             def end_
               @properties['end_']
             end
 
+            ##
+            # @return [String] The unique ID of the device using the SIM to connect
+            def imei
+              @properties['imei']
+            end
+
             ##
             # Provide a user friendly representation
             def to_s