wefunder 1.0.1 → 1.1.0

data/lib/wefunder_generated/models/fiscal_year_financials.rb

@@ -22,8 +22,16 @@ module WefunderGenerated
 
     attr_accessor :accounts_receivable
 
+    # Total current liabilities as filed on the Form C balance sheet — including SAFE and convertible-note liabilities, accrued expenses and deferred revenue, not only borrowed money. For borrowings see `outstanding_notes` and `outstanding_debts`, which itemize each instrument with its principal.
+    attr_accessor :current_liabilities
+
+    # Total non-current liabilities as filed on the Form C balance sheet. Same caveat as `current_liabilities`.
+    attr_accessor :non_current_liabilities
+
+    # Deprecated alias of `current_liabilities` (same value): the figure is total current liabilities, not short-term debt. Will be removed in a future dated version.
     attr_accessor :short_term_debt
 
+    # Deprecated alias of `non_current_liabilities` (same value): the figure is total non-current liabilities, not long-term debt. Will be removed in a future dated version.
     attr_accessor :long_term_debt
 
     attr_accessor :revenue
@@ -40,6 +48,8 @@ module WefunderGenerated
         :'total_assets' => :'total_assets',
         :'cash_and_equivalents' => :'cash_and_equivalents',
         :'accounts_receivable' => :'accounts_receivable',
+        :'current_liabilities' => :'current_liabilities',
+        :'non_current_liabilities' => :'non_current_liabilities',
         :'short_term_debt' => :'short_term_debt',
         :'long_term_debt' => :'long_term_debt',
         :'revenue' => :'revenue',
@@ -60,6 +70,8 @@ module WefunderGenerated
         :'total_assets' => :'String',
         :'cash_and_equivalents' => :'String',
         :'accounts_receivable' => :'String',
+        :'current_liabilities' => :'String',
+        :'non_current_liabilities' => :'String',
         :'short_term_debt' => :'String',
         :'long_term_debt' => :'String',
         :'revenue' => :'String',
@@ -75,6 +87,8 @@ module WefunderGenerated
         :'total_assets',
         :'cash_and_equivalents',
         :'accounts_receivable',
+        :'current_liabilities',
+        :'non_current_liabilities',
         :'short_term_debt',
         :'long_term_debt',
         :'revenue',
@@ -111,6 +125,14 @@ module WefunderGenerated
         self.accounts_receivable = attributes[:'accounts_receivable']
       end
 
+      if attributes.key?(:'current_liabilities')
+        self.current_liabilities = attributes[:'current_liabilities']
+      end
+
+      if attributes.key?(:'non_current_liabilities')
+        self.non_current_liabilities = attributes[:'non_current_liabilities']
+      end
+
       if attributes.key?(:'short_term_debt')
         self.short_term_debt = attributes[:'short_term_debt']
       end
@@ -159,6 +181,8 @@ module WefunderGenerated
           total_assets == o.total_assets &&
           cash_and_equivalents == o.cash_and_equivalents &&
           accounts_receivable == o.accounts_receivable &&
+          current_liabilities == o.current_liabilities &&
+          non_current_liabilities == o.non_current_liabilities &&
           short_term_debt == o.short_term_debt &&
           long_term_debt == o.long_term_debt &&
           revenue == o.revenue &&
@@ -176,7 +200,7 @@ module WefunderGenerated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [total_assets, cash_and_equivalents, accounts_receivable, short_term_debt, long_term_debt, revenue, cost_of_goods_sold, taxes_paid, net_income].hash
+      [total_assets, cash_and_equivalents, accounts_receivable, current_liabilities, non_current_liabilities, short_term_debt, long_term_debt, revenue, cost_of_goods_sold, taxes_paid, net_income].hash
     end
 
     # Builds the object from hash

data/lib/wefunder_generated/models/intent_attributes.rb

@@ -117,6 +117,7 @@ module WefunderGenerated
     def self.openapi_nullable
       Set.new([
         :'resource_id',
+        :'impact_summary',
         :'requested_by_agent',
         :'expires_at',
         :'approved_at',

data/lib/wefunder_generated/models/investment_delta_record.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module WefunderGenerated
-  # The record of one investment, or a tombstone (`visible: false`, only `id`). `visible` is founder visibility: a user's own canceled investment is a full record with `visible: false` and `status: canceled`. Investor PII keys are omitted without `read:investors:pii`, except on the user's own records. 
+  # The record of one investment, or a tombstone. A tombstone is `visible: false` with `id` and the sync metadata (`observed_at`, `cursor`, `reason`) and no payload fields: no `status`, `amounts`, `investor`. `visible` is founder visibility: a user's own canceled investment is a full record with `visible: false` and `status: canceled`, so tell the two apart by the presence of `status`, not by `visible`. Investor PII keys are omitted without `read:investors:pii`, except on the user's own records. 
   class InvestmentDeltaRecord
     # Investment external id (`inv_…`), stable for the life of the investment.
     attr_accessor :id
@@ -71,7 +71,7 @@ module WefunderGenerated
     # Ledger position of the change that listed this record (delta pages only).
     attr_accessor :cursor
 
-    # Why the ledger row exists. `investor_deactivated` marks the first republish after the investor's account was deactivated (identity fields redacted). Delta pages only. 
+    # Why the ledger row exists. Delta pages only; `null` on list pages and on retrieve. Every value is a record to upsert. `changed`: a partner-visible field moved. `recomputed`: the investment's inputs did not change and the record moved only because Wefunder changed how it derives a field; sync it, but a notification rule may skip it. `reprojected`: the retired name for `recomputed`, still served on rows published before the rename for as long as they are retained (90 days); treat it exactly like `recomputed`. `investor_deactivated` marks the first republish after the investor's account was deactivated (identity fields redacted). 
     attr_accessor :reason
 
     class EnumAttributeValidator
@@ -320,7 +320,7 @@ module WefunderGenerated
       status_validator = EnumAttributeValidator.new('String', ["reserved", "active", "executed", "canceled", "converted"])
       return false unless status_validator.valid?(@status)
       return false if @observed_at.nil?
-      reason_validator = EnumAttributeValidator.new('String', ["changed", "reprojected", "investor_deactivated"])
+      reason_validator = EnumAttributeValidator.new('String', ["changed", "recomputed", "reprojected", "investor_deactivated"])
       return false unless reason_validator.valid?(@reason)
       true
     end
@@ -338,7 +338,7 @@ module WefunderGenerated
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] reason Object to be assigned
     def reason=(reason)
-      validator = EnumAttributeValidator.new('String', ["changed", "reprojected", "investor_deactivated"])
+      validator = EnumAttributeValidator.new('String', ["changed", "recomputed", "reprojected", "investor_deactivated"])
       unless validator.valid?(reason)
         fail ArgumentError, "invalid value for \"reason\", must be one of #{validator.allowable_values}."
       end

data/lib/wefunder_generated/models/investment_session_attributes.rb

@@ -22,6 +22,7 @@ module WefunderGenerated
 
     attr_accessor :spv_id
 
+    # The recipient email you supplied. `null` for a session addressed by `wefunder_user_id`, directly or through an invite link addressed that way, which never returns the account's email.
     attr_accessor :email
 
     # The fixed amount the session locks to, in cents; null when the recipient chooses their own amount.

data/lib/wefunder_generated/models/investment_session_create_input.rb

@@ -26,9 +26,12 @@ module WefunderGenerated
     # Fixed investment amount, in cents (whole dollars only). Locks the checkout to exactly this value, overriding the SPV's min/max purchase range. Omit to let the recipient choose an amount within that range. 
     attr_accessor :allocation_cents
 
-    # Where to send the recipient after they complete the session.
+    # Where to send the recipient after they complete the session. An absolute `https` URL on the origin (scheme, host and port) of one of your app's registered OAuth redirect URIs, such as an iOS universal link or Android app link, or a URL in a custom scheme one of those redirect URIs uses (`com.partner.app://checkout/done`). `http` is accepted only on a loopback host one of your redirect URIs uses. Anything else is a `422 validation_error`. See [Investment sessions on mobile](/guides/investment-sessions-mobile). 
     attr_accessor :success_url
 
+    # Where to send the recipient when they cancel the session on the hosted page, or open it after it was canceled or expired. Same rules as `success_url`: an `https` URL on a registered redirect URI's origin, or a URL in a registered custom scheme. Wefunder appends `session_id` (the session's `is_` id) and `reason` to the query string, keeping any parameters already on the URL. `reason` is `user_canceled` (the session is now canceled), `user_left` (the investor had already started checkout, so the session stays active until it completes or expires), `canceled` or `expired`. 
+    attr_accessor :cancel_url
+
     # Session lifetime in hours (default 720, i.e. 30 days).
     attr_accessor :expires_in_hours
 
@@ -46,6 +49,7 @@ module WefunderGenerated
         :'wefunder_user_id' => :'wefunder_user_id',
         :'allocation_cents' => :'allocation_cents',
         :'success_url' => :'success_url',
+        :'cancel_url' => :'cancel_url',
         :'expires_in_hours' => :'expires_in_hours',
         :'metadata' => :'metadata',
         :'intent_id' => :'intent_id'
@@ -65,6 +69,7 @@ module WefunderGenerated
         :'wefunder_user_id' => :'String',
         :'allocation_cents' => :'Integer',
         :'success_url' => :'String',
+        :'cancel_url' => :'String',
         :'expires_in_hours' => :'Integer',
         :'metadata' => :'Object',
         :'intent_id' => :'String'
@@ -79,6 +84,7 @@ module WefunderGenerated
         :'wefunder_user_id',
         :'allocation_cents',
         :'success_url',
+        :'cancel_url',
         :'expires_in_hours',
         :'metadata',
         :'intent_id'
@@ -120,6 +126,10 @@ module WefunderGenerated
         self.success_url = attributes[:'success_url']
       end
 
+      if attributes.key?(:'cancel_url')
+        self.cancel_url = attributes[:'cancel_url']
+      end
+
       if attributes.key?(:'expires_in_hours')
         self.expires_in_hours = attributes[:'expires_in_hours']
       end
@@ -197,6 +207,7 @@ module WefunderGenerated
           wefunder_user_id == o.wefunder_user_id &&
           allocation_cents == o.allocation_cents &&
           success_url == o.success_url &&
+          cancel_url == o.cancel_url &&
           expires_in_hours == o.expires_in_hours &&
           metadata == o.metadata &&
           intent_id == o.intent_id
@@ -211,7 +222,7 @@ module WefunderGenerated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [spv_id, email, wefunder_user_id, allocation_cents, success_url, expires_in_hours, metadata, intent_id].hash
+      [spv_id, email, wefunder_user_id, allocation_cents, success_url, cancel_url, expires_in_hours, metadata, intent_id].hash
     end
 
     # Builds the object from hash

data/lib/wefunder_generated/models/investment_session_envelope.rb

@@ -36,7 +36,7 @@ module WefunderGenerated
     def self.openapi_types
       {
         :'data' => :'InvestmentSession',
-        :'meta' => :'WebhookEndpointEnvelopeMeta'
+        :'meta' => :'ReferralCodeEnvelopeMeta'
       }
     end
 

data/lib/wefunder_generated/models/invite_link_attributes.rb

@@ -15,21 +15,33 @@ require 'time'
 
 module WefunderGenerated
   class InviteLinkAttributes
-    # Shareable invite URL. Carries the access token, not the id.
+    # Shareable invite URL. Carries the access token, not the id. A link made through the API opens the hosted investment flow (`/invest/link/...`); a link made on wefunder.com opens the deal page with its token (`/{company}?invite_token=...`), the URL wefunder.com sends. Null on a per-person invite whose recipient the caller may not see (see `email`): the URL carries the invite's access token and its page shows the recipient. Cancel, update and resend still work. An invite your app addressed by `wefunder_user_id` keeps its URL: its page names no address. 
     attr_accessor :url
 
+    # `true` for a reusable (shareable) link, `false` for a per-person invite. Fixed at creation. Use this, not the presence of `email`, to tell the two apart. 
+    attr_accessor :reuse
+
     attr_accessor :allocation_cents
 
     attr_accessor :max_uses
 
     attr_accessor :uses_count
 
+    # How many times the link was clicked through: a click is recorded when the recipient continues past the link's landing page into the investment flow (loading the page alone is not counted, since mail clients prefetch links). Visits that found the link canceled or the offering closed are not clicks, nor are sends. Recorded for per-person links only; a reusable link reports 0 (use `uses_count` for its claims). 
+    attr_accessor :click_count
+
+    # When the link was first clicked; null if it never was. A click, not an email open.
+    attr_accessor :first_clicked_at
+
     # False once the link is canceled (soft-deleted).
     attr_accessor :active
 
+    # When the link was canceled; null while it is active.
+    attr_accessor :canceled_at
+
     attr_accessor :created_at
 
-    # Per-person only — recipient email.
+    # Per-person only — recipient email. Always `null` for an invite addressed by `wefunder_user_id`, which never returns the account's email. Otherwise null unless the token holds `read:investors:pii` (on an install, the install must grant it too), except that the app which created the invite through the API with an `email` always sees the address it supplied. The invite still sends, resends and reports status when the email is null. 
     attr_accessor :email
 
     # Per-person only — the recipient's id (`usr_...`), when they are an existing user.
@@ -38,7 +50,7 @@ module WefunderGenerated
     # Per-person only — derived live, not stored. `pending` (sent, not yet opened), `opened` (link clicked), `invested` (a matching active investment exists), `revoked` (canceled). 
     attr_accessor :status
 
-    # Per-person only.
+    # Per-person only. The first click, not an email open (deprecated: use `first_clicked_at`, which has the same value). 
     attr_accessor :opened_at
 
     # Per-person only.
@@ -76,10 +88,14 @@ module WefunderGenerated
     def self.attribute_map
       {
         :'url' => :'url',
+        :'reuse' => :'reuse',
         :'allocation_cents' => :'allocation_cents',
         :'max_uses' => :'max_uses',
         :'uses_count' => :'uses_count',
+        :'click_count' => :'click_count',
+        :'first_clicked_at' => :'first_clicked_at',
         :'active' => :'active',
+        :'canceled_at' => :'canceled_at',
         :'created_at' => :'created_at',
         :'email' => :'email',
         :'wefunder_user_id' => :'wefunder_user_id',
@@ -100,10 +116,14 @@ module WefunderGenerated
     def self.openapi_types
       {
         :'url' => :'String',
+        :'reuse' => :'Boolean',
         :'allocation_cents' => :'Integer',
         :'max_uses' => :'Integer',
         :'uses_count' => :'Integer',
+        :'click_count' => :'Integer',
+        :'first_clicked_at' => :'Time',
         :'active' => :'Boolean',
+        :'canceled_at' => :'Time',
         :'created_at' => :'Time',
         :'email' => :'String',
         :'wefunder_user_id' => :'String',
@@ -118,8 +138,11 @@ module WefunderGenerated
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'url',
         :'allocation_cents',
         :'max_uses',
+        :'first_clicked_at',
+        :'canceled_at',
         :'email',
         :'wefunder_user_id',
         :'status',
@@ -148,6 +171,10 @@ module WefunderGenerated
         self.url = attributes[:'url']
       end
 
+      if attributes.key?(:'reuse')
+        self.reuse = attributes[:'reuse']
+      end
+
       if attributes.key?(:'allocation_cents')
         self.allocation_cents = attributes[:'allocation_cents']
       end
@@ -160,10 +187,22 @@ module WefunderGenerated
         self.uses_count = attributes[:'uses_count']
       end
 
+      if attributes.key?(:'click_count')
+        self.click_count = attributes[:'click_count']
+      end
+
+      if attributes.key?(:'first_clicked_at')
+        self.first_clicked_at = attributes[:'first_clicked_at']
+      end
+
       if attributes.key?(:'active')
         self.active = attributes[:'active']
       end
 
+      if attributes.key?(:'canceled_at')
+        self.canceled_at = attributes[:'canceled_at']
+      end
+
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
@@ -232,10 +271,14 @@ module WefunderGenerated
       return true if self.equal?(o)
       self.class == o.class &&
           url == o.url &&
+          reuse == o.reuse &&
           allocation_cents == o.allocation_cents &&
           max_uses == o.max_uses &&
           uses_count == o.uses_count &&
+          click_count == o.click_count &&
+          first_clicked_at == o.first_clicked_at &&
           active == o.active &&
+          canceled_at == o.canceled_at &&
           created_at == o.created_at &&
           email == o.email &&
           wefunder_user_id == o.wefunder_user_id &&
@@ -255,7 +298,7 @@ module WefunderGenerated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [url, allocation_cents, max_uses, uses_count, active, created_at, email, wefunder_user_id, status, opened_at, invested_at, investment_id, events].hash
+      [url, reuse, allocation_cents, max_uses, uses_count, click_count, first_clicked_at, active, canceled_at, created_at, email, wefunder_user_id, status, opened_at, invested_at, investment_id, events].hash
     end
 
     # Builds the object from hash

data/lib/wefunder_generated/models/invite_link_attributes_events_inner.rb

@@ -17,6 +17,9 @@ module WefunderGenerated
   class InviteLinkAttributesEventsInner
     attr_accessor :event
 
+    # The account that acted (`usr_...`): the sender of a `send` or `resend`, or a signed-in visitor's click. Null when anonymous. Never an email. 
+    attr_accessor :wefunder_user_id
+
     attr_accessor :city
 
     attr_accessor :country_code
@@ -27,6 +30,7 @@ module WefunderGenerated
     def self.attribute_map
       {
         :'event' => :'event',
+        :'wefunder_user_id' => :'wefunder_user_id',
         :'city' => :'city',
         :'country_code' => :'country_code',
         :'created_at' => :'created_at'
@@ -42,6 +46,7 @@ module WefunderGenerated
     def self.openapi_types
       {
         :'event' => :'String',
+        :'wefunder_user_id' => :'String',
         :'city' => :'String',
         :'country_code' => :'String',
         :'created_at' => :'Time'
@@ -51,6 +56,7 @@ module WefunderGenerated
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'wefunder_user_id',
         :'city',
         :'country_code',
       ])
@@ -75,6 +81,10 @@ module WefunderGenerated
         self.event = attributes[:'event']
       end
 
+      if attributes.key?(:'wefunder_user_id')
+        self.wefunder_user_id = attributes[:'wefunder_user_id']
+      end
+
       if attributes.key?(:'city')
         self.city = attributes[:'city']
       end
@@ -109,6 +119,7 @@ module WefunderGenerated
       return true if self.equal?(o)
       self.class == o.class &&
           event == o.event &&
+          wefunder_user_id == o.wefunder_user_id &&
           city == o.city &&
           country_code == o.country_code &&
           created_at == o.created_at
@@ -123,7 +134,7 @@ module WefunderGenerated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [event, city, country_code, created_at].hash
+      [event, wefunder_user_id, city, country_code, created_at].hash
     end
 
     # Builds the object from hash

data/lib/wefunder_generated/models/invite_link_envelope.rb

@@ -36,7 +36,7 @@ module WefunderGenerated
     def self.openapi_types
       {
         :'data' => :'InviteLink',
-        :'meta' => :'WebhookEndpointEnvelopeMeta'
+        :'meta' => :'ReferralCodeEnvelopeMeta'
       }
     end
 

data/lib/wefunder_generated/models/{full_attribution_status.rb → member_link.rb}

@@ -14,10 +14,13 @@ require 'date'
 require 'time'
 
 module WefunderGenerated
-  class FullAttributionStatus
-    attr_accessor :bucket
+  class MemberLink
+    # Opaque id (`il_` prefix today). Do not parse it.
+    attr_accessor :id
 
-    attr_accessor :progress_bar
+    attr_accessor :type
+
+    attr_accessor :attributes
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -44,8 +47,9 @@ module WefunderGenerated
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'bucket' => :'bucket',
-        :'progress_bar' => :'progress_bar'
+        :'id' => :'id',
+        :'type' => :'type',
+        :'attributes' => :'attributes'
       }
     end
 
@@ -57,8 +61,9 @@ module WefunderGenerated
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'bucket' => :'String',
-        :'progress_bar' => :'Boolean'
+        :'id' => :'String',
+        :'type' => :'String',
+        :'attributes' => :'MemberLinkAttributes'
       }
     end
 
@@ -72,23 +77,27 @@ 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::FullAttributionStatus` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `WefunderGenerated::MemberLink` 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::FullAttributionStatus`. 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::MemberLink`. 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?(:'bucket')
-        self.bucket = attributes[:'bucket']
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
       end
 
-      if attributes.key?(:'progress_bar')
-        self.progress_bar = attributes[:'progress_bar']
+      if attributes.key?(:'attributes')
+        self.attributes = attributes[:'attributes']
       end
     end
 
@@ -104,19 +113,19 @@ module WefunderGenerated
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      bucket_validator = EnumAttributeValidator.new('String', ["draft", "no_payment_yet", "pending", "is_ready", "confirmed", "canceled"])
-      return false unless bucket_validator.valid?(@bucket)
+      type_validator = EnumAttributeValidator.new('String', ["member_link"])
+      return false unless type_validator.valid?(@type)
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] bucket Object to be assigned
-    def bucket=(bucket)
-      validator = EnumAttributeValidator.new('String', ["draft", "no_payment_yet", "pending", "is_ready", "confirmed", "canceled"])
-      unless validator.valid?(bucket)
-        fail ArgumentError, "invalid value for \"bucket\", must be one of #{validator.allowable_values}."
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["member_link"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end
-      @bucket = bucket
+      @type = type
     end
 
     # Checks equality by comparing each attribute.
@@ -124,8 +133,9 @@ module WefunderGenerated
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          bucket == o.bucket &&
-          progress_bar == o.progress_bar
+          id == o.id &&
+          type == o.type &&
+          attributes == o.attributes
     end
 
     # @see the `==` method
@@ -137,7 +147,7 @@ module WefunderGenerated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [bucket, progress_bar].hash
+      [id, type, attributes].hash
     end
 
     # Builds the object from hash