twilio-ruby 5.31.1 → 5.54.0

data/lib/twilio-ruby/rest/chat/v1/service/channel/message.rb

@@ -17,10 +17,10 @@ module Twilio
               # Initialize the MessageList
               # @param [Version] version Version that contains the resource
               # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is
+              #   {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is
               #   associated with.
               # @param [String] channel_sid The unique ID of the
-              #   [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the Message
+              #   {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] the Message
               #   resource belongs to.
               # @return [MessageList] MessageList
               def initialize(version, service_sid: nil, channel_sid: nil)
@@ -32,25 +32,20 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of MessageInstance records from the API.
-              # Request is executed immediately.
+              # Create the MessageInstance
               # @param [String] body The message to send to the channel. Can also be an empty
               #   string or `null`, which sets the value as an empty string. You can send
               #   structured data in the body by serializing it as a string.
               # @param [String] from The
-              #   [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the new
+              #   {identity}[https://www.twilio.com/docs/api/chat/guides/identity] of the new
               #   message's author. The default value is `system`.
               # @param [String] attributes A valid JSON string that contains
               #   application-specific data.
-              # @return [MessageInstance] Newly created MessageInstance
+              # @return [MessageInstance] Created MessageInstance
               def create(body: nil, from: :unset, attributes: :unset)
                 data = Twilio::Values.of({'Body' => body, 'From' => from, 'Attributes' => attributes, })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 MessageInstance.new(
                     @version,
@@ -128,11 +123,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 MessagePage.new(@version, response, @solution)
               end
 
@@ -195,10 +188,10 @@ module Twilio
               # Initialize the MessageContext
               # @param [Version] version Version that contains the resource
               # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the
+              #   {Service}[https://www.twilio.com/docs/api/chat/rest/services] to fetch the
               #   resource from.
               # @param [String] channel_sid The unique ID of the
-              #   [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the message to
+              #   {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] the message to
               #   fetch belongs to. Can be the Channel's `sid` or `unique_name`.
               # @param [String] sid The Twilio-provided string that uniquely identifies the
               #   Message resource to fetch.
@@ -212,16 +205,10 @@ module Twilio
               end
 
               ##
-              # Fetch a MessageInstance
+              # Fetch the MessageInstance
               # @return [MessageInstance] Fetched MessageInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 MessageInstance.new(
                     @version,
@@ -233,10 +220,10 @@ module Twilio
               end
 
               ##
-              # Deletes the MessageInstance
+              # Delete the MessageInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -250,11 +237,7 @@ module Twilio
               def update(body: :unset, attributes: :unset)
                 data = Twilio::Values.of({'Body' => body, 'Attributes' => attributes, })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data)
 
                 MessageInstance.new(
                     @version,
@@ -286,10 +269,10 @@ 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/api/chat/rest/services) the resource is
+              #   {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is
               #   associated with.
               # @param [String] channel_sid The unique ID of the
-              #   [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the Message
+              #   {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] the Message
               #   resource belongs to.
               # @param [String] sid The Twilio-provided string that uniquely identifies the
               #   Message resource to fetch.
@@ -418,14 +401,14 @@ module Twilio
               end
 
               ##
-              # Fetch a MessageInstance
+              # Fetch the MessageInstance
               # @return [MessageInstance] Fetched MessageInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the MessageInstance
+              # Delete the MessageInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete

data/lib/twilio-ruby/rest/chat/v1/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/api/chat/rest/services) the resource is
+            #   {Service}[https://www.twilio.com/docs/api/chat/rest/services] the 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/api/channels) roles or `deployment`
-            #   for [Service](https://www.twilio.com/docs/chat/api/services) 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` and are described in the documentation.
-            # @return [RoleInstance] Newly created RoleInstance
+            #   {Channel}[https://www.twilio.com/docs/chat/api/channels] roles or `deployment`
+            #   for {Service}[https://www.twilio.com/docs/chat/api/services] 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` and are described in the documentation.
+            # @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/api/chat/rest/services) to fetch the
+            #   {Service}[https://www.twilio.com/docs/api/chat/rest/services] to fetch the
             #   resource from.
             # @param [String] sid The Twilio-provided string that uniquely identifies the Role
             #   resource to fetch.
@@ -193,42 +186,32 @@ 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. The values for this parameter
             #   depend on the role's `type` and are described in the documentation.
             # @return [RoleInstance] Updated RoleInstance
             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
@@ -254,7 +237,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/api/chat/rest/services) the resource is
+            #   {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is
             #   associated with.
             # @param [String] sid The Twilio-provided string that uniquely identifies the Role
             #   resource to fetch.
@@ -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. The values for this parameter
             #   depend on the role's `type` and are described in the documentation.
             # @return [RoleInstance] Updated RoleInstance

data/lib/twilio-ruby/rest/chat/v1/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/api/chat/rest/services) the resource is
+            #   {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is
             #   associated with.
             # @return [UserList] UserList
             def initialize(version, service_sid: nil)
@@ -28,21 +28,20 @@ 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/api/chat/rest/v1/user) within the
-            #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). This value is
+            #   resource's {User}[https://www.twilio.com/docs/api/chat/rest/v1/user] within the
+            #   {Service}[https://www.twilio.com/docs/api/chat/rest/v1/service]. This value is
             #   often a username or email address. See the Identity documentation for more
             #   details.
             # @param [String] role_sid The SID of the
-            #   [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to the new
+            #   {Role}[https://www.twilio.com/docs/api/chat/rest/roles] assigned 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
+            # @return [UserInstance] Created UserInstance
             def create(identity: nil, role_sid: :unset, attributes: :unset, friendly_name: :unset)
               data = Twilio::Values.of({
                   'Identity' => identity,
@@ -51,11 +50,7 @@ module Twilio
                   'FriendlyName' => friendly_name,
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               UserInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
@@ -121,11 +116,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 +176,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/api/chat/rest/services) to fetch the
+            #   {Service}[https://www.twilio.com/docs/api/chat/rest/services] to fetch the
             #   resource from.
             # @param [String] sid The Twilio-provided string that uniquely identifies the User
             #   resource to fetch.
@@ -200,31 +193,25 @@ 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/api/chat/rest/roles) assigned to this user.
+            #   {Role}[https://www.twilio.com/docs/api/chat/rest/roles] assigned to this 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
@@ -237,11 +224,7 @@ module Twilio
                   'FriendlyName' => friendly_name,
               })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               UserInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
@@ -283,7 +266,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/api/chat/rest/services) the resource is
+            #   {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is
             #   associated with.
             # @param [String] sid The Twilio-provided string that uniquely identifies the User
             #   resource to fetch.
@@ -410,14 +393,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
@@ -426,7 +409,7 @@ module Twilio
             ##
             # Update the UserInstance
             # @param [String] role_sid The SID of the
-            #   [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to this user.
+            #   {Role}[https://www.twilio.com/docs/api/chat/rest/roles] assigned to this 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