twilio-ruby 5.34.0 → 5.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3c2f4bbf217f506df9191e83264ccfc2966a7500754885341f4c0bd7626a35a
-  data.tar.gz: 2f770e917a2b26214707107eaa47ad3052a8ef883ba1293caf47b89a87be9fef
+  metadata.gz: 0f977335dfe45b56523f320b3d4fbcf8e9dc4ab69b6f5459b61a5451ad3aacde
+  data.tar.gz: 5dcb7888fd08da7ebdf1c815abb1a5b9c44a71393d31c23d1f1c97547794dea6
 SHA512:
-  metadata.gz: 236c258000ffa8eacdb7947f3b7268fdfe5c141e0e3de6cd6ba90b2a8591a21c5dbd0fa88da678a6fbd3744aead2fcb951e92de8be9c3fc9ff7d035c132e7342
-  data.tar.gz: f60524d0983d267aefcf3d01234bcbf39b4de400e08bfd650edbc6a0c29c0dd67f46db2985d87325d28d51649376e8df27db1f38d00c6fd24b12e1517d7b1369
+  metadata.gz: 84713b37e22092294e75e6b26397d8e767392916dc4cf5959c54f6969f414ee79e56ea5410f6085ddd933835bb1c3e2661a560c8220245cef033b46923c0d3b1
+  data.tar.gz: 046fa6c107c85e0ce763ecb21d1d2c755dff0bebc2534394e35b401fad32d5265c93feaf0ee4b5309caa868d918bfa66ffc370927fd31e6dbda8cfe41f77837d

data/CHANGES.md

@@ -1,6 +1,132 @@
 twilio-ruby changelog
 =====================
 
+[2020-06-24] Version 5.38.0
+---------------------------
+**Api**
+- Added optional `JitterBufferSize` parameter for creating conference participant
+- Added optional `label` property for conference participants
+- Added optional parameter `caller_id` for creating conference participant endpoint.
+
+**Autopilot**
+- Remove Export resource from Autopilot Assistant
+
+**Conversations**
+- Expose Conversation timers
+
+**Monitor**
+- Update start/end date filter params to support date-or-time format **(breaking change)**
+
+**Numbers**
+- Add `provisionally-approved` as a Supporting Document status
+
+**Preview**
+- Removed `Authy` resources. **(breaking change)**
+
+**Supersim**
+- Add ready state to the allowed transitions in the sim update call behind the feature flag supersim.ready-state.v1
+
+**Verify**
+- Webhook resources added to Verify services and put behind the `api.verify.push` beta feature
+
+**Twiml**
+- Add more supported locales for the `Gather` verb.
+
+
+[2020-06-10] Version 5.37.0
+---------------------------
+**Library - Docs**
+- [PR #514](https://github.com/twilio/twilio-ruby/pull/514): link to handling exceptions. Thanks to [@thinkingserious](https://github.com/thinkingserious)!
+- [PR #513](https://github.com/twilio/twilio-ruby/pull/513): link to custom HTTP client instructions. Thanks to [@thinkingserious](https://github.com/thinkingserious)!
+
+**Api**
+- Added `pstnconnectivity` to `usage_record` API
+
+**Autopilot**
+- Add dialogue_sid param to Query list resource
+
+**Notify**
+- delivery_callback_url and delivery_callback_enabled added
+
+**Numbers**
+- Add `provisionally-approved` as a Bundle status
+
+**Preview**
+- `BrandsInformation` endpoint now returns a single `BrandsInformation`
+- Deleted phone number required field in the brand phone number endpoint from `kyc-api`
+- Removed insights `preview API` from API Definitions **(breaking change)**
+- Added `BrandsInformation` endpoint to query brands information stored in KYC
+
+**Supersim**
+- Require a Network Access Profile when creating a Fleet **(breaking change)**
+
+
+[2020-05-27] Version 5.36.0
+---------------------------
+**Api**
+- Added `reason_conference_ended` and `call_sid_ending_conference` to Conference read/fetch/update
+- Fixed some examples to use the correct "TK" SID prefix for Trunk resources.
+
+**Authy**
+- Renamed `twilio_authy_sandbox_mode` headers to `twilio_sandbox_mode` **(breaking change)**
+- Renamed `Twilio-Authy-*` headers to `Twilio-Veriry-*` **(breaking change)**
+
+**Flex**
+- Adding `flex_service_instance_sid` to Flex Configuration
+
+**Preview**
+- Removed insights preview API from API Definitions **(breaking change)**
+- Added `Channels` endpoint to brand a phone number for BrandedCalls
+
+**Serverless**
+- Add Build Sid to Log results
+
+**Supersim**
+- Add Network Access Profile resource Networks subresource
+- Allow specifying a Data Limit on Fleets
+
+**Trunking**
+- Fixed some examples to use the correct "TK" SID prefix for Trunk resources.
+
+
+[2020-05-20] Version 5.35.0
+---------------------------
+**Library - Feature**
+- [PR #512](https://github.com/twilio/twilio-ruby/pull/512): add regional and edge support. Thanks to [@eshanholtz](https://github.com/eshanholtz)!
+
+
+[2020-05-13] Version 5.34.1
+---------------------------
+**Api**
+- Add optional `emergency_caller_sid` parameter to SIP Domain
+- Updated `call_reason` optional property to be treated as PII
+- Added optional BYOC Trunk Sid property to Sip Domain API resource
+
+**Autopilot**
+- Add Restore resource to Autopilot Assistant
+
+**Contacts**
+- Added contacts Create API definition
+
+**Events**
+- Subscriptions API initial release
+
+**Numbers**
+- Add Evaluations API
+
+**Supersim**
+- Allow filtering the Fleets resource by Network Access Profile
+- Allow assigning a Network Access Profile when creating and updating a Fleet
+- Add Network Access Profiles resource
+
+**Verify**
+- Add `CustomCode` optional parameter on Verification creation.
+- Add delete action on Service resource.
+
+**Voice**
+- Added endpoints for BYOC trunks, SIP connection policies and source IP mappings
+
+
 [2020-04-29] Version 5.34.0
 ---------------------------
 **Library - Feature**

data/README.md

@@ -32,13 +32,13 @@ This library supports the following Ruby implementations:
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 5.34.0'
+gem 'twilio-ruby', '~> 5.38.0'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.34.0
+gem install twilio-ruby -v 5.38.0
 ```
 
 To build and install the development branch yourself from the latest source:
@@ -64,6 +64,23 @@ auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
 @client = Twilio::REST::Client.new account_sid, auth_token
 ```
 
+### Specify a Region and/or Edge
+
+To take advantage of Twilio's [Global Infrastructure](https://www.twilio.com/docs/global-infrastructure), specify the target Region and/or Edge for the client:
+
+```ruby
+# set up a client to talk to the Twilio REST API over a specific region and edge
+@client = Twilio::REST::Client.new account_sid, auth_token, nil, 'au1'
+@client.edge = 'sydney'
+
+# you may also specify the region and/or edge after client creation
+@client = Twilio::REST::Client.new account_sid, auth_token
+@client.region = 'au1'
+@client.edge = 'sydney'
+```
+
+This will result in the `hostname` transforming from `api.twilio.com` to `api.sydney.au1.twilio.com`.
+
 ### Make a Call
 
 ```ruby
@@ -106,16 +123,20 @@ message_sid = 'SMxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
 @client.http_client.adapter = :typhoeus
 ```
 
+To use a custom HTTP client with this helper library, please see the [Twilio documentation](https://www.twilio.com/docs/libraries/ruby/custom-http-clients).
+
 ### Handling Errors
 
 ```ruby
 begin
   messages = @client.messages.list(limit: 20)
-rescue Twilio::REST::TwilioError => e
+rescue Twilio::REST::RestError => e
   puts e.message
 end
 ```
 
+For more descriptive exception types, please see the [Twilio documentation](https://www.twilio.com/docs/libraries/ruby/usage-guide#error-handling).
+
 ### Getting Started With Client Capability Tokens
 
 If you just need to generate a Capability Token for use with Twilio Client, you can do this:

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
+  def_delegators :configuration, :account_sid, :auth_token, :http_client, :region, :edge
 
   ##
   # 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

@@ -614,33 +614,33 @@ module Twilio
 
               # Marshaled Properties
               @properties = {
-                  'account_sid' => payload['account_sid'],
-                  'annotation' => payload['annotation'],
-                  'answered_by' => payload['answered_by'],
-                  'api_version' => payload['api_version'],
-                  'caller_name' => payload['caller_name'],
+                  'sid' => payload['sid'],
                   'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
                   'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
-                  'direction' => payload['direction'],
-                  'duration' => payload['duration'],
-                  'end_time' => Twilio.deserialize_rfc2822(payload['end_time']),
-                  'forwarded_from' => payload['forwarded_from'],
+                  'parent_call_sid' => payload['parent_call_sid'],
+                  'account_sid' => payload['account_sid'],
+                  'to' => payload['to'],
+                  'to_formatted' => payload['to_formatted'],
                   'from' => payload['from'],
                   'from_formatted' => payload['from_formatted'],
-                  'group_sid' => payload['group_sid'],
-                  'parent_call_sid' => payload['parent_call_sid'],
                   'phone_number_sid' => payload['phone_number_sid'],
+                  'status' => payload['status'],
+                  'start_time' => Twilio.deserialize_rfc2822(payload['start_time']),
+                  'end_time' => Twilio.deserialize_rfc2822(payload['end_time']),
+                  'duration' => payload['duration'],
                   'price' => payload['price'],
                   'price_unit' => payload['price_unit'],
-                  'sid' => payload['sid'],
-                  'start_time' => Twilio.deserialize_rfc2822(payload['start_time']),
-                  'status' => payload['status'],
-                  'subresource_uris' => payload['subresource_uris'],
-                  'to' => payload['to'],
-                  'to_formatted' => payload['to_formatted'],
+                  'direction' => payload['direction'],
+                  'answered_by' => payload['answered_by'],
+                  'annotation' => payload['annotation'],
+                  'api_version' => payload['api_version'],
+                  'forwarded_from' => payload['forwarded_from'],
+                  'group_sid' => payload['group_sid'],
+                  'caller_name' => payload['caller_name'],
+                  'queue_time' => payload['queue_time'],
                   'trunk_sid' => payload['trunk_sid'],
                   'uri' => payload['uri'],
-                  'queue_time' => payload['queue_time'],
+                  'subresource_uris' => payload['subresource_uris'],
               }
 
               # Context
@@ -660,33 +660,9 @@ module Twilio
             end
 
             ##
-            # @return [String] The SID of the Account that created this resource
-            def account_sid
-              @properties['account_sid']
-            end
-
-            ##
-            # @return [String] The annotation provided for the call
-            def annotation
-              @properties['annotation']
-            end
-
-            ##
-            # @return [String] Either `human` or `machine` if this call was initiated with answering machine detection. Empty otherwise.
-            def answered_by
-              @properties['answered_by']
-            end
-
-            ##
-            # @return [String] The API Version used to create the call
-            def api_version
-              @properties['api_version']
-            end
-
-            ##
-            # @return [String] The caller's name if this call was an incoming call to a phone number with caller ID Lookup enabled. Otherwise, empty.
-            def caller_name
-              @properties['caller_name']
+            # @return [String] The unique string that identifies this resource
+            def sid
+              @properties['sid']
             end
 
             ##
@@ -702,27 +678,27 @@ module Twilio
             end
 
             ##
-            # @return [String] A string describing the direction of the call. `inbound` for inbound calls, `outbound-api` for calls initiated via the REST API or `outbound-dial` for calls initiated by a `Dial` verb.
-            def direction
-              @properties['direction']
+            # @return [String] The SID that identifies the call that created this leg.
+            def parent_call_sid
+              @properties['parent_call_sid']
             end
 
             ##
-            # @return [String] The length of the call in seconds.
-            def duration
-              @properties['duration']
+            # @return [String] The SID of the Account that created this resource
+            def account_sid
+              @properties['account_sid']
             end
 
             ##
-            # @return [Time] The end time of the call. Null if the call did not complete successfully.
-            def end_time
-              @properties['end_time']
+            # @return [String] The phone number, SIP address or Client identifier that received this call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`.
+            def to
+              @properties['to']
             end
 
             ##
-            # @return [String] The forwarding phone number if this call was an incoming call forwarded from another number (depends on carrier supporting forwarding). Otherwise, empty.
-            def forwarded_from
-              @properties['forwarded_from']
+            # @return [String] The phone number, SIP address or Client identifier that received this call. Formatted for display.
+            def to_formatted
+              @properties['to_formatted']
             end
 
             ##
@@ -738,21 +714,33 @@ module Twilio
             end
 
             ##
-            # @return [String] The Group SID associated with this call. If no Group is associated with the call, the field is empty.
-            def group_sid
-              @properties['group_sid']
+            # @return [String] If the call was inbound, this is the SID of the IncomingPhoneNumber resource that received the call. If the call was outbound, it is the SID of the OutgoingCallerId resource from which the call was placed.
+            def phone_number_sid
+              @properties['phone_number_sid']
             end
 
             ##
-            # @return [String] The SID that identifies the call that created this leg.
-            def parent_call_sid
-              @properties['parent_call_sid']
+            # @return [call.Status] The status of this call.
+            def status
+              @properties['status']
             end
 
             ##
-            # @return [String] If the call was inbound, this is the SID of the IncomingPhoneNumber resource that received the call. If the call was outbound, it is the SID of the OutgoingCallerId resource from which the call was placed.
-            def phone_number_sid
-              @properties['phone_number_sid']
+            # @return [Time] The start time of the call. Null if the call has not yet been dialed.
+            def start_time
+              @properties['start_time']
+            end
+
+            ##
+            # @return [Time] The end time of the call. Null if the call did not complete successfully.
+            def end_time
+              @properties['end_time']
+            end
+
+            ##
+            # @return [String] The length of the call in seconds.
+            def duration
+              @properties['duration']
             end
 
             ##
@@ -768,39 +756,51 @@ module Twilio
             end
 
             ##
-            # @return [String] The unique string that identifies this resource
-            def sid
-              @properties['sid']
+            # @return [String] A string describing the direction of the call. `inbound` for inbound calls, `outbound-api` for calls initiated via the REST API or `outbound-dial` for calls initiated by a `Dial` verb.
+            def direction
+              @properties['direction']
             end
 
             ##
-            # @return [Time] The start time of the call. Null if the call has not yet been dialed.
-            def start_time
-              @properties['start_time']
+            # @return [String] Either `human` or `machine` if this call was initiated with answering machine detection. Empty otherwise.
+            def answered_by
+              @properties['answered_by']
             end
 
             ##
-            # @return [call.Status] The status of this call.
-            def status
-              @properties['status']
+            # @return [String] The annotation provided for the call
+            def annotation
+              @properties['annotation']
             end
 
             ##
-            # @return [String] A list of related subresources identified by their relative URIs
-            def subresource_uris
-              @properties['subresource_uris']
+            # @return [String] The API Version used to create the call
+            def api_version
+              @properties['api_version']
             end
 
             ##
-            # @return [String] The phone number, SIP address or Client identifier that received this call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`.
-            def to
-              @properties['to']
+            # @return [String] The forwarding phone number if this call was an incoming call forwarded from another number (depends on carrier supporting forwarding). Otherwise, empty.
+            def forwarded_from
+              @properties['forwarded_from']
             end
 
             ##
-            # @return [String] The phone number, SIP address or Client identifier that received this call. Formatted for display.
-            def to_formatted
-              @properties['to_formatted']
+            # @return [String] The Group SID associated with this call. If no Group is associated with the call, the field is empty.
+            def group_sid
+              @properties['group_sid']
+            end
+
+            ##
+            # @return [String] The caller's name if this call was an incoming call to a phone number with caller ID Lookup enabled. Otherwise, empty.
+            def caller_name
+              @properties['caller_name']
+            end
+
+            ##
+            # @return [String] The wait time in milliseconds before the call is placed.
+            def queue_time
+              @properties['queue_time']
             end
 
             ##
@@ -816,9 +816,9 @@ module Twilio
             end
 
             ##
-            # @return [String] The wait time in milliseconds before the call is placed.
-            def queue_time
-              @properties['queue_time']
+            # @return [String] A list of related subresources identified by their relative URIs
+            def subresource_uris
+              @properties['subresource_uris']
             end
 
             ##