sz-apimatic-sdk 0.0.1

data/lib/seltz_api/models/monitor.rb

@@ -0,0 +1,157 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # Monitor Model.
+  class Monitor < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :cadence
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :created_at
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :monitor_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [Array[MonitorSearchRequest]]
+    attr_accessor :search_requests
+
+    # TODO: Write general description for this method
+    # @return [MonitorStatus]
+    attr_accessor :status
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :updated_at
+
+    # TODO: Write general description for this method
+    # @return [Webhook]
+    attr_accessor :webhook
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cadence'] = 'cadence'
+      @_hash['created_at'] = 'created_at'
+      @_hash['monitor_id'] = 'monitor_id'
+      @_hash['name'] = 'name'
+      @_hash['search_requests'] = 'search_requests'
+      @_hash['status'] = 'status'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['webhook'] = 'webhook'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        created_at
+        monitor_id
+        name
+        search_requests
+        updated_at
+        webhook
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        created_at
+        updated_at
+        webhook
+      ]
+    end
+
+    def initialize(cadence:, status: MonitorStatus::ACTIVE, created_at: SKIP,
+                   monitor_id: SKIP, name: SKIP, search_requests: SKIP,
+                   updated_at: SKIP, webhook: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @cadence = cadence
+      @created_at = created_at unless created_at == SKIP
+      @monitor_id = monitor_id unless monitor_id == SKIP
+      @name = name unless name == SKIP
+      @search_requests = search_requests unless search_requests == SKIP
+      @status = status
+      @updated_at = updated_at unless updated_at == SKIP
+      @webhook = webhook unless webhook == 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.
+      cadence = hash.key?('cadence') ? hash['cadence'] : nil
+      status = hash['status'] ||= MonitorStatus::ACTIVE
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      monitor_id = hash.key?('monitor_id') ? hash['monitor_id'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      search_requests = nil
+      unless hash['search_requests'].nil?
+        search_requests = []
+        hash['search_requests'].each do |structure|
+          search_requests << (MonitorSearchRequest.from_hash(structure) if structure)
+        end
+      end
+
+      search_requests = SKIP unless hash.key?('search_requests')
+      updated_at = hash.key?('updated_at') ? hash['updated_at'] : SKIP
+      webhook = Webhook.from_hash(hash['webhook']) if hash['webhook']
+
+      # 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.
+      Monitor.new(cadence: cadence,
+                  status: status,
+                  created_at: created_at,
+                  monitor_id: monitor_id,
+                  name: name,
+                  search_requests: search_requests,
+                  updated_at: updated_at,
+                  webhook: webhook,
+                  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}, created_at: #{@created_at}, monitor_id:"\
+      " #{@monitor_id}, name: #{@name}, search_requests: #{@search_requests}, status: #{@status},"\
+      " updated_at: #{@updated_at}, webhook: #{@webhook}, 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}, created_at: #{@created_at.inspect},"\
+      " monitor_id: #{@monitor_id.inspect}, name: #{@name.inspect}, search_requests:"\
+      " #{@search_requests.inspect}, status: #{@status.inspect}, updated_at:"\
+      " #{@updated_at.inspect}, webhook: #{@webhook.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/monitor_search_request.rb

@@ -0,0 +1,110 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # A search request stored on a monitor, with its server-assigned id.
+  class MonitorSearchRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Consecutive failed runs for this request.
+    # @return [Integer]
+    attr_accessor :consecutive_failures
+
+    # Consecutive failed runs for this request.
+    # @return [String]
+    attr_accessor :last_success_at
+
+    # Consecutive failed runs for this request.
+    # @return [SearchRequest]
+    attr_accessor :request
+
+    # Consecutive failed runs for this request.
+    # @return [String]
+    attr_accessor :request_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['consecutive_failures'] = 'consecutive_failures'
+      @_hash['last_success_at'] = 'last_success_at'
+      @_hash['request'] = 'request'
+      @_hash['request_id'] = 'request_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        consecutive_failures
+        last_success_at
+        request
+        request_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        last_success_at
+        request
+      ]
+    end
+
+    def initialize(consecutive_failures: 0, last_success_at: SKIP,
+                   request: SKIP, request_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @consecutive_failures = consecutive_failures unless consecutive_failures == SKIP
+      @last_success_at = last_success_at unless last_success_at == SKIP
+      @request = request unless request == SKIP
+      @request_id = request_id unless request_id == 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.
+      consecutive_failures = hash['consecutive_failures'] ||= 0
+      last_success_at =
+        hash.key?('last_success_at') ? hash['last_success_at'] : SKIP
+      request = SearchRequest.from_hash(hash['request']) if hash['request']
+      request_id = hash.key?('request_id') ? hash['request_id'] : 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.
+      MonitorSearchRequest.new(consecutive_failures: consecutive_failures,
+                               last_success_at: last_success_at,
+                               request: request,
+                               request_id: request_id,
+                               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} consecutive_failures: #{@consecutive_failures}, last_success_at:"\
+      " #{@last_success_at}, request: #{@request}, request_id: #{@request_id},"\
+      " 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} consecutive_failures: #{@consecutive_failures.inspect}, last_success_at:"\
+      " #{@last_success_at.inspect}, request: #{@request.inspect}, request_id:"\
+      " #{@request_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/monitor_status.rb

@@ -0,0 +1,47 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # A monitor's lifecycle state. `active` is scheduled and running. `paused`
+  # runs nothing and keeps its records and its record of what it has already
+  # delivered. Only those two can be set through the API; `disabled` and
+  # `deleted` are set by Seltz.
+  class MonitorStatus
+    MONITOR_STATUS = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'active'.freeze,
+
+      # TODO: Write general description for PAUSED
+      PAUSED = 'paused'.freeze,
+
+      # TODO: Write general description for DISABLED
+      DISABLED = 'disabled'.freeze,
+
+      # TODO: Write general description for DELETED
+      DELETED = 'deleted'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MONITOR_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACTIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'active' then ACTIVE
+      when 'paused' then PAUSED
+      when 'disabled' then DISABLED
+      when 'deleted' then DELETED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/seltz_api/models/monitor_status2.rb

@@ -0,0 +1,45 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # Set to `paused` to create the monitor without starting it. Only `active` and
+  # `paused` are accepted. Defaults to `active`.
+  class MonitorStatus2
+    MONITOR_STATUS2 = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'active'.freeze,
+
+      # TODO: Write general description for PAUSED
+      PAUSED = 'paused'.freeze,
+
+      # TODO: Write general description for DISABLED
+      DISABLED = 'disabled'.freeze,
+
+      # TODO: Write general description for DELETED
+      DELETED = 'deleted'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MONITOR_STATUS2.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACTIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'active' then ACTIVE
+      when 'paused' then PAUSED
+      when 'disabled' then DISABLED
+      when 'deleted' then DELETED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/seltz_api/models/payload.rb

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

data/lib/seltz_api/models/record.rb

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

data/lib/seltz_api/models/record_type.rb

@@ -0,0 +1,26 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # What a record carries.
+  class RecordType
+    RECORD_TYPE = [
+      # TODO: Write general description for SEARCH_RESULT
+      SEARCH_RESULT = 'search_result'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RECORD_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = SEARCH_RESULT)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/seltz_api/models/request_status.rb

@@ -0,0 +1,36 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # Whether one search request succeeded in a run.
+  class RequestStatus
+    REQUEST_STATUS = [
+      # TODO: Write general description for OK
+      OK = 'ok'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'failed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REQUEST_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = OK)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'ok' then OK
+      when 'failed' then FAILED
+      else
+        default_value
+      end
+    end
+  end
+end