twilio-ruby 5.40.2 → 5.40.3

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

@@ -332,7 +332,7 @@ module Twilio
           end
 
           ##
-          # @return [String] The unique id of the Account responsible for this service.
+          # @return [String] The unique ID of the Account responsible for this service.
           def account_sid
             @properties['account_sid']
           end

data/lib/twilio-ruby/rest/conversations/v1/service/binding.rb

@@ -17,9 +17,9 @@ module Twilio
             ##
             # Initialize the BindingList
             # @param [Version] version Version that contains the resource
-            # @param [String] chat_service_sid The SID of the [Chat
-            #   Service](https://www.twilio.com/docs/chat/rest/service-resource) the Binding
-            #   resource is associated with.
+            # @param [String] chat_service_sid The SID of the [Conversation
+            #   Service](https://www.twilio.com/docs/conversations/api/service-resource) the
+            #   Binding resource is associated with.
             # @return [BindingList] BindingList
             def initialize(version, chat_service_sid: nil)
               super(version)
@@ -38,10 +38,11 @@ module Twilio
             #   notification
             #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
             #   for more info.
-            # @param [String] identity The
-            #   [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value
-            #   of the resources to read. See [access
-            #   tokens](https://www.twilio.com/docs/chat/create-tokens) for more details.
+            # @param [String] identity The identity of a [Conversation
+            #   User](https://www.twilio.com/docs/conversations/api/user-resource) this binding
+            #   belongs to. See [access
+            #   tokens](https://www.twilio.com/docs/conversations/create-tokens) for more
+            #   details.
             # @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
@@ -67,10 +68,11 @@ module Twilio
             #   notification
             #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
             #   for more info.
-            # @param [String] identity The
-            #   [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value
-            #   of the resources to read. See [access
-            #   tokens](https://www.twilio.com/docs/chat/create-tokens) for more details.
+            # @param [String] identity The identity of a [Conversation
+            #   User](https://www.twilio.com/docs/conversations/api/user-resource) this binding
+            #   belongs to. See [access
+            #   tokens](https://www.twilio.com/docs/conversations/create-tokens) for more
+            #   details.
             # @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
@@ -108,10 +110,11 @@ module Twilio
             #   notification
             #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
             #   for more info.
-            # @param [String] identity The
-            #   [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value
-            #   of the resources to read. See [access
-            #   tokens](https://www.twilio.com/docs/chat/create-tokens) for more details.
+            # @param [String] identity The identity of a [Conversation
+            #   User](https://www.twilio.com/docs/conversations/api/user-resource) this binding
+            #   belongs to. See [access
+            #   tokens](https://www.twilio.com/docs/conversations/create-tokens) for more
+            #   details.
             # @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
@@ -187,9 +190,9 @@ module Twilio
             ##
             # Initialize the BindingContext
             # @param [Version] version Version that contains the resource
-            # @param [String] chat_service_sid The SID of the [Chat
-            #   Service](https://www.twilio.com/docs/chat/rest/service-resource) the Binding
-            #   resource is associated with.
+            # @param [String] chat_service_sid The SID of the [Conversation
+            #   Service](https://www.twilio.com/docs/conversations/api/service-resource) the
+            #   Binding resource is associated with.
             # @param [String] sid A 34 character string that uniquely identifies this
             #   resource.
             # @return [BindingContext] BindingContext
@@ -244,9 +247,9 @@ module Twilio
             # Initialize the BindingInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] chat_service_sid The SID of the [Chat
-            #   Service](https://www.twilio.com/docs/chat/rest/service-resource) the Binding
-            #   resource is associated with.
+            # @param [String] chat_service_sid The SID of the [Conversation
+            #   Service](https://www.twilio.com/docs/conversations/api/service-resource) the
+            #   Binding resource is associated with.
             # @param [String] sid A 34 character string that uniquely identifies this
             #   resource.
             # @return [BindingInstance] BindingInstance
@@ -291,13 +294,13 @@ module Twilio
             end
 
             ##
-            # @return [String] The unique id of the Account responsible for this binding.
+            # @return [String] The unique ID of the Account responsible for this binding.
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The SID of the Chat Service that the resource is associated with.
+            # @return [String] The SID of the Conversation Service that the resource is associated with.
             def chat_service_sid
               @properties['chat_service_sid']
             end
@@ -327,7 +330,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The string that identifies the resource's User.
+            # @return [String] The identity of Conversation User associated with this binding.
             def identity
               @properties['identity']
             end
@@ -339,7 +342,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The Chat message types the binding is subscribed to.
+            # @return [String] The Conversation message types the binding is subscribed to.
             def message_types
               @properties['message_types']
             end

data/lib/twilio-ruby/rest/conversations/v1/service/configuration.rb

@@ -80,6 +80,9 @@ module Twilio
               # Path Solution
               @solution = {chat_service_sid: chat_service_sid, }
               @uri = "/Services/#{@solution[:chat_service_sid]}/Configuration"
+
+              # Components
+              @notifications = nil
             end
 
             ##
@@ -93,17 +96,18 @@ module Twilio
 
             ##
             # Update the ConfigurationInstance
-            # @param [String] default_conversation_creator_role_sid The role assigned to a
-            #   conversation creator when they join a new conversation. See the [Role
-            #   resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
+            # @param [String] default_conversation_creator_role_sid The conversation-level
+            #   role assigned to a conversation creator when they join a new conversation. See
+            #   the [Conversation
+            #   Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info
             #   about roles.
-            # @param [String] default_conversation_role_sid The role assigned to users when
-            #   they are added to a conversation. See the [Role
-            #   resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
+            # @param [String] default_conversation_role_sid The conversation-level role
+            #   assigned to users when they are added to a conversation. See the [Conversation
+            #   Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info
             #   about roles.
-            # @param [String] default_chat_service_role_sid The service role assigned to users
-            #   when they are added to the service. See the [Role
-            #   resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
+            # @param [String] default_chat_service_role_sid The service-level role assigned to
+            #   users when they are added to the service. See the [Conversation
+            #   Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info
             #   about roles.
             # @return [ConfigurationInstance] Updated ConfigurationInstance
             def update(default_conversation_creator_role_sid: :unset, default_conversation_role_sid: :unset, default_chat_service_role_sid: :unset)
@@ -118,6 +122,13 @@ module Twilio
               ConfigurationInstance.new(@version, payload, chat_service_sid: @solution[:chat_service_sid], )
             end
 
+            ##
+            # Access the notifications
+            # @return [NotificationContext] NotificationContext
+            def notifications
+              return NotificationContext.new(@version, @solution[:chat_service_sid], )
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
@@ -217,17 +228,18 @@ module Twilio
 
             ##
             # Update the ConfigurationInstance
-            # @param [String] default_conversation_creator_role_sid The role assigned to a
-            #   conversation creator when they join a new conversation. See the [Role
-            #   resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
+            # @param [String] default_conversation_creator_role_sid The conversation-level
+            #   role assigned to a conversation creator when they join a new conversation. See
+            #   the [Conversation
+            #   Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info
             #   about roles.
-            # @param [String] default_conversation_role_sid The role assigned to users when
-            #   they are added to a conversation. See the [Role
-            #   resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
+            # @param [String] default_conversation_role_sid The conversation-level role
+            #   assigned to users when they are added to a conversation. See the [Conversation
+            #   Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info
             #   about roles.
-            # @param [String] default_chat_service_role_sid The service role assigned to users
-            #   when they are added to the service. See the [Role
-            #   resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
+            # @param [String] default_chat_service_role_sid The service-level role assigned to
+            #   users when they are added to the service. See the [Conversation
+            #   Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info
             #   about roles.
             # @return [ConfigurationInstance] Updated ConfigurationInstance
             def update(default_conversation_creator_role_sid: :unset, default_conversation_role_sid: :unset, default_chat_service_role_sid: :unset)

data/lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb

@@ -0,0 +1,315 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Conversations < Domain
+      class V1 < Version
+        class ServiceContext < InstanceContext
+          class ConfigurationContext < InstanceContext
+            ##
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+            class NotificationList < ListResource
+              ##
+              # Initialize the NotificationList
+              # @param [Version] version Version that contains the resource
+              # @param [String] chat_service_sid The unique string that we created to identify
+              #   the Service configuration resource.
+              # @return [NotificationList] NotificationList
+              def initialize(version, chat_service_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {chat_service_sid: chat_service_sid}
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Conversations.V1.NotificationList>'
+              end
+            end
+
+            ##
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+            class NotificationPage < Page
+              ##
+              # Initialize the NotificationPage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [NotificationPage] NotificationPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of NotificationInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [NotificationInstance] NotificationInstance
+              def get_instance(payload)
+                NotificationInstance.new(@version, payload, chat_service_sid: @solution[:chat_service_sid], )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Conversations.V1.NotificationPage>'
+              end
+            end
+
+            ##
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+            class NotificationContext < InstanceContext
+              ##
+              # Initialize the NotificationContext
+              # @param [Version] version Version that contains the resource
+              # @param [String] chat_service_sid The SID of the [Conversation
+              #   Service](https://www.twilio.com/docs/conversations/api/service-resource) the
+              #   Configuration applies to.
+              # @return [NotificationContext] NotificationContext
+              def initialize(version, chat_service_sid)
+                super(version)
+
+                # Path Solution
+                @solution = {chat_service_sid: chat_service_sid, }
+                @uri = "/Services/#{@solution[:chat_service_sid]}/Configuration/Notifications"
+              end
+
+              ##
+              # Update the NotificationInstance
+              # @param [Boolean] log_enabled Weather the notification logging is enabled.
+              # @param [Boolean] new_message_enabled Whether to send a notification when a new
+              #   message is added to a conversation. The default is `false`.
+              # @param [String] new_message_template The template to use to create the
+              #   notification text displayed when a new message is added to a conversation and
+              #   `new_message.enabled` is `true`.
+              # @param [String] new_message_sound The name of the sound to play when a new
+              #   message is added to a conversation and `new_message.enabled` is `true`.
+              # @param [Boolean] new_message_badge_count_enabled Whether the new message badge
+              #   is enabled. The default is `false`.
+              # @param [Boolean] added_to_conversation_enabled Whether to send a notification
+              #   when a participant is added to a conversation. The default is `false`.
+              # @param [String] added_to_conversation_template The template to use to create the
+              #   notification text displayed when a participant is added to a conversation and
+              #   `added_to_conversation.enabled` is `true`.
+              # @param [String] added_to_conversation_sound The name of the sound to play when a
+              #   participant is added to a conversation and `added_to_conversation.enabled` is
+              #   `true`.
+              # @param [Boolean] removed_from_conversation_enabled Whether to send a
+              #   notification to a user when they are removed from a conversation. The default is
+              #   `false`.
+              # @param [String] removed_from_conversation_template The template to use to create
+              #   the notification text displayed to a user when they are removed from a
+              #   conversation and `removed_from_conversation.enabled` is `true`.
+              # @param [String] removed_from_conversation_sound The name of the sound to play to
+              #   a user when they are removed from a conversation and
+              #   `removed_from_conversation.enabled` is `true`.
+              # @return [NotificationInstance] Updated NotificationInstance
+              def update(log_enabled: :unset, new_message_enabled: :unset, new_message_template: :unset, new_message_sound: :unset, new_message_badge_count_enabled: :unset, added_to_conversation_enabled: :unset, added_to_conversation_template: :unset, added_to_conversation_sound: :unset, removed_from_conversation_enabled: :unset, removed_from_conversation_template: :unset, removed_from_conversation_sound: :unset)
+                data = Twilio::Values.of({
+                    'LogEnabled' => log_enabled,
+                    'NewMessage.Enabled' => new_message_enabled,
+                    'NewMessage.Template' => new_message_template,
+                    'NewMessage.Sound' => new_message_sound,
+                    'NewMessage.BadgeCountEnabled' => new_message_badge_count_enabled,
+                    'AddedToConversation.Enabled' => added_to_conversation_enabled,
+                    'AddedToConversation.Template' => added_to_conversation_template,
+                    'AddedToConversation.Sound' => added_to_conversation_sound,
+                    'RemovedFromConversation.Enabled' => removed_from_conversation_enabled,
+                    'RemovedFromConversation.Template' => removed_from_conversation_template,
+                    'RemovedFromConversation.Sound' => removed_from_conversation_sound,
+                })
+
+                payload = @version.update('POST', @uri, data: data)
+
+                NotificationInstance.new(@version, payload, chat_service_sid: @solution[:chat_service_sid], )
+              end
+
+              ##
+              # Fetch the NotificationInstance
+              # @return [NotificationInstance] Fetched NotificationInstance
+              def fetch
+                payload = @version.fetch('GET', @uri)
+
+                NotificationInstance.new(@version, payload, chat_service_sid: @solution[:chat_service_sid], )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Conversations.V1.NotificationContext #{context}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Conversations.V1.NotificationContext #{context}>"
+              end
+            end
+
+            ##
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+            class NotificationInstance < InstanceResource
+              ##
+              # Initialize the NotificationInstance
+              # @param [Version] version Version that contains the resource
+              # @param [Hash] payload payload that contains response from Twilio
+              # @param [String] chat_service_sid The unique string that we created to identify
+              #   the Service configuration resource.
+              # @return [NotificationInstance] NotificationInstance
+              def initialize(version, payload, chat_service_sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'account_sid' => payload['account_sid'],
+                    'chat_service_sid' => payload['chat_service_sid'],
+                    'new_message' => payload['new_message'],
+                    'added_to_conversation' => payload['added_to_conversation'],
+                    'removed_from_conversation' => payload['removed_from_conversation'],
+                    'log_enabled' => payload['log_enabled'],
+                    'url' => payload['url'],
+                }
+
+                # Context
+                @instance_context = nil
+                @params = {'chat_service_sid' => chat_service_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 [NotificationContext] NotificationContext for this NotificationInstance
+              def context
+                unless @instance_context
+                  @instance_context = NotificationContext.new(@version, @params['chat_service_sid'], )
+                end
+                @instance_context
+              end
+
+              ##
+              # @return [String] The unique ID of the Account responsible for this configuration.
+              def account_sid
+                @properties['account_sid']
+              end
+
+              ##
+              # @return [String] The SID of the Conversation Service that the Configuration applies to.
+              def chat_service_sid
+                @properties['chat_service_sid']
+              end
+
+              ##
+              # @return [Hash] The Push Notification configuration for New Messages.
+              def new_message
+                @properties['new_message']
+              end
+
+              ##
+              # @return [Hash] The Push Notification configuration for being added to a Conversation.
+              def added_to_conversation
+                @properties['added_to_conversation']
+              end
+
+              ##
+              # @return [Hash] The Push Notification configuration for being removed from a Conversation.
+              def removed_from_conversation
+                @properties['removed_from_conversation']
+              end
+
+              ##
+              # @return [Boolean] Weather the notification logging is enabled.
+              def log_enabled
+                @properties['log_enabled']
+              end
+
+              ##
+              # @return [String] An absolute URL for this configuration.
+              def url
+                @properties['url']
+              end
+
+              ##
+              # Update the NotificationInstance
+              # @param [Boolean] log_enabled Weather the notification logging is enabled.
+              # @param [Boolean] new_message_enabled Whether to send a notification when a new
+              #   message is added to a conversation. The default is `false`.
+              # @param [String] new_message_template The template to use to create the
+              #   notification text displayed when a new message is added to a conversation and
+              #   `new_message.enabled` is `true`.
+              # @param [String] new_message_sound The name of the sound to play when a new
+              #   message is added to a conversation and `new_message.enabled` is `true`.
+              # @param [Boolean] new_message_badge_count_enabled Whether the new message badge
+              #   is enabled. The default is `false`.
+              # @param [Boolean] added_to_conversation_enabled Whether to send a notification
+              #   when a participant is added to a conversation. The default is `false`.
+              # @param [String] added_to_conversation_template The template to use to create the
+              #   notification text displayed when a participant is added to a conversation and
+              #   `added_to_conversation.enabled` is `true`.
+              # @param [String] added_to_conversation_sound The name of the sound to play when a
+              #   participant is added to a conversation and `added_to_conversation.enabled` is
+              #   `true`.
+              # @param [Boolean] removed_from_conversation_enabled Whether to send a
+              #   notification to a user when they are removed from a conversation. The default is
+              #   `false`.
+              # @param [String] removed_from_conversation_template The template to use to create
+              #   the notification text displayed to a user when they are removed from a
+              #   conversation and `removed_from_conversation.enabled` is `true`.
+              # @param [String] removed_from_conversation_sound The name of the sound to play to
+              #   a user when they are removed from a conversation and
+              #   `removed_from_conversation.enabled` is `true`.
+              # @return [NotificationInstance] Updated NotificationInstance
+              def update(log_enabled: :unset, new_message_enabled: :unset, new_message_template: :unset, new_message_sound: :unset, new_message_badge_count_enabled: :unset, added_to_conversation_enabled: :unset, added_to_conversation_template: :unset, added_to_conversation_sound: :unset, removed_from_conversation_enabled: :unset, removed_from_conversation_template: :unset, removed_from_conversation_sound: :unset)
+                context.update(
+                    log_enabled: log_enabled,
+                    new_message_enabled: new_message_enabled,
+                    new_message_template: new_message_template,
+                    new_message_sound: new_message_sound,
+                    new_message_badge_count_enabled: new_message_badge_count_enabled,
+                    added_to_conversation_enabled: added_to_conversation_enabled,
+                    added_to_conversation_template: added_to_conversation_template,
+                    added_to_conversation_sound: added_to_conversation_sound,
+                    removed_from_conversation_enabled: removed_from_conversation_enabled,
+                    removed_from_conversation_template: removed_from_conversation_template,
+                    removed_from_conversation_sound: removed_from_conversation_sound,
+                )
+              end
+
+              ##
+              # Fetch the NotificationInstance
+              # @return [NotificationInstance] Fetched NotificationInstance
+              def fetch
+                context.fetch
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Conversations.V1.NotificationInstance #{values}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Conversations.V1.NotificationInstance #{values}>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end