twilio-ruby 5.0.0.rc24 → 5.0.0.rc25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f981811e9dfbdbb8ccebb024fc19d02f8572343e
-  data.tar.gz: 3816114ec774607280c563ceba304d71a7e1586c
+  metadata.gz: 01f12541d8117c7793ef1e5379c69d3e214d80d2
+  data.tar.gz: 4e5d252025e627244c09ef9eb42e0a92bb4f1e6e
 SHA512:
-  metadata.gz: 15f5dec31b1c60f3c48ecba58a092e0bfba5b3421dddf07cf88f4fd59187b8d1b42aa1c7b763f9cd38f7422a2d8dabe9609624e915a4b9116affe157843c6a4d
-  data.tar.gz: adc945fc725af82de455d4ef556509bf1a15424c8eaa98206d7a27e07d9fdb583ed73d7968373d2b3cb1bfb06778a77d78efa55f2b368dbb0e5a34e309f54ebe
+  metadata.gz: 076f2cb21d3b85b132d75f8057c87c50520eaa5abfd336f49013e98109196a21ffb709aba5a8454338527beb93b5bdcc125bccbaab84c27eee27ee3ab24ec64e
+  data.tar.gz: ed11a19b6ccfe01f1e07f3e3894a25ffbae4a2289a7d5c4cfb1a2529d7a9daa8e0dca1ec89c1f6a2ffa36d74d0e53d05850dda355e8fd60418be18016b4c29c4

data/CHANGES.md

@@ -1,28 +1,48 @@
 twilio-ruby changelog
 =====================
-[2017-06-22] Version 5.0.0-rc24
+[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
+[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
+[2017-06-15] Version 5.0.0.rc22
 -------------------------------
 - Refactor JWT token constructors 
 
 
-[2017-05-24] Version 5.0.0-rc21
+[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
+[2017-05-22] Version 5.0.0.rc20
 -------------------------------
 - Add Wireless Domain
 - Add Fax Domain
@@ -31,7 +51,7 @@ twilio-ruby changelog
 - 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
+[2017-04-27] Version 5.0.0.rc19
 -------------------------------
 
 - Add chat v2.
@@ -39,28 +59,28 @@ twilio-ruby changelog
 - Message `ValidityPeriod` parameter.
 - New Usage API categories.
 
-Version 5.0.0-rc18
+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
+Version 5.0.0.rc16
 -------------------------------
 
 Release September 1, 2016
 
 - Add voice grant.
 
-Version 5.0.0-rc8
+Version 5.0.0.rc8
 -------------
 
 Release July 8, 2016
 
 - Add SMS and Facebook Messenger for Notify
 
-Version 5.0.0-rc7
+Version 5.0.0.rc7
 -------------
 
 Release June 9, 2016
@@ -68,14 +88,14 @@ Release June 9, 2016
 - Add messaging feedback support
 
 
-Version 5.0.0-rc5
+Version 5.0.0.rc5
 -------------
 
 Release May 31, 2016
 
 - Add preview.twilio.com/wireless support
 
-Version 5.0.0-rc4
+Version 5.0.0.rc4
 -------------
 
 Release March 28, 2016

data/LICENSE.md

@@ -1,21 +1,21 @@
-Copyright (c) 2010-2014 Andrew Benton.
+MIT License
 
-The MIT License (MIT)
+Copyright (C) 2017, Twilio, Inc. <help@twilio.com>
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 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.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,9 +1,9 @@
-[![Gem Version](http://img.shields.io/gem/v/twilio-ruby.svg)][gem]
+# twilio-ruby
+
 [![Build Status](http://img.shields.io/travis/twilio/twilio-ruby.svg)][travis]
+[![Gem Version](http://img.shields.io/gem/v/twilio-ruby.svg)][gem]
 [![Code Quality](http://img.shields.io/codeclimate/github/twilio/twilio-ruby.svg)][codeclimate]
 
-# twilio-ruby
-
 A module for using the Twilio REST API and generating valid [TwiML](http://www.twilio.com/docs/api/twiml/ "TwiML - Twilio Markup Language"). [Click here to read the full documentation.][documentation]
 
 ## Installation
@@ -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.rc21'
+gem 'twilio-ruby', '~> 5.0.0.rc25'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.0.0.rc21
+gem install twilio-ruby -v 5.0.0.rc25
 ```
 
 To build and install the development branch yourself from the latest source:
@@ -41,7 +41,7 @@ During the Release Candidate period of this library, please leave all feedback a
 
 ### Setup Work
 
-``` ruby
+```ruby
 require 'twilio-ruby'
 
 # put your own credentials here
@@ -63,7 +63,7 @@ end
 
 ### Make a Call
 
-``` ruby
+```ruby
 @client.api.account.calls.create(
   from: '+14159341234',
   to: '+16105557069',
@@ -73,7 +73,7 @@ end
 
 ### Send an SMS
 
-``` ruby
+```ruby
 @client.api.account.messages.create(
   from: '+14159341234',
   to: '+16105557069',
@@ -82,7 +82,7 @@ end
 ```
 
 ### Customizing your HTTP Client
-twilio-ruby uses [Faraday](https://github.com/lostisland/faraday) to make HTTP requests. You can tell Twilio::REST::Client to use any of the Faraday adapters like so:
+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
@@ -94,24 +94,26 @@ If you just need to generate a Capability Token for use with Twilio Client, you
 can do this:
 
 ``` ruby
-require 'rubygems' # not necessary with ruby 1.9 but included for completeness
 require 'twilio-ruby'
 
 # put your own account credentials here:
-account_sid = 'AC043dcf9844e13758bc3a36a84c29761'
-auth_token = '62ea81de3a5b413254eb263595357c69'
+account_sid = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
 
 # set up
-capability = Twilio::Util::Capability.new account_sid, auth_token
+capability = Twilio::JWT::ClientCapability.new account_sid, auth_token
+
 
 # allow outgoing calls to an application
-capability.allow_client_outgoing 'AP89a0180a1a4ddf1da954efca349b7a20'
+outgoingScope = Twilio::JWT::ClientCapability::OutgoingClientScope.new 'AP11111111111111111111111111111111'
+capability.add_scope(outgoingScope)
 
 # allow incoming calls to 'andrew'
-capability.allow_client_incoming 'andrew'
+incomingScope = Twilio::JWT::ClientCapability::IncomingClientScope.new 'tom'
+capability.add_scope(incomingScope)
 
 # generate the token string
-@token = capability.generate
+@token = capability.to_s
 ```
 
 There is a slightly more detailed document in the [Capability][capability]
@@ -123,28 +125,26 @@ TwiML support is based on the [Builder][builder] library. You can construct a
 TwiML response like this:
 
 ``` ruby
-require 'rubygems' # not necessary with ruby 1.9 but included for completeness
 require 'twilio-ruby'
 
-# build up a response
-response = Twilio::TwiML::Response.new do |r|
-  r.Say 'hello there', voice: 'alice'
-  r.Dial callerId: '+14159992222' do |d|
-    d.Client 'jenny'
+response = Twilio::TwiML::VoiceResponse.new do |r|
+  r.say('hello there', voice: 'alice')
+  r.dial('', caller_id: '+14159992222') do |d|
+    d.client 'jenny'
   end
 end
 
 # print the result
-puts response.text
+puts response.to_s()
 ```
 
 This will print the following (except for the whitespace):
 
-``` xml
+```xml
 <?xml version="1.0" encoding="UTF-8"?>
 <Response>
   <Say voice="alice">hello there</Say>
-  <Dial callerId="+14159992222">
+  <Dial callerid="+14159992222">
     <Client>jenny</Client>
   </Dial>
 </Response>
@@ -155,11 +155,11 @@ This will print the following (except for the whitespace):
 This library supports and is [tested against][travis] the following Ruby
 implementations:
 
+- Ruby 2.4.0
+- Ruby 2.3.0
 - Ruby 2.2.0
 - Ruby 2.1.0
 - Ruby 2.0.0
-- [JRuby][jruby]
-- [Rubinius][rubinius]
 
 [capability]: https://github.com/twilio/twilio-ruby/wiki/Capability
 [builder]: http://builder.rubyforge.org/
@@ -171,7 +171,6 @@ implementations:
 [gem]: https://rubygems.org/gems/twilio
 [travis]: http://travis-ci.org/twilio/twilio-ruby
 [codeclimate]: https://codeclimate.com/github/twilio/twilio-ruby
-[jruby]: http://www.jruby.org
-[rubinius]: http://rubini.us
 [upgrade]: https://github.com/twilio/twilio-ruby/wiki/Ruby-Version-5.x-Upgrade-Guide
 [issues]: https://github.com/twilio/twilio-ruby/issues
+[faraday]: https://github.com/lostisland/faraday

data/examples/examples.rb

@@ -1,83 +1,74 @@
-# examples version 3
+# examples version
 
-@account_sid = 'AC043dcf9844e04758bc3a36a84c29761'
-@auth_token = '62ea81de3a5b414154eb263595357c69'
+@account_sid = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+@auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
 # set up a client
 @client = Twilio::REST::Client.new(@account_sid, @auth_token)
 
 ################ ACCOUNTS ################
 
 # shortcut to grab your account object (account_sid is inferred from the client's auth credentials)
-@account = @client.account
+@account = @client.api.account
 
 # list your (sub)accounts
-@client.accounts.list
+@accounts = @client.api.accounts.each do |account|
+  puts(account)
+end
 
 # grab an account instance resource if you know the sid
-@account = @client.accounts.get(@account_sid)
-# http round trip happens here
-puts @account.friendly_name
+@account = @client.api.accounts(account_sid).fetch
+puts(@account.friendly_name)
 
 # update an account's friendly name
-@client.accounts.get(@account_sid).update(friendly_name: 'A Fabulous Friendly Name')
+@client.api.accounts(account_sid).update(friendly_name: 'A Fabulous Friendly Name')
 
 ################ CALLS ################
 
 # print a list of calls (all parameters optional)
-@account.calls.list(
-  page: 0,
-  page_size: 1000,
-  start_time: '2010-09-01'
-).each do |call|
+@client.calls.list(limit: 10, start_time: '2010-09-01').each do |call|
   puts call.sid
 end
 
 # get a particular call and list its recording urls
-@account.calls.get('CAXXXXXXX').recordings.list.each do |r|
-  puts r.wav
+@client.calls('CAXXXXXXX').fetch do |call|
+  call.recordings().each do |r|
+    puts r.wav
+  end
 end
 
 # make a new outgoing call. returns a call object just like calls.get
-@call = @account.calls.create(
+@call = @client.calls.create(
   from: '+14159341234',
   to: '+18004567890',
   url: 'http://example.com/call-handler'
 )
 
 # cancel the call if not already in progress
-@account.calls.get(@call.sid).update(status: 'canceled')
-# or equivalently
-@call.update(status: 'canceled')
-# or simply
-@call.cancel
+@client.calls(@call.sid).update(status: 'canceled')
 
 # redirect and then terminate a call
-@call = @account.calls.get('CA386025c9bf5d6052a1d1ea42b4d16662')
+@call = client.calls('CAXXXXXXX')
 @call.update(url: 'http://example.com/call-redirect')
 @call.update(status: 'completed')
-# or, use the aliases...
-@call.redirect_to('http://example.com/call-redirect')
-@call.hangup
 
 ################ SMS MESSAGES ################
 
-# print a list of messages
-@account.messages.list(date_sent: '2010-09-01').each do |message|
-  puts message.body
+@client.messages.list(date_sent: '2010-09-01').each do |message|
+  puts message.date_created
 end
 
 # print a particular sms message
-puts @account.messages.get('SMXXXXXXXX').body
+puts @client.messages('SMXXXXXXXX').fetch.body
 
 # send an sms
-@account.messages.create(
+@client.messages.create(
   from: '+14159341234',
   to: '+16105557069',
   body: 'Hey there!'
 )
 
 # send an mms
-@account.messages.create(
+@client.messages.create(
   from: '+14159341234',
   to: '+16105557069',
   media_urls: 'http://example.com/media.png'
@@ -86,56 +77,54 @@ puts @account.messages.get('SMXXXXXXXX').body
 ################ PHONE NUMBERS ################
 
 # get a list of supported country codes
-@account.available_phone_numbers.list
+@client.available_phone_numbers.list
 
 # print some available numbers
-@numbers = @account.available_phone_numbers.get('US').local.list(
-  contains: 'AWESOME'
-)
+@client.available_phone_numbers('US').local.list().each do |num|
+
+end
+
+@numbers = @client.available_phone_numbers('US').local.list(area_code: '908')
 @numbers.each { |num| puts num.phone_number }
 
 # buy the first one
-@account.incoming_phone_numbers.create(phone_number: @numbers[0].phone_number)
+@client.incoming_phone_numbers.create(phone_number: @numbers[0].phone_number)
 
 # update an existing phone number's voice url
-number = @account.incoming_phone_numbers.get('PNdba508c5616a7f5e141789f44f022cc3')
-number.update(voice_url: 'http://example.com/voice')
+@client.incoming_phone_numbers('PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx').update(
+    voice_url: 'http://example.com/voice'
+)
 
 # decommission an existing phone number
-numbers = @account.incoming_phone_numbers.list(
-  friendly_name: 'A Fabulous Friendly Name'
-)
-numbers[0].delete
+numbers = @client.incoming_phone_numbers.list(friendly_name: 'A Fabulous Friendly Name')
+number = numbers[0].sid
+@client.incoming_phone_numbers(number).delete
+
 ################ CONFERENCES  ################
 
 # get a particular conference's participants object and stash it
-conference = @account.conferences.get('CFbbe46ff1274e283f7e3ac1df0072ab39')
-@participants = conference.participants
+conference = @client.conferences('CFxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx').fetch
+@participants = conference.participants()
 
 # list participants
-@participants.list.each do |p|
+@participants.each do |p|
   puts p.sid
 end
 
 # update a conference participant
-@participants.get('CA386025c9bf5d6052a1d1ea42b4d16662').update(muted: 'true')
-# or an easier way
-@participants.get('CA386025c9bf5d6052a1d1ea42b4d16662').mute
-
-# and, since we're lazy loading, this would only incur one http request
-@account.conferences.get('CFbbe46ff1274e283f7e3ac1df0072ab39').participants
-  .get('CA386025c9bf5d6052a1d1ea42b4d16662').update(muted: 'true')
+@client.conferences('CFxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')
+    .participants('CAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx').update(muted: 'true')
 
 ################ QUEUES ###################
 
 # create a new queue
-@queue = @account.queues.create(friendly_name: 'MyQueue', max_size: 50)
+@queue = @client.queues.create(friendly_name: 'MyQueue', max_size: 50)
 
 # get a list of queues for this account
-@queues = @account.queues.list
+@queues = @client.queues.list()
 
 # get a particular queue and its members
-@queue = @account.queues.get("QQb6765b0458714964970a73dcaf55efd1")
+@queue = @client.queues('QQxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx').fetch
 @members = @queue.members
 
 #list members
@@ -144,5 +133,5 @@ end
 end
 
 # dequeue a particular user and run twiml at a specific url
-@member = @members.get('CA386025c9bf5d6052a1d1ea42b4d16662')
-@member.dequeue('http://myapp.com/deque')
+@client.queues('QQxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')
+    .members('CAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx').update(url: 'http://myapp.com/deque', method: 'POST')