twilio-ruby 3.11.5 → 5.0.0

data/docs/usage/conferences.rst

@@ -1,108 +0,0 @@
-.. module:: twilio.rest.resources
-
-==============================
-Conferences and Participants
-==============================
-
-For more information, see the `Conference REST Resource <http://www.twilio.com/docs/api/rest/conference>`_
-and `Participant REST Resource <http://www.twilio.com/docs/api/rest/participant>`_ documentation.
-
-
-Listing Conferences
------------------------
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    account_sid = "ACXXXXXXXXXXXXXXXXX"
-    auth_token = "YYYYYYYYYYYYYYYYYY"
-
-    @client = Twilio::REST::Client.new account_sid, auth_token
-    @conferences = @client.account.conferences.list()
-
-    @conferences.each do |conference|
-        puts conference.sid
-    end
-
-
-Filtering Conferences
------------------------
-
-The :meth:`Twilio::REST::Conferences.list` method supports filtering on :attr:`status`,
-:attr:`date_updated`, :attr:`date_created` and :attr:`friendly_name`. The following code
-will return a list of all in-progress conferences and print their friendly name.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    account_sid = "ACXXXXXXXXXXXXXXXXX"
-    auth_token = "YYYYYYYYYYYYYYYYYY"
-
-    @client = Twilio::REST::Client.new account_sid, auth_token
-    @conferences = @client.account.conferences.list({:status => "in-progress"})
-    
-    @conference.each do |conference|
-        puts conference.friendly_name
-    end
-
-
-Listing Participants
-----------------------
-
-Each :class:`Conference` has a :attr:`participants` instance which represents all current users in the conference
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    account_sid = "ACXXXXXXXXXXXXXXXXX"
-    auth_token = "YYYYYYYYYYYYYYYYYY"
-
-    @client = Twilio::REST::Client.new account_sid, auth_token
-    @conference = @client.account.conferences.get("CF123")
-
-    @conference.participants.list.each.do |paricipant|
-        puts participant.sid
-    end
-
-:class:`Conferences` and :class:`Participants` are subclasses of :class:`ListResource`.
-Therefore, their instances have the inherited methods such as :meth:`count`.
-
-
-Managing Participants
-----------------------
-
-Each :class:`Conference` has a :attr:`participants` function that returns a
-:class:`Participants` instance. This behavior differs from other list resources
-because :class:`Participants` needs a participant sid AND a conference sid to
-access the participants resource.
-
-Participants can be either muted or kicked out of the conference. The following
-code kicks out the first participant and mutes the rest.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    account_sid = "ACXXXXXXXXXXXXXXXXX"
-    auth_token = "YYYYYYYYYYYYYYYYYY"
-
-    @client = Twilio::REST::Client.new account_sid, auth_token
-    @participants = @client.account.conferences.get("CF123").participants.list()
-
-    if @participants.empty?
-        return
-
-    # Kick the first person out
-    @participants.pop().kick()
-
-    # And mute the rest
-    @participants.each do |participant|
-        participant.mute()
-

data/docs/usage/errors.rst

@@ -1,29 +0,0 @@
-Error Handling
-==============
-
-Exceptions
-----------
-If the Twilio API returns a 400 or a 500 level HTTP response,
-the twilio-ruby library will throw a :class:`Twilio::REST::RequestError`.
-400-level errors are normal during API operation ("Invalid number",
-"Cannot deliver SMS to that number", for example) and should be
-handled appropriately.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    account_sid = "ACXXXXXXXXXXXXXXXXX"
-    auth_token = "YYYYYYYYYYYYYYYYYY"
-
-    begin
-        @client = Twilio::REST::Client.new account_sid, auth_token
-        client.account.messages.create({
-            :from => '+1234567890',
-            :to => '+1234567890',
-            :body => 'Hello world'
-        })
-    rescue Twilio::REST::RequestError => e
-        puts e.message
-    end

data/docs/usage/messages.rst

@@ -1,109 +0,0 @@
-.. module:: twilio.rest.resources.sms_messages
-
-============
-Messages
-============
-
-For more information, see the
-`Message REST Resource <http://www.twilio.com/docs/api/rest/message>`_
-documentation.
-
-
-Sending a Text Message
-----------------------
-
-Send a text message in only a few lines of code.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    account_sid = "ACXXXXXXXXXXXXXXXXX"
-    auth_token = "YYYYYYYYYYYYYYYYYY"
-
-    @client = Twilio::REST::Client.new account_sid, auth_token
-
-    @message = @client.account.messages.create({:to => "+13216851234",
-                                       :from => "+15555555555",
-                                       :body => "Hello!"})
-
-If you want to send a message from a `short code
-<http://www.twilio.com/api/sms/short-codes>`_ on Twilio, just set :attr:`from`
-to your short code's number.
-
-
-Sending a Picture Message
--------------------------
-
-To send a picture, set :attr:`media_url` to the url of the picture you wish to send.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    account_sid = "ACXXXXXXXXXXXXXXXXX"
-    auth_token = "YYYYYYYYYYYYYYYYYY"
-
-    @client = Twilio::REST::Client.new account_sid, auth_token
-
-    @message = @client.account.messages.create({:to => "+15558676309",
-                                       :from => "+15555555555",
-                                       :body => "Jenny I need you!",
-                                       :media_url => "http://twilio.com/heart.jpg"})
-
-You can send multiple pictures in the same message by setting :attr:`media_url` to
-an array of urls.
-
-.. code-block:: ruby
-
-    @message = @client.account.messages.create({:to => "+15558676309",
-                                       :from => "+15555555555",
-                                       :body => "Jenny I need you!",
-                                       :media_url => [
-                                            "http://twilio.com/heart.jpg",
-                                            "http://twilio.com/rose.jpg"
-                                        ]})
-
-
-Retrieving Sent Messages
--------------------------
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    account_sid = "ACXXXXXXXXXXXXXXXXX"
-    auth_token = "YYYYYYYYYYYYYYYYYY"
-
-    @client = Twilio::REST::Client.new account_sid, auth_token
-
-    @client.account.messages.list.each do |message|
-        puts message.body
-
-
-Filtering Your Messages
--------------------------
-
-The :meth:`list` methods supports filtering on :attr:`to`, :attr:`from`,
-and :attr:`date_sent`.
-The following will only show messages to "+5466758723" on January 1st, 2011.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    account_sid = "ACXXXXXXXXXXXXXXXXX"
-    auth_token = "YYYYYYYYYYYYYYYYYY"
-
-    @client = Twilio::REST::Client.new account_sid, auth_token
-
-    @messages = @client.account.messages.list({:to => "+5466758723", :date_sent => "2011-01-01"})
-
-    @messages.each do |message|
-        puts message.body
-    
-

data/docs/usage/notifications.rst

@@ -1,70 +0,0 @@
-.. module:: twilio.rest.resources
-
-====================
-Notifications
-====================
-
-For more information, see the `Notifications REST Resource
-<http://www.twilio.com/docs/api/rest/notification>`_ documentation.
-
-
-Listing Your Notifications
-----------------------------
-
-The following code will print out additional information about each of your
-current :class:`Notification` resources.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    account_sid = "ACXXXXXXXXXXXXXXXXX"
-    auth_token = "YYYYYYYYYYYYYYYYYY"
-
-    @client = Twilio::REST::Client.new account_sid, auth_token
-
-    @client.account.notifications.list().each do |notification|:
-        puts notification.more_info
-
-You can filter transcriptions by :attr:`log` and :attr:`message_date`.
-The :attr:`log` value is 0 for `ERROR` and 1 for `WARNING`.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    account_sid = "ACXXXXXXXXXXXXXXXXX"
-    auth_token = "YYYYYYYYYYYYYYYYYY"
-
-    @client = Twilio::REST::Client.new account_sid, auth_token
-
-    ERROR = 0
-
-    @client.account.notifications.list(log=ERROR).each do |notification|:
-        puts notification.error_code
-
-.. note:: Due to the potentially voluminous amount of data in a notification,
-    the full HTTP request and response data is only returned in the
-    :class:`Notification` instance resource representation.
-
-
-Deleting Notifications
-------------------------
-
-Your account can sometimes generate an inordinate amount of
-:class:`Notification` resources. The :class:`Notifications` resource allows
-you to delete unnecessary notifications.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    account_sid = "ACXXXXXXXXXXXXXXXXX"
-    auth_token = "YYYYYYYYYYYYYYYYYY"
-
-    @client = Twilio::REST::Client.new account_sid, auth_token
-    @client.notifications.get("NO123").delete()
-

data/docs/usage/phone-calls.rst

@@ -1,166 +0,0 @@
-.. module:: twilio.rest
-.. _phone-calls:
-
-=====================
-Phone Calls
-=====================
-
-The :class:`Calls` resource manages all interaction with Twilio phone calls,
-including the creation and termination of phone calls.
-
-
-Making a Phone Call
--------------------
-
-The :class:`Calls` resource allows you to make outgoing calls. Before a call
-can be successfully started, you'll need a to set up a url endpoint which
-outputs valid `TwiML <http://www.twilio.com/docs/api/twiml/>`_.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    account_sid = "ACXXXXXXXXXXXXXXXXX"
-    auth_token = "YYYYYYYYYYYYYYYYYY"
-
-    @client = Twilio::REST::Client.new account_sid, auth_token
-    @call = @client.account.calls.create({:to => "9991231234",
-                                  :from => "9991231234",
-                                  :url => "http://foo.com/call.xml"})
-    puts @call.length
-    puts @call.sid
-
-
-Retrieve a Call Record
--------------------------
-
-If you already have a :class:`Call` sid,
-you can use the client to retrieve that record.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    account_sid = "ACXXXXXXXXXXXXXXXXX"
-    auth_token = "YYYYYYYYYYYYYYYYYY"
-
-    @client = Twilio::REST::Client.new account_sid, auth_token
-    sid = "CA12341234"
-    @call = @client.account.calls.get(sid)
-
-
-Accessing Specific Call Resources
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Each :class:`Call` resource also has access to its `notifications`,
-`recordings`, and `transcriptions`.
-These attributes are :class:`ListResources`,
-just like the :class:`Calls` resource itself.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    account_sid = "ACXXXXXXXXXXXXXXXXX"
-    auth_token = "YYYYYYYYYYYYYYYYYY"
-
-    @client = Twilio::REST::Client.new account_sid, auth_token
-    sid = "CA12341234"
-    @call = @client.account.calls.get(sid)
-
-    puts @call.notifications.list()
-    puts @call.recordings.list()
-    puts @call.transcriptions.list()
-
-However, what if you only have a `CallSid`, and not the actual
-:class:`Resource`? No worries, as :meth:`list` can be filter based on a given
-`CallSid`.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    account_sid = "ACXXXXXXXXXXXXXXXXX"
-    auth_token = "YYYYYYYYYYYYYYYYYY"
-
-    @client = Twilio::REST::Client.new account_sid, auth_token
-    sid = "CA24234"
-    puts @client.notifications.list({:call => sid})
-    puts @client.recordings.list({:call => sid})
-    puts @client.transcriptions.list({:call => sid})
-
-
-Modifying Live Calls
---------------------
-
-The :class:`Call` resource makes it easy to find current live calls and
-redirect them as necessary
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    account_sid = "ACXXXXXXXXXXXXXXXXX"
-    auth_token = "YYYYYYYYYYYYYYYYYY"
-
-    @client = Twilio::REST::Client.new account_sid, auth_token
-    @calls = @client.account.calls.list({:status => "in-progress"})
-
-    @calls.each do |call|
-        call.redirect_to("http://twimlets.com/holdmusic?Bucket=com.twilio.music.ambient")
-    end
-
-
-Ending all live calls is also possible
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    account_sid = "ACXXXXXXXXXXXXXXXXX"
-    auth_token = "YYYYYYYYYYYYYYYYYY"
-
-    @client = Twilio::REST::Client.new account_sid, auth_token
-    @calls = @client.account.calls.list({:status => "in-progress"})
-
-    @calls.each do |call|
-        call.hangup()
-    end
-
-Note that :meth:`hangup` will also cancel calls currently queued.
-
-If you already have a :class:`Call` sid, you can use the :class:`Calls`
-resource to update the record without having to use :meth:`get` first.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    account_sid = "ACXXXXXXXXXXXXXXXXX"
-    auth_token = "YYYYYYYYYYYYYYYYYY"
-
-    @client = Twilio::REST::Client.new account_sid, auth_token
-    sid = "CA12341234"
-    @client.account.calls.get(sid).redirect_to("http://twimlets.com/holdmusic?Bucket=com.twilio.music.ambient")
-
-Hanging up the call also works.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    account_sid = "ACXXXXXXXXXXXXXXXXX"
-    auth_token = "YYYYYYYYYYYYYYYYYY"
-
-    @client = Twilio::REST::Client.new account_sid, auth_token
-    sid = "CA12341234"
-    @client.account.calls.get(sid).hangup()
-

data/docs/usage/phone-numbers.rst

@@ -1,174 +0,0 @@
-.. module:: twilio.rest.resources
-
-=================
-Phone Numbers
-=================
-
-With Twilio you can search and buy real phone numbers, just using the API.
-
-For more information, see the
-`IncomingPhoneNumbers REST Resource
-<http://www.twilio.com/docs/api/rest/incoming-phone-numbers>`_ documentation.
-
-
-Searching and Buying a Number
---------------------------------
-
-Finding numbers to buy couldn't be easier.
-We first search for a number in area code 530.
-Once we find one, we'll purchase it for our account.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    account_sid = "ACXXXXXXXXXXXXXXXXX"
-    auth_token = "YYYYYYYYYYYYYYYYYY"
-
-    @client = Twilio::REST::Client.new account_sid, auth_token
-    numbers = @client.account.available_phone_numbers.list(:area_code=>"530")
-
-    if numbers:
-        numbers[0].purchase()
-    else:
-        print "No numbers in 530 available"
-
-
-Local, Toll-Free, and Mobile Numbers
-------------------------------------
-
-By default, :meth:`PhoneNumbers.search` looks for local phone numbers. You can
-search for different types of numbers by using a type subresource.
-
-Available subresources for AvailablePhoneNumbers are:
-- `local`
-- `toll_free`
-- `mobile`
-
-You can search for numbers for a given type.
-
-.. code-block:: ruby
-
-    # local
-	numbers = @client.account.available_phone_numbers.local.list()
-
-    # toll free
-	numbers = @client.account.available_phone_numbers.toll_free.list()
-
-    # mobile
-	numbers = @client.account.available_phone_numbers.mobile.list()
-
-Numbers Containing Words
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Phone number search also supports looking for words inside phone numbers.
-The following example will find any phone number with "FOO" in it.
-
-.. code-block:: ruby
-
-	numbers = @client.account.available_phone_numbers.list(:contains=>"FOO")
-
-You can use the ''*'' wildcard to match any character. The following example finds any phone number that matches the pattern ''D*D''.
-
-.. code-block:: ruby
-
-	numbers = @client.account.available_phone_numbers.list(:contains=>"D*D")
-
-
-International Numbers
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-By default, the client library will look for US numbers. Set the
-:data:`country` keyword to a country code of your choice to search for
-international numbers.
-
-.. code-block:: ruby
-
-	numbers = @client.account.available_phone_numbers.list(:country=>"FR")
-
-
-:meth:`PhoneNumbers.search` method has plenty of other options to augment your search :
-
-- :data:`region`: When searching the US, show numbers in this state
-- :data:`postal_code`: Only show numbers in this area code
-- :data:`rate_center`: US only.
-- :data:`near_lat_long`: Find numbers near this latitude and longitude.
-- :data:`distance`: Search radius for a Near- query in miles.
-
-The `AvailablePhoneNumbers REST Resource
-<http://www.twilio.com/docs/api/rest/available-phone-numbers>`_ documentation
-has more information on the various search options.
-
-
-Buying a Number
----------------
-
-If you've found a phone number you want, you can purchase the number.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    account_sid = "ACXXXXXXXXXXXXXXXXX"
-    auth_token = "YYYYYYYYYYYYYYYYYY"
-
-    @client = Twilio::REST::Client.new account_sid, auth_token
-    @number = @client.account.phone_numbers.purchase({:phone_number => "+15305431234"})
-
-However, it's easier to purchase numbers after finding them using search (as
-shown in the first example).
-
-
-Updating Properties on a Number
--------------------------------
-
-To update the properties on a phone number, call :meth:`update`
-on the phone number object, with any of the parameters
-listed in the `IncomingPhoneNumbers Resource documentation
-<http://www.twilio.com/docs/api/rest/incoming-phone-numbers>`_
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    account_sid = "ACXXXXXXXXXXXXXXXXX"
-    auth_token = "YYYYYYYYYYYYYYYYYY"
-
-    @client = Twilio::REST::Client.new account_sid, auth_token
-    @client.account.phone_numbers.list(api_version="2010-04-01").each do |number|
-        number.update({:voice_url => "http://twimlets.com/holdmusic?" + 
-            "Bucket=com.twilio.music.ambient", 
-            :status_callback => "http://example.com/callback"})
-
-
-Changing Applications
-----------------------
-
-An :class:`Application` encapsulates all necessary URLs for use with phone numbers. Update an application on a phone number using :meth:`update`.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    account_sid = "ACXXXXXXXXXXXXXXXXX"
-    auth_token = "YYYYYYYYYYYYYYYYYY"
-
-    @client = Twilio::REST::Client.new account_sid, auth_token
-
-    phone_sid = "PNXXXXXXXXXXXXXXXXX"
-
-    @number = @client.account.phone_numbers.get(phone_sid)
-    @number.update(:sms_application_sid => "APXXXXXXXXXXXXXXXXXX")
-
-See :doc:`/usage/applications` for instructions on updating and maintaining Applications.
-
-
-Validate a Phone Number
------------------------
-
-See validation instructions here: :doc:`/usage/caller-ids`:
-