twilio-ruby 5.74.4 → 7.7.1

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

@@ -0,0 +1,339 @@
+##
+#    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 FlexUserList < ListResource
+                
+                    ##
+                    # Initialize the FlexUserList
+                    # @param [Version] version Version that contains the resource
+                    # @return [FlexUserList] FlexUserList
+                    def initialize(version)
+                        super(version)
+                        # Path Solution
+                        @solution = {  }
+                        
+                        
+                    end
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.FlexApi.V2.FlexUserList>'
+                    end
+                end
+
+
+                class FlexUserContext < InstanceContext
+                    ##
+                    # Initialize the FlexUserContext
+                    # @param [Version] version Version that contains the resource
+                    # @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.
+                    # @return [FlexUserContext] FlexUserContext
+                    def initialize(version, instance_sid, flex_user_sid)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { instance_sid: instance_sid, flex_user_sid: flex_user_sid,  }
+                        @uri = "/Instances/#{@solution[:instance_sid]}/Users/#{@solution[:flex_user_sid]}"
+
+                        
+                    end
+                    ##
+                    # Fetch the FlexUserInstance
+                    # @return [FlexUserInstance] Fetched FlexUserInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        FlexUserInstance.new(
+                            @version,
+                            payload,
+                            instance_sid: @solution[:instance_sid],
+                            flex_user_sid: @solution[:flex_user_sid],
+                        )
+                    end
+
+                    ##
+                    # Update the FlexUserInstance
+                    # @param [String] email Email of the User.
+                    # @param [String] user_sid The unique SID identifier of the Twilio Unified User.
+                    # @param [String] locale The locale preference of the user.
+                    # @return [FlexUserInstance] Updated FlexUserInstance
+                    def update(
+                        email: :unset, 
+                        user_sid: :unset, 
+                        locale: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Email' => email,
+                            'UserSid' => user_sid,
+                            'Locale' => locale,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.update('POST', @uri, data: data, headers: headers)
+                        FlexUserInstance.new(
+                            @version,
+                            payload,
+                            instance_sid: @solution[:instance_sid],
+                            flex_user_sid: @solution[:flex_user_sid],
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.FlexApi.V2.FlexUserContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.FlexApi.V2.FlexUserContext #{context}>"
+                    end
+                end
+
+                class FlexUserPage < Page
+                    ##
+                    # Initialize the FlexUserPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [FlexUserPage] FlexUserPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of FlexUserInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [FlexUserInstance] FlexUserInstance
+                    def get_instance(payload)
+                        FlexUserInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.FlexApi.V2.FlexUserPage>'
+                    end
+                end
+                class FlexUserInstance < InstanceResource
+                    ##
+                    # Initialize the FlexUserInstance
+                    # @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 FlexUser
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [FlexUserInstance] FlexUserInstance
+                    def initialize(version, payload , instance_sid: nil, flex_user_sid: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'account_sid' => payload['account_sid'],
+                            'instance_sid' => payload['instance_sid'],
+                            'user_sid' => payload['user_sid'],
+                            'flex_user_sid' => payload['flex_user_sid'],
+                            'worker_sid' => payload['worker_sid'],
+                            'workspace_sid' => payload['workspace_sid'],
+                            'flex_team_sid' => payload['flex_team_sid'],
+                            'username' => payload['username'],
+                            'email' => payload['email'],
+                            'locale' => payload['locale'],
+                            'roles' => payload['roles'],
+                            'created_date' => Twilio.deserialize_iso8601_datetime(payload['created_date']),
+                            'updated_date' => Twilio.deserialize_iso8601_datetime(payload['updated_date']),
+                            'version' => payload['version'] == nil ? payload['version'] : payload['version'].to_i,
+                            'url' => payload['url'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'instance_sid' => instance_sid  || @properties['instance_sid']  ,'flex_user_sid' => flex_user_sid  || @properties['flex_user_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 [FlexUserContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = FlexUserContext.new(@version , @params['instance_sid'], @params['flex_user_sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The unique SID of the account that created the resource.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The unique ID created by Twilio to identify a Flex instance.
+                    def instance_sid
+                        @properties['instance_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The unique SID identifier of the Twilio Unified User.
+                    def user_sid
+                        @properties['user_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The unique SID identifier of the Flex User.
+                    def flex_user_sid
+                        @properties['flex_user_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The unique SID identifier of the worker.
+                    def worker_sid
+                        @properties['worker_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The unique SID identifier of the workspace.
+                    def workspace_sid
+                        @properties['workspace_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The unique SID identifier of the Flex Team.
+                    def flex_team_sid
+                        @properties['flex_team_sid']
+                    end
+                    
+                    ##
+                    # @return [String] Username of the User.
+                    def username
+                        @properties['username']
+                    end
+                    
+                    ##
+                    # @return [String] Email of the User.
+                    def email
+                        @properties['email']
+                    end
+                    
+                    ##
+                    # @return [String] The locale preference of the user.
+                    def locale
+                        @properties['locale']
+                    end
+                    
+                    ##
+                    # @return [Array<String>] The roles of the user.
+                    def roles
+                        @properties['roles']
+                    end
+                    
+                    ##
+                    # @return [Time] The date that this user was created, given in ISO 8601 format.
+                    def created_date
+                        @properties['created_date']
+                    end
+                    
+                    ##
+                    # @return [Time] The date that this user was updated, given in ISO 8601 format.
+                    def updated_date
+                        @properties['updated_date']
+                    end
+                    
+                    ##
+                    # @return [String] The current version of the user.
+                    def version
+                        @properties['version']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Fetch the FlexUserInstance
+                    # @return [FlexUserInstance] Fetched FlexUserInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Update the FlexUserInstance
+                    # @param [String] email Email of the User.
+                    # @param [String] user_sid The unique SID identifier of the Twilio Unified User.
+                    # @param [String] locale The locale preference of the user.
+                    # @return [FlexUserInstance] Updated FlexUserInstance
+                    def update(
+                        email: :unset, 
+                        user_sid: :unset, 
+                        locale: :unset
+                    )
+
+                        context.update(
+                            email: email, 
+                            user_sid: user_sid, 
+                            locale: locale, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.FlexApi.V2.FlexUserInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.FlexApi.V2.FlexUserInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end

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

@@ -1,133 +1,158 @@
 ##
-# 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
-
-        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
+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.
+                    # @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
+                    )
+
+                        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
+
+                
+
+
+                    # 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
-  end
-end
+end