wefunder 0.1.0.beta1

data/lib/wefunder_generated/models/offering_attributes.rb

@@ -0,0 +1,469 @@
+=begin
+#Wefunder API v2
+
+#OAuth 2.0 API for accessing Wefunder data programmatically.  ## Authentication  This API uses OAuth 2.0 for authentication. To get started:  1. Create an OAuth application at `/oauth/applications` 2. Get your Client ID and Client Secret 3. Implement the OAuth 2.0 Authorization Code flow 4. Use the access token to make API requests  ## Versioning  The API is versioned by the dated `Wefunder-Version` request header (`YYYY-MM-DD`), never by the URL. Resolution is header → your application's pinned version → latest; every response carries `Wefunder-Version` (the version that handled it) and `Wefunder-Version-Latest`. An unknown value returns `400 invalid_request` naming the valid versions. Current: `2026-10-01`.  ## Rate Limits  - Standard API: 1,000 requests/hour per token - Admin API: 10,000 requests/hour per token  ## Base URL  All API requests should be made to: `https://api.wefunder.com` (no version in the path). 
+
+The version of the OpenAPI document: 2.0
+Contact: api@wefunder.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'date'
+require 'time'
+
+module WefunderGenerated
+  class OfferingAttributes
+    attr_accessor :company_name
+
+    attr_accessor :tagline
+
+    # The company's Wefunder profile URL.
+    attr_accessor :url
+
+    # Absolute URL of the explore card image, or null if the company has none.
+    attr_accessor :card_image_url
+
+    # Absolute URL of the company logo, or null if the company has none.
+    attr_accessor :logo_url
+
+    attr_accessor :exemption
+
+    attr_accessor :security
+
+    attr_accessor :intended_security
+
+    # The company's curated industry tags (the ones the site's explore page filters by), as `{ type, label }`. Empty when none are set. Filterable via `industry`. 
+    attr_accessor :industries
+
+    # The company's curated business-model tags, as `{ type, label }`. Filterable via `business_model`.
+    attr_accessor :business_models
+
+    # Where the round is in its life. `open` accepts investments (or reservations, for a Testing-the-Waters round); `closed` finished raising; `upcoming` is not yet accepting (insiders only); `canceled` was aborted. How close an open round is to closing is `closes_at`; whether it is over target is `amount_raised` vs `funding_target`. 
+    attr_accessor :status
+
+    # True for Testing-the-Waters rounds, which collect non-binding **reservations**, not investments. Use \"reserve\"/\"reservation\" copy for these, \"invest\"/\"investment\" otherwise. 
+    attr_accessor :testing_the_waters
+
+    # Funding target in USD, as a decimal string.
+    attr_accessor :funding_target
+
+    # Minimum investment in USD, as a decimal string.
+    attr_accessor :min_investment
+
+    # Amount raised so far **by this offering** in USD, as a decimal string (hellbanned investors excluded). Not the company's lifetime total, and not the combined figure the company's Wefunder page shows when a Reg D round runs alongside — see `warnings`. 
+    attr_accessor :amount_raised
+
+    # Distinct investor count for this offering (hellbanned investors excluded).
+    attr_accessor :investor_count
+
+    attr_accessor :started_at
+
+    # When an open round is scheduled to stop accepting investments. Null when no date is set or the round is not open. A round can remain open past this date until it is actually closed, so use `status`, not this date against the clock, to decide whether it accepts investments.
+    attr_accessor :closes_at
+
+    # When the round finished raising. Null while the round is upcoming or open (the scheduled close is `closes_at`); set only once `status` is `closed`.
+    attr_accessor :closed_at
+
+    # **Logged-in view only** (`read:explore`). `false` when a logged-out visitor could not see this offering — it is in the response only because of who the authorizing user is (accredited, invited, Vault/syndicate member). Absent in the public view. 
+    attr_accessor :publicly_visible
+
+    # **Logged-in view only** (`read:explore`). Whether the authorizing user has an active investment in this offering. Absent in the public view. 
+    attr_accessor :invested
+
+    # **Logged-in view only** (`read:explore`). Whether the authorizing user follows this company on wefunder.com (their watchlist). Absent in the public view. 
+    attr_accessor :followed
+
+    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
+      {
+        :'company_name' => :'company_name',
+        :'tagline' => :'tagline',
+        :'url' => :'url',
+        :'card_image_url' => :'card_image_url',
+        :'logo_url' => :'logo_url',
+        :'exemption' => :'exemption',
+        :'security' => :'security',
+        :'intended_security' => :'intended_security',
+        :'industries' => :'industries',
+        :'business_models' => :'business_models',
+        :'status' => :'status',
+        :'testing_the_waters' => :'testing_the_waters',
+        :'funding_target' => :'funding_target',
+        :'min_investment' => :'min_investment',
+        :'amount_raised' => :'amount_raised',
+        :'investor_count' => :'investor_count',
+        :'started_at' => :'started_at',
+        :'closes_at' => :'closes_at',
+        :'closed_at' => :'closed_at',
+        :'publicly_visible' => :'publicly_visible',
+        :'invested' => :'invested',
+        :'followed' => :'followed'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'company_name' => :'String',
+        :'tagline' => :'String',
+        :'url' => :'String',
+        :'card_image_url' => :'String',
+        :'logo_url' => :'String',
+        :'exemption' => :'Exemption',
+        :'security' => :'OfferingAttributesSecurity',
+        :'intended_security' => :'OfferingAttributesIntendedSecurity',
+        :'industries' => :'Array<TagRef>',
+        :'business_models' => :'Array<TagRef>',
+        :'status' => :'String',
+        :'testing_the_waters' => :'Boolean',
+        :'funding_target' => :'String',
+        :'min_investment' => :'String',
+        :'amount_raised' => :'String',
+        :'investor_count' => :'Integer',
+        :'started_at' => :'Time',
+        :'closes_at' => :'Time',
+        :'closed_at' => :'Time',
+        :'publicly_visible' => :'Boolean',
+        :'invested' => :'Boolean',
+        :'followed' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'tagline',
+        :'card_image_url',
+        :'logo_url',
+        :'security',
+        :'intended_security',
+        :'funding_target',
+        :'min_investment',
+        :'amount_raised',
+        :'investor_count',
+        :'started_at',
+        :'closes_at',
+        :'closed_at',
+      ])
+    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 `WefunderGenerated::OfferingAttributes` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `WefunderGenerated::OfferingAttributes`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'company_name')
+        self.company_name = attributes[:'company_name']
+      end
+
+      if attributes.key?(:'tagline')
+        self.tagline = attributes[:'tagline']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'card_image_url')
+        self.card_image_url = attributes[:'card_image_url']
+      end
+
+      if attributes.key?(:'logo_url')
+        self.logo_url = attributes[:'logo_url']
+      end
+
+      if attributes.key?(:'exemption')
+        self.exemption = attributes[:'exemption']
+      end
+
+      if attributes.key?(:'security')
+        self.security = attributes[:'security']
+      end
+
+      if attributes.key?(:'intended_security')
+        self.intended_security = attributes[:'intended_security']
+      end
+
+      if attributes.key?(:'industries')
+        if (value = attributes[:'industries']).is_a?(Array)
+          self.industries = value
+        end
+      end
+
+      if attributes.key?(:'business_models')
+        if (value = attributes[:'business_models']).is_a?(Array)
+          self.business_models = value
+        end
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'testing_the_waters')
+        self.testing_the_waters = attributes[:'testing_the_waters']
+      end
+
+      if attributes.key?(:'funding_target')
+        self.funding_target = attributes[:'funding_target']
+      end
+
+      if attributes.key?(:'min_investment')
+        self.min_investment = attributes[:'min_investment']
+      end
+
+      if attributes.key?(:'amount_raised')
+        self.amount_raised = attributes[:'amount_raised']
+      end
+
+      if attributes.key?(:'investor_count')
+        self.investor_count = attributes[:'investor_count']
+      end
+
+      if attributes.key?(:'started_at')
+        self.started_at = attributes[:'started_at']
+      end
+
+      if attributes.key?(:'closes_at')
+        self.closes_at = attributes[:'closes_at']
+      end
+
+      if attributes.key?(:'closed_at')
+        self.closed_at = attributes[:'closed_at']
+      end
+
+      if attributes.key?(:'publicly_visible')
+        self.publicly_visible = attributes[:'publicly_visible']
+      end
+
+      if attributes.key?(:'invested')
+        self.invested = attributes[:'invested']
+      end
+
+      if attributes.key?(:'followed')
+        self.followed = attributes[:'followed']
+      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'
+      status_validator = EnumAttributeValidator.new('String', ["upcoming", "open", "closed", "canceled"])
+      return false unless status_validator.valid?(@status)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["upcoming", "open", "closed", "canceled"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    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 &&
+          company_name == o.company_name &&
+          tagline == o.tagline &&
+          url == o.url &&
+          card_image_url == o.card_image_url &&
+          logo_url == o.logo_url &&
+          exemption == o.exemption &&
+          security == o.security &&
+          intended_security == o.intended_security &&
+          industries == o.industries &&
+          business_models == o.business_models &&
+          status == o.status &&
+          testing_the_waters == o.testing_the_waters &&
+          funding_target == o.funding_target &&
+          min_investment == o.min_investment &&
+          amount_raised == o.amount_raised &&
+          investor_count == o.investor_count &&
+          started_at == o.started_at &&
+          closes_at == o.closes_at &&
+          closed_at == o.closed_at &&
+          publicly_visible == o.publicly_visible &&
+          invested == o.invested &&
+          followed == o.followed
+    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
+      [company_name, tagline, url, card_image_url, logo_url, exemption, security, intended_security, industries, business_models, status, testing_the_waters, funding_target, min_investment, amount_raised, investor_count, started_at, closes_at, closed_at, publicly_visible, invested, followed].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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = WefunderGenerated.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end