twilio-ruby 5.39.2 → 5.60.0

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

@@ -193,22 +193,22 @@ module Twilio
           # @param [String] friendly_name A descriptive string that you create to describe
           #   the resource.
           # @param [String] default_service_role_sid The service role assigned to users when
-          #   they are added to the service. See the [Role
-          #   resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
+          #   they are added to the service. See the {Role
+          #   resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info
           #   about roles.
           # @param [String] default_channel_role_sid The channel role assigned to users when
-          #   they are added to a channel. See the [Role
-          #   resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
+          #   they are added to a channel. See the {Role
+          #   resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info
           #   about roles.
           # @param [String] default_channel_creator_role_sid The channel role assigned to a
-          #   channel creator when they join a new channel. See the [Role
-          #   resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
+          #   channel creator when they join a new channel. See the {Role
+          #   resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info
           #   about roles.
-          # @param [Boolean] read_status_enabled Whether to enable the [Message Consumption
-          #   Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The
+          # @param [Boolean] read_status_enabled Whether to enable the {Message Consumption
+          #   Horizon}[https://www.twilio.com/docs/chat/consumption-horizon] feature. The
           #   default is `true`.
-          # @param [Boolean] reachability_enabled Whether to enable the [Reachability
-          #   Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this
+          # @param [Boolean] reachability_enabled Whether to enable the {Reachability
+          #   Indicator}[https://www.twilio.com/docs/chat/reachability-indicator] for this
           #   Service instance. The default is `false`.
           # @param [String] typing_indicator_timeout How long in seconds after a `started
           #   typing` event until clients should assume that user is no longer typing, even if
@@ -251,18 +251,18 @@ module Twilio
           #   play when a user is invited to a channel and
           #   `notifications.invited_to_channel.enabled` is `true`.
           # @param [String] pre_webhook_url The URL for pre-event webhooks, which are called
-          #   by using the `webhook_method`. See [Webhook
-          #   Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
+          #   by using the `webhook_method`. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
           # @param [String] post_webhook_url The URL for post-event webhooks, which are
-          #   called by using the `webhook_method`. See [Webhook
-          #   Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
+          #   called by using the `webhook_method`. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
           # @param [String] webhook_method The HTTP method to use for calls to the
           #   `pre_webhook_url` and `post_webhook_url` webhooks.  Can be: `POST` or `GET` and
-          #   the default is `POST`. See [Webhook
-          #   Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
-          # @param [String] webhook_filters The list of webhook events that are enabled for
-          #   this Service instance. See [Webhook
-          #   Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
+          #   the default is `POST`. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
+          # @param [Array[String]] webhook_filters The list of webhook events that are
+          #   enabled for this Service instance. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
           # @param [String] limits_channel_members The maximum number of Members that can be
           #   added to Channels within this Service. Can be up to 1,000.
           # @param [String] limits_user_channels The maximum number of Channels Users can be
@@ -557,7 +557,7 @@ module Twilio
           end
 
           ##
-          # @return [String] The list of webhook events that are enabled for this Service instance
+          # @return [Array[String]] The list of webhook events that are enabled for this Service instance
           def webhook_filters
             @properties['webhook_filters']
           end
@@ -617,22 +617,22 @@ module Twilio
           # @param [String] friendly_name A descriptive string that you create to describe
           #   the resource.
           # @param [String] default_service_role_sid The service role assigned to users when
-          #   they are added to the service. See the [Role
-          #   resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
+          #   they are added to the service. See the {Role
+          #   resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info
           #   about roles.
           # @param [String] default_channel_role_sid The channel role assigned to users when
-          #   they are added to a channel. See the [Role
-          #   resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
+          #   they are added to a channel. See the {Role
+          #   resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info
           #   about roles.
           # @param [String] default_channel_creator_role_sid The channel role assigned to a
-          #   channel creator when they join a new channel. See the [Role
-          #   resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
+          #   channel creator when they join a new channel. See the {Role
+          #   resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info
           #   about roles.
-          # @param [Boolean] read_status_enabled Whether to enable the [Message Consumption
-          #   Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The
+          # @param [Boolean] read_status_enabled Whether to enable the {Message Consumption
+          #   Horizon}[https://www.twilio.com/docs/chat/consumption-horizon] feature. The
           #   default is `true`.
-          # @param [Boolean] reachability_enabled Whether to enable the [Reachability
-          #   Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this
+          # @param [Boolean] reachability_enabled Whether to enable the {Reachability
+          #   Indicator}[https://www.twilio.com/docs/chat/reachability-indicator] for this
           #   Service instance. The default is `false`.
           # @param [String] typing_indicator_timeout How long in seconds after a `started
           #   typing` event until clients should assume that user is no longer typing, even if
@@ -675,18 +675,18 @@ module Twilio
           #   play when a user is invited to a channel and
           #   `notifications.invited_to_channel.enabled` is `true`.
           # @param [String] pre_webhook_url The URL for pre-event webhooks, which are called
-          #   by using the `webhook_method`. See [Webhook
-          #   Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
+          #   by using the `webhook_method`. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
           # @param [String] post_webhook_url The URL for post-event webhooks, which are
-          #   called by using the `webhook_method`. See [Webhook
-          #   Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
+          #   called by using the `webhook_method`. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
           # @param [String] webhook_method The HTTP method to use for calls to the
           #   `pre_webhook_url` and `post_webhook_url` webhooks.  Can be: `POST` or `GET` and
-          #   the default is `POST`. See [Webhook
-          #   Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
-          # @param [String] webhook_filters The list of webhook events that are enabled for
-          #   this Service instance. See [Webhook
-          #   Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
+          #   the default is `POST`. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
+          # @param [Array[String]] webhook_filters The list of webhook events that are
+          #   enabled for this Service instance. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
           # @param [String] limits_channel_members The maximum number of Members that can be
           #   added to Channels within this Service. Can be up to 1,000.
           # @param [String] limits_user_channels The maximum number of Channels Users can be

data/lib/twilio-ruby/rest/chat/v2.rb

@@ -25,11 +25,12 @@ module Twilio
         # @return [Twilio::REST::Chat::V2::CredentialList]
         def credentials(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @credentials ||= CredentialList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @credentials ||= CredentialList.new self
           else
-            CredentialContext.new(self, sid)
+              CredentialContext.new(self, sid)
           end
         end
 
@@ -39,11 +40,12 @@ module Twilio
         # @return [Twilio::REST::Chat::V2::ServiceList]
         def services(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @services ||= ServiceList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @services ||= ServiceList.new self
           else
-            ServiceContext.new(self, sid)
+              ServiceContext.new(self, sid)
           end
         end
 

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

@@ -13,11 +13,11 @@ module Twilio
     class Client
       @@default_region = 'us1'
 
-      attr_accessor :http_client, :username, :password, :account_sid, :auth_token, :region, :edge
+      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=nil)
+      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 || Twilio.region
@@ -26,6 +26,7 @@ module Twilio
         @auth_token = @password
         @auth = [@username, @password]
         @http_client = http_client || Twilio.http_client || Twilio::HTTP::Client.new
+        @logger = logger || Twilio.logger
 
         # Domains
         @accounts = nil
@@ -33,11 +34,14 @@ module Twilio
         @autopilot = nil
         @chat = nil
         @conversations = nil
+        @events = nil
         @fax = nil
         @flex_api = nil
+        @frontline_api = nil
         @insights = nil
         @ip_messaging = nil
         @lookups = nil
+        @media = nil
         @messaging = nil
         @monitor = nil
         @notify = nil
@@ -50,6 +54,7 @@ module Twilio
         @sync = nil
         @taskrouter = nil
         @trunking = nil
+        @trusthub = nil
         @verify = nil
         @video = nil
         @voice = nil
@@ -79,7 +84,24 @@ module Twilio
 
         uri = build_uri(uri)
 
-        @http_client.request(
+        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
+
+        response = @http_client.request(
           host,
           port,
           method,
@@ -90,6 +112,14 @@ 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
 
       ##
@@ -160,6 +190,12 @@ module Twilio
         @conversations ||= Conversations.new self
       end
 
+      ##
+      # Access the Events Twilio Domain
+      def events
+        @events ||= Events.new self
+      end
+
       ##
       # Access the Fax Twilio Domain
       def fax
@@ -172,6 +208,12 @@ module Twilio
         @flex_api ||= FlexApi.new self
       end
 
+      ##
+      # Access the FrontlineApi Twilio Domain
+      def frontline_api
+        @frontline_api ||= FrontlineApi.new self
+      end
+
       ##
       # Access the Insights Twilio Domain
       def insights
@@ -190,6 +232,12 @@ module Twilio
         @lookups ||= Lookups.new self
       end
 
+      ##
+      # Access the Media Twilio Domain
+      def media
+        @media ||= Media.new self
+      end
+
       ##
       # Access the Messaging Twilio Domain
       def messaging
@@ -262,6 +310,12 @@ module Twilio
         @trunking ||= Trunking.new self
       end
 
+      ##
+      # Access the Trusthub Twilio Domain
+      def trusthub
+        @trusthub ||= Trusthub.new self
+      end
+
       ##
       # Access the Verify Twilio Domain
       def verify
@@ -326,7 +380,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]
@@ -341,7 +395,7 @@ module Twilio
       end
 
       ##
-      # @param [String] sid The unique string that that we created to identify this Call
+      # @param [String] sid The unique string that we created to identify this Call
       #   resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::CallInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::CallList]

data/lib/twilio-ruby/rest/conversations/v1/configuration/webhook.rb

@@ -0,0 +1,254 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Conversations < Domain
+      class V1 < Version
+        class ConfigurationContext < InstanceContext
+          class WebhookList < ListResource
+            ##
+            # Initialize the WebhookList
+            # @param [Version] version Version that contains the resource
+            # @return [WebhookList] WebhookList
+            def initialize(version)
+              super(version)
+
+              # Path Solution
+              @solution = {}
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Conversations.V1.WebhookList>'
+            end
+          end
+
+          class WebhookPage < Page
+            ##
+            # Initialize the WebhookPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [WebhookPage] WebhookPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of WebhookInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [WebhookInstance] WebhookInstance
+            def get_instance(payload)
+              WebhookInstance.new(@version, payload, )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Conversations.V1.WebhookPage>'
+            end
+          end
+
+          class WebhookContext < InstanceContext
+            ##
+            # Initialize the WebhookContext
+            # @param [Version] version Version that contains the resource
+            # @return [WebhookContext] WebhookContext
+            def initialize(version)
+              super(version)
+
+              # Path Solution
+              @solution = {}
+              @uri = "/Configuration/Webhooks"
+            end
+
+            ##
+            # Fetch the WebhookInstance
+            # @return [WebhookInstance] Fetched WebhookInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              WebhookInstance.new(@version, payload, )
+            end
+
+            ##
+            # Update the WebhookInstance
+            # @param [String] method The HTTP method to be used when sending a webhook
+            #   request.
+            # @param [Array[String]] filters The list of webhook event triggers that are
+            #   enabled for this Service: `onMessageAdded`, `onMessageUpdated`,
+            #   `onMessageRemoved`, `onConversationUpdated`, `onConversationRemoved`,
+            #   `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`
+            # @param [String] pre_webhook_url The absolute url the pre-event webhook request
+            #   should be sent to.
+            # @param [String] post_webhook_url The absolute url the post-event webhook request
+            #   should be sent to.
+            # @param [webhook.Target] target The routing target of the webhook.
+            # @return [WebhookInstance] Updated WebhookInstance
+            def update(method: :unset, filters: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, target: :unset)
+              data = Twilio::Values.of({
+                  'Method' => method,
+                  'Filters' => Twilio.serialize_list(filters) { |e| e },
+                  'PreWebhookUrl' => pre_webhook_url,
+                  'PostWebhookUrl' => post_webhook_url,
+                  'Target' => target,
+              })
+
+              payload = @version.update('POST', @uri, data: data)
+
+              WebhookInstance.new(@version, payload, )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Conversations.V1.WebhookContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Conversations.V1.WebhookContext #{context}>"
+            end
+          end
+
+          class WebhookInstance < InstanceResource
+            ##
+            # Initialize the WebhookInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @return [WebhookInstance] WebhookInstance
+            def initialize(version, payload)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'account_sid' => payload['account_sid'],
+                  'method' => payload['method'],
+                  'filters' => payload['filters'],
+                  'pre_webhook_url' => payload['pre_webhook_url'],
+                  'post_webhook_url' => payload['post_webhook_url'],
+                  'target' => payload['target'],
+                  'url' => payload['url'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {}
+            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 [WebhookContext] WebhookContext for this WebhookInstance
+            def context
+              unless @instance_context
+                @instance_context = WebhookContext.new(@version, )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] The unique ID of the Account responsible for this conversation.
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [webhook.Method] The HTTP method to be used when sending a webhook request.
+            def method
+              @properties['method']
+            end
+
+            ##
+            # @return [Array[String]] The list of webhook event triggers that are enabled for this Service.
+            def filters
+              @properties['filters']
+            end
+
+            ##
+            # @return [String] The absolute url the pre-event webhook request should be sent to.
+            def pre_webhook_url
+              @properties['pre_webhook_url']
+            end
+
+            ##
+            # @return [String] The absolute url the post-event webhook request should be sent to.
+            def post_webhook_url
+              @properties['post_webhook_url']
+            end
+
+            ##
+            # @return [webhook.Target] The routing target of the webhook.
+            def target
+              @properties['target']
+            end
+
+            ##
+            # @return [String] An absolute URL for this webhook.
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Fetch the WebhookInstance
+            # @return [WebhookInstance] Fetched WebhookInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Update the WebhookInstance
+            # @param [String] method The HTTP method to be used when sending a webhook
+            #   request.
+            # @param [Array[String]] filters The list of webhook event triggers that are
+            #   enabled for this Service: `onMessageAdded`, `onMessageUpdated`,
+            #   `onMessageRemoved`, `onConversationUpdated`, `onConversationRemoved`,
+            #   `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`
+            # @param [String] pre_webhook_url The absolute url the pre-event webhook request
+            #   should be sent to.
+            # @param [String] post_webhook_url The absolute url the post-event webhook request
+            #   should be sent to.
+            # @param [webhook.Target] target The routing target of the webhook.
+            # @return [WebhookInstance] Updated WebhookInstance
+            def update(method: :unset, filters: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, target: :unset)
+              context.update(
+                  method: method,
+                  filters: filters,
+                  pre_webhook_url: pre_webhook_url,
+                  post_webhook_url: post_webhook_url,
+                  target: target,
+              )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Conversations.V1.WebhookInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Conversations.V1.WebhookInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end