wefunder 0.1.0.beta3 → 0.1.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3ac10a62a698ee6cb163f3ec6e100248d461dc6c55bf97caeb1bac349b44af6
-  data.tar.gz: 26d0e08433a88d288942da627f8d509ffa196e6e2ed3cc347bae43beadaf84bf
+  metadata.gz: 5debc49eda9f51f36042922d2fa820f891d2c847e20f83409d7e61fa1ff2e95a
+  data.tar.gz: d8f9889dc16fb317efd3900b5dafc881807e60a4822b4dcab8a7ded46a2f4d39
 SHA512:
-  metadata.gz: 4ee97ef8052e3e7a9476a8b0243b52a706bfd2c6a5911e1b9362c07e5d5d6290529615ed6daace3d953769d126a492440692ebef5191cd7846c418a70f6a54b5
-  data.tar.gz: 535800baceafa25b8fcb744d2a1fc16a0596e14d80db5fba6f0c83772ee371c16a361335f82819b5a5e664bf016d17b008d3ff46a3f07f527eab491d8aa36bdd
+  metadata.gz: 9b7c81d6afb161eacc9a727aaa4bcca3720a6b6bc77e3c8efc332ac594e5e35581680d4ad847c6dd6fb3df5d7382eb2149fcff0f072e0b75d189b96281cee6bc
+  data.tar.gz: 85613d6d2be67d40039f2a9a953682ee180d45811076f4e477629f9a2effce804274e1726c4bbf098b1d8d59ef7fc4fbf5a9fab358a1d656c23088265ea1ff87

data/README.md

@@ -103,8 +103,12 @@ portfolio = wf.portfolio.get
 ```
 
 Namespaces: `users`, `offerings`, `investments`, `portfolio`, `campaigns`, `syndicates`, `intents`,
-`attribution`, and `webhook_endpoints`. Query parameters are keyword arguments; enum-typed ones take
-plain strings, and `Time` / `DateTime` / `Date` values are sent as ISO 8601.
+`attribution`, `installations`, 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.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.

data/lib/wefunder/client.rb

@@ -26,7 +26,7 @@ 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, :webhook_endpoints
+                :attribution, :installations, :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,
@@ -53,6 +53,7 @@ module Wefunder
       @syndicates = Syndicates.new(self)
       @intents = Intents.new(self)
       @attribution = Attribution.new(self)
+      @installations = Installations.new(self)
       @webhook_endpoints = WebhookEndpoints.new(self)
     end
 
@@ -275,6 +276,58 @@ module Wefunder
       def me = data_of(wrap { raw.attribution_partners.get_attribution_me })
     end
 
+    # /installations (read:installations / write:installations; write does not imply read). An
+    # install lets your app act AS a company or syndicate: +create+ and +mint_token+ return the
+    # envelope whose +token.access_token+ is a company-owned token (shown once, no expiry, no
+    # refresh) — build a second client with it. Installing is also what makes a company or
+    # syndicate an audience for your webhooks.
+    class Installations < Namespace
+      # Companies / syndicates the token's user may install your app on (empty for an investor).
+      def eligible_targets(target_type: nil)
+        opts = target_type ? { target_type: target_type } : {}
+        data_of(wrap { raw.installations.list_eligible_install_targets(opts) }) || []
+      end
+
+      # Every install of your app; the envelope (+meta.count+).
+      def list = wrap { raw.installations.list_installations }
+      def get(installation_id) = data_of(wrap { raw.installations.get_installation(installation_id) })
+
+      # Install on a target (+target_type:+, +target_id:+, optional +scopes:+ / +tier:+). Returns the
+      # envelope: +data+ is the install, +token.access_token+ the one-time token. If the app is
+      # already installed there the API answers 409 +already_installed+ with
+      # +details["installation"]+ = the existing id; see +install_or_mint_token+.
+      def create(**attrs)
+        attrs = attrs.transform_keys(&:to_sym)
+        wrap { raw.installations.create_installation(WefunderGenerated::CreateInstallationRequest.new(attrs)) }
+      end
+
+      # A fresh company-owned token for an existing install. +scopes+ narrows within the install's
+      # ceiling; omit for the ceiling. An explicit +[]+ grants nothing, so only nil omits the body.
+      def mint_token(installation_id, scopes = nil)
+        opts = {}
+        opts[:create_installation_token_request] = WefunderGenerated::CreateInstallationTokenRequest.new(scopes: scopes) if scopes
+        wrap { raw.installations.create_installation_token(installation_id, opts) }
+      end
+
+      # +create+, falling back to +mint_token+ for the existing install on 409 +already_installed+.
+      # The mint re-requests +scopes+ so a retry never widens the grant. Any other error (revoked
+      # install, missing scope) still raises.
+      def install_or_mint_token(**attrs)
+        # Normalize once so the fallback re-requests exactly what create sent — string-keyed
+        # attrs (e.g. from JSON.parse) must not turn a restricted or empty grant into the ceiling.
+        attrs = attrs.transform_keys(&:to_sym)
+        create(**attrs)
+      rescue Wefunder::Error => e
+        existing_id = e.details["installation"] if e.type == "already_installed" && e.details.is_a?(Hash)
+        raise unless existing_id.is_a?(String) && !existing_id.empty?
+
+        mint_token(existing_id, attrs[:scopes])
+      end
+
+      # Revoke an install: its tokens stop working at once. Returns the install, now +revoked+.
+      def revoke(installation_id) = data_of(wrap { raw.installations.revoke_installation(installation_id) })
+    end
+
     # Endpoints belong to your application and are managed through the LIVE API
     # (write:webhooks). The signing secret is returned only on create and rotate.
     class WebhookEndpoints < Namespace

data/lib/wefunder/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Wefunder
-  VERSION = "0.1.0.beta3"
+  VERSION = "0.1.0.beta4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wefunder
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta3
+  version: 0.1.0.beta4
 platform: ruby
 authors:
 - Wefunder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-02 00:00:00.000000000 Z
+date: 2026-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday