twilio-ruby 5.34.1 → 5.39.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f3afee506f82f8d295b1b7bd408c090df9f2984bb639c1165559f837282cd0e
-  data.tar.gz: 3f3f1b4854f5df815c42617e0b089397925cb27f8207f22b35d0cf49011bdbdf
+  metadata.gz: 97f0ee149435bbd62398add789961831ee075746c2f312e8d75623f02d96d38b
+  data.tar.gz: 9757f9bb87acd69aad26d647baeafc0b677f077110ab0ca7d78183634c148920
 SHA512:
-  metadata.gz: 715032b7a617559d21cdacaaaa769567f873ccbdc432ac40b5e3d5761c4f32c9c18d51512a3221fe35527821b0945774a0770a43653fd7815b4a7011e3f76798
-  data.tar.gz: 6b305639f5b8ca5fa69e97d185221e13d9b1969d95b3d89b7d112b046e82dbab4c88a8cb7d633e0eefa0bde94d6aec9a424ea2cb3cc5897368c022d35c1d25f8
+  metadata.gz: c891f1c65f2c542998025ce0004e102e0c7ee9d7dc6a2961c6235c8f051790655f77ed5d454902f1b97c02e98a94ea7c8911090dc1930fb653227c5431256626
+  data.tar.gz: '0904a46ba5a28ea18445191e37f9827ee5a0e03efeeb26a3a740dc3aababbdfcc674e9ef026051427dbe1869beb3ce0b418a41390bb01ad87f00ec72adc4e819'

data/CHANGES.md

@@ -1,6 +1,132 @@
 twilio-ruby changelog
 =====================
 
+[2020-07-08] Version 5.39.0
+---------------------------
+**Library - Feature**
+- [PR #516](https://github.com/twilio/twilio-ruby/pull/516): add custom header support. Thanks to [@eshanholtz](https://github.com/eshanholtz)!
+
+**Library - Chore**
+- [PR #515](https://github.com/twilio/twilio-ruby/pull/515): regenerate library after generator refactor. Thanks to [@eshanholtz](https://github.com/eshanholtz)!
+
+**Conversations**
+- Allow Address updates for Participants
+- Message delivery receipts
+
+**Events**
+- Add account_sid to subscription and subscribed_events resources
+
+**Flex**
+- Changed `wfm_integrations` Flex Configuration key to private **(breaking change)**
+
+**Messaging**
+- Add error states to WhatsApp Sender status with failed reason **(breaking change)**
+- Delete WhatsApp Template API
+- Update WhatsApp Template API
+- Add WhatsApp Template Get Api (fetch and read)
+
+**Numbers**
+- Add `valid_until` in the Bundles resource
+- Add API for Bundle deletion
+
+**Verify**
+- Removed support for `sms`, `totp` and `app-push` factor types in Verify push **(breaking change)**
+
+
+[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**

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.1'
+gem 'twilio-ruby', '~> 5.39.0'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.34.1
+gem install twilio-ruby -v 5.39.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/framework/version.rb

@@ -57,7 +57,7 @@ module Twilio
         Twilio::REST::RestError.new(header, response)
       end
 
-      def fetch(method, uri, params = {}, data = {}, headers = {}, auth = nil, timeout = nil)
+      def fetch(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil)
         response = request(
           method,
           uri,
@@ -93,7 +93,7 @@ module Twilio
         response.body
       end
 
-      def delete(method, uri, params = {}, data = {}, headers = {}, auth = nil, timeout = nil)
+      def delete(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil)
         response = request(
           method,
           uri,
@@ -127,7 +127,7 @@ module Twilio
         }
       end
 
-      def page(method, uri, params = {}, data = {}, headers = {}, auth = nil, timeout = nil)
+      def page(method, uri, params = {}, data = {}, headers: {}, auth: nil, timeout: nil)
         request(
           method,
           uri,

data/lib/twilio-ruby/rest/accounts/v1/credential/aws.rb

@@ -85,11 +85,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params)
+
               AwsPage.new(@version, response, @solution)
             end
 
@@ -107,8 +105,7 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of AwsInstance records from the API.
-            # Request is executed immediately.
+            # Create the AwsInstance
             # @param [String] credentials A string that contains the AWS access credentials in
             #   the format `<AWS_ACCESS_KEY_ID>:<AWS_SECRET_ACCESS_KEY>`. For example,
             #   `AKIAIOSFODNN7EXAMPLE:wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`
@@ -117,7 +114,7 @@ module Twilio
             # @param [String] account_sid The SID of the Subaccount that this Credential
             #   should be associated with. Must be a valid Subaccount of the account issuing the
             #   request.
-            # @return [AwsInstance] Newly created AwsInstance
+            # @return [AwsInstance] Created AwsInstance
             def create(credentials: nil, friendly_name: :unset, account_sid: :unset)
               data = Twilio::Values.of({
                   'Credentials' => credentials,
@@ -125,11 +122,7 @@ module Twilio
                   'AccountSid' => account_sid,
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               AwsInstance.new(@version, payload, )
             end
@@ -186,16 +179,10 @@ module Twilio
             end
 
             ##
-            # Fetch a AwsInstance
+            # Fetch the AwsInstance
             # @return [AwsInstance] Fetched AwsInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               AwsInstance.new(@version, payload, sid: @solution[:sid], )
             end
@@ -208,20 +195,16 @@ module Twilio
             def update(friendly_name: :unset)
               data = Twilio::Values.of({'FriendlyName' => friendly_name, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               AwsInstance.new(@version, payload, sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the AwsInstance
+            # Delete the AwsInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -313,7 +296,7 @@ module Twilio
             end
 
             ##
-            # Fetch a AwsInstance
+            # Fetch the AwsInstance
             # @return [AwsInstance] Fetched AwsInstance
             def fetch
               context.fetch
@@ -329,7 +312,7 @@ module Twilio
             end
 
             ##
-            # Deletes the AwsInstance
+            # Delete the AwsInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete

data/lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb

@@ -85,11 +85,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params)
+
               PublicKeyPage.new(@version, response, @solution)
             end
 
@@ -107,8 +105,7 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of PublicKeyInstance records from the API.
-            # Request is executed immediately.
+            # Create the PublicKeyInstance
             # @param [String] public_key A URL encoded representation of the public key. For
             #   example, `-----BEGIN PUBLIC KEY-----MIIBIjANB.pa9xQIDAQAB-----END PUBLIC
             #   KEY-----`
@@ -117,7 +114,7 @@ module Twilio
             # @param [String] account_sid The SID of the Subaccount that this Credential
             #   should be associated with. Must be a valid Subaccount of the account issuing the
             #   request
-            # @return [PublicKeyInstance] Newly created PublicKeyInstance
+            # @return [PublicKeyInstance] Created PublicKeyInstance
             def create(public_key: nil, friendly_name: :unset, account_sid: :unset)
               data = Twilio::Values.of({
                   'PublicKey' => public_key,
@@ -125,11 +122,7 @@ module Twilio
                   'AccountSid' => account_sid,
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               PublicKeyInstance.new(@version, payload, )
             end
@@ -186,16 +179,10 @@ module Twilio
             end
 
             ##
-            # Fetch a PublicKeyInstance
+            # Fetch the PublicKeyInstance
             # @return [PublicKeyInstance] Fetched PublicKeyInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               PublicKeyInstance.new(@version, payload, sid: @solution[:sid], )
             end
@@ -208,20 +195,16 @@ module Twilio
             def update(friendly_name: :unset)
               data = Twilio::Values.of({'FriendlyName' => friendly_name, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               PublicKeyInstance.new(@version, payload, sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the PublicKeyInstance
+            # Delete the PublicKeyInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -313,7 +296,7 @@ module Twilio
             end
 
             ##
-            # Fetch a PublicKeyInstance
+            # Fetch the PublicKeyInstance
             # @return [PublicKeyInstance] Fetched PublicKeyInstance
             def fetch
               context.fetch
@@ -329,7 +312,7 @@ module Twilio
             end
 
             ##
-            # Deletes the PublicKeyInstance
+            # Delete the PublicKeyInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete