twilio-ruby 5.31.1 → 5.46.1

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

@@ -16,11 +16,8 @@ module Twilio
               ##
               # Initialize the MemberList
               # @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] channel_sid The unique ID of the
-              #   [Channel](https://www.twilio.com/docs/api/chat/rest/channels) for the member.
+              # @param [String] service_sid The service_sid
+              # @param [String] channel_sid The channel_sid
               # @return [MemberList] MemberList
               def initialize(version, service_sid: nil, channel_sid: nil)
                 super(version)
@@ -31,26 +28,14 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of MemberInstance 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/services). See [access
-              #   tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more
-              #   details.
-              # @param [String] role_sid The SID of the
-              #   [Role](https://www.twilio.com/docs/api/chat/rest/roles) to assign to the member.
-              #   The default roles are those specified on the
-              #   [Service](https://www.twilio.com/docs/chat/api/services).
-              # @return [MemberInstance] Newly created MemberInstance
+              # Create the MemberInstance
+              # @param [String] identity The identity
+              # @param [String] role_sid The role_sid
+              # @return [MemberInstance] Created MemberInstance
               def create(identity: nil, role_sid: :unset)
                 data = Twilio::Values.of({'Identity' => identity, 'RoleSid' => role_sid, })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 MemberInstance.new(
                     @version,
@@ -64,11 +49,7 @@ module Twilio
               # Lists MemberInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [String] identity The
-              #   [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of
-              #   the resources to read. See [access
-              #   tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more
-              #   details.
+              # @param [Array[String]] identity The identity
               # @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
@@ -84,11 +65,7 @@ module Twilio
               # Streams MemberInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [String] identity The
-              #   [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of
-              #   the resources to read. See [access
-              #   tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more
-              #   details.
+              # @param [Array[String]] identity The identity
               # @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
@@ -121,11 +98,7 @@ module Twilio
               ##
               # Retrieve a single page of MemberInstance records from the API.
               # Request is executed immediately.
-              # @param [String] identity The
-              #   [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of
-              #   the resources to read. See [access
-              #   tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more
-              #   details.
+              # @param [Array[String]] identity The identity
               # @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
@@ -137,11 +110,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 MemberPage.new(@version, response, @solution)
               end
 
@@ -203,14 +174,9 @@ module Twilio
               ##
               # Initialize the MemberContext
               # @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] channel_sid The unique ID of the
-              #   [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the member to
-              #   fetch belongs to. Can be the Channel resource's `sid` or `unique_name` value.
-              # @param [String] sid The Twilio-provided string that uniquely identifies the
-              #   Member resource to fetch.
+              # @param [String] service_sid The service_sid
+              # @param [String] channel_sid The channel_sid
+              # @param [String] sid The sid
               # @return [MemberContext] MemberContext
               def initialize(version, service_sid, channel_sid, sid)
                 super(version)
@@ -221,16 +187,10 @@ module Twilio
               end
 
               ##
-              # Fetch a MemberInstance
+              # Fetch the MemberInstance
               # @return [MemberInstance] Fetched MemberInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 MemberInstance.new(
                     @version,
@@ -242,22 +202,16 @@ module Twilio
               end
 
               ##
-              # Deletes the MemberInstance
+              # Delete the MemberInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
               # Update the MemberInstance
-              # @param [String] role_sid The SID of the
-              #   [Role](https://www.twilio.com/docs/api/chat/rest/roles) to assign to the member.
-              #   The default roles are those specified on the
-              #   [Service](https://www.twilio.com/docs/chat/api/services).
-              # @param [String] last_consumed_message_index The index of the last
-              #   [Message](https://www.twilio.com/docs/api/chat/rest/messages) that the Member
-              #   has read within the
-              #   [Channel](https://www.twilio.com/docs/api/chat/rest/channels).
+              # @param [String] role_sid The role_sid
+              # @param [String] last_consumed_message_index The last_consumed_message_index
               # @return [MemberInstance] Updated MemberInstance
               def update(role_sid: :unset, last_consumed_message_index: :unset)
                 data = Twilio::Values.of({
@@ -265,11 +219,7 @@ module Twilio
                     'LastConsumedMessageIndex' => last_consumed_message_index,
                 })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data)
 
                 MemberInstance.new(
                     @version,
@@ -300,13 +250,9 @@ module Twilio
               # Initialize the MemberInstance
               # @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] channel_sid The unique ID of the
-              #   [Channel](https://www.twilio.com/docs/api/chat/rest/channels) for the member.
-              # @param [String] sid The Twilio-provided string that uniquely identifies the
-              #   Member resource to fetch.
+              # @param [String] service_sid The service_sid
+              # @param [String] channel_sid The channel_sid
+              # @param [String] sid The sid
               # @return [MemberInstance] MemberInstance
               def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil)
                 super(version)
@@ -352,80 +298,80 @@ 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 unique ID of the Channel for the member
+              # @return [String] The channel_sid
               def channel_sid
                 @properties['channel_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 identifies the resource's User
+              # @return [String] The identity
               def identity
                 @properties['identity']
               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 SID of the Role assigned to the member
+              # @return [String] The role_sid
               def role_sid
                 @properties['role_sid']
               end
 
               ##
-              # @return [String] The index of the last Message that the Member has read within the Channel
+              # @return [String] The last_consumed_message_index
               def last_consumed_message_index
                 @properties['last_consumed_message_index']
               end
 
               ##
-              # @return [Time] The ISO 8601 based timestamp string that represents the date-time of the last Message read event for the Member within the Channel
+              # @return [Time] The last_consumption_timestamp
               def last_consumption_timestamp
                 @properties['last_consumption_timestamp']
               end
 
               ##
-              # @return [String] The absolute URL of the Member resource
+              # @return [String] The url
               def url
                 @properties['url']
               end
 
               ##
-              # Fetch a MemberInstance
+              # Fetch the MemberInstance
               # @return [MemberInstance] Fetched MemberInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the MemberInstance
+              # Delete the MemberInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
@@ -433,14 +379,8 @@ module Twilio
 
               ##
               # Update the MemberInstance
-              # @param [String] role_sid The SID of the
-              #   [Role](https://www.twilio.com/docs/api/chat/rest/roles) to assign to the member.
-              #   The default roles are those specified on the
-              #   [Service](https://www.twilio.com/docs/chat/api/services).
-              # @param [String] last_consumed_message_index The index of the last
-              #   [Message](https://www.twilio.com/docs/api/chat/rest/messages) that the Member
-              #   has read within the
-              #   [Channel](https://www.twilio.com/docs/api/chat/rest/channels).
+              # @param [String] role_sid The role_sid
+              # @param [String] last_consumed_message_index The last_consumed_message_index
               # @return [MemberInstance] Updated MemberInstance
               def update(role_sid: :unset, last_consumed_message_index: :unset)
                 context.update(role_sid: role_sid, last_consumed_message_index: last_consumed_message_index, )

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

@@ -16,12 +16,8 @@ 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
-              #   associated with.
-              # @param [String] channel_sid The unique ID of the
-              #   [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the Message
-              #   resource belongs to.
+              # @param [String] service_sid The service_sid
+              # @param [String] channel_sid The channel_sid
               # @return [MessageList] MessageList
               def initialize(version, service_sid: nil, channel_sid: nil)
                 super(version)
@@ -32,25 +28,15 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of MessageInstance records from the API.
-              # Request is executed immediately.
-              # @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
-              #   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
+              # Create the MessageInstance
+              # @param [String] body The body
+              # @param [String] from The from
+              # @param [String] attributes The attributes
+              # @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,
@@ -64,8 +50,7 @@ module Twilio
               # Lists MessageInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [message.OrderType] order The sort order of the returned messages. Can
-              #   be: `asc` (ascending) or `desc` (descending) with `asc` as the default.
+              # @param [message.OrderType] order The order
               # @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
@@ -81,8 +66,7 @@ module Twilio
               # Streams MessageInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [message.OrderType] order The sort order of the returned messages. Can
-              #   be: `asc` (ascending) or `desc` (descending) with `asc` as the default.
+              # @param [message.OrderType] order The order
               # @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
@@ -115,8 +99,7 @@ module Twilio
               ##
               # Retrieve a single page of MessageInstance records from the API.
               # Request is executed immediately.
-              # @param [message.OrderType] order The sort order of the returned messages. Can
-              #   be: `asc` (ascending) or `desc` (descending) with `asc` as the default.
+              # @param [message.OrderType] order The order
               # @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
@@ -128,11 +111,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
 
@@ -194,14 +175,9 @@ 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
-              #   resource from.
-              # @param [String] channel_sid The unique ID of the
-              #   [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.
+              # @param [String] service_sid The service_sid
+              # @param [String] channel_sid The channel_sid
+              # @param [String] sid The sid
               # @return [MessageContext] MessageContext
               def initialize(version, service_sid, channel_sid, sid)
                 super(version)
@@ -212,16 +188,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,28 +203,21 @@ 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
 
               ##
               # Update 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] attributes A valid JSON string that contains
-              #   application-specific data.
+              # @param [String] body The body
+              # @param [String] attributes The attributes
               # @return [MessageInstance] Updated MessageInstance
               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,
@@ -285,14 +248,9 @@ module Twilio
               # Initialize the MessageInstance
               # @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] channel_sid The unique ID of the
-              #   [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.
+              # @param [String] service_sid The service_sid
+              # @param [String] channel_sid The channel_sid
+              # @param [String] sid The sid
               # @return [MessageInstance] MessageInstance
               def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil)
                 super(version)
@@ -340,92 +298,92 @@ 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 JSON string that stores application-specific data
+              # @return [String] The attributes
               def attributes
                 @properties['attributes']
               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 SID of the Channel that the message was sent to
+              # @return [String] The to
               def to
                 @properties['to']
               end
 
               ##
-              # @return [String] The unique ID of the Channel the Message resource belongs to
+              # @return [String] The channel_sid
               def channel_sid
                 @properties['channel_sid']
               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 [Boolean] Whether the message has been edited since  it was created
+              # @return [Boolean] The was_edited
               def was_edited
                 @properties['was_edited']
               end
 
               ##
-              # @return [String] The identity of the message's author
+              # @return [String] The from
               def from
                 @properties['from']
               end
 
               ##
-              # @return [String] The content of the message
+              # @return [String] The body
               def body
                 @properties['body']
               end
 
               ##
-              # @return [String] The index of the message within the Channel
+              # @return [String] The index
               def index
                 @properties['index']
               end
 
               ##
-              # @return [String] The absolute URL of the Message resource
+              # @return [String] The url
               def url
                 @properties['url']
               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
@@ -433,11 +391,8 @@ module Twilio
 
               ##
               # Update 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] attributes A valid JSON string that contains
-              #   application-specific data.
+              # @param [String] body The body
+              # @param [String] attributes The attributes
               # @return [MessageInstance] Updated MessageInstance
               def update(body: :unset, attributes: :unset)
                 context.update(body: body, attributes: attributes, )