sz-apimatic-sdk 0.0.1

data/lib/seltz_api/models/run.rb

@@ -0,0 +1,200 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # Run Model.
+  class Run < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :completed_at
+
+    # The lowest `record_id` this run produced. Records are not contiguous; use
+    # `record_count` for the count.
+    # @return [String]
+    attr_accessor :first_record_id
+
+    # The highest `record_id` this run produced. Records are not contiguous; use
+    # `record_count` for the count.
+    # @return [String]
+    attr_accessor :last_record_id
+
+    # The highest `record_id` this run produced. Records are not contiguous; use
+    # `record_count` for the count.
+    # @return [String]
+    attr_accessor :monitor_id
+
+    # The highest `record_id` this run produced. Records are not contiguous; use
+    # `record_count` for the count.
+    # @return [Integer]
+    attr_accessor :record_count
+
+    # The highest `record_id` this run produced. Records are not contiguous; use
+    # `record_count` for the count.
+    # @return [Integer]
+    attr_accessor :requests_failed
+
+    # The highest `record_id` this run produced. Records are not contiguous; use
+    # `record_count` for the count.
+    # @return [Integer]
+    attr_accessor :requests_ok
+
+    # The highest `record_id` this run produced. Records are not contiguous; use
+    # `record_count` for the count.
+    # @return [Integer]
+    attr_accessor :requests_total
+
+    # The highest `record_id` this run produced. Records are not contiguous; use
+    # `record_count` for the count.
+    # @return [String]
+    attr_accessor :run_id
+
+    # The highest `record_id` this run produced. Records are not contiguous; use
+    # `record_count` for the count.
+    # @return [String]
+    attr_accessor :started_at
+
+    # The highest `record_id` this run produced. Records are not contiguous; use
+    # `record_count` for the count.
+    # @return [RunStatus]
+    attr_accessor :status
+
+    # Prose for a human, empty when completed.
+    # @return [String]
+    attr_accessor :status_reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['completed_at'] = 'completed_at'
+      @_hash['first_record_id'] = 'first_record_id'
+      @_hash['last_record_id'] = 'last_record_id'
+      @_hash['monitor_id'] = 'monitor_id'
+      @_hash['record_count'] = 'record_count'
+      @_hash['requests_failed'] = 'requests_failed'
+      @_hash['requests_ok'] = 'requests_ok'
+      @_hash['requests_total'] = 'requests_total'
+      @_hash['run_id'] = 'run_id'
+      @_hash['started_at'] = 'started_at'
+      @_hash['status'] = 'status'
+      @_hash['status_reason'] = 'status_reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        completed_at
+        first_record_id
+        last_record_id
+        monitor_id
+        record_count
+        requests_failed
+        requests_ok
+        requests_total
+        run_id
+        started_at
+        status_reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        completed_at
+        started_at
+      ]
+    end
+
+    def initialize(status: RunStatus::COMPLETED, completed_at: SKIP,
+                   first_record_id: '0', last_record_id: '0', monitor_id: SKIP,
+                   record_count: 0, requests_failed: 0, requests_ok: 0,
+                   requests_total: 0, run_id: '0', started_at: SKIP,
+                   status_reason: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @completed_at = completed_at unless completed_at == SKIP
+      @first_record_id = first_record_id unless first_record_id == SKIP
+      @last_record_id = last_record_id unless last_record_id == SKIP
+      @monitor_id = monitor_id unless monitor_id == SKIP
+      @record_count = record_count unless record_count == SKIP
+      @requests_failed = requests_failed unless requests_failed == SKIP
+      @requests_ok = requests_ok unless requests_ok == SKIP
+      @requests_total = requests_total unless requests_total == SKIP
+      @run_id = run_id unless run_id == SKIP
+      @started_at = started_at unless started_at == SKIP
+      @status = status
+      @status_reason = status_reason unless status_reason == 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.
+      status = hash['status'] ||= RunStatus::COMPLETED
+      completed_at = hash.key?('completed_at') ? hash['completed_at'] : SKIP
+      first_record_id = hash['first_record_id'] ||= '0'
+      last_record_id = hash['last_record_id'] ||= '0'
+      monitor_id = hash.key?('monitor_id') ? hash['monitor_id'] : SKIP
+      record_count = hash['record_count'] ||= 0
+      requests_failed = hash['requests_failed'] ||= 0
+      requests_ok = hash['requests_ok'] ||= 0
+      requests_total = hash['requests_total'] ||= 0
+      run_id = hash['run_id'] ||= '0'
+      started_at = hash.key?('started_at') ? hash['started_at'] : SKIP
+      status_reason = hash.key?('status_reason') ? hash['status_reason'] : 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.
+      Run.new(status: status,
+              completed_at: completed_at,
+              first_record_id: first_record_id,
+              last_record_id: last_record_id,
+              monitor_id: monitor_id,
+              record_count: record_count,
+              requests_failed: requests_failed,
+              requests_ok: requests_ok,
+              requests_total: requests_total,
+              run_id: run_id,
+              started_at: started_at,
+              status_reason: status_reason,
+              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} completed_at: #{@completed_at}, first_record_id: #{@first_record_id},"\
+      " last_record_id: #{@last_record_id}, monitor_id: #{@monitor_id}, record_count:"\
+      " #{@record_count}, requests_failed: #{@requests_failed}, requests_ok: #{@requests_ok},"\
+      " requests_total: #{@requests_total}, run_id: #{@run_id}, started_at: #{@started_at},"\
+      " status: #{@status}, status_reason: #{@status_reason}, 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} completed_at: #{@completed_at.inspect}, first_record_id:"\
+      " #{@first_record_id.inspect}, last_record_id: #{@last_record_id.inspect}, monitor_id:"\
+      " #{@monitor_id.inspect}, record_count: #{@record_count.inspect}, requests_failed:"\
+      " #{@requests_failed.inspect}, requests_ok: #{@requests_ok.inspect}, requests_total:"\
+      " #{@requests_total.inspect}, run_id: #{@run_id.inspect}, started_at:"\
+      " #{@started_at.inspect}, status: #{@status.inspect}, status_reason:"\
+      " #{@status_reason.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/run_request.rb

@@ -0,0 +1,127 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # One run's outcome for one search request.
+  class RunRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :completed_at
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :new_records
+
+    # Why the request failed, empty when it succeeded. Not machine-readable.
+    # @return [String]
+    attr_accessor :reason
+
+    # Why the request failed, empty when it succeeded. Not machine-readable.
+    # @return [String]
+    attr_accessor :request_id
+
+    # Why the request failed, empty when it succeeded. Not machine-readable.
+    # @return [Integer]
+    attr_accessor :results_returned
+
+    # Why the request failed, empty when it succeeded. Not machine-readable.
+    # @return [RequestStatus]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['completed_at'] = 'completed_at'
+      @_hash['new_records'] = 'new_records'
+      @_hash['reason'] = 'reason'
+      @_hash['request_id'] = 'request_id'
+      @_hash['results_returned'] = 'results_returned'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        completed_at
+        new_records
+        reason
+        request_id
+        results_returned
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        completed_at
+      ]
+    end
+
+    def initialize(status: RequestStatus::OK, completed_at: SKIP,
+                   new_records: 0, reason: SKIP, request_id: SKIP,
+                   results_returned: 0, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @completed_at = completed_at unless completed_at == SKIP
+      @new_records = new_records unless new_records == SKIP
+      @reason = reason unless reason == SKIP
+      @request_id = request_id unless request_id == SKIP
+      @results_returned = results_returned unless results_returned == SKIP
+      @status = status
+      @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.
+      status = hash['status'] ||= RequestStatus::OK
+      completed_at = hash.key?('completed_at') ? hash['completed_at'] : SKIP
+      new_records = hash['new_records'] ||= 0
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+      request_id = hash.key?('request_id') ? hash['request_id'] : SKIP
+      results_returned = hash['results_returned'] ||= 0
+
+      # 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.
+      RunRequest.new(status: status,
+                     completed_at: completed_at,
+                     new_records: new_records,
+                     reason: reason,
+                     request_id: request_id,
+                     results_returned: results_returned,
+                     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} completed_at: #{@completed_at}, new_records: #{@new_records}, reason:"\
+      " #{@reason}, request_id: #{@request_id}, results_returned: #{@results_returned}, status:"\
+      " #{@status}, 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} completed_at: #{@completed_at.inspect}, new_records:"\
+      " #{@new_records.inspect}, reason: #{@reason.inspect}, request_id: #{@request_id.inspect},"\
+      " results_returned: #{@results_returned.inspect}, status: #{@status.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/run_state.rb

@@ -0,0 +1,40 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # Whether a monitor has a run open on it right now.
+  class RunState
+    RUN_STATE = [
+      # TODO: Write general description for IDLE
+      IDLE = 'idle'.freeze,
+
+      # TODO: Write general description for RUNNING
+      RUNNING = 'running'.freeze,
+
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'unknown'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RUN_STATE.include?(value)
+    end
+
+    def self.from_value(value, default_value = IDLE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'idle' then IDLE
+      when 'running' then RUNNING
+      when 'unknown' then UNKNOWN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/seltz_api/models/run_state2.rb

@@ -0,0 +1,41 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # Live run state. Returned by this RPC only — the list endpoints do not
+  # include it.
+  class RunState2
+    RUN_STATE2 = [
+      # TODO: Write general description for IDLE
+      IDLE = 'idle'.freeze,
+
+      # TODO: Write general description for RUNNING
+      RUNNING = 'running'.freeze,
+
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'unknown'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RUN_STATE2.include?(value)
+    end
+
+    def self.from_value(value, default_value = IDLE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'idle' then IDLE
+      when 'running' then RUNNING
+      when 'unknown' then UNKNOWN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/seltz_api/models/run_status.rb

@@ -0,0 +1,47 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # A run's outcome. `completed` -- every request succeeded. `partial` -- at
+  # least one request failed after retries and at least one succeeded. `failed`
+  # -- no request succeeded, and no records. `skipped` -- not attempted and not
+  # billed; see `status_reason`. Any of them may produce no records.
+  class RunStatus
+    RUN_STATUS = [
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'completed'.freeze,
+
+      # TODO: Write general description for PARTIAL
+      PARTIAL = 'partial'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'failed'.freeze,
+
+      # TODO: Write general description for SKIPPED
+      SKIPPED = 'skipped'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RUN_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = COMPLETED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'completed' then COMPLETED
+      when 'partial' then PARTIAL
+      when 'failed' then FAILED
+      when 'skipped' then SKIPPED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/seltz_api/models/schedule.rb

@@ -0,0 +1,73 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # Schedule Model.
+  class Schedule < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :cadence
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cadence'] = 'cadence'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(cadence:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @cadence = cadence
+      @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.
+      cadence = hash.key?('cadence') ? hash['cadence'] : nil
+
+      # 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.
+      Schedule.new(cadence: cadence,
+                   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} cadence: #{@cadence}, 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} cadence: #{@cadence.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/search_record.rb

@@ -0,0 +1,101 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # SearchRecord Model.
+  class SearchRecord < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Document]
+    attr_accessor :document
+
+    # Only the requests that matched in the run that emitted this record. A
+    # record
+    # is emitted once, on first sight, so a request that would match it in a
+    # later
+    # run never attaches to it.
+    # @return [Array[SearchRequestRef]]
+    attr_accessor :matched_requests
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['document'] = 'document'
+      @_hash['matched_requests'] = 'matched_requests'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        document
+        matched_requests
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        document
+      ]
+    end
+
+    def initialize(document: SKIP, matched_requests: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @document = document unless document == SKIP
+      @matched_requests = matched_requests unless matched_requests == 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.
+      document = Document.from_hash(hash['document']) if hash['document']
+      # Parameter is an array, so we need to iterate through it
+      matched_requests = nil
+      unless hash['matched_requests'].nil?
+        matched_requests = []
+        hash['matched_requests'].each do |structure|
+          matched_requests << (SearchRequestRef.from_hash(structure) if structure)
+        end
+      end
+
+      matched_requests = SKIP unless hash.key?('matched_requests')
+
+      # 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.
+      SearchRecord.new(document: document,
+                       matched_requests: matched_requests,
+                       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} document: #{@document}, matched_requests: #{@matched_requests},"\
+      " 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} document: #{@document.inspect}, matched_requests:"\
+      " #{@matched_requests.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end