twilio-ruby 5.19.0 → 5.77.0

data/lib/twilio-ruby/rest/flex_api/v1/web_channel.rb

@@ -0,0 +1,341 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class FlexApi < Domain
+      class V1 < Version
+        class WebChannelList < ListResource
+          ##
+          # Initialize the WebChannelList
+          # @param [Version] version Version that contains the resource
+          # @return [WebChannelList] WebChannelList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/WebChannels"
+          end
+
+          ##
+          # Lists WebChannelInstance 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 WebChannelInstance 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 WebChannelInstance 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 WebChannelInstance 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 WebChannelInstance
+          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)
+
+            WebChannelPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of WebChannelInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of WebChannelInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            WebChannelPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Create the WebChannelInstance
+          # @param [String] flex_flow_sid The SID of the Flex Flow.
+          # @param [String] identity The chat identity.
+          # @param [String] customer_friendly_name The chat participant's friendly name.
+          # @param [String] chat_friendly_name The chat channel's friendly name.
+          # @param [String] chat_unique_name The chat channel's unique name.
+          # @param [String] pre_engagement_data The pre-engagement data.
+          # @return [WebChannelInstance] Created WebChannelInstance
+          def create(flex_flow_sid: nil, identity: nil, customer_friendly_name: nil, chat_friendly_name: nil, chat_unique_name: :unset, pre_engagement_data: :unset)
+            data = Twilio::Values.of({
+                'FlexFlowSid' => flex_flow_sid,
+                'Identity' => identity,
+                'CustomerFriendlyName' => customer_friendly_name,
+                'ChatFriendlyName' => chat_friendly_name,
+                'ChatUniqueName' => chat_unique_name,
+                'PreEngagementData' => pre_engagement_data,
+            })
+
+            payload = @version.create('POST', @uri, data: data)
+
+            WebChannelInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.FlexApi.V1.WebChannelList>'
+          end
+        end
+
+        class WebChannelPage < Page
+          ##
+          # Initialize the WebChannelPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [WebChannelPage] WebChannelPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of WebChannelInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [WebChannelInstance] WebChannelInstance
+          def get_instance(payload)
+            WebChannelInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.FlexApi.V1.WebChannelPage>'
+          end
+        end
+
+        class WebChannelContext < InstanceContext
+          ##
+          # Initialize the WebChannelContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid The SID of the WebChannel resource to fetch.
+          # @return [WebChannelContext] WebChannelContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {sid: sid, }
+            @uri = "/WebChannels/#{@solution[:sid]}"
+          end
+
+          ##
+          # Fetch the WebChannelInstance
+          # @return [WebChannelInstance] Fetched WebChannelInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            WebChannelInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Update the WebChannelInstance
+          # @param [web_channel.ChatStatus] chat_status The chat status. Can only be
+          #   `inactive`.
+          # @param [String] post_engagement_data The post-engagement data.
+          # @return [WebChannelInstance] Updated WebChannelInstance
+          def update(chat_status: :unset, post_engagement_data: :unset)
+            data = Twilio::Values.of({
+                'ChatStatus' => chat_status,
+                'PostEngagementData' => post_engagement_data,
+            })
+
+            payload = @version.update('POST', @uri, data: data)
+
+            WebChannelInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Delete the WebChannelInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
+          def delete
+             @version.delete('DELETE', @uri)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.FlexApi.V1.WebChannelContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.FlexApi.V1.WebChannelContext #{context}>"
+          end
+        end
+
+        class WebChannelInstance < InstanceResource
+          ##
+          # Initialize the WebChannelInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid The SID of the WebChannel resource to fetch.
+          # @return [WebChannelInstance] WebChannelInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'account_sid' => payload['account_sid'],
+                'flex_flow_sid' => payload['flex_flow_sid'],
+                'sid' => payload['sid'],
+                'url' => payload['url'],
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+            }
+
+            # 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 [WebChannelContext] WebChannelContext for this WebChannelInstance
+          def context
+            unless @instance_context
+              @instance_context = WebChannelContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The SID of the Account that created the resource and owns this Workflow
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] The SID of the Flex Flow
+          def flex_flow_sid
+            @properties['flex_flow_sid']
+          end
+
+          ##
+          # @return [String] The unique string that identifies the WebChannel resource
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] The absolute URL of the WebChannel resource
+          def url
+            @properties['url']
+          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
+
+          ##
+          # Fetch the WebChannelInstance
+          # @return [WebChannelInstance] Fetched WebChannelInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Update the WebChannelInstance
+          # @param [web_channel.ChatStatus] chat_status The chat status. Can only be
+          #   `inactive`.
+          # @param [String] post_engagement_data The post-engagement data.
+          # @return [WebChannelInstance] Updated WebChannelInstance
+          def update(chat_status: :unset, post_engagement_data: :unset)
+            context.update(chat_status: chat_status, post_engagement_data: post_engagement_data, )
+          end
+
+          ##
+          # Delete the WebChannelInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
+          def delete
+            context.delete
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.FlexApi.V1.WebChannelInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.FlexApi.V1.WebChannelInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,221 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class FlexApi
+      class V1 < Version
+        ##
+        # Initialize the V1 version of FlexApi
+        def initialize(domain)
+          super
+          @version = 'v1'
+          @channel = nil
+          @configuration = nil
+          @flex_flow = nil
+          @assessments = nil
+          @insights_assessments_comment = nil
+          @insights_conversations = nil
+          @insights_questionnaires = nil
+          @insights_questionnaires_category = nil
+          @insights_questionnaires_question = nil
+          @insights_segments = nil
+          @insights_session = nil
+          @insights_settings_answer_sets = nil
+          @insights_settings_comment = nil
+          @insights_user_roles = nil
+          @interaction = nil
+          @web_channel = nil
+        end
+
+        ##
+        # @param [String] sid The SID of the Flex chat channel resource to fetch.
+        # @return [Twilio::REST::Flex_api::V1::ChannelContext] if sid was passed.
+        # @return [Twilio::REST::Flex_api::V1::ChannelList]
+        def channel(sid=:unset)
+          if sid.nil?
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @channel ||= ChannelList.new self
+          else
+              ChannelContext.new(self, sid)
+          end
+        end
+
+        ##
+        # @return [Twilio::REST::Flex_api::V1::ConfigurationContext]
+        def configuration
+          @configuration ||= ConfigurationContext.new self
+        end
+
+        ##
+        # @param [String] sid The SID of the Flex Flow resource to fetch.
+        # @return [Twilio::REST::Flex_api::V1::FlexFlowContext] if sid was passed.
+        # @return [Twilio::REST::Flex_api::V1::FlexFlowList]
+        def flex_flow(sid=:unset)
+          if sid.nil?
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @flex_flow ||= FlexFlowList.new self
+          else
+              FlexFlowContext.new(self, sid)
+          end
+        end
+
+        ##
+        # @param [String] assessment_id The id of the assessment to be modified
+        # @return [Twilio::REST::Flex_api::V1::AssessmentsContext] if assessment_id was passed.
+        # @return [Twilio::REST::Flex_api::V1::AssessmentsList]
+        def assessments(assessment_id=:unset)
+          if assessment_id.nil?
+              raise ArgumentError, 'assessment_id cannot be nil'
+          end
+          if assessment_id == :unset
+              @assessments ||= AssessmentsList.new self
+          else
+              AssessmentsContext.new(self, assessment_id)
+          end
+        end
+
+        ##
+        # @return [Twilio::REST::Flex_api::V1::InsightsAssessmentsCommentContext]
+        def insights_assessments_comment
+          @insights_assessments_comment ||= InsightsAssessmentsCommentList.new self
+        end
+
+        ##
+        # @return [Twilio::REST::Flex_api::V1::InsightsConversationsContext]
+        def insights_conversations
+          @insights_conversations ||= InsightsConversationsList.new self
+        end
+
+        ##
+        # @param [String] id The unique ID of the questionnaire
+        # @return [Twilio::REST::Flex_api::V1::InsightsQuestionnairesContext] if id was passed.
+        # @return [Twilio::REST::Flex_api::V1::InsightsQuestionnairesList]
+        def insights_questionnaires(id=:unset)
+          if id.nil?
+              raise ArgumentError, 'id cannot be nil'
+          end
+          if id == :unset
+              @insights_questionnaires ||= InsightsQuestionnairesList.new self
+          else
+              InsightsQuestionnairesContext.new(self, id)
+          end
+        end
+
+        ##
+        # @param [String] category_id The ID of the category to be update
+        # @return [Twilio::REST::Flex_api::V1::InsightsQuestionnairesCategoryContext] if category_id was passed.
+        # @return [Twilio::REST::Flex_api::V1::InsightsQuestionnairesCategoryList]
+        def insights_questionnaires_category(category_id=:unset)
+          if category_id.nil?
+              raise ArgumentError, 'category_id cannot be nil'
+          end
+          if category_id == :unset
+              @insights_questionnaires_category ||= InsightsQuestionnairesCategoryList.new self
+          else
+              InsightsQuestionnairesCategoryContext.new(self, category_id)
+          end
+        end
+
+        ##
+        # @param [String] question_id The unique ID of the question
+        # @return [Twilio::REST::Flex_api::V1::InsightsQuestionnairesQuestionContext] if question_id was passed.
+        # @return [Twilio::REST::Flex_api::V1::InsightsQuestionnairesQuestionList]
+        def insights_questionnaires_question(question_id=:unset)
+          if question_id.nil?
+              raise ArgumentError, 'question_id cannot be nil'
+          end
+          if question_id == :unset
+              @insights_questionnaires_question ||= InsightsQuestionnairesQuestionList.new self
+          else
+              InsightsQuestionnairesQuestionContext.new(self, question_id)
+          end
+        end
+
+        ##
+        # @param [String] segment_id To unique id of the segment
+        # @return [Twilio::REST::Flex_api::V1::InsightsSegmentsContext] if segment_id was passed.
+        # @return [Twilio::REST::Flex_api::V1::InsightsSegmentsList]
+        def insights_segments(segment_id=:unset)
+          if segment_id.nil?
+              raise ArgumentError, 'segment_id cannot be nil'
+          end
+          if segment_id == :unset
+              @insights_segments ||= InsightsSegmentsList.new self
+          else
+              InsightsSegmentsContext.new(self, segment_id)
+          end
+        end
+
+        ##
+        # @return [Twilio::REST::Flex_api::V1::InsightsSessionContext]
+        def insights_session
+          @insights_session ||= InsightsSessionContext.new self
+        end
+
+        ##
+        # @return [Twilio::REST::Flex_api::V1::InsightsSettingsAnswerSetsContext]
+        def insights_settings_answer_sets
+          @insights_settings_answer_sets ||= InsightsSettingsAnswerSetsList.new self
+        end
+
+        ##
+        # @return [Twilio::REST::Flex_api::V1::InsightsSettingsCommentContext]
+        def insights_settings_comment
+          @insights_settings_comment ||= InsightsSettingsCommentList.new self
+        end
+
+        ##
+        # @return [Twilio::REST::Flex_api::V1::InsightsUserRolesContext]
+        def insights_user_roles
+          @insights_user_roles ||= InsightsUserRolesContext.new self
+        end
+
+        ##
+        # @param [String] sid The SID of the Interaction resource to fetch.
+        # @return [Twilio::REST::Flex_api::V1::InteractionContext] if sid was passed.
+        # @return [Twilio::REST::Flex_api::V1::InteractionList]
+        def interaction(sid=:unset)
+          if sid.nil?
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @interaction ||= InteractionList.new self
+          else
+              InteractionContext.new(self, sid)
+          end
+        end
+
+        ##
+        # @param [String] sid The SID of the WebChannel resource to fetch.
+        # @return [Twilio::REST::Flex_api::V1::WebChannelContext] if sid was passed.
+        # @return [Twilio::REST::Flex_api::V1::WebChannelList]
+        def web_channel(sid=:unset)
+          if sid.nil?
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @web_channel ||= WebChannelList.new self
+          else
+              WebChannelContext.new(self, sid)
+          end
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::FlexApi::V1>'
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/flex_api/v2/web_channels.rb

@@ -0,0 +1,133 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class FlexApi < Domain
+      class V2 < Version
+        class WebChannelsList < ListResource
+          ##
+          # Initialize the WebChannelsList
+          # @param [Version] version Version that contains the resource
+          # @return [WebChannelsList] WebChannelsList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/WebChats"
+          end
+
+          ##
+          # Create the WebChannelsInstance
+          # @param [String] address_sid The SID of the Conversations Address. See {Address
+          #   Configuration
+          #   Resource}[https://www.twilio.com/docs/conversations/api/address-configuration-resource]
+          #   for configuration details. When a conversation is created on the Flex backend,
+          #   the callback URL will be set to the corresponding Studio Flow SID or webhook URL
+          #   in your address configuration.
+          # @param [String] chat_friendly_name The Conversation's friendly name. See the
+          #   {Conversation
+          #   resource}[https://www.twilio.com/docs/conversations/api/conversation-resource]
+          #   for an example.
+          # @param [String] customer_friendly_name The Conversation participant's friendly
+          #   name. See the {Conversation Participant
+          #   Resource}[https://www.twilio.com/docs/conversations/api/conversation-participant-resource]
+          #   for an example.
+          # @param [String] pre_engagement_data The pre-engagement data.
+          # @return [WebChannelsInstance] Created WebChannelsInstance
+          def create(address_sid: nil, chat_friendly_name: :unset, customer_friendly_name: :unset, pre_engagement_data: :unset)
+            data = Twilio::Values.of({
+                'AddressSid' => address_sid,
+                'ChatFriendlyName' => chat_friendly_name,
+                'CustomerFriendlyName' => customer_friendly_name,
+                'PreEngagementData' => pre_engagement_data,
+            })
+
+            payload = @version.create('POST', @uri, data: data)
+
+            WebChannelsInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.FlexApi.V2.WebChannelsList>'
+          end
+        end
+
+        class WebChannelsPage < Page
+          ##
+          # Initialize the WebChannelsPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [WebChannelsPage] WebChannelsPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of WebChannelsInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [WebChannelsInstance] WebChannelsInstance
+          def get_instance(payload)
+            WebChannelsInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.FlexApi.V2.WebChannelsPage>'
+          end
+        end
+
+        class WebChannelsInstance < InstanceResource
+          ##
+          # Initialize the WebChannelsInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [WebChannelsInstance] WebChannelsInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {'conversation_sid' => payload['conversation_sid'], 'identity' => payload['identity'], }
+          end
+
+          ##
+          # @return [String] The unique string representing the Conversation resource created
+          def conversation_sid
+            @properties['conversation_sid']
+          end
+
+          ##
+          # @return [String] The unique string representing the User created
+          def identity
+            @properties['identity']
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            "<Twilio.FlexApi.V2.WebChannelsInstance>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            "<Twilio.FlexApi.V2.WebChannelsInstance>"
+          end
+        end
+      end
+    end
+  end
+end