sz-apimatic-sdk 0.0.1

data/lib/seltz_api/models/envelope_error.rb

@@ -0,0 +1,83 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # The error context. `code` is a stable descriptor in all-caps from a closed
+  # set per endpoint. `message` is a human-readable summary of what went wrong.
+  class EnvelopeError < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The error code.
+    # @return [String]
+    attr_accessor :code
+
+    # The error message.
+    # @return [String]
+    attr_accessor :message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['message'] = 'message'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code:, message:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @code = code
+      @message = message
+      @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.
+      code = hash.key?('code') ? hash['code'] : nil
+      message = hash.key?('message') ? hash['message'] : 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.
+      EnvelopeError.new(code: code,
+                        message: message,
+                        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} code: #{@code}, message: #{@message}, 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} code: #{@code.inspect}, message: #{@message.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/envelope_error1.rb

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

data/lib/seltz_api/models/fetch_error.rb

@@ -0,0 +1,107 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # Why one URL failed.
+  class FetchError < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A stable, machine-readable reason. A client must treat an unrecognized
+    # code as a generic failure rather than rejecting the result.
+    # Documented codes:
+    # "invalid_url"              -- not a parseable absolute URL.
+    # "unsupported_scheme"       -- parseable, but not `http` or `https`.
+    # "url_not_accessible"       -- DNS, connection, TLS, or navigation
+    # failure reaching the origin, or a host
+    # this service does not fetch.
+    # "timeout"                  -- the fetch did not finish within
+    # `timeout_ms`.
+    # "unsupported_content_type" -- the document is not an HTML page. PDFs,
+    # images, archives, and other binaries are
+    # out of scope. Refused from the URL before
+    # the fetch, or from the media type the
+    # origin declared after it.
+    # "extraction_failed"        -- the page was fetched, but no requested
+    # format could be produced from it.
+    # "upstream_error"           -- the fetch path itself failed. Ours, not
+    # the URL's.
+    # @return [String]
+    attr_accessor :code
+
+    # A human-readable explanation. Always set when this message is present:
+    # `FetchError` itself is optional on the result, so an absent error is
+    # absent whole, and there is no state where a failure arrives without a
+    # reason. For operators and logs. Never parse it -- branch on `code`. The
+    # wording of any given message may change at any time.
+    # @return [String]
+    attr_accessor :message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['message'] = 'message'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        message
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code: SKIP, message: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @code = code unless code == SKIP
+      @message = message unless message == 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.
+      code = hash.key?('code') ? hash['code'] : SKIP
+      message = hash.key?('message') ? hash['message'] : 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.
+      FetchError.new(code: code,
+                     message: message,
+                     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} code: #{@code}, message: #{@message}, 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} code: #{@code.inspect}, message: #{@message.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/fetch_error1.rb

@@ -0,0 +1,108 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # Why the fetch failed. Set when `status` is the error status, unset
+  # otherwise.
+  class FetchError1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A stable, machine-readable reason. A client must treat an unrecognized
+    # code as a generic failure rather than rejecting the result.
+    # Documented codes:
+    # "invalid_url"              -- not a parseable absolute URL.
+    # "unsupported_scheme"       -- parseable, but not `http` or `https`.
+    # "url_not_accessible"       -- DNS, connection, TLS, or navigation
+    # failure reaching the origin, or a host
+    # this service does not fetch.
+    # "timeout"                  -- the fetch did not finish within
+    # `timeout_ms`.
+    # "unsupported_content_type" -- the document is not an HTML page. PDFs,
+    # images, archives, and other binaries are
+    # out of scope. Refused from the URL before
+    # the fetch, or from the media type the
+    # origin declared after it.
+    # "extraction_failed"        -- the page was fetched, but no requested
+    # format could be produced from it.
+    # "upstream_error"           -- the fetch path itself failed. Ours, not
+    # the URL's.
+    # @return [String]
+    attr_accessor :code
+
+    # A human-readable explanation. Always set when this message is present:
+    # `FetchError` itself is optional on the result, so an absent error is
+    # absent whole, and there is no state where a failure arrives without a
+    # reason. For operators and logs. Never parse it -- branch on `code`. The
+    # wording of any given message may change at any time.
+    # @return [String]
+    attr_accessor :message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['message'] = 'message'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        message
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code: SKIP, message: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @code = code unless code == SKIP
+      @message = message unless message == 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.
+      code = hash.key?('code') ? hash['code'] : SKIP
+      message = hash.key?('message') ? hash['message'] : 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.
+      FetchError1.new(code: code,
+                      message: message,
+                      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} code: #{@code}, message: #{@message}, 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} code: #{@code.inspect}, message: #{@message.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/fetch_request.rb

@@ -0,0 +1,144 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # FetchRequest Model.
+  class FetchRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # API key to access the service. Either this or the `x-api-key` header must
+    # be supplied on the HTTP surface; the header takes precedence and is the
+    # documented path. On gRPC this field is the only carrier.
+    # Each URL that comes back with the OK status is billed. A URL that comes
+    # back with an error is not. The call is refused up front unless the balance
+    # covers the whole batch.
+    # @return [String]
+    attr_accessor :api_key
+
+    # Representations to return, as documented format names.
+    # Omitted, or sent empty, means `\["markdown"\]` -- a repeated field carries
+    # no presence, so the two are the same request and neither means "no
+    # formats".
+    # Documented names:
+    # "markdown" -- the main content as Markdown, boilerplate removed.
+    # An unrecognized name is rejected.
+    # @return [Array[String]]
+    attr_accessor :formats
+
+    # The service tier, which selects the price. Send `"pro"`. Unset resolves to
+    # `"pro"`.
+    # An unrecognized value is rejected rather than defaulted, because the value
+    # selects a price. The name is matched exactly.
+    # @return [String]
+    attr_accessor :tier
+
+    # Wall-clock budget for one URL, in milliseconds.
+    # Applies to each URL, not to the batch. A URL that exceeds the budget gets
+    # `error.code = "timeout"`; the others in the same request are unaffected.
+    # Unset means 75000, which is also the maximum; a larger value is served as
+    # 75000, and a value below 1000 is served as 1000.
+    # @return [Integer]
+    attr_accessor :timeout_ms
+
+    # The URLs to fetch. At least one, at most 20.
+    # An empty list, more than 20 entries, a duplicate entry, a blank or padded
+    # entry, or an entry over 2048 bytes is rejected before any billing --
+    # duplicates because `FetchResult.requested_url` is the correlation key and
+    # a repeated key is ambiguous.
+    # Everything else is reported inside a `200` as that URL's error result: a
+    # value that is not an absolute `http` or `https` URL, a host that does not
+    # resolve or that this service will not fetch, an origin that refuses, and a
+    # document that is not an HTML page.
+    # @return [Array[String]]
+    attr_accessor :urls
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['api_key'] = 'api_key'
+      @_hash['formats'] = 'formats'
+      @_hash['tier'] = 'tier'
+      @_hash['timeout_ms'] = 'timeout_ms'
+      @_hash['urls'] = 'urls'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        api_key
+        formats
+        tier
+        timeout_ms
+        urls
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        api_key
+        tier
+        timeout_ms
+      ]
+    end
+
+    def initialize(api_key: SKIP, formats:, tier: SKIP, timeout_ms: SKIP, urls:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @api_key = api_key unless api_key == SKIP
+      @formats = formats unless formats == SKIP
+      @tier = tier unless tier == SKIP
+      @timeout_ms = timeout_ms unless timeout_ms == SKIP
+      @urls = urls unless urls == 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.
+      api_key = hash.key?('api_key') ? hash['api_key'] : SKIP
+      formats = hash['formats'] ||= 
+      tier = hash.key?('tier') ? hash['tier'] : SKIP
+      timeout_ms = hash.key?('timeout_ms') ? hash['timeout_ms'] : SKIP
+      urls = hash['urls'] ||= 
+
+      # 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.
+      FetchRequest.new(api_key: api_key,
+                       formats: formats,
+                       tier: tier,
+                       timeout_ms: timeout_ms,
+                       urls: urls,
+                       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} api_key: #{@api_key}, formats: #{@formats}, tier: #{@tier}, timeout_ms:"\
+      " #{@timeout_ms}, urls: #{@urls}, 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} api_key: #{@api_key.inspect}, formats: #{@formats.inspect}, tier:"\
+      " #{@tier.inspect}, timeout_ms: #{@timeout_ms.inspect}, urls: #{@urls.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/fetch_response.rb

@@ -0,0 +1,87 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # One result per requested URL.
+  class FetchResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # One entry per entry in `FetchRequest.urls`, successful or not, in the
+    # order
+    # the URLs were requested.
+    # Correlate on `FetchResult.requested_url` rather than on position.
+    # @return [Array[FetchResult]]
+    attr_accessor :results
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['results'] = 'results'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        results
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(results: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @results = results unless results == 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.
+      # Parameter is an array, so we need to iterate through it
+      results = nil
+      unless hash['results'].nil?
+        results = []
+        hash['results'].each do |structure|
+          results << (FetchResult.from_hash(structure) if structure)
+        end
+      end
+
+      results = SKIP unless hash.key?('results')
+
+      # 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.
+      FetchResponse.new(results: results,
+                        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} results: #{@results}, 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} results: #{@results.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end