sz-apimatic-sdk 0.0.1

data/lib/seltz_api/models/fetch_result.rb

@@ -0,0 +1,176 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # The outcome for one URL.
+  class FetchResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The origin's declared media type for the main document, without
+    # parameters.
+    # Frequently unset, including on results that carry content. Never branch on
+    # it: `status` says whether a result carries content.
+    # @return [String]
+    attr_accessor :content_type
+
+    # The origin's declared media type for the main document, without
+    # parameters.
+    # Frequently unset, including on results that carry content. Never branch on
+    # it: `status` says whether a result carries content.
+    # @return [FetchError1]
+    attr_accessor :error
+
+    # The origin's declared media type for the main document, without
+    # parameters.
+    # Frequently unset, including on results that carry content. Never branch on
+    # it: `status` says whether a result carries content.
+    # @return [String]
+    attr_accessor :fetched_at
+
+    # The URL the content actually came from, after HTTP redirects and any
+    # client-side navigation. Equal to `requested_url` when nothing redirected.
+    # Set on a result whose `status` is ERROR only when the failure happened
+    # after the origin answered, such as a page this service could not extract.
+    # Unset when the URL was never reached.
+    # @return [String]
+    attr_accessor :final_url
+
+    # The origin's HTTP status code for the main document. Unset when no network
+    # response was observed for the navigation.
+    # An HTTP error status is not a fetch failure: this service renders the
+    # origin's error page, so a 404 arrives as an OK result carrying 404. On a
+    # result whose `status` is ERROR, this follows `final_url` - set only when
+    # the failure happened after the origin answered.
+    # @return [Integer]
+    attr_accessor :http_status_code
+
+    # The page's main content as Markdown, with boilerplate removed.
+    # @return [String]
+    attr_accessor :markdown
+
+    # The URL this answers, echoed verbatim from the request -- byte for byte,
+    # never normalized, and never the post-redirect URL. This is the correlation
+    # key. Where redirects landed is `final_url`.
+    # @return [String]
+    attr_accessor :requested_url
+
+    # The URL this answers, echoed verbatim from the request -- byte for byte,
+    # never normalized, and never the post-redirect URL. This is the correlation
+    # key. Where redirects landed is `final_url`.
+    # @return [FetchStatus2]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['content_type'] = 'content_type'
+      @_hash['error'] = 'error'
+      @_hash['fetched_at'] = 'fetched_at'
+      @_hash['final_url'] = 'final_url'
+      @_hash['http_status_code'] = 'http_status_code'
+      @_hash['markdown'] = 'markdown'
+      @_hash['requested_url'] = 'requested_url'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        content_type
+        error
+        fetched_at
+        final_url
+        http_status_code
+        markdown
+        requested_url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        content_type
+        error
+        fetched_at
+        final_url
+        http_status_code
+        markdown
+      ]
+    end
+
+    def initialize(status: FetchStatus2::OK, content_type: SKIP, error: SKIP,
+                   fetched_at: SKIP, final_url: SKIP, http_status_code: SKIP,
+                   markdown: SKIP, requested_url: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @content_type = content_type unless content_type == SKIP
+      @error = error unless error == SKIP
+      @fetched_at = fetched_at unless fetched_at == SKIP
+      @final_url = final_url unless final_url == SKIP
+      @http_status_code = http_status_code unless http_status_code == SKIP
+      @markdown = markdown unless markdown == SKIP
+      @requested_url = requested_url unless requested_url == 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'] ||= FetchStatus2::OK
+      content_type = hash.key?('content_type') ? hash['content_type'] : SKIP
+      error = FetchError1.from_hash(hash['error']) if hash['error']
+      fetched_at = hash.key?('fetched_at') ? hash['fetched_at'] : SKIP
+      final_url = hash.key?('final_url') ? hash['final_url'] : SKIP
+      http_status_code =
+        hash.key?('http_status_code') ? hash['http_status_code'] : SKIP
+      markdown = hash.key?('markdown') ? hash['markdown'] : SKIP
+      requested_url = hash.key?('requested_url') ? hash['requested_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.
+      FetchResult.new(status: status,
+                      content_type: content_type,
+                      error: error,
+                      fetched_at: fetched_at,
+                      final_url: final_url,
+                      http_status_code: http_status_code,
+                      markdown: markdown,
+                      requested_url: requested_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} content_type: #{@content_type}, error: #{@error}, fetched_at:"\
+      " #{@fetched_at}, final_url: #{@final_url}, http_status_code: #{@http_status_code},"\
+      " markdown: #{@markdown}, requested_url: #{@requested_url}, 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} content_type: #{@content_type.inspect}, error: #{@error.inspect},"\
+      " fetched_at: #{@fetched_at.inspect}, final_url: #{@final_url.inspect}, http_status_code:"\
+      " #{@http_status_code.inspect}, markdown: #{@markdown.inspect}, requested_url:"\
+      " #{@requested_url.inspect}, status: #{@status.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/fetch_status.rb

@@ -0,0 +1,36 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # Whether a `FetchResult` carries content.
+  class FetchStatus
+    FETCH_STATUS = [
+      # TODO: Write general description for OK
+      OK = 'ok'.freeze,
+
+      # TODO: Write general description for ERROR
+      ERROR = 'error'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FETCH_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 'error' then ERROR
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/seltz_api/models/fetch_status2.rb

@@ -0,0 +1,40 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # Whether this result carries content. Branch on this field, never on whether
+  # a given content field is present: a format the page could not produce is
+  # unset on an otherwise successful result, so "markdown is absent" does not
+  # mean "the fetch failed". A failed fetch is still HTTP 200, with the error
+  # status on the result.
+  class FetchStatus2
+    FETCH_STATUS2 = [
+      # TODO: Write general description for OK
+      OK = 'ok'.freeze,
+
+      # TODO: Write general description for ERROR
+      ERROR = 'error'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FETCH_STATUS2.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 'error' then ERROR
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/seltz_api/models/fields.rb

@@ -0,0 +1,108 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # The selectable members of a response `Document`, and how much of each to
+  # return. `Document.url` and `Document.published_date` are always selected.
+  # Each member takes `true`, `false`, or an object of ceilings. An object
+  # selects the member and bounds it, so `{"content":
+  # {"max_characters_per_result": 500}}` returns content and no snippets.
+  # `{"content": true}` selects content under the default ceiling, which is what
+  # `{"content": {}}` returns as well. `false` switches the member off. A
+  # `fields` that names neither member returns the defaults below, so `{}` and a
+  # wholly absent `fields` mean the same thing. A `fields` that names either is
+  # read literally, so `{"snippets": true}` returns passages and no content.
+  class Fields < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Emit `Document.content`. Unset is true.
+    # @return [Object]
+    attr_accessor :content
+
+    # Emit `Document.snippets`. Unset is false.
+    # @return [Object]
+    attr_accessor :snippets
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['content'] = 'content'
+      @_hash['snippets'] = 'snippets'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        content
+        snippets
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(content: SKIP, snippets: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @content = content unless content == SKIP
+      @snippets = snippets unless snippets == 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.
+      content = hash.key?('content') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:FieldsContent), hash['content']
+      ) : SKIP
+      snippets = hash.key?('snippets') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:FieldsSnippets), hash['snippets']
+      ) : 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.
+      Fields.new(content: content,
+                 snippets: snippets,
+                 additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Fields | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} content: #{@content}, snippets: #{@snippets}, 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} content: #{@content.inspect}, snippets: #{@snippets.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/fields2.rb

@@ -0,0 +1,101 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # Which selectable members of `Document` to populate. If absent, defaults to
+  # `{content: true}`, which returns content under the default ceiling stated on
+  # `ContentOptions`.
+  class Fields2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Emit `Document.content`. Unset is true.
+    # @return [Object]
+    attr_accessor :content
+
+    # Emit `Document.snippets`. Unset is false.
+    # @return [Object]
+    attr_accessor :snippets
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['content'] = 'content'
+      @_hash['snippets'] = 'snippets'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        content
+        snippets
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(content: SKIP, snippets: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @content = content unless content == SKIP
+      @snippets = snippets unless snippets == 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.
+      content = hash.key?('content') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:Fields2Content), hash['content']
+      ) : SKIP
+      snippets = hash.key?('snippets') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:Fields2Snippets), hash['snippets']
+      ) : 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.
+      Fields2.new(content: content,
+                  snippets: snippets,
+                  additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Fields2 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} content: #{@content}, snippets: #{@snippets}, 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} content: #{@content.inspect}, snippets: #{@snippets.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/get_monitor_response.rb

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

data/lib/seltz_api/models/get_run_response.rb

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