wefunder 1.0.1 → 1.1.0

data/lib/wefunder_generated/models/{marketing_partner.rb → member_link_attributes.rb}

@@ -14,17 +14,24 @@ require 'date'
 require 'time'
 
 module WefunderGenerated
-  # A registered marketing partner
-  class MarketingPartner
-    attr_accessor :id
+  class MemberLinkAttributes
+    # The offering's deal page carrying this link's token. Send the member here.
+    attr_accessor :url
 
-    attr_accessor :user_id
+    # `created` nobody has redeemed it; `bound` a Wefunder account holds it; `invested` that account invested in this offering after the link was minted (kept after a cancel); `canceled` canceled before any investment. 
+    attr_accessor :state
 
-    attr_accessor :company_name
+    # Your member id, as passed at create.
+    attr_accessor :reference
 
-    attr_accessor :website
+    # The bound account's `usr_` id. Never an email.
+    attr_accessor :wefunder_user_id
 
-    attr_accessor :status
+    # The `inv_` id of the investment made through this link.
+    attr_accessor :investment_id
+
+    # The offering's id.
+    attr_accessor :offering
 
     attr_accessor :created_at
 
@@ -53,11 +60,12 @@ module WefunderGenerated
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
-        :'user_id' => :'user_id',
-        :'company_name' => :'company_name',
-        :'website' => :'website',
-        :'status' => :'status',
+        :'url' => :'url',
+        :'state' => :'state',
+        :'reference' => :'reference',
+        :'wefunder_user_id' => :'wefunder_user_id',
+        :'investment_id' => :'investment_id',
+        :'offering' => :'offering',
         :'created_at' => :'created_at'
       }
     end
@@ -70,11 +78,12 @@ module WefunderGenerated
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'id' => :'Integer',
-        :'user_id' => :'Integer',
-        :'company_name' => :'String',
-        :'website' => :'String',
-        :'status' => :'String',
+        :'url' => :'String',
+        :'state' => :'String',
+        :'reference' => :'String',
+        :'wefunder_user_id' => :'String',
+        :'investment_id' => :'String',
+        :'offering' => :'String',
         :'created_at' => :'Time'
       }
     end
@@ -82,7 +91,9 @@ module WefunderGenerated
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'website',
+        :'reference',
+        :'wefunder_user_id',
+        :'investment_id',
       ])
     end
 
@@ -90,35 +101,39 @@ module WefunderGenerated
     # @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::MarketingPartner` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `WefunderGenerated::MemberLinkAttributes` 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::MarketingPartner`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `WefunderGenerated::MemberLinkAttributes`. 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?(:'id')
-        self.id = attributes[:'id']
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
       end
 
-      if attributes.key?(:'user_id')
-        self.user_id = attributes[:'user_id']
+      if attributes.key?(:'reference')
+        self.reference = attributes[:'reference']
       end
 
-      if attributes.key?(:'company_name')
-        self.company_name = attributes[:'company_name']
+      if attributes.key?(:'wefunder_user_id')
+        self.wefunder_user_id = attributes[:'wefunder_user_id']
       end
 
-      if attributes.key?(:'website')
-        self.website = attributes[:'website']
+      if attributes.key?(:'investment_id')
+        self.investment_id = attributes[:'investment_id']
       end
 
-      if attributes.key?(:'status')
-        self.status = attributes[:'status']
+      if attributes.key?(:'offering')
+        self.offering = attributes[:'offering']
       end
 
       if attributes.key?(:'created_at')
@@ -138,19 +153,19 @@ module WefunderGenerated
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      status_validator = EnumAttributeValidator.new('String', ["pending", "approved", "rejected"])
-      return false unless status_validator.valid?(@status)
+      state_validator = EnumAttributeValidator.new('String', ["created", "bound", "invested", "canceled"])
+      return false unless state_validator.valid?(@state)
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] status Object to be assigned
-    def status=(status)
-      validator = EnumAttributeValidator.new('String', ["pending", "approved", "rejected"])
-      unless validator.valid?(status)
-        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+    # @param [Object] state Object to be assigned
+    def state=(state)
+      validator = EnumAttributeValidator.new('String', ["created", "bound", "invested", "canceled"])
+      unless validator.valid?(state)
+        fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
       end
-      @status = status
+      @state = state
     end
 
     # Checks equality by comparing each attribute.
@@ -158,11 +173,12 @@ module WefunderGenerated
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id == o.id &&
-          user_id == o.user_id &&
-          company_name == o.company_name &&
-          website == o.website &&
-          status == o.status &&
+          url == o.url &&
+          state == o.state &&
+          reference == o.reference &&
+          wefunder_user_id == o.wefunder_user_id &&
+          investment_id == o.investment_id &&
+          offering == o.offering &&
           created_at == o.created_at
     end
 
@@ -175,7 +191,7 @@ module WefunderGenerated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, user_id, company_name, website, status, created_at].hash
+      [url, state, reference, wefunder_user_id, investment_id, offering, created_at].hash
     end
 
     # Builds the object from hash

data/lib/wefunder_generated/models/{attribution_me_envelope.rb → member_link_create_input.rb}

@@ -14,13 +14,18 @@ require 'date'
 require 'time'
 
 module WefunderGenerated
-  class AttributionMeEnvelope
-    attr_accessor :data
+  class MemberLinkCreateInput
+    # Your opaque member id. Repeating it on the same offering returns the live link.
+    attr_accessor :reference
+
+    # Pre-bind the link to a member whose Wefunder account you know (`usr_` id). A repeated `reference` naming a different account is a 409.
+    attr_accessor :wefunder_user_id
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'data' => :'data'
+        :'reference' => :'reference',
+        :'wefunder_user_id' => :'wefunder_user_id'
       }
     end
 
@@ -32,7 +37,8 @@ module WefunderGenerated
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'data' => :'AttributionMe'
+        :'reference' => :'String',
+        :'wefunder_user_id' => :'String'
       }
     end
 
@@ -46,19 +52,23 @@ module WefunderGenerated
     # @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::AttributionMeEnvelope` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `WefunderGenerated::MemberLinkCreateInput` 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::AttributionMeEnvelope`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `WefunderGenerated::MemberLinkCreateInput`. 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?(:'data')
-        self.data = attributes[:'data']
+      if attributes.key?(:'reference')
+        self.reference = attributes[:'reference']
+      end
+
+      if attributes.key?(:'wefunder_user_id')
+        self.wefunder_user_id = attributes[:'wefunder_user_id']
       end
     end
 
@@ -67,6 +77,10 @@ module WefunderGenerated
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if !@reference.nil? && @reference.to_s.length > 255
+        invalid_properties.push('invalid value for "reference", the character length must be smaller than or equal to 255.')
+      end
+
       invalid_properties
     end
 
@@ -74,15 +88,31 @@ module WefunderGenerated
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if !@reference.nil? && @reference.to_s.length > 255
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] reference Value to be assigned
+    def reference=(reference)
+      if reference.nil?
+        fail ArgumentError, 'reference cannot be nil'
+      end
+
+      if reference.to_s.length > 255
+        fail ArgumentError, 'invalid value for "reference", the character length must be smaller than or equal to 255.'
+      end
+
+      @reference = reference
+    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
+          reference == o.reference &&
+          wefunder_user_id == o.wefunder_user_id
     end
 
     # @see the `==` method
@@ -94,7 +124,7 @@ module WefunderGenerated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [data].hash
+      [reference, wefunder_user_id].hash
     end
 
     # Builds the object from hash

data/lib/wefunder_generated/models/{spv_with_meta_envelope.rb → member_link_envelope.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module WefunderGenerated
-  class SpvWithMetaEnvelope
+  class MemberLinkEnvelope
     attr_accessor :data
 
     attr_accessor :meta
@@ -35,8 +35,8 @@ module WefunderGenerated
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'data' => :'Spv',
-        :'meta' => :'SpvWithMetaEnvelopeMeta'
+        :'data' => :'MemberLink',
+        :'meta' => :'ReferralCodeEnvelopeMeta'
       }
     end
 
@@ -50,13 +50,13 @@ module WefunderGenerated
     # @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::SpvWithMetaEnvelope` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `WefunderGenerated::MemberLinkEnvelope` 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::SpvWithMetaEnvelope`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `WefunderGenerated::MemberLinkEnvelope`. 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
       }

data/lib/wefunder_generated/models/{spv_list_envelope.rb → member_link_list_envelope.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module WefunderGenerated
-  class SpvListEnvelope
+  class MemberLinkListEnvelope
     attr_accessor :data
 
     attr_accessor :meta
@@ -35,8 +35,8 @@ module WefunderGenerated
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'data' => :'Array<Spv>',
-        :'meta' => :'PaginationMeta'
+        :'data' => :'Array<MemberLink>',
+        :'meta' => :'MemberLinkListEnvelopeMeta'
       }
     end
 
@@ -50,13 +50,13 @@ module WefunderGenerated
     # @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::SpvListEnvelope` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `WefunderGenerated::MemberLinkListEnvelope` 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::SpvListEnvelope`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `WefunderGenerated::MemberLinkListEnvelope`. 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
       }

data/lib/wefunder_generated/models/{full_attribution_investor.rb → member_link_list_envelope_meta.rb}

@@ -14,23 +14,22 @@ require 'date'
 require 'time'
 
 module WefunderGenerated
-  # Full investor details
-  class FullAttributionInvestor
-    attr_accessor :id
+  class MemberLinkListEnvelopeMeta
+    attr_accessor :has_more
 
-    attr_accessor :name
+    attr_accessor :page_count
 
-    attr_accessor :email
+    attr_accessor :request_id
 
-    attr_accessor :username
+    attr_accessor :next_cursor
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
-        :'name' => :'name',
-        :'email' => :'email',
-        :'username' => :'username'
+        :'has_more' => :'has_more',
+        :'page_count' => :'page_count',
+        :'request_id' => :'request_id',
+        :'next_cursor' => :'next_cursor'
       }
     end
 
@@ -42,10 +41,10 @@ module WefunderGenerated
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'id' => :'Integer',
-        :'name' => :'String',
-        :'email' => :'String',
-        :'username' => :'String'
+        :'has_more' => :'Boolean',
+        :'page_count' => :'Integer',
+        :'request_id' => :'String',
+        :'next_cursor' => :'String'
       }
     end
 
@@ -59,31 +58,31 @@ module WefunderGenerated
     # @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::FullAttributionInvestor` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `WefunderGenerated::MemberLinkListEnvelopeMeta` 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::FullAttributionInvestor`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `WefunderGenerated::MemberLinkListEnvelopeMeta`. 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?(:'id')
-        self.id = attributes[:'id']
+      if attributes.key?(:'has_more')
+        self.has_more = attributes[:'has_more']
       end
 
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
+      if attributes.key?(:'page_count')
+        self.page_count = attributes[:'page_count']
       end
 
-      if attributes.key?(:'email')
-        self.email = attributes[:'email']
+      if attributes.key?(:'request_id')
+        self.request_id = attributes[:'request_id']
       end
 
-      if attributes.key?(:'username')
-        self.username = attributes[:'username']
+      if attributes.key?(:'next_cursor')
+        self.next_cursor = attributes[:'next_cursor']
       end
     end
 
@@ -107,10 +106,10 @@ module WefunderGenerated
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id == o.id &&
-          name == o.name &&
-          email == o.email &&
-          username == o.username
+          has_more == o.has_more &&
+          page_count == o.page_count &&
+          request_id == o.request_id &&
+          next_cursor == o.next_cursor
     end
 
     # @see the `==` method
@@ -122,7 +121,7 @@ module WefunderGenerated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, email, username].hash
+      [has_more, page_count, request_id, next_cursor].hash
     end
 
     # Builds the object from hash

data/lib/wefunder_generated/models/offering_attributes.rb

@@ -49,6 +49,9 @@ module WefunderGenerated
     # Funding target in USD, as a decimal string.
     attr_accessor :funding_target
 
+    # The most this round may raise, in USD as a decimal string (the same denomination as `funding_target`). For a Reg CF round, the maximum offering amount on its Form C (the largest funding tier); otherwise the maximum the company set for the round. Null when neither exists. Raising past `funding_target` up to this amount is normal. 
+    attr_accessor :max_funding_target
+
     # Minimum investment in USD, as a decimal string.
     attr_accessor :min_investment
 
@@ -66,6 +69,12 @@ module WefunderGenerated
     # 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
 
+    # The round's latest accepted Form C (or Form C/A amendment) on SEC EDGAR, a public sec.gov URL. Reg CF rounds only; null until the Form C is filed and for every other exemption. For the round a company page shows, the same filing is `filing.sec_filing_url` in `GET /companies/{id}/disclosures`. 
+    attr_accessor :form_c_url
+
+    # The legal name of the Wefunder SPV (a series LLC that co-issues the round) that investors hold through, e.g. \"WF Acme 2025, a series of Wefunder SPV, LLC\". Null when investors hold the security directly. 
+    attr_accessor :spv_legal_name
+
     # **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
 
@@ -113,12 +122,15 @@ module WefunderGenerated
         :'status' => :'status',
         :'testing_the_waters' => :'testing_the_waters',
         :'funding_target' => :'funding_target',
+        :'max_funding_target' => :'max_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',
+        :'form_c_url' => :'form_c_url',
+        :'spv_legal_name' => :'spv_legal_name',
         :'publicly_visible' => :'publicly_visible',
         :'invested' => :'invested',
         :'followed' => :'followed'
@@ -146,12 +158,15 @@ module WefunderGenerated
         :'status' => :'String',
         :'testing_the_waters' => :'Boolean',
         :'funding_target' => :'String',
+        :'max_funding_target' => :'String',
         :'min_investment' => :'String',
         :'amount_raised' => :'String',
         :'investor_count' => :'Integer',
         :'started_at' => :'Time',
         :'closes_at' => :'Time',
         :'closed_at' => :'Time',
+        :'form_c_url' => :'String',
+        :'spv_legal_name' => :'String',
         :'publicly_visible' => :'Boolean',
         :'invested' => :'Boolean',
         :'followed' => :'Boolean'
@@ -167,12 +182,15 @@ module WefunderGenerated
         :'security',
         :'intended_security',
         :'funding_target',
+        :'max_funding_target',
         :'min_investment',
         :'amount_raised',
         :'investor_count',
         :'started_at',
         :'closes_at',
         :'closed_at',
+        :'form_c_url',
+        :'spv_legal_name',
       ])
     end
 
@@ -247,6 +265,10 @@ module WefunderGenerated
         self.funding_target = attributes[:'funding_target']
       end
 
+      if attributes.key?(:'max_funding_target')
+        self.max_funding_target = attributes[:'max_funding_target']
+      end
+
       if attributes.key?(:'min_investment')
         self.min_investment = attributes[:'min_investment']
       end
@@ -271,6 +293,14 @@ module WefunderGenerated
         self.closed_at = attributes[:'closed_at']
       end
 
+      if attributes.key?(:'form_c_url')
+        self.form_c_url = attributes[:'form_c_url']
+      end
+
+      if attributes.key?(:'spv_legal_name')
+        self.spv_legal_name = attributes[:'spv_legal_name']
+      end
+
       if attributes.key?(:'publicly_visible')
         self.publicly_visible = attributes[:'publicly_visible']
       end
@@ -329,12 +359,15 @@ module WefunderGenerated
           status == o.status &&
           testing_the_waters == o.testing_the_waters &&
           funding_target == o.funding_target &&
+          max_funding_target == o.max_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 &&
+          form_c_url == o.form_c_url &&
+          spv_legal_name == o.spv_legal_name &&
           publicly_visible == o.publicly_visible &&
           invested == o.invested &&
           followed == o.followed
@@ -349,7 +382,7 @@ module WefunderGenerated
     # 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
+      [company_name, tagline, url, card_image_url, logo_url, exemption, security, intended_security, industries, business_models, status, testing_the_waters, funding_target, max_funding_target, min_investment, amount_raised, investor_count, started_at, closes_at, closed_at, form_c_url, spv_legal_name, publicly_visible, invested, followed].hash
     end
 
     # Builds the object from hash