RubyGems - twilio-ruby - Versions diffs - 4.13.0 → 5.40.0 - Mend

twilio-ruby 4.13.0 → 5.40.0

Files changed (1049) hide show

data/docs/getting-started.rst DELETED Viewed

@@ -1,117 +0,0 @@
-===========
-Quickstart
-===========
-Getting started with the Twilio API couldn't be easier. Create a Twilio REST
-client to get started. For example, the following code makes a call using the
-Twilio REST API.
-Make a Call
-===============
-.. 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://twimlets.com/holdmusic?Bucket=com.twilio.music.ambient"
-    )
-    puts @call.length
-    puts @call.sid
-Send an SMS
-===========
-.. 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: "+12316851234",
-      from: "+15555555555",
-      body: "Hello there!"
-    )
-Send an MMS
-===========
-.. 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"
-    )
-Generating TwiML
-=================
-To control phone calls, your application needs to output `TwiML
-<http://www.twilio.com/docs/api/twiml/>`_. Use :class:`twilio.twiml.Response`
-to easily create such responses.
-.. code-block:: ruby
-    Twilio::TwiML::Response do |r|
-        r.Play "https://api.twilio.com/cowbell.mp3", loop: 5
-    end.text
-.. code-block:: xml
-    <?xml version="1.0" encoding="utf-8"?>
-    <Response>
-        <Play loop="5">https://api.twilio.com/cowbell.mp3</Play>
-    <Response>
-Create a Task with TaskRouter
-=================
-If you need to create a Task to TaskRouter, you can do so by using the TaskRouterClient.
-Additional resources had off of the workspace object (task_queues, workers, workflows, activities, tasks, statistics, events).
-.. code-block:: ruby
-    require 'twilio-ruby'
-    # To find these visit https://www.twilio.com/user/account
-    account_sid = "ACXXXXXXXXXXXXXXXXX"
-    auth_token = "YYYYYYYYYYYYYYYYYY"
-    workspace_sid = "WSzzzzzzzzzzzzzzzzzzzzzzzzzzz"
-    client = Twilio::REST::TaskRouterClient.new account_sid, auth_token, workspace_sid
-    workflow_sid = "WFzzzzzzzzzzzzz"
-    task = client.workspace.tasks.create(attributes: '{"foo":"bar"}', workflow_sid: workflow_sid)
-Digging Deeper
-========================
-The full power of the Twilio API is at your fingertips. The :ref:`user-guide`
-explains all the awesome features available to use.

data/docs/index.rst DELETED Viewed

@@ -1,135 +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
-    usage/pricing
-TaskRouter
----------
-Query the Twilio TaskRouter API to set up workspaces and task routing, and
-create capability tokens to authorize your client-side code to safely update
-state.
-.. toctree::
-    :maxdepth: 1
-    usage/taskrouter
-    usage/taskrouter-tokens
-Lookups
--------
-Query the Lookups API to get information about phone numbers and their carriers.
-.. toctree::
-    :maxdepth: 1
-    usage/lookups
-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 DELETED Viewed

@@ -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 DELETED Viewed

@@ -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 DELETED Viewed

@@ -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/addresses.rst DELETED Viewed

@@ -1,101 +0,0 @@
-.. module:: twilio.rest.resources
-=========
-Addresses
-=========
-An Address instance resource represents your or your customer’s physical
-location within a country. Around the world, some local authorities require the
-name and address of the user to be on file with Twilio to purchase and own a
-phone number.
-For more information, see the `Address REST Resource
-<http://www.twilio.com/docs/api/rest/address`_ documentation.
-Creating an Address
--------------------
-Addresses contain the name of your company or your customer’s company in
-addition to location information and an optional 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
-    @address = @client.addresses.create(
-      friendly_name: "Homer",
-      customer_name: "Homer Simpson",
-      street: "742 Evergreen Terrace",
-      city: "Springfield",
-      region "IL",
-      postal_code: "62701",
-      iso_country: "US"
-    )
-Listing Addresses
------------------
-The following code will print out the :attr:`customer_name` for each :class:`Address`.
-.. code-block:: ruby
-    @addresses = @client.addresses.list()
-    @addresses.each do |address|
-      puts address.customer_name
-    end
-Filtering Addresses
--------------------
-The list of Addresses can be filtered on :attr:`friendly_name`,
-:attr:`customer_name`, and/or :attr:`iso_country`.
-.. code-block:: ruby
-    @addresses = @client.addresses.list(iso_country: 'AU')
-    @addresses.each do |address|
-      puts address.customer_name
-    end
-Updating an Address
--------------------
-All Address attributes other than :attr:`iso_country` can be updated.
-To create an Address with a different country, see the "Creating an Address" section.
-.. code-block:: ruby
-    @sid = 'AD123' # the address you'd like to update
-    @address = @client.addresses.get(@sid)
-    @address.update(customer_name: "Marge Simpson")
-Deleting an Address
--------------------
-.. code-block:: ruby
-    address_sid = 'AD123'
-    @address = @client.addresses.get(address_sid)
-    @address.delete()
-Listing Dependent Phone Numbers
--------------------------------
-Twilio will not permit you to delete an Address if it is the sole
-Address resource on your account that satisfies the address requirements
-for one or more of your purchased phone numbers.
-To see which phone numbers depend on a given address:
-.. code-block:: ruby
-    address_sid = 'AD123'
-    @address = @client.addresses.get(address_sid)
-    @address.dependent_phone_numbers.list.each do |number|
-      puts number.sid
-    end