twilio-ruby 4.6.1 → 6.9.0

data/docs/usage/taskrouter.rst

@@ -1,440 +0,0 @@
-.. module:: twilio.rest.resources.task_router
-
-==========
-TaskRouter
-==========
-
-Twilio TaskRouter is a system for distributing tasks such as phone calls,
-leads, support tickets, and other work items to the people and processes that
-can best handle them.
-
-For more information, see the `TaskRouter documentation
-<https://www.twilio.com/docs/taskrouter>_`.
-
-Note: Passed in Form/Query Parameters are based on their json equivalent attribute.
-
-Workspaces
---------------------
-
-A Workspace is a container for your Tasks, Workers, TaskQueues, Workflows and
-Activities. Each of these items exists within a single Workspace and will not
-be shared across Workspaces.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    ACCOUNT_SID = "ACXXXXXXXXXXXXXXXXX"
-    AUTH_TOKEN = "YYYYYYYYYYYYYYYYYY"
-    # You can create a workspace through the portal, or put a fake value
-    # here to create your first workspace with the Ruby library
-    WORKSPACE_SID = "WSZZZZZZZZZ"
-
-    @client = Twilio::REST::TaskRouterClient.new ACCOUNT_SID, AUTH_TOKEN, WORKSPACE_SID
-
-    # creating a workspace
-    @workspace = @client.workspaces.create(
-        friendly_name: "Customer Support",
-        template: "FIFO",  # Sets up default activities and a FIFO TaskQueue
-    )
-    puts @workspace.sid
-
-    # fetching a workspace
-    @workspace = @client.workspace
-    puts @workspace.sid
-    puts @workspace.friendly_name
-
-    # fetching a list of workspaces
-    @client.workspaces.list.each do |workspace|
-      puts workspace.friendly_name
-    end
-
-    # updating a workspace
-    @client.workspace.update(friendly_name: 'MyWorkspace2')
-
-    # deleting a workspace
-    @client.workspace.delete
-
-
-Workflows
----------
-
-Workflows control how tasks will be prioritized and routed into TaskQueues, and
-how Tasks should escalate in priority or move across queues over time.
-Workflows are described in a simple JSON format and can be modified through the
-REST API or through the account portal.
-
-Creating a Workflow
---------------------
-
-The following code will create a new :class:`Workflow` resource and print its
-unique ID:
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    ACCOUNT_SID = "ACXXXXXXXXXXXXXXXXX"
-    AUTH_TOKEN = "YYYYYYYYYYYYYYYYYY"
-
-    # See previous examples to create a Workspace
-    WORKSPACE_SID = "WSZZZZZZZZZZZZZZ"
-
-    # Some JSON to configure the Workflow. See the documentation at
-    # http://www.twilio.com/docs/taskrouter for more details.
-    CONFIG = <<-EOS
-    {
-       "task_routing":{
-          "filters":[
-             {
-                "friendly_name":"Gold Tickets",
-                "expression":"customer_value == 'Gold' AND type == 'ticket'",
-                "targets":[
-                   {
-                      "queue":"YourGoldTicketQueueSid",
-                      "priority":"2"
-                   }
-                ]
-             }
-          ],
-          "default_filter":{
-             "queue":"YourDefaultQueueSid"
-          }
-       }
-    }
-    EOS
-
-    @client = Twilio::REST::TaskRouterClient.new ACCOUNT_SID, AUTH_TOKEN, WORKSPACE_SID
-
-    @workflow = @client.workspace.workflows.create(
-        friendly_name: "Incoming Call Flow",
-        assignment_callback_url: "https://example.com/callback",
-        fallback_assignment_callback_url: "https://example.com/callback2",
-        configuration: CONFIG
-    )
-    puts @workflow.sid
-
-You can also utilize our Workflow Builder to make this process a bit easier utilizing objects:
-
-.. code-block:: ruby
-
-    require twilio-ruby
-
-    # To find these visit https://www.twilio.com/user/account
-    ACCOUNT_SID = "ACXXXXXXXXXXXXXXXXX"
-    AUTH_TOKEN = "YYYYYYYYYYYYYYYYYY"
-
-    # See previous examples to create a Workspace
-    WORKSPACE_SID = "WSZZZZZZZZZZZZZZ"
-
-    @client = Twilio::REST::TaskRouterClient.new ACCOUNT_SID, AUTH_TOKEN, WORKSPACE_SID
-
-    gold_ticket_queue_sid = 'YourGoldTicketQueueSid'
-    default_queue_sid = 'YourDefaultQueueSid'
-
-    gold_ticket_targets = [Twilio::TaskRouter::WorkflowRuleTarget.new(gold_ticket_queue_sid)]
-    gold_ticket_rule = Twilio::TaskRouter::WorkflowRule.new 'customer_value == "Gold" AND type == "ticket"', gold_ticket_targets, 'Gold Tickets'
-
-    @rules = [gold_ticket_rule]
-    @default_target = Twilio::TaskRouter::WorkflowRuleTarget.new default_queue_sid
-
-    @config = Twilio::TaskRouter::WorkflowConfiguration.new @rules, @default_target
-    puts @config.to_json
-
-    @workflow = @client.workspace.workflows.create(configuration: @config.to_json, friendly_name: 'Incoming Call Flow', assignment_callback_url: 'https://example.com/callback', fallback_assignment_callback_url: 'https://example.com/callback2')
-    puts @workflow.sid
-
-Fetching, Updating, Deleting Workflows
---------------------
-
-.. code-block:: ruby
-
-    require twilio-ruby
-
-    # To find these visit https://www.twilio.com/user/account
-    ACCOUNT_SID = "ACXXXXXXXXXXXXXXXXX"
-    AUTH_TOKEN = "YYYYYYYYYYYYYYYYYY"
-
-    # See previous examples to create a Workspace
-    WORKSPACE_SID = "WSZZZZZZZZZZZZZZ"
-    WORKFLOW_SID = "WFZZZZZZZZZZZZZZZ"
-
-    # fetching a workflow
-    @client = Twilio::REST::TaskRouterClient.new ACCOUNT_SID, AUTH_TOKEN, WORKSPACE_SID
-    @workflow = @client.workspace.workflows.get(WORKFLOW_SID)
-    puts @workflow.sid
-    puts @workflow.friendly_name
-
-    # fetching a list of workflows
-    @client.workspace.workflows.list.each do |workflow|
-      puts workflow.friendly_name
-    end
-
-    # updating a workflow
-    @workflow.update(friendly_name: 'NewWorkflowName')
-
-    # deleting a workflow
-    @workflow.delete
-
-Activities
-----------
-
-Activities describe the current status of your Workers, which determines
-whether they are eligible to receive task assignments. Workers are always set
-to a single Activity.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    ACCOUNT_SID = "ACXXXXXXXXXXXXXXXXX"
-    AUTH_TOKEN = "YYYYYYYYYYYYYYYYYY"
-
-    # See previous examples to create a Workspace
-    WORKSPACE_SID = "WSZZZZZZZZZZZZZZ"
-
-    @client = Twilio::REST::TaskRouterClient.new ACCOUNT_SID, AUTH_TOKEN, WORKSPACE_SID
-
-    # creating an activity
-    @activity = @client.workspace.activities.create(
-        friendly_name: "Coffee Break",
-        available: false  # Whether workers are available to handle tasks during this activity
-    )
-    puts @activity.sid
-
-    # fetching a list of activities
-    @client.workspace.activities.list.each do |activity|
-      puts activity.friendly_name
-    end
-
-    # fetching an activity
-    ACTIVITY_SID = "WAZZZZZZZZZZZZZZZZZ"
-    @activity = @client.workspace.activities.get(ACTIVITY_SID)
-
-    # updating an activity
-    @activity.update(friendly_name: 'NewFriendlyName')
-
-    # deleting an activity
-    @activity.delete
-
-Workers
--------
-
-Workers represent an entity that is able to perform tasks, such as an agent
-working in a call center, or a salesperson handling leads.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    ACCOUNT_SID = "ACXXXXXXXXXXXXXXXXX"
-    AUTH_TOKEN = "YYYYYYYYYYYYYYYYYY"
-
-    # See previous examples to create a Workspace
-    WORKSPACE_SID = "WSZZZZZZZZZZZZZZ"
-
-    @client = Twilio::REST::TaskRouterClient.new ACCOUNT_SID, AUTH_TOKEN, WORKSPACE_SID
-
-    # creating a worker
-    @worker = @client.workspace.workers.create(
-        friendly_name:"Jamie",
-        attributes:'{"phone": "+14155551234", "languages": ["EN", "ES"]}'
-    )
-    puts @worker.sid
-
-    # fetching a list of workers
-    @client.workspace.workers.list.each do |worker|
-      puts worker.friendly_name
-    end
-
-    # fetching a list of workers based on activity
-    @client.workspace.workers.list(activity_name: 'Offline').each do |worker|
-      puts worker.friendly_name + ' is offline'
-    end
-
-    # fetching an worker
-    WORKER_SID = "WKZZZZZZZZZZZZZZZZZ"
-    @worker = @client.workspace.workers.get(WORKER_SID)
-
-    # updating an worker
-    @worker.update(friendly_name: 'NewFriendlyName')
-
-    # deleting an worker
-    @worker.delete
-
-
-TaskQueues
-----------
-
-TaskQueues are the resource you use to categorize Tasks and describe which
-Workers are eligible to handle those Tasks. As your Workflows process Tasks,
-those Tasks will pass through one or more TaskQueues until the Task is assigned
-and accepted by an eligible Worker.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    ACCOUNT_SID = "ACXXXXXXXXXXXXXXXXX"
-    AUTH_TOKEN = "YYYYYYYYYYYYYYYYYY"
-
-    # See previous examples to create a Workspace
-    WORKSPACE_SID = "WSZZZZZZZZZZZZZZ"
-
-    @client = Twilio::REST::TaskRouterClient.new ACCOUNT_SID, AUTH_TOKEN, WORKSPACE_SID
-
-    # creating a task_queue
-    @taskqueue = @client.workspace.task_queues.create(
-        friendly_name: "Sales",
-        # The Activity to assign workers when a task is reserved for them
-        reservation_activity_sid: "WA11111111111",
-        # The Activity to assign workers when a task is assigned to them
-        assignment_activity_sid: "WA222222222222",
-    )
-    puts @taskqueue.sid
-
-     # fetching a list of task_queues
-    @client.workspace.task_queues.list.each do |task_queue|
-      puts task_queue.friendly_name
-    end
-
-    # fetching an taskqueue
-    TASK_QUEUE_SID = "WQZZZZZZZZZZZZZZZZZ"
-    @taskqueue = @client.workspace.task_queues.get(TASK_QUEUE_SID)
-
-    # updating an taskqueue
-    @taskqueue.update(friendly_name: 'NewFriendlyName')
-
-    # deleting an taskqueue
-    @taskqueue.delete
-
-
-Tasks
------
-
-A Task instance resource represents a single item of work waiting to be
-processed.
-
-.. code-block:: ruby
-
-    # To find these visit https://www.twilio.com/user/account
-    ACCOUNT_SID = "ACXXXXXXXXXXXXXXXXX"
-    AUTH_TOKEN = "YYYYYYYYYYYYYYYYYY"
-
-    # See previous examples to create a Workspace
-    WORKSPACE_SID = "WSZZZZZZZZZZZZZZ"
-
-    @client = Twilio::REST::TaskRouterClient.new ACCOUNT_SID, AUTH_TOKEN, WORKSPACE_SID
-
-    # Some JSON containing attributes for this task. User-defined.
-    TASK_ATTRIBUTES = <<-EOS
-    {
-         "type": "call",
-         "contact": "+15558675309",
-         "customer-value": "gold",
-         "task-reason": "support",
-         "callSid": "CA42ed11..."
-    }
-    EOS
-
-    # creating a task
-    @task = @client.workspace.tasks.create(
-        attributes: TASK_ATTRIBUTES,
-        assignment_status: 'pending',
-    )
-    puts @task.sid
-
-    # fetching a list of tasks
-    @client.workspace.tasks.list.each do |task|
-      puts task.sid
-    end
-
-    # fetching a list of tasks that are pending
-    @client.workspace.tasks.list(assignment_status: 'pending').each do |task|
-      puts task.sid
-    end
-
-    # fetching an task
-    TASK_SID = "WTZZZZZZZZZZZZZZZZZ"
-    @task = @client.workspace.tasks.get(TASK_SID)
-
-    # updating an task
-    @task.update(friendly_name: 'NewFriendlyName')
-
-    # deleting an task
-    @task.delete
-
-Reservations
------
-
-A Reservation instance resource represents a single matching item of work from a task to a worker.
-
-.. code-block:: ruby
-
-    # To find these visit https://www.twilio.com/user/account
-    ACCOUNT_SID = "ACXXXXXXXXXXXXXXXXX"
-    AUTH_TOKEN = "YYYYYYYYYYYYYYYYYY"
-
-    # See previous examples to create a Workspace
-    WORKSPACE_SID = "WSZZZZZZZZZZZZZZ"
-
-    @client = Twilio::REST::TaskRouterClient.new ACCOUNT_SID, AUTH_TOKEN, WORKSPACE_SID
-
-    # fetching an task
-    TASK_SID = "WTZZZZZZZZZZZZZZZZZ"
-    @task = @client.workspace.tasks.get(TASK_SID)
-
-    # fetching reservations for said task
-    @task.reservations.list.each do |reservation|
-        puts reservation.sid
-    end
-
-Statistics
------
-
-A Statistics resource represents the statistics over a time period for a particular resource
-
-.. code-block:: ruby
-
-    # To find these visit https://www.twilio.com/user/account
-    ACCOUNT_SID = "ACXXXXXXXXXXXXXXXXX"
-    AUTH_TOKEN = "YYYYYYYYYYYYYYYYYY"
-
-    # See previous examples to create a Workspace
-    WORKSPACE_SID = "WSZZZZZZZZZZZZZZ"
-
-    @client = Twilio::REST::TaskRouterClient.new ACCOUNT_SID, AUTH_TOKEN, WORKSPACE_SID
-
-    # fetching statistics based on the last 4 hours
-    @workspace_stats = @client.workspace.statistics(minutes: '240')
-    @cumulative = @workspace_stats.cumulative
-    puts 'Avg Task Acceptance Time: ' + @cumulative['avg_task_acceptance_time'].to_s \
-         + ' with ' + @cumulative['tasks_created'].to_s + ' tasks created'
-
-Events
------
-
-A Event represents an internal TaskRouter event that occurred and has been logged.
-You can query based on time the event occurred, a certain resource or combination.
-
-.. code-block:: ruby
-
-    # To find these visit https://www.twilio.com/user/account
-    ACCOUNT_SID = "ACXXXXXXXXXXXXXXXXX"
-    AUTH_TOKEN = "YYYYYYYYYYYYYYYYYY"
-
-    # See previous examples to create a Workspace
-    WORKSPACE_SID = "WSZZZZZZZZZZZZZZ"
-
-    @client = Twilio::REST::TaskRouterClient.new ACCOUNT_SID, AUTH_TOKEN, WORKSPACE_SID
-
-    # fetching events for a workspace for the last 15 minutes
-    @events = @client.workspace.events.list(minutes: '15')
-    @events.each do |event|
-      puts event.event_type + ' at ' + event.event_date
-    end

data/docs/usage/token-generation.rst

@@ -1,115 +0,0 @@
-.. module:: twilio.util
-
-===========================
-Generate Capability Tokens
-===========================
-
-`Twilio Client <http://www.twilio.com/api/client>`_ allows you to make and
-receive connections in the browser.
-You can place a call to a phone on the PSTN network,
-all without leaving your browser. See the `Twilio Client Quickstart
-<http:/www.twilio.com/docs/quickstart/client>`_ to get up and running with
-Twilio Client.
-
-Capability tokens are used by `Twilio Client
-<http://www.twilio.com/api/client>`_ to provide connection
-security and authorization. The `Capability Token documentation
-<https://www.twilio.com/docs/client/capability-tokens>`_ explains in depth the purpose and
-features of these tokens.
-
-:class:`Twilio::Util::Capability` is responsible for the creation of these
-capability tokens. You'll need your Twilio AccountSid and AuthToken.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # Find these values at twilio.com/user/account
-    account_sid = "AC123123"
-    auth_token = "secret"
-
-    @capability = Twilio::Util::Capability.new account_sid, auth_token
-
-You can also configure capability tokens 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
-
-    @capability = Twilio::Util::Capability.new
-
-
-
-Allow Incoming Connections
-==============================
-
-Before a device running `Twilio Client <http://www.twilio.com/api/client>`_
-can recieve incoming connections, the instance must first register a name
-(such as "Alice" or "Bob").
-The :meth:`allow_client_incoming` method adds the client name to the
-capability token.
-
-.. code-block:: ruby
-
-    @capability.allow_client_incoming("Alice")
-
-
-Allow Outgoing Connections
-==============================
-
-To make an outgoing connection from a
-`Twilio Client <http://www.twilio.com/api/client>`_ device,
-you'll need to choose a
-`Twilio Application <http://www.twilio.com/docs/api/rest/applications>`_
-to handle TwiML URLs. A Twilio Application is a collection of URLs responsible
-for outputting valid TwiML to control phone calls and messages.
-
-.. code-block:: ruby
-
-    # Twilio Application Sid
-    application_sid = "APabe7650f654fc34655fc81ae71caa3ff"
-    @capability.allow_client_outgoing(application_sid)
-    
-Add Parameters to an Outgoing Scope
-===================================
-
-You can send parameters to your Twilio Application's :attr:`VoiceUrl` by passing
-a hash to :attr:`#allow_client_outgoing`. Here we pass along a hypothetical user
-id.
-
-.. code-block:: ruby
-
-    application_sid = "APabe7650f654fc34655fc81ae71caa3ff"
-    params = {'user_id' => @user.id}
-
-    # Allow outgoing calls to an application and pass the user id to your server.
-    @capability.allow_client_outgoing(application_sid, params)
-
-The :attr:`user_id` parameter and its value will be sent to your Application's
-:attr:`VoiceUrl` along with the other parameters that Twilio usually sends, like
-:attr:`From`, :attr:`To` and :attr:`CallSid`.
-
-
-Generate a Token
-==================
-
-.. code-block:: ruby
-
-    @token = @capability.generate()
-
-By default, this token will expire in one hour. If you'd like to change the
-token expiration, :meth:`generate` takes an optional :attr:`ttl` argument.
-
-.. code-block:: ruby
-
-    @token = @capability.generate(ttl=600)
-
-This token will now expire in 10 minutes. If you haven't guessed already,
-:attr:`ttl` is expressed in seconds.
-

data/docs/usage/transcriptions.rst

@@ -1,32 +0,0 @@
-.. module:: twilio.rest.resources
-
-================
-Transcriptions
-================
-
-Transcriptions are generated from recordings via the
-`TwiML <Record> verb <http://www.twilio.com/docs/api/twiml/record>`_.
-Using the API, you can only read your transcription records.
-
-For more information, see the `Transcriptions REST Resource
-<http://www.twilio.com/docs/api/rest/transcription>`_ documentation.
-
-
-Listing Your Transcriptions
-----------------------------
-
-The following code will print out the length of each :class:`Transcription`.
-
-.. 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.transcriptions.list().each do |transcription|
-      puts transcription.duration
-    end
-

data/docs/usage/twiml.rst

@@ -1,69 +0,0 @@
-.. _usage-twiml:
-
-.. module:: twilio.twiml
-
-==============
-TwiML Creation
-==============
-
-TwiML creation begins with the :class:`Response` verb.
-Each successive verb is created by calling various methods on the response,
-such as :meth:`say` or :meth:`play`.
-These methods return the verbs they create to ease creation of nested TwiML.
-To finish, call the :meth:`toxml` method on the :class:`Response`,
-which returns raw TwiML.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    Twilio::TwiML::Response.new do |r|
-      r.Say "Hello"
-    end.text
-
-.. code-block:: xml
-
-   <?xml version="1.0" encoding="utf-8"?>
-   <Response><Say>Hello</Say><Response>
-
-The verb methods (outlined in the :doc:`complete reference </api/twiml>`)
-take the body (only text) of the verb as the first argument.
-All attributes are keyword arguments.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    Twilio::TwiML::Response.new 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="3">https://api.twilio.com/cowbell.mp3</Play>
-    <Response>
-
-Any example of nesting nouns in verbs
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    Twilio::TwiML::Response.new do |r|
-      r.Say "hello"
-      r.Gather finishOnKey: => 4 do |g|
-        g.Say "world"
-      end
-    end.text
-
-which returns the following
-
-.. code-block:: xml
-
-    <?xml version="1.0" encoding="utf-8"?>
-    <Response>
-      <Say>Hello</Say>
-      <Gather finishOnKey="4"><Say>World</Say></Gather>
-    </Response>