twilio-ruby 5.74.0 → 7.10.1

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

@@ -1,133 +1,266 @@
 ##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
+#    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.
 #
-# 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
+    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.
+                    # @param [String] identity The Identity of the guest user. See the [Conversation User Resource](https://www.twilio.com/docs/conversations/api/user-resource) for an example.
+                    # @param [String] ui_version The Ui-Version HTTP request header
+                    # @return [WebChannelsInstance] Created WebChannelsInstance
+                    def create(
+                        address_sid: nil, 
+                        chat_friendly_name: :unset, 
+                        customer_friendly_name: :unset, 
+                        pre_engagement_data: :unset, 
+                        identity: :unset, 
+                        ui_version: :unset
+                    )
 
-        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
+                        data = Twilio::Values.of({
+                            'AddressSid' => address_sid,
+                            'ChatFriendlyName' => chat_friendly_name,
+                            'CustomerFriendlyName' => customer_friendly_name,
+                            'PreEngagementData' => pre_engagement_data,
+                            'Identity' => identity,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Ui-Version' => ui_version, })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
+                        WebChannelsInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the WebChannelsInstanceMetadata
+                    # @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.
+                    # @param [String] identity The Identity of the guest user. See the [Conversation User Resource](https://www.twilio.com/docs/conversations/api/user-resource) for an example.
+                    # @param [String] ui_version The Ui-Version HTTP request header
+                    # @return [WebChannelsInstance] Created WebChannelsInstance
+                    def create_with_metadata(
+                      address_sid: nil, 
+                      chat_friendly_name: :unset, 
+                      customer_friendly_name: :unset, 
+                      pre_engagement_data: :unset, 
+                      identity: :unset, 
+                      ui_version: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'AddressSid' => address_sid,
+                            'ChatFriendlyName' => chat_friendly_name,
+                            'CustomerFriendlyName' => customer_friendly_name,
+                            'PreEngagementData' => pre_engagement_data,
+                            'Identity' => identity,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Ui-Version' => ui_version, })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        web_channels_instance = WebChannelsInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        WebChannelsInstanceMetadata.new(
+                            @version,
+                            web_channels_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    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 WebChannelsPageMetadata < PageMetadata
+                    attr_reader :web_channels_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @web_channels_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @web_channels_page << WebChannelsListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @web_channels_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::FlexApi::V2PageMetadata>';
+                    end
+                end
+                class WebChannelsListResponse < InstanceListResource
+
+                    # @param [Array<WebChannelsInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @web_channels = data_list.map do |data|
+                        WebChannelsInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def web_channels
+                        @web_channels
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    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
 
-        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
-end
+end

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

@@ -1,35 +1,77 @@
 ##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
+#    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.
 #
-# frozen_string_literal: true
 
 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::Flex_api::V2::WebChannelsContext]
-        def web_channels
-          @web_channels ||= WebChannelsList.new self
-        end
+    module REST
+        class FlexApi
+            class V2 < Version
+                ##
+                # Initialize the V2 version of FlexApi
+                def initialize(domain)
+                    super
+                    @version = 'v2'
+                    @flex_user = nil
+                    @web_channels = nil
+                end
 
-        ##
-        # Provide a user friendly representation
-        def to_s
-          '<Twilio::REST::FlexApi::V2>'
+                ##
+                # @param [String] instance_sid The unique ID created by Twilio to identify a Flex instance.
+                # @param [String] flex_user_sid The unique id for the flex user to be retrieved.
+                # @return [Twilio::REST::FlexApi::V2::FlexUserContext] if instanceSid was passed.
+                # @return [Twilio::REST::FlexApi::V2::FlexUserList]
+                def flex_user(instance_sid=:unset, flex_user_sid=:unset)
+                    if instance_sid.nil?
+                        raise ArgumentError, 'instance_sid cannot be nil'
+                    end
+                    if flex_user_sid.nil?
+                        raise ArgumentError, 'flex_user_sid cannot be nil'
+                    end
+                    if instance_sid == :unset && flex_user_sid == :unset
+                        @flex_user ||= FlexUserList.new self
+                    else
+                        FlexUserContext.new(self, instance_sid, flex_user_sid)
+                    end
+                end
+                ##
+                # @param [String] instance_sid The unique ID created by Twilio to identify a Flex instance.
+                # @param [String] flex_user_sid The unique id for the flex user to be retrieved.
+                # @return [Twilio::REST::FlexApi::V2::FlexUserContext] if flexUserSid was passed.
+                # @return [Twilio::REST::FlexApi::V2::FlexUserList]
+                def flex_user(instance_sid=:unset, flex_user_sid=:unset)
+                    if instance_sid.nil?
+                        raise ArgumentError, 'instance_sid cannot be nil'
+                    end
+                    if flex_user_sid.nil?
+                        raise ArgumentError, 'flex_user_sid cannot be nil'
+                    end
+                    if instance_sid == :unset && flex_user_sid == :unset
+                        @flex_user ||= FlexUserList.new self
+                    else
+                        FlexUserContext.new(self, instance_sid, flex_user_sid)
+                    end
+                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
-  end
-end
+end

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

@@ -1,43 +1,10 @@
-##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
-#
-# frozen_string_literal: true
-
 module Twilio
   module REST
-    class FlexApi < Domain
-      ##
-      # Initialize the FlexApi Domain
-      def initialize(twilio)
-        super
-
-        @base_url = 'https://flex-api.twilio.com'
-        @host = 'flex-api.twilio.com'
-        @port = 443
-
-        # Versions
-        @v1 = nil
-        @v2 = nil
-      end
-
-      ##
-      # Version v1 of flex_api
-      def v1
-        @v1 ||= V1.new self
-      end
-
-      ##
-      # Version v2 of flex_api
-      def v2
-        @v2 ||= V2.new self
-      end
-
+    class FlexApi < FlexApiBase
       ##
       # @return [Twilio::REST::Flex_api::V1::AssessmentsInstance]
       def assessments
+        warn "assessments is deprecated. Use v1.assessments instead."
         self.v1.assessments()
       end
 
@@ -47,12 +14,14 @@ module Twilio
       # @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
 
@@ -62,12 +31,14 @@ module Twilio
       # @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
 
@@ -77,12 +48,14 @@ module Twilio
       # @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
 
@@ -92,20 +65,9 @@ module Twilio
       # @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
-
-      ##
-      # @return [Twilio::REST::Flex_api::V2::WebChannelsInstance]
-      def web_channels
-        self.v2.web_channels()
-      end
-
-      ##
-      # Provide a user friendly representation
-      def to_s
-        '#<Twilio::REST::FlexApi>'
-      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