abliteration 0.0.1 → 0.1.0

data/lib/abliteration/models/dataset_detail.rb

@@ -0,0 +1,169 @@
+=begin
+#abliteration.org Public API
+
+#Read access to the abliteration.org catalog: models and their method classification, alignment datasets and their passports, the M-code taxonomy, the four flagship indices and the curated field timeline.  Every call is authenticated with a bearer key and metered in credits against the same wallet the Research Agent spends from. There is no free tier for machine traffic and no separate billing.  Responses report `cost` and `credits_remaining` on every success. While `metering` reads `preview`, the cost shown is what the call will bill once metering is enabled and nothing is actually deducted; when it reads `billed`, it was.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Abliteration
+  # The full dataset record, plus files and the passport when one exists.
+  class DatasetDetail < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :files
+
+    attr_accessor :passport
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'files' => :'files',
+        :'passport' => :'passport'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'files' => :'Array<Object>',
+        :'passport' => :'Passport'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'passport'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Abliteration::DatasetDetail` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Abliteration::DatasetDetail`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'files')
+        if (value = attributes[:'files']).is_a?(Array)
+          self.files = value
+        end
+      end
+
+      if attributes.key?(:'passport')
+        self.passport = attributes[:'passport']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          files == o.files &&
+          passport == o.passport
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, files, passport].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/abliteration/models/envelope.rb

@@ -0,0 +1,364 @@
+=begin
+#abliteration.org Public API
+
+#Read access to the abliteration.org catalog: models and their method classification, alignment datasets and their passports, the M-code taxonomy, the four flagship indices and the curated field timeline.  Every call is authenticated with a bearer key and metered in credits against the same wallet the Research Agent spends from. There is no free tier for machine traffic and no separate billing.  Responses report `cost` and `credits_remaining` on every success. While `metering` reads `preview`, the cost shown is what the call will bill once metering is enabled and nothing is actually deducted; when it reads `billed`, it was.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Abliteration
+  class Envelope < ApiModelBase
+    # The payload. An array on list routes, an object on single-entity routes.
+    attr_accessor :data
+
+    # Credits this call costs.
+    attr_accessor :cost
+
+    # Wallet balance after the call. Unchanged while metering is preview.
+    attr_accessor :credits_remaining
+
+    # Ceiling for the current window. Also returned as X-RateLimit-Limit.
+    attr_accessor :rate_limit_limit
+
+    # Calls left in the current window for this key. Also returned as X-RateLimit-Remaining.
+    attr_accessor :rate_limit_remaining
+
+    # Unix seconds at which the window resets to full ceiling. Also returned as X-RateLimit-Reset.
+    attr_accessor :rate_limit_reset
+
+    # Whether cost was actually deducted.
+    attr_accessor :metering
+
+    # Also returned in the x-request-id header.
+    attr_accessor :request_id
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data',
+        :'cost' => :'cost',
+        :'credits_remaining' => :'credits_remaining',
+        :'rate_limit_limit' => :'rate_limit_limit',
+        :'rate_limit_remaining' => :'rate_limit_remaining',
+        :'rate_limit_reset' => :'rate_limit_reset',
+        :'metering' => :'metering',
+        :'request_id' => :'request_id'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'data' => :'Object',
+        :'cost' => :'Integer',
+        :'credits_remaining' => :'Integer',
+        :'rate_limit_limit' => :'Integer',
+        :'rate_limit_remaining' => :'Integer',
+        :'rate_limit_reset' => :'Integer',
+        :'metering' => :'String',
+        :'request_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'data',
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Abliteration::Envelope` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Abliteration::Envelope`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'data')
+        self.data = attributes[:'data']
+      else
+        self.data = nil
+      end
+
+      if attributes.key?(:'cost')
+        self.cost = attributes[:'cost']
+      else
+        self.cost = nil
+      end
+
+      if attributes.key?(:'credits_remaining')
+        self.credits_remaining = attributes[:'credits_remaining']
+      else
+        self.credits_remaining = nil
+      end
+
+      if attributes.key?(:'rate_limit_limit')
+        self.rate_limit_limit = attributes[:'rate_limit_limit']
+      else
+        self.rate_limit_limit = nil
+      end
+
+      if attributes.key?(:'rate_limit_remaining')
+        self.rate_limit_remaining = attributes[:'rate_limit_remaining']
+      else
+        self.rate_limit_remaining = nil
+      end
+
+      if attributes.key?(:'rate_limit_reset')
+        self.rate_limit_reset = attributes[:'rate_limit_reset']
+      else
+        self.rate_limit_reset = nil
+      end
+
+      if attributes.key?(:'metering')
+        self.metering = attributes[:'metering']
+      else
+        self.metering = nil
+      end
+
+      if attributes.key?(:'request_id')
+        self.request_id = attributes[:'request_id']
+      else
+        self.request_id = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @cost.nil?
+        invalid_properties.push('invalid value for "cost", cost cannot be nil.')
+      end
+
+      if @credits_remaining.nil?
+        invalid_properties.push('invalid value for "credits_remaining", credits_remaining cannot be nil.')
+      end
+
+      if @rate_limit_limit.nil?
+        invalid_properties.push('invalid value for "rate_limit_limit", rate_limit_limit cannot be nil.')
+      end
+
+      if @rate_limit_remaining.nil?
+        invalid_properties.push('invalid value for "rate_limit_remaining", rate_limit_remaining cannot be nil.')
+      end
+
+      if @rate_limit_reset.nil?
+        invalid_properties.push('invalid value for "rate_limit_reset", rate_limit_reset cannot be nil.')
+      end
+
+      if @metering.nil?
+        invalid_properties.push('invalid value for "metering", metering cannot be nil.')
+      end
+
+      if @request_id.nil?
+        invalid_properties.push('invalid value for "request_id", request_id cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @cost.nil?
+      return false if @credits_remaining.nil?
+      return false if @rate_limit_limit.nil?
+      return false if @rate_limit_remaining.nil?
+      return false if @rate_limit_reset.nil?
+      return false if @metering.nil?
+      metering_validator = EnumAttributeValidator.new('String', ["preview", "billed"])
+      return false unless metering_validator.valid?(@metering)
+      return false if @request_id.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] cost Value to be assigned
+    def cost=(cost)
+      if cost.nil?
+        fail ArgumentError, 'cost cannot be nil'
+      end
+
+      @cost = cost
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] credits_remaining Value to be assigned
+    def credits_remaining=(credits_remaining)
+      if credits_remaining.nil?
+        fail ArgumentError, 'credits_remaining cannot be nil'
+      end
+
+      @credits_remaining = credits_remaining
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] rate_limit_limit Value to be assigned
+    def rate_limit_limit=(rate_limit_limit)
+      if rate_limit_limit.nil?
+        fail ArgumentError, 'rate_limit_limit cannot be nil'
+      end
+
+      @rate_limit_limit = rate_limit_limit
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] rate_limit_remaining Value to be assigned
+    def rate_limit_remaining=(rate_limit_remaining)
+      if rate_limit_remaining.nil?
+        fail ArgumentError, 'rate_limit_remaining cannot be nil'
+      end
+
+      @rate_limit_remaining = rate_limit_remaining
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] rate_limit_reset Value to be assigned
+    def rate_limit_reset=(rate_limit_reset)
+      if rate_limit_reset.nil?
+        fail ArgumentError, 'rate_limit_reset cannot be nil'
+      end
+
+      @rate_limit_reset = rate_limit_reset
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] metering Object to be assigned
+    def metering=(metering)
+      validator = EnumAttributeValidator.new('String', ["preview", "billed"])
+      unless validator.valid?(metering)
+        fail ArgumentError, "invalid value for \"metering\", must be one of #{validator.allowable_values}."
+      end
+      @metering = metering
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] request_id Value to be assigned
+    def request_id=(request_id)
+      if request_id.nil?
+        fail ArgumentError, 'request_id cannot be nil'
+      end
+
+      @request_id = request_id
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          data == o.data &&
+          cost == o.cost &&
+          credits_remaining == o.credits_remaining &&
+          rate_limit_limit == o.rate_limit_limit &&
+          rate_limit_remaining == o.rate_limit_remaining &&
+          rate_limit_reset == o.rate_limit_reset &&
+          metering == o.metering &&
+          request_id == o.request_id
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [data, cost, credits_remaining, rate_limit_limit, rate_limit_remaining, rate_limit_reset, metering, request_id].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end