wefunder 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f82d3280df8bafaa7518ab69f7af96d3bdfb1a2e253b6b6fb22794f65d40c701
-  data.tar.gz: ff14e7f509d6868ed74b89beefd709cc7b9f30d84a5fdb54a7490193babfa8e5
+  metadata.gz: dc048e16fefefd8990b541796babbd387abc54f4e02f64af2c742ae31e45b375
+  data.tar.gz: e4595cd74e1b0fc03d20cb0b564d68d28deaedf56b600cc4e0cdcc07978edb5e
 SHA512:
-  metadata.gz: 669cdc32cae0a4218a827efdc5418d8060fc6667b6c7b7c1ecef0405c232eaa37935e32ec6970b233ccc8e43e4638d447fcc7fec2eb61e9d8e53d9732972a941
-  data.tar.gz: 708b4b330bf19f2ab9af55369576ac2a30e7ca7a1a9a7d989a5ee353869f46ca0162c2f7271e801650c601d64a0a2d2b21d85a8eeb76c8798c840d06e2755eba
+  metadata.gz: ab861d9306c4247e365fa1eef24f50d90efdb80375a22a33ad6b1f6f89c0091566c2059bea111400ca9377bff1dcd5fc01d53427f28a4e1cfb82641aea16b343
+  data.tar.gz: '08489fc8cb90890feebdb951227e008693d97b498ab5b5791312fbf27a4cd09237cb215cce8ed7523eec6f0c7d3e73ccc4d8b54b63a0efa768e4fc555c1c6eca'

data/README.md

@@ -1,7 +1,6 @@
 # wefunder
 
-Official Ruby SDK for the [Wefunder API](https://docs.wefunder.com). **Beta** — the API is pre-launch
-and `0.x` releases may include breaking changes.
+Official Ruby SDK for the [Wefunder API](https://docs.wefunder.com).
 
 - A `Wefunder::Client` on [Faraday](https://lostisland.github.io/faraday/) with a generated, typed
   layer for every public operation
@@ -94,6 +93,15 @@ Concurrent requests that hit a 401 at the same time share one refresh (the clien
 If several application instances can use the same OAuth connection, serialize refreshes for that
 connection yourself.
 
+## API version
+
+The SDK sends `Wefunder-Version: 2026-10-15` on every request (`DEFAULT_API_VERSION`); pass
+`api_version:` to pin an older one. 1.1.0 moved the default from the pre-launch `2025-01-15` alias:
+`GET /activity` and the syndicate deal `close` / `finalize` operations (and the
+`syndicates.close_deal` / `finalize_deal` intent actions) are not part of 2026-10-15, so their
+generated methods are gone; the legacy Attribution and attribution-webhook operations, removed
+from the API on 2026-10-14, left with them (`wf.attribution` is gone; use `wf.referral_codes`).
+
 ## Calling the API
 
 ```ruby
@@ -103,13 +111,22 @@ portfolio = wf.portfolio.get
 ```
 
 Namespaces: `users`, `offerings`, `investments`, `portfolio`, `campaigns`, `syndicates`, `intents`,
-`attribution`, `installations`, and `webhook_endpoints`. Query parameters are keyword arguments;
+`installations`, `member_links`, `referral_codes`, `join_sessions`, `investment_sessions`, and
+`webhook_endpoints`. Query parameters are keyword arguments;
 enum-typed ones take plain strings, and `Time` / `DateTime` / `Date` values are sent as ISO 8601.
 
 `wf.installations` lets your app act as a company or syndicate: `eligible_targets`, `create`,
 `mint_token`, `list`, `get`, `revoke`, and `install_or_mint_token`, which handles the API's 409
 `already_installed` answer by minting a token for the existing install with the same scopes.
 
+`wf.member_links` mints your app's per-person links to one deal page and reports what each member did
+(`list`, `all`, `create`, `get`, `cancel`; needs a company- or syndicate-owned token). `wf.referral_codes`
+(beta) creates codes with your server key and reads per-company stats (`list`, `all`, `get`, `create`,
+`update`, `stats`). `wf.join_sessions` (beta) mints hosted syndicate join sessions (`list`, `all`, `get`,
+`create`; the API publishes no schema for these yet, so they come back as string-keyed Hashes), and
+`wf.investment_sessions` (beta) puts a known investor straight into checkout for one offering (`list`,
+`all`, `list_for_offering`, `all_for_offering`, `get`, `create`, `cancel`).
+
 `wf.investments` is the Investment Delta API. `list` without a cursor bootstraps; pass `updated_since:`
 or the `meta.next_cursor` you saved from your last page to receive only records that changed since then.
 `next_cursor` is always present, even on the final page, so persist it after every sync.
@@ -138,16 +155,20 @@ API failures raise `Wefunder::Error`:
 
 ```ruby
 begin
-  wf.syndicates.get("syn_example")
+  wf.syndicates.get("syn_aB3xQ9k2vF8mNp1zT5wY7Qc4")
 rescue Wefunder::Error => e
   puts e.status, e.type, e.message, e.request_id, e.remediation
 end
 ```
 
-The SDK retries idempotent `GET` requests after transient network errors, `5xx` responses, and rate
-limits (honouring `X-RateLimit-Reset`). Write requests are not retried automatically, except once after
-a `401` has been recovered. Exhausted network failures raise `Wefunder::Error` with `status` 0 and
-`type` `"network_error"`, from namespaces and `request` alike.
+Retries are bounded (`retry_options:` `max_retries`, default 2) and differ by failure: a `429` is
+retried for any method after waiting out `X-RateLimit-Reset`; transient network errors and `5xx`
+responses are retried only for idempotent methods (`GET`, `HEAD`, `OPTIONS`); a `401` is recovered
+once, for any method, by refreshing or re-minting the token and resending. Size request timeouts with
+the rate-limit wait in mind, since rate limiting alone can attempt a write up to three times, and the
+one-time 401 recovery can add one more. Exhausted
+network failures raise `Wefunder::Error` with `status` 0 and `type` `"network_error"`, from namespaces
+and `request` alike.
 
 `timeout:` (seconds, default 30) applies to every request the client makes: API calls, `request`, and
 the OAuth token round-trips for refresh and re-mint.
@@ -223,7 +244,7 @@ generated under `WefunderGenerated::<Tag>Api` and reachable through `wf.raw.<tag
 the same auth, retries, and typed errors:
 
 ```ruby
-members = wf.wrap { wf.raw.syndicate_members.list_syndicate_members("syn_example") }
+members = wf.wrap { wf.raw.syndicate_members.list_syndicate_members("syn_aB3xQ9k2vF8mNp1zT5wY7Qc4") }
 ```
 
 For a path the generated layer does not know yet, `wf.request(:get, path, query:, body:, headers:)`
@@ -269,12 +290,13 @@ Commit the specification and generated client together.
 
 ### Releasing
 
-Set the version in `lib/wefunder/version.rb` (e.g. `0.1.0.beta2`), rebuild `examples_manifest.json`,
-commit, then:
+Set the version in `lib/wefunder/version.rb` (e.g. `1.1.0`; a prerelease is `1.2.0.beta1`), run
+`bundle install` so `Gemfile.lock` follows, rebuild `examples_manifest.json`, commit, then:
 
 ```bash
-git tag v0.1.0.beta2
-git push --follow-tags
+git push origin main
+git tag v1.1.0
+git push origin v1.1.0      # push the tag explicitly: `--follow-tags` only pushes annotated tags
 ```
 
 The release workflow verifies the tag, runs the checks, and publishes to RubyGems via trusted publishing.

data/lib/wefunder/client.rb

@@ -9,7 +9,7 @@ module Wefunder
   # Version-free base — the edge gateway serves the API at the host root; +/api/v2+ remains a
   # back-compat alias. The API version is pinned via the +Wefunder-Version+ header, not the path.
   DEFAULT_API_BASE_URL = "https://api.wefunder.com"
-  DEFAULT_API_VERSION = "2025-01-15"
+  DEFAULT_API_VERSION = "2026-10-15"
   API_VERSION_HEADER = "Wefunder-Version"
 
   # "live" / "test" from the access-token prefix. UX only — never used for routing.
@@ -26,7 +26,8 @@ module Wefunder
   # typed-error unwrapping, and lazy auto-pagination. +raw+ exposes every generated API.
   class Client
     attr_reader :mode, :users, :offerings, :investments, :portfolio, :campaigns, :syndicates, :intents,
-                :attribution, :installations, :webhook_endpoints
+                :installations, :member_links, :referral_codes, :join_sessions, :investment_sessions,
+                :webhook_endpoints
 
     def initialize(access_token: nil, tokens: nil, client_id: nil, client_secret: nil, client_credentials: nil,
                    api_version: DEFAULT_API_VERSION, base_url: DEFAULT_API_BASE_URL, authorize_base_url: nil,
@@ -52,8 +53,11 @@ module Wefunder
       @campaigns = Campaigns.new(self)
       @syndicates = Syndicates.new(self)
       @intents = Intents.new(self)
-      @attribution = Attribution.new(self)
       @installations = Installations.new(self)
+      @member_links = MemberLinks.new(self)
+      @referral_codes = ReferralCodes.new(self)
+      @join_sessions = JoinSessions.new(self)
+      @investment_sessions = InvestmentSessions.new(self)
       @webhook_endpoints = WebhookEndpoints.new(self)
     end
 
@@ -166,13 +170,14 @@ module Wefunder
     # Lazily-built generated API instances, one per tag.
     class Raw
       APIS = {
-        activity: "ActivityApi", attribution: "AttributionApi", attribution_partners: "AttributionPartnersApi",
-        attribution_webhooks: "AttributionWebhooksApi", campaigns: "CampaignsApi", companies: "CompaniesApi",
-        explore: "ExploreApi", installations: "InstallationsApi", intents: "IntentsApi",
-        investment_delta: "InvestmentDeltaApi", investments: "InvestmentsApi", portfolio: "PortfolioApi",
-        syndicate_deals: "SyndicateDealsApi", syndicate_members: "SyndicateMembersApi",
-        syndicate_portfolio: "SyndicatePortfolioApi", syndicate_statistics: "SyndicateStatisticsApi",
-        syndicates: "SyndicatesApi", users: "UsersApi", webhook_endpoints: "WebhookEndpointsApi"
+        activity: "ActivityApi", campaigns: "CampaignsApi", companies: "CompaniesApi", explore: "ExploreApi",
+        installations: "InstallationsApi", intents: "IntentsApi", investment_delta: "InvestmentDeltaApi",
+        investments: "InvestmentsApi", member_links: "MemberLinksApi",
+        partner_invites_sessions: "PartnerInvitesSessionsApi", portfolio: "PortfolioApi",
+        referral_codes: "ReferralCodesApi", syndicate_deals: "SyndicateDealsApi",
+        syndicate_members: "SyndicateMembersApi", syndicate_portfolio: "SyndicatePortfolioApi",
+        syndicate_statistics: "SyndicateStatisticsApi", syndicates: "SyndicatesApi", users: "UsersApi",
+        webhook_endpoints: "WebhookEndpointsApi"
       }.freeze
 
       def initialize(api_client)
@@ -272,8 +277,118 @@ module Wefunder
       def preview(body) = data_of(wrap { raw.intents.preview_intent(WefunderGenerated::PreviewIntentRequest.new(body)) })
     end
 
-    class Attribution < Namespace
-      def me = data_of(wrap { raw.attribution_partners.get_attribution_me })
+    # /syndicates/{id}/join_sessions (write:syndicate_members to mint, read:syndicates to read; beta).
+    # Mint a hosted session for an email, send the person to +attributes["url"]+, and learn the
+    # outcome from +get+ or the +join_session.*+ webhooks. The spec publishes no response schema for
+    # these yet, so sessions come back as plain Hashes.
+    class JoinSessions < Namespace
+      def list(syndicate_id, **opts)
+        strings(wrap { raw.syndicate_members.list_syndicate_join_sessions(syndicate_id, norm(opts)) })
+      end
+
+      def all(syndicate_id, **opts)
+        sessions = pages(opts) { |o| raw.syndicate_members.list_syndicate_join_sessions(syndicate_id, o) }
+        Enumerator.new { |y| sessions.each { |session| y << strings(session) } }
+      end
+
+      def get(syndicate_id, session_id)
+        strings(data_of(wrap { raw.syndicate_members.get_syndicate_join_session(syndicate_id, session_id) }))
+      end
+
+      # Mint a session for one person (+email:+ required). Needs a manager's user token or the syndicate's own.
+      def create(syndicate_id, **attrs)
+        body = WefunderGenerated::CreateSyndicateJoinSessionRequest.new(
+          join_session: WefunderGenerated::CreateSyndicateJoinSessionRequestJoinSession.new(attrs)
+        )
+        strings(data_of(wrap { raw.syndicate_members.create_syndicate_join_session(syndicate_id, body) }))
+      end
+
+      private
+
+      # The generated client parses an untyped +object+ response with symbol keys; hand it back the
+      # way the documented examples read it (+session["attributes"]["url"]+).
+      def strings(obj) = JSON.parse(JSON.generate(obj))
+    end
+
+    # /offerings/{id}/investment_sessions and /investment_sessions (read:investment_sessions /
+    # write:investment_sessions; beta). A session puts a known investor straight into checkout for one
+    # offering and tracks that one investment.
+    class InvestmentSessions < Namespace
+      # Every session your app created, across offerings; the envelope.
+      def list(**opts) = wrap { raw.partner_invites_sessions.list_investment_sessions(norm(opts)) }
+      def all(**opts) = pages(opts) { |o| raw.partner_invites_sessions.list_investment_sessions(o) }
+
+      def list_for_offering(offering_id, **opts)
+        wrap { raw.partner_invites_sessions.list_offering_investment_sessions(offering_id, norm(opts)) }
+      end
+
+      def all_for_offering(offering_id, **opts)
+        pages(opts) { |o| raw.partner_invites_sessions.list_offering_investment_sessions(offering_id, o) }
+      end
+
+      def get(session_id) = data_of(wrap { raw.partner_invites_sessions.get_investment_session(session_id) })
+
+      # Create a session on an offering; +idempotency_key:+ makes a retry safe.
+      def create(offering_id, idempotency_key: nil, **attrs)
+        body = WefunderGenerated::CreateOfferingInvestmentSessionRequest.new(
+          investment_session: WefunderGenerated::InvestmentSessionCreateInput.new(attrs)
+        )
+        opts = idempotency_key ? { idempotency_key: idempotency_key } : {}
+        data_of(wrap { raw.partner_invites_sessions.create_offering_investment_session(offering_id, body, opts) })
+      end
+
+      # Cancel a session the recipient has not completed.
+      def cancel(session_id) = data_of(wrap { raw.partner_invites_sessions.cancel_investment_session(session_id) })
+    end
+
+    # /offerings/{id}/member_links and /member_links/{id} (read:invite_links / write:invite_links):
+    # your app's per-person links that send a member to one deal page and report what they did.
+    # Needs a company- or syndicate-owned token of an app installed on the offering's syndicate or
+    # company; a user token gets 404.
+    class MemberLinks < Namespace
+      # One page of the offering's links; the envelope.
+      def list(offering_id, **opts) = wrap { raw.member_links.list_offering_member_links(offering_id, norm(opts)) }
+      def all(offering_id) = pages({}) { |o| raw.member_links.list_offering_member_links(offering_id, o) }
+
+      # Mint a link (+reference:+, optional +wefunder_user_id:+). Repeating a +reference+ returns the
+      # live link instead of a second one; +idempotency_key:+ makes a retried request safe as well.
+      def create(offering_id, idempotency_key: nil, **attrs)
+        opts = {}
+        opts[:idempotency_key] = idempotency_key if idempotency_key
+        unless attrs.empty?
+          opts[:create_offering_member_link_request] =
+            WefunderGenerated::CreateOfferingMemberLinkRequest.new(member_link: WefunderGenerated::MemberLinkCreateInput.new(attrs))
+        end
+        data_of(wrap { raw.member_links.create_offering_member_link(offering_id, opts) })
+      end
+
+      def get(link_id) = data_of(wrap { raw.member_links.get_member_link(link_id) })
+      # Stop an unused link from opening the deal page.
+      def cancel(link_id) = data_of(wrap { raw.member_links.cancel_member_link(link_id) })
+    end
+
+    # /referral_codes (read:referral_codes / write:referral_codes; beta). Mint with your app's server
+    # key, add +?wfr=ref_…+ to any wefunder.com link, and read +stats+. What +stats+ shows per company
+    # depends on its +level+: +counts+ is weekly cohorts (+weeks+), +anonymized+ is per-investment rows
+    # with opaque tokens (+investments+), and +full+, for an app installed on the company with a
+    # founder-tier grant, carries investor names and emails.
+    class ReferralCodes < Namespace
+      def list(**opts) = wrap { raw.referral_codes.list_referral_codes(norm(opts)) }
+      def all(**opts) = pages(opts) { |o| raw.referral_codes.list_referral_codes(o) }
+      def get(code_id) = data_of(wrap { raw.referral_codes.get_referral_code(code_id) })
+
+      # Not idempotent: a retried create can mint a second code, which you can deactivate.
+      def create(**attrs)
+        data_of(wrap { raw.referral_codes.create_referral_code(WefunderGenerated::CreateReferralCodeRequest.new(attrs)) })
+      end
+
+      def update(code_id, **changes)
+        body = WefunderGenerated::UpdateReferralCodeRequest.new(changes)
+        data_of(wrap { raw.referral_codes.update_referral_code(code_id, body) })
+      end
+
+      # Weekly cohorts per company; the envelope (+meta.next_cursor+ pages the company list).
+      def stats(code_id, **opts) = wrap { raw.referral_codes.get_referral_code_stats(code_id, norm(opts)) }
     end
 
     # /installations (read:installations / write:installations; write does not imply read). An

data/lib/wefunder/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Wefunder
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/wefunder/webhooks.rb

@@ -36,12 +36,15 @@ module Wefunder
     # spec/webhooks_spec.rb, which fails when the two diverge.
     EVENT_NAMES = %w[
       investment.created investment.reinstated investment.canceled investment.converted
-      investment.amount_changed investment.executed investment.changed
+      investment.amount_changed investment.executed investment.changed investment.referred
       offering.opened offering.closing offering.closed offering.canceled
       investment_session.created investment_session.started investment_session.completed
       investment_session.expired investment_session.canceled
       syndicate_member.invited syndicate_member.reinvited syndicate_member.applied
-      syndicate_member.approved syndicate_member.joined
+      syndicate_member.approved syndicate_member.joined syndicate_member.left syndicate_member.declined
+      join_session.pending_approval join_session.completed join_session.rejected join_session.ineligible
+      join_session.canceled join_session.expired
+      installation.created installation.revoked referral_cohorts.published
     ].freeze
 
     # Raised by +construct_event+. Respond 400 and don't process.

data/lib/wefunder_generated/api/activity_api.rb

@@ -19,98 +19,6 @@ module WefunderGenerated
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # List activity events
-    # Returns actions taken by OAuth apps authorized by the current user. This is the API backing the user-facing activity feed at Settings > Activity. 
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :app_id Filter by connected app
-    # @option opts [String] :action_pattern Filter by action pattern (e.g. syndicates.* or syndicates.member.*)
-    # @option opts [String] :resource_type Filter by resource type (e.g. Club). Must be used with resource_id.
-    # @option opts [String] :resource_id Filter by specific resource ID. Must be used with resource_type. For Club resources, pass the syndicate's id (`syn_...`). 
-    # @option opts [String] :status 
-    # @option opts [Time] :since 
-    # @option opts [Time] :_until 
-    # @option opts [String] :cursor Opaque cursor from the previous response's `meta.next_cursor`.
-    # @option opts [Integer] :per_page  (default to 25)
-    # @return [AuditEventListEnvelope]
-    def list_activity(opts = {})
-      data, _status_code, _headers = list_activity_with_http_info(opts)
-      data
-    end
-
-    # List activity events
-    # Returns actions taken by OAuth apps authorized by the current user. This is the API backing the user-facing activity feed at Settings > Activity. 
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :app_id Filter by connected app
-    # @option opts [String] :action_pattern Filter by action pattern (e.g. syndicates.* or syndicates.member.*)
-    # @option opts [String] :resource_type Filter by resource type (e.g. Club). Must be used with resource_id.
-    # @option opts [String] :resource_id Filter by specific resource ID. Must be used with resource_type. For Club resources, pass the syndicate's id (`syn_...`). 
-    # @option opts [String] :status 
-    # @option opts [Time] :since 
-    # @option opts [Time] :_until 
-    # @option opts [String] :cursor Opaque cursor from the previous response's `meta.next_cursor`.
-    # @option opts [Integer] :per_page  (default to 25)
-    # @return [Array<(AuditEventListEnvelope, Integer, Hash)>] AuditEventListEnvelope data, response status code and response headers
-    def list_activity_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: ActivityApi.list_activity ...'
-      end
-      allowable_values = ["success", "failure", "denied"]
-      if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
-        fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
-      end
-      if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
-        fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling ActivityApi.list_activity, must be smaller than or equal to 100.'
-      end
-
-      # resource path
-      local_var_path = '/activity'
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'app_id'] = opts[:'app_id'] if !opts[:'app_id'].nil?
-      query_params[:'action_pattern'] = opts[:'action_pattern'] if !opts[:'action_pattern'].nil?
-      query_params[:'resource_type'] = opts[:'resource_type'] if !opts[:'resource_type'].nil?
-      query_params[:'resource_id'] = opts[:'resource_id'] if !opts[:'resource_id'].nil?
-      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
-      query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
-      query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
-      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
-      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
-
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:debug_body]
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'AuditEventListEnvelope'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth', 'bearerAuth']
-
-      new_options = opts.merge(
-        :operation => :"ActivityApi.list_activity",
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => return_type
-      )
-
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: ActivityApi#list_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # List connected apps
     # Returns all OAuth apps the user has authorized, with summary stats.
     # @param [Hash] opts the optional parameters

data/lib/wefunder_generated/api/explore_api.rb

@@ -20,7 +20,7 @@ module WefunderGenerated
       @api_client = api_client
     end
     # Get a company page
-    # The company page behind an offering, as structured data — the \"click a company\" step after `/explore`. Addressed by the `co_...` id every offering carries in `company.id`.  Keeps apart the three raised numbers the page shows and readers conflate: `current_raise.amount_raised` (this campaign's live rounds combined, on Wefunder), `past_rounds[]` (prior rounds the page lists, each tagged `source: wefunder` for rounds observed here or `reported` for founder-disclosed off-platform rounds), and `totals.profile_total_raised` (the number on the page's ticker bar). Every figure comes from the same policy the page uses, so the API never disagrees with the site.  **Who has a page.** Every company whose profile wefunder.com lists publicly — the same set the site's search bar returns (published, not invite-only, searchable or with a live Form C; accredited-only companies need an accredited viewer) — plus the `/explore` set. A funded company, or one the viewer may see no round of, renders with `raising: false` and `current_raise: null`; its history is in `wefunder_rounds`. **Logged-in view (`read:explore`)** additionally covers the vault / syndicate-led companies the site shows an accredited viewer, and the round described is the one the page would show that viewer. A valid id for a company outside the viewer's set is a `404`, never a partial payload. 
+    # The company page behind an offering, as structured data — the \"click a company\" step after `/explore`. Addressed by the `co_...` id every offering carries in its top-level `company` field (a bare string).  Keeps apart the three raised numbers the page shows and readers conflate: `current_raise.amount_raised` (this campaign's live rounds combined, on Wefunder), `past_rounds[]` (prior rounds the page lists, each tagged `source: wefunder` for rounds observed here or `reported` for founder-disclosed off-platform rounds), and `totals.profile_total_raised` (the number on the page's ticker bar). Every figure comes from the same policy the page uses, so the API never disagrees with the site.  **Who has a page.** Every company whose profile wefunder.com lists publicly — the same set the site's search bar returns (published, not invite-only, searchable or with a live Form C; accredited-only companies need an accredited viewer) — plus the `/explore` set. A funded company, or one the viewer may see no round of, renders with `raising: false` and `current_raise: null`; its history is in `wefunder_rounds`. **Logged-in view (`read:explore`)** additionally covers the vault / syndicate-led companies the site shows an accredited viewer, and the round described is the one the page would show that viewer. A valid id for a company outside the viewer's set is a `404`, never a partial payload. 
     # @param id [String] The company's id (`co_...`).
     # @param [Hash] opts the optional parameters
     # @return [CompanyEnvelope]
@@ -30,7 +30,7 @@ module WefunderGenerated
     end
 
     # Get a company page
-    # The company page behind an offering, as structured data — the \"click a company\" step after `/explore`. Addressed by the `co_...` id every offering carries in `company.id`.  Keeps apart the three raised numbers the page shows and readers conflate: `current_raise.amount_raised` (this campaign's live rounds combined, on Wefunder), `past_rounds[]` (prior rounds the page lists, each tagged `source: wefunder` for rounds observed here or `reported` for founder-disclosed off-platform rounds), and `totals.profile_total_raised` (the number on the page's ticker bar). Every figure comes from the same policy the page uses, so the API never disagrees with the site.  **Who has a page.** Every company whose profile wefunder.com lists publicly — the same set the site's search bar returns (published, not invite-only, searchable or with a live Form C; accredited-only companies need an accredited viewer) — plus the `/explore` set. A funded company, or one the viewer may see no round of, renders with `raising: false` and `current_raise: null`; its history is in `wefunder_rounds`. **Logged-in view (`read:explore`)** additionally covers the vault / syndicate-led companies the site shows an accredited viewer, and the round described is the one the page would show that viewer. A valid id for a company outside the viewer's set is a `404`, never a partial payload. 
+    # The company page behind an offering, as structured data — the \"click a company\" step after `/explore`. Addressed by the `co_...` id every offering carries in its top-level `company` field (a bare string).  Keeps apart the three raised numbers the page shows and readers conflate: `current_raise.amount_raised` (this campaign's live rounds combined, on Wefunder), `past_rounds[]` (prior rounds the page lists, each tagged `source: wefunder` for rounds observed here or `reported` for founder-disclosed off-platform rounds), and `totals.profile_total_raised` (the number on the page's ticker bar). Every figure comes from the same policy the page uses, so the API never disagrees with the site.  **Who has a page.** Every company whose profile wefunder.com lists publicly — the same set the site's search bar returns (published, not invite-only, searchable or with a live Form C; accredited-only companies need an accredited viewer) — plus the `/explore` set. A funded company, or one the viewer may see no round of, renders with `raising: false` and `current_raise: null`; its history is in `wefunder_rounds`. **Logged-in view (`read:explore`)** additionally covers the vault / syndicate-led companies the site shows an accredited viewer, and the round described is the one the page would show that viewer. A valid id for a company outside the viewer's set is a `404`, never a partial payload. 
     # @param id [String] The company's id (`co_...`).
     # @param [Hash] opts the optional parameters
     # @return [Array<(CompanyEnvelope, Integer, Hash)>] CompanyEnvelope data, response status code and response headers
@@ -521,10 +521,12 @@ module WefunderGenerated
     end
 
     # List public offerings
-    # Returns the offerings shown on wefunder.com/explore — the curated set of companies that meet Wefunder's discoverability bar (a soft-confirmed traction threshold plus approval), **one offering per company**. An \"offering\" is a fundraise, addressed by its id (`ofr_...`).  **Public view (`read:public`).** Reachable with either a server-side (client_credentials) token or a user access token. Private rounds (e.g. Reg D 506(b)) are never listed, and low-traction or unapproved companies are excluded — exactly as they are on the website for a logged-out visitor.  **Logged-in view (`read:explore`).** A user access token carrying `read:explore` gets what *that user* sees on wefunder.com/explore: the public offerings plus any the user qualifies for (accredited-only / Vault deals, invited private rounds), each checked against the same visibility policy the website applies. The response is a strict superset of the public one — same fields and ids — with two extra attributes, `publicly_visible` and `invested`, and `meta.personalized: true`. A server-side key can never hold `read:explore`; a token with `read:explore` but no resolvable user gets the public view.  Order with `sort` (default: most raised); paginate with `cursor`. `meta.total_count` is the number of offerings across all pages, after filters.  **Filters** are objective, per-offering terms — exemption family, security type, TTW vs. live, minimum investment ceiling, close date, amount raised floor. The response echoes the applied set in `meta.filters`. An out-of-vocabulary value is a `400` naming the accepted values. There are deliberately no relevance, quality, or ranking criteria.  Use this endpoint to: - Discover and monitor active deals - Build deal aggregators and public listings 
+    # Returns the offerings shown on wefunder.com/explore — the curated set of companies that meet Wefunder's discoverability bar (a soft-confirmed traction threshold plus approval), **one offering per company**. An \"offering\" is a fundraise, addressed by its id (`ofr_...`).  **Public view (`read:public`).** Reachable with either a server-side (client_credentials) token or a user access token. Private rounds (e.g. Reg D 506(b)) are never listed, and low-traction or unapproved companies are excluded — exactly as they are on the website for a logged-out visitor.  **Logged-in view (`read:explore`).** A user access token carrying `read:explore` gets what *that user* sees on wefunder.com/explore: the public offerings plus any the user qualifies for (accredited-only / Vault deals, invited private rounds), each checked against the same visibility policy the website applies. The response is a strict superset of the public one — same fields and ids — with two extra attributes, `publicly_visible` and `invested`, and `meta.personalized: true`. A server-side key can never hold `read:explore`; a token with `read:explore` but no resolvable user gets the public view.  Order with `sort` (default: most raised); paginate with `cursor` and `per_page`. `meta.total_count` is the number of offerings across all pages, after filters.  **Closed rounds (`status`).** By default the list is live rounds. `status=closed` lists rounds that finished raising instead, newest `closed_at` first. It is not limited to one per company or to the curated explore set: it covers every finished round that `GET /offerings/{id}` serves to a logged-out visitor, for companies listed in Wefunder's public directory. `status=all` returns the live list first, then the closed list. With `status=closed` or `status=all`, `exemption` is the only filter accepted, and `sort` orders only the live part. Closed rounds follow the public view even for a `read:explore` token.  **Filters** are objective, per-offering terms — exemption family, security type, TTW vs. live, minimum investment ceiling, close date, amount raised floor. The response echoes the applied set in `meta.filters`. An out-of-vocabulary value is a `400` naming the accepted values. There are deliberately no relevance, quality, or ranking criteria.  Use this endpoint to: - Discover and monitor active deals - Build deal aggregators and public listings - Bulk-list closed rounds (`status=closed`) 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :cursor Cursor-based pagination token. Use the &#x60;next_cursor&#x60; value from the previous response&#39;s &#x60;meta&#x60; object to retrieve the next page of results. Omit this parameter to retrieve the first page. 
-    # @option opts [String] :sort Result ordering: - &#x60;most_raised&#x60; (default) — highest amount raised first - &#x60;closing_soon&#x60; — soonest funding close first - &#x60;newest&#x60; — most recently launched first - &#x60;most_investors&#x60; — highest investor count first  (default to 'most_raised')
+    # @option opts [Integer] :per_page Offerings per page. (default to 25)
+    # @option opts [String] :status Which rounds to list: - &#x60;live&#x60; (default): rounds accepting investments or reservations, as on wefunder.com/explore - &#x60;closed&#x60;: rounds that finished raising, newest &#x60;closed_at&#x60; first (id breaks ties) - &#x60;all&#x60;: the live list, then the closed list  Any other value is a &#x60;400&#x60;.  (default to 'live')
+    # @option opts [String] :sort Ordering of live rounds. A &#x60;400&#x60; with &#x60;status&#x3D;closed&#x60;; with &#x60;status&#x3D;all&#x60; it orders the live part only. - &#x60;most_raised&#x60; (default) — highest amount raised first - &#x60;closing_soon&#x60; — soonest funding close first - &#x60;newest&#x60; — most recently launched first - &#x60;most_investors&#x60; — highest investor count first  (default to 'most_raised')
     # @option opts [String] :exemption Only offerings under this SEC exemption family. Reg CF and Reg D are the supported public filters.
     # @option opts [String] :security Only offerings issuing this kind of security — the &#x60;security.type&#x60; value on results.
     # @option opts [Boolean] :testing_the_waters &#x60;false&#x60; — only live rounds accepting investments; &#x60;true&#x60; — only Testing-the-Waters rounds collecting non-binding reservations.
@@ -541,10 +543,12 @@ module WefunderGenerated
     end
 
     # List public offerings
-    # Returns the offerings shown on wefunder.com/explore — the curated set of companies that meet Wefunder&#39;s discoverability bar (a soft-confirmed traction threshold plus approval), **one offering per company**. An \&quot;offering\&quot; is a fundraise, addressed by its id (&#x60;ofr_...&#x60;).  **Public view (&#x60;read:public&#x60;).** Reachable with either a server-side (client_credentials) token or a user access token. Private rounds (e.g. Reg D 506(b)) are never listed, and low-traction or unapproved companies are excluded — exactly as they are on the website for a logged-out visitor.  **Logged-in view (&#x60;read:explore&#x60;).** A user access token carrying &#x60;read:explore&#x60; gets what *that user* sees on wefunder.com/explore: the public offerings plus any the user qualifies for (accredited-only / Vault deals, invited private rounds), each checked against the same visibility policy the website applies. The response is a strict superset of the public one — same fields and ids — with two extra attributes, &#x60;publicly_visible&#x60; and &#x60;invested&#x60;, and &#x60;meta.personalized: true&#x60;. A server-side key can never hold &#x60;read:explore&#x60;; a token with &#x60;read:explore&#x60; but no resolvable user gets the public view.  Order with &#x60;sort&#x60; (default: most raised); paginate with &#x60;cursor&#x60;. &#x60;meta.total_count&#x60; is the number of offerings across all pages, after filters.  **Filters** are objective, per-offering terms — exemption family, security type, TTW vs. live, minimum investment ceiling, close date, amount raised floor. The response echoes the applied set in &#x60;meta.filters&#x60;. An out-of-vocabulary value is a &#x60;400&#x60; naming the accepted values. There are deliberately no relevance, quality, or ranking criteria.  Use this endpoint to: - Discover and monitor active deals - Build deal aggregators and public listings 
+    # Returns the offerings shown on wefunder.com/explore — the curated set of companies that meet Wefunder&#39;s discoverability bar (a soft-confirmed traction threshold plus approval), **one offering per company**. An \&quot;offering\&quot; is a fundraise, addressed by its id (&#x60;ofr_...&#x60;).  **Public view (&#x60;read:public&#x60;).** Reachable with either a server-side (client_credentials) token or a user access token. Private rounds (e.g. Reg D 506(b)) are never listed, and low-traction or unapproved companies are excluded — exactly as they are on the website for a logged-out visitor.  **Logged-in view (&#x60;read:explore&#x60;).** A user access token carrying &#x60;read:explore&#x60; gets what *that user* sees on wefunder.com/explore: the public offerings plus any the user qualifies for (accredited-only / Vault deals, invited private rounds), each checked against the same visibility policy the website applies. The response is a strict superset of the public one — same fields and ids — with two extra attributes, &#x60;publicly_visible&#x60; and &#x60;invested&#x60;, and &#x60;meta.personalized: true&#x60;. A server-side key can never hold &#x60;read:explore&#x60;; a token with &#x60;read:explore&#x60; but no resolvable user gets the public view.  Order with &#x60;sort&#x60; (default: most raised); paginate with &#x60;cursor&#x60; and &#x60;per_page&#x60;. &#x60;meta.total_count&#x60; is the number of offerings across all pages, after filters.  **Closed rounds (&#x60;status&#x60;).** By default the list is live rounds. &#x60;status&#x3D;closed&#x60; lists rounds that finished raising instead, newest &#x60;closed_at&#x60; first. It is not limited to one per company or to the curated explore set: it covers every finished round that &#x60;GET /offerings/{id}&#x60; serves to a logged-out visitor, for companies listed in Wefunder&#39;s public directory. &#x60;status&#x3D;all&#x60; returns the live list first, then the closed list. With &#x60;status&#x3D;closed&#x60; or &#x60;status&#x3D;all&#x60;, &#x60;exemption&#x60; is the only filter accepted, and &#x60;sort&#x60; orders only the live part. Closed rounds follow the public view even for a &#x60;read:explore&#x60; token.  **Filters** are objective, per-offering terms — exemption family, security type, TTW vs. live, minimum investment ceiling, close date, amount raised floor. The response echoes the applied set in &#x60;meta.filters&#x60;. An out-of-vocabulary value is a &#x60;400&#x60; naming the accepted values. There are deliberately no relevance, quality, or ranking criteria.  Use this endpoint to: - Discover and monitor active deals - Build deal aggregators and public listings - Bulk-list closed rounds (&#x60;status&#x3D;closed&#x60;) 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :cursor Cursor-based pagination token. Use the &#x60;next_cursor&#x60; value from the previous response&#39;s &#x60;meta&#x60; object to retrieve the next page of results. Omit this parameter to retrieve the first page. 
-    # @option opts [String] :sort Result ordering: - &#x60;most_raised&#x60; (default) — highest amount raised first - &#x60;closing_soon&#x60; — soonest funding close first - &#x60;newest&#x60; — most recently launched first - &#x60;most_investors&#x60; — highest investor count first  (default to 'most_raised')
+    # @option opts [Integer] :per_page Offerings per page. (default to 25)
+    # @option opts [String] :status Which rounds to list: - &#x60;live&#x60; (default): rounds accepting investments or reservations, as on wefunder.com/explore - &#x60;closed&#x60;: rounds that finished raising, newest &#x60;closed_at&#x60; first (id breaks ties) - &#x60;all&#x60;: the live list, then the closed list  Any other value is a &#x60;400&#x60;.  (default to 'live')
+    # @option opts [String] :sort Ordering of live rounds. A &#x60;400&#x60; with &#x60;status&#x3D;closed&#x60;; with &#x60;status&#x3D;all&#x60; it orders the live part only. - &#x60;most_raised&#x60; (default) — highest amount raised first - &#x60;closing_soon&#x60; — soonest funding close first - &#x60;newest&#x60; — most recently launched first - &#x60;most_investors&#x60; — highest investor count first  (default to 'most_raised')
     # @option opts [String] :exemption Only offerings under this SEC exemption family. Reg CF and Reg D are the supported public filters.
     # @option opts [String] :security Only offerings issuing this kind of security — the &#x60;security.type&#x60; value on results.
     # @option opts [Boolean] :testing_the_waters &#x60;false&#x60; — only live rounds accepting investments; &#x60;true&#x60; — only Testing-the-Waters rounds collecting non-binding reservations.
@@ -559,6 +563,18 @@ module WefunderGenerated
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ExploreApi.list_offerings ...'
       end
+      if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling ExploreApi.list_offerings, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling ExploreApi.list_offerings, must be greater than or equal to 1.'
+      end
+
+      allowable_values = ["live", "closed", "all"]
+      if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
+        fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
+      end
       allowable_values = ["most_raised", "closing_soon", "newest", "most_investors"]
       if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
         fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
@@ -585,6 +601,8 @@ module WefunderGenerated
       # query parameters
       query_params = opts[:query_params] || {}
       query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
       query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
       query_params[:'exemption'] = opts[:'exemption'] if !opts[:'exemption'].nil?
       query_params[:'security'] = opts[:'security'] if !opts[:'security'].nil?

data/lib/wefunder_generated/api/intents_api.rb

@@ -20,7 +20,7 @@ module WefunderGenerated
       @api_client = api_client
     end
     # Propose an intent
-    # Propose a dangerous or irreversible action for human approval. Returns a `review_url` where a human must review the impact and approve before the action executes.  The entity that proposes an intent can never approve it. Approval always happens on Wefunder's UI by a user with permission on the resource.  Each action names the scope that may propose it and the resource type it targets (`syndicates.*` → `write:syndicates` on a syndicate; `comments.create` → `write:comments` on a `Company`). The token must hold that action's scope; holding another proposing scope is not enough (403 `insufficient_scope`).  `comments.create` posts a question on a company's Ask tab, or an answer to one, as the requesting user once they approve on wefunder.com. `resource_id` is the company (`co_...`); `params` is `{ target_type: \"company\" | \"comment\", target: \"co_...\" | \"cmt_...\", body, disclosure_key? }` (`disclosure_key` ∈ investor, stockholder, promoter, financial_stakeholder). Who may post is the site's own rule: anyone the page is available to may ask (unless the company has closed questions); only the company's team may answer. Only the requester can approve. 20 proposals per user per day (429).  An `idempotency_key` names one operation. Reusing it for the same operation returns the existing intent (200) while that intent is pending, approved, executing, or executed; reusing it for a different action, resource, or params is a 409 `idempotency_conflict`.  An action still rolling out per account returns 403 `feature_disabled` for a user who is not yet enabled. `POST /intents/preview` runs the same checks without minting.  See [Intents documentation](/concepts/intents) for the full pattern. 
+    # Propose a dangerous or irreversible action for human approval. Returns a `review_url` where a human must review the impact and approve before the action executes.  The entity that proposes an intent can never approve it. Approval always happens on Wefunder's UI by a user with permission on the resource.  Each action names the scope that may propose it and the resource type it targets (`syndicates.*` → `write:syndicates` on a syndicate; `comments.create` → `write:comments` on a `Company`). The token must hold that action's scope; holding another proposing scope is not enough (403 `insufficient_scope`).  `comments.create` posts a question on a company's Ask tab, or an answer to one, as the requesting user once they approve on wefunder.com. `resource_id` is the company (`co_...`); `params` is `{ target_type: \"company\" | \"comment\", target: \"co_...\" | \"cmt_...\", body, disclosure_key? }` (`disclosure_key` ∈ investor, stockholder, promoter, financial_stakeholder). Who may post is the site's own rule: anyone the page is available to may ask (unless the company has closed questions); only the company's team may answer. Only the requester can approve. 20 proposals per user per day (429).  An `idempotency_key` names one operation. Reusing it for the same operation returns the existing intent (200) while that intent is pending, approved, executing, or executed; reusing it for a different action, resource, or params is a 409 `idempotency_conflict`.  An action still rolling out per account returns 403 `feature_disabled` for a user who is not yet enabled. `POST /intents/preview` runs the same checks without minting.  `syndicates.close_deal` and `syndicates.finalize_deal` were removed in `2026-10-15`: on this version they answer 400 `bad_request` (\"Unknown action\") with `details.removed_in_version`. A syndicate's managers close and finalize deals on wefunder.com. Intents minted before still appear in `GET /intents` with those action names.  See [Intents documentation](/concepts/intents) for the full pattern. 
     # @param create_intent_request [CreateIntentRequest] 
     # @param [Hash] opts the optional parameters
     # @return [IntentEnvelope]
@@ -30,7 +30,7 @@ module WefunderGenerated
     end
 
     # Propose an intent
-    # Propose a dangerous or irreversible action for human approval. Returns a `review_url` where a human must review the impact and approve before the action executes.  The entity that proposes an intent can never approve it. Approval always happens on Wefunder's UI by a user with permission on the resource.  Each action names the scope that may propose it and the resource type it targets (`syndicates.*` → `write:syndicates` on a syndicate; `comments.create` → `write:comments` on a `Company`). The token must hold that action's scope; holding another proposing scope is not enough (403 `insufficient_scope`).  `comments.create` posts a question on a company's Ask tab, or an answer to one, as the requesting user once they approve on wefunder.com. `resource_id` is the company (`co_...`); `params` is `{ target_type: \"company\" | \"comment\", target: \"co_...\" | \"cmt_...\", body, disclosure_key? }` (`disclosure_key` ∈ investor, stockholder, promoter, financial_stakeholder). Who may post is the site's own rule: anyone the page is available to may ask (unless the company has closed questions); only the company's team may answer. Only the requester can approve. 20 proposals per user per day (429).  An `idempotency_key` names one operation. Reusing it for the same operation returns the existing intent (200) while that intent is pending, approved, executing, or executed; reusing it for a different action, resource, or params is a 409 `idempotency_conflict`.  An action still rolling out per account returns 403 `feature_disabled` for a user who is not yet enabled. `POST /intents/preview` runs the same checks without minting.  See [Intents documentation](/concepts/intents) for the full pattern. 
+    # Propose a dangerous or irreversible action for human approval. Returns a `review_url` where a human must review the impact and approve before the action executes.  The entity that proposes an intent can never approve it. Approval always happens on Wefunder's UI by a user with permission on the resource.  Each action names the scope that may propose it and the resource type it targets (`syndicates.*` → `write:syndicates` on a syndicate; `comments.create` → `write:comments` on a `Company`). The token must hold that action's scope; holding another proposing scope is not enough (403 `insufficient_scope`).  `comments.create` posts a question on a company's Ask tab, or an answer to one, as the requesting user once they approve on wefunder.com. `resource_id` is the company (`co_...`); `params` is `{ target_type: \"company\" | \"comment\", target: \"co_...\" | \"cmt_...\", body, disclosure_key? }` (`disclosure_key` ∈ investor, stockholder, promoter, financial_stakeholder). Who may post is the site's own rule: anyone the page is available to may ask (unless the company has closed questions); only the company's team may answer. Only the requester can approve. 20 proposals per user per day (429).  An `idempotency_key` names one operation. Reusing it for the same operation returns the existing intent (200) while that intent is pending, approved, executing, or executed; reusing it for a different action, resource, or params is a 409 `idempotency_conflict`.  An action still rolling out per account returns 403 `feature_disabled` for a user who is not yet enabled. `POST /intents/preview` runs the same checks without minting.  `syndicates.close_deal` and `syndicates.finalize_deal` were removed in `2026-10-15`: on this version they answer 400 `bad_request` (\"Unknown action\") with `details.removed_in_version`. A syndicate's managers close and finalize deals on wefunder.com. Intents minted before still appear in `GET /intents` with those action names.  See [Intents documentation](/concepts/intents) for the full pattern. 
     # @param create_intent_request [CreateIntentRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(IntentEnvelope, Integer, Hash)>] IntentEnvelope data, response status code and response headers

data/lib/wefunder_generated/api/investment_delta_api.rb

@@ -19,8 +19,8 @@ module WefunderGenerated
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Bootstrap or page investment changes for a company
-    # The Investment Delta API: keep a copy of a company's investment records in sync by polling. Call without `cursor` to **bootstrap** (list every current record for the company); every response carries `meta.next_cursor`; call again with that cursor to receive only the records whose published state changed since. Records are the same shape in both modes.  - Records are **published state**, not live rows: Wefunder publishes a record when the   investment's founder-visible state changes, and serves exactly what was published. - `visible: false` records are **tombstones**: the investment is no longer visible to the   company (canceled, converted to another round, hidden, or deleted). Delete your copy. - Apply records in `cursor` order. `observed_at` is when the payload was observed, not a   version; a record you read late carries the *current* published state. - **410 Gone** means your cursor predates the 90-day retention window. Bootstrap again and   **replace** your dataset for the company from the result (records absent from the   bootstrap are deleted). - Investor identity fields (`investor.name`, `investor.legal_name`, `investor.email`,   `investor.address`, `investor.bio`, `message`, `external_username`) are **omitted**   unless the token carries `read:investors:pii`. - Money is integer minor units plus `amounts.currency` (`committed_cents`,   `investment_size_cents`, `in_escrow_cents`, `contracts[].override_amount_cents`).   `shares` and `average_share_price` are decimal strings, `null` on rounds without shares.   `amounts.raised_cents` is the row's contribution to the public raised figure (0 while   `needs_whitelisting`); sum it, not `committed_cents`, to match the deal page. 
+    # Legacy alias: bootstrap or page investment changes for a company
+    # **Compatibility alias.** This path keeps working unchanged for partners already on it, but new integrations should use [List or sync investments](/api-reference/list-investments) (`GET /investments?company_id=…`): same records, interchangeable cursors. The [migration notes](/partner-api/investments/changes#migrating-from-companiescompany_idinvestmentschanges) list the differences.  The Investment Delta API: keep a copy of a company's investment records in sync by polling. Call without `cursor` to **bootstrap** (list every current record for the company); every response carries `meta.next_cursor`; call again with that cursor to receive only the records whose published state changed since. Records are the same shape in both modes.  - Records are **published state**, not live rows: Wefunder publishes a record when the   investment's founder-visible state changes, and serves exactly what was published. - `visible: false` records are **tombstones**: the investment is no longer visible to the   company (canceled, converted to another round, hidden, or deleted). Delete your copy. - Apply records in `cursor` order. `observed_at` is when the payload was observed, not a   version; a record you read late carries the *current* published state. - **410 Gone** means your cursor predates the 90-day retention window. Bootstrap again and   **replace** your dataset for the company from the result (records absent from the   bootstrap are deleted). - Investor identity fields (`investor.name`, `investor.legal_name`, `investor.email`,   `investor.address`, `investor.bio`, `message`, `external_username`) are **omitted**   unless the token carries `read:investors:pii`. - Money is integer minor units plus `amounts.currency` (`committed_cents`,   `investment_size_cents`, `in_escrow_cents`, `contracts[].override_amount_cents`).   `shares` and `average_share_price` are decimal strings, `null` on rounds without shares.   `amounts.raised_cents` is the row's contribution to the public raised figure (0 while   `needs_whitelisting`); sum it, not `committed_cents`, to match the deal page. 
     # @param company_id [String] The company's external id (`co_…`).
     # @param [Hash] opts the optional parameters
     # @option opts [String] :cursor Opaque cursor from a previous response's `meta.next_cursor`. Omit to bootstrap. 
@@ -31,8 +31,8 @@ module WefunderGenerated
       data
     end
 
-    # Bootstrap or page investment changes for a company
-    # The Investment Delta API: keep a copy of a company's investment records in sync by polling. Call without `cursor` to **bootstrap** (list every current record for the company); every response carries `meta.next_cursor`; call again with that cursor to receive only the records whose published state changed since. Records are the same shape in both modes.  - Records are **published state**, not live rows: Wefunder publishes a record when the   investment's founder-visible state changes, and serves exactly what was published. - `visible: false` records are **tombstones**: the investment is no longer visible to the   company (canceled, converted to another round, hidden, or deleted). Delete your copy. - Apply records in `cursor` order. `observed_at` is when the payload was observed, not a   version; a record you read late carries the *current* published state. - **410 Gone** means your cursor predates the 90-day retention window. Bootstrap again and   **replace** your dataset for the company from the result (records absent from the   bootstrap are deleted). - Investor identity fields (`investor.name`, `investor.legal_name`, `investor.email`,   `investor.address`, `investor.bio`, `message`, `external_username`) are **omitted**   unless the token carries `read:investors:pii`. - Money is integer minor units plus `amounts.currency` (`committed_cents`,   `investment_size_cents`, `in_escrow_cents`, `contracts[].override_amount_cents`).   `shares` and `average_share_price` are decimal strings, `null` on rounds without shares.   `amounts.raised_cents` is the row's contribution to the public raised figure (0 while   `needs_whitelisting`); sum it, not `committed_cents`, to match the deal page. 
+    # Legacy alias: bootstrap or page investment changes for a company
+    # **Compatibility alias.** This path keeps working unchanged for partners already on it, but new integrations should use [List or sync investments](/api-reference/list-investments) (`GET /investments?company_id=…`): same records, interchangeable cursors. The [migration notes](/partner-api/investments/changes#migrating-from-companiescompany_idinvestmentschanges) list the differences.  The Investment Delta API: keep a copy of a company's investment records in sync by polling. Call without `cursor` to **bootstrap** (list every current record for the company); every response carries `meta.next_cursor`; call again with that cursor to receive only the records whose published state changed since. Records are the same shape in both modes.  - Records are **published state**, not live rows: Wefunder publishes a record when the   investment's founder-visible state changes, and serves exactly what was published. - `visible: false` records are **tombstones**: the investment is no longer visible to the   company (canceled, converted to another round, hidden, or deleted). Delete your copy. - Apply records in `cursor` order. `observed_at` is when the payload was observed, not a   version; a record you read late carries the *current* published state. - **410 Gone** means your cursor predates the 90-day retention window. Bootstrap again and   **replace** your dataset for the company from the result (records absent from the   bootstrap are deleted). - Investor identity fields (`investor.name`, `investor.legal_name`, `investor.email`,   `investor.address`, `investor.bio`, `message`, `external_username`) are **omitted**   unless the token carries `read:investors:pii`. - Money is integer minor units plus `amounts.currency` (`committed_cents`,   `investment_size_cents`, `in_escrow_cents`, `contracts[].override_amount_cents`).   `shares` and `average_share_price` are decimal strings, `null` on rounds without shares.   `amounts.raised_cents` is the row's contribution to the public raised figure (0 while   `needs_whitelisting`); sum it, not `committed_cents`, to match the deal page. 
     # @param company_id [String] The company's external id (`co_…`).
     # @param [Hash] opts the optional parameters
     # @option opts [String] :cursor Opaque cursor from a previous response's `meta.next_cursor`. Omit to bootstrap.