twilio-ruby 4.6.1 → 6.9.0

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

@@ -0,0 +1,208 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Flex
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+module Twilio
+    module REST
+        class FlexApi
+            class V1 < Version
+                ##
+                # Initialize the V1 version of FlexApi
+                def initialize(domain)
+                    super
+                    @version = 'v1'
+                    @assessments = nil
+                    @channel = nil
+                    @configuration = nil
+                    @flex_flow = 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
+                    @provisioning_status = nil
+                    @web_channel = nil
+                end
+
+                ##
+                # @param [String] assessment_sid The SID of the assessment to be modified
+                # @return [Twilio::REST::FlexApi::V1::AssessmentsContext] if assessmentSid was passed.
+                # @return [Twilio::REST::FlexApi::V1::AssessmentsList]
+                def assessments(assessment_sid=:unset)
+                    if assessment_sid.nil?
+                        raise ArgumentError, 'assessment_sid cannot be nil'
+                    end
+                    if assessment_sid == :unset
+                        @assessments ||= AssessmentsList.new self
+                    else
+                        AssessmentsContext.new(self, assessment_sid)
+                    end
+                end
+                ##
+                # @param [String] sid The SID of the Flex chat channel resource to fetch.
+                # @return [Twilio::REST::FlexApi::V1::ChannelContext] if sid was passed.
+                # @return [Twilio::REST::FlexApi::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::FlexApi::V1::configurationContext]
+                def configuration
+                    @configuration ||= ConfigurationContext.new self
+                end
+                ##
+                # @param [String] sid The SID of the Flex Flow resource to fetch.
+                # @return [Twilio::REST::FlexApi::V1::FlexFlowContext] if sid was passed.
+                # @return [Twilio::REST::FlexApi::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
+                ##
+                # @return [Twilio::REST::FlexApi::V1::InsightsAssessmentsCommentList]
+                def insights_assessments_comment
+                    @insights_assessments_comment ||= InsightsAssessmentsCommentList.new self
+                end
+                ##
+                # @return [Twilio::REST::FlexApi::V1::InsightsConversationsList]
+                def insights_conversations
+                    @insights_conversations ||= InsightsConversationsList.new self
+                end
+                ##
+                # @param [String] questionnaire_sid The SID of the questionnaire
+                # @return [Twilio::REST::FlexApi::V1::InsightsQuestionnairesContext] if questionnaireSid was passed.
+                # @return [Twilio::REST::FlexApi::V1::InsightsQuestionnairesList]
+                def insights_questionnaires(questionnaire_sid=:unset)
+                    if questionnaire_sid.nil?
+                        raise ArgumentError, 'questionnaire_sid cannot be nil'
+                    end
+                    if questionnaire_sid == :unset
+                        @insights_questionnaires ||= InsightsQuestionnairesList.new self
+                    else
+                        InsightsQuestionnairesContext.new(self, questionnaire_sid)
+                    end
+                end
+                ##
+                # @param [String] category_sid The SID of the category to be updated
+                # @return [Twilio::REST::FlexApi::V1::InsightsQuestionnairesCategoryContext] if categorySid was passed.
+                # @return [Twilio::REST::FlexApi::V1::InsightsQuestionnairesCategoryList]
+                def insights_questionnaires_category(category_sid=:unset)
+                    if category_sid.nil?
+                        raise ArgumentError, 'category_sid cannot be nil'
+                    end
+                    if category_sid == :unset
+                        @insights_questionnaires_category ||= InsightsQuestionnairesCategoryList.new self
+                    else
+                        InsightsQuestionnairesCategoryContext.new(self, category_sid)
+                    end
+                end
+                ##
+                # @param [String] question_sid The SID of the question
+                # @return [Twilio::REST::FlexApi::V1::InsightsQuestionnairesQuestionContext] if questionSid was passed.
+                # @return [Twilio::REST::FlexApi::V1::InsightsQuestionnairesQuestionList]
+                def insights_questionnaires_question(question_sid=:unset)
+                    if question_sid.nil?
+                        raise ArgumentError, 'question_sid cannot be nil'
+                    end
+                    if question_sid == :unset
+                        @insights_questionnaires_question ||= InsightsQuestionnairesQuestionList.new self
+                    else
+                        InsightsQuestionnairesQuestionContext.new(self, question_sid)
+                    end
+                end
+                ##
+                # @return [Twilio::REST::FlexApi::V1::InsightsSegmentsList]
+                def insights_segments
+                    @insights_segments ||= InsightsSegmentsList.new self
+                end
+                ##
+                # @return [Twilio::REST::FlexApi::V1::insightsSessionContext]
+                def insights_session
+                    @insights_session ||= InsightsSessionContext.new self
+                end
+                ##
+                # @return [Twilio::REST::FlexApi::V1::InsightsSettingsAnswerSetsList]
+                def insights_settings_answer_sets
+                    @insights_settings_answer_sets ||= InsightsSettingsAnswerSetsList.new self
+                end
+                ##
+                # @return [Twilio::REST::FlexApi::V1::InsightsSettingsCommentList]
+                def insights_settings_comment
+                    @insights_settings_comment ||= InsightsSettingsCommentList.new self
+                end
+                ##
+                # @return [Twilio::REST::FlexApi::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::FlexApi::V1::InteractionContext] if sid was passed.
+                # @return [Twilio::REST::FlexApi::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
+                ##
+                # @return [Twilio::REST::FlexApi::V1::provisioningStatusContext]
+                def provisioning_status
+                    @provisioning_status ||= ProvisioningStatusContext.new self
+                end
+                ##
+                # @param [String] sid The SID of the WebChannel resource to fetch.
+                # @return [Twilio::REST::FlexApi::V1::WebChannelContext] if sid was passed.
+                # @return [Twilio::REST::FlexApi::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,146 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Flex
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class FlexApi < FlexApiBase
+            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
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this WebChannels
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @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](https://www.twilio.com/docs/conversations/api/conversation-resource) created.
+                    def conversation_sid
+                        @properties['conversation_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The unique string representing the User created and should be authorized to participate in the Conversation. For more details, see [User Identity & Access Tokens](https://www.twilio.com/docs/conversations/identity).
+                    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

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

@@ -0,0 +1,40 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Flex
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+module Twilio
+    module REST
+        class FlexApi
+            class V2 < Version
+                ##
+                # Initialize the V2 version of FlexApi
+                def initialize(domain)
+                    super
+                    @version = 'v2'
+                    @web_channels = nil
+                end
+
+                ##
+                # @return [Twilio::REST::FlexApi::V2::WebChannelsList]
+                def web_channels
+                    @web_channels ||= WebChannelsList.new self
+                end
+                ##
+                # Provide a user friendly representation
+                def to_s
+                    '<Twilio::REST::FlexApi::V2>';
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,73 @@
+module Twilio
+  module REST
+    class FlexApi < FlexApiBase
+      ##
+      # @return [Twilio::REST::Flex_api::V1::AssessmentsInstance]
+      def assessments
+        warn "assessments is deprecated. Use v1.assessments instead."
+        self.v1.assessments()
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify the Channel
+      #   resource.
+      # @return [Twilio::REST::Flex_api::V1::ChannelInstance] if sid was passed.
+      # @return [Twilio::REST::Flex_api::V1::ChannelList]
+      def channel(sid=:unset)
+        warn "channel is deprecated. Use v1.channel instead."
+        self.v1.channel(sid)
+      end
+
+      ##
+      # @return [Twilio::REST::Flex_api::V1::ConfigurationInstance]
+      def configuration
+        warn "configuration is deprecated. Use v1.configuration instead."
+        self.v1.configuration()
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify the Flex Flow
+      #   resource.
+      # @return [Twilio::REST::Flex_api::V1::FlexFlowInstance] if sid was passed.
+      # @return [Twilio::REST::Flex_api::V1::FlexFlowList]
+      def flex_flow(sid=:unset)
+        warn "flex_flow is deprecated. Use v1.flex_flow instead."
+        self.v1.flex_flow(sid)
+      end
+
+      ##
+      # @return [Twilio::REST::Flex_api::V1::GoodDataInstance]
+      def good_data
+        warn "good_data is deprecated. Use v1.good_data instead."
+        self.v1.good_data()
+      end
+
+      ##
+      # @param [String] sid The unique string created by Twilio to identify an
+      #   Interaction resource, prefixed with KD.
+      # @return [Twilio::REST::Flex_api::V1::InteractionInstance] if sid was passed.
+      # @return [Twilio::REST::Flex_api::V1::InteractionList]
+      def interaction(sid=:unset)
+        warn "interaction is deprecated. Use v1.interaction instead."
+        self.v1.interaction(sid)
+      end
+
+      ##
+      # @return [Twilio::REST::Flex_api::V1::UserRolesInstance]
+      def user_roles
+        warn "user_roles is deprecated. Use v1.user_roles instead."
+        self.v1.user_roles()
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify the WebChannel
+      #   resource.
+      # @return [Twilio::REST::Flex_api::V1::WebChannelInstance] if sid was passed.
+      # @return [Twilio::REST::Flex_api::V1::WebChannelList]
+      def web_channel(sid=:unset)
+        warn "web_channel is deprecated. Use v1.web_channel instead."
+        self.v1.web_channel(sid)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+##
+ # This code was generated by
+ # ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ #  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ #  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ #
+ # NOTE: This class is auto generated by OpenAPI Generator.
+ # https://openapi-generator.tech
+ # Do not edit the class manually.
+# frozen_string_literal: true
+module Twilio
+  module REST
+    class FlexApiBase < Domain
+      ##
+      # Initialize flexApi domain
+      #
+      # @param twilio - The twilio client
+      #
+      def initialize(twilio)
+        super(twilio)
+        @base_url =  "https://flex-api.twilio.com"
+        @host = "flex-api.twilio.com"
+        @port = 443
+        @v1 = nil
+        @v2 = nil
+      end
+
+      def v1
+        @v1 ||= FlexApi::V1.new self
+      end
+
+      def v2
+        @v2 ||= FlexApi::V2.new self
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '<Twilio::REST::FlexApi>';
+      end
+    end
+  end
+end