twilio-ruby 4.13.0 → 5.6.4

data/CHANGES.md

@@ -1,117 +1,455 @@
 twilio-ruby changelog
 =====================
 
-Version 4.13.0
---------------
+[2018-02-23] Version 5.6.4
+---------------------------
+**Library**
+- PR #385 - Fix ClientCapability appParams
 
-Released September 19, 2016:
+**Api**
+- Add `trim` param to Outbound Calls API
 
-- Add VideoGrant.
+**Lookups**
+- Add support for `fraud` lookup type
 
-Version 4.12.1
---------------
+**Numbers**
+- Initial Release
 
-Released September 1, 2016:
+**Video**
+- [composer] Add `SEQUENCE` value to available layouts, and `trim` and `reuse` params.
 
-- Add VoiceGrant.
 
-Version 4.11.1
--------------
+[2018-02-09] Version 5.6.3
+---------------------------
+**Api**
+- Add `AnnounceUrl` and `AnnounceMethod` params for conference announce
 
-Released February 12, 2016:
+**Chat**
+- Add support to looking up user channels by identity in v1
 
-- Add missing Keys mount to Account
 
-Version 4.11.0
--------------
+[2018-01-30] Version 5.6.2
+---------------------------
+**Api**
+- Add `studio-engagements` usage key
 
-Released January 28, 2016:
+**Preview**
+- Remove Studio Engagement Deletion
 
-- Add support for alternative auth (eg. Keys)
+**Studio**
+- Initial Release
 
-Version 4.10.0
--------------
+**Video**
+- [omit] Beta: Allow updates to `SubscribedTracks`.
+- Add `SubscribedTracks`.
+- Add track name to Video Recording resource
+- Add Composition and Composition Media resources
 
-Released January 28, 2016:
 
-- Add support for filter_friendly_name in WorkflowConfig
-- Load reservations by default in TaskRouter
+[2018-01-22] Version 5.6.1
+---------------------------
+**Api**
+- Add `conference_sid` property on Recordings
+- Add proxy and sms usage key
 
-Version 4.9.1
--------------
+**Chat**
+- Make user channels accessible by identity
+- Add notifications logs flag parameter
 
-Release January 28, 2016
+**Fax**
+- Added `ttl` parameter
+  `ttl` is the number of minutes a fax is considered valid.
 
-- Fix ip messaging first person grant
+**Preview**
+- Add `call_delay`, `extension`, `verification_code`, and `verification_call_sids`.
+- Add `failure_reason` to HostedNumberOrders.
+- Add DependentHostedNumberOrders endpoint for AuthorizationDocuments preview API.
 
-Version 4.9.0
--------------
 
-Release December 17, 2015
+[2017-12-15] Version 5.6.0
+---------------------------
+**Api**
+- Add `voip`, `national`, `shared_cost`, and `machine_to_machine` sub-resources to `/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{IsoCountryCode}/`
+- Add programmable video keys
 
-- Release ip messaging
+**Preview**
+- Add `verification_type` and `verification_document_sid` to HostedNumberOrders.
 
-Version 4.8.0
--------------
+**Proxy**
+- Fixed typo in session status enum value
 
-Release December 8, 2015
+**Twiml**
+- Fix Dial record property incorrectly typed as accepting TrimEnum values when it actually has its own enum of values. *(breaking change)*
+- Add `priority` and `timeout` properties to Task TwiML.
+- Add support for `recording_status_callback_event` for Dial verb and for Conference
 
-- Make nbf optional
 
-Version 4.7.0
--------------
+[2017-12-01] Version 5.5.1
+---------------------------
+**Api**
+- Use the correct properties for Dependent Phone Numbers of an Address *(breaking change)*
+- Update Call Recordings with the correct properties
 
-Release December 3, 2015
+**Preview**
+- Add `status` and `email` query param filters for AuthorizationDocument list endpoint
 
-- Add access tokens
+**Proxy**
+- Added DELETE support to Interaction
+- Standardized enum values to dash-case
+- Rename Service#friendly_name to Service#unique_name
 
-Version 4.6.2
--------------
+**Video**
+- Remove beta flag from `media_region` and `video_codecs`
+
+**Wireless**
+- Bug fix: Changed `operator_mcc` and `operator_mnc` in `DataSessions` subresource from `integer` to `string`
+
+
+[2017-11-17] Version 5.5.0
+---------------------------
+**Sync**
+- Add TTL support for Sync objects *(breaking change)*
+  - The required `data` parameter on the following actions is now optional: "Update Document", "Update Map Item", "Update List Item"
+  - New actions available for updating TTL of Sync objects: "Update List", "Update Map", "Update Stream"
+
+**Video**
+- [bi] Rename `RoomParticipant` to `Participant`
+- Add Recording Settings resource
+- Expose EncryptionKey and MediaExternalLocation properties in Recording resource
+
+
+[2017-11-10] Version 5.4.5
+---------------------------
+**Accounts**
+- Add AWS credential type
+
+**Preview**
+- Removed `iso_country` as required field for creating a HostedNumberOrder.
+
+**Proxy**
+- Added new fields to Service: geo_match_level, number_selection_behavior, intercept_callback_url, out_of_session_callback_url
+
+
+[2017-11-03] Version 5.4.4
+---------------------------
+**Library**
+- PR #365: Fixed proxy interpolation. Thanks @ankane.
+
+**Api**
+- Add programmable video keys
+
+**Video**
+- Add `Participants`
+
+
+[2017-10-27] Version 5.4.3
+---------------------------
+**Chat**
+- Add Binding resource
+- Add UserBinding resource
+
+
+[2017-10-20] Version 5.4.2
+---------------------------
+**Library**
+- #360 Fix downcasing twiml parameters that are not snake_case
+
+[2017-10-20] Version 5.4.1
+---------------------------
+**Library**
+- #359 Correctly set headers on Twilio::Response
+
+**Api**
+- Add `address_sid` param to IncomingPhoneNumbers create and update
+- Add 'fax_enabled' option for Phone Number Search
+
+
+[2017-10-13] Version 5.4.0
+---------------------------
+**Api**
+- Add `smart_encoded` param for Messages
+- Add `identity_sid` param to IncomingPhoneNumbers create and update
+
+**Preview**
+- Make 'address_sid' and 'email' optional fields when creating a HostedNumberOrder
+- Add AuthorizationDocuments preview API.
+
+**Proxy**
+- Initial Release
+
+**Wireless**
+- Added `ip_address` to sim resource
+
+
+[2017-10-06] Version 5.3.1
+---------------------------
+**Preview**
+- Add `acc_security` (authy-phone-verification) initial api-definitions
+
+**Taskrouter**
+- [bi] Less verbose naming of cumulative and real time statistics
+
+
+[2017-09-29] Version 5.3.0
+---------------------------
+**Library**
+- Remove left over files from legacy 4.x library
+
+**Chat**
+- Make member accessible through identity
+- Make channel subresources accessible by channel unique name
+- Set get list 'max_page_size' parameter to 100
+- Add service instance webhook retry configuration
+- Add media message capability
+- Make `body` an optional parameter on Message creation. *(breaking change)*
+
+**Notify**
+- `data`, `apn`, `gcm`, `fcm`, `sms` parameters in `Notifications` create resource now accept objects (hashes) instead of strings. Passing manually stringified json will continue to work.
+
+**Taskrouter**
+- Add new query ability by TaskChannelSid or TaskChannelUniqueName
+- Move Events, Worker, Workers endpoint over to CPR
+- Add new RealTime and Cumulative Statistics endpoints
+
+**Video**
+- Create should allow an array of video_codecs.
+- Add video_codecs as a property of room to make it externally visible.
+
+
+[2017-09-15] Version 5.2.3
+---------------------------
+**Api**
+- Add `sip_registration` property on SIP Domains
+- Add new video and market usage category keys
+- Add support for transferring IncomingPhoneNumbers between accounts.
+
+
+[2017-09-08] Version 5.2.2
+---------------------------
+- Add configurable timeout to HttpClient
+
+[2017-09-01] Version 5.2.1
+---------------------------
+**Sync**
+- Add support for Streams
+
+**Wireless**
+- Added DataSessions sub-resource to Sims.
 
-Release November 19, 2015
 
-- Fix Pricing Messages
+[2017-08-25] Version 5.2.0
+---------------------------
+**Library**
+- Add `last_request`, `last_response` properties to http client for easier debugging.
+- Add `Request` class to abstract http client implementations.
+- Rename `TwilioResponse` to `Response` for consistency, deprecate `TwilioResponse` class.
+- Support libxml 2 and 3. Issue #315. Thanks @malmckay.
+- Add `inspect` methods to all classes. Thanks @malmckay.
 
-Version 4.6.1
+**Api**
+- Update `status` enum for Recordings to include 'failed'
+- Add `error_code` property on Recordings
+
+**Chat**
+- Add mutable parameters for channel, members and messages
+
+**Video**
+- New `media_region` parameter when creating a room, which controls which region media will be served out of.
+
+
+[2017-08-18] Version 5.1.2
+---------------------------
+**Api**
+- Add VoiceReceiveMode {'voice', 'fax'} option to IncomingPhoneNumber UPDATE requests
+
+**Chat**
+- Add channel message media information
+- Add service instance message media information
+
+**Preview**
+- Removed 'email' from bulk_exports configuration api [bi]. No migration plan needed because api has not been used yet.
+- Add DeployedDevices.
+
+**Sync**
+- Add support for Service Instance unique names
+
+
+[2017-08-10] Version 5.1.1
+---------------------------
+**Library**
+- Don't override Faraday default param encoder. Thanks to @isaacseymour. PR #309
+- Fix incorrectly aliased `to_xml` on TwiML classes. Thanks to @philnash. PR #318
+- Only define `to_s` on BaseJWT instead of subclasses. Thanks to @philnash. PR #321
+- Silence deprecation messages in testing. Thanks to @philnash. PR #323
+
+**Api**
+- Add New wireless usage keys added
+- Add `auto_correct_address` param for Addresses create and update
+
+**Video**
+- Add `video_codec` enum and `video_codecs` parameter, which can be set to either `VP8` or `H264` during room creation.
+- Restrict recordings page size to 100
+
+**Chat**
+- Add ChatGrant to available access tokens.
+- Mark IpMessagingGrant as deprecated in favor of ChatGrant.
+
+
+[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
+
+[2017-07-07] Version 5.0.0.rc26
+--------------------------------
+**Api**
+- [omit] Rachet /Keys and /SigningKeys
+
+**Preview**
+- Add `status_callback_url` and `status_callback_method` to HostedNumberOrders.
+
+
+[2017-07-06] Version 5.0.0.rc25
+--------------------------------
+**Messaging**
+- Fix incorrectly typed capabilities property for PhoneNumbers.
+
+**Notify**
+- Add `ToBinding` optional parameter on Notifications resource creation. Accepted values are json strings.
+
+**Preview**
+- [omit] Enabled beta feature flag (api.vault.data-platform) for bulk_exports api
+
+**Video**
+- Filter recordings by date using the parameters `DateCreatedAfter` and `DateCreatedBefore`.
+- Override the default time-to-live of a recording's media URL through the `Ttl` parameter (in seconds, default value is 3600).
+- Add query parameters `SourceSid`, `Status`, `DateCreatedAfter` and `DateCreatedBefore` to the convenience method for retrieving Room recordings.
+
+**Wireless**
+- Added national and international data limits to the RatePlans resource.
+
+
+[2017-06-22] Version 5.0.0.rc24
+-------------------------------
+- Namespaced Policy, Grants, and Scope to their respective Token.
+- Added `announce_url` and `annouce_url_method` to Conference update.
+- Added `store_media` to Fax.
+
+[2017-06-19] Version 5.0.0.rc23
+-------------------------------
+- Fixed ClientCapability parameter encoded bug.
+- Optional URL parameter for TwiML Play verb.
+
+[2017-06-15] Version 5.0.0.rc22
+-------------------------------
+- Refactor JWT token constructors
+
+
+[2017-05-24] Version 5.0.0.rc21
+-------------------------------
+- Add HostedNumbers preview support.
+- Add Proxy preview support.
+- Add BulkExports preview support.
+
+[2017-05-22] Version 5.0.0.rc20
+-------------------------------
+- Add Wireless Domain
+- Add Fax Domain
+- Add Video Domain
+- Updated Usage Trigger enums with missing categories.
+- Add `area_code_geomatch`, `validtiy_period`, `fallback_to_long_code` to Messaging Service
+- Converted `TwilioException` to `TwilioError`
+
+[2017-04-27] Version 5.0.0.rc19
+-------------------------------
+
+- Add chat v2.
+- Wireless rate plans updates.
+- Message `ValidityPeriod` parameter.
+- New Usage API categories.
+
+Version 5.0.0.rc18
+-------------------------------
+
+Release April 17, 2017
+
+- Update VideoGrant access token to accept `room` instead of `configuration_profile_sid`
+
+Version 5.0.0.rc16
+-------------------------------
+
+Release September 1, 2016
+
+- Add voice grant.
+
+Version 5.0.0.rc8
 -------------
 
-Release November 10, 2015
+Release July 8, 2016
 
-- Fix TrunkingClient references
+- Add SMS and Facebook Messenger for Notify
 
-Version 4.6.0
+Version 5.0.0.rc7
 -------------
 
-Release October 28, 2015
+Release June 9, 2016
+
+- Add messaging feedback support
 
-- Add /Keys endpoint
 
-Version 4.4.0
+Version 5.0.0.rc5
 -------------
 
-Release September 23, 2015
+Release May 31, 2016
 
-- Add fetching a list of worker reservations
-- Add TaskRouter Workflow builder
+- Add preview.twilio.com/wireless support
 
-Version 4.3.0
+Version 5.0.0.rc4
 -------------
 
-Release August 11, 2015
+Release March 28, 2016
 
-- Add support for new Taskrouter JWT Functionality, JWTs now grant access to
-  - Workspace
-  - Worker
-  - TaskQueue
+- Add notifications.twilio.com subdomain
 
-Version 4.2.1
+Version 5.0.0
 -------------
 
-Release June 19, 2015
+Release January 29, 2016
 
-- Allow passing URL parameters through when getting statistics for TaskRouter objects
-- URI encode phone number lookups
-- Adds documentation for lookups
+- First class paging support
+- Streaming auto-paging functionality
+- Separation between strict paging and streaming, with network-efficient defaults
+- Fully configurable and swappable HTTP Client interfaces
+- Normalization of mounts -> endpoints relations, with first-class unified support for subdomains and multi-version support
+- Fixed URL pathing of subresources, preventing edge case errors with path building via mounting
+- Proper serialization/deserialization of types (integers, dates, etc.)
 
 Version 4.2.0
 -------------

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/Gemfile

@@ -3,8 +3,8 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'rake', '~> 10.1'
-  gem 'rspec', '~> 3.0'
   gem 'fakeweb', '~> 1.3'
   gem 'rack', '~> 1.3'
+  gem 'rake', '~> 10.1'
+  gem 'rspec', '~> 3.0'
 end