wefunder 1.0.1 → 1.1.0

data/lib/wefunder_generated/models/offering_list_envelope_meta.rb

@@ -18,27 +18,57 @@ module WefunderGenerated
     # Total number of offerings across all pages.
     attr_accessor :total_count
 
-    # Number of offerings on this page (at most 25).
+    # Number of offerings on this page (at most `per_page`).
     attr_accessor :page_count
 
     attr_accessor :has_more
 
-    # The sort applied to this response.
+    # The `status` applied to this response.
+    attr_accessor :status
+
+    # The sort applied to this response. `recently_closed` for `status=closed`, which has a fixed order.
     attr_accessor :sort
 
+    # True when the response is the logged-in (`read:explore`) view.
+    attr_accessor :personalized
+
     # The filters applied to this response (validated values), empty when none.
     attr_accessor :filters
 
     # Opaque pagination cursor — pass as `cursor` to fetch the next page. Present only when `has_more` is true.
     attr_accessor :next_cursor
 
+    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
       {
         :'total_count' => :'total_count',
         :'page_count' => :'page_count',
         :'has_more' => :'has_more',
+        :'status' => :'status',
         :'sort' => :'sort',
+        :'personalized' => :'personalized',
         :'filters' => :'filters',
         :'next_cursor' => :'next_cursor'
       }
@@ -55,7 +85,9 @@ module WefunderGenerated
         :'total_count' => :'Integer',
         :'page_count' => :'Integer',
         :'has_more' => :'Boolean',
+        :'status' => :'String',
         :'sort' => :'String',
+        :'personalized' => :'Boolean',
         :'filters' => :'Object',
         :'next_cursor' => :'Integer'
       }
@@ -95,10 +127,18 @@ module WefunderGenerated
         self.has_more = attributes[:'has_more']
       end
 
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
       if attributes.key?(:'sort')
         self.sort = attributes[:'sort']
       end
 
+      if attributes.key?(:'personalized')
+        self.personalized = attributes[:'personalized']
+      end
+
       if attributes.key?(:'filters')
         self.filters = attributes[:'filters']
       end
@@ -120,9 +160,21 @@ module WefunderGenerated
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      status_validator = EnumAttributeValidator.new('String', ["live", "closed", "all"])
+      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', ["live", "closed", "all"])
+      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)
@@ -131,7 +183,9 @@ module WefunderGenerated
           total_count == o.total_count &&
           page_count == o.page_count &&
           has_more == o.has_more &&
+          status == o.status &&
           sort == o.sort &&
+          personalized == o.personalized &&
           filters == o.filters &&
           next_cursor == o.next_cursor
     end
@@ -145,7 +199,7 @@ module WefunderGenerated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [total_count, page_count, has_more, sort, filters, next_cursor].hash
+      [total_count, page_count, has_more, status, sort, personalized, filters, next_cursor].hash
     end
 
     # Builds the object from hash

data/lib/wefunder_generated/models/portfolio_company_ref.rb

@@ -23,12 +23,16 @@ module WefunderGenerated
 
     attr_accessor :slug
 
+    # The company's page on wefunder.com, absolute. This is the link target the [attribution rule](/resources/acceptable-use#attribution) asks for wherever you show the position; do not link to the investor's Wefunder portfolio instead. Null when the company no longer has a public page.
+    attr_accessor :url
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
         :'name' => :'name',
-        :'slug' => :'slug'
+        :'slug' => :'slug',
+        :'url' => :'url'
       }
     end
 
@@ -42,14 +46,16 @@ module WefunderGenerated
       {
         :'id' => :'String',
         :'name' => :'String',
-        :'slug' => :'String'
+        :'slug' => :'String',
+        :'url' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'slug'
+        :'slug',
+        :'url'
       ])
     end
 
@@ -79,6 +85,10 @@ module WefunderGenerated
       if attributes.key?(:'slug')
         self.slug = attributes[:'slug']
       end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -103,7 +113,8 @@ module WefunderGenerated
       self.class == o.class &&
           id == o.id &&
           name == o.name &&
-          slug == o.slug
+          slug == o.slug &&
+          url == o.url
     end
 
     # @see the `==` method
@@ -115,7 +126,7 @@ module WefunderGenerated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, slug].hash
+      [id, name, slug, url].hash
     end
 
     # Builds the object from hash

data/lib/wefunder_generated/models/portfolio_position_attributes.rb

@@ -31,6 +31,9 @@ module WefunderGenerated
     # Why the position ended. Set only for `exited` and `failed` positions — a `sold` position ended with the transfer itself, and some older positions have no recorded ending. `ipo` means the company went public; distributions, if any, appear in `realized_gain_cents`. 
     attr_accessor :exit_reason
 
+    # The date the position ended (`YYYY-MM-DD`): the effective date of the company's recorded exit. Set only for `exited` and `failed` positions, and null for older exits recorded before Wefunder kept exit dates, even when `exit_reason` is present. 
+    attr_accessor :exited_on
+
     attr_accessor :invested_at
 
     # ISO 4217 code, lower-case, of the investment amounts on this position and its `securities` (cost basis, values, gains, share price) — the offering's currency: `usd`, or `eur` for an ECSP round. A security's note cap and pre-money valuation carry their own `terms.currency`, which can differ.
@@ -38,7 +41,7 @@ module WefunderGenerated
 
     attr_accessor :cost_basis_cents
 
-    # Estimated current value; based on cost basis when no newer valuation has been recorded.
+    # Estimated current value. It equals `cost_basis_cents` until a later priced round, a recorded valuation mark, or an exit marks the position, so an active position reading at cost is expected, not missing data.
     attr_accessor :current_value_cents
 
     # Can be negative.
@@ -96,6 +99,7 @@ module WefunderGenerated
         :'security' => :'security',
         :'status' => :'status',
         :'exit_reason' => :'exit_reason',
+        :'exited_on' => :'exited_on',
         :'invested_at' => :'invested_at',
         :'currency' => :'currency',
         :'cost_basis_cents' => :'cost_basis_cents',
@@ -126,6 +130,7 @@ module WefunderGenerated
         :'security' => :'SecuritySummary',
         :'status' => :'String',
         :'exit_reason' => :'String',
+        :'exited_on' => :'Date',
         :'invested_at' => :'Time',
         :'currency' => :'String',
         :'cost_basis_cents' => :'Integer',
@@ -147,6 +152,7 @@ module WefunderGenerated
       Set.new([
         :'security',
         :'exit_reason',
+        :'exited_on',
         :'invested_at',
         :'return_multiple',
         :'shares_held',
@@ -193,6 +199,10 @@ module WefunderGenerated
         self.exit_reason = attributes[:'exit_reason']
       end
 
+      if attributes.key?(:'exited_on')
+        self.exited_on = attributes[:'exited_on']
+      end
+
       if attributes.key?(:'invested_at')
         self.invested_at = attributes[:'invested_at']
       end
@@ -312,6 +322,7 @@ module WefunderGenerated
           security == o.security &&
           status == o.status &&
           exit_reason == o.exit_reason &&
+          exited_on == o.exited_on &&
           invested_at == o.invested_at &&
           currency == o.currency &&
           cost_basis_cents == o.cost_basis_cents &&
@@ -336,7 +347,7 @@ module WefunderGenerated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [offering_id, company, asset_type, security, status, exit_reason, invested_at, currency, cost_basis_cents, current_value_cents, unrealized_gain_cents, realized_gain_cents, return_multiple, shares_held, current_share_price, securities, holdings, investor_count, as_of].hash
+      [offering_id, company, asset_type, security, status, exit_reason, exited_on, invested_at, currency, cost_basis_cents, current_value_cents, unrealized_gain_cents, realized_gain_cents, return_multiple, shares_held, current_share_price, securities, holdings, investor_count, as_of].hash
     end
 
     # Builds the object from hash

data/lib/wefunder_generated/models/portfolio_security_terms.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module WefunderGenerated
-  # The offering's issue terms. Fields are null when the term does not apply to the security type.
+  # The offering's issue terms. A field is null when the term does not apply to the security type, and also when the security has none: an uncapped SAFE or note has a null `note_cap_cents` (with `uncapped: true`), and a security with no discount, including one recorded as zero, has a null `note_discount`.
   class PortfolioSecurityTerms
     # Issue price per share as a decimal string
     attr_accessor :share_price
@@ -22,8 +22,13 @@ module WefunderGenerated
     # Lower-case ISO 4217 code of `note_cap_cents` and `premoney_valuation_cents`, the currency the founder entered them in. USD when the round's terms are explicitly USD-denominated (checkout prices them in USD then); otherwise a SAFE's cap is in the round's declared financials currency (falling back to the round's), while equity pre-money and a convertible note's valuation are in the round currency. A EUR-funded SAFE can therefore carry a `usd` or `dkk` cap. `share_price` and every other `_cents` field on the position stay in the position's top-level `currency`.
     attr_accessor :currency
 
+    # The valuation cap of a SAFE or convertible note, in cents of `terms.currency`. Null when the security is uncapped (see `uncapped`) or has no cap.
     attr_accessor :note_cap_cents
 
+    # `true` when a SAFE or convertible note has no valuation cap, `false` when it has one. Null for securities that never carry a cap (equity, revenue share, debt, fund, other). Same rule as `uncapped` in an offering's `security.terms`.
+    attr_accessor :uncapped
+
+    # Conversion discount as a decimal string percentage (`\"20.0\"` is 20%). Null when there is no discount, including a discount recorded as zero, the same as `discount_percent` in an offering's `security.terms`.
     attr_accessor :note_discount
 
     attr_accessor :premoney_valuation_cents
@@ -34,6 +39,7 @@ module WefunderGenerated
         :'share_price' => :'share_price',
         :'currency' => :'currency',
         :'note_cap_cents' => :'note_cap_cents',
+        :'uncapped' => :'uncapped',
         :'note_discount' => :'note_discount',
         :'premoney_valuation_cents' => :'premoney_valuation_cents'
       }
@@ -50,6 +56,7 @@ module WefunderGenerated
         :'share_price' => :'String',
         :'currency' => :'String',
         :'note_cap_cents' => :'Integer',
+        :'uncapped' => :'Boolean',
         :'note_discount' => :'String',
         :'premoney_valuation_cents' => :'Integer'
       }
@@ -60,6 +67,7 @@ module WefunderGenerated
       Set.new([
         :'share_price',
         :'note_cap_cents',
+        :'uncapped',
         :'note_discount',
         :'premoney_valuation_cents'
       ])
@@ -92,6 +100,10 @@ module WefunderGenerated
         self.note_cap_cents = attributes[:'note_cap_cents']
       end
 
+      if attributes.key?(:'uncapped')
+        self.uncapped = attributes[:'uncapped']
+      end
+
       if attributes.key?(:'note_discount')
         self.note_discount = attributes[:'note_discount']
       end
@@ -124,6 +136,7 @@ module WefunderGenerated
           share_price == o.share_price &&
           currency == o.currency &&
           note_cap_cents == o.note_cap_cents &&
+          uncapped == o.uncapped &&
           note_discount == o.note_discount &&
           premoney_valuation_cents == o.premoney_valuation_cents
     end
@@ -137,7 +150,7 @@ module WefunderGenerated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [share_price, currency, note_cap_cents, note_discount, premoney_valuation_cents].hash
+      [share_price, currency, note_cap_cents, uncapped, note_discount, premoney_valuation_cents].hash
     end
 
     # Builds the object from hash

data/lib/wefunder_generated/models/{spv_status.rb → referral_code.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module WefunderGenerated
-  class SpvStatus
+  class ReferralCode
     attr_accessor :id
 
     attr_accessor :type
@@ -40,7 +40,7 @@ module WefunderGenerated
       {
         :'id' => :'String',
         :'type' => :'String',
-        :'attributes' => :'SpvStatusAttributes'
+        :'attributes' => :'ReferralCodeAttributes'
       }
     end
 
@@ -54,13 +54,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::SpvStatus` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `WefunderGenerated::ReferralCode` 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::SpvStatus`. 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::ReferralCode`. 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/{webhook_subscription.rb → referral_code_attributes.rb}

@@ -14,57 +14,38 @@ require 'date'
 require 'time'
 
 module WefunderGenerated
-  # A webhook subscription for attribution events
-  class WebhookSubscription
-    attr_accessor :id
+  class ReferralCodeAttributes
+    attr_accessor :label
 
-    attr_accessor :campaign_id
+    # A paused code is ignored on arrival; it still credits cookies set while it was active.
+    attr_accessor :active
 
-    attr_accessor :target_url
+    attr_accessor :target
 
-    attr_accessor :events
+    attr_accessor :utm
 
-    # Whether the subscription is active
-    attr_accessor :active
+    attr_accessor :metadata
 
-    # Number of consecutive delivery failures (resets on success)
-    attr_accessor :consecutive_failures
+    # The query parameter to append to any wefunder.com link.
+    attr_accessor :link_parameter
+
+    # On list and retrieve only: the daily visit snapshot. Investor ranges are per company and per week, on `GET /referral_codes/{id}/stats`. 
+    attr_accessor :stats
 
     attr_accessor :created_at
 
     attr_accessor :updated_at
 
-    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
       {
-        :'id' => :'id',
-        :'campaign_id' => :'campaign_id',
-        :'target_url' => :'target_url',
-        :'events' => :'events',
+        :'label' => :'label',
         :'active' => :'active',
-        :'consecutive_failures' => :'consecutive_failures',
+        :'target' => :'target',
+        :'utm' => :'utm',
+        :'metadata' => :'metadata',
+        :'link_parameter' => :'link_parameter',
+        :'stats' => :'stats',
         :'created_at' => :'created_at',
         :'updated_at' => :'updated_at'
       }
@@ -78,12 +59,13 @@ module WefunderGenerated
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'id' => :'Integer',
-        :'campaign_id' => :'Integer',
-        :'target_url' => :'String',
-        :'events' => :'Array<String>',
+        :'label' => :'String',
         :'active' => :'Boolean',
-        :'consecutive_failures' => :'Integer',
+        :'target' => :'ReferralCodeAttributesTarget',
+        :'utm' => :'ReferralCodeUtm',
+        :'metadata' => :'Hash<String, Object>',
+        :'link_parameter' => :'String',
+        :'stats' => :'ReferralCodeVisits',
         :'created_at' => :'Time',
         :'updated_at' => :'Time'
       }
@@ -92,6 +74,7 @@ module WefunderGenerated
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'target',
       ])
     end
 
@@ -99,41 +82,45 @@ 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::WebhookSubscription` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `WefunderGenerated::ReferralCodeAttributes` 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::WebhookSubscription`. 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::ReferralCodeAttributes`. 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?(:'label')
+        self.label = attributes[:'label']
+      end
+
+      if attributes.key?(:'active')
+        self.active = attributes[:'active']
       end
 
-      if attributes.key?(:'campaign_id')
-        self.campaign_id = attributes[:'campaign_id']
+      if attributes.key?(:'target')
+        self.target = attributes[:'target']
       end
 
-      if attributes.key?(:'target_url')
-        self.target_url = attributes[:'target_url']
+      if attributes.key?(:'utm')
+        self.utm = attributes[:'utm']
       end
 
-      if attributes.key?(:'events')
-        if (value = attributes[:'events']).is_a?(Array)
-          self.events = value
+      if attributes.key?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
         end
       end
 
-      if attributes.key?(:'active')
-        self.active = attributes[:'active']
+      if attributes.key?(:'link_parameter')
+        self.link_parameter = attributes[:'link_parameter']
       end
 
-      if attributes.key?(:'consecutive_failures')
-        self.consecutive_failures = attributes[:'consecutive_failures']
+      if attributes.key?(:'stats')
+        self.stats = attributes[:'stats']
       end
 
       if attributes.key?(:'created_at')
@@ -165,12 +152,13 @@ module WefunderGenerated
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id == o.id &&
-          campaign_id == o.campaign_id &&
-          target_url == o.target_url &&
-          events == o.events &&
+          label == o.label &&
           active == o.active &&
-          consecutive_failures == o.consecutive_failures &&
+          target == o.target &&
+          utm == o.utm &&
+          metadata == o.metadata &&
+          link_parameter == o.link_parameter &&
+          stats == o.stats &&
           created_at == o.created_at &&
           updated_at == o.updated_at
     end
@@ -184,7 +172,7 @@ module WefunderGenerated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, campaign_id, target_url, events, active, consecutive_failures, created_at, updated_at].hash
+      [label, active, target, utm, metadata, link_parameter, stats, created_at, updated_at].hash
     end
 
     # Builds the object from hash