twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -29,7 +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 binding_type
+              # @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
@@ -45,7 +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 binding_type
+              # @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
@@ -56,7 +58,7 @@ module Twilio
               def stream(binding_type: :unset, limit: nil, page_size: nil)
                 limits = @version.read_limits(limit, page_size)
 
-                page = self.page(binding_type: binding_type, page_size: limits[:page_size])
+                page = self.page(binding_type: binding_type, page_size: limits[:page_size], )
 
                 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
               end
@@ -68,7 +70,7 @@ module Twilio
               def each
                 limits = @version.read_limits
 
-                page = self.page(page_size: limits[:page_size])
+                page = self.page(page_size: limits[:page_size], )
 
                 @version.stream(page,
                                 limit: limits[:limit],
@@ -78,7 +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 binding_type
+              # @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
@@ -90,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
 
@@ -164,21 +164,15 @@ module Twilio
                 super(version)
 
                 # Path Solution
-                @solution = {service_sid: service_sid, user_sid: user_sid, sid: sid}
+                @solution = {service_sid: service_sid, user_sid: user_sid, sid: sid, }
                 @uri = "/Services/#{@solution[:service_sid]}/Users/#{@solution[:user_sid]}/Bindings/#{@solution[:sid]}"
               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,
@@ -190,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
 
               ##
@@ -202,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
@@ -234,7 +235,7 @@ module Twilio
 
                 # Context
                 @instance_context = nil
-                @params = {'service_sid' => service_sid, 'user_sid' => user_sid, 'sid' => sid || @properties['sid']}
+                @params = {'service_sid' => service_sid, 'user_sid' => user_sid, 'sid' => sid || @properties['sid'], }
               end
 
               ##
@@ -314,7 +315,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The message_types
+              # @return [Array[String]] The message_types
               def message_types
                 @properties['message_types']
               end
@@ -326,15 +327,15 @@ module Twilio
               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,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -15,7 +17,7 @@ module Twilio
               # Initialize the UserChannelList
               # @param [Version] version Version that contains the resource
               # @param [String] service_sid The service_sid
-              # @param [String] user_sid The sid
+              # @param [String] user_sid The user_sid
               # @return [UserChannelList] UserChannelList
               def initialize(version, service_sid: nil, user_sid: nil)
                 super(version)
@@ -54,7 +56,7 @@ module Twilio
               def stream(limit: nil, page_size: nil)
                 limits = @version.read_limits(limit, page_size)
 
-                page = self.page(page_size: limits[:page_size])
+                page = self.page(page_size: limits[:page_size], )
 
                 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
               end
@@ -66,7 +68,7 @@ module Twilio
               def each
                 limits = @version.read_limits
 
-                page = self.page(page_size: limits[:page_size])
+                page = self.page(page_size: limits[:page_size], )
 
                 @version.stream(page,
                                 limit: limits[:limit],
@@ -86,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
 
@@ -148,15 +148,94 @@ module Twilio
               end
             end
 
+            class UserChannelContext < InstanceContext
+              ##
+              # Initialize the UserChannelContext
+              # @param [Version] version Version that contains the resource
+              # @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)
+
+                # Path Solution
+                @solution = {service_sid: service_sid, user_sid: user_sid, channel_sid: channel_sid, }
+                @uri = "/Services/#{@solution[:service_sid]}/Users/#{@solution[:user_sid]}/Channels/#{@solution[:channel_sid]}"
+              end
+
+              ##
+              # Fetch the UserChannelInstance
+              # @return [UserChannelInstance] Fetched UserChannelInstance
+              def fetch
+                payload = @version.fetch('GET', @uri)
+
+                UserChannelInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    user_sid: @solution[:user_sid],
+                    channel_sid: @solution[:channel_sid],
+                )
+              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 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({
+                    'NotificationLevel' => notification_level,
+                    'LastConsumedMessageIndex' => last_consumed_message_index,
+                    'LastConsumptionTimestamp' => Twilio.serialize_iso8601_datetime(last_consumption_timestamp),
+                })
+
+                payload = @version.update('POST', @uri, data: data)
+
+                UserChannelInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    user_sid: @solution[:user_sid],
+                    channel_sid: @solution[:channel_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                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
               ##
               # 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 service_sid
-              # @param [String] user_sid The 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)
+              def initialize(version, payload, service_sid: nil, user_sid: nil, channel_sid: nil)
                 super(version)
 
                 # Marshaled Properties
@@ -164,14 +243,41 @@ module Twilio
                     'account_sid' => payload['account_sid'],
                     'service_sid' => payload['service_sid'],
                     'channel_sid' => payload['channel_sid'],
+                    'user_sid' => payload['user_sid'],
                     'member_sid' => payload['member_sid'],
                     'status' => payload['status'],
                     'last_consumed_message_index' => payload['last_consumed_message_index'] == nil ? payload['last_consumed_message_index'] : payload['last_consumed_message_index'].to_i,
                     'unread_messages_count' => payload['unread_messages_count'] == nil ? payload['unread_messages_count'] : payload['unread_messages_count'].to_i,
                     'links' => payload['links'],
+                    'url' => payload['url'],
+                    'notification_level' => payload['notification_level'],
+                }
+
+                # Context
+                @instance_context = nil
+                @params = {
+                    'service_sid' => service_sid,
+                    'user_sid' => user_sid,
+                    'channel_sid' => channel_sid || @properties['channel_sid'],
                 }
               end
 
+              ##
+              # Generate an instance context for the instance, the context is capable of
+              # performing various actions.  All instance actions are proxied to the context
+              # @return [UserChannelContext] UserChannelContext for this UserChannelInstance
+              def context
+                unless @instance_context
+                  @instance_context = UserChannelContext.new(
+                      @version,
+                      @params['service_sid'],
+                      @params['user_sid'],
+                      @params['channel_sid'],
+                  )
+                end
+                @instance_context
+              end
+
               ##
               # @return [String] The account_sid
               def account_sid
@@ -190,6 +296,12 @@ module Twilio
                 @properties['channel_sid']
               end
 
+              ##
+              # @return [String] The user_sid
+              def user_sid
+                @properties['user_sid']
+              end
+
               ##
               # @return [String] The member_sid
               def member_sid
@@ -220,16 +332,59 @@ module Twilio
                 @properties['links']
               end
 
+              ##
+              # @return [String] The url
+              def url
+                @properties['url']
+              end
+
+              ##
+              # @return [user_channel.NotificationLevel] The notification_level
+              def notification_level
+                @properties['notification_level']
+              end
+
+              ##
+              # 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 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(
+                    notification_level: notification_level,
+                    last_consumed_message_index: last_consumed_message_index,
+                    last_consumption_timestamp: last_consumption_timestamp,
+                )
+              end
+
               ##
               # Provide a user friendly representation
               def to_s
-                "<Twilio.IpMessaging.V2.UserChannelInstance>"
+                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.IpMessaging.V2.UserChannelInstance #{values}>"
               end
 
               ##
               # Provide a detailed, user friendly representation
               def inspect
-                "<Twilio.IpMessaging.V2.UserChannelInstance>"
+                values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.IpMessaging.V2.UserChannelInstance #{values}>"
               end
             end
           end

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -24,28 +26,26 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of UserInstance records from the API.
-            # Request is executed immediately.
+            # Create the UserInstance
             # @param [String] identity The identity
             # @param [String] role_sid The role_sid
             # @param [String] attributes The attributes
             # @param [String] friendly_name The friendly_name
-            # @return [UserInstance] Newly created UserInstance
-            def create(identity: nil, role_sid: :unset, attributes: :unset, friendly_name: :unset)
+            # @param [user.WebhookEnabledType] x_twilio_webhook_enabled The
+            #   X-Twilio-Webhook-Enabled HTTP request header
+            # @return [UserInstance] Created UserInstance
+            def create(identity: nil, role_sid: :unset, attributes: :unset, friendly_name: :unset, x_twilio_webhook_enabled: :unset)
               data = Twilio::Values.of({
                   'Identity' => identity,
                   'RoleSid' => role_sid,
                   'Attributes' => attributes,
                   'FriendlyName' => friendly_name,
               })
+              headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data, headers: headers)
 
-              UserInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              UserInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -77,7 +77,7 @@ module Twilio
             def stream(limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(page_size: limits[:page_size])
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -89,7 +89,7 @@ module Twilio
             def each
               limits = @version.read_limits
 
-              page = self.page(page_size: limits[:page_size])
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page,
                               limit: limits[:limit],
@@ -109,11 +109,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               UserPage.new(@version, response, @solution)
             end
 
@@ -156,7 +154,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [UserInstance] UserInstance
             def get_instance(payload)
-              UserInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              UserInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -177,7 +175,7 @@ module Twilio
               super(version)
 
               # Path Solution
-              @solution = {service_sid: service_sid, sid: sid}
+              @solution = {service_sid: service_sid, sid: sid, }
               @uri = "/Services/#{@solution[:service_sid]}/Users/#{@solution[:sid]}"
 
               # Dependents
@@ -186,25 +184,19 @@ module Twilio
             end
 
             ##
-            # Fetch a UserInstance
+            # Fetch the UserInstance
             # @return [UserInstance] Fetched UserInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
-              UserInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+              UserInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the UserInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the UserInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -212,28 +204,33 @@ module Twilio
             # @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
-            def update(role_sid: :unset, attributes: :unset, friendly_name: :unset)
+            def update(role_sid: :unset, attributes: :unset, friendly_name: :unset, x_twilio_webhook_enabled: :unset)
               data = Twilio::Values.of({
                   'RoleSid' => role_sid,
                   'Attributes' => attributes,
                   'FriendlyName' => friendly_name,
               })
+              headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data, headers: headers)
 
-              UserInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+              UserInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
             # Access the user_channels
             # @return [UserChannelList]
-            # @return [UserChannelContext]
-            def user_channels
+            # @return [UserChannelContext] if channel_sid was passed.
+            def user_channels(channel_sid=:unset)
+              raise ArgumentError, 'channel_sid cannot be nil' if channel_sid.nil?
+
+              if channel_sid != :unset
+                return UserChannelContext.new(@version, @solution[:service_sid], @solution[:sid], channel_sid, )
+              end
+
               unless @user_channels
                 @user_channels = UserChannelList.new(
                     @version,
@@ -253,7 +250,7 @@ module Twilio
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return UserBindingContext.new(@version, @solution[:service_sid], @solution[:sid], sid)
+                return UserBindingContext.new(@version, @solution[:service_sid], @solution[:sid], sid, )
               end
 
               unless @user_bindings
@@ -273,6 +270,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.IpMessaging.V2.UserContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.IpMessaging.V2.UserContext #{context}>"
+            end
           end
 
           class UserInstance < InstanceResource
@@ -306,7 +310,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid']}
+              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -315,7 +319,7 @@ module Twilio
             # @return [UserContext] UserContext for this UserInstance
             def context
               unless @instance_context
-                @instance_context = UserContext.new(@version, @params['service_sid'], @params['sid'])
+                @instance_context = UserContext.new(@version, @params['service_sid'], @params['sid'], )
               end
               @instance_context
             end
@@ -405,15 +409,15 @@ module Twilio
             end
 
             ##
-            # Fetch a UserInstance
+            # Fetch the UserInstance
             # @return [UserInstance] Fetched UserInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the UserInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the UserInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
@@ -423,9 +427,16 @@ module Twilio
             # @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
-            def update(role_sid: :unset, attributes: :unset, friendly_name: :unset)
-              context.update(role_sid: role_sid, attributes: attributes, friendly_name: friendly_name)
+            def update(role_sid: :unset, attributes: :unset, friendly_name: :unset, x_twilio_webhook_enabled: :unset)
+              context.update(
+                  role_sid: role_sid,
+                  attributes: attributes,
+                  friendly_name: friendly_name,
+                  x_twilio_webhook_enabled: x_twilio_webhook_enabled,
+              )
             end
 
             ##