twilio-ruby 5.42.0 → 5.43.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9778eed7f661d600a460a4f11f0cc9c4ecb1f9327ae1fa0bc7f17701b45f783
-  data.tar.gz: 1efe2eaf64fed893801694ec1f9dd68a40ac98be3e444ef2989b7acf520331bc
+  metadata.gz: ec5ff54dd66649c891ed4290835b064e07dd8fc969cb2cfed80be83f17b1d253
+  data.tar.gz: 0d2492ccc67cca79e4c12387aaf8a62184d48f2a6193480e7655448846b0e64b
 SHA512:
-  metadata.gz: 147bb2ba1d376c0d8f7e0335c0c744ba07696cf05ca1368a586750ec746692715a5415b1179c4b8485cec6e42670192704b288cf993cd25e8485888f348da2f4
-  data.tar.gz: 61de95cc6c57cf05b0acf95e6f4ab218402651d3fea976cb88f21527e868b184fb6a0ac9b278e3e6597c31e233b0391801d1d7f660a57c4468189f605a51bd15
+  metadata.gz: 256b0e576d26bf990e61f6393edd819709b770a6bfe3677a6cd177f4f2d9270e5cd50da413d5a2700cbfadb8d4343eb9046a4be5f0d6d87f13edf9d2c54d0ae8
+  data.tar.gz: 14d7a20171b7577e19c57ede894867deb382e558c77bd0c677385128fe4bb972d93f6b9ae8da7008aba5b3086f201f5cc6cc0cd61f3dd9cae7e9dd7488f8b4eb

data/CHANGES.md

@@ -1,6 +1,33 @@
 twilio-ruby changelog
 =====================
 
+[2020-11-18] Version 5.43.0
+---------------------------
+**Library - Feature**
+- [PR #538](https://github.com/twilio/twilio-ruby/pull/538): adding http logging for ruby. Thanks to [@shwetha-manvinkurke](https://github.com/shwetha-manvinkurke)!
+
+**Api**
+- Add new call events resource - GET /2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Events.json
+
+**Conversations**
+- Fixed default response property issue for Service Notifications Configuration
+
+**Insights**
+- Removing call_sid from participant summary. **(breaking change)**
+
+**Serverless**
+- Allow Service unique name to be used in path (in place of SID) in Service update request
+
+**Sync**
+- Added HideExpired query parameter for filtering Sync Documents with expired
+
+**Verify**
+- Challenge `Details` and `HiddenDetails` properties are now marked as `PII`
+- Challenge `expiration_date` attribute updated to set a default value of five (5) minutes and to allow max dates of one (1) hour after creation.
+- Entity `identity` attribute updated to allow values between 8 and 64 characters.
+- Verify Service frinedly_name attribute updated from 64 max lenght to 30 characters.
+
+
 [2020-11-05] Version 5.42.0
 ---------------------------
 **Library - Feature**

data/README.md

@@ -34,13 +34,13 @@ This library supports the following Ruby implementations:
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 5.42.0'
+gem 'twilio-ruby', '~> 5.43.0'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.42.0
+gem install twilio-ruby -v 5.43.0
 ```
 
 To build and install the development branch yourself from the latest source:
@@ -81,6 +81,22 @@ To take advantage of Twilio's [Global Infrastructure](https://www.twilio.com/doc
 @client.edge = 'sydney'
 ```
 
+### Enable Debug logging
+
+In order to enable debug logging, pass in a 'logger' instance to the client with the level set to at least 'DEBUG'
+
+```ruby
+@client = Twilio::REST::Client.new account_sid, auth_token
+myLogger = Logger.new(STDOUT)
+myLogger.level = Logger::DEBUG
+@client.logger = myLogger
+
+@client = Twilio::REST::Client.new account_sid, auth_token
+myLogger = Logger.new('my_log.log')
+myLogger.level = Logger::DEBUG
+@client.logger = myLogger
+```
+
 This will result in the `hostname` transforming from `api.twilio.com` to `api.sydney.au1.twilio.com`.
 
 ### Make a Call

data/lib/twilio-ruby.rb

@@ -38,7 +38,7 @@ module Twilio
   autoload :JWT, File.join(File.dirname(__FILE__), 'twilio-ruby', 'jwt', 'jwt.rb')
   autoload :TwiML, File.join(File.dirname(__FILE__), 'twilio-ruby', 'twiml', 'twiml.rb')
 
-  def_delegators :configuration, :account_sid, :auth_token, :http_client, :region, :edge
+  def_delegators :configuration, :account_sid, :auth_token, :http_client, :region, :edge, :logger
 
   ##
   # Pre-configure with account SID and auth token so that you don't need to

data/lib/twilio-ruby/rest/api/v2010/account/call.rb

@@ -426,6 +426,7 @@ module Twilio
               @recordings = nil
               @notifications = nil
               @feedback = nil
+              @events = nil
               @payments = nil
             end
 
@@ -546,6 +547,18 @@ module Twilio
               FeedbackContext.new(@version, @solution[:account_sid], @solution[:sid], )
             end
 
+            ##
+            # Access the events
+            # @return [EventList]
+            # @return [EventContext]
+            def events
+              unless @events
+                @events = EventList.new(@version, account_sid: @solution[:account_sid], call_sid: @solution[:sid], )
+              end
+
+              @events
+            end
+
             ##
             # Access the payments
             # @return [PaymentList]
@@ -885,6 +898,13 @@ module Twilio
               context.feedback
             end
 
+            ##
+            # Access the events
+            # @return [events] events
+            def events
+              context.events
+            end
+
             ##
             # Access the payments
             # @return [payments] payments

data/lib/twilio-ruby/rest/api/v2010/account/call/event.rb

@@ -0,0 +1,201 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Api < Domain
+      class V2010 < Version
+        class AccountContext < InstanceContext
+          class CallContext < InstanceContext
+            class EventList < ListResource
+              ##
+              # Initialize the EventList
+              # @param [Version] version Version that contains the resource
+              # @param [String] account_sid The SID of the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Call
+              #   resource.
+              # @param [String] call_sid The unique string that that we created to identify this
+              #   Call resource.
+              # @return [EventList] EventList
+              def initialize(version, account_sid: nil, call_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {account_sid: account_sid, call_sid: call_sid}
+                @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:call_sid]}/Events.json"
+              end
+
+              ##
+              # Lists EventInstance records from the API as a list.
+              # Unlike stream(), this operation is eager and will load `limit` records into
+              # memory before returning.
+              # @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
+              #    not set will use the default value of 50 records.  If no page_size is defined
+              #    but a limit is defined, stream() will attempt to read the limit with the most
+              #    efficient page size, i.e. min(limit, 1000)
+              # @return [Array] Array of up to limit results
+              def list(limit: nil, page_size: nil)
+                self.stream(limit: limit, page_size: page_size).entries
+              end
+
+              ##
+              # Streams EventInstance records from the API as an Enumerable.
+              # This operation lazily loads records as efficiently as possible until the limit
+              # is reached.
+              # @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
+              #    not set will use the default value of 50 records. If no page_size is defined
+              #    but a limit is defined, stream() will attempt to read the limit with the most
+              #    efficient page size, i.e. min(limit, 1000)
+              # @return [Enumerable] Enumerable that will yield up to limit results
+              def stream(limit: nil, page_size: nil)
+                limits = @version.read_limits(limit, page_size)
+
+                page = self.page(page_size: limits[:page_size], )
+
+                @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+              end
+
+              ##
+              # When passed a block, yields EventInstance records from the API.
+              # This operation lazily loads records as efficiently as possible until the limit
+              # is reached.
+              def each
+                limits = @version.read_limits
+
+                page = self.page(page_size: limits[:page_size], )
+
+                @version.stream(page,
+                                limit: limits[:limit],
+                                page_limit: limits[:page_limit]).each {|x| yield x}
+              end
+
+              ##
+              # Retrieve a single page of EventInstance records from the API.
+              # Request is executed immediately.
+              # @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
+              # @return [Page] Page of EventInstance
+              def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                params = Twilio::Values.of({
+                    'PageToken' => page_token,
+                    'Page' => page_number,
+                    'PageSize' => page_size,
+                })
+
+                response = @version.page('GET', @uri, params: params)
+
+                EventPage.new(@version, response, @solution)
+              end
+
+              ##
+              # Retrieve a single page of EventInstance records from the API.
+              # Request is executed immediately.
+              # @param [String] target_url API-generated URL for the requested results page
+              # @return [Page] Page of EventInstance
+              def get_page(target_url)
+                response = @version.domain.request(
+                    'GET',
+                    target_url
+                )
+                EventPage.new(@version, response, @solution)
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Api.V2010.EventList>'
+              end
+            end
+
+            class EventPage < Page
+              ##
+              # Initialize the EventPage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [EventPage] EventPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of EventInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [EventInstance] EventInstance
+              def get_instance(payload)
+                EventInstance.new(
+                    @version,
+                    payload,
+                    account_sid: @solution[:account_sid],
+                    call_sid: @solution[:call_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Api.V2010.EventPage>'
+              end
+            end
+
+            class EventInstance < InstanceResource
+              ##
+              # Initialize the EventInstance
+              # @param [Version] version Version that contains the resource
+              # @param [Hash] payload payload that contains response from Twilio
+              # @param [String] account_sid The SID of the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Call
+              #   resource.
+              # @param [String] call_sid The unique string that that we created to identify this
+              #   Call resource.
+              # @return [EventInstance] EventInstance
+              def initialize(version, payload, account_sid: nil, call_sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {'request' => payload['request'], 'response' => payload['response'], }
+              end
+
+              ##
+              # @return [Hash] Call Request.
+              def request
+                @properties['request']
+              end
+
+              ##
+              # @return [Hash] Call Response with Events.
+              def response
+                @properties['response']
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                "<Twilio.Api.V2010.EventInstance>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                "<Twilio.Api.V2010.EventInstance>"
+              end
+            end
+          end
+        end
+      end
+    end
+  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
@@ -80,7 +81,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,
@@ -91,6 +109,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
 
       ##

data/lib/twilio-ruby/rest/events/v1/subscription.rb

@@ -29,6 +29,8 @@ module Twilio
           # Lists SubscriptionInstance records from the API as a list.
           # Unlike stream(), this operation is eager and will load `limit` records into
           # memory before returning.
+          # @param [String] sink_sid The SID of the sink that the list of Subscriptions
+          #   should be filtered by.
           # @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
@@ -36,14 +38,16 @@ module Twilio
           #    but a limit is defined, stream() will attempt to read the limit with the most
           #    efficient page size, i.e. min(limit, 1000)
           # @return [Array] Array of up to limit results
-          def list(limit: nil, page_size: nil)
-            self.stream(limit: limit, page_size: page_size).entries
+          def list(sink_sid: :unset, limit: nil, page_size: nil)
+            self.stream(sink_sid: sink_sid, limit: limit, page_size: page_size).entries
           end
 
           ##
           # Streams SubscriptionInstance records from the API as an Enumerable.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
+          # @param [String] sink_sid The SID of the sink that the list of Subscriptions
+          #   should be filtered by.
           # @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
@@ -51,10 +55,10 @@ module Twilio
           #    but a limit is defined, stream() will attempt to read the limit with the most
           #    efficient page size, i.e. min(limit, 1000)
           # @return [Enumerable] Enumerable that will yield up to limit results
-          def stream(limit: nil, page_size: nil)
+          def stream(sink_sid: :unset, limit: nil, page_size: nil)
             limits = @version.read_limits(limit, page_size)
 
-            page = self.page(page_size: limits[:page_size], )
+            page = self.page(sink_sid: sink_sid, page_size: limits[:page_size], )
 
             @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
           end
@@ -76,12 +80,15 @@ module Twilio
           ##
           # Retrieve a single page of SubscriptionInstance records from the API.
           # Request is executed immediately.
+          # @param [String] sink_sid The SID of the sink that the list of Subscriptions
+          #   should be filtered by.
           # @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
           # @return [Page] Page of SubscriptionInstance
-          def page(page_token: :unset, page_number: :unset, page_size: :unset)
+          def page(sink_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
             params = Twilio::Values.of({
+                'SinkSid' => sink_sid,
                 'PageToken' => page_token,
                 'Page' => page_number,
                 'PageSize' => page_size,