twilio-ruby 5.12.0 → 5.12.1

data/lib/twilio-ruby/rest/preview/studio.rb

@@ -1,43 +0,0 @@
-##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
-# 
-# frozen_string_literal: true
-
-module Twilio
-  module REST
-    class Preview
-      class Studio < Version
-        ##
-        # Initialize the Studio version of Preview
-        def initialize(domain)
-          super
-          @version = 'Studio'
-          @flows = nil
-        end
-
-        ##
-        # @param [String] sid The sid
-        # @return [Twilio::REST::Preview::Studio::FlowContext] if sid was passed.
-        # @return [Twilio::REST::Preview::Studio::FlowList]
-        def flows(sid=:unset)
-          if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @flows ||= FlowList.new self
-          else
-            FlowContext.new(self, sid)
-          end
-        end
-
-        ##
-        # Provide a user friendly representation
-        def to_s
-          '<Twilio::REST::Preview::Studio>'
-        end
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/preview/studio/flow.rb

@@ -1,355 +0,0 @@
-##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
-# 
-# frozen_string_literal: true
-
-module Twilio
-  module REST
-    class Preview < Domain
-      class Studio < Version
-        ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-        class FlowList < ListResource
-          ##
-          # Initialize the FlowList
-          # @param [Version] version Version that contains the resource
-          # @return [FlowList] FlowList
-          def initialize(version)
-            super(version)
-
-            # Path Solution
-            @solution = {}
-            @uri = "/Flows"
-          end
-
-          ##
-          # Lists FlowInstance 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 FlowInstance 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 FlowInstance 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 FlowInstance 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 FlowInstance
-          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
-            )
-            FlowPage.new(@version, response, @solution)
-          end
-
-          ##
-          # Retrieve a single page of FlowInstance records from the API.
-          # Request is executed immediately.
-          # @param [String] target_url API-generated URL for the requested results page
-          # @return [Page] Page of FlowInstance
-          def get_page(target_url)
-            response = @version.domain.request(
-                'GET',
-                target_url
-            )
-            FlowPage.new(@version, response, @solution)
-          end
-
-          ##
-          # Provide a user friendly representation
-          def to_s
-            '#<Twilio.Preview.Studio.FlowList>'
-          end
-        end
-
-        ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-        class FlowPage < Page
-          ##
-          # Initialize the FlowPage
-          # @param [Version] version Version that contains the resource
-          # @param [Response] response Response from the API
-          # @param [Hash] solution Path solution for the resource
-          # @return [FlowPage] FlowPage
-          def initialize(version, response, solution)
-            super(version, response)
-
-            # Path Solution
-            @solution = solution
-          end
-
-          ##
-          # Build an instance of FlowInstance
-          # @param [Hash] payload Payload response from the API
-          # @return [FlowInstance] FlowInstance
-          def get_instance(payload)
-            FlowInstance.new(@version, payload, )
-          end
-
-          ##
-          # Provide a user friendly representation
-          def to_s
-            '<Twilio.Preview.Studio.FlowPage>'
-          end
-        end
-
-        ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-        class FlowContext < InstanceContext
-          ##
-          # Initialize the FlowContext
-          # @param [Version] version Version that contains the resource
-          # @param [String] sid The sid
-          # @return [FlowContext] FlowContext
-          def initialize(version, sid)
-            super(version)
-
-            # Path Solution
-            @solution = {sid: sid, }
-            @uri = "/Flows/#{@solution[:sid]}"
-
-            # Dependents
-            @engagements = nil
-          end
-
-          ##
-          # Fetch a FlowInstance
-          # @return [FlowInstance] Fetched FlowInstance
-          def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
-
-            FlowInstance.new(@version, payload, sid: @solution[:sid], )
-          end
-
-          ##
-          # Deletes the FlowInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
-          def delete
-            @version.delete('delete', @uri)
-          end
-
-          ##
-          # Access the engagements
-          # @return [EngagementList]
-          # @return [EngagementContext] if sid was passed.
-          def engagements(sid=:unset)
-            raise ArgumentError, 'sid cannot be nil' if sid.nil?
-
-            if sid != :unset
-              return EngagementContext.new(@version, @solution[:sid], sid, )
-            end
-
-            unless @engagements
-              @engagements = EngagementList.new(@version, flow_sid: @solution[:sid], )
-            end
-
-            @engagements
-          end
-
-          ##
-          # Provide a user friendly representation
-          def to_s
-            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-            "#<Twilio.Preview.Studio.FlowContext #{context}>"
-          end
-        end
-
-        ##
-        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-        class FlowInstance < InstanceResource
-          ##
-          # Initialize the FlowInstance
-          # @param [Version] version Version that contains the resource
-          # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid The sid
-          # @return [FlowInstance] FlowInstance
-          def initialize(version, payload, sid: nil)
-            super(version)
-
-            # Marshaled Properties
-            @properties = {
-                'sid' => payload['sid'],
-                'account_sid' => payload['account_sid'],
-                'friendly_name' => payload['friendly_name'],
-                'status' => payload['status'],
-                'debug' => payload['debug'],
-                'version' => payload['version'].to_i,
-                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
-                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
-                'url' => payload['url'],
-                'links' => payload['links'],
-            }
-
-            # 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 [FlowContext] FlowContext for this FlowInstance
-          def context
-            unless @instance_context
-              @instance_context = FlowContext.new(@version, @params['sid'], )
-            end
-            @instance_context
-          end
-
-          ##
-          # @return [String] A string that uniquely identifies this Flow.
-          def sid
-            @properties['sid']
-          end
-
-          ##
-          # @return [String] Account Sid.
-          def account_sid
-            @properties['account_sid']
-          end
-
-          ##
-          # @return [String] A human readable description of this resource.
-          def friendly_name
-            @properties['friendly_name']
-          end
-
-          ##
-          # @return [flow.Status] The Status of this Flow
-          def status
-            @properties['status']
-          end
-
-          ##
-          # @return [Boolean] Toggle extra logging.
-          def debug
-            @properties['debug']
-          end
-
-          ##
-          # @return [String] The latest version number of this Flow's definition.
-          def version
-            @properties['version']
-          end
-
-          ##
-          # @return [Time] The date this Flow was created
-          def date_created
-            @properties['date_created']
-          end
-
-          ##
-          # @return [Time] The date this Flow was updated
-          def date_updated
-            @properties['date_updated']
-          end
-
-          ##
-          # @return [String] The URL of this resource.
-          def url
-            @properties['url']
-          end
-
-          ##
-          # @return [String] Nested resource URLs.
-          def links
-            @properties['links']
-          end
-
-          ##
-          # Fetch a FlowInstance
-          # @return [FlowInstance] Fetched FlowInstance
-          def fetch
-            context.fetch
-          end
-
-          ##
-          # Deletes the FlowInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
-          def delete
-            context.delete
-          end
-
-          ##
-          # Access the engagements
-          # @return [engagements] engagements
-          def engagements
-            context.engagements
-          end
-
-          ##
-          # Provide a user friendly representation
-          def to_s
-            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Preview.Studio.FlowInstance #{values}>"
-          end
-
-          ##
-          # Provide a detailed, user friendly representation
-          def inspect
-            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Preview.Studio.FlowInstance #{values}>"
-          end
-        end
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/preview/studio/flow/engagement.rb

@@ -1,372 +0,0 @@
-##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
-# 
-# frozen_string_literal: true
-
-module Twilio
-  module REST
-    class Preview < Domain
-      class Studio < Version
-        class FlowContext < InstanceContext
-          ##
-          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-          class EngagementList < ListResource
-            ##
-            # Initialize the EngagementList
-            # @param [Version] version Version that contains the resource
-            # @param [String] flow_sid The unique SID identifier of the Flow.
-            # @return [EngagementList] EngagementList
-            def initialize(version, flow_sid: nil)
-              super(version)
-
-              # Path Solution
-              @solution = {flow_sid: flow_sid}
-              @uri = "/Flows/#{@solution[:flow_sid]}/Engagements"
-            end
-
-            ##
-            # Lists EngagementInstance 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 EngagementInstance 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 EngagementInstance 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 EngagementInstance 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 EngagementInstance
-            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
-              )
-              EngagementPage.new(@version, response, @solution)
-            end
-
-            ##
-            # Retrieve a single page of EngagementInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] target_url API-generated URL for the requested results page
-            # @return [Page] Page of EngagementInstance
-            def get_page(target_url)
-              response = @version.domain.request(
-                  'GET',
-                  target_url
-              )
-              EngagementPage.new(@version, response, @solution)
-            end
-
-            ##
-            # Retrieve a single page of EngagementInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] to The to
-            # @param [String] from The from
-            # @param [String] parameters The parameters
-            # @return [EngagementInstance] Newly created EngagementInstance
-            def create(to: nil, from: nil, parameters: :unset)
-              data = Twilio::Values.of({'To' => to, 'From' => from, 'Parameters' => parameters, })
-
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
-
-              EngagementInstance.new(@version, payload, flow_sid: @solution[:flow_sid], )
-            end
-
-            ##
-            # Provide a user friendly representation
-            def to_s
-              '#<Twilio.Preview.Studio.EngagementList>'
-            end
-          end
-
-          ##
-          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-          class EngagementPage < Page
-            ##
-            # Initialize the EngagementPage
-            # @param [Version] version Version that contains the resource
-            # @param [Response] response Response from the API
-            # @param [Hash] solution Path solution for the resource
-            # @return [EngagementPage] EngagementPage
-            def initialize(version, response, solution)
-              super(version, response)
-
-              # Path Solution
-              @solution = solution
-            end
-
-            ##
-            # Build an instance of EngagementInstance
-            # @param [Hash] payload Payload response from the API
-            # @return [EngagementInstance] EngagementInstance
-            def get_instance(payload)
-              EngagementInstance.new(@version, payload, flow_sid: @solution[:flow_sid], )
-            end
-
-            ##
-            # Provide a user friendly representation
-            def to_s
-              '<Twilio.Preview.Studio.EngagementPage>'
-            end
-          end
-
-          ##
-          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-          class EngagementContext < InstanceContext
-            ##
-            # Initialize the EngagementContext
-            # @param [Version] version Version that contains the resource
-            # @param [String] flow_sid The flow_sid
-            # @param [String] sid The sid
-            # @return [EngagementContext] EngagementContext
-            def initialize(version, flow_sid, sid)
-              super(version)
-
-              # Path Solution
-              @solution = {flow_sid: flow_sid, sid: sid, }
-              @uri = "/Flows/#{@solution[:flow_sid]}/Engagements/#{@solution[:sid]}"
-
-              # Dependents
-              @steps = nil
-            end
-
-            ##
-            # Fetch a EngagementInstance
-            # @return [EngagementInstance] Fetched EngagementInstance
-            def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
-
-              EngagementInstance.new(@version, payload, flow_sid: @solution[:flow_sid], sid: @solution[:sid], )
-            end
-
-            ##
-            # Access the steps
-            # @return [StepList]
-            # @return [StepContext] if sid was passed.
-            def steps(sid=:unset)
-              raise ArgumentError, 'sid cannot be nil' if sid.nil?
-
-              if sid != :unset
-                return StepContext.new(@version, @solution[:flow_sid], @solution[:sid], sid, )
-              end
-
-              unless @steps
-                @steps = StepList.new(@version, flow_sid: @solution[:flow_sid], engagement_sid: @solution[:sid], )
-              end
-
-              @steps
-            end
-
-            ##
-            # Provide a user friendly representation
-            def to_s
-              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-              "#<Twilio.Preview.Studio.EngagementContext #{context}>"
-            end
-          end
-
-          ##
-          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-          class EngagementInstance < InstanceResource
-            ##
-            # Initialize the EngagementInstance
-            # @param [Version] version Version that contains the resource
-            # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] flow_sid The unique SID identifier of the Flow.
-            # @param [String] sid The sid
-            # @return [EngagementInstance] EngagementInstance
-            def initialize(version, payload, flow_sid: nil, sid: nil)
-              super(version)
-
-              # Marshaled Properties
-              @properties = {
-                  'sid' => payload['sid'],
-                  'account_sid' => payload['account_sid'],
-                  'flow_sid' => payload['flow_sid'],
-                  'contact_sid' => payload['contact_sid'],
-                  'contact_channel_address' => payload['contact_channel_address'],
-                  'status' => payload['status'],
-                  'context' => payload['context'],
-                  'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
-                  'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
-                  'url' => payload['url'],
-                  'links' => payload['links'],
-              }
-
-              # Context
-              @instance_context = nil
-              @params = {'flow_sid' => flow_sid, '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 [EngagementContext] EngagementContext for this EngagementInstance
-            def context
-              unless @instance_context
-                @instance_context = EngagementContext.new(@version, @params['flow_sid'], @params['sid'], )
-              end
-              @instance_context
-            end
-
-            ##
-            # @return [String] A string that uniquely identifies this Engagement.
-            def sid
-              @properties['sid']
-            end
-
-            ##
-            # @return [String] Account Sid.
-            def account_sid
-              @properties['account_sid']
-            end
-
-            ##
-            # @return [String] Flow Sid.
-            def flow_sid
-              @properties['flow_sid']
-            end
-
-            ##
-            # @return [String] Contact Sid.
-            def contact_sid
-              @properties['contact_sid']
-            end
-
-            ##
-            # @return [String] The phone number, SIP address or Client identifier that triggered this Engagement.
-            def contact_channel_address
-              @properties['contact_channel_address']
-            end
-
-            ##
-            # @return [engagement.Status] The Status of this Engagement
-            def status
-              @properties['status']
-            end
-
-            ##
-            # @return [Hash] Nested resource URLs.
-            def context
-              @properties['context']
-            end
-
-            ##
-            # @return [Time] The date this Engagement was created
-            def date_created
-              @properties['date_created']
-            end
-
-            ##
-            # @return [Time] The date this Engagement was updated
-            def date_updated
-              @properties['date_updated']
-            end
-
-            ##
-            # @return [String] The URL of this resource.
-            def url
-              @properties['url']
-            end
-
-            ##
-            # @return [String] Nested resource URLs.
-            def links
-              @properties['links']
-            end
-
-            ##
-            # Fetch a EngagementInstance
-            # @return [EngagementInstance] Fetched EngagementInstance
-            def fetch
-              context.fetch
-            end
-
-            ##
-            # Access the steps
-            # @return [steps] steps
-            def steps
-              context.steps
-            end
-
-            ##
-            # Provide a user friendly representation
-            def to_s
-              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Preview.Studio.EngagementInstance #{values}>"
-            end
-
-            ##
-            # Provide a detailed, user friendly representation
-            def inspect
-              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Preview.Studio.EngagementInstance #{values}>"
-            end
-          end
-        end
-      end
-    end
-  end
-end