twilio-ruby 3.11.5 → 5.0.0

data/docs/index.rst

@@ -1,109 +0,0 @@
-=============================
-Twilio Ruby Helper Library
-=============================
-
-.. _installation:
-
-Installation
-================
-
-Just install the gem!
-
-.. code-block:: bash
-
-    $ gem install twilio-ruby
-
-Getting Started
-================
-
-The :doc:`/getting-started` will get you up and running in a few quick minutes.
-This guide assumes you understand the core concepts of Twilio.
-If you've never used Twilio before, don't fret! Just read
-`about how Twilio works <http://www.twilio.com/api/>`_ and then jump in!
-
-
-.. _user-guide:
-
-User Guide
-==================
-
-Functionality is split over three different sub-packages within
-**twilio-ruby**. Below are in-depth guides to specific portions of the
-library.
-
-
-REST API
-----------
-
-Query the Twilio REST API to create phone calls, send SMS/MMS messages and more!
-
-.. toctree::
-    :maxdepth: 1
-
-    usage/basics
-    usage/errors
-    usage/messages
-    usage/phone-calls
-    usage/phone-numbers
-    usage/accounts
-    usage/conferences
-    usage/applications
-    usage/notifications
-    usage/recordings
-    usage/transcriptions
-    usage/caller-ids
-    usage/queues
-    usage/sip
-
-TwiML
----------
-
-Generates valid TwiML for controlling and manipulating phone calls.
-
-.. toctree::
-    :maxdepth: 2
-
-    usage/twiml
-
-Utilities
-----------
-
-Small functions useful for validating requests are coming from Twilio
-
-.. toctree::
-    :maxdepth: 1
-
-    usage/validation
-    usage/token-generation
-
-Frequently Asked Questions
-==========================
-
-What to do if you get an ``ImportError``, and some advice about how to format
-phone numbers.
-
-.. toctree::
-    :maxdepth: 2
-
-    faq
-
-Changelog
-=========
-
-See the :doc:`/changelog` for version history.
-
-Support and Development
-==========================
-All development occurs over on
-`Github <https://github.com/twilio/twilio-ruby>`_. To checkout the source,
-
-.. code-block:: bash
-
-    $ git clone git@github.com:twilio/twilio-ruby.git
-
-
-Report bugs using the Github
-`issue tracker <https://github.com/twilio/twilio-ruby/issues>`_.
-
-If you have questions that aren't answered by this documentation,
-ask the `#twilio IRC channel <irc://irc.freenode.net/#twilio>`_

data/docs/make.bat

@@ -1,170 +0,0 @@
-@ECHO OFF
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
-set BUILDDIR=_build
-set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
-if NOT "%PAPER%" == "" (
-	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
-)
-
-if "%1" == "" goto help
-
-if "%1" == "help" (
-	:help
-	echo.Please use `make ^<target^>` where ^<target^> is one of
-	echo.  html       to make standalone HTML files
-	echo.  dirhtml    to make HTML files named index.html in directories
-	echo.  singlehtml to make a single large HTML file
-	echo.  pickle     to make pickle files
-	echo.  json       to make JSON files
-	echo.  htmlhelp   to make HTML files and a HTML help project
-	echo.  qthelp     to make HTML files and a qthelp project
-	echo.  devhelp    to make HTML files and a Devhelp project
-	echo.  epub       to make an epub
-	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
-	echo.  text       to make text files
-	echo.  man        to make manual pages
-	echo.  changes    to make an overview over all changed/added/deprecated items
-	echo.  linkcheck  to check all external links for integrity
-	echo.  doctest    to run all doctests embedded in the documentation if enabled
-	goto end
-)
-
-if "%1" == "clean" (
-	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
-	del /q /s %BUILDDIR%\*
-	goto end
-)
-
-if "%1" == "html" (
-	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
-	goto end
-)
-
-if "%1" == "dirhtml" (
-	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
-	goto end
-)
-
-if "%1" == "singlehtml" (
-	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
-	goto end
-)
-
-if "%1" == "pickle" (
-	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished; now you can process the pickle files.
-	goto end
-)
-
-if "%1" == "json" (
-	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished; now you can process the JSON files.
-	goto end
-)
-
-if "%1" == "htmlhelp" (
-	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished; now you can run HTML Help Workshop with the ^
-.hhp project file in %BUILDDIR%/htmlhelp.
-	goto end
-)
-
-if "%1" == "qthelp" (
-	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished; now you can run "qcollectiongenerator" with the ^
-.qhcp project file in %BUILDDIR%/qthelp, like this:
-	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\twilio-python2.qhcp
-	echo.To view the help file:
-	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\twilio-python2.ghc
-	goto end
-)
-
-if "%1" == "devhelp" (
-	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished.
-	goto end
-)
-
-if "%1" == "epub" (
-	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The epub file is in %BUILDDIR%/epub.
-	goto end
-)
-
-if "%1" == "latex" (
-	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
-	goto end
-)
-
-if "%1" == "text" (
-	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The text files are in %BUILDDIR%/text.
-	goto end
-)
-
-if "%1" == "man" (
-	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The manual pages are in %BUILDDIR%/man.
-	goto end
-)
-
-if "%1" == "changes" (
-	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.The overview file is in %BUILDDIR%/changes.
-	goto end
-)
-
-if "%1" == "linkcheck" (
-	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Link check complete; look for any errors in the above output ^
-or in %BUILDDIR%/linkcheck/output.txt.
-	goto end
-)
-
-if "%1" == "doctest" (
-	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Testing of doctests in the sources finished, look at the ^
-results in %BUILDDIR%/doctest/output.txt.
-	goto end
-)
-
-:end

data/docs/src/pip-delete-this-directory.txt

@@ -1,5 +0,0 @@
-This file is placed here by pip to indicate the source was put
-here by pip.
-
-Once this package is successfully installed this source code will be
-deleted (unless you remove this file).

data/docs/usage/accounts.rst

@@ -1,89 +0,0 @@
-.. module:: twilio.rest
-
-===========
-Accounts
-===========
-
-Managing Twilio accounts is straightforward.
-Update your own account information or create and manage multiple subaccounts.
-
-For more information, see the
-`Account REST Resource <http://www.twilio.com/docs/api/rest/account>`_
-documentation.
-
-
-Updating Account Information
-----------------------------
-
-Use the :meth:`Account.update` to modify one of your accounts.
-Right now the only valid attribute is :attr:`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
-    @account = @client.accounts.get(account_sid)
-    @account.update({:friendly_name => "My Awesome Account"})
-
-
-Creating Subaccounts
-----------------------
-
-Subaccounts are easy to make.
-
-.. 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
-    @subaccount = @client.accounts.create({:name => "My Awesome SubAccount"})
-
-
-Managing Subaccounts
--------------------------
-
-Say you have a subaccount for Client X with an account sid `AC123`
-
-.. 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 X's subaccount
-    @subaccount = @client.accounts.get('AC123')
-
-Client X hasn't paid you recently, so let's suspend their account.
-
-.. code-block:: ruby
-
-    @subaccount.update({:status => 'suspended'}
-
-If it was just a misunderstanding, reenable their account.
-
-.. code-block:: ruby
-
-    @subaccount.update({:status => 'active'}
-
-Otherwise, close their account permanently.
-
-.. code-block:: ruby
-
-    @subaccount.update({:status => 'closed'}
-
-.. warning::
-    This action can't be undone. 
-

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.account.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.account.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.account.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.account.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.account.applications.get(app_sid)
-    @application.delete()
-

data/docs/usage/basics.rst

@@ -1,102 +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
-
-
-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.account.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.account.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.account.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.account.recordings.get("RC123")
-    @recording.delete()
-

data/docs/usage/caller-ids.rst

@@ -1,45 +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.account.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.account.outgoing_caller_ids.list(:phone_number => "+15555555555")
-    @callerid = response[0]
-    @callerid.delete()