twilio-api-sdk 1.0.0

data/lib/twilio_ap_is/models/workers_cumulative_statistics.rb

@@ -0,0 +1,221 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module TwilioApIs
+  # WorkersCumulativeStatistics Model.
+  class WorkersCumulativeStatistics < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that
+    # created the Worker resource.
+    # @return [String]
+    attr_accessor :account_sid
+
+    # The beginning of the interval during which these statistics were
+    # calculated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+    # @return [DateTime]
+    attr_accessor :start_time
+
+    # The end of the interval during which these statistics were calculated, in
+    # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+    # @return [DateTime]
+    attr_accessor :end_time
+
+    # The minimum, average, maximum, and total time (in seconds) that Workers
+    # spent in each Activity.
+    # @return [Array[Object]]
+    attr_accessor :activity_durations
+
+    # The total number of Reservations that were created.
+    # @return [Integer]
+    attr_accessor :reservations_created
+
+    # The total number of Reservations that were accepted.
+    # @return [Integer]
+    attr_accessor :reservations_accepted
+
+    # The total number of Reservations that were rejected.
+    # @return [Integer]
+    attr_accessor :reservations_rejected
+
+    # The total number of Reservations that were timed out.
+    # @return [Integer]
+    attr_accessor :reservations_timed_out
+
+    # The total number of Reservations that were canceled.
+    # @return [Integer]
+    attr_accessor :reservations_canceled
+
+    # The total number of Reservations that were rescinded.
+    # @return [Integer]
+    attr_accessor :reservations_rescinded
+
+    # The SID of the Workspace that contains the Workers.
+    # @return [String]
+    attr_accessor :workspace_sid
+
+    # The absolute URL of the Workers 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['start_time'] = 'start_time'
+      @_hash['end_time'] = 'end_time'
+      @_hash['activity_durations'] = 'activity_durations'
+      @_hash['reservations_created'] = 'reservations_created'
+      @_hash['reservations_accepted'] = 'reservations_accepted'
+      @_hash['reservations_rejected'] = 'reservations_rejected'
+      @_hash['reservations_timed_out'] = 'reservations_timed_out'
+      @_hash['reservations_canceled'] = 'reservations_canceled'
+      @_hash['reservations_rescinded'] = 'reservations_rescinded'
+      @_hash['workspace_sid'] = 'workspace_sid'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_sid
+        start_time
+        end_time
+        activity_durations
+        reservations_created
+        reservations_accepted
+        reservations_rejected
+        reservations_timed_out
+        reservations_canceled
+        reservations_rescinded
+        workspace_sid
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_sid
+        start_time
+        end_time
+        activity_durations
+        workspace_sid
+        url
+      ]
+    end
+
+    def initialize(account_sid: SKIP, start_time: SKIP, end_time: SKIP,
+                   activity_durations: SKIP, reservations_created: 0,
+                   reservations_accepted: 0, reservations_rejected: 0,
+                   reservations_timed_out: 0, reservations_canceled: 0,
+                   reservations_rescinded: 0, 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
+      @start_time = start_time unless start_time == SKIP
+      @end_time = end_time unless end_time == SKIP
+      @activity_durations = activity_durations unless activity_durations == SKIP
+      @reservations_created = reservations_created unless reservations_created == SKIP
+      @reservations_accepted = reservations_accepted unless reservations_accepted == SKIP
+      @reservations_rejected = reservations_rejected unless reservations_rejected == SKIP
+      @reservations_timed_out = reservations_timed_out unless reservations_timed_out == SKIP
+      @reservations_canceled = reservations_canceled unless reservations_canceled == SKIP
+      @reservations_rescinded = reservations_rescinded unless reservations_rescinded == 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
+      start_time = if hash.key?('start_time')
+                     (DateTimeHelper.from_rfc3339(hash['start_time']) if hash['start_time'])
+                   else
+                     SKIP
+                   end
+      end_time = if hash.key?('end_time')
+                   (DateTimeHelper.from_rfc3339(hash['end_time']) if hash['end_time'])
+                 else
+                   SKIP
+                 end
+      activity_durations =
+        hash.key?('activity_durations') ? hash['activity_durations'] : SKIP
+      reservations_created = hash['reservations_created'] ||= 0
+      reservations_accepted = hash['reservations_accepted'] ||= 0
+      reservations_rejected = hash['reservations_rejected'] ||= 0
+      reservations_timed_out = hash['reservations_timed_out'] ||= 0
+      reservations_canceled = hash['reservations_canceled'] ||= 0
+      reservations_rescinded = hash['reservations_rescinded'] ||= 0
+      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.
+      WorkersCumulativeStatistics.new(account_sid: account_sid,
+                                      start_time: start_time,
+                                      end_time: end_time,
+                                      activity_durations: activity_durations,
+                                      reservations_created: reservations_created,
+                                      reservations_accepted: reservations_accepted,
+                                      reservations_rejected: reservations_rejected,
+                                      reservations_timed_out: reservations_timed_out,
+                                      reservations_canceled: reservations_canceled,
+                                      reservations_rescinded: reservations_rescinded,
+                                      workspace_sid: workspace_sid,
+                                      url: url,
+                                      additional_properties: additional_properties)
+    end
+
+    def to_custom_start_time
+      DateTimeHelper.to_rfc3339(start_time)
+    end
+
+    def to_custom_end_time
+      DateTimeHelper.to_rfc3339(end_time)
+    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}, start_time: #{@start_time}, end_time:"\
+      " #{@end_time}, activity_durations: #{@activity_durations}, reservations_created:"\
+      " #{@reservations_created}, reservations_accepted: #{@reservations_accepted},"\
+      " reservations_rejected: #{@reservations_rejected}, reservations_timed_out:"\
+      " #{@reservations_timed_out}, reservations_canceled: #{@reservations_canceled},"\
+      " reservations_rescinded: #{@reservations_rescinded}, 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}, start_time: #{@start_time.inspect},"\
+      " end_time: #{@end_time.inspect}, activity_durations: #{@activity_durations.inspect},"\
+      " reservations_created: #{@reservations_created.inspect}, reservations_accepted:"\
+      " #{@reservations_accepted.inspect}, reservations_rejected:"\
+      " #{@reservations_rejected.inspect}, reservations_timed_out:"\
+      " #{@reservations_timed_out.inspect}, reservations_canceled:"\
+      " #{@reservations_canceled.inspect}, reservations_rescinded:"\
+      " #{@reservations_rescinded.inspect}, workspace_sid: #{@workspace_sid.inspect}, url:"\
+      " #{@url.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/twilio_ap_is/models/workers_real_time_statistics.rb

@@ -0,0 +1,124 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # WorkersRealTimeStatistics Model.
+  class WorkersRealTimeStatistics < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that
+    # created the Worker resource.
+    # @return [String]
+    attr_accessor :account_sid
+
+    # The number of current Workers by Activity.
+    # @return [Array[Object]]
+    attr_accessor :activity_statistics
+
+    # The total number of Workers.
+    # @return [Integer]
+    attr_accessor :total_workers
+
+    # The SID of the Workspace that contains the Workers.
+    # @return [String]
+    attr_accessor :workspace_sid
+
+    # The absolute URL of the Workers 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['activity_statistics'] = 'activity_statistics'
+      @_hash['total_workers'] = 'total_workers'
+      @_hash['workspace_sid'] = 'workspace_sid'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_sid
+        activity_statistics
+        total_workers
+        workspace_sid
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_sid
+        activity_statistics
+        workspace_sid
+        url
+      ]
+    end
+
+    def initialize(account_sid: SKIP, activity_statistics: SKIP,
+                   total_workers: 0, 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
+      @activity_statistics = activity_statistics unless activity_statistics == SKIP
+      @total_workers = total_workers unless total_workers == 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
+      activity_statistics =
+        hash.key?('activity_statistics') ? hash['activity_statistics'] : SKIP
+      total_workers = hash['total_workers'] ||= 0
+      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.
+      WorkersRealTimeStatistics.new(account_sid: account_sid,
+                                    activity_statistics: activity_statistics,
+                                    total_workers: total_workers,
+                                    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}, activity_statistics: #{@activity_statistics},"\
+      " total_workers: #{@total_workers}, 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}, activity_statistics:"\
+      " #{@activity_statistics.inspect}, total_workers: #{@total_workers.inspect}, workspace_sid:"\
+      " #{@workspace_sid.inspect}, url: #{@url.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/twilio_ap_is/models/workflow.rb

@@ -0,0 +1,247 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module TwilioApIs
+  # Workflow Model.
+  class Workflow < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that
+    # created the Workflow resource.
+    # @return [String]
+    attr_accessor :account_sid
+
+    # The URL that we call when a task managed by the Workflow is assigned to a
+    # Worker. See Assignment Callback URL for more information.
+    # @return [String]
+    attr_accessor :assignment_callback_url
+
+    # A JSON string that contains the Workflow's configuration. See [Configuring
+    # Workflows](https://www.twilio.com/docs/taskrouter/workflow-configuration)
+    # for more information.
+    # @return [String]
+    attr_accessor :configuration
+
+    # 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 MIME type of the document.
+    # @return [String]
+    attr_accessor :document_content_type
+
+    # The URL that we call when a call to the `assignment_callback_url` fails.
+    # @return [String]
+    attr_accessor :fallback_assignment_callback_url
+
+    # The string that you assigned to describe the Workflow resource. For
+    # example, `Customer Support` or `2014 Election Campaign`.
+    # @return [String]
+    attr_accessor :friendly_name
+
+    # The unique string that we created to identify the Workflow resource.
+    # @return [String]
+    attr_accessor :sid
+
+    # How long TaskRouter will wait for a confirmation response from your
+    # application after it assigns a Task to a Worker. Can be up to `86,400` (24
+    # hours) and the default is `120`.
+    # @return [Integer]
+    attr_accessor :task_reservation_timeout
+
+    # The SID of the Workspace that contains the Workflow.
+    # @return [String]
+    attr_accessor :workspace_sid
+
+    # The absolute URL of the Workflow resource.
+    # @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['assignment_callback_url'] = 'assignment_callback_url'
+      @_hash['configuration'] = 'configuration'
+      @_hash['date_created'] = 'date_created'
+      @_hash['date_updated'] = 'date_updated'
+      @_hash['document_content_type'] = 'document_content_type'
+      @_hash['fallback_assignment_callback_url'] =
+        'fallback_assignment_callback_url'
+      @_hash['friendly_name'] = 'friendly_name'
+      @_hash['sid'] = 'sid'
+      @_hash['task_reservation_timeout'] = 'task_reservation_timeout'
+      @_hash['workspace_sid'] = 'workspace_sid'
+      @_hash['url'] = 'url'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_sid
+        assignment_callback_url
+        configuration
+        date_created
+        date_updated
+        document_content_type
+        fallback_assignment_callback_url
+        friendly_name
+        sid
+        task_reservation_timeout
+        workspace_sid
+        url
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_sid
+        assignment_callback_url
+        configuration
+        date_created
+        date_updated
+        document_content_type
+        fallback_assignment_callback_url
+        friendly_name
+        sid
+        workspace_sid
+        url
+        links
+      ]
+    end
+
+    def initialize(account_sid: SKIP, assignment_callback_url: SKIP,
+                   configuration: SKIP, date_created: SKIP, date_updated: SKIP,
+                   document_content_type: SKIP,
+                   fallback_assignment_callback_url: SKIP, friendly_name: SKIP,
+                   sid: SKIP, task_reservation_timeout: 0, 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
+      @assignment_callback_url = assignment_callback_url unless assignment_callback_url == SKIP
+      @configuration = configuration unless configuration == SKIP
+      @date_created = date_created unless date_created == SKIP
+      @date_updated = date_updated unless date_updated == SKIP
+      @document_content_type = document_content_type unless document_content_type == SKIP
+      unless fallback_assignment_callback_url == SKIP
+        @fallback_assignment_callback_url =
+          fallback_assignment_callback_url
+      end
+      @friendly_name = friendly_name unless friendly_name == SKIP
+      @sid = sid unless sid == SKIP
+      @task_reservation_timeout = task_reservation_timeout unless task_reservation_timeout == 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
+      assignment_callback_url =
+        hash.key?('assignment_callback_url') ? hash['assignment_callback_url'] : SKIP
+      configuration = hash.key?('configuration') ? hash['configuration'] : 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
+      document_content_type =
+        hash.key?('document_content_type') ? hash['document_content_type'] : SKIP
+      fallback_assignment_callback_url =
+        hash.key?('fallback_assignment_callback_url') ? hash['fallback_assignment_callback_url'] : SKIP
+      friendly_name = hash.key?('friendly_name') ? hash['friendly_name'] : SKIP
+      sid = hash.key?('sid') ? hash['sid'] : SKIP
+      task_reservation_timeout = hash['task_reservation_timeout'] ||= 0
+      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.
+      Workflow.new(account_sid: account_sid,
+                   assignment_callback_url: assignment_callback_url,
+                   configuration: configuration,
+                   date_created: date_created,
+                   date_updated: date_updated,
+                   document_content_type: document_content_type,
+                   fallback_assignment_callback_url: fallback_assignment_callback_url,
+                   friendly_name: friendly_name,
+                   sid: sid,
+                   task_reservation_timeout: task_reservation_timeout,
+                   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}, assignment_callback_url:"\
+      " #{@assignment_callback_url}, configuration: #{@configuration}, date_created:"\
+      " #{@date_created}, date_updated: #{@date_updated}, document_content_type:"\
+      " #{@document_content_type}, fallback_assignment_callback_url:"\
+      " #{@fallback_assignment_callback_url}, friendly_name: #{@friendly_name}, sid: #{@sid},"\
+      " task_reservation_timeout: #{@task_reservation_timeout}, 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}, assignment_callback_url:"\
+      " #{@assignment_callback_url.inspect}, configuration: #{@configuration.inspect},"\
+      " date_created: #{@date_created.inspect}, date_updated: #{@date_updated.inspect},"\
+      " document_content_type: #{@document_content_type.inspect},"\
+      " fallback_assignment_callback_url: #{@fallback_assignment_callback_url.inspect},"\
+      " friendly_name: #{@friendly_name.inspect}, sid: #{@sid.inspect}, task_reservation_timeout:"\
+      " #{@task_reservation_timeout.inspect}, workspace_sid: #{@workspace_sid.inspect}, url:"\
+      " #{@url.inspect}, links: #{@links.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end