twilio-ruby 5.9.0 → 5.10.0

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

@@ -16,8 +16,12 @@ module Twilio
               ##
               # Initialize the MemberList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] channel_sid The channel_sid
+              # @param [String] service_sid The unique id of the
+              #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/services) this member
+              #   belongs to.
+              # @param [String] channel_sid The unique id of the
+              #   [Channel](https://www.twilio.com/docs/api/chat/rest/v1/channels) for this
+              #   member.
               # @return [MemberList] MemberList
               def initialize(version, service_sid: nil, channel_sid: nil)
                 super(version)
@@ -30,8 +34,14 @@ module Twilio
               ##
               # Retrieve a single page of MemberInstance records from the API.
               # Request is executed immediately.
-              # @param [String] identity The identity
-              # @param [String] role_sid The role_sid
+              # @param [String] identity A unique string identifier for this
+              #   [User](https://www.twilio.com/docs/api/chat/rest/v1/users) in this
+              #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/services). See the
+              #   [access
+              #   tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens)[/docs/api/chat/guides/create-tokens] docs for more details.
+              # @param [String] role_sid The
+              #   [Role](https://www.twilio.com/docs/api/chat/rest/v1/roles) assigned to this
+              #   member.
               # @return [MemberInstance] Newly created MemberInstance
               def create(identity: nil, role_sid: :unset)
                 data = Twilio::Values.of({'Identity' => identity, 'RoleSid' => role_sid, })
@@ -54,7 +64,11 @@ 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 identity
+              # @param [String] identity A unique string identifier for this
+              #   [User](https://www.twilio.com/docs/api/chat/rest/v1/users) in this
+              #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/services). See the
+              #   [access
+              #   tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens)[/docs/api/chat/guides/create-tokens] docs for more details.
               # @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
@@ -70,7 +84,11 @@ 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 identity
+              # @param [String] identity A unique string identifier for this
+              #   [User](https://www.twilio.com/docs/api/chat/rest/v1/users) in this
+              #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/services). See the
+              #   [access
+              #   tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens)[/docs/api/chat/guides/create-tokens] docs for more details.
               # @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
@@ -103,7 +121,11 @@ module Twilio
               ##
               # Retrieve a single page of MemberInstance records from the API.
               # Request is executed immediately.
-              # @param [String] identity The identity
+              # @param [String] identity A unique string identifier for this
+              #   [User](https://www.twilio.com/docs/api/chat/rest/v1/users) in this
+              #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/services). See the
+              #   [access
+              #   tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens)[/docs/api/chat/guides/create-tokens] docs for more details.
               # @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
@@ -223,8 +245,13 @@ module Twilio
 
               ##
               # Update the MemberInstance
-              # @param [String] role_sid The role_sid
-              # @param [String] last_consumed_message_index The last_consumed_message_index
+              # @param [String] role_sid The
+              #   [Role](https://www.twilio.com/docs/api/chat/rest/v1/roles) assigned to this
+              #   member.
+              # @param [String] last_consumed_message_index An Integer representing index of the
+              #   last [Message](https://www.twilio.com/docs/api/chat/rest/v1/messages) this
+              #   Member has read within this
+              #   [Channel](https://www.twilio.com/docs/api/chat/rest/v1/channels)
               # @return [MemberInstance] Updated MemberInstance
               def update(role_sid: :unset, last_consumed_message_index: :unset)
                 data = Twilio::Values.of({
@@ -260,8 +287,12 @@ 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 service_sid
-              # @param [String] channel_sid The channel_sid
+              # @param [String] service_sid The unique id of the
+              #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/services) this member
+              #   belongs to.
+              # @param [String] channel_sid The unique id of the
+              #   [Channel](https://www.twilio.com/docs/api/chat/rest/v1/channels) for this
+              #   member.
               # @param [String] sid The sid
               # @return [MemberInstance] MemberInstance
               def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil)
@@ -308,67 +339,67 @@ module Twilio
               end
 
               ##
-              # @return [String] The sid
+              # @return [String] A 34 character string that uniquely identifies this resource.
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The unique id of the Account responsible for this member.
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The channel_sid
+              # @return [String] The unique id of the Channel for this member.
               def channel_sid
                 @properties['channel_sid']
               end
 
               ##
-              # @return [String] The service_sid
+              # @return [String] The unique id of the Service this member belongs to.
               def service_sid
                 @properties['service_sid']
               end
 
               ##
-              # @return [String] The identity
+              # @return [String] A unique string identifier for this User in this Service.
               def identity
                 @properties['identity']
               end
 
               ##
-              # @return [Time] The date_created
+              # @return [Time] The date that this resource was created.
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date_updated
+              # @return [Time] The date that this resource was last updated.
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [String] The role_sid
+              # @return [String] The Role assigned to this member.
               def role_sid
                 @properties['role_sid']
               end
 
               ##
-              # @return [String] The last_consumed_message_index
+              # @return [String] An Integer representing index of the last Message this Member has read within this Channel
               def last_consumed_message_index
                 @properties['last_consumed_message_index']
               end
 
               ##
-              # @return [Time] The last_consumption_timestamp
+              # @return [Time] An ISO8601 based timestamp string representing the datetime of the last Message read event for this Member within this Channel
               def last_consumption_timestamp
                 @properties['last_consumption_timestamp']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] An absolute URL for this member.
               def url
                 @properties['url']
               end
@@ -389,8 +420,13 @@ module Twilio
 
               ##
               # Update the MemberInstance
-              # @param [String] role_sid The role_sid
-              # @param [String] last_consumed_message_index The last_consumed_message_index
+              # @param [String] role_sid The
+              #   [Role](https://www.twilio.com/docs/api/chat/rest/v1/roles) assigned to this
+              #   member.
+              # @param [String] last_consumed_message_index An Integer representing index of the
+              #   last [Message](https://www.twilio.com/docs/api/chat/rest/v1/messages) this
+              #   Member has read within this
+              #   [Channel](https://www.twilio.com/docs/api/chat/rest/v1/channels)
               # @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,7 +16,9 @@ module Twilio
               ##
               # Initialize the MessageList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
+              # @param [String] service_sid The unique id of the
+              #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/services) this message
+              #   belongs to.
               # @param [String] channel_sid The channel_sid
               # @return [MessageList] MessageList
               def initialize(version, service_sid: nil, channel_sid: nil)
@@ -224,8 +226,11 @@ module Twilio
 
               ##
               # Update the MessageInstance
-              # @param [String] body The body
-              # @param [String] attributes The attributes
+              # @param [String] body The new message body string. You can also send structured
+              #   data by serializing it into a string.
+              # @param [String] attributes The new attributes metadata field you can use to
+              #   store any data you wish.  The string value must contain structurally valid JSON
+              #   if specified.
               # @return [MessageInstance] Updated MessageInstance
               def update(body: :unset, attributes: :unset)
                 data = Twilio::Values.of({'Body' => body, 'Attributes' => attributes, })
@@ -258,7 +263,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 service_sid
+              # @param [String] service_sid The unique id of the
+              #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/services) this message
+              #   belongs to.
               # @param [String] channel_sid The channel_sid
               # @param [String] sid The sid
               # @return [MessageInstance] MessageInstance
@@ -308,31 +315,31 @@ module Twilio
               end
 
               ##
-              # @return [String] The sid
+              # @return [String] A 34 character string that uniquely identifies this resource.
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The unique id of the Account responsible for this message.
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The attributes
+              # @return [String] An optional string metadata field you can use to store any data you wish.
               def attributes
                 @properties['attributes']
               end
 
               ##
-              # @return [String] The service_sid
+              # @return [String] The unique id of the Service this message belongs to.
               def service_sid
                 @properties['service_sid']
               end
 
               ##
-              # @return [String] The to
+              # @return [String] The unique id of the Channel this message was sent to.
               def to
                 @properties['to']
               end
@@ -344,43 +351,43 @@ module Twilio
               end
 
               ##
-              # @return [Time] The date_created
+              # @return [Time] The date that this resource was created.
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date_updated
+              # @return [Time] The date that this resource was last updated.
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [Boolean] The was_edited
+              # @return [Boolean] true if the message has been updated since it was created.
               def was_edited
                 @properties['was_edited']
               end
 
               ##
-              # @return [String] The from
+              # @return [String] The identity of the message's author.
               def from
                 @properties['from']
               end
 
               ##
-              # @return [String] The body
+              # @return [String] The contents of the message.
               def body
                 @properties['body']
               end
 
               ##
-              # @return [String] The index
+              # @return [String] The index of the message within the Channel
               def index
                 @properties['index']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] An absolute URL for this message.
               def url
                 @properties['url']
               end
@@ -401,8 +408,11 @@ module Twilio
 
               ##
               # Update the MessageInstance
-              # @param [String] body The body
-              # @param [String] attributes The attributes
+              # @param [String] body The new message body string. You can also send structured
+              #   data by serializing it into a string.
+              # @param [String] attributes The new attributes metadata field you can use to
+              #   store any data you wish.  The string value must contain structurally valid JSON
+              #   if specified.
               # @return [MessageInstance] Updated MessageInstance
               def update(body: :unset, attributes: :unset)
                 context.update(body: body, attributes: attributes, )

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

@@ -15,7 +15,8 @@ module Twilio
             ##
             # Initialize the ChannelList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
+            # @param [String] service_sid The unique id of the [Service][service] this channel
+            #   belongs to.
             # @return [ChannelList] ChannelList
             def initialize(version, service_sid: nil)
               super(version)
@@ -28,10 +29,13 @@ module Twilio
             ##
             # Retrieve a single page of ChannelInstance records from the API.
             # Request is executed immediately.
-            # @param [String] friendly_name The friendly_name
-            # @param [String] unique_name The unique_name
-            # @param [String] attributes The attributes
-            # @param [channel.ChannelType] type The type
+            # @param [String] friendly_name A human-readable name for the Channel. Optional.
+            # @param [String] unique_name A unique, addressable name for the Channel. 
+            #   Optional.
+            # @param [String] attributes An optional metadata field you can use to store any
+            #   data you wish. No processing or validation is done on this field.
+            # @param [channel.ChannelType] type The visibility of the channel - `public` or
+            #   `private`. Defaults to `public`.
             # @return [ChannelInstance] Newly created ChannelInstance
             def create(friendly_name: :unset, unique_name: :unset, attributes: :unset, type: :unset)
               data = Twilio::Values.of({
@@ -216,9 +220,11 @@ module Twilio
 
             ##
             # Update the ChannelInstance
-            # @param [String] friendly_name The friendly_name
-            # @param [String] unique_name The unique_name
-            # @param [String] attributes The attributes
+            # @param [String] friendly_name A human-readable name for the Channel. Optional.
+            # @param [String] unique_name A unique, addressable name for the Channel. 
+            #   Optional.
+            # @param [String] attributes An optional metadata field you can use to store any
+            #   data you wish. No processing or validation is done on this field.
             # @return [ChannelInstance] Updated ChannelInstance
             def update(friendly_name: :unset, unique_name: :unset, attributes: :unset)
               data = Twilio::Values.of({
@@ -315,7 +321,8 @@ module Twilio
             # Initialize the ChannelInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] service_sid The service_sid
+            # @param [String] service_sid The unique id of the [Service][service] this channel
+            #   belongs to.
             # @param [String] sid The sid
             # @return [ChannelInstance] ChannelInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
@@ -356,61 +363,61 @@ module Twilio
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] A 34 character string that uniquely identifies this resource.
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The unique id of the [Account][/console] responsible for this channel.
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The service_sid
+            # @return [String] The unique id of the [Service][service] this channel belongs to.
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] The human-readable name of this channel.
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The unique_name
+            # @return [String] The unique, addressable name of this channel.
             def unique_name
               @properties['unique_name']
             end
 
             ##
-            # @return [String] The attributes
+            # @return [String] An optional string metadata field you can use to store any data you wish.
             def attributes
               @properties['attributes']
             end
 
             ##
-            # @return [channel.ChannelType] The type
+            # @return [channel.ChannelType] The visibility of this channel - either public or private
             def type
               @properties['type']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The date that this resource was created.
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The date that this resource was last updated.
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The created_by
+            # @return [String] Identity of the channel's creator.
             def created_by
               @properties['created_by']
             end
@@ -428,13 +435,13 @@ module Twilio
             end
 
             ##
-            # @return [String] The url
+            # @return [String] An absolute URL for this channel.
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] Absolute URLs to access the [Members][members] and [Messages][messages] for this channel.
             def links
               @properties['links']
             end
@@ -455,9 +462,11 @@ module Twilio
 
             ##
             # Update the ChannelInstance
-            # @param [String] friendly_name The friendly_name
-            # @param [String] unique_name The unique_name
-            # @param [String] attributes The attributes
+            # @param [String] friendly_name A human-readable name for the Channel. Optional.
+            # @param [String] unique_name A unique, addressable name for the Channel. 
+            #   Optional.
+            # @param [String] attributes An optional metadata field you can use to store any
+            #   data you wish. No processing or validation is done on this field.
             # @return [ChannelInstance] Updated ChannelInstance
             def update(friendly_name: :unset, unique_name: :unset, attributes: :unset)
               context.update(friendly_name: friendly_name, unique_name: unique_name, attributes: attributes, )