twilio-ruby 4.13.0 → 5.0.0.alpha1

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

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

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