twilio-ruby 5.20.0 → 5.47.0

data/lib/twilio-ruby/rest/studio/v2/flow_validate.rb

@@ -0,0 +1,117 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Studio < Domain
+      class V2 < Version
+        class FlowValidateList < ListResource
+          ##
+          # Initialize the FlowValidateList
+          # @param [Version] version Version that contains the resource
+          # @return [FlowValidateList] FlowValidateList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Flows/Validate"
+          end
+
+          ##
+          # Update the FlowValidateInstance
+          # @param [String] friendly_name The string that you assigned to describe the Flow.
+          # @param [flow_validate.Status] status The status of the Flow. Can be: `draft` or
+          #   `published`.
+          # @param [Hash] definition JSON representation of flow definition.
+          # @param [String] commit_message Description of change made in the revision.
+          # @return [FlowValidateInstance] Updated FlowValidateInstance
+          def update(friendly_name: nil, status: nil, definition: nil, commit_message: :unset)
+            data = Twilio::Values.of({
+                'FriendlyName' => friendly_name,
+                'Status' => status,
+                'Definition' => Twilio.serialize_object(definition),
+                'CommitMessage' => commit_message,
+            })
+
+            payload = @version.update('POST', @uri, data: data)
+
+            FlowValidateInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Studio.V2.FlowValidateList>'
+          end
+        end
+
+        class FlowValidatePage < Page
+          ##
+          # Initialize the FlowValidatePage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [FlowValidatePage] FlowValidatePage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of FlowValidateInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [FlowValidateInstance] FlowValidateInstance
+          def get_instance(payload)
+            FlowValidateInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Studio.V2.FlowValidatePage>'
+          end
+        end
+
+        class FlowValidateInstance < InstanceResource
+          ##
+          # Initialize the FlowValidateInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [FlowValidateInstance] FlowValidateInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {'valid' => payload['valid'], }
+          end
+
+          ##
+          # @return [Boolean] Boolean if the flow definition is valid
+          def valid
+            @properties['valid']
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            "<Twilio.Studio.V2.FlowValidateInstance>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            "<Twilio.Studio.V2.FlowValidateInstance>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,88 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Supersim < Domain
+      ##
+      # Initialize the Supersim Domain
+      def initialize(twilio)
+        super
+
+        @base_url = 'https://supersim.twilio.com'
+        @host = 'supersim.twilio.com'
+        @port = 443
+
+        # Versions
+        @v1 = nil
+      end
+
+      ##
+      # Version v1 of supersim
+      def v1
+        @v1 ||= V1.new self
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify the Command
+      #   resource.
+      # @return [Twilio::REST::Supersim::V1::CommandInstance] if sid was passed.
+      # @return [Twilio::REST::Supersim::V1::CommandList]
+      def commands(sid=:unset)
+        self.v1.commands(sid)
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify the Fleet
+      #   resource.
+      # @return [Twilio::REST::Supersim::V1::FleetInstance] if sid was passed.
+      # @return [Twilio::REST::Supersim::V1::FleetList]
+      def fleets(sid=:unset)
+        self.v1.fleets(sid)
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify the Network
+      #   resource.
+      # @return [Twilio::REST::Supersim::V1::NetworkInstance] if sid was passed.
+      # @return [Twilio::REST::Supersim::V1::NetworkList]
+      def networks(sid=:unset)
+        self.v1.networks(sid)
+      end
+
+      ##
+      # @param [String] sid The unique string that identifies the Network Access Profile
+      #   resource.
+      # @return [Twilio::REST::Supersim::V1::NetworkAccessProfileInstance] if sid was passed.
+      # @return [Twilio::REST::Supersim::V1::NetworkAccessProfileList]
+      def network_access_profiles(sid=:unset)
+        self.v1.network_access_profiles(sid)
+      end
+
+      ##
+      # @param [String] sid The unique string that identifies the Sim resource.
+      # @return [Twilio::REST::Supersim::V1::SimInstance] if sid was passed.
+      # @return [Twilio::REST::Supersim::V1::SimList]
+      def sims(sid=:unset)
+        self.v1.sims(sid)
+      end
+
+      ##
+      # @return [Twilio::REST::Supersim::V1::UsageRecordInstance]
+      def usage_records
+        self.v1.usage_records()
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '#<Twilio::REST::Supersim>'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,110 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Supersim
+      class V1 < Version
+        ##
+        # Initialize the V1 version of Supersim
+        def initialize(domain)
+          super
+          @version = 'v1'
+          @commands = nil
+          @fleets = nil
+          @networks = nil
+          @network_access_profiles = nil
+          @sims = nil
+          @usage_records = nil
+        end
+
+        ##
+        # @param [String] sid The SID of the Command resource to fetch.
+        # @return [Twilio::REST::Supersim::V1::CommandContext] if sid was passed.
+        # @return [Twilio::REST::Supersim::V1::CommandList]
+        def commands(sid=:unset)
+          if sid.nil?
+            raise ArgumentError, 'sid cannot be nil'
+          elsif sid == :unset
+            @commands ||= CommandList.new self
+          else
+            CommandContext.new(self, sid)
+          end
+        end
+
+        ##
+        # @param [String] sid The SID of the Fleet resource to fetch.
+        # @return [Twilio::REST::Supersim::V1::FleetContext] if sid was passed.
+        # @return [Twilio::REST::Supersim::V1::FleetList]
+        def fleets(sid=:unset)
+          if sid.nil?
+            raise ArgumentError, 'sid cannot be nil'
+          elsif sid == :unset
+            @fleets ||= FleetList.new self
+          else
+            FleetContext.new(self, sid)
+          end
+        end
+
+        ##
+        # @param [String] sid The SID of the Network resource to fetch.
+        # @return [Twilio::REST::Supersim::V1::NetworkContext] if sid was passed.
+        # @return [Twilio::REST::Supersim::V1::NetworkList]
+        def networks(sid=:unset)
+          if sid.nil?
+            raise ArgumentError, 'sid cannot be nil'
+          elsif sid == :unset
+            @networks ||= NetworkList.new self
+          else
+            NetworkContext.new(self, sid)
+          end
+        end
+
+        ##
+        # @param [String] sid The SID of the Network Access Profile resource to fetch.
+        # @return [Twilio::REST::Supersim::V1::NetworkAccessProfileContext] if sid was passed.
+        # @return [Twilio::REST::Supersim::V1::NetworkAccessProfileList]
+        def network_access_profiles(sid=:unset)
+          if sid.nil?
+            raise ArgumentError, 'sid cannot be nil'
+          elsif sid == :unset
+            @network_access_profiles ||= NetworkAccessProfileList.new self
+          else
+            NetworkAccessProfileContext.new(self, sid)
+          end
+        end
+
+        ##
+        # @param [String] sid The SID of the Sim resource to fetch.
+        # @return [Twilio::REST::Supersim::V1::SimContext] if sid was passed.
+        # @return [Twilio::REST::Supersim::V1::SimList]
+        def sims(sid=:unset)
+          if sid.nil?
+            raise ArgumentError, 'sid cannot be nil'
+          elsif sid == :unset
+            @sims ||= SimList.new self
+          else
+            SimContext.new(self, sid)
+          end
+        end
+
+        ##
+        # @return [Twilio::REST::Supersim::V1::UsageRecordContext]
+        def usage_records
+          @usage_records ||= UsageRecordList.new self
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::Supersim::V1>'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,368 @@
+##
+# 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 CommandList < ListResource
+          ##
+          # Initialize the CommandList
+          # @param [Version] version Version that contains the resource
+          # @return [CommandList] CommandList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Commands"
+          end
+
+          ##
+          # Create the CommandInstance
+          # @param [String] sim The `sid` or `unique_name` of the
+          #   {SIM}[https://www.twilio.com/docs/wireless/api/sim-resource] to send the Command
+          #   to.
+          # @param [String] command The message body of the command.
+          # @param [String] callback_method The HTTP method we should use to call
+          #   `callback_url`. Can be: `GET` or `POST` and the default is POST.
+          # @param [String] callback_url The URL we should call using the `callback_method`
+          #   after we have sent the command.
+          # @return [CommandInstance] Created CommandInstance
+          def create(sim: nil, command: nil, callback_method: :unset, callback_url: :unset)
+            data = Twilio::Values.of({
+                'Sim' => sim,
+                'Command' => command,
+                'CallbackMethod' => callback_method,
+                'CallbackUrl' => callback_url,
+            })
+
+            payload = @version.create('POST', @uri, data: data)
+
+            CommandInstance.new(@version, payload, )
+          end
+
+          ##
+          # Lists CommandInstance 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 The SID or unique name of the Sim that Command was sent to
+          #   or from.
+          # @param [command.Status] status The status of the Command. Can be: `queued`,
+          #   `sent`, `delivered`, `received` or `failed`. See the {Command Status
+          #   Values}[https://www.twilio.com/docs/wireless/api/command-resource#status-values]
+          #   for a description of each.
+          # @param [command.Direction] direction The direction of the Command. Can be
+          #   `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term
+          #   `mobile terminated`, and `from_sim` is synonymous with the term `mobile
+          #   originated`.
+          # @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, direction: :unset, limit: nil, page_size: nil)
+            self.stream(
+                sim: sim,
+                status: status,
+                direction: direction,
+                limit: limit,
+                page_size: page_size
+            ).entries
+          end
+
+          ##
+          # Streams CommandInstance records from the API as an Enumerable.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @param [String] sim The SID or unique name of the Sim that Command was sent to
+          #   or from.
+          # @param [command.Status] status The status of the Command. Can be: `queued`,
+          #   `sent`, `delivered`, `received` or `failed`. See the {Command Status
+          #   Values}[https://www.twilio.com/docs/wireless/api/command-resource#status-values]
+          #   for a description of each.
+          # @param [command.Direction] direction The direction of the Command. Can be
+          #   `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term
+          #   `mobile terminated`, and `from_sim` is synonymous with the term `mobile
+          #   originated`.
+          # @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, direction: :unset, limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+
+            page = self.page(sim: sim, status: status, direction: direction, page_size: limits[:page_size], )
+
+            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+          end
+
+          ##
+          # When passed a block, yields CommandInstance 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 CommandInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] sim The SID or unique name of the Sim that Command was sent to
+          #   or from.
+          # @param [command.Status] status The status of the Command. Can be: `queued`,
+          #   `sent`, `delivered`, `received` or `failed`. See the {Command Status
+          #   Values}[https://www.twilio.com/docs/wireless/api/command-resource#status-values]
+          #   for a description of each.
+          # @param [command.Direction] direction The direction of the Command. Can be
+          #   `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term
+          #   `mobile terminated`, and `from_sim` is synonymous with the term `mobile
+          #   originated`.
+          # @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 CommandInstance
+          def page(sim: :unset, status: :unset, direction: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+            params = Twilio::Values.of({
+                'Sim' => sim,
+                'Status' => status,
+                'Direction' => direction,
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            })
+
+            response = @version.page('GET', @uri, params: params)
+
+            CommandPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of CommandInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of CommandInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            CommandPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Supersim.V1.CommandList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class CommandPage < Page
+          ##
+          # Initialize the CommandPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [CommandPage] CommandPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of CommandInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [CommandInstance] CommandInstance
+          def get_instance(payload)
+            CommandInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Supersim.V1.CommandPage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class CommandContext < InstanceContext
+          ##
+          # Initialize the CommandContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid The SID of the Command resource to fetch.
+          # @return [CommandContext] CommandContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {sid: sid, }
+            @uri = "/Commands/#{@solution[:sid]}"
+          end
+
+          ##
+          # Fetch the CommandInstance
+          # @return [CommandInstance] Fetched CommandInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            CommandInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Supersim.V1.CommandContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Supersim.V1.CommandContext #{context}>"
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class CommandInstance < InstanceResource
+          ##
+          # Initialize the CommandInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid The SID of the Command resource to fetch.
+          # @return [CommandInstance] CommandInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'account_sid' => payload['account_sid'],
+                'sim_sid' => payload['sim_sid'],
+                'command' => payload['command'],
+                'status' => payload['status'],
+                'direction' => payload['direction'],
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'sid' => sid || @properties['sid'], }
+          end
+
+          ##
+          # Generate an instance context for the instance, the context is capable of
+          # performing various actions.  All instance actions are proxied to the context
+          # @return [CommandContext] CommandContext for this CommandInstance
+          def context
+            unless @instance_context
+              @instance_context = CommandContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The unique string that identifies the resource
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] The SID of the Account that created the resource
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] The SID of the SIM that this Command was sent to or from
+          def sim_sid
+            @properties['sim_sid']
+          end
+
+          ##
+          # @return [String] The message body of the command sent to or from the SIM
+          def command
+            @properties['command']
+          end
+
+          ##
+          # @return [command.Status] The status of the Command
+          def status
+            @properties['status']
+          end
+
+          ##
+          # @return [command.Direction] The direction of the Command
+          def direction
+            @properties['direction']
+          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
+
+          ##
+          # @return [String] The absolute URL of the Command resource
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the CommandInstance
+          # @return [CommandInstance] Fetched CommandInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Supersim.V1.CommandInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Supersim.V1.CommandInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end