twilio-ruby 6.0.0.pre.rc.3 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b50bcb41c0f25e83979ea7c86cd34be29192f84e
-  data.tar.gz: 03f7b80f2d0c3feede506fd95a8fa0adcf5772ff
+  metadata.gz: 85039c08af528f9313181700dd95e0899d8c7804
+  data.tar.gz: e3a4908a007fb1f83e5251938955b495cb33c2a1
 SHA512:
-  metadata.gz: 468b2e3cbd98d1e945f567a6c9a6d2efe5638f7fb2c4ed6645369bfde36285cde24579ddbdc3a3579b4d13bee0f4028df854ef597603da465763a8e9fb1183e9
-  data.tar.gz: d0160a37b6db988eb7b06cc881e0b1894173835571ce1e870f8b48a4f4fc38d7bd0a55860a56213920594f536ceb3e4613f7a1eb1d73f070bad9814dfe0b5bac
+  metadata.gz: bf79a09337c97ca9584703af2520e49964e76fe32c4fdb4e1502b24592577d98e2823581534881ed131d61cd48c820286d10acfe69f671ba29b13fa26eb8c292
+  data.tar.gz: 115c92304528bd4f7bf8fc372166e7e85c4de548f900214de6e884cee4d45fd460c0fc1c908aebadf24e8364f169a8432f537dbaacf24f388eab4fc1df3e1714

data/CHANGES.md

@@ -1,13 +1,24 @@
 twilio-ruby changelog
-=====================
+===================== 
 
-[2023-04-19] Version 6.0.0-rc.3
--------------------------------
-**Library - Fix**
-- [PR #644](https://github.com/twilio/twilio-ruby/pull/644): remove deprecated access token grants. Thanks to [@kridai](https://github.com/kridai)!
+[2023-05-04] Version 6.0.0
+--------------------------
+**Note:** This release contains breaking changes, check our [upgrade guide](./UPGRADE.md#2023-05-03-5xx-to-6xx) for detailed migration notes.
 
-**Library - Chore**
-- [PR #647](https://github.com/twilio/twilio-ruby/pull/647): update client.rb. Thanks to [@shrutiburman](https://github.com/shrutiburman)!
+**Library - Feature**
+- [PR #651](https://github.com/twilio/twilio-ruby/pull/651): Merge branch '6.x.x-rc' to main. Thanks to [@shrutiburman](https://github.com/shrutiburman)! **(breaking change)**
+
+**Conversations**
+- Remove `start_date`, `end_date` and `state` query parameters from list operation on Conversations resource **(breaking change)**
+
+**Twiml**
+- Add support for new Amazon Polly voices (Q1 2023) for `Say` verb
+
+
+[2023-04-19] Version 5.77.0
+---------------------------
+**Library - Docs**
+- [PR #645](https://github.com/twilio/twilio-ruby/pull/645): consolidate. Thanks to [@stern-shawn](https://github.com/stern-shawn)!
 
 **Messaging**
 - Remove `messaging_service_sids` and `messaging_service_sid_action` from domain config endpoint **(breaking change)**
@@ -17,15 +28,8 @@ twilio-ruby changelog
 - Added the new Eligibility API under version `/v1`.
 
 
-[2023-04-05] Version 6.0.0-rc.2
--------------------------------
-**Library - Fix**
-- [PR #642](https://github.com/twilio/twilio-ruby/pull/642): remove deprecated Twilio::REST::TwilioError#body. Thanks to [@kridai](https://github.com/kridai)!
-- [PR #641](https://github.com/twilio/twilio-ruby/pull/641): remove deprecated TwilioResponse class. Thanks to [@kridai](https://github.com/kridai)!
-
-**Library - Chore**
-- [PR #643](https://github.com/twilio/twilio-ruby/pull/643): extend ruby & jruby support. Thanks to [@shrutiburman](https://github.com/shrutiburman)!
-
+[2023-04-05] Version 5.76.0
+---------------------------
 **Conversations**
 - Expose query parameters `start_date`, `end_date` and `state` in list operation on Conversations resource for sorting and filtering
 
@@ -42,52 +46,93 @@ twilio-ruby changelog
 - Add Brand Registrations OTP API
 
 
-[2023-03-23] Version 6.0.0-rc.1
--------------------------------
-**Library - Fix**
-- [PR #639](https://github.com/twilio/twilio-ruby/pull/639): add all handcrafted domain files. Thanks to [@charan678](https://github.com/charan678)!
-
+[2023-03-22] Version 5.75.0
+---------------------------
 **Library - Chore**
-- [PR #631](https://github.com/twilio/twilio-ruby/pull/631): Add Cluster test to rc branch. Thanks to [@rohith-prakash](https://github.com/rohith-prakash)!
-- [PR #627](https://github.com/twilio/twilio-ruby/pull/627): bump jwt max version to 2.6. Thanks to [@claudiachua](https://github.com/claudiachua)!
-
-**Library - Feature**
-- [PR #622](https://github.com/twilio/twilio-ruby/pull/622): Add client base file. Thanks to [@shrutiburman](https://github.com/shrutiburman)!
+- [PR #630](https://github.com/twilio/twilio-ruby/pull/630): Accommodate jwt's minor and patch updates. Thanks to [@sato11](https://github.com/sato11)!
 
 **Api**
 - Revert Corrected the data type for `friendly_name` in Available Phone Number Local, Mobile and TollFree resources
 - Corrected the data type for `friendly_name` in Available Phone Number Local, Mobile and TollFree resources **(breaking change)**
+
+**Messaging**
+- Add `linkshortening_messaging_service` resource
+- Add new endpoint for GetDomainConfigByMessagingServiceSid
+- Remove `validated` parameter and add `cert_in_validation` parameter to Link Shortening API **(breaking change)**
+
+
+[2023-03-09] Version 5.74.5
+---------------------------
+**Api**
 - Add new categories for whatsapp template
+
+**Lookups**
+- Remove `validation_results` from the `default_output_properties`
+
+**Supersim**
+- Add ESimProfile's `matching_id` and `activation_code` parameters to libraries
+
+
+[2023-02-22] Version 5.74.4
+---------------------------
+**Api**
 - Remove `scheduled_for` property from message resource
 - Add `scheduled_for` property to message resource
+
+
+[2023-02-08] Version 5.74.3
+---------------------------
+**Lookups**
+- Add `disposable_phone_number_risk` package to the lookup response
+- Add `sms_pumping_risk` package to the lookup response
+
+
+[2023-01-25] Version 5.74.2
+---------------------------
+**Api**
 - Add `public_application_connect_enabled` param to Application resource
-- Add `street_secondary` param to address create and update
-- Make `method` optional for user defined message subscription **(breaking change)**
+
+**Messaging**
+- Add new tollfree verification API property (ExternalReferenceId)]
+
+**Verify**
+- Add `device_ip` parameter and channel `auto` for sna/sms orchestration
+
+**Twiml**
+- Add support for `<Application>` noun and `<ApplicationSid>` noun, nested `<Parameter>` to `<Hangup>` and `<Leave>` verb
+
+
+[2023-01-11] Version 5.74.1
+---------------------------
+**Library - Chore**
+- [PR #626](https://github.com/twilio/twilio-ruby/pull/626): Bump jwt version max version to 2.6. Thanks to [@MarcPer](https://github.com/MarcPer)!
 
 **Conversations**
 - Add support for creating Multi-Channel Rich Content Messages
 
+**Lookups**
+- Changed the no data message for match postal code from `no_data` to `data_not_available` in identity match package
+
+**Messaging**
+- Add update/edit tollfree verification API
+
+
+[2022-12-14] Version 5.74.0
+---------------------------
+**Api**
+- Add `street_secondary` param to address create and update
+- Make `method` optional for user defined message subscription **(breaking change)**
+
 **Flex**
 - Flex Conversations is now Generally Available
 - Adding the ie1 mapping for authorization api, updating service base uri and base url response attribute **(breaking change)**
 - Change web channels to GA and library visibility to public
 - Changing the uri for authorization api from using Accounts to Insights **(breaking change)**
 
-**Lookups**
-- Remove `validation_results` from the `default_output_properties`
-- Add `disposable_phone_number_risk` package to the lookup response
-- Add `sms_pumping_risk` package to the lookup response
-- Changed the no data message for match postal code from `no_data` to `data_not_available` in identity match package
-
 **Media**
 - Gate Twilio Live endpoints behind beta_feature for EOS
 
 **Messaging**
-- Add `linkshortening_messaging_service` resource
-- Add new endpoint for GetDomainConfigByMessagingServiceSid
-- Remove `validated` parameter and add `cert_in_validation` parameter to Link Shortening API **(breaking change)**
-- Add new tollfree verification API property (ExternalReferenceId)]
-- Add update/edit tollfree verification API
 - Mark `MessageFlow` as a required field for Campaign Creation **(breaking change)**
 
 **Oauth**
@@ -95,14 +140,9 @@ twilio-ruby changelog
 - Added device code authorization endpoint
 
 **Supersim**
-- Add ESimProfile's `matching_id` and `activation_code` parameters to libraries
 - Allow filtering the SettingsUpdates resource by `status`
 
-**Verify**
-- Add `device_ip` parameter and channel `auto` for sna/sms orchestration
-
 **Twiml**
-- Add support for `<Application>` noun and `<ApplicationSid>` noun, nested `<Parameter>` to `<Hangup>` and `<Leave>` verb
 - Add new Polly Neural voices
 - Add tr-TR, ar-AE, yue-CN, fi-FI languages to SSML `<lang>` element.
 - Add x-amazon-jyutping, x-amazon-pinyin, x-amazon-pron-kana, x-amazon-yomigana alphabets to SSML `<phoneme>` element.
@@ -110,10 +150,6 @@ twilio-ruby changelog
 - Rename `role` attribute to `format` in SSML `<say-as>` element. **(breaking change)**
 
 
-[2023-03-23] Version 6.0.0-rc.0
----------------------------
-- Release Candidate prep  
-
 [2022-11-30] Version 5.73.4
 ---------------------------
 **Flex**

data/CONTRIBUTING.md

@@ -21,7 +21,7 @@ it can be.
 ## <a name="question"></a> Got an API/Product Question or Problem?
 
 If you have questions about how to use `twilio-ruby`, please see our
-[docs][docs-link], and if you don't find the answer there, please contact
+[docs](./README.md), and if you don't find the answer there, please contact
 [help@twilio.com](mailto:help@twilio.com) with any issues you have.
 
 ## <a name="issue"></a> Found an Issue?
@@ -37,6 +37,14 @@ This code was generated by
       /       /
 """
 ```
+or
+```
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+```
 then it is a generated file and the change will need to be made by us, but
 submitting an issue will help us track it and keep you up-to-date. If the file
 isn't generated, you can help us out even more by submitting a Pull Request with
@@ -68,10 +76,6 @@ you're working on.
 For large fixes, please build and test the documentation before submitting the
 PR to be sure you haven't accidentally introduced layout or formatting issues.
 
-If you want to help improve the docs at
-[https://www.twilio.com/docs/libraries/ruby][docs-link], please contact
-[help@twilio.com](mailto:help@twilio.com).
-
 ## <a name="submit"></a> Submission Guidelines
 
 ### Submitting an Issue
@@ -155,7 +159,5 @@ you are working:
 * All features or bug fixes **must be tested** by one or more tests.
 * All classes and methods **must be documented**.
 
-
-[docs-link]: https://www.twilio.com/docs/libraries/ruby
 [issue-link]: https://github.com/twilio/twilio-ruby/issues/new
-[github]: https://github.com/twilio/twilio-ruby
+[github]: https://github.com/twilio/twilio-ruby

data/README.md

@@ -8,7 +8,7 @@
 
 The documentation for the Twilio API can be found [here][apidocs].
 
-The Ruby library documentation can be found [here][libdocs] and individual releases [here][refdocs].
+The individual releases [here][refdocs].
 
 ## Versions
 
@@ -30,7 +30,7 @@ This library supports the following Ruby implementations:
 * JRuby 9.3
 * JRuby 9.4
 
-### Migrating from 4.x
+### Migrating from 5.x
 
 [Upgrade Guide][upgrade]
 
@@ -39,19 +39,13 @@ This library supports the following Ruby implementations:
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 6.0.0-rc.3'
+gem 'twilio-ruby', '~> 6.0.0'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 6.0.0-rc.3
-```
-
-To install `twilio-ruby` release candidate via [Rubygems][rubygems] simply gem install:
-
-```bash
-gem install twilio-ruby -v 6.0.0-rc.3
+gem install twilio-ruby -v 6.0.0
 ```
 
 To build and install the development branch yourself from the latest source:
@@ -62,18 +56,47 @@ cd twilio-ruby
 make install
 ```
 
-## Getting Started
+> **Info**
+> If the command line gives you an error message that says Permission Denied, try running the above commands with sudo.
+>
+> For example: `sudo gem install twilio-ruby`
+
+### Test your installation
+
+To make sure the installation was successful, try sending yourself an SMS message, like this:
 
-### Setup Work
+```rb
+require "twilio-ruby"
+
+# Your Account SID and Auth Token from console.twilio.com
+account_sid = "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+auth_token = "your_auth_token"
+
+@client = Twilio::REST::Client.new account_sid, auth_token
+message = @client.messages.create(
+  body: "Hello from Ruby",
+  to: "+12345678901",  # Text this number
+  from: "+15005550006", # From a valid Twilio number
+)
+
+puts message.sid
+```
+
+> **Warning**
+> It's okay to hardcode your credentials when testing locally, but you should use environment variables to keep them secret before committing any code or deploying to production. Check out [How to Set Environment Variables](https://www.twilio.com/blog/2017/01/how-to-set-environment-variables.html) for more information.
+
+## Usage
+
+### Authenticate the Client
 
 ```ruby
 require 'twilio-ruby'
 
-# put your own credentials here
+# Your Account SID and Auth Token from console.twilio.com
 account_sid = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
 auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
 
-# set up a client to talk to the Twilio REST API
+# Initialize the Twilio Client with your credentials
 @client = Twilio::REST::Client.new account_sid, auth_token
 ```
 
@@ -82,8 +105,9 @@ auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
 ```ruby
 require 'twilio-ruby'
 
-# put your own credentials here
+# Your Account SID from console.twilio.com
 account_sid = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+# API Key from twilio.com/console/project/api-keys
 api_key_sid = 'zzzzzzzzzzzzzzzzzzzzzz'
 api_key_secret = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
 
@@ -108,22 +132,6 @@ To take advantage of Twilio's [Global Infrastructure](https://www.twilio.com/doc
 
 This will result in the `hostname` transforming from `api.twilio.com` to `api.sydney.au1.twilio.com`.
 
-### 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
-```
-
 ### Make a Call
 
 ```ruby
@@ -158,27 +166,59 @@ message_sid = 'SMxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
 @client.messages(message_sid).fetch
 ```
 
-### Customizing your HTTP Client
+### Iterate through records
 
-`twilio-ruby` uses [Faraday][faraday] to make HTTP requests. You can tell `Twilio::REST::Client` to use any of the Faraday adapters like so:
+The library automatically handles paging for you. Collections, such as `calls` and `messages`, have `list` and stream methods that page under the hood. With both `list` and `stream`, you can specify the number of records you want to receive (`limit`) and the maximum size you want each page fetch to be (`page_size`). The library will then handle the task for you.
 
-```ruby
-@client.http_client.adapter = :typhoeus
+`list` eagerly fetches all records and returns them as a list, whereas `stream` returns an enumerator and lazily retrieves pages of records as you iterate over the collection. You can also page manually using the `page` method.
+
+For more information about these methods, view the [auto-generated library docs](https://www.twilio.com/docs/libraries/reference/twilio-ruby).
+
+```rb
+require 'twilio-ruby'
+
+account_sid = 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
+auth_token = 'your_auth_token'
+
+@client = Twilio::REST::Client.new(account_sid, auth_token)
+
+@client.calls.list
+       .each do |call|
+         puts call.direction
+       end
 ```
 
-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).
+### Enable Debug logging
 
-To apply customizations such as middleware, you can use the `configure_connection` method like so:
+In order to enable debug logging, pass in a 'logger' instance to the client with the level set to at least 'DEBUG'
 
 ```ruby
-@client.http_client.configure_connection do |faraday|
-  faraday.use SomeMiddleware
-end
+@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
 ```
 
-### Handling Errors
+### Handle Exceptions {#exceptions}
+
+If the Twilio API returns a 400 or a 500 level HTTP response, the `twilio-ruby`
+library will throw a `Twilio::REST::RestError`. 400-level errors are normal
+during API operation (`“Invalid number”`, `“Cannot deliver SMS to that number”`,
+for example) and should be handled appropriately.
+
+```rb
+require 'twilio-ruby'
+
+account_sid = 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
+auth_token = 'your_auth_token'
+
+@client = Twilio::REST::Client.new account_sid, auth_token
 
-```ruby
 begin
   messages = @client.messages.list(limit: 20)
 rescue Twilio::REST::RestError => e
@@ -186,9 +226,51 @@ rescue Twilio::REST::RestError => e
 end
 ```
 
-For more descriptive exception types, please see the [Twilio documentation](https://www.twilio.com/docs/libraries/ruby/usage-guide#error-handling).
+### Debug API requests
+
+To assist with debugging, the library allows you to access the underlying request and response objects. This capability is built into the default HTTP client that ships with the library.
+
+For example, you can retrieve the status code of the last response like so:
+
+```ruby
+require 'rubygems' # Not necessary with ruby 1.9 but included for completeness
+require 'twilio-ruby'
+
+# Your Account SID and Auth Token from console.twilio.com
+account_sid = 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
+auth_token = 'your_auth_token'
+
+@client = Twilio::REST::Client.new(account_sid, auth_token)
+
+@message = @client.messages.create(
+  to: '+14158675309',
+  from: '+14258675310',
+  body: 'Ahoy!'
+)
+
+# Retrieve the status code of the last response from the HTTP client
+puts @client.http_client.last_response.status_code
+```
+
+### Customize your HTTP Client
+
+`twilio-ruby` uses [Faraday][faraday] to make HTTP requests. You can tell `Twilio::REST::Client` to use any of the Faraday adapters like so:
+
+```ruby
+@client.http_client.adapter = :typhoeus
+```
+
+To use a custom HTTP client with this helper library, please see the [advanced example of how to do so](./advanced-examples/custom-http-client.md).
+
+To apply customizations such as middleware, you can use the `configure_connection` method like so:
+
+```ruby
+@client.http_client.configure_connection do |faraday|
+  faraday.use SomeMiddleware
+end
+```
 
-### Getting Started With Client Capability Tokens
+### Get started With Client Capability Tokens
 
 If you just need to generate a Capability Token for use with Twilio Client, you can do this:
 
@@ -216,7 +298,7 @@ capability.add_scope(incoming_scope)
 
 There is a slightly more detailed document in the [Capability][capability] section of the wiki.
 
-### Generating TwiML
+### Generate TwiML
 
 To control phone calls, your application needs to output [TwiML][twiml].
 
@@ -260,7 +342,7 @@ If you've instead found a bug in the library or would like new features added, g
 
 [apidocs]: https://www.twilio.com/docs/api
 [twiml]: https://www.twilio.com/docs/api/twiml
-[libdocs]: https://www.twilio.com/docs/libraries/ruby
+[libdocs]: https://www.twilio.com/docs/libraries/reference/twilio-ruby/
 [refdocs]: https://twilio.github.io/twilio-ruby
 [capability]: https://github.com/twilio/twilio-ruby/wiki/JWT-Tokens
 [wiki]: https://github.com/twilio/twilio-ruby/wiki

data/UPGRADE.md

@@ -3,10 +3,13 @@
 _After `5.0.0` all `MINOR` and `MAJOR` version bumps will have upgrade notes
 posted here._
 
-[2023-03-23] 5.3.x to 6.0.0-rc.x
-----------------------------
-Twilio Ruby Helper Library’s rc version 6.0.0-rc.x is now available. We ensured that you can upgrade to Ruby helper Library 6.0.0-rc version without any breaking changes.
-Behind the scenes Ruby RC Helper is now auto-generated via OpenAPI with this release. This enables us to rapidly add new features and enhance consistency across versions and languages.
+[2023-05-03] 5.x.x to 6.x.x
+-----------------------------
+### Overview
+
+##### Twilio Ruby Helper Library’s major version 6.0.0 is now available. We ensured that you can upgrade to Ruby helper Library 6.0.0 version without any breaking changes
+
+Behind the scenes Ruby Helper is now auto-generated via OpenAPI with this release. This  enables us to rapidly add new features and enhance consistency across versions and languages.
 
 To learn more about the Ruby Helper Library, check out [our docs](https://www.twilio.com/docs/libraries/ruby).