twilio-ruby 5.19.0 → 5.77.0

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -15,9 +15,7 @@ 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 service_sid
             # @return [UserList] UserList
             def initialize(version, service_sid: nil)
               super(version)
@@ -28,32 +26,24 @@ 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
+            # @param [String] role_sid The role_sid
+            # @param [String] attributes The attributes
+            # @param [String] friendly_name The friendly_name
+            # @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 +109,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 +168,8 @@ 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 service_sid
+            # @param [String] sid The sid
             # @return [UserContext] UserContext
             def initialize(version, service_sid, sid)
               super(version)
@@ -199,49 +184,38 @@ 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 role_sid
+            # @param [String] attributes The attributes
+            # @param [String] friendly_name The friendly_name
+            # @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 +270,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.IpMessaging.V2.UserContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.IpMessaging.V2.UserContext #{context}>"
+            end
           end
 
           class UserInstance < InstanceResource
@@ -303,11 +284,8 @@ 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 service_sid
+            # @param [String] sid The sid
             # @return [UserInstance] UserInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -325,7 +303,7 @@ module Twilio
                   'is_notifiable' => payload['is_notifiable'],
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                   'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
-                  'joined_channels_count' => payload['joined_channels_count'].to_i,
+                  'joined_channels_count' => payload['joined_channels_count'] == nil ? payload['joined_channels_count'] : payload['joined_channels_count'].to_i,
                   'links' => payload['links'],
                   'url' => payload['url'],
               }
@@ -347,73 +325,73 @@ module Twilio
             end
 
             ##
-            # @return [String] A 34 character string that uniquely identifies this resource.
+            # @return [String] The sid
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The unique id of the Account responsible for this user.
+            # @return [String] The account_sid
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The unique id of the Service this user belongs to.
+            # @return [String] The service_sid
             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 attributes
             def attributes
               @properties['attributes']
             end
 
             ##
-            # @return [String] The human-readable name of this user.
+            # @return [String] The friendly_name
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The unique id of the [Role][role] assigned to this user.
+            # @return [String] The role_sid
             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 identity
             def identity
               @properties['identity']
             end
 
             ##
-            # @return [Boolean] Indicates whether the User is actively connected to the Service instance and online.
+            # @return [Boolean] The is_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] The is_notifiable
             def is_notifiable
               @properties['is_notifiable']
             end
 
             ##
-            # @return [Time] The date that this resource was created in ISO 8601 format.
+            # @return [Time] The date_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 date_updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The number of Channels this User is a Member of.
+            # @return [String] The joined_channels_count
             def joined_channels_count
               @properties['joined_channels_count']
             end
@@ -425,37 +403,40 @@ module Twilio
             end
 
             ##
-            # @return [String] An absolute URL for this user.
+            # @return [String] The url
             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 role_sid
+            # @param [String] attributes The attributes
+            # @param [String] friendly_name The friendly_name
+            # @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
 
             ##