twilio-ruby 5.20.0 → 5.47.0

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -15,9 +15,9 @@ module Twilio
             ##
             # Initialize the DataSessionList
             # @param [Version] version Version that contains the resource
-            # @param [String] sim_sid The unique id of the
-            #   [SIM](https://www.twilio.com/docs/api/wireless/rest-api/sim) resource that this
-            #   Data Session is for.
+            # @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)
@@ -31,8 +31,6 @@ 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 [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
@@ -40,16 +38,14 @@ module Twilio
             #    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, limit: nil, page_size: nil)
-              self.stream(end_: end_, start: start, limit: limit, page_size: page_size).entries
+            def list(limit: nil, page_size: nil)
+              self.stream(limit: limit, page_size: page_size).entries
             end
 
             ##
             # 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 [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
@@ -57,10 +53,10 @@ module Twilio
             #    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, limit: nil, page_size: nil)
+            def stream(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(page_size: limits[:page_size], )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -82,25 +78,19 @@ 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 [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 DataSessionInstance
-            def page(end_: :unset, start: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+            def page(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),
                   'PageToken' => page_token,
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               DataSessionPage.new(@version, response, @solution)
             end
 
@@ -158,9 +148,9 @@ module Twilio
             # 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 unique id of the
-            #   [SIM](https://www.twilio.com/docs/api/wireless/rest-api/sim) resource that this
-            #   Data Session is for.
+            # @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 +172,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 unique id of the Data Session resource that this Data Record is for.
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The unique id of the SIM resource that this Data Session is for.
+            # @return [String] The SID of the Sim resource that the Data Session is for
             def sim_sid
               @properties['sim_sid']
             end
 
             ##
-            # @return [String] The unique id of the Account that the SIM belongs to.
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The generation of wireless technology that the device was attached to the cellular tower using.
+            # @return [String] The generation of wireless technology that the device was using
             def radio_link
               @properties['radio_link']
             end
 
             ##
-            # @return [String] The 'mobile country code' is the unique id of the home country where the Data Session took place.
+            # @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 'mobile network code' is the unique id specific to the mobile operator network where the Data Session took place.
+            # @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 three letter country code representing where the device's Data Session took place.
+            # @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 friendly name of the mobile operator network that the SIM-connected device is attached to.
+            # @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 unique id of the cellular tower that the device was attached to at the moment when the Data Session was last updated.
+            # @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] An object representing the estimated location where the device's Data Session took place.
+            # @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 number of packets uploaded by the device between the start time and when the Data Session was last updated.
+            # @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 number of packets downloaded by the device between the start time and when the Data Session was last updated.
+            # @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 date that this resource was last updated, given as GMT in ISO 8601 format.
+            # @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 date that this Data Session started, given as GMT in ISO 8601 format.
+            # @return [Time] The date that the Data Session started, given as GMT in ISO 8601 format
             def start
               @properties['start']
             end
 
             ##
-            # @return [Time] The date that this record ended, given as GMT in ISO 8601 format.
+            # @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

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -15,9 +15,9 @@ module Twilio
             ##
             # Initialize the UsageRecordList
             # @param [Version] version Version that contains the resource
-            # @param [String] sim_sid The unique id of the
-            #   [SIM](https://www.twilio.com/docs/api/wireless/rest-api/sim) resource that this
-            #   Usage Record is for.
+            # @param [String] sim_sid The SID of the {Sim
+            #   resource}[https://www.twilio.com/docs/wireless/api/sim-resource] that this Usage
+            #   Record is for.
             # @return [UsageRecordList] UsageRecordList
             def initialize(version, sim_sid: nil)
               super(version)
@@ -31,13 +31,15 @@ module Twilio
             # 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_ Only include usage that has occurred on or before this date.
-            #   Format is [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm).
-            # @param [Time] start Only include usage that has occurred on or after this date.
-            #   Format is [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm).
-            # @param [usage_record.Granularity] granularity The time-based grouping that
-            #   results are aggregated by. Valid values are `daily`, `hourly`, `all`. `all` will
-            #   return one Usage Record for the entire period.
+            # @param [Time] end_ Only include usage that occurred on or before this date,
+            #   specified in {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html].
+            #   The default is the current time.
+            # @param [Time] start Only include usage that has occurred on or after this date,
+            #   specified in {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html].
+            #   The default is one month before the `end` parameter value.
+            # @param [usage_record.Granularity] granularity How to summarize the usage by
+            #   time. Can be: `daily`, `hourly`, or `all`. The default is `all`. A value of
+            #   `all` returns one Usage Record that describes the usage for the entire period.
             # @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
@@ -59,13 +61,15 @@ module Twilio
             # 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_ Only include usage that has occurred on or before this date.
-            #   Format is [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm).
-            # @param [Time] start Only include usage that has occurred on or after this date.
-            #   Format is [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm).
-            # @param [usage_record.Granularity] granularity The time-based grouping that
-            #   results are aggregated by. Valid values are `daily`, `hourly`, `all`. `all` will
-            #   return one Usage Record for the entire period.
+            # @param [Time] end_ Only include usage that occurred on or before this date,
+            #   specified in {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html].
+            #   The default is the current time.
+            # @param [Time] start Only include usage that has occurred on or after this date,
+            #   specified in {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html].
+            #   The default is one month before the `end` parameter value.
+            # @param [usage_record.Granularity] granularity How to summarize the usage by
+            #   time. Can be: `daily`, `hourly`, or `all`. The default is `all`. A value of
+            #   `all` returns one Usage Record that describes the usage for the entire period.
             # @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
@@ -98,13 +102,15 @@ module Twilio
             ##
             # Retrieve a single page of UsageRecordInstance records from the API.
             # Request is executed immediately.
-            # @param [Time] end_ Only include usage that has occurred on or before this date.
-            #   Format is [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm).
-            # @param [Time] start Only include usage that has occurred on or after this date.
-            #   Format is [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm).
-            # @param [usage_record.Granularity] granularity The time-based grouping that
-            #   results are aggregated by. Valid values are `daily`, `hourly`, `all`. `all` will
-            #   return one Usage Record for the entire period.
+            # @param [Time] end_ Only include usage that occurred on or before this date,
+            #   specified in {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html].
+            #   The default is the current time.
+            # @param [Time] start Only include usage that has occurred on or after this date,
+            #   specified in {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html].
+            #   The default is one month before the `end` parameter value.
+            # @param [usage_record.Granularity] granularity How to summarize the usage by
+            #   time. Can be: `daily`, `hourly`, or `all`. The default is `all`. A value of
+            #   `all` returns one Usage Record that describes the usage for the entire period.
             # @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
@@ -118,11 +124,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               UsageRecordPage.new(@version, response, @solution)
             end
 
@@ -180,9 +184,9 @@ module Twilio
             # 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 unique id of the
-            #   [SIM](https://www.twilio.com/docs/api/wireless/rest-api/sim) resource that this
-            #   Usage Record is for.
+            # @param [String] sim_sid The SID of the {Sim
+            #   resource}[https://www.twilio.com/docs/wireless/api/sim-resource] that this Usage
+            #   Record is for.
             # @return [UsageRecordInstance] UsageRecordInstance
             def initialize(version, payload, sim_sid: nil)
               super(version)
@@ -198,31 +202,31 @@ module Twilio
             end
 
             ##
-            # @return [String] The unique id of the SIM resource that this Usage Record is for.
+            # @return [String] The SID of the Sim resource that this Usage Record is for
             def sim_sid
               @properties['sim_sid']
             end
 
             ##
-            # @return [String] The unique id of the Account that the SIM belongs to.
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [Hash] The time period for which usage is reported.
+            # @return [Hash] The time period for which the usage is reported
             def period
               @properties['period']
             end
 
             ##
-            # @return [Hash] An object representing the Commands usage for the SIM over the period.
+            # @return [Hash] An object that describes the SIM's usage of Commands during the specified period
             def commands
               @properties['commands']
             end
 
             ##
-            # @return [Hash] An object representing the Data usage for the SIM over the period.
+            # @return [Hash] An object that describes the SIM's data usage during the specified period
             def data
               @properties['data']
             end

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

@@ -0,0 +1,229 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Wireless < Domain
+      class V1 < Version
+        class UsageRecordList < ListResource
+          ##
+          # Initialize the UsageRecordList
+          # @param [Version] version Version that contains the resource
+          # @return [UsageRecordList] UsageRecordList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/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_ Only include usage that has occurred on or before this date.
+          #   Format is {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html].
+          # @param [Time] start Only include usage that has occurred on or after this date.
+          #   Format is {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html].
+          # @param [usage_record.Granularity] granularity How to summarize the usage by
+          #   time. Can be: `daily`, `hourly`, or `all`. A value of `all` returns one Usage
+          #   Record that describes the usage for the entire period.
+          # @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_ Only include usage that has occurred on or before this date.
+          #   Format is {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html].
+          # @param [Time] start Only include usage that has occurred on or after this date.
+          #   Format is {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html].
+          # @param [usage_record.Granularity] granularity How to summarize the usage by
+          #   time. Can be: `daily`, `hourly`, or `all`. A value of `all` returns one Usage
+          #   Record that describes the usage for the entire period.
+          # @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_ Only include usage that has occurred on or before this date.
+          #   Format is {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html].
+          # @param [Time] start Only include usage that has occurred on or after this date.
+          #   Format is {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html].
+          # @param [usage_record.Granularity] granularity How to summarize the usage by
+          #   time. Can be: `daily`, `hourly`, or `all`. A value of `all` returns one Usage
+          #   Record that describes the usage for the entire period.
+          # @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: 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
+
+        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, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Wireless.V1.UsageRecordPage>'
+          end
+        end
+
+        class UsageRecordInstance < InstanceResource
+          ##
+          # Initialize the UsageRecordInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [UsageRecordInstance] UsageRecordInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'account_sid' => payload['account_sid'],
+                'period' => payload['period'],
+                'commands' => payload['commands'],
+                'data' => payload['data'],
+            }
+          end
+
+          ##
+          # @return [String] The SID of the Account that created the resource
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [Hash] The time period for which usage is reported
+          def period
+            @properties['period']
+          end
+
+          ##
+          # @return [Hash] An object that describes the aggregated Commands usage for all SIMs during the specified period
+          def commands
+            @properties['commands']
+          end
+
+          ##
+          # @return [Hash] An object that describes the aggregated Data usage for all SIMs over the period
+          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