twilio-ruby 5.20.0 → 5.47.0

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -16,11 +16,12 @@ 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
+              # @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] user_sid The unique id of the
-              #   [User](https://www.twilio.com/docs/api/chat/rest/users) this Channel belongs to.
               # @return [UserChannelList] UserChannelList
               def initialize(version, service_sid: nil, user_sid: nil)
                 super(version)
@@ -91,11 +92,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 +156,17 @@ 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 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.
               # @return [UserChannelContext] UserChannelContext
               def initialize(version, service_sid, user_sid, channel_sid)
                 super(version)
@@ -172,16 +177,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 +191,33 @@ 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 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].
               # @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 +234,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Chat.V2.UserChannelContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Chat.V2.UserChannelContext #{context}>"
+              end
             end
 
             class UserChannelInstance < InstanceResource
@@ -228,12 +248,16 @@ 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
+              # @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] 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] 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.
               # @return [UserChannelInstance] UserChannelInstance
               def initialize(version, payload, service_sid: nil, user_sid: nil, channel_sid: nil)
                 super(version)
@@ -279,85 +303,103 @@ module Twilio
               end
 
               ##
-              # @return [String] The unique id of the Account responsible for this channel.
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The unique id of the Service this channel belongs to.
+              # @return [String] The SID of the Service that the resource is associated with
               def service_sid
                 @properties['service_sid']
               end
 
               ##
-              # @return [String] The unique id of a Channel.
+              # @return [String] The SID of the Channel the resource belongs to
               def channel_sid
                 @properties['channel_sid']
               end
 
               ##
-              # @return [String] The unique id of the User this Channel belongs to.
+              # @return [String] The SID of the User the User Channel belongs to
               def user_sid
                 @properties['user_sid']
               end
 
               ##
-              # @return [String] The unique id of this User as a Member in this Channel.
+              # @return [String] The SID of the User as a Member in the Channel
               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 of the User on the Channel
               def status
                 @properties['status']
               end
 
               ##
-              # @return [String] The index of the last read Message in this Channel for this User.
+              # @return [String] The index of the last Message in the Channel the Member has read
               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 number of unread Messages in the Channel for the User
               def unread_messages_count
                 @properties['unread_messages_count']
               end
 
               ##
-              # @return [String] The links
+              # @return [String] Absolute URLs to access the Members, Messages , Invites and, if it exists, the last Message for the Channel
               def links
                 @properties['links']
               end
 
               ##
-              # @return [String] An absolute URL for this User Channel.
+              # @return [String] The absolute URL of the resource
               def url
                 @properties['url']
               end
 
               ##
-              # @return [user_channel.NotificationLevel] The notification level of the User for this Channel.
+              # @return [user_channel.NotificationLevel] The push notification level of the User for the Channel
               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 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].
               # @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
 
               ##

data/lib/twilio-ruby/rest/client.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -11,43 +11,53 @@ module Twilio
     ##
     # A client for accessing the Twilio API.
     class Client
-      attr_accessor :http_client, :username, :password, :account_sid, :auth_token, :region
+      @@default_region = 'us1'
+
+      attr_accessor :http_client, :username, :password, :account_sid, :auth_token, :region, :edge, :logger
 
       ##
       # Initializes the Twilio Client
-      def initialize(username=nil, password=nil, account_sid=nil, region=nil, http_client=Twilio::HTTP::Client.new)
+      def initialize(username=nil, password=nil, account_sid=nil, region=nil, http_client=nil, logger=nil)
         @username = username || Twilio.account_sid
         @password = password || Twilio.auth_token
-        @region = region
+        @region = region || Twilio.region
+        @edge = Twilio.edge
         @account_sid = account_sid || @username
         @auth_token = @password
         @auth = [@username, @password]
-        @http_client = http_client
+        @http_client = http_client || Twilio.http_client || Twilio::HTTP::Client.new
+        @logger = logger || Twilio.logger
 
         # Domains
         @accounts = nil
         @api = nil
-        @authy = nil
         @autopilot = nil
         @chat = nil
+        @conversations = nil
+        @events = nil
         @fax = nil
+        @flex_api = nil
+        @insights = nil
         @ip_messaging = nil
         @lookups = nil
+        @messaging = nil
         @monitor = nil
         @notify = nil
+        @numbers = nil
         @preview = nil
         @pricing = nil
         @proxy = nil
+        @serverless = nil
+        @studio = nil
+        @sync = nil
         @taskrouter = nil
         @trunking = nil
-        @video = nil
-        @messaging = nil
-        @wireless = nil
-        @sync = nil
-        @studio = nil
         @verify = nil
+        @video = nil
         @voice = nil
-        @insights = nil
+        @wireless = nil
+        @supersim = nil
+        @bulkexports = nil
       end
 
       ##
@@ -69,14 +79,26 @@ module Twilio
           headers['Accept'] = 'application/json'
         end
 
-        if !region.nil?
-            head, tail  = uri.split('.', 2)
-            if !tail.start_with?(region)
-                uri = [head, region, tail].join('.')
+        uri = build_uri(uri)
+
+        if @logger
+          @logger.debug("--BEGIN Twilio API Request--")
+          @logger.debug("Request Method: <#{method}>")
+
+          headers.each do |key, value|
+            unless key.downcase == 'authorization'
+              @logger.debug("#{key}:#{value}")
             end
+          end
+
+          url = URI(uri)
+          @logger.debug("Host:#{url.host}")
+          @logger.debug("Path:#{url.path}")
+          @logger.debug("Query:#{url.query}")
+          @logger.debug("Request Params:#{params}")
         end
 
-        @http_client.request(
+        response = @http_client.request(
           host,
           port,
           method,
@@ -87,6 +109,43 @@ module Twilio
           auth,
           timeout
         )
+
+        if @logger
+          @logger.debug("Response Status Code:#{response.status_code}")
+          @logger.debug("Response Headers:#{response.headers}")
+          @logger.debug("--END TWILIO API REQUEST--")
+        end
+
+        response
+      end
+
+      ##
+      # Build the final request uri
+      def build_uri(uri)
+        if @region.nil? and @edge.nil?
+          return uri
+        end
+
+        parsed_url = URI(uri)
+        pieces = parsed_url.host.split('.')
+        product = pieces[0]
+        domain = pieces[-2, 2]
+        new_edge = @edge
+        new_region = @region
+
+        if pieces.length == 4
+          new_region ||= pieces[1]
+        elsif pieces.length == 5
+          new_edge ||= pieces[1]
+          new_region ||= pieces[2]
+        end
+
+        if !new_edge.nil? && new_region.nil?
+          new_region = @@default_region
+        end
+
+        parsed_url.host = [product, new_edge, new_region, domain].select {|item| !item.nil?}.join('.')
+        parsed_url.to_s
       end
 
       ##
@@ -110,12 +169,6 @@ module Twilio
         @api ||= Api.new self
       end
 
-      ##
-      # Access the Authy Twilio Domain
-      def authy
-        @authy ||= Authy.new self
-      end
-
       ##
       # Access the Autopilot Twilio Domain
       def autopilot
@@ -128,12 +181,36 @@ module Twilio
         @chat ||= Chat.new self
       end
 
+      ##
+      # Access the Conversations Twilio Domain
+      def conversations
+        @conversations ||= Conversations.new self
+      end
+
+      ##
+      # Access the Events Twilio Domain
+      def events
+        @events ||= Events.new self
+      end
+
       ##
       # Access the Fax Twilio Domain
       def fax
         @fax ||= Fax.new self
       end
 
+      ##
+      # Access the FlexApi Twilio Domain
+      def flex_api
+        @flex_api ||= FlexApi.new self
+      end
+
+      ##
+      # Access the Insights Twilio Domain
+      def insights
+        @insights ||= Insights.new self
+      end
+
       ##
       # Access the IpMessaging Twilio Domain
       def ip_messaging
@@ -146,6 +223,12 @@ module Twilio
         @lookups ||= Lookups.new self
       end
 
+      ##
+      # Access the Messaging Twilio Domain
+      def messaging
+        @messaging ||= Messaging.new self
+      end
+
       ##
       # Access the Monitor Twilio Domain
       def monitor
@@ -158,6 +241,12 @@ module Twilio
         @notify ||= Notify.new self
       end
 
+      ##
+      # Access the Numbers Twilio Domain
+      def numbers
+        @numbers ||= Numbers.new self
+      end
+
       ##
       # Access the Preview Twilio Domain
       def preview
@@ -176,6 +265,24 @@ module Twilio
         @proxy ||= Proxy.new self
       end
 
+      ##
+      # Access the Serverless Twilio Domain
+      def serverless
+        @serverless ||= Serverless.new self
+      end
+
+      ##
+      # Access the Studio Twilio Domain
+      def studio
+        @studio ||= Studio.new self
+      end
+
+      ##
+      # Access the Sync Twilio Domain
+      def sync
+        @sync ||= Sync.new self
+      end
+
       ##
       # Access the Taskrouter Twilio Domain
       def taskrouter
@@ -188,6 +295,12 @@ module Twilio
         @trunking ||= Trunking.new self
       end
 
+      ##
+      # Access the Verify Twilio Domain
+      def verify
+        @verify ||= Verify.new self
+      end
+
       ##
       # Access the Video Twilio Domain
       def video
@@ -195,9 +308,9 @@ module Twilio
       end
 
       ##
-      # Access the Messaging Twilio Domain
-      def messaging
-        @messaging ||= Messaging.new self
+      # Access the Voice Twilio Domain
+      def voice
+        @voice ||= Voice.new self
       end
 
       ##
@@ -207,33 +320,15 @@ module Twilio
       end
 
       ##
-      # Access the Sync Twilio Domain
-      def sync
-        @sync ||= Sync.new self
-      end
-
-      ##
-      # Access the Studio Twilio Domain
-      def studio
-        @studio ||= Studio.new self
-      end
-
-      ##
-      # Access the Verify Twilio Domain
-      def verify
-        @verify ||= Verify.new self
-      end
-
-      ##
-      # Access the Voice Twilio Domain
-      def voice
-        @voice ||= Voice.new self
+      # Access the Supersim Twilio Domain
+      def supersim
+        @supersim ||= Supersim.new self
       end
 
       ##
-      # Access the Insights Twilio Domain
-      def insights
-        @insights ||= Insights.new self
+      # Access the Bulkexports Twilio Domain
+      def bulkexports
+        @bulkexports ||= Bulkexports.new self
       end
 
       ##
@@ -264,7 +359,7 @@ module Twilio
 
       ##
       # @param [String] country_code The
-      #   [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of
+      #   {ISO-3166-1}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] country code of
       #   the country.
       # @return [Twilio::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryInstance] if country_code was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryList]
@@ -315,8 +410,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this API Key.
-      #    You will use this as the basic-auth `user` when authenticating to the API.
+      # @param [String] sid The unique string that that we created to identify the Key
+      #   resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::KeyInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::KeyList]
       def keys(sid=:unset)
@@ -324,8 +419,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   resource.
+      # @param [String] sid The unique string that that we created to identify the
+      #   Message resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::MessageInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::MessageList]
       def messages(sid=:unset)
@@ -372,8 +467,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   resource.
+      # @param [String] sid The unique string that that we created to identify the
+      #   Recording resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::RecordingInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::RecordingList]
       def recordings(sid=:unset)
@@ -410,7 +505,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A unique 34-character string that identifies this resource.
+      # @param [String] sid The unique string that that we created to identify the
+      #   Transcription resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::TranscriptionInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::TranscriptionList]
       def transcriptions(sid=:unset)