twilio-ruby 5.39.2 → 5.60.0

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

@@ -16,14 +16,8 @@ module Twilio
               ##
               # Initialize the UserBindingList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User
-              #   Binding resource is associated with.
-              # @param [String] user_sid The SID of the
-              #   [User](https://www.twilio.com/docs/chat/rest/user-resource) with the User
-              #   Binding resource.  See [push notification
-              #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
-              #   for more info.
+              # @param [String] service_sid The service_sid
+              # @param [String] user_sid The user_sid
               # @return [UserBindingList] UserBindingList
               def initialize(version, service_sid: nil, user_sid: nil)
                 super(version)
@@ -37,11 +31,7 @@ module Twilio
               # Lists UserBindingInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [user_binding.BindingType] binding_type The push technology used by the
-              #   User Binding resources to read. Can be: `apn`, `gcm`, or `fcm`.  See [push
-              #   notification
-              #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
-              #   for more info.
+              # @param [Array[user_binding.BindingType]] binding_type The binding_type
               # @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
@@ -57,11 +47,7 @@ module Twilio
               # Streams UserBindingInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [user_binding.BindingType] binding_type The push technology used by the
-              #   User Binding resources to read. Can be: `apn`, `gcm`, or `fcm`.  See [push
-              #   notification
-              #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
-              #   for more info.
+              # @param [Array[user_binding.BindingType]] binding_type The binding_type
               # @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
@@ -94,11 +80,7 @@ module Twilio
               ##
               # Retrieve a single page of UserBindingInstance records from the API.
               # Request is executed immediately.
-              # @param [user_binding.BindingType] binding_type The push technology used by the
-              #   User Binding resources to read. Can be: `apn`, `gcm`, or `fcm`.  See [push
-              #   notification
-              #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
-              #   for more info.
+              # @param [Array[user_binding.BindingType]] binding_type The binding_type
               # @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
@@ -174,15 +156,9 @@ module Twilio
               ##
               # Initialize the UserBindingContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the
-              #   User Binding resource from.
-              # @param [String] user_sid The SID of the
-              #   [User](https://www.twilio.com/docs/chat/rest/user-resource) with the User
-              #   Binding resource to fetch.  See [push notification
-              #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
-              #   for more info.
-              # @param [String] sid The SID of the User Binding resource to fetch.
+              # @param [String] service_sid The service_sid
+              # @param [String] user_sid The user_sid
+              # @param [String] sid The sid
               # @return [UserBindingContext] UserBindingContext
               def initialize(version, service_sid, user_sid, sid)
                 super(version)
@@ -234,15 +210,9 @@ module Twilio
               # Initialize the UserBindingInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User
-              #   Binding resource is associated with.
-              # @param [String] user_sid The SID of the
-              #   [User](https://www.twilio.com/docs/chat/rest/user-resource) with the User
-              #   Binding resource.  See [push notification
-              #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
-              #   for more info.
-              # @param [String] sid The SID of the User Binding resource to fetch.
+              # @param [String] service_sid The service_sid
+              # @param [String] user_sid The user_sid
+              # @param [String] sid The sid
               # @return [UserBindingInstance] UserBindingInstance
               def initialize(version, payload, service_sid: nil, user_sid: nil, sid: nil)
                 super(version)
@@ -285,73 +255,73 @@ 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 [Time] The ISO 8601 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 ISO 8601 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 unique endpoint identifier for the User Binding
+              # @return [String] The endpoint
               def endpoint
                 @properties['endpoint']
               end
 
               ##
-              # @return [String] The string that identifies the resource's User
+              # @return [String] The identity
               def identity
                 @properties['identity']
               end
 
               ##
-              # @return [String] The SID of the User with the binding
+              # @return [String] The user_sid
               def user_sid
                 @properties['user_sid']
               end
 
               ##
-              # @return [String] The SID of the Credential for the binding
+              # @return [String] The credential_sid
               def credential_sid
                 @properties['credential_sid']
               end
 
               ##
-              # @return [user_binding.BindingType] The push technology to use for the binding
+              # @return [user_binding.BindingType] The binding_type
               def binding_type
                 @properties['binding_type']
               end
 
               ##
-              # @return [String] The Programmable Chat message types the binding is subscribed to
+              # @return [Array[String]] The message_types
               def message_types
                 @properties['message_types']
               end
 
               ##
-              # @return [String] The absolute URL of the User Binding resource
+              # @return [String] The url
               def url
                 @properties['url']
               end

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

@@ -16,12 +16,8 @@ module Twilio
               ##
               # Initialize the UserChannelList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User
-              #   Channel resource is associated with.
-              # @param [String] user_sid The SID of the
-              #   [User](https://www.twilio.com/docs/chat/rest/user-resource) the User Channel
-              #   belongs to.
+              # @param [String] service_sid The service_sid
+              # @param [String] user_sid The user_sid
               # @return [UserChannelList] UserChannelList
               def initialize(version, service_sid: nil, user_sid: nil)
                 super(version)
@@ -156,17 +152,9 @@ module Twilio
               ##
               # Initialize the UserChannelContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the
-              #   User Channel resource from.
-              # @param [String] user_sid The SID of the
-              #   [User](https://www.twilio.com/docs/chat/rest/user-resource) to fetch the User
-              #   Channel resource from. This value can be either the `sid` or the `identity` of
-              #   the User resource.
-              # @param [String] channel_sid The SID of the
-              #   [Channel](https://www.twilio.com/docs/chat/channels) that has the User Channel
-              #   to fetch. This value can be either the `sid` or the `unique_name` of the Channel
-              #   to fetch.
+              # @param [String] service_sid The service_sid
+              # @param [String] user_sid The user_sid
+              # @param [String] channel_sid The channel_sid
               # @return [UserChannelContext] UserChannelContext
               def initialize(version, service_sid, user_sid, channel_sid)
                 super(version)
@@ -200,15 +188,10 @@ module Twilio
 
               ##
               # Update the UserChannelInstance
-              # @param [user_channel.NotificationLevel] notification_level The push notification
-              #   level to assign to the User Channel. Can be: `default` or `muted`.
-              # @param [String] last_consumed_message_index The index of the last
-              #   [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the
-              #   [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read.
-              # @param [Time] last_consumption_timestamp The [ISO
-              #   8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last
-              #   [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for
-              #   the Member within the [Channel](https://www.twilio.com/docs/chat/channels).
+              # @param [user_channel.NotificationLevel] notification_level The
+              #   notification_level
+              # @param [String] last_consumed_message_index The last_consumed_message_index
+              # @param [Time] last_consumption_timestamp The last_consumption_timestamp
               # @return [UserChannelInstance] Updated UserChannelInstance
               def update(notification_level: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset)
                 data = Twilio::Values.of({
@@ -248,16 +231,9 @@ module Twilio
               # Initialize the UserChannelInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User
-              #   Channel resource is associated with.
-              # @param [String] user_sid The SID of the
-              #   [User](https://www.twilio.com/docs/chat/rest/user-resource) the User Channel
-              #   belongs to.
-              # @param [String] channel_sid The SID of the
-              #   [Channel](https://www.twilio.com/docs/chat/channels) that has the User Channel
-              #   to fetch. This value can be either the `sid` or the `unique_name` of the Channel
-              #   to fetch.
+              # @param [String] service_sid The service_sid
+              # @param [String] user_sid The user_sid
+              # @param [String] channel_sid The channel_sid
               # @return [UserChannelInstance] UserChannelInstance
               def initialize(version, payload, service_sid: nil, user_sid: nil, channel_sid: nil)
                 super(version)
@@ -303,67 +279,67 @@ module Twilio
               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 SID of the Channel the resource belongs to
+              # @return [String] The channel_sid
               def channel_sid
                 @properties['channel_sid']
               end
 
               ##
-              # @return [String] The SID of the User the User Channel belongs to
+              # @return [String] The user_sid
               def user_sid
                 @properties['user_sid']
               end
 
               ##
-              # @return [String] The SID of the User as a Member in the Channel
+              # @return [String] The member_sid
               def member_sid
                 @properties['member_sid']
               end
 
               ##
-              # @return [user_channel.ChannelStatus] The status of the User on the Channel
+              # @return [user_channel.ChannelStatus] The status
               def status
                 @properties['status']
               end
 
               ##
-              # @return [String] The index of the last Message in the Channel the Member has read
+              # @return [String] The last_consumed_message_index
               def last_consumed_message_index
                 @properties['last_consumed_message_index']
               end
 
               ##
-              # @return [String] The number of unread Messages in the Channel for the User
+              # @return [String] The unread_messages_count
               def unread_messages_count
                 @properties['unread_messages_count']
               end
 
               ##
-              # @return [String] Absolute URLs to access the Members, Messages , Invites and, if it exists, the last Message for the Channel
+              # @return [String] The links
               def links
                 @properties['links']
               end
 
               ##
-              # @return [String] The absolute URL of the resource
+              # @return [String] The url
               def url
                 @properties['url']
               end
 
               ##
-              # @return [user_channel.NotificationLevel] The push notification level of the User for the Channel
+              # @return [user_channel.NotificationLevel] The notification_level
               def notification_level
                 @properties['notification_level']
               end
@@ -384,15 +360,10 @@ module Twilio
 
               ##
               # Update the UserChannelInstance
-              # @param [user_channel.NotificationLevel] notification_level The push notification
-              #   level to assign to the User Channel. Can be: `default` or `muted`.
-              # @param [String] last_consumed_message_index The index of the last
-              #   [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the
-              #   [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read.
-              # @param [Time] last_consumption_timestamp The [ISO
-              #   8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last
-              #   [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for
-              #   the Member within the [Channel](https://www.twilio.com/docs/chat/channels).
+              # @param [user_channel.NotificationLevel] notification_level The
+              #   notification_level
+              # @param [String] last_consumed_message_index The last_consumed_message_index
+              # @param [Time] last_consumption_timestamp The last_consumption_timestamp
               # @return [UserChannelInstance] Updated UserChannelInstance
               def update(notification_level: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset)
                 context.update(

data/lib/twilio-ruby/rest/ip_messaging/v2/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/chat/rest/service-resource) the User
-            #   resource is associated with.
+            # @param [String] service_sid The service_sid
             # @return [UserList] UserList
             def initialize(version, service_sid: nil)
               super(version)
@@ -29,18 +27,10 @@ module Twilio
 
             ##
             # Create the UserInstance
-            # @param [String] identity The `identity` value that uniquely identifies the new
-            #   resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within
-            #   the [Service](https://www.twilio.com/docs/chat/rest/service-resource). This
-            #   value is often a username or email address. See the Identity documentation for
-            #   more info.
-            # @param [String] role_sid The SID of the
-            #   [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the new
-            #   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.
+            # @param [String] identity The identity
+            # @param [String] role_sid The role_sid
+            # @param [String] attributes The attributes
+            # @param [String] friendly_name The friendly_name
             # @param [user.WebhookEnabledType] x_twilio_webhook_enabled The
             #   X-Twilio-Webhook-Enabled HTTP request header
             # @return [UserInstance] Created UserInstance
@@ -178,11 +168,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/chat/rest/service-resource) to fetch the
-            #   User resource from.
-            # @param [String] sid The SID of the User resource to fetch. This value can be
-            #   either the `sid` or the `identity` of the User resource to fetch.
+            # @param [String] service_sid The service_sid
+            # @param [String] sid The sid
             # @return [UserContext] UserContext
             def initialize(version, service_sid, sid)
               super(version)
@@ -214,13 +201,9 @@ module Twilio
 
             ##
             # Update the UserInstance
-            # @param [String] role_sid The SID of the
-            #   [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the
-            #   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
             # @param [user.WebhookEnabledType] x_twilio_webhook_enabled The
             #   X-Twilio-Webhook-Enabled HTTP request header
             # @return [UserInstance] Updated UserInstance
@@ -301,11 +284,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/chat/rest/service-resource) the User
-            #   resource is associated with.
-            # @param [String] sid The SID of the User resource to fetch. This value can be
-            #   either the `sid` or the `identity` of the User resource to fetch.
+            # @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)
@@ -345,85 +325,85 @@ 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 Role 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 ISO 8601 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 ISO 8601 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 the 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
@@ -444,13 +424,9 @@ module Twilio
 
             ##
             # Update the UserInstance
-            # @param [String] role_sid The SID of the
-            #   [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the
-            #   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
             # @param [user.WebhookEnabledType] x_twilio_webhook_enabled The
             #   X-Twilio-Webhook-Enabled HTTP request header
             # @return [UserInstance] Updated UserInstance