twilio-ruby 4.13.0 → 5.40.0

data/docs/usage/applications.rst

@@ -1,108 +0,0 @@
-.. module:: twilio.rest.resources
-
-=================
-Applications
-=================
-
-An application inside of Twilio is just a set of URLs and other configuration
-data that tells Twilio how to behave when one of your Twilio numbers receives
-a call or message.
-
-For more information, see the `Application REST Resource
-<http://www.twilio.com/docs/api/rest/applications>`_ documentation.
-
-
-Listing Your Applications
---------------------------
-
-The following code will print out the :attr:`friendly_name` for each :class:`Application`.
-
-.. 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.applications.each do |app|
-      puts app.friendly_name
-    end
-
-
-Filtering Applications
----------------------------
-
-You can filter applications by FriendlyName
-
-.. 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.applications.list(friendly_name: 'FOO').each do |app|
-      puts app.sid
-    end
-
-
-Creating an Application
--------------------------
-
-When creating an application, no fields are required. We create an application
-with only a :attr:`friendly_name`. The :meth:`Applications.create()` method
-accepts many other arguments for url configuration.
-
-.. 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
-    @application = @client.applications.create(
-      friendly_name: "My New App"
-    )
-
-Updating an Application
-------------------------
-
-.. 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
-
-    url = "http://twimlets.com/holdmusic?Bucket=com.twilio.music.ambient"
-    app_sid = 'AP123' # the app you'd like to update
-
-    @application = @client.applications.get(app_sid)
-    @application.update(voice_url: url)
-
-Deleting an Application
--------------------------
-
-.. 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
-
-    app_sid = 'AP123' # the app you'd like to delete
-    @client.applications.get(app_sid)
-    @application.delete()
-

data/docs/usage/basics.rst

@@ -1,115 +0,0 @@
-.. module:: twilio.rest
-
-=========================
-Accessing REST Resources
-=========================
-
-To access Twilio REST resources, you'll first need to instantiate a
-:class:`Twilio::REST::Client`.
-
-Authentication
---------------------------
-
-The :class:`Twilio::REST::Client` needs your Twilio credentials. To get
-your credentials, visit `your Twilio account portal
-<https://www.twilio.com/user/account>`_. If you don't have a Twilio account
-yet, go `here <https://www.twilio.com/try-twilio>`_ to get started.
-
-Once you have your credentials, you can create create a new :class:`Client` and get started.
-
-.. 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
-
-You can also configure the client using the top level configure method, like so:
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    Twilio.configure do |config|
-      config.account_sid = "ACXXXXXXXXXXXXXXXXX"
-      config.auth_token = "YYYYYYYYYYYYYYYYYY"
-    end
-
-    @client = Twilio::REST::Client.new
-
-
-Listing Resources
--------------------
-
-The :class:`Client` gives you access to various list resources.
-:meth:`ListResource.list`, by default, returns the most recent 50 instance 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
-	@calls = @client.calls.list()
-
-:meth:`ListResource.list` accepts paging arguments.
-The following will return page 3 with page size of 25.
-
-.. 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(page: 3, page_size: 25)
-
-
-Get an Individual Resource
------------------------------
-
-To get an individual instance resource, use :meth:`ListResource.get`.
-Provide the :attr:`sid` of the resource you'd like to get.
-
-.. 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.get("CA123")
-    puts @call.to
-
-
-Deleting a Resource
--------------------------------
-
-Resources can only be deleted via their instance object. This means
-you must instantiate an instance object using :meth:`ListResource.get`
-and then call :meth:`delete` on it.
-
-.. 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
-
-    @recording = @client.recordings.get("RC123")
-    @recording.delete()
-

data/docs/usage/caller-ids.rst

@@ -1,47 +0,0 @@
-.. module:: twilio.rest.resources
-
-=================
-Caller Ids
-=================
-
-
-Validate a Phone Number
------------------------
-
-Validating a phone number is quick and easy.
-
-.. 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
-    @response = @client.outgoing_caller_ids.create(
-      phone_number: "+44 9876543212"
-    )
-    puts @response.validation_code
-
-Twilio will call the provided number and wait for the validation code to be
-entered.
-
-Delete a Phone Number
----------------------
-
-Deleting a phone number is quick and easy.
-
-.. 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
-
-    @response = @client.outgoing_caller_ids.list(phone_number: "+15555555555")
-    @callerid = response[0]
-    @callerid.delete()

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()
-