twilio-ruby 5.20.0 → 5.47.0

data/lib/twilio-ruby/rest/chat/v2/service/user.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -15,9 +15,9 @@ module Twilio
             ##
             # Initialize the UserList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The unique id of the
-            #   [Service](https://www.twilio.com/docs/api/chat/rest/services) this user belongs
-            #   to.
+            # @param [String] service_sid The SID of the
+            #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the User
+            #   resource is associated with.
             # @return [UserList] UserList
             def initialize(version, service_sid: nil)
               super(version)
@@ -28,32 +28,32 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of UserInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] identity A unique string that identifies the user within this
-            #   service - often a username or email address. See the [identity][identity] docs
-            #   for more details.
-            # @param [String] role_sid The unique id of the
-            #   [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to this user.
-            # @param [String] attributes An optional string used to contain any metadata or
-            #   other information for the User.  The string must contain structurally valid JSON
-            #   if specified.
-            # @param [String] friendly_name An optional human readable string representing the
-            #   user.  Often used for display purposes.
-            # @return [UserInstance] Newly created UserInstance
-            def create(identity: nil, role_sid: :unset, attributes: :unset, friendly_name: :unset)
+            # Create the UserInstance
+            # @param [String] identity The `identity` value that uniquely identifies the new
+            #   resource's {User}[https://www.twilio.com/docs/chat/rest/user-resource] within
+            #   the {Service}[https://www.twilio.com/docs/chat/rest/service-resource]. This
+            #   value is often a username or email address. See the Identity documentation for
+            #   more info.
+            # @param [String] role_sid The SID of the
+            #   {Role}[https://www.twilio.com/docs/chat/rest/role-resource] to assign to the new
+            #   User.
+            # @param [String] attributes A valid JSON string that contains
+            #   application-specific data.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the new resource. This value is often used for display purposes.
+            # @param [user.WebhookEnabledType] x_twilio_webhook_enabled The
+            #   X-Twilio-Webhook-Enabled HTTP request header
+            # @return [UserInstance] Created UserInstance
+            def create(identity: nil, role_sid: :unset, attributes: :unset, friendly_name: :unset, x_twilio_webhook_enabled: :unset)
               data = Twilio::Values.of({
                   'Identity' => identity,
                   'RoleSid' => role_sid,
                   'Attributes' => attributes,
                   'FriendlyName' => friendly_name,
               })
+              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, service_sid: @solution[:service_sid], )
             end
@@ -119,11 +119,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               UserPage.new(@version, response, @solution)
             end
 
@@ -180,11 +178,11 @@ module Twilio
             ##
             # Initialize the UserContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid Sid of the
-            #   [Service](https://www.twilio.com/docs/api/chat/rest/services) this user belongs
-            #   to.
-            # @param [String] sid Key that uniquely defines the user to fetch. Could be Sid or
-            #   Identity.
+            # @param [String] service_sid The SID of the
+            #   {Service}[https://www.twilio.com/docs/chat/rest/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.
             # @return [UserContext] UserContext
             def initialize(version, service_sid, sid)
               super(version)
@@ -199,49 +197,42 @@ module Twilio
             end
 
             ##
-            # Fetch a UserInstance
+            # Fetch the UserInstance
             # @return [UserInstance] Fetched UserInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               UserInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the UserInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the UserInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
             # Update the UserInstance
-            # @param [String] role_sid The unique id of the [Role][role] assigned to this
-            #   user.
-            # @param [String] attributes An optional string used to contain any metadata or
-            #   other information for the User.  The string must contain structurally valid JSON
-            #   if specified.
-            # @param [String] friendly_name An optional human readable string representing the
-            #   user.  Often used for display purposes.
+            # @param [String] role_sid The SID of the
+            #   {Role}[https://www.twilio.com/docs/chat/rest/role-resource] to assign to the
+            #   User.
+            # @param [String] attributes A valid JSON string that contains
+            #   application-specific data.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It is often used for display purposes.
+            # @param [user.WebhookEnabledType] x_twilio_webhook_enabled The
+            #   X-Twilio-Webhook-Enabled HTTP request header
             # @return [UserInstance] Updated UserInstance
-            def update(role_sid: :unset, attributes: :unset, friendly_name: :unset)
+            def update(role_sid: :unset, attributes: :unset, friendly_name: :unset, x_twilio_webhook_enabled: :unset)
               data = Twilio::Values.of({
                   'RoleSid' => role_sid,
                   'Attributes' => attributes,
                   'FriendlyName' => friendly_name,
               })
+              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, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
@@ -296,6 +287,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Chat.V2.UserContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Chat.V2.UserContext #{context}>"
+            end
           end
 
           class UserInstance < InstanceResource
@@ -303,11 +301,11 @@ module Twilio
             # Initialize the UserInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] service_sid The unique id of the
-            #   [Service](https://www.twilio.com/docs/api/chat/rest/services) this user belongs
-            #   to.
-            # @param [String] sid Key that uniquely defines the user to fetch. Could be Sid or
-            #   Identity.
+            # @param [String] service_sid The SID of the
+            #   {Service}[https://www.twilio.com/docs/chat/rest/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.
             # @return [UserInstance] UserInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -347,115 +345,122 @@ module Twilio
             end
 
             ##
-            # @return [String] A 34 character string that uniquely identifies this resource.
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The unique id of the Account responsible for this user.
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The unique id of the Service this user belongs to.
+            # @return [String] The SID of the Service that the resource is associated with
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [String] An optional string metadata field you can use to store any data you wish.
+            # @return [String] The JSON string that stores application-specific data
             def attributes
               @properties['attributes']
             end
 
             ##
-            # @return [String] The human-readable name of this user.
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The unique id of the [Role][role] assigned to this user.
+            # @return [String] The SID of the Role assigned to the user
             def role_sid
               @properties['role_sid']
             end
 
             ##
-            # @return [String] A unique string that identifies the user within this service - often a username or email address.
+            # @return [String] The string that identifies the resource's User
             def identity
               @properties['identity']
             end
 
             ##
-            # @return [Boolean] Indicates whether the User is actively connected to the Service instance and online.
+            # @return [Boolean] Whether the User is actively connected to the Service instance and online
             def is_online
               @properties['is_online']
             end
 
             ##
-            # @return [Boolean] Indicates whether the User has a potentially valid Push Notification registration  for the Service instance.
+            # @return [Boolean] Whether the User has a potentially valid Push Notification registration for the Service instance
             def is_notifiable
               @properties['is_notifiable']
             end
 
             ##
-            # @return [Time] The date that this resource was created in ISO 8601 format.
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date that this resource was last updated in ISO 8601 format.
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The number of Channels this User is a Member of.
+            # @return [String] The number of Channels the User is a Member of
             def joined_channels_count
               @properties['joined_channels_count']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] The absolute URLs of the Channel and Binding resources related to the user
             def links
               @properties['links']
             end
 
             ##
-            # @return [String] An absolute URL for this user.
+            # @return [String] The absolute URL of the User resource
             def url
               @properties['url']
             end
 
             ##
-            # Fetch a UserInstance
+            # Fetch the UserInstance
             # @return [UserInstance] Fetched UserInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the UserInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the UserInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
 
             ##
             # Update the UserInstance
-            # @param [String] role_sid The unique id of the [Role][role] assigned to this
-            #   user.
-            # @param [String] attributes An optional string used to contain any metadata or
-            #   other information for the User.  The string must contain structurally valid JSON
-            #   if specified.
-            # @param [String] friendly_name An optional human readable string representing the
-            #   user.  Often used for display purposes.
+            # @param [String] role_sid The SID of the
+            #   {Role}[https://www.twilio.com/docs/chat/rest/role-resource] to assign to the
+            #   User.
+            # @param [String] attributes A valid JSON string that contains
+            #   application-specific data.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It is often used for display purposes.
+            # @param [user.WebhookEnabledType] x_twilio_webhook_enabled The
+            #   X-Twilio-Webhook-Enabled HTTP request header
             # @return [UserInstance] Updated UserInstance
-            def update(role_sid: :unset, attributes: :unset, friendly_name: :unset)
-              context.update(role_sid: role_sid, attributes: attributes, friendly_name: friendly_name, )
+            def update(role_sid: :unset, attributes: :unset, friendly_name: :unset, x_twilio_webhook_enabled: :unset)
+              context.update(
+                  role_sid: role_sid,
+                  attributes: attributes,
+                  friendly_name: friendly_name,
+                  x_twilio_webhook_enabled: x_twilio_webhook_enabled,
+              )
             end
 
             ##

data/lib/twilio-ruby/rest/chat/v2/service/user/user_binding.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -16,14 +16,14 @@ module Twilio
               ##
               # Initialize the UserBindingList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The unique id of the
-              #   [Service](https://www.twilio.com/docs/api/chat/rest/services) this binding
-              #   belongs to.
-              # @param [String] user_sid The unique id of the
-              #   [User](https://www.twilio.com/docs/api/chat/rest/users) for this binding.  See
-              #   [push notification
-              #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
-              #   for more information.
+              # @param [String] service_sid The SID of the
+              #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the User
+              #   Binding resource is associated with.
+              # @param [String] user_sid The SID of the
+              #   {User}[https://www.twilio.com/docs/chat/rest/user-resource] with the User
+              #   Binding resource.  See {push notification
+              #   configuration}[https://www.twilio.com/docs/chat/push-notification-configuration]
+              #   for more info.
               # @return [UserBindingList] UserBindingList
               def initialize(version, service_sid: nil, user_sid: nil)
                 super(version)
@@ -37,11 +37,11 @@ module Twilio
               # Lists UserBindingInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [user_binding.BindingType] binding_type The push technology used for the
-              #   returned Bindings.  Supported values are apn, gcm and fcm.  See [push
-              #   notification
-              #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
-              #   for more information.
+              # @param [Array[user_binding.BindingType]] binding_type The push technology used
+              #   by the User Binding resources to read. Can be: `apn`, `gcm`, or `fcm`.  See
+              #   {push notification
+              #   configuration}[https://www.twilio.com/docs/chat/push-notification-configuration]
+              #   for more info.
               # @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
@@ -57,11 +57,11 @@ module Twilio
               # Streams UserBindingInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [user_binding.BindingType] binding_type The push technology used for the
-              #   returned Bindings.  Supported values are apn, gcm and fcm.  See [push
-              #   notification
-              #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
-              #   for more information.
+              # @param [Array[user_binding.BindingType]] binding_type The push technology used
+              #   by the User Binding resources to read. Can be: `apn`, `gcm`, or `fcm`.  See
+              #   {push notification
+              #   configuration}[https://www.twilio.com/docs/chat/push-notification-configuration]
+              #   for more info.
               # @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
@@ -94,11 +94,11 @@ module Twilio
               ##
               # Retrieve a single page of UserBindingInstance records from the API.
               # Request is executed immediately.
-              # @param [user_binding.BindingType] binding_type The push technology used for the
-              #   returned Bindings.  Supported values are apn, gcm and fcm.  See [push
-              #   notification
-              #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
-              #   for more information.
+              # @param [Array[user_binding.BindingType]] binding_type The push technology used
+              #   by the User Binding resources to read. Can be: `apn`, `gcm`, or `fcm`.  See
+              #   {push notification
+              #   configuration}[https://www.twilio.com/docs/chat/push-notification-configuration]
+              #   for more info.
               # @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
@@ -110,11 +110,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 UserBindingPage.new(@version, response, @solution)
               end
 
@@ -176,9 +174,15 @@ module Twilio
               ##
               # Initialize the UserBindingContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] user_sid The user_sid
-              # @param [String] sid The sid
+              # @param [String] service_sid The SID of the
+              #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the
+              #   User Binding resource from.
+              # @param [String] user_sid The SID of the
+              #   {User}[https://www.twilio.com/docs/chat/rest/user-resource] with the User
+              #   Binding resource to fetch.  See {push notification
+              #   configuration}[https://www.twilio.com/docs/chat/push-notification-configuration]
+              #   for more info.
+              # @param [String] sid The SID of the User Binding resource to fetch.
               # @return [UserBindingContext] UserBindingContext
               def initialize(version, service_sid, user_sid, sid)
                 super(version)
@@ -189,16 +193,10 @@ module Twilio
               end
 
               ##
-              # Fetch a UserBindingInstance
+              # Fetch the UserBindingInstance
               # @return [UserBindingInstance] Fetched UserBindingInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 UserBindingInstance.new(
                     @version,
@@ -210,10 +208,10 @@ module Twilio
               end
 
               ##
-              # Deletes the UserBindingInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the UserBindingInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -222,6 +220,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Chat.V2.UserBindingContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Chat.V2.UserBindingContext #{context}>"
+              end
             end
 
             class UserBindingInstance < InstanceResource
@@ -229,15 +234,15 @@ module Twilio
               # Initialize the UserBindingInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] service_sid The unique id of the
-              #   [Service](https://www.twilio.com/docs/api/chat/rest/services) this binding
-              #   belongs to.
-              # @param [String] user_sid The unique id of the
-              #   [User](https://www.twilio.com/docs/api/chat/rest/users) for this binding.  See
-              #   [push notification
-              #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
-              #   for more information.
-              # @param [String] sid The sid
+              # @param [String] service_sid The SID of the
+              #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the User
+              #   Binding resource is associated with.
+              # @param [String] user_sid The SID of the
+              #   {User}[https://www.twilio.com/docs/chat/rest/user-resource] with the User
+              #   Binding resource.  See {push notification
+              #   configuration}[https://www.twilio.com/docs/chat/push-notification-configuration]
+              #   for more info.
+              # @param [String] sid The SID of the User Binding resource to fetch.
               # @return [UserBindingInstance] UserBindingInstance
               def initialize(version, payload, service_sid: nil, user_sid: nil, sid: nil)
                 super(version)
@@ -280,87 +285,87 @@ module Twilio
               end
 
               ##
-              # @return [String] A 34 character string that uniquely identifies this resource.
+              # @return [String] The unique string that identifies the resource
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] The unique id of the Account responsible for this binding.
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The unique id of the Service this binding belongs to.
+              # @return [String] The SID of the Service that the resource is associated with
               def service_sid
                 @properties['service_sid']
               end
 
               ##
-              # @return [Time] The date that this resource was created.
+              # @return [Time] The ISO 8601 date and time in GMT when the resource was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date that this resource was last updated.
+              # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [String] The unique endpoint identifier for this Binding.
+              # @return [String] The unique endpoint identifier for the User Binding
               def endpoint
                 @properties['endpoint']
               end
 
               ##
-              # @return [String] A unique string identifier for the Binding for this User in this Service.
+              # @return [String] The string that identifies the resource's User
               def identity
                 @properties['identity']
               end
 
               ##
-              # @return [String] The unique id of the User for this binding.
+              # @return [String] The SID of the User with the binding
               def user_sid
                 @properties['user_sid']
               end
 
               ##
-              # @return [String] The unique id of the Credential for this binding.
+              # @return [String] The SID of the Credential for the binding
               def credential_sid
                 @properties['credential_sid']
               end
 
               ##
-              # @return [user_binding.BindingType] The push technology to use for this binding.
+              # @return [user_binding.BindingType] The push technology to use for the binding
               def binding_type
                 @properties['binding_type']
               end
 
               ##
-              # @return [String] List of message types for this binding.
+              # @return [Array[String]] The Programmable Chat message types the binding is subscribed to
               def message_types
                 @properties['message_types']
               end
 
               ##
-              # @return [String] An absolute URL for this binding.
+              # @return [String] The absolute URL of the User Binding resource
               def url
                 @properties['url']
               end
 
               ##
-              # Fetch a UserBindingInstance
+              # Fetch the UserBindingInstance
               # @return [UserBindingInstance] Fetched UserBindingInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the UserBindingInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the UserBindingInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end