twilio-ruby 5.42.0 → 5.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9778eed7f661d600a460a4f11f0cc9c4ecb1f9327ae1fa0bc7f17701b45f783
-  data.tar.gz: 1efe2eaf64fed893801694ec1f9dd68a40ac98be3e444ef2989b7acf520331bc
+  metadata.gz: ec2f94329e022fb33cd55a694e8ef8638b465b3b1b9f336b392308a30ff4b6c0
+  data.tar.gz: 5cae812b5d92082cc9f1f5d9c00c4cb87e2cf07daf1f9cf53539d5be8b4dde77
 SHA512:
-  metadata.gz: 147bb2ba1d376c0d8f7e0335c0c744ba07696cf05ca1368a586750ec746692715a5415b1179c4b8485cec6e42670192704b288cf993cd25e8485888f348da2f4
-  data.tar.gz: 61de95cc6c57cf05b0acf95e6f4ab218402651d3fea976cb88f21527e868b184fb6a0ac9b278e3e6597c31e233b0391801d1d7f660a57c4468189f605a51bd15
+  metadata.gz: 4a4d102e1238ceffe7b22101af1e23573a90e47ff8accead506f303794791e9d6adbd48b302583e5ae15ddcf2d5fc2336ccfeba3676cf8f2767e2c0a10388141
+  data.tar.gz: 86eb8eb1f84acc4f13c8574430a5e86ea63b150b537263c3af0fbb878a7d0dcf2c4d7de998e94356cb8c171a8f029bef66866ef3f2973981e2e519730b2cfe1f

data/.travis.yml

@@ -4,6 +4,7 @@ bundler_args: --without development
 
 rvm:
   - ruby-head
+  - 3.0
   - 2.7
   - 2.6
   - 2.5

data/CHANGES.md

@@ -1,6 +1,101 @@
 twilio-ruby changelog
 =====================
 
+[2021-01-13] Version 5.46.0
+---------------------------
+**Library - Docs**
+- [PR #546](https://github.com/twilio/twilio-ruby/pull/546): Fixing docs for list parameter types. Thanks to [@shwetha-manvinkurke](https://github.com/shwetha-manvinkurke)!
+
+**Library - Fix**
+- [PR #545](https://github.com/twilio/twilio-ruby/pull/545): Adds Ruby 3.0 to Travis. Fixes test. Thanks to [@philnash](https://github.com/philnash)!
+
+**Api**
+- Add 'Electric Imp v1 Usage' to usage categories
+
+**Conversations**
+- Changed `last_read_message_index` type in Participant's resource **(breaking change)**
+
+**Insights**
+- Added `created_time` to call summary.
+
+**Sync**
+- Remove HideExpired query parameter for filtering Sync Documents with expired **(breaking change)**
+
+**Video**
+- [Rooms] Expose maxConcurrentPublishedTracks property in Room resource
+
+
+[2020-12-16] Version 5.45.1
+---------------------------
+**Api**
+- Updated `call_event` default_output_properties to request and response.
+
+**Conversations**
+- Added `last_read_message_index` and `last_read_timestamp` to Participant's resource update operation
+- Added `is_notifiable` and `is_online` to User's resource
+- Added `reachability_enabled` parameters to update method for Conversation Service Configuration resource
+
+**Messaging**
+- Added WA template quick reply, URL, and phone number buttons
+
+**Twiml**
+- Add `sequential` to `Dial`.
+
+
+[2020-12-08] Version 5.45.0
+---------------------------
+**Api**
+- Added optional `RecordingTrack` parameter for create calls, create participants, and create call recordings
+- Removed deprecated Programmable Chat usage record categories **(breaking change)**
+
+**Twiml**
+- Add `recordingTrack` to `Dial`.
+
+
+[2020-12-02] Version 5.44.0
+---------------------------
+**Api**
+- Remove `RecordingTrack` parameter for create calls, create participants, and create call recordings **(breaking change)**
+- Added `RecordingTrack` parameter for create calls and create call recordings
+- Add optional property `recording_track` in the participant create request
+
+**Lookups**
+- Changed `caller_name` and `carrier` properties type to object **(breaking change)**
+
+**Trunking**
+- Added dual channel recording options for Trunks.
+
+**Twiml**
+- Add `jitterBufferSize` and `participantLabel` to `Conference`.
+
+
+[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/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (C) 2020, Twilio, Inc. <help@twilio.com>
+Copyright (C) 2021, Twilio, Inc. <help@twilio.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

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.46.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.46.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/authorized_connect_app.rb

@@ -288,7 +288,7 @@ module Twilio
             end
 
             ##
-            # @return [authorized_connect_app.Permission] Permissions authorized to the app
+            # @return [Array[authorized_connect_app.Permission]] Permissions authorized to the app
             def permissions
               @properties['permissions']
             end

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

@@ -52,10 +52,10 @@ module Twilio
             #   `status_callback_event` is specified, we will send the `completed` status. If an
             #   `application_sid` parameter is present, this parameter is ignored. URLs must
             #   contain a valid hostname (underscores are not permitted).
-            # @param [String] status_callback_event The call progress events that we will send
-            #   to the `status_callback` URL. Can be: `initiated`, `ringing`, `answered`, and
-            #   `completed`. If no event is specified, we send the `completed` status. If you
-            #   want to receive multiple events, specify each one in a separate
+            # @param [Array[String]] status_callback_event The call progress events that we
+            #   will send to the `status_callback` URL. Can be: `initiated`, `ringing`,
+            #   `answered`, and `completed`. If no event is specified, we send the `completed`
+            #   status. If you want to receive multiple events, specify each one in a separate
             #   `status_callback_event` parameter. See the code sample for {monitoring call
             #   progress}[https://www.twilio.com/docs/voice/api/call-resource?code-sample=code-create-a-call-resource-and-specify-a-statuscallbackevent&code-sdk-version=json].
             #   If an `application_sid` is present, this parameter is ignored.
@@ -106,10 +106,10 @@ module Twilio
             # @param [String] machine_detection_timeout The number of seconds that we should
             #   attempt to detect an answering machine before timing out and sending a voice
             #   request with `AnsweredBy` of `unknown`. The default timeout is 30 seconds.
-            # @param [String] recording_status_callback_event The recording status events that
-            #   will trigger calls to the URL specified in `recording_status_callback`. Can be:
-            #   `in-progress`, `completed` and `absent`. Defaults to `completed`. Separate
-            #   multiple values with a space.
+            # @param [Array[String]] recording_status_callback_event The recording status
+            #   events that will trigger calls to the URL specified in
+            #   `recording_status_callback`. Can be: `in-progress`, `completed` and `absent`.
+            #   Defaults to `completed`. Separate  multiple values with a space.
             # @param [String] trim Whether to trim any leading and trailing silence from the
             #   recording. Can be: `trim-silence` or `do-not-trim` and the default is
             #   `trim-silence`.
@@ -142,6 +142,10 @@ module Twilio
             # @param [String] call_reason The Reason for the outgoing call. Use it to specify
             #   the purpose of the call that is presented on the called party's phone. (Branded
             #   Calls Beta)
+            # @param [String] recording_track The audio track to record for the call. Can be:
+            #   `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the
+            #   audio that is received by Twilio. `outbound` records the audio that is generated
+            #   from Twilio. `both` records the audio that is received and generated by Twilio.
             # @param [String] url The absolute URL that returns the TwiML instructions for the
             #   call. We will call this URL using the `method` when the call connects. For more
             #   information, see the {Url
@@ -153,7 +157,7 @@ module Twilio
             # @param [String] application_sid The SID of the Application resource that will
             #   handle the call, if the call will be handled by an application.
             # @return [CallInstance] Created CallInstance
-            def create(to: nil, from: nil, method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_event: :unset, status_callback_method: :unset, send_digits: :unset, timeout: :unset, record: :unset, recording_channels: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, sip_auth_username: :unset, sip_auth_password: :unset, machine_detection: :unset, machine_detection_timeout: :unset, recording_status_callback_event: :unset, trim: :unset, caller_id: :unset, machine_detection_speech_threshold: :unset, machine_detection_speech_end_threshold: :unset, machine_detection_silence_timeout: :unset, async_amd: :unset, async_amd_status_callback: :unset, async_amd_status_callback_method: :unset, byoc: :unset, call_reason: :unset, url: :unset, twiml: :unset, application_sid: :unset)
+            def create(to: nil, from: nil, method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_event: :unset, status_callback_method: :unset, send_digits: :unset, timeout: :unset, record: :unset, recording_channels: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, sip_auth_username: :unset, sip_auth_password: :unset, machine_detection: :unset, machine_detection_timeout: :unset, recording_status_callback_event: :unset, trim: :unset, caller_id: :unset, machine_detection_speech_threshold: :unset, machine_detection_speech_end_threshold: :unset, machine_detection_silence_timeout: :unset, async_amd: :unset, async_amd_status_callback: :unset, async_amd_status_callback_method: :unset, byoc: :unset, call_reason: :unset, recording_track: :unset, url: :unset, twiml: :unset, application_sid: :unset)
               data = Twilio::Values.of({
                   'To' => to,
                   'From' => from,
@@ -187,6 +191,7 @@ module Twilio
                   'AsyncAmdStatusCallbackMethod' => async_amd_status_callback_method,
                   'Byoc' => byoc,
                   'CallReason' => call_reason,
+                  'RecordingTrack' => recording_track,
               })
 
               payload = @version.create('POST', @uri, data: data)
@@ -426,6 +431,7 @@ module Twilio
               @recordings = nil
               @notifications = nil
               @feedback = nil
+              @events = nil
               @payments = nil
             end
 
@@ -546,6 +552,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 +903,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