twilio-ruby 5.15.1 → 5.58.1

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -16,14 +16,8 @@ module Twilio
               ##
               # Initialize the UserBindingList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The unique id of the
-              #   [Service](https://www.twilio.com/docs/api/chat/rest/services) this binding
-              #   belongs to.
-              # @param [String] user_sid The unique id of the
-              #   [User](https://www.twilio.com/docs/api/chat/rest/users) for this binding.  See
-              #   [push notification
-              #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
-              #   for more information.
+              # @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 for the
-              #   returned Bindings.  Supported values are apn, gcm and fcm.  See [push
-              #   notification
-              #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
-              #   for more information.
+              # @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 for the
-              #   returned Bindings.  Supported values are apn, gcm and fcm.  See [push
-              #   notification
-              #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
-              #   for more information.
+              # @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 for the
-              #   returned Bindings.  Supported values are apn, gcm and fcm.  See [push
-              #   notification
-              #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
-              #   for more information.
+              # @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
@@ -110,11 +92,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 UserBindingPage.new(@version, response, @solution)
               end
 
@@ -189,16 +169,10 @@ module Twilio
               end
 
               ##
-              # Fetch a UserBindingInstance
+              # Fetch the UserBindingInstance
               # @return [UserBindingInstance] Fetched UserBindingInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 UserBindingInstance.new(
                     @version,
@@ -210,10 +184,10 @@ module Twilio
               end
 
               ##
-              # Deletes the UserBindingInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the UserBindingInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -222,6 +196,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.IpMessaging.V2.UserBindingContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.IpMessaging.V2.UserBindingContext #{context}>"
+              end
             end
 
             class UserBindingInstance < InstanceResource
@@ -229,14 +210,8 @@ 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 unique id of the
-              #   [Service](https://www.twilio.com/docs/api/chat/rest/services) this binding
-              #   belongs to.
-              # @param [String] user_sid The unique id of the
-              #   [User](https://www.twilio.com/docs/api/chat/rest/users) for this binding.  See
-              #   [push notification
-              #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
-              #   for more information.
+              # @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)
@@ -280,87 +255,87 @@ module Twilio
               end
 
               ##
-              # @return [String] A 34 character string that uniquely identifies this resource.
+              # @return [String] The sid
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] The unique id of the Account responsible for this binding.
+              # @return [String] The account_sid
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The unique id of the Service this binding belongs to.
+              # @return [String] The service_sid
               def service_sid
                 @properties['service_sid']
               end
 
               ##
-              # @return [Time] The date that this resource was created.
+              # @return [Time] The date_created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date that this resource was last updated.
+              # @return [Time] The date_updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [String] The unique endpoint identifier for this Binding.
+              # @return [String] The endpoint
               def endpoint
                 @properties['endpoint']
               end
 
               ##
-              # @return [String] A unique string identifier for the Binding for this User in this Service.
+              # @return [String] The identity
               def identity
                 @properties['identity']
               end
 
               ##
-              # @return [String] The unique id of the User for this binding.
+              # @return [String] The user_sid
               def user_sid
                 @properties['user_sid']
               end
 
               ##
-              # @return [String] The unique id of the Credential for this binding.
+              # @return [String] The credential_sid
               def credential_sid
                 @properties['credential_sid']
               end
 
               ##
-              # @return [user_binding.BindingType] The push technology to use for this binding.
+              # @return [user_binding.BindingType] The binding_type
               def binding_type
                 @properties['binding_type']
               end
 
               ##
-              # @return [String] List of message types for this binding.
+              # @return [Array[String]] The message_types
               def message_types
                 @properties['message_types']
               end
 
               ##
-              # @return [String] An absolute URL for this binding.
+              # @return [String] The url
               def url
                 @properties['url']
               end
 
               ##
-              # Fetch a UserBindingInstance
+              # Fetch the UserBindingInstance
               # @return [UserBindingInstance] Fetched UserBindingInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the UserBindingInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the UserBindingInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -16,11 +16,8 @@ module Twilio
               ##
               # Initialize the UserChannelList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The unique id of the
-              #   [Service](https://www.twilio.com/docs/api/chat/rest/services) this channel
-              #   belongs to.
-              # @param [String] user_sid The unique id of the
-              #   [User](https://www.twilio.com/docs/api/chat/rest/users) this 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)
@@ -91,11 +88,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 UserChannelPage.new(@version, response, @solution)
               end
 
@@ -157,11 +152,9 @@ module Twilio
               ##
               # Initialize the UserChannelContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The unique id of the
-              #   [Service](https://www.twilio.com/docs/api/chat/rest/services) those channels
-              #   belong to.
-              # @param [String] user_sid The unique id of a User.
-              # @param [String] channel_sid The unique id of a Channel.
+              # @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)
@@ -172,16 +165,10 @@ module Twilio
               end
 
               ##
-              # Fetch a UserChannelInstance
+              # Fetch the UserChannelInstance
               # @return [UserChannelInstance] Fetched UserChannelInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 UserChannelInstance.new(
                     @version,
@@ -192,19 +179,28 @@ module Twilio
                 )
               end
 
+              ##
+              # Delete the UserChannelInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
+              def delete
+                 @version.delete('DELETE', @uri)
+              end
+
               ##
               # Update the UserChannelInstance
-              # @param [user_channel.NotificationLevel] notification_level Push notification
-              #   level to be assigned to Channel of the User.
+              # @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: nil)
-                data = Twilio::Values.of({'NotificationLevel' => notification_level, })
+              def update(notification_level: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset)
+                data = Twilio::Values.of({
+                    'NotificationLevel' => notification_level,
+                    'LastConsumedMessageIndex' => last_consumed_message_index,
+                    'LastConsumptionTimestamp' => Twilio.serialize_iso8601_datetime(last_consumption_timestamp),
+                })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data)
 
                 UserChannelInstance.new(
                     @version,
@@ -221,6 +217,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.IpMessaging.V2.UserChannelContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.IpMessaging.V2.UserChannelContext #{context}>"
+              end
             end
 
             class UserChannelInstance < InstanceResource
@@ -228,12 +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 unique id of the
-              #   [Service](https://www.twilio.com/docs/api/chat/rest/services) this channel
-              #   belongs to.
-              # @param [String] user_sid The unique id of the
-              #   [User](https://www.twilio.com/docs/api/chat/rest/users) this Channel belongs to.
-              # @param [String] channel_sid The unique id of a Channel.
+              # @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)
@@ -279,49 +279,49 @@ module Twilio
               end
 
               ##
-              # @return [String] The unique id of the Account responsible for this channel.
+              # @return [String] The account_sid
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The unique id of the Service this channel belongs to.
+              # @return [String] The service_sid
               def service_sid
                 @properties['service_sid']
               end
 
               ##
-              # @return [String] The unique id of a Channel.
+              # @return [String] The channel_sid
               def channel_sid
                 @properties['channel_sid']
               end
 
               ##
-              # @return [String] The unique id of the User this Channel belongs to.
+              # @return [String] The user_sid
               def user_sid
                 @properties['user_sid']
               end
 
               ##
-              # @return [String] The unique id of this User as a Member in this Channel.
+              # @return [String] The member_sid
               def member_sid
                 @properties['member_sid']
               end
 
               ##
-              # @return [user_channel.ChannelStatus] The status of the User on this Channel.
+              # @return [user_channel.ChannelStatus] The status
               def status
                 @properties['status']
               end
 
               ##
-              # @return [String] The index of the last read Message in this Channel for this User.
+              # @return [String] The last_consumed_message_index
               def last_consumed_message_index
                 @properties['last_consumed_message_index']
               end
 
               ##
-              # @return [String] The count of unread Messages in this Channel for this User.
+              # @return [String] The unread_messages_count
               def unread_messages_count
                 @properties['unread_messages_count']
               end
@@ -333,31 +333,44 @@ module Twilio
               end
 
               ##
-              # @return [String] An absolute URL for this User Channel.
+              # @return [String] The url
               def url
                 @properties['url']
               end
 
               ##
-              # @return [user_channel.NotificationLevel] The notification level of the User for this Channel.
+              # @return [user_channel.NotificationLevel] The notification_level
               def notification_level
                 @properties['notification_level']
               end
 
               ##
-              # Fetch a UserChannelInstance
+              # Fetch the UserChannelInstance
               # @return [UserChannelInstance] Fetched UserChannelInstance
               def fetch
                 context.fetch
               end
 
+              ##
+              # Delete the UserChannelInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
+              def delete
+                context.delete
+              end
+
               ##
               # Update the UserChannelInstance
-              # @param [user_channel.NotificationLevel] notification_level Push notification
-              #   level to be assigned to Channel of the User.
+              # @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: nil)
-                context.update(notification_level: notification_level, )
+              def update(notification_level: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset)
+                context.update(
+                    notification_level: notification_level,
+                    last_consumed_message_index: last_consumed_message_index,
+                    last_consumption_timestamp: last_consumption_timestamp,
+                )
               end
 
               ##