twilio-ruby 5.31.1 → 5.54.0

data/lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb

@@ -15,9 +15,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
-            #   associated with.
+            # @param [String] service_sid The service_sid
             # @return [RoleList] RoleList
             def initialize(version, service_sid: nil)
               super(version)
@@ -28,18 +26,11 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of RoleInstance records from the API.
-            # Request is executed immediately.
-            # @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
+            # Create the RoleInstance
+            # @param [String] friendly_name The friendly_name
+            # @param [role.RoleType] type The type
+            # @param [Array[String]] permission The permission
+            # @return [RoleInstance] Created RoleInstance
             def create(friendly_name: nil, type: nil, permission: nil)
               data = Twilio::Values.of({
                   'FriendlyName' => friendly_name,
@@ -47,11 +38,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 +104,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
 
@@ -178,11 +163,8 @@ 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
-            #   resource from.
-            # @param [String] sid The Twilio-provided string that uniquely identifies the Role
-            #   resource to fetch.
+            # @param [String] service_sid The service_sid
+            # @param [String] sid The sid
             # @return [RoleContext] RoleContext
             def initialize(version, service_sid, sid)
               super(version)
@@ -193,42 +175,29 @@ 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,
-            #   repeat this parameter for each permission value. The values for this parameter
-            #   depend on the role's `type` and are described in the documentation.
+            # @param [Array[String]] permission The permission
             # @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
@@ -253,11 +222,8 @@ module Twilio
             # Initialize the RoleInstance
             # @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
-            #   associated with.
-            # @param [String] sid The Twilio-provided string that uniquely identifies the Role
-            #   resource to fetch.
+            # @param [String] service_sid The service_sid
+            # @param [String] sid The sid
             # @return [RoleInstance] RoleInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -292,68 +258,68 @@ module Twilio
             end
 
             ##
-            # @return [String] The unique string that identifies the resource
+            # @return [String] The sid
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The SID of the Account that created the resource
+            # @return [String] The account_sid
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The SID of the Service that the resource is associated with
+            # @return [String] The service_sid
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [String] The string that you assigned to describe the resource
+            # @return [String] The friendly_name
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [role.RoleType] The type of role
+            # @return [role.RoleType] The type
             def type
               @properties['type']
             end
 
             ##
-            # @return [String] An array of the permissions the role has been granted
+            # @return [Array[String]] The permissions
             def permissions
               @properties['permissions']
             end
 
             ##
-            # @return [Time] The RFC 2822 date and time in GMT when the resource was created
+            # @return [Time] The date_created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
+            # @return [Time] The date_updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The absolute URL of the Role resource
+            # @return [String] The url
             def url
               @properties['url']
             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,10 +327,7 @@ 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,
-            #   repeat this parameter for each permission value. The values for this parameter
-            #   depend on the role's `type` and are described in the documentation.
+            # @param [Array[String]] permission The permission
             # @return [RoleInstance] Updated RoleInstance
             def update(permission: nil)
               context.update(permission: permission, )

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

@@ -15,9 +15,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
-            #   associated with.
+            # @param [String] service_sid The service_sid
             # @return [UserList] UserList
             def initialize(version, service_sid: nil)
               super(version)
@@ -28,21 +26,12 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of UserInstance records from the API.
-            # Request is executed immediately.
-            # @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
-            #   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
-            #   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
+            # 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
+            # @return [UserInstance] Created UserInstance
             def create(identity: nil, role_sid: :unset, attributes: :unset, friendly_name: :unset)
               data = Twilio::Values.of({
                   'Identity' => identity,
@@ -51,11 +40,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 +106,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
 
@@ -182,11 +165,8 @@ 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
-            #   resource from.
-            # @param [String] sid The Twilio-provided string that uniquely identifies the User
-            #   resource to fetch.
+            # @param [String] service_sid The service_sid
+            # @param [String] sid The sid
             # @return [UserContext] UserContext
             def initialize(version, service_sid, sid)
               super(version)
@@ -200,35 +180,26 @@ 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.
-            # @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 [String] role_sid The role_sid
+            # @param [String] attributes The attributes
+            # @param [String] friendly_name The friendly_name
             # @return [UserInstance] Updated UserInstance
             def update(role_sid: :unset, attributes: :unset, friendly_name: :unset)
               data = Twilio::Values.of({
@@ -237,11 +208,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
@@ -282,11 +249,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 SID of the
-            #   [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.
+            # @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)
@@ -326,98 +290,98 @@ module Twilio
             end
 
             ##
-            # @return [String] The unique string that identifies the resource
+            # @return [String] The sid
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The SID of the Account that created the resource
+            # @return [String] The account_sid
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The SID of the Service that the resource is associated with
+            # @return [String] The service_sid
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [String] The JSON string that stores application-specific data
+            # @return [String] The attributes
             def attributes
               @properties['attributes']
             end
 
             ##
-            # @return [String] The string that you assigned to describe the resource
+            # @return [String] The friendly_name
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The SID of the assigned to the user
+            # @return [String] The role_sid
             def role_sid
               @properties['role_sid']
             end
 
             ##
-            # @return [String] The string that identifies the resource's User
+            # @return [String] The identity
             def identity
               @properties['identity']
             end
 
             ##
-            # @return [Boolean] 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] 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 RFC 2822 date and time in GMT when the resource was created
+            # @return [Time] The date_created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
+            # @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
 
             ##
-            # @return [String] The absolute URLs of the Channel and Binding resources related to the user
+            # @return [String] The links
             def links
               @properties['links']
             end
 
             ##
-            # @return [String] The absolute URL of the User resource
+            # @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
+            # Delete the UserInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
@@ -425,12 +389,9 @@ 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.
-            # @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 [String] role_sid The role_sid
+            # @param [String] attributes The attributes
+            # @param [String] friendly_name The friendly_name
             # @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, )