twilio-ruby 4.13.0 → 5.6.4

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

@@ -0,0 +1,170 @@
+module Twilio
+  module JWT
+    class TaskRouterCapability < BaseJWT
+      TASK_ROUTER_VERSION = 'v1'.freeze
+      def initialize(account_sid, auth_token, workspace_sid, channel_id, nbf: nil, ttl: 3600, valid_until: nil)
+        super(secret_key: auth_token,
+              issuer: account_sid,
+              nbf: nbf,
+              ttl: ttl,
+              valid_until: valid_until
+        )
+        @account_sid = account_sid
+        @auth_token = auth_token
+        @workspace_sid = workspace_sid
+        @channel_id = channel_id
+        @policies = []
+      end
+
+      def add_policy(policy)
+        @policies.push(policy)
+      end
+
+      protected
+
+      def _generate_payload
+        Twilio::JWT::TaskRouterCapability::TaskRouterUtils
+          .web_socket_policies(@account_sid, @channel_id)
+          .each { |policy| add_policy(policy) }
+        policies = @policies.map(&:_generate_payload)
+
+        payload = {
+          account_sid: @account_sid,
+          workspace_sid: @workspace_sid,
+          channel: @channel_id,
+          version: TASK_ROUTER_VERSION,
+          friendly_name: @channel_id,
+          policies: policies
+        }
+
+        if @channel_id[0..1] == 'WK'
+          payload[:worker_sid] = @channel_id
+        elsif @channel_id[0..1] == 'WQ'
+          payload[:taskqueue_sid] = @channel_id
+        end
+
+        payload
+      end
+
+      class Policy
+        attr_accessor :url,
+                      :method,
+                      :allowed,
+                      :post_filters,
+                      :query_filters
+
+        def initialize(url, method, allowed, post_filters = {}, query_filters = {})
+          @url = url
+          @method = method
+          @allowed = allowed
+          @post_filters = post_filters
+          @query_filters = query_filters
+        end
+
+        def _generate_payload
+          policy = {
+            url: @url,
+            method: @method,
+            query_filter: @query_filters,
+            post_filter: @post_filters,
+            allow: @allowed
+          }
+          policy
+        end
+      end
+
+      class TaskRouterUtils
+        TASK_ROUTER_VERSION = 'v1'.freeze
+        TASK_ROUTER_BASE_URL = 'https://taskrouter.twilio.com'.freeze
+        TASK_ROUTER_WEBSOCKET_BASE_URL = 'https://event-bridge.twilio.com/v1/wschannels'.freeze
+
+        def self.workspaces
+          [TASK_ROUTER_BASE_URL, TASK_ROUTER_VERSION, 'Workspaces'].join('/')
+        end
+
+        def self.workspace(worskspace_sid)
+          [TASK_ROUTER_BASE_URL, TASK_ROUTER_VERSION, 'Workspaces', worskspace_sid].join('/')
+        end
+
+        def self.all_workspaces
+          [TASK_ROUTER_BASE_URL, TASK_ROUTER_VERSION, 'Workspaces', '**'].join('/')
+        end
+
+        def self.tasks(workspace_sid)
+          [workspace(workspace_sid), 'Tasks'].join('/')
+        end
+
+        def self.task(workspace_sid, tasks_sid)
+          [workspace(workspace_sid), 'Tasks', tasks_sid].join('/')
+        end
+
+        def self.all_tasks(workspace_sid)
+          [workspace(workspace_sid), 'Tasks', '**'].join('/')
+        end
+
+        def self.task_queues(workspace_sid)
+          [workspace(workspace_sid), 'TaskQueues'].join('/')
+        end
+
+        def self.task_queue(workspace_sid, taskqueue_sid)
+          [workspace(workspace_sid), 'TaskQueues', taskqueue_sid].join('/')
+        end
+
+        def self.all_task_queues(workspace_sid)
+          [workspace(workspace_sid), 'TaskQueues', '**'].join('/')
+        end
+
+        def self.activities(workspace_sid)
+          [workspace(workspace_sid), 'Activities'].join('/')
+        end
+
+        def self.activity(workspace_sid, activity_sid)
+          [workspace(workspace_sid), 'Activities', activity_sid].join('/')
+        end
+
+        def self.all_activities(workspace_sid)
+          [workspace(workspace_sid), 'Activities', '**'].join('/')
+        end
+
+        def self.workers(workspace_sid)
+          [workspace(workspace_sid), 'Workers'].join('/')
+        end
+
+        def self.worker(workspace_sid, worker_sid)
+          [workspace(workspace_sid), 'Workers', worker_sid].join('/')
+        end
+
+        def self.all_workers(workspace_sid)
+          [workspace(workspace_sid), 'Workers', '**'].join('/')
+        end
+
+        def self.reservations(workspace_sid, worker_sid)
+          [worker(workspace_sid, worker_sid), 'Reservations'].join('/')
+        end
+
+        def self.reservation(workspace_sid, worker_sid, reservation_sid)
+          [worker(workspace_sid, worker_sid), 'Reservations', reservation_sid].join('/')
+        end
+
+        def self.all_reservations(workspace_sid, worker_sid)
+          [worker(workspace_sid, worker_sid), 'Reservations', '**'].join('/')
+        end
+
+        def self.web_socket_policies(account_sid, channel_sid)
+          url = [TASK_ROUTER_WEBSOCKET_BASE_URL, account_sid, channel_sid].join('/')
+          get = Policy.new(url, 'GET', true)
+          post = Policy.new(url, 'POST', true)
+          [get, post]
+        end
+
+        def self.worker_policies(workspace_sid, worker_sid)
+          activities = Policy.new(self.activities(workspace_sid), 'GET', true)
+          tasks = Policy.new(all_tasks(workspace_sid), 'GET', true)
+          reservations = Policy.new(all_reservations(workspace_sid, worker_sid), 'GET', true)
+          fetch = Policy.new(worker(workspace_sid, worker_sid), 'GET', true)
+          [activities, tasks, reservations, fetch]
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/accounts/v1/credential/aws.rb

@@ -0,0 +1,338 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Accounts < Domain
+      class V1 < Version
+        class CredentialList < ListResource
+          class AwsList < ListResource
+            ##
+            # Initialize the AwsList
+            # @param [Version] version Version that contains the resource
+            # @return [AwsList] AwsList
+            def initialize(version)
+              super(version)
+
+              # Path Solution
+              @solution = {}
+              @uri = "/Credentials/AWS"
+            end
+
+            ##
+            # Lists AwsInstance records from the API as a list.
+            # Unlike stream(), this operation is eager and will load `limit` records into
+            # memory before returning.
+            # @param [Integer] limit Upper limit for the number of records to return. stream()
+            #    guarantees to never return more than limit.  Default is no limit
+            # @param [Integer] page_size Number of records to fetch per request, when
+            #    not set will use the default value of 50 records.  If no page_size is defined
+            #    but a limit is defined, stream() will attempt to read the limit with the most
+            #    efficient page size, i.e. min(limit, 1000)
+            # @return [Array] Array of up to limit results
+            def list(limit: nil, page_size: nil)
+              self.stream(limit: limit, page_size: page_size).entries
+            end
+
+            ##
+            # Streams AwsInstance records from the API as an Enumerable.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            # @param [Integer] limit Upper limit for the number of records to return. stream()
+            #    guarantees to never return more than limit. Default is no limit.
+            # @param [Integer] page_size Number of records to fetch per request, when
+            #    not set will use the default value of 50 records. If no page_size is defined
+            #    but a limit is defined, stream() will attempt to read the limit with the most
+            #    efficient page size, i.e. min(limit, 1000)
+            # @return [Enumerable] Enumerable that will yield up to limit results
+            def stream(limit: nil, page_size: nil)
+              limits = @version.read_limits(limit, page_size)
+
+              page = self.page(page_size: limits[:page_size], )
+
+              @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+            end
+
+            ##
+            # When passed a block, yields AwsInstance records from the API.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            def each
+              limits = @version.read_limits
+
+              page = self.page(page_size: limits[:page_size], )
+
+              @version.stream(page,
+                              limit: limits[:limit],
+                              page_limit: limits[:page_limit]).each {|x| yield x}
+            end
+
+            ##
+            # Retrieve a single page of AwsInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] page_token PageToken provided by the API
+            # @param [Integer] page_number Page Number, this value is simply for client state
+            # @param [Integer] page_size Number of records to return, defaults to 50
+            # @return [Page] Page of AwsInstance
+            def page(page_token: :unset, page_number: :unset, page_size: :unset)
+              params = Twilio::Values.of({
+                  'PageToken' => page_token,
+                  'Page' => page_number,
+                  'PageSize' => page_size,
+              })
+              response = @version.page(
+                  'GET',
+                  @uri,
+                  params
+              )
+              AwsPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of AwsInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of AwsInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              AwsPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of AwsInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] credentials The credentials
+            # @param [String] friendly_name The friendly_name
+            # @param [String] account_sid The account_sid
+            # @return [AwsInstance] Newly created AwsInstance
+            def create(credentials: nil, friendly_name: :unset, account_sid: :unset)
+              data = Twilio::Values.of({
+                  'Credentials' => credentials,
+                  'FriendlyName' => friendly_name,
+                  'AccountSid' => account_sid,
+              })
+
+              payload = @version.create(
+                  'POST',
+                  @uri,
+                  data: data
+              )
+
+              AwsInstance.new(@version, payload, )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Accounts.V1.AwsList>'
+            end
+          end
+
+          class AwsPage < Page
+            ##
+            # Initialize the AwsPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [AwsPage] AwsPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of AwsInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [AwsInstance] AwsInstance
+            def get_instance(payload)
+              AwsInstance.new(@version, payload, )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Accounts.V1.AwsPage>'
+            end
+          end
+
+          class AwsContext < InstanceContext
+            ##
+            # Initialize the AwsContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] sid The sid
+            # @return [AwsContext] AwsContext
+            def initialize(version, sid)
+              super(version)
+
+              # Path Solution
+              @solution = {sid: sid, }
+              @uri = "/Credentials/AWS/#{@solution[:sid]}"
+            end
+
+            ##
+            # Fetch a AwsInstance
+            # @return [AwsInstance] Fetched AwsInstance
+            def fetch
+              params = Twilio::Values.of({})
+
+              payload = @version.fetch(
+                  'GET',
+                  @uri,
+                  params,
+              )
+
+              AwsInstance.new(@version, payload, sid: @solution[:sid], )
+            end
+
+            ##
+            # Update the AwsInstance
+            # @param [String] friendly_name The friendly_name
+            # @return [AwsInstance] Updated AwsInstance
+            def update(friendly_name: :unset)
+              data = Twilio::Values.of({'FriendlyName' => friendly_name, })
+
+              payload = @version.update(
+                  'POST',
+                  @uri,
+                  data: data,
+              )
+
+              AwsInstance.new(@version, payload, sid: @solution[:sid], )
+            end
+
+            ##
+            # Deletes the AwsInstance
+            # @return [Boolean] true if delete succeeds, true otherwise
+            def delete
+              @version.delete('delete', @uri)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Accounts.V1.AwsContext #{context}>"
+            end
+          end
+
+          class AwsInstance < InstanceResource
+            ##
+            # Initialize the AwsInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] sid The sid
+            # @return [AwsInstance] AwsInstance
+            def initialize(version, payload, sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'sid' => payload['sid'],
+                  'account_sid' => payload['account_sid'],
+                  'friendly_name' => payload['friendly_name'],
+                  'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                  'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                  'url' => payload['url'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {'sid' => sid || @properties['sid'], }
+            end
+
+            ##
+            # Generate an instance context for the instance, the context is capable of
+            # performing various actions.  All instance actions are proxied to the context
+            # @return [AwsContext] AwsContext for this AwsInstance
+            def context
+              unless @instance_context
+                @instance_context = AwsContext.new(@version, @params['sid'], )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] The sid
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @return [String] The account_sid
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [String] The friendly_name
+            def friendly_name
+              @properties['friendly_name']
+            end
+
+            ##
+            # @return [Time] The date_created
+            def date_created
+              @properties['date_created']
+            end
+
+            ##
+            # @return [Time] The date_updated
+            def date_updated
+              @properties['date_updated']
+            end
+
+            ##
+            # @return [String] The url
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Fetch a AwsInstance
+            # @return [AwsInstance] Fetched AwsInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Update the AwsInstance
+            # @param [String] friendly_name The friendly_name
+            # @return [AwsInstance] Updated AwsInstance
+            def update(friendly_name: :unset)
+              context.update(friendly_name: friendly_name, )
+            end
+
+            ##
+            # Deletes the AwsInstance
+            # @return [Boolean] true if delete succeeds, true otherwise
+            def delete
+              context.delete
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Accounts.V1.AwsInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Accounts.V1.AwsInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end