twilio-ruby 5.10.7 → 7.6.2

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

@@ -0,0 +1,155 @@
+##
+#    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.
+                    # @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, 
+                        ui_version: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'AddressSid' => address_sid,
+                            'ChatFriendlyName' => chat_friendly_name,
+                            'CustomerFriendlyName' => customer_friendly_name,
+                            'PreEngagementData' => pre_engagement_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
+
+                
+
+
+                    # 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,77 @@
+##
+#    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'
+                    @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
+                    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

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

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

@@ -0,0 +1,286 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Frontline
+#    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 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 = {  }
+                        
+                        
+                    end
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.FrontlineApi.V1.UserList>'
+                    end
+                end
+
+
+                class UserContext < InstanceContext
+                    ##
+                    # Initialize the UserContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] sid The SID of the User resource to update. This value can be either the `sid` or the `identity` of the User resource to update.
+                    # @return [UserContext] UserContext
+                    def initialize(version, sid)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { sid: sid,  }
+                        @uri = "/Users/#{@solution[:sid]}"
+
+                        
+                    end
+                    ##
+                    # Fetch the UserInstance
+                    # @return [UserInstance] Fetched UserInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        UserInstance.new(
+                            @version,
+                            payload,
+                            sid: @solution[:sid],
+                        )
+                    end
+
+                    ##
+                    # Update the UserInstance
+                    # @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(
+                        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', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.update('POST', @uri, data: data, headers: headers)
+                        UserInstance.new(
+                            @version,
+                            payload,
+                            sid: @solution[:sid],
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.FrontlineApi.V1.UserContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.FrontlineApi.V1.UserContext #{context}>"
+                    end
+                end
+
+                class UserPage < Page
+                    ##
+                    # Initialize the UserPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [UserPage] UserPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of UserInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [UserInstance] UserInstance
+                    def get_instance(payload)
+                        UserInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.FrontlineApi.V1.UserPage>'
+                    end
+                end
+                class UserInstance < InstanceResource
+                    ##
+                    # Initialize the UserInstance
+                    # @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 User
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [UserInstance] UserInstance
+                    def initialize(version, payload , sid: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'sid' => payload['sid'],
+                            'identity' => payload['identity'],
+                            'friendly_name' => payload['friendly_name'],
+                            'avatar' => payload['avatar'],
+                            'state' => payload['state'],
+                            'is_available' => payload['is_available'],
+                            'url' => payload['url'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'sid' => sid  || @properties['sid']  , }
+                    end
+
+                    ##
+                    # Generate an instance context for the instance, the context is capable of
+                    # performing various actions.  All instance actions are proxied to the context
+                    # @return [UserContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = UserContext.new(@version , @params['sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The unique string that we created to identify the User resource.
+                    def sid
+                        @properties['sid']
+                    end
+                    
+                    ##
+                    # @return [String] The application-defined string that uniquely identifies the resource's User. This value is often a username or an email address, and is case-sensitive.
+                    def identity
+                        @properties['identity']
+                    end
+                    
+                    ##
+                    # @return [String] The string that you assigned to describe the User.
+                    def friendly_name
+                        @properties['friendly_name']
+                    end
+                    
+                    ##
+                    # @return [String] The avatar URL which will be shown in Frontline application.
+                    def avatar
+                        @properties['avatar']
+                    end
+                    
+                    ##
+                    # @return [StateType] 
+                    def state
+                        @properties['state']
+                    end
+                    
+                    ##
+                    # @return [Boolean] Whether the User is available for new conversations. Defaults to `false` for new users.
+                    def is_available
+                        @properties['is_available']
+                    end
+                    
+                    ##
+                    # @return [String] An absolute API resource URL for this user.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Fetch the UserInstance
+                    # @return [UserInstance] Fetched UserInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Update the UserInstance
+                    # @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(
+                        friendly_name: :unset, 
+                        avatar: :unset, 
+                        state: :unset, 
+                        is_available: :unset
+                    )
+
+                        context.update(
+                            friendly_name: friendly_name, 
+                            avatar: avatar, 
+                            state: state, 
+                            is_available: is_available, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.FrontlineApi.V1.UserInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.FrontlineApi.V1.UserInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,49 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Frontline
+#    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 FrontlineApi
+            class V1 < Version
+                ##
+                # Initialize the V1 version of FrontlineApi
+                def initialize(domain)
+                    super
+                    @version = 'v1'
+                    @users = nil
+                end
+
+                ##
+                # @param [String] sid The SID of the User resource to fetch. This value can be either the `sid` or the `identity` of the User resource to fetch.
+                # @return [Twilio::REST::FrontlineApi::V1::UserContext] if sid was passed.
+                # @return [Twilio::REST::FrontlineApi::V1::UserList]
+                def users(sid=:unset)
+                    if sid.nil?
+                        raise ArgumentError, 'sid cannot be nil'
+                    end
+                    if sid == :unset
+                        @users ||= UserList.new self
+                    else
+                        UserContext.new(self, sid)
+                    end
+                end
+                ##
+                # Provide a user friendly representation
+                def to_s
+                    '<Twilio::REST::FrontlineApi::V1>';
+                end
+            end
+        end
+    end
+end