twilio-ruby 5.64.0 → 5.66.0

data/lib/twilio-ruby/rest/chat/v3.rb

@@ -0,0 +1,48 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Chat
+      class V3 < Version
+        ##
+        # Initialize the V3 version of Chat
+        def initialize(domain)
+          super
+          @version = 'v3'
+          @channels = nil
+        end
+
+        ##
+        # @param [String] service_sid The unique SID identifier of the Service.
+        # @param [String] sid A 34 character string that uniquely identifies this Channel.
+        # @return [Twilio::REST::Chat::V3::ChannelContext] if sid was passed.
+        # @return [Twilio::REST::Chat::V3::ChannelList]
+        def channels(service_sid=:unset, sid=:unset)
+          if service_sid.nil?
+              raise ArgumentError, 'service_sid cannot be nil'
+          end
+          if sid.nil?
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if service_sid == :unset && sid == :unset
+              @channels ||= ChannelList.new self
+          else
+              ChannelContext.new(self, service_sid, sid)
+          end
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::Chat::V3>'
+        end
+      end
+    end
+  end
+end

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

@@ -21,6 +21,7 @@ module Twilio
         # Versions
         @v1 = nil
         @v2 = nil
+        @v3 = nil
       end
 
       ##
@@ -35,6 +36,12 @@ module Twilio
         @v2 ||= V2.new self
       end
 
+      ##
+      # Version v3 of chat
+      def v3
+        @v3 ||= V3.new self
+      end
+
       ##
       # @param [String] sid The unique string that we created to identify the Credential
       #   resource.
@@ -53,6 +60,15 @@ module Twilio
         self.v2.services(sid)
       end
 
+      ##
+      # @param [String] sid The unique string that we created to identify the Channel
+      #   resource.
+      # @return [Twilio::REST::Chat::V3::ChannelInstance] if sid was passed.
+      # @return [Twilio::REST::Chat::V3::ChannelList]
+      def channels(service_sid=:unset, sid=:unset)
+        self.v3.channels(service_sid, sid)
+      end
+
       ##
       # Provide a user friendly representation
       def to_s

data/lib/twilio-ruby/rest/conversations/v1/address_configuration.rb

@@ -114,7 +114,7 @@ module Twilio
           # @param [Boolean] auto_creation_enabled Enable/Disable auto-creating
           #   conversations for messages to this address
           # @param [address_configuration.AutoCreationType] auto_creation_type Type of Auto
-          #   Creation. Value can be one of `webhook`, `studio`, `default`.
+          #   Creation. Value can be one of `webhook`, `studio` or `default`.
           # @param [String] auto_creation_conversation_service_sid Conversation Service for
           #   the auto-created conversation. If not set, the conversation is created in the
           #   default service.
@@ -123,9 +123,13 @@ module Twilio
           # @param [address_configuration.Method] auto_creation_webhook_method For type
           #   `webhook`, the HTTP method to be used when sending a webhook request.
           # @param [Array[String]] auto_creation_webhook_filters The list of events, firing
-          #   webhook event for this Conversation.
+          #   webhook event for this Conversation. Values can be any of the following:
+          #   `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`,
+          #   `onConversationUpdated`, `onConversationStateUpdated`, `onConversationRemoved`,
+          #   `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`,
+          #   `onDeliveryUpdated`
           # @param [String] auto_creation_studio_flow_sid For type `studio`, the studio flow
-          #   SID, where the webhook should be sent to.
+          #   SID where the webhook should be sent to.
           # @param [String] auto_creation_studio_retry_count For type `studio`, number of
           #   times to retry the webhook request
           # @return [AddressConfigurationInstance] Created AddressConfigurationInstance
@@ -216,7 +220,7 @@ module Twilio
           # @param [Boolean] auto_creation_enabled Enable/Disable auto-creating
           #   conversations for messages to this address
           # @param [address_configuration.AutoCreationType] auto_creation_type Type of Auto
-          #   Creation. Value can be one of `webhook`, `studio`, `default`.
+          #   Creation. Value can be one of `webhook`, `studio` or `default`.
           # @param [String] auto_creation_conversation_service_sid Conversation Service for
           #   the auto-created conversation. If not set, the conversation is created in the
           #   default service.
@@ -225,9 +229,13 @@ module Twilio
           # @param [address_configuration.Method] auto_creation_webhook_method For type
           #   `webhook`, the HTTP method to be used when sending a webhook request.
           # @param [Array[String]] auto_creation_webhook_filters The list of events, firing
-          #   webhook event for this Conversation.
+          #   webhook event for this Conversation. Values can be any of the following:
+          #   `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`,
+          #   `onConversationUpdated`, `onConversationStateUpdated`, `onConversationRemoved`,
+          #   `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`,
+          #   `onDeliveryUpdated`
           # @param [String] auto_creation_studio_flow_sid For type `studio`, the studio flow
-          #   SID, where the webhook should be sent to.
+          #   SID where the webhook should be sent to.
           # @param [String] auto_creation_studio_retry_count For type `studio`, number of
           #   times to retry the webhook request
           # @return [AddressConfigurationInstance] Updated AddressConfigurationInstance
@@ -324,7 +332,7 @@ module Twilio
           end
 
           ##
-          # @return [String] Type of Address, value can be `whatsapp` or `sms`.
+          # @return [String] Type of Address.
           def type
             @properties['type']
           end
@@ -379,7 +387,7 @@ module Twilio
           # @param [Boolean] auto_creation_enabled Enable/Disable auto-creating
           #   conversations for messages to this address
           # @param [address_configuration.AutoCreationType] auto_creation_type Type of Auto
-          #   Creation. Value can be one of `webhook`, `studio`, `default`.
+          #   Creation. Value can be one of `webhook`, `studio` or `default`.
           # @param [String] auto_creation_conversation_service_sid Conversation Service for
           #   the auto-created conversation. If not set, the conversation is created in the
           #   default service.
@@ -388,9 +396,13 @@ module Twilio
           # @param [address_configuration.Method] auto_creation_webhook_method For type
           #   `webhook`, the HTTP method to be used when sending a webhook request.
           # @param [Array[String]] auto_creation_webhook_filters The list of events, firing
-          #   webhook event for this Conversation.
+          #   webhook event for this Conversation. Values can be any of the following:
+          #   `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`,
+          #   `onConversationUpdated`, `onConversationStateUpdated`, `onConversationRemoved`,
+          #   `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`,
+          #   `onDeliveryUpdated`
           # @param [String] auto_creation_studio_flow_sid For type `studio`, the studio flow
-          #   SID, where the webhook should be sent to.
+          #   SID where the webhook should be sent to.
           # @param [String] auto_creation_studio_retry_count For type `studio`, number of
           #   times to retry the webhook request
           # @return [AddressConfigurationInstance] Updated AddressConfigurationInstance

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

@@ -170,6 +170,7 @@ module Twilio
                 'flex_insights_hr' => payload['flex_insights_hr'],
                 'flex_insights_drilldown' => payload['flex_insights_drilldown'],
                 'flex_url' => payload['flex_url'],
+                'channel_configs' => payload['channel_configs'],
             }
 
             # Context
@@ -440,6 +441,12 @@ module Twilio
             @properties['flex_url']
           end
 
+          ##
+          # @return [Array[Hash]] Flex Conversations channels' attachments configurations
+          def channel_configs
+            @properties['channel_configs']
+          end
+
           ##
           # Fetch the ConfigurationInstance
           # @param [String] ui_version The Pinned UI version of the Configuration resource

data/lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb

@@ -0,0 +1,236 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class FlexApi < Domain
+      class V1 < Version
+        class InteractionContext < InstanceContext
+          class InteractionChannelContext < InstanceContext
+            class InteractionChannelInviteList < ListResource
+              ##
+              # Initialize the InteractionChannelInviteList
+              # @param [Version] version Version that contains the resource
+              # @param [String] interaction_sid The interaction_sid
+              # @param [String] channel_sid The channel_sid
+              # @return [InteractionChannelInviteList] InteractionChannelInviteList
+              def initialize(version, interaction_sid: nil, channel_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {interaction_sid: interaction_sid, channel_sid: channel_sid}
+                @uri = "/Interactions/#{@solution[:interaction_sid]}/Channels/#{@solution[:channel_sid]}/Invites"
+              end
+
+              ##
+              # Create the InteractionChannelInviteInstance
+              # @param [Hash] routing The routing
+              # @return [InteractionChannelInviteInstance] Created InteractionChannelInviteInstance
+              def create(routing: nil)
+                data = Twilio::Values.of({'Routing' => Twilio.serialize_object(routing), })
+
+                payload = @version.create('POST', @uri, data: data)
+
+                InteractionChannelInviteInstance.new(
+                    @version,
+                    payload,
+                    interaction_sid: @solution[:interaction_sid],
+                    channel_sid: @solution[:channel_sid],
+                )
+              end
+
+              ##
+              # Lists InteractionChannelInviteInstance records from the API as a list.
+              # Unlike stream(), this operation is eager and will load `limit` records into
+              # memory before returning.
+              # @param [Integer] limit Upper limit for the number of records to return. stream()
+              #    guarantees to never return more than limit.  Default is no limit
+              # @param [Integer] page_size Number of records to fetch per request, when
+              #    not set will use the default value of 50 records.  If no page_size is defined
+              #    but a limit is defined, stream() will attempt to read the limit with the most
+              #    efficient page size, i.e. min(limit, 1000)
+              # @return [Array] Array of up to limit results
+              def list(limit: nil, page_size: nil)
+                self.stream(limit: limit, page_size: page_size).entries
+              end
+
+              ##
+              # Streams InteractionChannelInviteInstance records from the API as an Enumerable.
+              # This operation lazily loads records as efficiently as possible until the limit
+              # is reached.
+              # @param [Integer] limit Upper limit for the number of records to return. stream()
+              #    guarantees to never return more than limit. Default is no limit.
+              # @param [Integer] page_size Number of records to fetch per request, when
+              #    not set will use the default value of 50 records. If no page_size is defined
+              #    but a limit is defined, stream() will attempt to read the limit with the most
+              #    efficient page size, i.e. min(limit, 1000)
+              # @return [Enumerable] Enumerable that will yield up to limit results
+              def stream(limit: nil, page_size: nil)
+                limits = @version.read_limits(limit, page_size)
+
+                page = self.page(page_size: limits[:page_size], )
+
+                @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+              end
+
+              ##
+              # When passed a block, yields InteractionChannelInviteInstance records from the API.
+              # This operation lazily loads records as efficiently as possible until the limit
+              # is reached.
+              def each
+                limits = @version.read_limits
+
+                page = self.page(page_size: limits[:page_size], )
+
+                @version.stream(page,
+                                limit: limits[:limit],
+                                page_limit: limits[:page_limit]).each {|x| yield x}
+              end
+
+              ##
+              # Retrieve a single page of InteractionChannelInviteInstance records from the API.
+              # Request is executed immediately.
+              # @param [String] page_token PageToken provided by the API
+              # @param [Integer] page_number Page Number, this value is simply for client state
+              # @param [Integer] page_size Number of records to return, defaults to 50
+              # @return [Page] Page of InteractionChannelInviteInstance
+              def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                params = Twilio::Values.of({
+                    'PageToken' => page_token,
+                    'Page' => page_number,
+                    'PageSize' => page_size,
+                })
+
+                response = @version.page('GET', @uri, params: params)
+
+                InteractionChannelInvitePage.new(@version, response, @solution)
+              end
+
+              ##
+              # Retrieve a single page of InteractionChannelInviteInstance records from the API.
+              # Request is executed immediately.
+              # @param [String] target_url API-generated URL for the requested results page
+              # @return [Page] Page of InteractionChannelInviteInstance
+              def get_page(target_url)
+                response = @version.domain.request(
+                    'GET',
+                    target_url
+                )
+                InteractionChannelInvitePage.new(@version, response, @solution)
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.FlexApi.V1.InteractionChannelInviteList>'
+              end
+            end
+
+            class InteractionChannelInvitePage < Page
+              ##
+              # Initialize the InteractionChannelInvitePage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [InteractionChannelInvitePage] InteractionChannelInvitePage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of InteractionChannelInviteInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [InteractionChannelInviteInstance] InteractionChannelInviteInstance
+              def get_instance(payload)
+                InteractionChannelInviteInstance.new(
+                    @version,
+                    payload,
+                    interaction_sid: @solution[:interaction_sid],
+                    channel_sid: @solution[:channel_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.FlexApi.V1.InteractionChannelInvitePage>'
+              end
+            end
+
+            class InteractionChannelInviteInstance < InstanceResource
+              ##
+              # Initialize the InteractionChannelInviteInstance
+              # @param [Version] version Version that contains the resource
+              # @param [Hash] payload payload that contains response from Twilio
+              # @param [String] interaction_sid The interaction_sid
+              # @param [String] channel_sid The channel_sid
+              # @return [InteractionChannelInviteInstance] InteractionChannelInviteInstance
+              def initialize(version, payload, interaction_sid: nil, channel_sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'sid' => payload['sid'],
+                    'interaction_sid' => payload['interaction_sid'],
+                    'channel_sid' => payload['channel_sid'],
+                    'routing' => payload['routing'],
+                    'url' => payload['url'],
+                }
+              end
+
+              ##
+              # @return [String] The sid
+              def sid
+                @properties['sid']
+              end
+
+              ##
+              # @return [String] The interaction_sid
+              def interaction_sid
+                @properties['interaction_sid']
+              end
+
+              ##
+              # @return [String] The channel_sid
+              def channel_sid
+                @properties['channel_sid']
+              end
+
+              ##
+              # @return [Hash] The routing
+              def routing
+                @properties['routing']
+              end
+
+              ##
+              # @return [String] The url
+              def url
+                @properties['url']
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                "<Twilio.FlexApi.V1.InteractionChannelInviteInstance>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                "<Twilio.FlexApi.V1.InteractionChannelInviteInstance>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end