twilio-api-sdk 1.0.0

data/lib/twilio_ap_is/models/task_queue_statistics.rb

@@ -0,0 +1,135 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # TaskQueueStatistics Model.
+  class TaskQueueStatistics < 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
+
+    # An object that contains the cumulative statistics for the TaskQueue.
+    # @return [Object]
+    attr_accessor :cumulative
+
+    # An object that contains the real-time statistics for the TaskQueue.
+    # @return [Object]
+    attr_accessor :realtime
+
+    # The SID of the TaskQueue from which these statistics were calculated.
+    # @return [String]
+    attr_accessor :task_queue_sid
+
+    # The SID of the Workspace that contains the TaskQueue.
+    # @return [String]
+    attr_accessor :workspace_sid
+
+    # 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['cumulative'] = 'cumulative'
+      @_hash['realtime'] = 'realtime'
+      @_hash['task_queue_sid'] = 'task_queue_sid'
+      @_hash['workspace_sid'] = 'workspace_sid'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_sid
+        cumulative
+        realtime
+        task_queue_sid
+        workspace_sid
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_sid
+        cumulative
+        realtime
+        task_queue_sid
+        workspace_sid
+        url
+      ]
+    end
+
+    def initialize(account_sid: SKIP, cumulative: SKIP, realtime: SKIP,
+                   task_queue_sid: SKIP, workspace_sid: SKIP, 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
+      @cumulative = cumulative unless cumulative == SKIP
+      @realtime = realtime unless realtime == SKIP
+      @task_queue_sid = task_queue_sid unless task_queue_sid == SKIP
+      @workspace_sid = workspace_sid unless workspace_sid == SKIP
+      @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
+      cumulative = hash.key?('cumulative') ? hash['cumulative'] : SKIP
+      realtime = hash.key?('realtime') ? hash['realtime'] : SKIP
+      task_queue_sid =
+        hash.key?('task_queue_sid') ? hash['task_queue_sid'] : SKIP
+      workspace_sid = hash.key?('workspace_sid') ? hash['workspace_sid'] : SKIP
+      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.
+      TaskQueueStatistics.new(account_sid: account_sid,
+                              cumulative: cumulative,
+                              realtime: realtime,
+                              task_queue_sid: task_queue_sid,
+                              workspace_sid: workspace_sid,
+                              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}, cumulative: #{@cumulative}, realtime:"\
+      " #{@realtime}, task_queue_sid: #{@task_queue_sid}, workspace_sid: #{@workspace_sid}, 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}, cumulative: #{@cumulative.inspect},"\
+      " realtime: #{@realtime.inspect}, task_queue_sid: #{@task_queue_sid.inspect}, workspace_sid:"\
+      " #{@workspace_sid.inspect}, url: #{@url.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/twilio_ap_is/models/task_queue_task_order.rb

@@ -0,0 +1,40 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # 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-l
+  # ifo) to learn more.
+  class TaskQueueTaskOrder
+    TASK_QUEUE_TASK_ORDER = [
+      # TODO: Write general description for FIFO
+      FIFO = 'FIFO'.freeze,
+
+      # TODO: Write general description for LIFO
+      LIFO = 'LIFO'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TASK_QUEUE_TASK_ORDER.include?(value)
+    end
+
+    def self.from_value(value, default_value = FIFO)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'fifo' then FIFO
+      when 'lifo' then LIFO
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/twilio_ap_is/models/task_queues_stats.rb

@@ -0,0 +1,124 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # TaskQueuesStats Model.
+  class TaskQueuesStats < 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
+
+    # An object that contains the cumulative statistics for the TaskQueues.
+    # @return [Object]
+    attr_accessor :cumulative
+
+    # An object that contains the real-time statistics for the TaskQueues.
+    # @return [Object]
+    attr_accessor :realtime
+
+    # The SID of the TaskQueue from which these statistics were calculated.
+    # @return [String]
+    attr_accessor :task_queue_sid
+
+    # The SID of the Workspace that contains the TaskQueues.
+    # @return [String]
+    attr_accessor :workspace_sid
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_sid'] = 'account_sid'
+      @_hash['cumulative'] = 'cumulative'
+      @_hash['realtime'] = 'realtime'
+      @_hash['task_queue_sid'] = 'task_queue_sid'
+      @_hash['workspace_sid'] = 'workspace_sid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_sid
+        cumulative
+        realtime
+        task_queue_sid
+        workspace_sid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_sid
+        cumulative
+        realtime
+        task_queue_sid
+        workspace_sid
+      ]
+    end
+
+    def initialize(account_sid: SKIP, cumulative: SKIP, realtime: SKIP,
+                   task_queue_sid: SKIP, workspace_sid: 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
+      @cumulative = cumulative unless cumulative == SKIP
+      @realtime = realtime unless realtime == SKIP
+      @task_queue_sid = task_queue_sid unless task_queue_sid == SKIP
+      @workspace_sid = workspace_sid unless workspace_sid == 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
+      cumulative = hash.key?('cumulative') ? hash['cumulative'] : SKIP
+      realtime = hash.key?('realtime') ? hash['realtime'] : SKIP
+      task_queue_sid =
+        hash.key?('task_queue_sid') ? hash['task_queue_sid'] : SKIP
+      workspace_sid = hash.key?('workspace_sid') ? hash['workspace_sid'] : 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.
+      TaskQueuesStats.new(account_sid: account_sid,
+                          cumulative: cumulative,
+                          realtime: realtime,
+                          task_queue_sid: task_queue_sid,
+                          workspace_sid: workspace_sid,
+                          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}, cumulative: #{@cumulative}, realtime:"\
+      " #{@realtime}, task_queue_sid: #{@task_queue_sid}, workspace_sid: #{@workspace_sid},"\
+      " 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}, cumulative: #{@cumulative.inspect},"\
+      " realtime: #{@realtime.inspect}, task_queue_sid: #{@task_queue_sid.inspect}, workspace_sid:"\
+      " #{@workspace_sid.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/twilio_ap_is/models/task_reservation.rb

@@ -0,0 +1,210 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module TwilioApIs
+  # TaskReservation Model.
+  class TaskReservation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that
+    # created the TaskReservation resource.
+    # @return [String]
+    attr_accessor :account_sid
+
+    # The date and time in GMT when the resource was created specified in [ISO
+    # 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+    # @return [DateTime]
+    attr_accessor :date_created
+
+    # The date and time in GMT when the resource was last updated specified in
+    # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+    # @return [DateTime]
+    attr_accessor :date_updated
+
+    # The current status of the reservation. Can be: `pending`, `accepted`,
+    # `rejected`, or `timeout`.
+    # @return [TaskReservationStatus]
+    attr_accessor :reservation_status
+
+    # The unique string that we created to identify the TaskReservation
+    # resource.
+    # @return [String]
+    attr_accessor :sid
+
+    # The SID of the reserved Task resource.
+    # @return [String]
+    attr_accessor :task_sid
+
+    # The `friendly_name` of the Worker that is reserved.
+    # @return [String]
+    attr_accessor :worker_name
+
+    # The SID of the reserved Worker resource.
+    # @return [String]
+    attr_accessor :worker_sid
+
+    # The SID of the Workspace that this task is contained within.
+    # @return [String]
+    attr_accessor :workspace_sid
+
+    # The absolute URL of the TaskReservation reservation.
+    # @return [String]
+    attr_accessor :url
+
+    # 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['date_created'] = 'date_created'
+      @_hash['date_updated'] = 'date_updated'
+      @_hash['reservation_status'] = 'reservation_status'
+      @_hash['sid'] = 'sid'
+      @_hash['task_sid'] = 'task_sid'
+      @_hash['worker_name'] = 'worker_name'
+      @_hash['worker_sid'] = 'worker_sid'
+      @_hash['workspace_sid'] = 'workspace_sid'
+      @_hash['url'] = 'url'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_sid
+        date_created
+        date_updated
+        reservation_status
+        sid
+        task_sid
+        worker_name
+        worker_sid
+        workspace_sid
+        url
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_sid
+        date_created
+        date_updated
+        sid
+        task_sid
+        worker_name
+        worker_sid
+        workspace_sid
+        url
+        links
+      ]
+    end
+
+    def initialize(account_sid: SKIP, date_created: SKIP, date_updated: SKIP,
+                   reservation_status: SKIP, sid: SKIP, task_sid: SKIP,
+                   worker_name: SKIP, worker_sid: SKIP, workspace_sid: SKIP,
+                   url: 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
+      @date_created = date_created unless date_created == SKIP
+      @date_updated = date_updated unless date_updated == SKIP
+      @reservation_status = reservation_status unless reservation_status == SKIP
+      @sid = sid unless sid == SKIP
+      @task_sid = task_sid unless task_sid == SKIP
+      @worker_name = worker_name unless worker_name == SKIP
+      @worker_sid = worker_sid unless worker_sid == SKIP
+      @workspace_sid = workspace_sid unless workspace_sid == SKIP
+      @url = url unless url == 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
+      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
+      reservation_status =
+        hash.key?('reservation_status') ? hash['reservation_status'] : SKIP
+      sid = hash.key?('sid') ? hash['sid'] : SKIP
+      task_sid = hash.key?('task_sid') ? hash['task_sid'] : SKIP
+      worker_name = hash.key?('worker_name') ? hash['worker_name'] : SKIP
+      worker_sid = hash.key?('worker_sid') ? hash['worker_sid'] : SKIP
+      workspace_sid = hash.key?('workspace_sid') ? hash['workspace_sid'] : SKIP
+      url = hash.key?('url') ? hash['url'] : 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.
+      TaskReservation.new(account_sid: account_sid,
+                          date_created: date_created,
+                          date_updated: date_updated,
+                          reservation_status: reservation_status,
+                          sid: sid,
+                          task_sid: task_sid,
+                          worker_name: worker_name,
+                          worker_sid: worker_sid,
+                          workspace_sid: workspace_sid,
+                          url: url,
+                          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}, date_created: #{@date_created}, date_updated:"\
+      " #{@date_updated}, reservation_status: #{@reservation_status}, sid: #{@sid}, task_sid:"\
+      " #{@task_sid}, worker_name: #{@worker_name}, worker_sid: #{@worker_sid}, workspace_sid:"\
+      " #{@workspace_sid}, url: #{@url}, 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}, date_created:"\
+      " #{@date_created.inspect}, date_updated: #{@date_updated.inspect}, reservation_status:"\
+      " #{@reservation_status.inspect}, sid: #{@sid.inspect}, task_sid: #{@task_sid.inspect},"\
+      " worker_name: #{@worker_name.inspect}, worker_sid: #{@worker_sid.inspect}, workspace_sid:"\
+      " #{@workspace_sid.inspect}, url: #{@url.inspect}, links: #{@links.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/twilio_ap_is/models/task_reservation_call_status.rb

@@ -0,0 +1,44 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # TaskReservationCallStatus.
+  class TaskReservationCallStatus
+    TASK_RESERVATION_CALL_STATUS = [
+      # TODO: Write general description for INITIATED
+      INITIATED = 'initiated'.freeze,
+
+      # TODO: Write general description for RINGING
+      RINGING = 'ringing'.freeze,
+
+      # TODO: Write general description for ANSWERED
+      ANSWERED = 'answered'.freeze,
+
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'completed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TASK_RESERVATION_CALL_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = INITIATED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'initiated' then INITIATED
+      when 'ringing' then RINGING
+      when 'answered' then ANSWERED
+      when 'completed' then COMPLETED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/twilio_ap_is/models/task_reservation_conference_event.rb

@@ -0,0 +1,56 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # TaskReservationConferenceEvent.
+  class TaskReservationConferenceEvent
+    TASK_RESERVATION_CONFERENCE_EVENT = [
+      # TODO: Write general description for START
+      START = 'start'.freeze,
+
+      # TODO: Write general description for ENUM_END
+      ENUM_END = 'end'.freeze,
+
+      # TODO: Write general description for JOIN
+      JOIN = 'join'.freeze,
+
+      # TODO: Write general description for LEAVE
+      LEAVE = 'leave'.freeze,
+
+      # TODO: Write general description for MUTE
+      MUTE = 'mute'.freeze,
+
+      # TODO: Write general description for HOLD
+      HOLD = 'hold'.freeze,
+
+      # TODO: Write general description for SPEAKER
+      SPEAKER = 'speaker'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TASK_RESERVATION_CONFERENCE_EVENT.include?(value)
+    end
+
+    def self.from_value(value, default_value = START)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'start' then START
+      when 'enum_end' then ENUM_END
+      when 'join' then JOIN
+      when 'leave' then LEAVE
+      when 'mute' then MUTE
+      when 'hold' then HOLD
+      when 'speaker' then SPEAKER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/twilio_ap_is/models/task_reservation_status.rb

@@ -0,0 +1,61 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # The current status of the reservation. Can be: `pending`, `accepted`,
+  # `rejected`, or `timeout`.
+  class TaskReservationStatus
+    TASK_RESERVATION_STATUS = [
+      # TODO: Write general description for PENDING
+      PENDING = 'pending'.freeze,
+
+      # TODO: Write general description for ACCEPTED
+      ACCEPTED = 'accepted'.freeze,
+
+      # TODO: Write general description for REJECTED
+      REJECTED = 'rejected'.freeze,
+
+      # TODO: Write general description for TIMEOUT
+      TIMEOUT = 'timeout'.freeze,
+
+      # TODO: Write general description for CANCELED
+      CANCELED = 'canceled'.freeze,
+
+      # TODO: Write general description for RESCINDED
+      RESCINDED = 'rescinded'.freeze,
+
+      # TODO: Write general description for WRAPPING
+      WRAPPING = 'wrapping'.freeze,
+
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'completed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TASK_RESERVATION_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = PENDING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pending' then PENDING
+      when 'accepted' then ACCEPTED
+      when 'rejected' then REJECTED
+      when 'timeout' then TIMEOUT
+      when 'canceled' then CANCELED
+      when 'rescinded' then RESCINDED
+      when 'wrapping' then WRAPPING
+      when 'completed' then COMPLETED
+      else
+        default_value
+      end
+    end
+  end
+end