twilio-ruby 6.8.0 → 7.10.7

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

@@ -18,12 +18,14 @@ module Twilio
         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"
@@ -35,12 +37,16 @@ module Twilio
                     # @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
+                      address_sid: nil, 
+                      chat_friendly_name: :unset, 
+                      customer_friendly_name: :unset, 
+                      pre_engagement_data: :unset, 
+                      identity: :unset, 
+                      ui_version: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -48,15 +54,67 @@ module Twilio
                             'ChatFriendlyName' => chat_friendly_name,
                             'CustomerFriendlyName' => customer_friendly_name,
                             'PreEngagementData' => pre_engagement_data,
+                            'Identity' => identity,
                         })
 
-                        payload = @version.create('POST', @uri, data: data)
+                        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
+
                 
 
 
@@ -75,6 +133,7 @@ module Twilio
                     # @return [WebChannelsPage] WebChannelsPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -94,6 +153,66 @@ module Twilio
                         '<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
@@ -107,6 +226,7 @@ module Twilio
                     def initialize(version, payload )
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'conversation_sid' => payload['conversation_sid'],

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

@@ -21,9 +21,52 @@ module Twilio
                 def initialize(domain)
                     super
                     @version = 'v2'
+                    @flex_user = nil
                     @web_channels = nil
                 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 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
+                    elsif instance_sid != :unset && flex_user_sid == :unset
+                        FlexUserList.new(self, instance_sid: instance_sid)
+                    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
+                    elsif instance_sid != :unset && flex_user_sid == :unset
+                        FlexUserList.new(self, instance_sid: instance_sid)
+                    else
+                        FlexUserContext.new(self, instance_sid, flex_user_sid)
+                    end
+                end
                 ##
                 # @return [Twilio::REST::FlexApi::V2::WebChannelsList]
                 def web_channels

data/lib/twilio-ruby/rest/frontline_api/v1/user.rb

@@ -18,12 +18,14 @@ module Twilio
         class FrontlineApi < FrontlineApiBase
             class V1 < Version
                 class UserList < ListResource
+                
                     ##
                     # Initialize the UserList
                     # @param [Version] version Version that contains the resource
                     # @return [UserList] UserList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         
@@ -39,8 +41,6 @@ module Twilio
                 end
 
 
-                ##
-                #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
                 class UserContext < InstanceContext
                     ##
                     # Initialize the UserContext
@@ -49,6 +49,7 @@ module Twilio
                     # @return [UserContext] UserContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -61,7 +62,13 @@ module Twilio
                     # @return [UserInstance] Fetched UserInstance
                     def fetch
 
-                        payload = @version.fetch('GET', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
                         UserInstance.new(
                             @version,
                             payload,
@@ -69,6 +76,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the UserInstanceMetadata
+                    # @return [UserInstance] Fetched UserInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        user_instance = UserInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        UserInstanceMetadata.new(
+                            @version,
+                            user_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the UserInstance
                     # @param [String] friendly_name The string that you assigned to describe the User.
@@ -77,10 +109,10 @@ module Twilio
                     # @param [Boolean] is_available Whether the User is available for new conversations. Set to `false` to prevent User from receiving new inbound conversations if you are using [Pool Routing](https://www.twilio.com/docs/frontline/handle-incoming-conversations#3-pool-routing).
                     # @return [UserInstance] Updated UserInstance
                     def update(
-                        friendly_name: :unset, 
-                        avatar: :unset, 
-                        state: :unset, 
-                        is_available: :unset
+                      friendly_name: :unset, 
+                      avatar: :unset, 
+                      state: :unset, 
+                      is_available: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -90,7 +122,13 @@ module Twilio
                             'IsAvailable' => is_available,
                         })
 
-                        payload = @version.update('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.update('POST', @uri, data: data, headers: headers)
                         UserInstance.new(
                             @version,
                             payload,
@@ -98,6 +136,47 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the UserInstanceMetadata
+                    # @param [String] friendly_name The string that you assigned to describe the User.
+                    # @param [String] avatar The avatar URL which will be shown in Frontline application.
+                    # @param [StateType] state 
+                    # @param [Boolean] is_available Whether the User is available for new conversations. Set to `false` to prevent User from receiving new inbound conversations if you are using [Pool Routing](https://www.twilio.com/docs/frontline/handle-incoming-conversations#3-pool-routing).
+                    # @return [UserInstance] Updated UserInstance
+                    def update_with_metadata(
+                      friendly_name: :unset, 
+                      avatar: :unset, 
+                      state: :unset, 
+                      is_available: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'Avatar' => avatar,
+                            'State' => state,
+                            'IsAvailable' => is_available,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        user_instance = UserInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        UserInstanceMetadata.new(
+                            @version,
+                            user_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -114,6 +193,53 @@ module Twilio
                     end
                 end
 
+                class UserInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new UserInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}UserInstance] user_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [UserInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, user_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @user_instance = user_instance
+                    end
+
+                    def user
+                        @user_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.UserInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class UserListResponse < InstanceListResource
+                    # @param [Array<UserInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @user_instance = payload.body[key].map do |data|
+                        UserInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def user_instance
+                          @instance
+                      end
+                  end
+
                 class UserPage < Page
                     ##
                     # Initialize the UserPage
@@ -123,6 +249,7 @@ module Twilio
                     # @return [UserPage] UserPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -142,6 +269,66 @@ module Twilio
                         '<Twilio.FrontlineApi.V1.UserPage>'
                     end
                 end
+
+                class UserPageMetadata < PageMetadata
+                    attr_reader :user_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @user_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @user_page << UserListResponse.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
+                        @user_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::FrontlineApi::V1PageMetadata>';
+                    end
+                end
+                class UserListResponse < InstanceListResource
+
+                    # @param [Array<UserInstance>] 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
+                      @user = data_list.map do |data|
+                        UserInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def user
+                        @user
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class UserInstance < InstanceResource
                     ##
                     # Initialize the UserInstance
@@ -155,6 +342,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
@@ -240,10 +428,10 @@ module Twilio
                     # @param [Boolean] is_available Whether the User is available for new conversations. Set to `false` to prevent User from receiving new inbound conversations if you are using [Pool Routing](https://www.twilio.com/docs/frontline/handle-incoming-conversations#3-pool-routing).
                     # @return [UserInstance] Updated UserInstance
                     def update(
-                        friendly_name: :unset, 
-                        avatar: :unset, 
-                        state: :unset, 
-                        is_available: :unset
+                      friendly_name: :unset, 
+                      avatar: :unset, 
+                      state: :unset, 
+                      is_available: :unset
                     )
 
                         context.update(

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

@@ -32,6 +32,7 @@ module Twilio
                     if sid.nil?
                         raise ArgumentError, 'sid cannot be nil'
                     end
+
                     if sid == :unset
                         @users ||= UserList.new self
                     else