twilio-ruby 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6a6f5e9d921db6048332ae4913809af14e3ea8a
-  data.tar.gz: 6a3634728a3446a9bbe70d4da8cbaf5df29e00f2
+  metadata.gz: 7ad998d6d974a18680aa4af67eac5060956bd089
+  data.tar.gz: 2c2907bdecbc092b9cdc5d3dc51f106bbb27092f
 SHA512:
-  metadata.gz: 3f866e4c93cc5bd0f58648eda34acf840b4859052f4e26967001b4fd5874accdda13a198f61bb1c5c50bcea968cb8071b9bddbcd528c0e922dcd7ca39640531d
-  data.tar.gz: e28c9d8b3f51a160ed850ff21a3cf9720b1604fe2e9b580326ee71faf0cf177d343f160c49ce055242cb6f98a82d939a3a26828dd8a886b6058f33efaddd6b6a
+  metadata.gz: 8749bb3401a502e263e21733cc70591c86a4c6013b5aa193928be83f63921e65586cbd2b66ea06b92093091081bdca27870ada78100ca750726425cbfe4bd87c
+  data.tar.gz: 9ad4c8bc2ed44eb805f33d75f2ec9bb4ede33b5854a620d00b5b46377039ec100c3131b2585e7ea24cc41ba35d74db6ebb8ec002217e3c80b656b9226605cf19

data/CHANGES.md

@@ -1,5 +1,33 @@
 twilio-ruby changelog
 =====================
+[2017-07-27] Version 5.1.0
+---------------------------
+This release adds Beta and Preview products to main artifact.
+
+Previously, Beta and Preview products were only included in the alpha artifact.
+They are now being included in the main artifact to ease product
+discoverability and the collective operational overhead of maintaining multiple
+artifacts per library.
+
+**Api**
+- Remove unused `encryption_type` property on Recordings *(breaking change)*
+- Update `status` enum for Messages to include 'accepted'
+- Update `AnnounceMethod` parameter naming for consistency
+
+**Messaging**
+- Fix incorrectly typed capabilities property for PhoneNumbers.
+
+**Notify**
+- Add `ToBinding` optional parameter on Notifications resource creation. Accepted values are json strings.
+
+**Preview**
+- Add `sms_application_sid` to HostedNumberOrders.
+- Add `verification_attempts` to HostedNumberOrders.
+
+**Taskrouter**
+- Fully support conference functionality in reservations.
+
+
 [2017-07-13] Version 5.0.0
 --------------------------------
 - Moving to General Availability
@@ -42,11 +70,11 @@ twilio-ruby changelog
 [2017-06-19] Version 5.0.0.rc23
 -------------------------------
 - Fixed ClientCapability parameter encoded bug.
-- Optional URL parameter for TwiML Play verb. 
+- Optional URL parameter for TwiML Play verb.
 
 [2017-06-15] Version 5.0.0.rc22
 -------------------------------
-- Refactor JWT token constructors 
+- Refactor JWT token constructors
 
 
 [2017-05-24] Version 5.0.0.rc21

data/CONTRIBUTING.md

@@ -0,0 +1,159 @@
+# Contributing to `twilio-ruby`
+
+We'd love for you to contribute to our source code and to make `twilio-ruby`
+even better than it is today! Here are the guidelines we'd like you to follow:
+
+ - [Code of Conduct](#coc)
+ - [Question or Problem?](#question)
+ - [Issues and Bugs](#issue)
+ - [Feature Requests](#feature)
+ - [Documentation fixes](#docs)
+ - [Submission Guidelines](#submit)
+ - [Coding Rules](#rules)
+
+## <a name="coc"></a> Code of Conduct
+
+Help us keep `twilio-ruby` open and inclusive. Please be kind to and considerate
+of other developers, as we all have the same goal: make `twilio-ruby` as good as
+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
+[help@twilio.com](mailto:help@twilio.com) with any issues you have.
+
+## <a name="issue"></a> Found an Issue?
+
+If you find a bug in the source code or a mistake in the documentation, you can
+help us by submitting [an issue][issue-link]. If the file in which the error
+exists has this header:
+```
+"""
+This code was generated by
+\ / _    _  _|   _  _
+ | (_)\/(_)(_|\/| |(/_  v1.0.0
+      /       /
+"""
+```
+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
+a fix.
+
+**Please see the [Submission Guidelines](#submit) below.**
+
+## <a name="feature"></a> Want a Feature?
+
+You can request a new feature by submitting an issue to our
+[GitHub Repository][github]. If you would like to implement a new feature then
+consider what kind of change it is:
+
+* **Major Changes** that you wish to contribute to the project should be
+  discussed first with `twilio-ruby` contributors in an issue or pull request so
+  that we can develop a proper solution and better coordinate our efforts,
+  prevent duplication of work, and help you to craft the change so that it is
+  successfully accepted into the project.
+* **Small Changes** can be crafted and submitted to the
+  [GitHub Repository][github] as a Pull Request.
+
+## <a name="docs"></a> Want a Doc Fix?
+
+If you want to help improve the docs in the helper library, it's a good idea to
+let others know what you're working on to minimize duplication of effort. Create
+a new issue (or comment on a related existing one) to let others know what
+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
+Before you submit your issue search the archive, maybe your question was already
+answered.
+
+If your issue appears to be a bug, and hasn't been reported, open a new issue.
+Help us to maximize the effort we can spend fixing issues and adding new
+features by not reporting duplicate issues. Providing the following information
+will increase the chances of your issue being dealt with quickly:
+
+* **Overview of the Issue** - if an error is being thrown a non-minified stack
+  trace helps
+* **Motivation for or Use Case** - explain why this is a bug for you
+* **`twilio-ruby` Version(s)** - is it a regression?
+* **Operating System (if relevant)** - is this a problem with all systems or
+  only specific ones?
+* **Reproduce the Error** - provide an isolated code snippet or an unambiguous
+  set of steps.
+* **Related Issues** - has a similar issue been reported before?
+* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point
+  to what might be causing the problem (line of code or commit)
+
+**If you get help, help others. Good karma rules!**
+
+### Submitting a Pull Request
+Before you submit your pull request consider the following guidelines:
+
+* Search [GitHub][github] for an open or closed Pull Request that relates to
+  your submission. You don't want to duplicate effort.
+* Make your changes in a new git branch:
+
+    ```shell
+    git checkout -b my-fix-branch master
+    ```
+
+* Create your patch, **including appropriate test cases**.
+* Follow our [Coding Rules](#rules).
+* Run the full `twilio-ruby` test suite (aliased by `make test`), and ensure
+  that all tests pass.
+* Commit your changes using a descriptive commit message.
+
+    ```shell
+    git commit -a
+    ```
+  Note: the optional commit `-a` command line option will automatically "add"
+  and "rm" edited files.
+
+* Build your changes locally to ensure all the tests pass:
+
+    ```shell
+    make test
+    ```
+
+* Push your branch to GitHub:
+
+    ```shell
+    git push origin my-fix-branch
+    ```
+
+In GitHub, send a pull request to `twilio-ruby:master`.
+If we suggest changes, then:
+
+* Make the required updates.
+* Re-run the `twilio-ruby` test suite to ensure tests are still passing.
+* Commit your changes to your branch (e.g. `my-fix-branch`).
+* Push the changes to your GitHub repository (this will update your Pull Request).
+
+That's it! Thank you for your contribution!
+
+#### After your pull request is merged
+
+After your pull request is merged, you can safely delete your branch and pull
+the changes from the main (upstream) repository.
+
+## <a name="rules"></a> Coding Rules
+
+To ensure consistency throughout the source code, keep these rules in mind as
+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

data/ISSUE_TEMPLATE.md

@@ -0,0 +1,26 @@
+*Note: These issues are for bugs and feature requests for the helper libraries.
+If you need help or support, please email help@twilio.com and one of our experts
+will assist you!*
+
+
+**Version:**
+
+### Code Snippet
+```ruby
+# paste code here
+```
+
+### Exception/Log
+```
+<place exception/log here>
+```
+
+### Steps to Reproduce
+1.
+2.
+3.
+
+
+### Feature Request
+_If this is a feature request, make sure you search Issues for an existing
+request before creating a new one!_

data/LICENSE.md

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

data/README.md

@@ -11,13 +11,13 @@ A module for using the Twilio REST API and generating valid [TwiML](http://www.t
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 5.0.0.rc26'
+gem 'twilio-ruby', '~> 5.1.0'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.0.0.rc26
+gem install twilio-ruby -v 5.1.0
 ```
 
 To build and install the development branch yourself from the latest source:
@@ -103,14 +103,13 @@ auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
 # set up
 capability = Twilio::JWT::ClientCapability.new account_sid, auth_token
 
-
 # allow outgoing calls to an application
-outgoingScope = Twilio::JWT::ClientCapability::OutgoingClientScope.new 'AP11111111111111111111111111111111'
-capability.add_scope(outgoingScope)
+outgoing_scope = Twilio::JWT::ClientCapability::OutgoingClientScope.new 'AP11111111111111111111111111111111'
+capability.add_scope(outgoing_scope)
 
 # allow incoming calls to 'andrew'
-incomingScope = Twilio::JWT::ClientCapability::IncomingClientScope.new 'tom'
-capability.add_scope(incomingScope)
+incoming_scope = Twilio::JWT::ClientCapability::IncomingClientScope.new 'andrew'
+capability.add_scope(incoming_scope)
 
 # generate the token string
 @token = capability.to_s

data/VERSIONS.md

@@ -1,64 +1,36 @@
 # Versioning Strategy
 
-`twilio-ruby` uses a modified version of [Semantic Versioning][semver] for all 
-changes to the helper library.  It is strongly encouraged that you pin at least 
-the major version and potentially the minor version to avoid pulling in breaking 
-changes.
+`twilio-ruby` uses a modified version of [Semantic Versioning][semver] for
+all changes to the helper library. It is strongly encouraged that you pin at
+least the major version and potentially the minor version to avoid pulling in
+breaking changes.
 
 Semantic Versions take the form of `MAJOR`.`MINOR`.`PATCH`
 
-When bugs are fixed in the library in a backwards compatible way, the `PATCH` 
-level will be incremented by one.  When new features are added to the library 
+When bugs are fixed in the library in a backwards compatible way, the `PATCH`
+level will be incremented by one. When new features are added to the library
 in a backwards compatible way, the `PATCH` level will be incremented by one.
 `PATCH` changes should _not_ break your code and are generally safe for upgrade.
 
-When a new large feature set comes online or a small breaking change is 
-introduced, the `MINOR` version will be incremented by one and the `PATCH` 
+When a new large feature set comes online or a small breaking change is
+introduced, the `MINOR` version will be incremented by one and the `PATCH`
 version reset to zero. `MINOR` changes _may_ require some amount of manual code
-change for upgrade. These backwards-incompatible changes will generally be limited 
-to a small number of function signature changes.
+change for upgrade. These backwards-incompatible changes will generally be
+limited to a small number of function signature changes.
 
-The `MAJOR` version is used to indicate the family of technology represented by 
-the helper library.  It increased from `4.x.x` to `5.x.x` when Twilio moved to 
-auto generation of helper libraries.  Breaking changes that requires extensive 
-reworking of code (like the `4.x.x` to `5.x.x` upgrade) will case the `MAJOR` 
-version to be incremented by one, the `MINOR` and `PATCH` versions will be reset 
-to zero.  Twilio understands that this can be very disruptive, we will only 
-introduce this type of breaking change when absolutely necessary. New `MAJOR` 
-versions will be communicated in advance with `Release Candidates` and a 
-schedule.
+The `MAJOR` version is used to indicate the family of technology represented by
+the helper library. Breaking changes that requires extensive reworking of code
+will case the `MAJOR` version to be incremented by one, and the `MINOR` and
+`PATCH` versions will be reset to zero. Twilio understands that this can be very
+disruptive, so we will only introduce this type of breaking change when
+absolutely necessary. New `MAJOR` versions will be communicated in advance with
+`Release Candidates` and a schedule.
 
 ## Supported Versions
 
-`twilio-ruby` follows an evergreen model of support.  New features and 
-functionality will only be added to the current version.  The current version - 
-1 will continue to be supported with bugfixes and security updates, but no new 
+`twilio-ruby` follows an evergreen model of support. New features and
+functionality will only be added to the current version. The current version -
+1 will continue to be supported with bug fixes and security updates, but no new
 features.
 
-## Edge Features (alpha Branch)
-
-Twilio frequently rolls out new features in public and private beta periods.
-Twilio strives to ship early and often and bake customer feedback back into our 
-products.  To support that mission, the `twilio-ruby` helper library has an 
-`Edge` version based of the `alpha` branch.  This version is identified with an
-`alpha` metadata tag on the version number.
-
-The way the `Edge` artifact is created is by playing the `Edge` features on top
-of our stable artifact.  The `Edge` artifact will always have the same version 
-number as the stable artifact it was created from, but with an `alpha` suffix.
-
-For example, `5.0.0-alpha-1` is the `5.0.0` branch with `Edge` features included.
-If there is a change to one of the `Edge` features we may regenerate the `Edge`
-artifact and release a new `5.0.0-alpha-2`, new `Edge` artifacts simply increment
-the number after the `alpha` suffix.  All `Edge` features are considered 
-unstable and a backwards incompatible change in an `Edge` feature will not cause
-any version change so you should take care when upgrading from one `alpha` 
-version to another.  
-
-Once an `Edge` feature has matured it will be considered `Mainline` and included
-in the stable artifact, with a `MAJOR` or `MINOR` version bump.
-
-To use an `Edge` artifact in your Ruby project you will have to make sure that 
-you pin the artifact with `alpha` stability in your `pom.xml`.
-
-[semver]: http://semver.org/
+[semver]: http://semver.org/

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

@@ -27,11 +27,11 @@ module Twilio
             # 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)
+            #    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(
@@ -44,12 +44,12 @@ module Twilio
             # Streams PublicKeyInstance 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)
+            # @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)

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

@@ -33,11 +33,11 @@ module Twilio
               # 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)
+              #    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(
@@ -50,12 +50,12 @@ module Twilio
               # Streams DependentPhoneNumberInstance 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)
+              # @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)