twilio-ruby 4.13.0 → 5.0.0.alpha1

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.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.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.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.conferences.get("CF123").participants.list()
-
-    return if @participants.empty?
-
-    # Kick the first person out
-    @participants.pop().kick()
-
-    # And mute the rest
-    @participants.each do |participant|
-      participant.mute()
-    end
-

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.messages.create({
-        from: '+1234567890',
-        to: '+1234567890',
-        body: 'Hello world'
-      })
-    rescue Twilio::REST::RequestError => e
-      puts e.message
-    end

data/docs/usage/lookups.rst

@@ -1,62 +0,0 @@
-===========
-Lookups API
-===========
-
-Lookups allows you to systematically ascertain information about phone numbers. With Lookups, you can identify local-friendly number formats, reduce the likelihood of undelivered messages and protect yourself from fraud.
-
-For more information see the `Lookups API <https://www.twilio.com/docs/api/rest/lookups>`_ documentation.
-
-Looking up details on a phone number
-------------------------------------
-
-You can look up a phone number with a :class:`Twilio::REST::LookupsClient`. You instantiate the client as you would with any other :class:`Twilio::REST` client
-
-.. code-block:: ruby
-
-    require "twilio-ruby"
-
-    # Find these values at twilio.com/user/account
-    account_sid = "AC123123"
-    auth_token = "secret"
-
-    @lookups_client = Twilio::REST::LookupsClient.new account_sid, auth_token
-
-You can then use the client to lookup a phone number.
-
-.. code-block:: ruby
-
-    response = @lookups_client.phone_numbers.get("+12316851234")
-    response.country_code
-    # => "US"
-    response.phone_number
-    # => "+12316851234"
-    response.national_format
-    # => "(231) 685-1234"
-    response.url
-    # => "https://lookups.twilio.com/v1/PhoneNumbers/+12316851234"
-
-Invalid Phone Numbers
----------------------
-
-The Lookups API is a REST API that returns data on phone number resources. If you try to lookup a phone number that doesn't exist the API will raise a 404 :class:`Twilio::REST::RequestError`. You should handle this within your code.
-
-.. code-block:: ruby
-
-    response = @lookups_client.phone_numbers.get("+15558675309")
-    begin
-      puts response.phone_number
-    rescue Twilio::REST::RequestError => e
-      raise e unless e.code == 20404 # ensure this is a 404 error
-      puts "Invalid number"
-    end
-
-Carrier Information
--------------------
-
-The Lookups API can be used to find out more information about the carrier for the phone number. Just pass the type "carrier" to the request.
-
-.. code-block:: ruby
-
-    response = @lookups_client.phone_numbers.get("+12316851234", type: "carrier")
-    response.carrier
-    # => {"mobile_country_code"=>nil, "mobile_network_code"=>nil, "name"=>"Charter Fiberlink, LLC", "type"=>"landline", "error_code"=>nil}

data/docs/usage/messages.rst

@@ -1,137 +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.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.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.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.messages.list.each do |message|
-      puts message.body
-    end
-
-Redacting or Deleting 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
-    @msg_sid = 'MM123'
-    @msg = @client.messages.get('MM123')
-    # Deletes the Body field contents
-    @msg.redact
-
-    # Removes the entire Message record
-    @msg.delete
-
-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.messages.list(
-      to: "+5466758723",
-      date_sent: "2011-01-01"
-    )
-
-    @messages.each do |message|
-      puts message.body
-    end
-

data/docs/usage/notifications.rst

@@ -1,72 +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.notifications.list.each do |notification|
-      puts notification.more_info
-    end
-
-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.notifications.list(log=ERROR).each do |notification|
-      puts notification.error_code
-    end
-
-.. 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,185 +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.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.calls.get(sid)
-
-Delete a Call 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.calls.get(sid)
-
-    # Removes the entire record from Twilio's storage
-    @call.delete
-
-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.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.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.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.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.calls.get(sid).hangup()
-