twilio-ruby 5.40.3 → 5.74.1

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

@@ -11,14 +11,12 @@ module Twilio
     class Conversations < Domain
       class V1 < Version
         class ServiceContext < InstanceContext
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class UserList < ListResource
             ##
             # Initialize the UserList
             # @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
+            # @param [String] chat_service_sid The SID of the {Conversation
+            #   Service}[https://www.twilio.com/docs/conversations/api/service-resource] the
             #   User resource is associated with.
             # @return [UserList] UserList
             def initialize(version, chat_service_sid: nil)
@@ -32,26 +30,29 @@ module Twilio
             ##
             # Create the UserInstance
             # @param [String] identity The application-defined string that uniquely identifies
-            #   the resource's User within the [Conversation
-            #   Service](https://www.twilio.com/docs/conversations/api/service-resource). This
+            #   the resource's User within the {Conversation
+            #   Service}[https://www.twilio.com/docs/conversations/api/service-resource]. This
             #   value is often a username or an email address, and is case-sensitive.
             # @param [String] friendly_name The string that you assigned to describe the
             #   resource.
             # @param [String] attributes The JSON Object string that stores
             #   application-specific data. If attributes have not been set, `{}` is returned.
             # @param [String] role_sid The SID of a service-level
-            #   [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to
+            #   {Role}[https://www.twilio.com/docs/conversations/api/role-resource] to assign to
             #   the user.
+            # @param [user.WebhookEnabledType] x_twilio_webhook_enabled The
+            #   X-Twilio-Webhook-Enabled HTTP request header
             # @return [UserInstance] Created UserInstance
-            def create(identity: nil, friendly_name: :unset, attributes: :unset, role_sid: :unset)
+            def create(identity: nil, friendly_name: :unset, attributes: :unset, role_sid: :unset, x_twilio_webhook_enabled: :unset)
               data = Twilio::Values.of({
                   'Identity' => identity,
                   'FriendlyName' => friendly_name,
                   'Attributes' => attributes,
                   'RoleSid' => role_sid,
               })
+              headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
 
-              payload = @version.create('POST', @uri, data: data)
+              payload = @version.create('POST', @uri, data: data, headers: headers)
 
               UserInstance.new(@version, payload, chat_service_sid: @solution[:chat_service_sid], )
             end
@@ -143,8 +144,6 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class UserPage < Page
             ##
             # Initialize the UserPage
@@ -174,14 +173,12 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class UserContext < InstanceContext
             ##
             # Initialize the UserContext
             # @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) to
+            # @param [String] chat_service_sid The SID of the {Conversation
+            #   Service}[https://www.twilio.com/docs/conversations/api/service-resource] to
             #   fetch the User resource from.
             # @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.
@@ -192,6 +189,9 @@ module Twilio
               # Path Solution
               @solution = {chat_service_sid: chat_service_sid, sid: sid, }
               @uri = "/Services/#{@solution[:chat_service_sid]}/Users/#{@solution[:sid]}"
+
+              # Dependents
+              @user_conversations = nil
             end
 
             ##
@@ -201,17 +201,20 @@ module Twilio
             # @param [String] attributes The JSON Object string that stores
             #   application-specific data. If attributes have not been set, `{}` is returned.
             # @param [String] role_sid The SID of a service-level
-            #   [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to
+            #   {Role}[https://www.twilio.com/docs/conversations/api/role-resource] to assign to
             #   the user.
+            # @param [user.WebhookEnabledType] x_twilio_webhook_enabled The
+            #   X-Twilio-Webhook-Enabled HTTP request header
             # @return [UserInstance] Updated UserInstance
-            def update(friendly_name: :unset, attributes: :unset, role_sid: :unset)
+            def update(friendly_name: :unset, attributes: :unset, role_sid: :unset, x_twilio_webhook_enabled: :unset)
               data = Twilio::Values.of({
                   'FriendlyName' => friendly_name,
                   'Attributes' => attributes,
                   'RoleSid' => role_sid,
               })
+              headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
 
-              payload = @version.update('POST', @uri, data: data)
+              payload = @version.update('POST', @uri, data: data, headers: headers)
 
               UserInstance.new(
                   @version,
@@ -223,9 +226,13 @@ module Twilio
 
             ##
             # Delete the UserInstance
+            # @param [user.WebhookEnabledType] x_twilio_webhook_enabled The
+            #   X-Twilio-Webhook-Enabled HTTP request header
             # @return [Boolean] true if delete succeeds, false otherwise
-            def delete
-               @version.delete('DELETE', @uri)
+            def delete(x_twilio_webhook_enabled: :unset)
+              headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
+
+               @version.delete('DELETE', @uri, headers: headers)
             end
 
             ##
@@ -242,6 +249,33 @@ module Twilio
               )
             end
 
+            ##
+            # Access the user_conversations
+            # @return [UserConversationList]
+            # @return [UserConversationContext] if conversation_sid was passed.
+            def user_conversations(conversation_sid=:unset)
+              raise ArgumentError, 'conversation_sid cannot be nil' if conversation_sid.nil?
+
+              if conversation_sid != :unset
+                return UserConversationContext.new(
+                    @version,
+                    @solution[:chat_service_sid],
+                    @solution[:sid],
+                    conversation_sid,
+                )
+              end
+
+              unless @user_conversations
+                @user_conversations = UserConversationList.new(
+                    @version,
+                    chat_service_sid: @solution[:chat_service_sid],
+                    user_sid: @solution[:sid],
+                )
+              end
+
+              @user_conversations
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
@@ -257,15 +291,13 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           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] chat_service_sid The SID of the [Conversation
-            #   Service](https://www.twilio.com/docs/conversations/api/service-resource) the
+            # @param [String] chat_service_sid The SID of the {Conversation
+            #   Service}[https://www.twilio.com/docs/conversations/api/service-resource] the
             #   User resource is associated with.
             # @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.
@@ -283,9 +315,11 @@ module Twilio
                   'friendly_name' => payload['friendly_name'],
                   'attributes' => payload['attributes'],
                   'is_online' => payload['is_online'],
+                  'is_notifiable' => payload['is_notifiable'],
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                   'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                   'url' => payload['url'],
+                  'links' => payload['links'],
               }
 
               # Context
@@ -347,11 +381,17 @@ module Twilio
             end
 
             ##
-            # @return [Boolean] Whether the User is actively connected to the Service instance and online
+            # @return [Boolean] Whether the User is actively connected to this Conversations Service and online
             def is_online
               @properties['is_online']
             end
 
+            ##
+            # @return [Boolean] Whether the User has a potentially valid Push Notification registration for this Conversations Service
+            def is_notifiable
+              @properties['is_notifiable']
+            end
+
             ##
             # @return [Time] The ISO 8601 date and time in GMT when the resource was created
             def date_created
@@ -365,11 +405,17 @@ module Twilio
             end
 
             ##
-            # @return [String] The absolute URL of the User resource
+            # @return [String] An absolute URL for this user.
             def url
               @properties['url']
             end
 
+            ##
+            # @return [String] The links
+            def links
+              @properties['links']
+            end
+
             ##
             # Update the UserInstance
             # @param [String] friendly_name The string that you assigned to describe the
@@ -377,18 +423,27 @@ module Twilio
             # @param [String] attributes The JSON Object string that stores
             #   application-specific data. If attributes have not been set, `{}` is returned.
             # @param [String] role_sid The SID of a service-level
-            #   [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to
+            #   {Role}[https://www.twilio.com/docs/conversations/api/role-resource] to assign to
             #   the user.
+            # @param [user.WebhookEnabledType] x_twilio_webhook_enabled The
+            #   X-Twilio-Webhook-Enabled HTTP request header
             # @return [UserInstance] Updated UserInstance
-            def update(friendly_name: :unset, attributes: :unset, role_sid: :unset)
-              context.update(friendly_name: friendly_name, attributes: attributes, role_sid: role_sid, )
+            def update(friendly_name: :unset, attributes: :unset, role_sid: :unset, x_twilio_webhook_enabled: :unset)
+              context.update(
+                  friendly_name: friendly_name,
+                  attributes: attributes,
+                  role_sid: role_sid,
+                  x_twilio_webhook_enabled: x_twilio_webhook_enabled,
+              )
             end
 
             ##
             # Delete the UserInstance
+            # @param [user.WebhookEnabledType] x_twilio_webhook_enabled The
+            #   X-Twilio-Webhook-Enabled HTTP request header
             # @return [Boolean] true if delete succeeds, false otherwise
-            def delete
-              context.delete
+            def delete(x_twilio_webhook_enabled: :unset)
+              context.delete(x_twilio_webhook_enabled: x_twilio_webhook_enabled, )
             end
 
             ##
@@ -398,6 +453,13 @@ module Twilio
               context.fetch
             end
 
+            ##
+            # Access the user_conversations
+            # @return [user_conversations] user_conversations
+            def user_conversations
+              context.user_conversations
+            end
+
             ##
             # Provide a user friendly representation
             def to_s

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

@@ -10,8 +10,6 @@ module Twilio
   module REST
     class Conversations < Domain
       class V1 < Version
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ServiceList < ListResource
           ##
           # Initialize the ServiceList
@@ -125,8 +123,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ServicePage < Page
           ##
           # Initialize the ServicePage
@@ -156,8 +152,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ServiceContext < InstanceContext
           ##
           # Initialize the ServiceContext
@@ -178,6 +172,7 @@ module Twilio
             @users = nil
             @roles = nil
             @configuration = nil
+            @participant_conversations = nil
           end
 
           ##
@@ -276,6 +271,21 @@ module Twilio
             ConfigurationContext.new(@version, @solution[:sid], )
           end
 
+          ##
+          # Access the participant_conversations
+          # @return [ParticipantConversationList]
+          # @return [ParticipantConversationContext]
+          def participant_conversations
+            unless @participant_conversations
+              @participant_conversations = ParticipantConversationList.new(
+                  @version,
+                  chat_service_sid: @solution[:sid],
+              )
+            end
+
+            @participant_conversations
+          end
+
           ##
           # Provide a user friendly representation
           def to_s
@@ -291,8 +301,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ServiceInstance < InstanceResource
           ##
           # Initialize the ServiceInstance
@@ -368,7 +376,7 @@ module Twilio
           end
 
           ##
-          # @return [String] Absolute URLs to access the Conversations, Users, Roles and Bindings of this Service.
+          # @return [String] Absolute URLs to access the conversations, users, roles, bindings and configuration of this service.
           def links
             @properties['links']
           end
@@ -422,6 +430,13 @@ module Twilio
             context.configuration
           end
 
+          ##
+          # Access the participant_conversations
+          # @return [participant_conversations] participant_conversations
+          def participant_conversations
+            context.participant_conversations
+          end
+
           ##
           # Provide a user friendly representation
           def to_s