spartera_api_sdk 1.0.74 → 1.0.78

data/lib/spartera_api_sdk/models/endpoints.rb

@@ -0,0 +1,684 @@
+=begin
+#Spartera API Documentation
+
+#Auto-generated API documentation for REST services of the Spartera platform
+
+The version of the OpenAPI document: 1.25.0
+Contact: support@spartera.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'date'
+require 'time'
+
+module SparteraApiSdk
+  # A configured API endpoint exposing seller data with access controls and rate limiting
+  class Endpoints < ApiModelBase
+    # Required.
+    attr_accessor :date_created
+
+    # Required.
+    attr_accessor :last_updated
+
+    # Unique identifier.
+    attr_accessor :endpoint_id
+
+    # User who created this endpoint
+    attr_accessor :user_id
+
+    # References companies.company_id — A Spartera seller or buyer company account. See GET /companies for valid values. Required.
+    attr_accessor :company_id
+
+    # Connection to the data source
+    attr_accessor :connection_id
+
+    # Industry / category for marketplace discovery
+    attr_accessor :industry_id
+
+    # Primary use case for marketplace discovery
+    attr_accessor :auc_id
+
+    # Approval status before marketplace publication
+    attr_accessor :approval_status
+
+    # User who approved this endpoint for marketplace
+    attr_accessor :approved_by_user_id
+
+    # Timestamp of marketplace approval
+    attr_accessor :approved_at
+
+    # Whether this endpoint appears in the public marketplace
+    attr_accessor :sell_in_marketplace
+
+    # Credits deducted from the buyer's pool per successful (200 OK) request. Same credit pool as assets. price_usd kept for billing records / dashboards.
+    attr_accessor :price_credits
+
+    # Human-readable name for the endpoint
+    attr_accessor :name
+
+    # Human-readable, URL-safe slug derived from name at creation time. e.g. 'NFL Live Moneyline & Spread Odds' → 'nfl-live-moneyline-spread-odds'. Never changes after creation. Unique within company (DB constraint). Creation fails with 409 if a duplicate name exists in the same company.
+    attr_accessor :slug
+
+    # Description of what this endpoint provides
+    attr_accessor :description
+
+    # Schema/database name where the table resides
+    attr_accessor :source_schema_name
+
+    # Table name to query from
+    attr_accessor :source_table_name
+
+    # Named customer for B2B deals (marketplace uses price_credits instead)
+    attr_accessor :customer_name
+
+    # USD reference price for billing records and seller dashboards
+    attr_accessor :price_usd
+
+    # Column configurations including aggregations, filters, and visibility. Format: {columns: [{name, type, aggregation, filter, is_hidden, alias, ...}]}. This is the source of truth — SQL is generated at runtime from this configuration.
+    attr_accessor :endpoint_schema
+
+    # Number of requests allowed per rate_limit_period
+    attr_accessor :rate_limit_requests
+
+    # Time period for rate limiting (HOUR, DAY, MONTH)
+    attr_accessor :rate_limit_period
+
+    # How to group rate limits (IP, USER, COMPANY, API_KEY, GLOBAL)
+    attr_accessor :rate_limit_granularity
+
+    # Access control method (OPEN, API_KEY, IP, EMAIL, DOMAIN)
+    attr_accessor :access_method
+
+    # List of allowed IPs, emails, or domains based on access_method. Format: {type: 'ip'|'email'|'domain', values: ['192.168.1.1', ...]}
+    attr_accessor :access_whitelist
+
+    # Current status of the endpoint (ACTIVE, INACTIVE, DEPRECATED)
+    attr_accessor :status
+
+    # Comma-separated tags for organizing endpoints
+    attr_accessor :tags
+
+    # When this endpoint was last called
+    attr_accessor :last_accessed
+
+    # Seller-enforced row cap per request. Buyers cannot exceed this. Default 1000.
+    attr_accessor :max_records_per_request
+
+    # Last successful {spartera, request, response} envelope. Saved on each successful marketplace run. Displayed as preview on product page load.
+    attr_accessor :sample_response
+
+    # Required.
+    attr_accessor :active
+
+    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
+      {
+        :'date_created' => :'date_created',
+        :'last_updated' => :'last_updated',
+        :'endpoint_id' => :'endpoint_id',
+        :'user_id' => :'user_id',
+        :'company_id' => :'company_id',
+        :'connection_id' => :'connection_id',
+        :'industry_id' => :'industry_id',
+        :'auc_id' => :'auc_id',
+        :'approval_status' => :'approval_status',
+        :'approved_by_user_id' => :'approved_by_user_id',
+        :'approved_at' => :'approved_at',
+        :'sell_in_marketplace' => :'sell_in_marketplace',
+        :'price_credits' => :'price_credits',
+        :'name' => :'name',
+        :'slug' => :'slug',
+        :'description' => :'description',
+        :'source_schema_name' => :'source_schema_name',
+        :'source_table_name' => :'source_table_name',
+        :'customer_name' => :'customer_name',
+        :'price_usd' => :'price_usd',
+        :'endpoint_schema' => :'endpoint_schema',
+        :'rate_limit_requests' => :'rate_limit_requests',
+        :'rate_limit_period' => :'rate_limit_period',
+        :'rate_limit_granularity' => :'rate_limit_granularity',
+        :'access_method' => :'access_method',
+        :'access_whitelist' => :'access_whitelist',
+        :'status' => :'status',
+        :'tags' => :'tags',
+        :'last_accessed' => :'last_accessed',
+        :'max_records_per_request' => :'max_records_per_request',
+        :'sample_response' => :'sample_response',
+        :'active' => :'active'
+      }
+    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
+      {
+        :'date_created' => :'Time',
+        :'last_updated' => :'Time',
+        :'endpoint_id' => :'String',
+        :'user_id' => :'String',
+        :'company_id' => :'String',
+        :'connection_id' => :'String',
+        :'industry_id' => :'Integer',
+        :'auc_id' => :'Integer',
+        :'approval_status' => :'String',
+        :'approved_by_user_id' => :'String',
+        :'approved_at' => :'Time',
+        :'sell_in_marketplace' => :'Boolean',
+        :'price_credits' => :'Integer',
+        :'name' => :'String',
+        :'slug' => :'String',
+        :'description' => :'String',
+        :'source_schema_name' => :'String',
+        :'source_table_name' => :'String',
+        :'customer_name' => :'String',
+        :'price_usd' => :'Float',
+        :'endpoint_schema' => :'Object',
+        :'rate_limit_requests' => :'Integer',
+        :'rate_limit_period' => :'String',
+        :'rate_limit_granularity' => :'String',
+        :'access_method' => :'String',
+        :'access_whitelist' => :'Object',
+        :'status' => :'String',
+        :'tags' => :'String',
+        :'last_accessed' => :'Time',
+        :'max_records_per_request' => :'Integer',
+        :'sample_response' => :'Object',
+        :'active' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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 `SparteraApiSdk::Endpoints` 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 `SparteraApiSdk::Endpoints`. 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?(:'date_created')
+        self.date_created = attributes[:'date_created']
+      else
+        self.date_created = nil
+      end
+
+      if attributes.key?(:'last_updated')
+        self.last_updated = attributes[:'last_updated']
+      else
+        self.last_updated = nil
+      end
+
+      if attributes.key?(:'endpoint_id')
+        self.endpoint_id = attributes[:'endpoint_id']
+      end
+
+      if attributes.key?(:'user_id')
+        self.user_id = attributes[:'user_id']
+      end
+
+      if attributes.key?(:'company_id')
+        self.company_id = attributes[:'company_id']
+      else
+        self.company_id = nil
+      end
+
+      if attributes.key?(:'connection_id')
+        self.connection_id = attributes[:'connection_id']
+      else
+        self.connection_id = nil
+      end
+
+      if attributes.key?(:'industry_id')
+        self.industry_id = attributes[:'industry_id']
+      end
+
+      if attributes.key?(:'auc_id')
+        self.auc_id = attributes[:'auc_id']
+      end
+
+      if attributes.key?(:'approval_status')
+        self.approval_status = attributes[:'approval_status']
+      end
+
+      if attributes.key?(:'approved_by_user_id')
+        self.approved_by_user_id = attributes[:'approved_by_user_id']
+      end
+
+      if attributes.key?(:'approved_at')
+        self.approved_at = attributes[:'approved_at']
+      end
+
+      if attributes.key?(:'sell_in_marketplace')
+        self.sell_in_marketplace = attributes[:'sell_in_marketplace']
+      else
+        self.sell_in_marketplace = nil
+      end
+
+      if attributes.key?(:'price_credits')
+        self.price_credits = attributes[:'price_credits']
+      else
+        self.price_credits = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'slug')
+        self.slug = attributes[:'slug']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'source_schema_name')
+        self.source_schema_name = attributes[:'source_schema_name']
+      end
+
+      if attributes.key?(:'source_table_name')
+        self.source_table_name = attributes[:'source_table_name']
+      end
+
+      if attributes.key?(:'customer_name')
+        self.customer_name = attributes[:'customer_name']
+      end
+
+      if attributes.key?(:'price_usd')
+        self.price_usd = attributes[:'price_usd']
+      end
+
+      if attributes.key?(:'endpoint_schema')
+        self.endpoint_schema = attributes[:'endpoint_schema']
+      end
+
+      if attributes.key?(:'rate_limit_requests')
+        self.rate_limit_requests = attributes[:'rate_limit_requests']
+      end
+
+      if attributes.key?(:'rate_limit_period')
+        self.rate_limit_period = attributes[:'rate_limit_period']
+      end
+
+      if attributes.key?(:'rate_limit_granularity')
+        self.rate_limit_granularity = attributes[:'rate_limit_granularity']
+      end
+
+      if attributes.key?(:'access_method')
+        self.access_method = attributes[:'access_method']
+      end
+
+      if attributes.key?(:'access_whitelist')
+        self.access_whitelist = attributes[:'access_whitelist']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'tags')
+        self.tags = attributes[:'tags']
+      end
+
+      if attributes.key?(:'last_accessed')
+        self.last_accessed = attributes[:'last_accessed']
+      end
+
+      if attributes.key?(:'max_records_per_request')
+        self.max_records_per_request = attributes[:'max_records_per_request']
+      end
+
+      if attributes.key?(:'sample_response')
+        self.sample_response = attributes[:'sample_response']
+      end
+
+      if attributes.key?(:'active')
+        self.active = attributes[:'active']
+      else
+        self.active = 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 @date_created.nil?
+        invalid_properties.push('invalid value for "date_created", date_created cannot be nil.')
+      end
+
+      if @last_updated.nil?
+        invalid_properties.push('invalid value for "last_updated", last_updated cannot be nil.')
+      end
+
+      if @company_id.nil?
+        invalid_properties.push('invalid value for "company_id", company_id cannot be nil.')
+      end
+
+      if @connection_id.nil?
+        invalid_properties.push('invalid value for "connection_id", connection_id cannot be nil.')
+      end
+
+      if @sell_in_marketplace.nil?
+        invalid_properties.push('invalid value for "sell_in_marketplace", sell_in_marketplace cannot be nil.')
+      end
+
+      if @price_credits.nil?
+        invalid_properties.push('invalid value for "price_credits", price_credits cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @active.nil?
+        invalid_properties.push('invalid value for "active", active 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 @date_created.nil?
+      return false if @last_updated.nil?
+      return false if @company_id.nil?
+      return false if @connection_id.nil?
+      approval_status_validator = EnumAttributeValidator.new('String', ["PENDING", "APPROVED", "REJECTED", "NEEDS_REVISION"])
+      return false unless approval_status_validator.valid?(@approval_status)
+      return false if @sell_in_marketplace.nil?
+      return false if @price_credits.nil?
+      return false if @name.nil?
+      rate_limit_period_validator = EnumAttributeValidator.new('String', ["SECOND", "MINUTE", "HOUR", "DAY"])
+      return false unless rate_limit_period_validator.valid?(@rate_limit_period)
+      rate_limit_granularity_validator = EnumAttributeValidator.new('String', ["USER", "COMPANY", "IP", "GLOBAL"])
+      return false unless rate_limit_granularity_validator.valid?(@rate_limit_granularity)
+      access_method_validator = EnumAttributeValidator.new('String', ["OPEN", "API_KEY", "IP", "EMAIL", "DOMAIN"])
+      return false unless access_method_validator.valid?(@access_method)
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "INACTIVE", "DEPRECATED"])
+      return false unless status_validator.valid?(@status)
+      return false if @active.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] date_created Value to be assigned
+    def date_created=(date_created)
+      if date_created.nil?
+        fail ArgumentError, 'date_created cannot be nil'
+      end
+
+      @date_created = date_created
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] last_updated Value to be assigned
+    def last_updated=(last_updated)
+      if last_updated.nil?
+        fail ArgumentError, 'last_updated cannot be nil'
+      end
+
+      @last_updated = last_updated
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] company_id Value to be assigned
+    def company_id=(company_id)
+      if company_id.nil?
+        fail ArgumentError, 'company_id cannot be nil'
+      end
+
+      @company_id = company_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] connection_id Value to be assigned
+    def connection_id=(connection_id)
+      if connection_id.nil?
+        fail ArgumentError, 'connection_id cannot be nil'
+      end
+
+      @connection_id = connection_id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] approval_status Object to be assigned
+    def approval_status=(approval_status)
+      validator = EnumAttributeValidator.new('String', ["PENDING", "APPROVED", "REJECTED", "NEEDS_REVISION"])
+      unless validator.valid?(approval_status)
+        fail ArgumentError, "invalid value for \"approval_status\", must be one of #{validator.allowable_values}."
+      end
+      @approval_status = approval_status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sell_in_marketplace Value to be assigned
+    def sell_in_marketplace=(sell_in_marketplace)
+      if sell_in_marketplace.nil?
+        fail ArgumentError, 'sell_in_marketplace cannot be nil'
+      end
+
+      @sell_in_marketplace = sell_in_marketplace
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] price_credits Value to be assigned
+    def price_credits=(price_credits)
+      if price_credits.nil?
+        fail ArgumentError, 'price_credits cannot be nil'
+      end
+
+      @price_credits = price_credits
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] rate_limit_period Object to be assigned
+    def rate_limit_period=(rate_limit_period)
+      validator = EnumAttributeValidator.new('String', ["SECOND", "MINUTE", "HOUR", "DAY"])
+      unless validator.valid?(rate_limit_period)
+        fail ArgumentError, "invalid value for \"rate_limit_period\", must be one of #{validator.allowable_values}."
+      end
+      @rate_limit_period = rate_limit_period
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] rate_limit_granularity Object to be assigned
+    def rate_limit_granularity=(rate_limit_granularity)
+      validator = EnumAttributeValidator.new('String', ["USER", "COMPANY", "IP", "GLOBAL"])
+      unless validator.valid?(rate_limit_granularity)
+        fail ArgumentError, "invalid value for \"rate_limit_granularity\", must be one of #{validator.allowable_values}."
+      end
+      @rate_limit_granularity = rate_limit_granularity
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] access_method Object to be assigned
+    def access_method=(access_method)
+      validator = EnumAttributeValidator.new('String', ["OPEN", "API_KEY", "IP", "EMAIL", "DOMAIN"])
+      unless validator.valid?(access_method)
+        fail ArgumentError, "invalid value for \"access_method\", must be one of #{validator.allowable_values}."
+      end
+      @access_method = access_method
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["ACTIVE", "INACTIVE", "DEPRECATED"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] active Value to be assigned
+    def active=(active)
+      if active.nil?
+        fail ArgumentError, 'active cannot be nil'
+      end
+
+      @active = active
+    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 &&
+          date_created == o.date_created &&
+          last_updated == o.last_updated &&
+          endpoint_id == o.endpoint_id &&
+          user_id == o.user_id &&
+          company_id == o.company_id &&
+          connection_id == o.connection_id &&
+          industry_id == o.industry_id &&
+          auc_id == o.auc_id &&
+          approval_status == o.approval_status &&
+          approved_by_user_id == o.approved_by_user_id &&
+          approved_at == o.approved_at &&
+          sell_in_marketplace == o.sell_in_marketplace &&
+          price_credits == o.price_credits &&
+          name == o.name &&
+          slug == o.slug &&
+          description == o.description &&
+          source_schema_name == o.source_schema_name &&
+          source_table_name == o.source_table_name &&
+          customer_name == o.customer_name &&
+          price_usd == o.price_usd &&
+          endpoint_schema == o.endpoint_schema &&
+          rate_limit_requests == o.rate_limit_requests &&
+          rate_limit_period == o.rate_limit_period &&
+          rate_limit_granularity == o.rate_limit_granularity &&
+          access_method == o.access_method &&
+          access_whitelist == o.access_whitelist &&
+          status == o.status &&
+          tags == o.tags &&
+          last_accessed == o.last_accessed &&
+          max_records_per_request == o.max_records_per_request &&
+          sample_response == o.sample_response &&
+          active == o.active
+    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
+      [date_created, last_updated, endpoint_id, user_id, company_id, connection_id, industry_id, auc_id, approval_status, approved_by_user_id, approved_at, sell_in_marketplace, price_credits, name, slug, description, source_schema_name, source_table_name, customer_name, price_usd, endpoint_schema, rate_limit_requests, rate_limit_period, rate_limit_granularity, access_method, access_whitelist, status, tags, last_accessed, max_records_per_request, sample_response, active].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