twilio-api-sdk 1.0.0

data/lib/twilio_ap_is/models/task_queue.rb

@@ -0,0 +1,278 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module TwilioApIs
+  # TaskQueue Model.
+  class TaskQueue < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that
+    # created the TaskQueue resource.
+    # @return [String]
+    attr_accessor :account_sid
+
+    # The SID of the Activity to assign Workers when a task is assigned for
+    # them.
+    # @return [String]
+    attr_accessor :assignment_activity_sid
+
+    # The name of the Activity to assign Workers when a task is assigned for
+    # them.
+    # @return [String]
+    attr_accessor :assignment_activity_name
+
+    # The date and time in GMT when the resource was created specified in [RFC
+    # 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
+    # @return [DateTime]
+    attr_accessor :date_created
+
+    # The date and time in GMT when the resource was last updated specified in
+    # [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
+    # @return [DateTime]
+    attr_accessor :date_updated
+
+    # The string that you assigned to describe the resource.
+    # @return [String]
+    attr_accessor :friendly_name
+
+    # The maximum number of Workers to reserve for the assignment of a task in
+    # the queue. Can be an integer between 1 and 50, inclusive and defaults to
+    # 1.
+    # @return [Integer]
+    attr_accessor :max_reserved_workers
+
+    # The SID of the Activity to assign Workers once a task is reserved for
+    # them.
+    # @return [String]
+    attr_accessor :reservation_activity_sid
+
+    # The name of the Activity to assign Workers once a task is reserved for
+    # them.
+    # @return [String]
+    attr_accessor :reservation_activity_name
+
+    # The unique string that we created to identify the TaskQueue resource.
+    # @return [String]
+    attr_accessor :sid
+
+    # A string describing the Worker selection criteria for any Tasks that enter
+    # the TaskQueue. For example `'"language" == "spanish"'` If no TargetWorkers
+    # parameter is provided, Tasks will wait in the TaskQueue until they are
+    # either deleted or moved to another TaskQueue. Additional examples on how
+    # to describing Worker selection criteria below. Defaults to 1==1.
+    # @return [String]
+    attr_accessor :target_workers
+
+    # How Tasks will be assigned to Workers. Set this parameter to `LIFO` to
+    # assign most recently created Task first or `FIFO` to assign the oldest
+    # Task. Default is FIFO. [Click
+    # here](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out
+    # -lifo) to learn more.
+    # @return [TaskQueueTaskOrder]
+    attr_accessor :task_order
+
+    # The absolute URL of the TaskQueue resource.
+    # @return [String]
+    attr_accessor :url
+
+    # The SID of the Workspace that contains the TaskQueue.
+    # @return [String]
+    attr_accessor :workspace_sid
+
+    # The URLs of related resources.
+    # @return [Object]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_sid'] = 'account_sid'
+      @_hash['assignment_activity_sid'] = 'assignment_activity_sid'
+      @_hash['assignment_activity_name'] = 'assignment_activity_name'
+      @_hash['date_created'] = 'date_created'
+      @_hash['date_updated'] = 'date_updated'
+      @_hash['friendly_name'] = 'friendly_name'
+      @_hash['max_reserved_workers'] = 'max_reserved_workers'
+      @_hash['reservation_activity_sid'] = 'reservation_activity_sid'
+      @_hash['reservation_activity_name'] = 'reservation_activity_name'
+      @_hash['sid'] = 'sid'
+      @_hash['target_workers'] = 'target_workers'
+      @_hash['task_order'] = 'task_order'
+      @_hash['url'] = 'url'
+      @_hash['workspace_sid'] = 'workspace_sid'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_sid
+        assignment_activity_sid
+        assignment_activity_name
+        date_created
+        date_updated
+        friendly_name
+        max_reserved_workers
+        reservation_activity_sid
+        reservation_activity_name
+        sid
+        target_workers
+        task_order
+        url
+        workspace_sid
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_sid
+        assignment_activity_sid
+        assignment_activity_name
+        date_created
+        date_updated
+        friendly_name
+        reservation_activity_sid
+        reservation_activity_name
+        sid
+        target_workers
+        url
+        workspace_sid
+        links
+      ]
+    end
+
+    def initialize(account_sid: SKIP, assignment_activity_sid: SKIP,
+                   assignment_activity_name: SKIP, date_created: SKIP,
+                   date_updated: SKIP, friendly_name: SKIP,
+                   max_reserved_workers: 0, reservation_activity_sid: SKIP,
+                   reservation_activity_name: SKIP, sid: SKIP,
+                   target_workers: SKIP, task_order: SKIP, url: SKIP,
+                   workspace_sid: SKIP, links: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_sid = account_sid unless account_sid == SKIP
+      @assignment_activity_sid = assignment_activity_sid unless assignment_activity_sid == SKIP
+      @assignment_activity_name = assignment_activity_name unless assignment_activity_name == SKIP
+      @date_created = date_created unless date_created == SKIP
+      @date_updated = date_updated unless date_updated == SKIP
+      @friendly_name = friendly_name unless friendly_name == SKIP
+      @max_reserved_workers = max_reserved_workers unless max_reserved_workers == SKIP
+      @reservation_activity_sid = reservation_activity_sid unless reservation_activity_sid == SKIP
+      unless reservation_activity_name == SKIP
+        @reservation_activity_name =
+          reservation_activity_name
+      end
+      @sid = sid unless sid == SKIP
+      @target_workers = target_workers unless target_workers == SKIP
+      @task_order = task_order unless task_order == SKIP
+      @url = url unless url == SKIP
+      @workspace_sid = workspace_sid unless workspace_sid == SKIP
+      @links = links unless links == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      account_sid = hash.key?('account_sid') ? hash['account_sid'] : SKIP
+      assignment_activity_sid =
+        hash.key?('assignment_activity_sid') ? hash['assignment_activity_sid'] : SKIP
+      assignment_activity_name =
+        hash.key?('assignment_activity_name') ? hash['assignment_activity_name'] : SKIP
+      date_created = if hash.key?('date_created')
+                       (DateTimeHelper.from_rfc3339(hash['date_created']) if hash['date_created'])
+                     else
+                       SKIP
+                     end
+      date_updated = if hash.key?('date_updated')
+                       (DateTimeHelper.from_rfc3339(hash['date_updated']) if hash['date_updated'])
+                     else
+                       SKIP
+                     end
+      friendly_name = hash.key?('friendly_name') ? hash['friendly_name'] : SKIP
+      max_reserved_workers = hash['max_reserved_workers'] ||= 0
+      reservation_activity_sid =
+        hash.key?('reservation_activity_sid') ? hash['reservation_activity_sid'] : SKIP
+      reservation_activity_name =
+        hash.key?('reservation_activity_name') ? hash['reservation_activity_name'] : SKIP
+      sid = hash.key?('sid') ? hash['sid'] : SKIP
+      target_workers =
+        hash.key?('target_workers') ? hash['target_workers'] : SKIP
+      task_order = hash.key?('task_order') ? hash['task_order'] : SKIP
+      url = hash.key?('url') ? hash['url'] : SKIP
+      workspace_sid = hash.key?('workspace_sid') ? hash['workspace_sid'] : SKIP
+      links = hash.key?('links') ? hash['links'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      TaskQueue.new(account_sid: account_sid,
+                    assignment_activity_sid: assignment_activity_sid,
+                    assignment_activity_name: assignment_activity_name,
+                    date_created: date_created,
+                    date_updated: date_updated,
+                    friendly_name: friendly_name,
+                    max_reserved_workers: max_reserved_workers,
+                    reservation_activity_sid: reservation_activity_sid,
+                    reservation_activity_name: reservation_activity_name,
+                    sid: sid,
+                    target_workers: target_workers,
+                    task_order: task_order,
+                    url: url,
+                    workspace_sid: workspace_sid,
+                    links: links,
+                    additional_properties: additional_properties)
+    end
+
+    def to_custom_date_created
+      DateTimeHelper.to_rfc3339(date_created)
+    end
+
+    def to_custom_date_updated
+      DateTimeHelper.to_rfc3339(date_updated)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_sid: #{@account_sid}, assignment_activity_sid:"\
+      " #{@assignment_activity_sid}, assignment_activity_name: #{@assignment_activity_name},"\
+      " date_created: #{@date_created}, date_updated: #{@date_updated}, friendly_name:"\
+      " #{@friendly_name}, max_reserved_workers: #{@max_reserved_workers},"\
+      " reservation_activity_sid: #{@reservation_activity_sid}, reservation_activity_name:"\
+      " #{@reservation_activity_name}, sid: #{@sid}, target_workers: #{@target_workers},"\
+      " task_order: #{@task_order}, url: #{@url}, workspace_sid: #{@workspace_sid}, links:"\
+      " #{@links}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_sid: #{@account_sid.inspect}, assignment_activity_sid:"\
+      " #{@assignment_activity_sid.inspect}, assignment_activity_name:"\
+      " #{@assignment_activity_name.inspect}, date_created: #{@date_created.inspect},"\
+      " date_updated: #{@date_updated.inspect}, friendly_name: #{@friendly_name.inspect},"\
+      " max_reserved_workers: #{@max_reserved_workers.inspect}, reservation_activity_sid:"\
+      " #{@reservation_activity_sid.inspect}, reservation_activity_name:"\
+      " #{@reservation_activity_name.inspect}, sid: #{@sid.inspect}, target_workers:"\
+      " #{@target_workers.inspect}, task_order: #{@task_order.inspect}, url: #{@url.inspect},"\
+      " workspace_sid: #{@workspace_sid.inspect}, links: #{@links.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/twilio_ap_is/models/task_queue_bulk_real_time_statistics.rb

@@ -0,0 +1,141 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # TaskQueueBulkRealTimeStatistics Model.
+  class TaskQueueBulkRealTimeStatistics < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that
+    # created the TaskQueue resource.
+    # @return [String]
+    attr_accessor :account_sid
+
+    # The SID of the Workspace that contains the TaskQueue.
+    # @return [String]
+    attr_accessor :workspace_sid
+
+    # The real-time statistics for each requested TaskQueue SID.
+    # `task_queue_data` returns the following attributes:
+    # `task_queue_sid`: The SID of the TaskQueue from which these statistics
+    # were calculated.
+    # `total_available_workers`: The total number of Workers available for Tasks
+    # in the TaskQueue.
+    # `total_eligible_workers`: The total number of Workers eligible for Tasks
+    # in the TaskQueue, regardless of their Activity state.
+    # `total_tasks`: The total number of Tasks.
+    # `longest_task_waiting_age`: The age of the longest waiting Task.
+    # `longest_task_waiting_sid`: The SID of the longest waiting Task.
+    # `tasks_by_status`: The number of Tasks grouped by their current status.
+    # `tasks_by_priority`: The number of Tasks grouped by priority.
+    # `activity_statistics`: The number of current Workers grouped by Activity.
+    # @return [Array[Object]]
+    attr_accessor :task_queue_data
+
+    # The number of TaskQueue statistics received in task_queue_data.
+    # @return [Integer]
+    attr_accessor :task_queue_response_count
+
+    # The absolute URL of the TaskQueue statistics resource.
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_sid'] = 'account_sid'
+      @_hash['workspace_sid'] = 'workspace_sid'
+      @_hash['task_queue_data'] = 'task_queue_data'
+      @_hash['task_queue_response_count'] = 'task_queue_response_count'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_sid
+        workspace_sid
+        task_queue_data
+        task_queue_response_count
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_sid
+        workspace_sid
+        task_queue_data
+        url
+      ]
+    end
+
+    def initialize(account_sid: SKIP, workspace_sid: SKIP,
+                   task_queue_data: SKIP, task_queue_response_count: 0,
+                   url: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_sid = account_sid unless account_sid == SKIP
+      @workspace_sid = workspace_sid unless workspace_sid == SKIP
+      @task_queue_data = task_queue_data unless task_queue_data == SKIP
+      unless task_queue_response_count == SKIP
+        @task_queue_response_count =
+          task_queue_response_count
+      end
+      @url = url unless url == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      account_sid = hash.key?('account_sid') ? hash['account_sid'] : SKIP
+      workspace_sid = hash.key?('workspace_sid') ? hash['workspace_sid'] : SKIP
+      task_queue_data =
+        hash.key?('task_queue_data') ? hash['task_queue_data'] : SKIP
+      task_queue_response_count = hash['task_queue_response_count'] ||= 0
+      url = hash.key?('url') ? hash['url'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      TaskQueueBulkRealTimeStatistics.new(account_sid: account_sid,
+                                          workspace_sid: workspace_sid,
+                                          task_queue_data: task_queue_data,
+                                          task_queue_response_count: task_queue_response_count,
+                                          url: url,
+                                          additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_sid: #{@account_sid}, workspace_sid: #{@workspace_sid},"\
+      " task_queue_data: #{@task_queue_data}, task_queue_response_count:"\
+      " #{@task_queue_response_count}, url: #{@url}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_sid: #{@account_sid.inspect}, workspace_sid:"\
+      " #{@workspace_sid.inspect}, task_queue_data: #{@task_queue_data.inspect},"\
+      " task_queue_response_count: #{@task_queue_response_count.inspect}, url: #{@url.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end