twilio-ruby 5.47.0 → 5.74.0

data/lib/twilio-ruby/rest/supersim/v1/settings_update.rb

@@ -0,0 +1,247 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Supersim < Domain
+      class V1 < Version
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class SettingsUpdateList < ListResource
+          ##
+          # Initialize the SettingsUpdateList
+          # @param [Version] version Version that contains the resource
+          # @return [SettingsUpdateList] SettingsUpdateList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/SettingsUpdates"
+          end
+
+          ##
+          # Lists SettingsUpdateInstance records from the API as a list.
+          # Unlike stream(), this operation is eager and will load `limit` records into
+          # memory before returning.
+          # @param [String] sim Filter the Settings Updates by a Super SIM's SID or
+          #   UniqueName.
+          # @param [settings_update.Status] status Filter the Settings Updates by status.
+          #   Can be `scheduled`, `in-progress`, `successful`, or `failed`.
+          # @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(sim: :unset, status: :unset, limit: nil, page_size: nil)
+            self.stream(sim: sim, status: status, limit: limit, page_size: page_size).entries
+          end
+
+          ##
+          # Streams SettingsUpdateInstance records from the API as an Enumerable.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @param [String] sim Filter the Settings Updates by a Super SIM's SID or
+          #   UniqueName.
+          # @param [settings_update.Status] status Filter the Settings Updates by status.
+          #   Can be `scheduled`, `in-progress`, `successful`, or `failed`.
+          # @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(sim: :unset, status: :unset, limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+
+            page = self.page(sim: sim, status: status, page_size: limits[:page_size], )
+
+            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+          end
+
+          ##
+          # When passed a block, yields SettingsUpdateInstance 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 SettingsUpdateInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] sim Filter the Settings Updates by a Super SIM's SID or
+          #   UniqueName.
+          # @param [settings_update.Status] status Filter the Settings Updates by status.
+          #   Can be `scheduled`, `in-progress`, `successful`, or `failed`.
+          # @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 SettingsUpdateInstance
+          def page(sim: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+            params = Twilio::Values.of({
+                'Sim' => sim,
+                'Status' => status,
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            })
+
+            response = @version.page('GET', @uri, params: params)
+
+            SettingsUpdatePage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of SettingsUpdateInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of SettingsUpdateInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            SettingsUpdatePage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Supersim.V1.SettingsUpdateList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class SettingsUpdatePage < Page
+          ##
+          # Initialize the SettingsUpdatePage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [SettingsUpdatePage] SettingsUpdatePage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of SettingsUpdateInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [SettingsUpdateInstance] SettingsUpdateInstance
+          def get_instance(payload)
+            SettingsUpdateInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Supersim.V1.SettingsUpdatePage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class SettingsUpdateInstance < InstanceResource
+          ##
+          # Initialize the SettingsUpdateInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [SettingsUpdateInstance] SettingsUpdateInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'iccid' => payload['iccid'],
+                'sim_sid' => payload['sim_sid'],
+                'status' => payload['status'],
+                'packages' => payload['packages'],
+                'date_completed' => Twilio.deserialize_iso8601_datetime(payload['date_completed']),
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+            }
+          end
+
+          ##
+          # @return [String] The unique identifier of this Settings Update
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] The ICCID associated with the SIM
+          def iccid
+            @properties['iccid']
+          end
+
+          ##
+          # @return [String] The SID of the Super SIM to which this Settings Update was applied
+          def sim_sid
+            @properties['sim_sid']
+          end
+
+          ##
+          # @return [settings_update.Status] The Status of this Settings Update
+          def status
+            @properties['status']
+          end
+
+          ##
+          # @return [Array[Hash]] Array containing the different Settings Packages that will be applied to the SIM after the update completes
+          def packages
+            @properties['packages']
+          end
+
+          ##
+          # @return [Time] The time when the update successfully completed and the new settings were applied to the SIM
+          def date_completed
+            @properties['date_completed']
+          end
+
+          ##
+          # @return [Time] The date this Settings Update was created
+          def date_created
+            @properties['date_created']
+          end
+
+          ##
+          # @return [Time] The date this Settings Update was last updated
+          def date_updated
+            @properties['date_updated']
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            "<Twilio.Supersim.V1.SettingsUpdateInstance>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            "<Twilio.Supersim.V1.SettingsUpdateInstance>"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/supersim/v1/sim/billing_period.rb

@@ -0,0 +1,231 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Supersim < Domain
+      class V1 < Version
+        class SimContext < InstanceContext
+          class BillingPeriodList < ListResource
+            ##
+            # Initialize the BillingPeriodList
+            # @param [Version] version Version that contains the resource
+            # @param [String] sim_sid The SID of the Super SIM the Billing Period belongs to.
+            # @return [BillingPeriodList] BillingPeriodList
+            def initialize(version, sim_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {sim_sid: sim_sid}
+              @uri = "/Sims/#{@solution[:sim_sid]}/BillingPeriods"
+            end
+
+            ##
+            # Lists BillingPeriodInstance records from the API as a list.
+            # Unlike stream(), this operation is eager and will load `limit` records into
+            # memory before returning.
+            # @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(limit: nil, page_size: nil)
+              self.stream(limit: limit, page_size: page_size).entries
+            end
+
+            ##
+            # Streams BillingPeriodInstance records from the API as an Enumerable.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            # @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(limit: nil, page_size: nil)
+              limits = @version.read_limits(limit, page_size)
+
+              page = self.page(page_size: limits[:page_size], )
+
+              @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+            end
+
+            ##
+            # When passed a block, yields BillingPeriodInstance 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 BillingPeriodInstance records from the API.
+            # Request is executed immediately.
+            # @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 BillingPeriodInstance
+            def page(page_token: :unset, page_number: :unset, page_size: :unset)
+              params = Twilio::Values.of({
+                  'PageToken' => page_token,
+                  'Page' => page_number,
+                  'PageSize' => page_size,
+              })
+
+              response = @version.page('GET', @uri, params: params)
+
+              BillingPeriodPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of BillingPeriodInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of BillingPeriodInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              BillingPeriodPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Supersim.V1.BillingPeriodList>'
+            end
+          end
+
+          class BillingPeriodPage < Page
+            ##
+            # Initialize the BillingPeriodPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [BillingPeriodPage] BillingPeriodPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of BillingPeriodInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [BillingPeriodInstance] BillingPeriodInstance
+            def get_instance(payload)
+              BillingPeriodInstance.new(@version, payload, sim_sid: @solution[:sim_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Supersim.V1.BillingPeriodPage>'
+            end
+          end
+
+          class BillingPeriodInstance < InstanceResource
+            ##
+            # Initialize the BillingPeriodInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] sim_sid The SID of the Super SIM the Billing Period belongs to.
+            # @return [BillingPeriodInstance] BillingPeriodInstance
+            def initialize(version, payload, sim_sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'sid' => payload['sid'],
+                  'account_sid' => payload['account_sid'],
+                  'sim_sid' => payload['sim_sid'],
+                  'start_time' => Twilio.deserialize_iso8601_datetime(payload['start_time']),
+                  'end_time' => Twilio.deserialize_iso8601_datetime(payload['end_time']),
+                  'period_type' => payload['period_type'],
+                  'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                  'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+              }
+            end
+
+            ##
+            # @return [String] The SID of the Billing Period
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @return [String] The SID of the Account the Super SIM belongs to
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [String] The SID of the Super SIM the Billing Period belongs to
+            def sim_sid
+              @properties['sim_sid']
+            end
+
+            ##
+            # @return [Time] The start time of the Billing Period
+            def start_time
+              @properties['start_time']
+            end
+
+            ##
+            # @return [Time] The end time of the Billing Period
+            def end_time
+              @properties['end_time']
+            end
+
+            ##
+            # @return [billing_period.BpType] The type of the Billing Period
+            def period_type
+              @properties['period_type']
+            end
+
+            ##
+            # @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 ISO 8601 date and time in GMT when the resource was last updated
+            def date_updated
+              @properties['date_updated']
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              "<Twilio.Supersim.V1.BillingPeriodInstance>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              "<Twilio.Supersim.V1.BillingPeriodInstance>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/supersim/v1/sim/sim_ip_address.rb

@@ -0,0 +1,195 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Supersim < 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 SimIpAddressList < ListResource
+            ##
+            # Initialize the SimIpAddressList
+            # @param [Version] version Version that contains the resource
+            # @param [String] sim_sid The unique string that identifies the Sim resource.
+            # @return [SimIpAddressList] SimIpAddressList
+            def initialize(version, sim_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {sim_sid: sim_sid}
+              @uri = "/Sims/#{@solution[:sim_sid]}/IpAddresses"
+            end
+
+            ##
+            # Lists SimIpAddressInstance records from the API as a list.
+            # Unlike stream(), this operation is eager and will load `limit` records into
+            # memory before returning.
+            # @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(limit: nil, page_size: nil)
+              self.stream(limit: limit, page_size: page_size).entries
+            end
+
+            ##
+            # Streams SimIpAddressInstance records from the API as an Enumerable.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            # @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(limit: nil, page_size: nil)
+              limits = @version.read_limits(limit, page_size)
+
+              page = self.page(page_size: limits[:page_size], )
+
+              @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+            end
+
+            ##
+            # When passed a block, yields SimIpAddressInstance 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 SimIpAddressInstance records from the API.
+            # Request is executed immediately.
+            # @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 SimIpAddressInstance
+            def page(page_token: :unset, page_number: :unset, page_size: :unset)
+              params = Twilio::Values.of({
+                  'PageToken' => page_token,
+                  'Page' => page_number,
+                  'PageSize' => page_size,
+              })
+
+              response = @version.page('GET', @uri, params: params)
+
+              SimIpAddressPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of SimIpAddressInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of SimIpAddressInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              SimIpAddressPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Supersim.V1.SimIpAddressList>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class SimIpAddressPage < Page
+            ##
+            # Initialize the SimIpAddressPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [SimIpAddressPage] SimIpAddressPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of SimIpAddressInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [SimIpAddressInstance] SimIpAddressInstance
+            def get_instance(payload)
+              SimIpAddressInstance.new(@version, payload, sim_sid: @solution[:sim_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Supersim.V1.SimIpAddressPage>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class SimIpAddressInstance < InstanceResource
+            ##
+            # Initialize the SimIpAddressInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] sim_sid The unique string that identifies the Sim resource.
+            # @return [SimIpAddressInstance] SimIpAddressInstance
+            def initialize(version, payload, sim_sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'ip_address' => payload['ip_address'],
+                  'ip_address_version' => payload['ip_address_version'],
+              }
+            end
+
+            ##
+            # @return [String] IP address assigned to the given Super SIM
+            def ip_address
+              @properties['ip_address']
+            end
+
+            ##
+            # @return [sim_ip_address.IpAddressVersion] IP address version
+            def ip_address_version
+              @properties['ip_address_version']
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              "<Twilio.Supersim.V1.SimIpAddressInstance>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              "<Twilio.Supersim.V1.SimIpAddressInstance>"
+            end
+          end
+        end
+      end
+    end
+  end
+end