twilio-ruby 5.31.1 → 5.54.0

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

@@ -16,7 +16,7 @@ module Twilio
             # Initialize the RoleList
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Role
+            #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Role
             #   resource is associated with.
             # @return [RoleList] RoleList
             def initialize(version, service_sid: nil)
@@ -28,18 +28,17 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of RoleInstance records from the API.
-            # Request is executed immediately.
+            # Create the RoleInstance
             # @param [String] friendly_name A descriptive string that you create to describe
             #   the new resource. It can be up to 64 characters long.
             # @param [role.RoleType] type The type of role. Can be: `channel` for
-            #   [Channel](https://www.twilio.com/docs/chat/channels) roles or `deployment` for
-            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) roles.
-            # @param [String] permission A permission that you grant to the new role. Only one
-            #   permission can be granted per parameter. To assign more than one permission,
-            #   repeat this parameter for each permission value. The values for this parameter
-            #   depend on the role's `type`.
-            # @return [RoleInstance] Newly created RoleInstance
+            #   {Channel}[https://www.twilio.com/docs/chat/channels] roles or `deployment` for
+            #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] roles.
+            # @param [Array[String]] permission A permission that you grant to the new role.
+            #   Only one permission can be granted per parameter. To assign more than one
+            #   permission, repeat this parameter for each permission value. The values for this
+            #   parameter depend on the role's `type`.
+            # @return [RoleInstance] Created RoleInstance
             def create(friendly_name: nil, type: nil, permission: nil)
               data = Twilio::Values.of({
                   'FriendlyName' => friendly_name,
@@ -47,11 +46,7 @@ module Twilio
                   'Permission' => Twilio.serialize_list(permission) { |e| e },
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               RoleInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
@@ -117,11 +112,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               RolePage.new(@version, response, @solution)
             end
 
@@ -179,7 +172,7 @@ module Twilio
             # Initialize the RoleContext
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the
+            #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the
             #   Role resource from.
             # @param [String] sid The SID of the Role resource to fetch.
             # @return [RoleContext] RoleContext
@@ -192,31 +185,25 @@ module Twilio
             end
 
             ##
-            # Fetch a RoleInstance
+            # Fetch the RoleInstance
             # @return [RoleInstance] Fetched RoleInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               RoleInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the RoleInstance
+            # Delete the RoleInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
             # Update the RoleInstance
-            # @param [String] permission A permission that you grant to the role. Only one
-            #   permission can be granted per parameter. To assign more than one permission,
+            # @param [Array[String]] permission A permission that you grant to the role. Only
+            #   one permission can be granted per parameter. To assign more than one permission,
             #   repeat this parameter for each permission value. Note that the update action
             #   replaces all previously assigned permissions with those defined in the update
             #   action. To remove a permission, do not include it in the subsequent update
@@ -225,11 +212,7 @@ module Twilio
             def update(permission: nil)
               data = Twilio::Values.of({'Permission' => Twilio.serialize_list(permission) { |e| e }, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               RoleInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
@@ -255,7 +238,7 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Role
+            #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Role
             #   resource is associated with.
             # @param [String] sid The SID of the Role resource to fetch.
             # @return [RoleInstance] RoleInstance
@@ -322,7 +305,7 @@ module Twilio
             end
 
             ##
-            # @return [String] An array of the permissions the role has been granted
+            # @return [Array[String]] An array of the permissions the role has been granted
             def permissions
               @properties['permissions']
             end
@@ -346,14 +329,14 @@ module Twilio
             end
 
             ##
-            # Fetch a RoleInstance
+            # Fetch the RoleInstance
             # @return [RoleInstance] Fetched RoleInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the RoleInstance
+            # Delete the RoleInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
@@ -361,8 +344,8 @@ module Twilio
 
             ##
             # Update the RoleInstance
-            # @param [String] permission A permission that you grant to the role. Only one
-            #   permission can be granted per parameter. To assign more than one permission,
+            # @param [Array[String]] permission A permission that you grant to the role. Only
+            #   one permission can be granted per parameter. To assign more than one permission,
             #   repeat this parameter for each permission value. Note that the update action
             #   replaces all previously assigned permissions with those defined in the update
             #   action. To remove a permission, do not include it in the subsequent update

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

@@ -16,7 +16,7 @@ module Twilio
             # Initialize the UserList
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User
+            #   {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)
@@ -28,34 +28,32 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of UserInstance records from the API.
-            # Request is executed immediately.
+            # 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
+            #   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
+            #   {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.
-            # @return [UserInstance] Newly created UserInstance
-            def create(identity: nil, role_sid: :unset, attributes: :unset, friendly_name: :unset)
+            # @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
@@ -121,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
 
@@ -183,7 +179,7 @@ module Twilio
             # Initialize the UserContext
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch 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.
@@ -201,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
+            # 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 SID of the
-            #   [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to 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
@@ -313,7 +302,7 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User
+            #   {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.
@@ -386,7 +375,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The SID of the assigned to the user
+            # @return [String] The SID of the Role assigned to the user
             def role_sid
               @properties['role_sid']
             end
@@ -440,14 +429,14 @@ module Twilio
             end
 
             ##
-            # Fetch a UserInstance
+            # Fetch the UserInstance
             # @return [UserInstance] Fetched UserInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the UserInstance
+            # Delete the UserInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
@@ -456,15 +445,22 @@ module Twilio
             ##
             # Update the UserInstance
             # @param [String] role_sid The SID of the
-            #   [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to 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

@@ -17,12 +17,12 @@ module Twilio
               # Initialize the UserBindingList
               # @param [Version] version Version that contains the resource
               # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User
+              #   {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)
+              #   {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)
@@ -37,10 +37,10 @@ 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 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)
+              # @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
@@ -57,10 +57,10 @@ 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 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)
+              # @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.
@@ -94,10 +94,10 @@ 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 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)
+              # @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
@@ -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
 
@@ -177,12 +175,12 @@ module Twilio
               # Initialize the UserBindingContext
               # @param [Version] version Version that contains the resource
               # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch 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)
+              #   {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
@@ -195,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,
@@ -216,10 +208,10 @@ module Twilio
               end
 
               ##
-              # Deletes the UserBindingInstance
+              # Delete the UserBindingInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -243,12 +235,12 @@ module Twilio
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
               # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User
+              #   {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)
+              #   {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
@@ -353,7 +345,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The Programmable Chat message types the binding is subscribed to
+              # @return [Array[String]] The Programmable Chat message types the binding is subscribed to
               def message_types
                 @properties['message_types']
               end
@@ -365,14 +357,14 @@ module Twilio
               end
 
               ##
-              # Fetch a UserBindingInstance
+              # Fetch the UserBindingInstance
               # @return [UserBindingInstance] Fetched UserBindingInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the UserBindingInstance
+              # Delete the UserBindingInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete