twilio-ruby 4.6.1 → 6.9.0

data/lib/twilio-ruby/rest/task_router_client.rb

@@ -1,176 +0,0 @@
-require 'twilio-ruby/rest/base_client'
-module Twilio
-  module REST
-    class TaskRouterClient < BaseClient
-      API_VERSION = 'v1'
-
-      attr_reader :workspace, :workspace_sid, :workspaces
-
-      host 'taskrouter.twilio.com'
-
-      ##
-      # Instantiate a new HTTP TaskRouter client to talk to Twilio. The parameters
-      # +account_sid+, +auth_token+ and +workspace_sid are required, unless you
-      # have configured them already using the block configure syntax, and used
-      # to generate the HTTP basic auth header in each request. The +options+
-      # parameter is a hash of connection configuration options. the following
-      # keys are supported:
-      #
-      # === <tt>host: 'taskrouter.twilio.com'</tt>
-      #
-      # The domain to which you'd like the client to make HTTP requests. Useful
-      # for testing. Defaults to 'api.twilio.com'.
-      #
-      # === <tt>port: 443</tt>
-      #
-      # The port on which to connect to the above domain. Defaults to 443 and
-      # should be left that way except in testing environments.
-      #
-      # === <tt>use_ssl: true</tt>
-      #
-      # Declare whether ssl should be used for connections to the above domain.
-      # Defaults to true and should be left alone except when testing.
-      #
-      # === <tt>ssl_verify_peer: true</tt>
-      #
-      # Declare whether to verify the host's ssl cert when setting up the
-      # connection to the above domain. Defaults to true, but can be turned off
-      # to avoid ssl certificate verification failures in environments without
-      # the necessary ca certificates.
-      #
-      # === <tt>ssl_ca_file: '/path/to/ca/file'</tt>
-      #
-      # Specify the path to the certificate authority bundle you'd like to use
-      # to verify Twilio's SSL certificate on each request. If not specified, a
-      # certificate bundle extraced from Firefox is packaged with the gem and
-      # used by default.
-      #
-      # === <tt>timeout: 30</tt>
-      #
-      # Set the time in seconds to wait before timing out the HTTP request.
-      # Defaults to 30 seconds. If you aren't fetching giant pages of call or
-      # SMS logs you can safely decrease this to something like 3 seconds or
-      # lower. In paricular if you are sending SMS you can set this to 1 second
-      # or less and swallow the exception if you don't care about the response.
-      #
-      # === <tt>proxy_addr: 'proxy.host.domain'</tt>
-      #
-      # The domain of a proxy through which you'd like the client to make HTTP
-      # requests. Defaults to nil.
-      #
-      # === <tt>proxy_port: 3128</tt>
-      #
-      # The port on which to connect to the above proxy. Defaults to nil.
-      #
-      # === <tt>proxy_user: 'username'</tt>
-      #
-      # The user name to use for authentication with the proxy. Defaults to nil.
-      #
-      # === <tt>proxy_pass: 'password'</tt>
-      #
-      # The password to use for authentication with the proxy. Defaults to nil.
-      #
-      # === <tt>retry_limit: 1</tt>
-      #
-      # The number of times to retry a request that has failed before throwing
-      # an exception. Defaults to one.
-      def initialize(*args)
-        @workspace_sid = args[2]
-        if @workspace_sid.nil?
-          raise ArgumentError, 'Workspace SID is required'
-        end
-        super(*args)
-      end
-
-      def inspect # :nodoc:
-        "<Twilio::REST::TaskRouterClient @account_sid=#{@account_sid}>"
-      end
-
-      ##
-      # Delegate workspace methods from the client. This saves having to call
-      # <tt>client.workspace</tt> every time for resources on the default
-      # workspace.
-      def method_missing(method_name, *args, &block)
-        if workspace.respond_to?(method_name)
-          workspace.send(method_name, *args, &block)
-        else
-          super
-        end
-      end
-
-      def respond_to?(method_name, include_private=false)
-        if workspace.respond_to?(method_name, include_private)
-          true
-        else
-          super
-        end
-      end
-
-      ##
-      # Get statistics of a task queue.
-      def task_queue_statistics(task_queue_sid, *args) # :doc:
-        warn "[DEPRECATED] task_queue_statistics is deprecated. " \
-             "Please call client.task_queue.get(sid).statistics."
-        task_queues.get(task_queue_sid).statistics
-      end
-
-      ##
-      # Get statistics of task queues.
-      def task_queues_statistics(*args) # :doc:
-        warn "[DEPRECATED] task_queues_statistics is deprecated. " \
-             "Please call client.task_queues.statistics."
-        task_queues.statistics
-      end
-
-      ##
-      # Get statistics of a worker.
-      def worker_statistics(worker_sid, *args) # :doc:
-        warn "[DEPRECATED] worker_statistics is deprecated. " \
-             "Please call client.worker.get(sid).statistics."
-        workers.get(worker_sid).statistics
-      end
-
-      ##
-      # Get statistics of workers.
-      def workers_statistics(*args) # :doc:
-        warn "[DEPRECATED] workers_statistics is deprecated. " \
-             "Please call client.workers.statistics."
-        workers.statistics
-      end
-
-      ##
-      # Get statistics of a workflow.
-      def workflow_statistics(workflow_sid, *args) # :doc:
-        warn "[DEPRECATED] workflow_statistics is deprecated. " \
-             "Please call client.workflow.get(sid).statistics."
-        workflows.get(workflow_sid).statistics
-      end
-
-      ##
-      # Get statistics of a workspace.
-      def workspace_statistics(*args) # :doc:
-        warn "[DEPRECATED] worker_statistics is deprecated. " \
-             "Please call client.workspace.statistics."
-        workspace.statistics
-      end
-
-      protected
-
-      ##
-      # Set up +workspace+ and +workspaces+ attributes.
-      def set_up_subresources # :doc:
-        @workspaces = Twilio::REST::TaskRouter::Workspaces.new "/#{API_VERSION}/Workspaces", self
-        @workspace = @workspaces.get @workspace_sid
-      end
-
-      ##
-      # Builds up full request path
-      def build_full_path(path, params, method)
-        path = path.dup
-        path << "?#{url_encode(params)}" if method == :get && !params.empty?
-        path
-      end
-
-    end
-  end
-end

data/lib/twilio-ruby/rest/tokens.rb

@@ -1,7 +0,0 @@
-module Twilio
-  module REST
-    class Tokens < ListResource; end
-
-    class Token < InstanceResource; end
-  end
-end

data/lib/twilio-ruby/rest/transcriptions.rb

@@ -1,6 +0,0 @@
-module Twilio
-  module REST
-    class Transcriptions < ListResource; end
-    class Transcription < InstanceResource; end
-  end
-end

data/lib/twilio-ruby/rest/trunking/credential_lists.rb

@@ -1,8 +0,0 @@
-module Twilio
-  module REST
-    module Trunking
-      class CredentialLists < NextGenListResource; end
-      class CredentialList < InstanceResource; end
-    end
-  end
-end

data/lib/twilio-ruby/rest/trunking/ip_access_control_lists.rb

@@ -1,8 +0,0 @@
-module Twilio
-  module REST
-    module Trunking
-      class IpAccessControlLists < NextGenListResource; end
-      class IpAccessControlList < InstanceResource; end
-    end
-  end
-end

data/lib/twilio-ruby/rest/trunking/origination_urls.rb

@@ -1,8 +0,0 @@
-module Twilio
-  module REST
-    module Trunking
-      class OriginationUrls < NextGenListResource; end
-      class OriginationUrl < InstanceResource; end
-    end
-  end
-end

data/lib/twilio-ruby/rest/trunking/phone_numbers.rb

@@ -1,8 +0,0 @@
-module Twilio
-  module REST
-    module Trunking
-      class PhoneNumbers < NextGenListResource; end
-      class PhoneNumber < InstanceResource; end
-    end
-  end
-end

data/lib/twilio-ruby/rest/trunking/trunks.rb

@@ -1,19 +0,0 @@
-module Twilio
-  module REST
-    module Trunking
-      class Trunks < NextGenListResource; end
-      class Trunk < InstanceResource
-
-        def initialize(path, client, params={})
-          super
-          @submodule = :Trunking
-          resource :credential_lists,
-                   :ip_access_control_lists,
-                   :origination_urls,
-                   :phone_numbers
-        end
-
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/trunking_client.rb

@@ -1,106 +0,0 @@
-require 'twilio-ruby/rest/base_client'
-
-module Twilio
-  module REST
-    class TrunkingClient < BaseClient
-      include Twilio::Util
-      include Twilio::REST::Utils
-
-      API_VERSION = 'v1'
-
-      attr_reader :trunks
-
-      host 'trunking.twilio.com'
-
-      ##
-      # Instantiate a new HTTP client to talk to Twilio's Trunking API. The
-      # parameters +account_sid+ and +auth_token+ are required, unless you have
-      # configured them already using the block configure syntax, and used to
-      # generate the HTTP basic auth header in each request. The +options+
-      # parameter is a hash of connection configuration options. the following
-      # keys are supported:
-      #
-      # === <tt>host: 'trunking.twilio.com'</tt>
-      #
-      # The domain to which you'd like the client to make HTTP requests. Useful
-      # for testing. Defaults to 'trunking.twilio.com'.
-      #
-      # === <tt>port: 443</tt>
-      #
-      # The port on which to connect to the above domain. Defaults to 443 and
-      # should be left that way except in testing environments.
-      #
-      # === <tt>use_ssl: true</tt>
-      #
-      # Declare whether ssl should be used for connections to the above domain.
-      # Defaults to true and should be left alone except when testing.
-      #
-      # === <tt>ssl_verify_peer: true</tt>
-      #
-      # Declare whether to verify the host's ssl cert when setting up the
-      # connection to the above domain. Defaults to true, but can be turned off
-      # to avoid ssl certificate verification failures in environments without
-      # the necessary ca certificates.
-      #
-      # === <tt>ssl_ca_file: '/path/to/ca/file'</tt>
-      #
-      # Specify the path to the certificate authority bundle you'd like to use
-      # to verify Twilio's SSL certificate on each request. If not specified, a
-      # certificate bundle extraced from Firefox is packaged with the gem and
-      # used by default.
-      #
-      # === <tt>timeout: 30</tt>
-      #
-      # Set the time in seconds to wait before timing out the HTTP request.
-      # Defaults to 30 seconds. If you aren't fetching giant pages of call or
-      # SMS logs you can safely decrease this to something like 3 seconds or
-      # lower. In paricular if you are sending SMS you can set this to 1 second
-      # or less and swallow the exception if you don't care about the response.
-      #
-      # === <tt>proxy_addr: 'proxy.host.domain'</tt>
-      #
-      # The domain of a proxy through which you'd like the client to make HTTP
-      # requests. Defaults to nil.
-      #
-      # === <tt>proxy_port: 3128</tt>
-      #
-      # The port on which to connect to the above proxy. Defaults to nil.
-      #
-      # === <tt>proxy_user: 'username'</tt>
-      #
-      # The user name to use for authentication with the proxy. Defaults to nil.
-      #
-      # === <tt>proxy_pass: 'password'</tt>
-      #
-      # The password to use for authentication with the proxy. Defaults to nil.
-      #
-      # === <tt>retry_limit: 1</tt>
-      #
-      # The number of times to retry a request that has failed before throwing
-      # an exception. Defaults to one.
-      def initialize(*args)
-        super(*args)
-      end
-
-      def inspect # :nodoc:
-        "<Twilio::REST::TrunkingClient @account_sid=#{@account_sid}>"
-      end
-
-      protected
-
-      ##
-      # Set up +trunks+ attribute.
-      def set_up_subresources # :doc:
-        @trunks = Twilio::REST::Trunking::Trunks.new "/#{API_VERSION}/Trunks", self
-      end
-
-      ##
-      # Builds up full request path
-      def build_full_path(path, params, method)
-        path = path.dup
-        path << "?#{url_encode(params)}" if method == :get && !params.empty?
-        path
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/usage/records.rb

@@ -1,21 +0,0 @@
-module Twilio
-  module REST
-    class Records < ListResource
-
-      SUBRESOURCES = [:daily, :monthly, :yearly, :all_time, :today,
-                      :yesterday, :this_month, :last_month]
-
-      def initialize(path, client)
-        super
-        @list_key = 'usage_records'
-      end
-
-      def method_missing(method, *args)
-        return super unless SUBRESOURCES.include? method
-        self.class.new "#{@path}/#{twilify(method)}", @client
-      end
-    end
-
-    class Record < InstanceResource; end
-  end
-end

data/lib/twilio-ruby/rest/usage/triggers.rb

@@ -1,12 +0,0 @@
-module Twilio
-  module REST
-    class Triggers < ListResource
-      def initialize(path, client)
-        super
-        @list_key = 'usage_triggers'
-      end
-    end
-
-    class Trigger < InstanceResource; end
-  end
-end

data/lib/twilio-ruby/rest/usage.rb

@@ -1,10 +0,0 @@
-module Twilio
-  module REST
-    class Usage < InstanceResource
-      def initialize(path, client, params={})
-        super
-        resource :records, :triggers
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/utils.rb

@@ -1,49 +0,0 @@
-module Twilio
-  module REST
-    module Utils
-
-      def twilify(something)
-        return key_map(something, :twilify) if something.is_a? Hash
-        string = something.to_s
-        string.split('_').map do |string_part|
-          string_part[0,1].capitalize + string_part[1..-1]
-        end.join
-      end
-
-      def detwilify(something)
-        return key_map(something, :detwilify) if something.is_a? Hash
-        string = something.to_s
-        string = string[0,1].downcase + string[1..-1]
-        string.gsub(/[A-Z][a-z]*/) { |s| "_#{s.downcase}" }
-      end
-
-      protected
-
-      def resource(*resources)
-        custom_resource_names = { sms: 'SMS', sip: 'SIP' }
-        resources.each do |r|
-          resource = twilify r
-          relative_path = custom_resource_names.fetch(r, resource)
-          path = "#{@path}/#{relative_path}"
-          enclosing_module = if @submodule == nil
-            Twilio::REST
-          else
-            Twilio::REST.const_get(@submodule)
-          end
-          resource_class = enclosing_module.const_get resource
-          instance_variable_set("@#{r}", resource_class.new(path, @client))
-        end
-        self.class.instance_eval { attr_reader *resources }
-      end
-
-      private
-
-      def key_map(something, method)
-        something = something.to_a.flat_map do |pair|
-          [send(method, pair[0]).to_sym, pair[1]]
-        end
-        Hash[*something]
-      end
-    end
-  end
-end

data/lib/twilio-ruby/task_router/capability.rb

@@ -1,224 +0,0 @@
-module Twilio
-  module TaskRouter
-    class Capability
-      TASK_ROUTER_BASE_URL = 'https://taskrouter.twilio.com'
-      TASK_ROUTER_VERSION = 'v1'
-      TASK_ROUTER_WEBSOCKET_BASE_URL = 'https://event-bridge.twilio.com/v1/wschannels'
-
-      REQUIRED = {required: true}
-      OPTIONAL = {required: false}
-
-      def initialize(account_sid, auth_token, workspace_sid, channel_id)
-        @account_sid = account_sid
-        @auth_token = auth_token
-        @policies = []
-
-        @workspace_sid = workspace_sid
-        @channel_id = channel_id
-
-        @baseUrl = "#{TASK_ROUTER_BASE_URL}/#{TASK_ROUTER_VERSION}/Workspaces/#{workspace_sid}"
-
-        validate_jwt
-
-        setup_resource
-
-        allow_websocket_requests(@channel_id)
-        allow(@resourceUrl, "GET")
-      end
-
-      def allow_fetch_subresources
-        allow(@resourceUrl + "/**", "GET")
-      end
-
-      def allow_updates
-        allow(@resourceUrl, "POST")
-      end
-
-      def allow_updates_subresources
-        allow(@resourceUrl + "/**", "POST")
-      end
-
-      def allow_delete
-        allow(@resourceUrl, "DELETE")
-      end
-
-      def allow_delete_subresources
-        allow(@resourceUrl + "/**", "DELETE")
-      end
-
-      # @deprecated Please use {Twilio::TaskRouter::WorkerCapability.allowActivityUpdates} instead
-      def allow_worker_activity_updates
-        if(@channel_id[0..1] == 'WK')
-          allow(@resourceUrl, "POST", nil, {ActivitySid: REQUIRED})
-        else
-          raise "Deprecreated function not applicable to non-Worker"
-        end
-      end
-
-      # @deprecated Please use {Twilio::TaskRouter::WorkerCapability} instead; added automatically in constructor
-      def allow_worker_fetch_attributes
-        if(@channel_id[0..1] == 'WK')
-          allow(@resourceUrl, "GET")
-        else
-          raise "Deprecated function not applicable to non Worker"
-        end
-      end
-
-      # @deprecated Please use {Twilio::TaskRouter::WorkerCapability.allowReservationUpdates} instead
-      def allow_task_reservation_updates
-        if(@channel_id[0..1] == 'WK')
-          task_url = "#{@baseUrl}/Tasks/**"
-          allow(task_url, "POST", nil, nil)
-        else
-          raise "Deprecated function not applicable to non Worker"
-        end
-      end
-
-      def add_policy(url, method, allowed = true, query_filters = nil, post_filters = nil)
-        policy = {
-            url: url,
-            method: method,
-            query_filter: query_filters || {},
-            post_filter: post_filters || {},
-            allow: allowed
-        }
-
-        @policies.push(policy)
-      end
-
-      def allow(url, method, query_filters = nil, post_filters = nil)
-        add_policy(url, method, true, query_filters, post_filters)
-      end
-
-      def deny(url, method, query_filters = nil, post_filters = nil)
-        add_policy(url, method, false, query_filters, post_filters)
-      end
-
-      def generate_token(ttl = 3600)
-        taskRouterAttributes = {
-            account_sid: @account_sid,
-            workspace_sid: @workspace_sid,
-            channel: @channel_id
-        }
-
-        if(@channel_id[0..1] == 'WK')
-          taskRouterAttributes['worker_sid'] = @channel_id
-        elsif(@channel_id[0..1] == 'WQ')
-          taskRouterAttributes['taskqueue_sid'] = @channel_id
-        end
-
-        generate_token_protected(ttl, taskRouterAttributes)
-      end
-
-      protected
-
-      def generate_token_protected(ttl = 3600, extraAttributes)
-        payload = {
-            iss: @account_sid,
-            exp: (Time.now.to_i + ttl),
-            version: TASK_ROUTER_VERSION,
-            friendly_name: @channel_id,
-            policies: @policies,
-        }
-        extraAttributes.each { |key, value|
-          payload[key] = value
-        }
-
-        JWT.encode payload, @auth_token
-      end
-
-      def setup_resource
-        if(@channel_id[0..1] == 'WS')
-          @resourceUrl = @baseUrl
-        elsif(@channel_id[0..1] == 'WK')
-          @resourceUrl = @baseUrl + "/Workers/" + @channel_id
-
-          @activityUrl = @baseUrl + "/Activities"
-          allow(@activityUrl, "GET")
-
-          @reservationsUrl = @baseUrl + "/Tasks/**"
-          allow(@reservationsUrl, "GET")
-
-        elsif(@channel_id[0..1] == 'WQ')
-          @resourceUrl = @baseUrl + "/TaskQueues/" + @channel_id
-        end
-      end
-
-      def allow_websocket_requests(channel_id)
-        worker_url = "#{TASK_ROUTER_WEBSOCKET_BASE_URL}/#{@account_sid}/#{channel_id}"
-        ['GET', 'POST'].each do |meth|
-          add_policy(worker_url, meth)
-        end
-      end
-
-      def validate_jwt
-        if(@account_sid.nil? or @account_sid[0..1] != 'AC')
-          raise "Invalid AccountSid provided #{@account_sid}"
-        end
-        if(@workspace_sid.nil? or @workspace_sid[0..1] != 'WS')
-          raise "Invalid WorkspaceSid provided #{@workspace_sid}"
-        end
-        if(@channel_id.nil?)
-          raise "ChannelId not provided"
-        end
-        @prefix = @channel_id[0..1]
-        if(@prefix != 'WS' and @prefix != 'WK' and @prefix != 'WQ')
-          raise "Invalid ChannelId provided: #{@channel_id}"
-        end
-      end
-    end
-    class WorkerCapability < Capability
-
-      def initialize(account_sid, auth_token, workspace_sid, worker_sid)
-        super(account_sid, auth_token, workspace_sid, worker_sid)
-        @reservationsUrl = @baseUrl + "/Tasks/**"
-        @activityUrl = @baseUrl + "/Activities"
-
-        allow(@activityUrl, "GET")
-        allow(@reservationsUrl, "GET")
-      end
-
-      def allow_activity_updates
-        allow(@resourceUrl, "POST", nil, {ActivitySid: REQUIRED})
-      end
-
-      def allow_reservation_updates
-        allow(@reservationsUrl, "POST", nil, nil)
-      end
-
-      protected
-
-      def setup_resource
-        @resourceUrl = @baseUrl + "/Workers/" + @channel_id
-      end
-
-    end
-
-    class WorkspaceCapability < Capability
-
-      def initialize(account_sid, auth_token, workspace_sid)
-        super(account_sid, auth_token, workspace_sid, workspace_sid)
-      end
-
-      protected
-
-      def setup_resource
-        @resourceUrl = @baseUrl
-      end
-
-    end
-
-    class TaskQueueCapability < Capability
-
-      def initialize(account_sid, auth_token, workspace_sid, taskqueue_sid)
-        super(account_sid, auth_token, workspace_sid, taskqueue_sid)
-      end
-
-      protected
-
-      def setup_resource
-        @resourceUrl = @baseUrl + "/TaskQueues/" + @channel_id
-      end
-    end
-  end
-end