spartera_api_sdk 0.3.6

data/lib/spartera_api_sdk/models/companies.rb

@@ -0,0 +1,374 @@
+=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 Spartera seller or buyer company account
+  class Companies < ApiModelBase
+    # Optional.
+    attr_accessor :date_created
+
+    # Optional.
+    attr_accessor :last_updated
+
+    # Unique identifier.
+    attr_accessor :company_id
+
+    # References industries.industry_id — Available industry categories for asset classification. Based on US NAISC codes.. See GET /industries for valid values. Optional.
+    attr_accessor :industry_id
+
+    # References countries.country_id — List of countries of the world. See GET /countries for valid values. Optional.
+    attr_accessor :country_id
+
+    # Optional.
+    attr_accessor :company_name
+
+    # Optional.
+    attr_accessor :company_description
+
+    # Required. Must be unique.
+    attr_accessor :company_handle
+
+    # Required. Must be unique.
+    attr_accessor :company_domain
+
+    # Current balance of credits for this company (buyer)
+    attr_accessor :credits_balance
+
+    # Optional.
+    attr_accessor :accepted_eula
+
+    # Stripe Connect account ID for marketplace sellers
+    attr_accessor :stripe_account_id
+
+    # Status of the Stripe account (verified, pending, etc.)
+    attr_accessor :stripe_account_status
+
+    # Negotiated vendor revenue share (e.g. 0.85 = 85%). NULL = system default 80%.
+    attr_accessor :vendor_share_percent
+
+    # Partnership type: SELF_MANAGED, CUSTODIAN, or null
+    attr_accessor :partnership_type
+
+    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',
+        :'company_id' => :'company_id',
+        :'industry_id' => :'industry_id',
+        :'country_id' => :'country_id',
+        :'company_name' => :'company_name',
+        :'company_description' => :'company_description',
+        :'company_handle' => :'company_handle',
+        :'company_domain' => :'company_domain',
+        :'credits_balance' => :'credits_balance',
+        :'accepted_eula' => :'accepted_eula',
+        :'stripe_account_id' => :'stripe_account_id',
+        :'stripe_account_status' => :'stripe_account_status',
+        :'vendor_share_percent' => :'vendor_share_percent',
+        :'partnership_type' => :'partnership_type'
+      }
+    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',
+        :'company_id' => :'String',
+        :'industry_id' => :'Integer',
+        :'country_id' => :'Integer',
+        :'company_name' => :'String',
+        :'company_description' => :'String',
+        :'company_handle' => :'String',
+        :'company_domain' => :'String',
+        :'credits_balance' => :'Integer',
+        :'accepted_eula' => :'Boolean',
+        :'stripe_account_id' => :'String',
+        :'stripe_account_status' => :'String',
+        :'vendor_share_percent' => :'Float',
+        :'partnership_type' => :'String'
+      }
+    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::Companies` 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::Companies`. 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']
+      end
+
+      if attributes.key?(:'last_updated')
+        self.last_updated = attributes[:'last_updated']
+      end
+
+      if attributes.key?(:'company_id')
+        self.company_id = attributes[:'company_id']
+      end
+
+      if attributes.key?(:'industry_id')
+        self.industry_id = attributes[:'industry_id']
+      end
+
+      if attributes.key?(:'country_id')
+        self.country_id = attributes[:'country_id']
+      end
+
+      if attributes.key?(:'company_name')
+        self.company_name = attributes[:'company_name']
+      end
+
+      if attributes.key?(:'company_description')
+        self.company_description = attributes[:'company_description']
+      end
+
+      if attributes.key?(:'company_handle')
+        self.company_handle = attributes[:'company_handle']
+      else
+        self.company_handle = nil
+      end
+
+      if attributes.key?(:'company_domain')
+        self.company_domain = attributes[:'company_domain']
+      else
+        self.company_domain = nil
+      end
+
+      if attributes.key?(:'credits_balance')
+        self.credits_balance = attributes[:'credits_balance']
+      else
+        self.credits_balance = nil
+      end
+
+      if attributes.key?(:'accepted_eula')
+        self.accepted_eula = attributes[:'accepted_eula']
+      end
+
+      if attributes.key?(:'stripe_account_id')
+        self.stripe_account_id = attributes[:'stripe_account_id']
+      end
+
+      if attributes.key?(:'stripe_account_status')
+        self.stripe_account_status = attributes[:'stripe_account_status']
+      end
+
+      if attributes.key?(:'vendor_share_percent')
+        self.vendor_share_percent = attributes[:'vendor_share_percent']
+      end
+
+      if attributes.key?(:'partnership_type')
+        self.partnership_type = attributes[:'partnership_type']
+      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 @company_handle.nil?
+        invalid_properties.push('invalid value for "company_handle", company_handle cannot be nil.')
+      end
+
+      if @company_domain.nil?
+        invalid_properties.push('invalid value for "company_domain", company_domain cannot be nil.')
+      end
+
+      if @credits_balance.nil?
+        invalid_properties.push('invalid value for "credits_balance", credits_balance 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 @company_handle.nil?
+      return false if @company_domain.nil?
+      return false if @credits_balance.nil?
+      partnership_type_validator = EnumAttributeValidator.new('String', ["SELF_MANAGED", "CUSTODIAN"])
+      return false unless partnership_type_validator.valid?(@partnership_type)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] company_handle Value to be assigned
+    def company_handle=(company_handle)
+      if company_handle.nil?
+        fail ArgumentError, 'company_handle cannot be nil'
+      end
+
+      @company_handle = company_handle
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] company_domain Value to be assigned
+    def company_domain=(company_domain)
+      if company_domain.nil?
+        fail ArgumentError, 'company_domain cannot be nil'
+      end
+
+      @company_domain = company_domain
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] credits_balance Value to be assigned
+    def credits_balance=(credits_balance)
+      if credits_balance.nil?
+        fail ArgumentError, 'credits_balance cannot be nil'
+      end
+
+      @credits_balance = credits_balance
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] partnership_type Object to be assigned
+    def partnership_type=(partnership_type)
+      validator = EnumAttributeValidator.new('String', ["SELF_MANAGED", "CUSTODIAN"])
+      unless validator.valid?(partnership_type)
+        fail ArgumentError, "invalid value for \"partnership_type\", must be one of #{validator.allowable_values}."
+      end
+      @partnership_type = partnership_type
+    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 &&
+          company_id == o.company_id &&
+          industry_id == o.industry_id &&
+          country_id == o.country_id &&
+          company_name == o.company_name &&
+          company_description == o.company_description &&
+          company_handle == o.company_handle &&
+          company_domain == o.company_domain &&
+          credits_balance == o.credits_balance &&
+          accepted_eula == o.accepted_eula &&
+          stripe_account_id == o.stripe_account_id &&
+          stripe_account_status == o.stripe_account_status &&
+          vendor_share_percent == o.vendor_share_percent &&
+          partnership_type == o.partnership_type
+    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, company_id, industry_id, country_id, company_name, company_description, company_handle, company_domain, credits_balance, accepted_eula, stripe_account_id, stripe_account_status, vendor_share_percent, partnership_type].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/spartera_api_sdk/models/companies_input.rb

@@ -0,0 +1,327 @@
+=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
+  # Input schema for creating Company
+  class CompaniesInput < ApiModelBase
+    # References industries.industry_id — Available industry categories for asset classification. Based on US NAISC codes.. See GET /industries for valid values. Optional.
+    attr_accessor :industry_id
+
+    # References countries.country_id — List of countries of the world. See GET /countries for valid values. Optional.
+    attr_accessor :country_id
+
+    # Optional.
+    attr_accessor :company_name
+
+    # Optional.
+    attr_accessor :company_description
+
+    # Required. Must be unique.
+    attr_accessor :company_handle
+
+    # Required. Must be unique.
+    attr_accessor :company_domain
+
+    # Current balance of credits for this company (buyer)
+    attr_accessor :credits_balance
+
+    # Optional.
+    attr_accessor :accepted_eula
+
+    # Stripe Connect account ID for marketplace sellers
+    attr_accessor :stripe_account_id
+
+    # Status of the Stripe account (verified, pending, etc.)
+    attr_accessor :stripe_account_status
+
+    # Negotiated vendor revenue share (e.g. 0.85 = 85%). NULL = system default 80%.
+    attr_accessor :vendor_share_percent
+
+    # Partnership type: SELF_MANAGED, CUSTODIAN, or null
+    attr_accessor :partnership_type
+
+    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
+      {
+        :'industry_id' => :'industry_id',
+        :'country_id' => :'country_id',
+        :'company_name' => :'company_name',
+        :'company_description' => :'company_description',
+        :'company_handle' => :'company_handle',
+        :'company_domain' => :'company_domain',
+        :'credits_balance' => :'credits_balance',
+        :'accepted_eula' => :'accepted_eula',
+        :'stripe_account_id' => :'stripe_account_id',
+        :'stripe_account_status' => :'stripe_account_status',
+        :'vendor_share_percent' => :'vendor_share_percent',
+        :'partnership_type' => :'partnership_type'
+      }
+    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
+      {
+        :'industry_id' => :'Integer',
+        :'country_id' => :'Integer',
+        :'company_name' => :'String',
+        :'company_description' => :'String',
+        :'company_handle' => :'String',
+        :'company_domain' => :'String',
+        :'credits_balance' => :'Integer',
+        :'accepted_eula' => :'Boolean',
+        :'stripe_account_id' => :'String',
+        :'stripe_account_status' => :'String',
+        :'vendor_share_percent' => :'Float',
+        :'partnership_type' => :'String'
+      }
+    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::CompaniesInput` 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::CompaniesInput`. 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?(:'industry_id')
+        self.industry_id = attributes[:'industry_id']
+      end
+
+      if attributes.key?(:'country_id')
+        self.country_id = attributes[:'country_id']
+      end
+
+      if attributes.key?(:'company_name')
+        self.company_name = attributes[:'company_name']
+      end
+
+      if attributes.key?(:'company_description')
+        self.company_description = attributes[:'company_description']
+      end
+
+      if attributes.key?(:'company_handle')
+        self.company_handle = attributes[:'company_handle']
+      else
+        self.company_handle = nil
+      end
+
+      if attributes.key?(:'company_domain')
+        self.company_domain = attributes[:'company_domain']
+      else
+        self.company_domain = nil
+      end
+
+      if attributes.key?(:'credits_balance')
+        self.credits_balance = attributes[:'credits_balance']
+      end
+
+      if attributes.key?(:'accepted_eula')
+        self.accepted_eula = attributes[:'accepted_eula']
+      end
+
+      if attributes.key?(:'stripe_account_id')
+        self.stripe_account_id = attributes[:'stripe_account_id']
+      end
+
+      if attributes.key?(:'stripe_account_status')
+        self.stripe_account_status = attributes[:'stripe_account_status']
+      end
+
+      if attributes.key?(:'vendor_share_percent')
+        self.vendor_share_percent = attributes[:'vendor_share_percent']
+      end
+
+      if attributes.key?(:'partnership_type')
+        self.partnership_type = attributes[:'partnership_type']
+      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 @company_handle.nil?
+        invalid_properties.push('invalid value for "company_handle", company_handle cannot be nil.')
+      end
+
+      if @company_domain.nil?
+        invalid_properties.push('invalid value for "company_domain", company_domain 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 @company_handle.nil?
+      return false if @company_domain.nil?
+      partnership_type_validator = EnumAttributeValidator.new('String', ["SELF_MANAGED", "CUSTODIAN"])
+      return false unless partnership_type_validator.valid?(@partnership_type)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] company_handle Value to be assigned
+    def company_handle=(company_handle)
+      if company_handle.nil?
+        fail ArgumentError, 'company_handle cannot be nil'
+      end
+
+      @company_handle = company_handle
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] company_domain Value to be assigned
+    def company_domain=(company_domain)
+      if company_domain.nil?
+        fail ArgumentError, 'company_domain cannot be nil'
+      end
+
+      @company_domain = company_domain
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] partnership_type Object to be assigned
+    def partnership_type=(partnership_type)
+      validator = EnumAttributeValidator.new('String', ["SELF_MANAGED", "CUSTODIAN"])
+      unless validator.valid?(partnership_type)
+        fail ArgumentError, "invalid value for \"partnership_type\", must be one of #{validator.allowable_values}."
+      end
+      @partnership_type = partnership_type
+    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 &&
+          industry_id == o.industry_id &&
+          country_id == o.country_id &&
+          company_name == o.company_name &&
+          company_description == o.company_description &&
+          company_handle == o.company_handle &&
+          company_domain == o.company_domain &&
+          credits_balance == o.credits_balance &&
+          accepted_eula == o.accepted_eula &&
+          stripe_account_id == o.stripe_account_id &&
+          stripe_account_status == o.stripe_account_status &&
+          vendor_share_percent == o.vendor_share_percent &&
+          partnership_type == o.partnership_type
+    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
+      [industry_id, country_id, company_name, company_description, company_handle, company_domain, credits_balance, accepted_eula, stripe_account_id, stripe_account_status, vendor_share_percent, partnership_type].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