@axivoy/api 1.7.0 → 1.8.0

package/dist/generated/schema.d.ts

@@ -1565,6 +1565,72 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/ops/customer_payments.bank_connections.disconnect": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Disconnect a bank account
+         * @description Revokes a bank link at the provider and stops its syncs. Transactions already in the bank inbox stay.
+         *
+         *     Kind: `mutate`. Errors use the envelope `{error: {code, reason, message, fields}}`.
+         */
+        post: operations["ops.customer_payments.bank_connections.disconnect"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/ops/customer_payments.bank_connections.list": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * List bank connections
+         * @description Linked bank accounts with their status, last sync and whether syncing is failing.
+         *
+         *     Kind: `read`. Errors use the envelope `{error: {code, reason, message, fields}}`.
+         */
+        post: operations["ops.customer_payments.bank_connections.list"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/ops/customer_payments.bank_connections.request_link": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Ask someone to link a bank account
+         * @description Asks the people who may link bank accounts (or one of them) to link one, with an in-app notification and an email that opens the bank connections page. Each person is asked at most once per 24 hours.
+         *
+         *     Kind: `talk`. Errors use the envelope `{error: {code, reason, message, fields}}`.
+         */
+        post: operations["ops.customer_payments.bank_connections.request_link"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/ops/customer_payments.bank_connections.sync": {
         parameters: {
             query?: never;
@@ -6693,6 +6759,32 @@ export interface paths {
     };
 }
 export interface webhooks {
+    "bank_connection.link_requested": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Bank link requested
+         * @description Someone (a person, assistant, app or API key) asked the people who may link bank accounts to link one.
+         *
+         *     Version 1. Delivered at least once; dedupe by `id`.
+         *
+         *     Subscriptions can filter on: `requested_by_kind` (Requested by), `recipient_count` (Recipients).
+         *
+         *     Verify `Axivoy-Signature` before trusting the body; answer 2xx within 10 seconds. Failed tries retry at 1 minute, 10 minutes, 1 hour, 6 hours and 16 hours; replay any delivery from the last 30 days with `webhooks.deliveries.replay`.
+         */
+        post: operations["events.bank_connection.link_requested"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "compliance.item.expiring": {
         parameters: {
             query?: never;
@@ -18535,6 +18627,410 @@ export interface operations {
             };
         };
     };
+    "ops.customer_payments.bank_connections.disconnect": {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Replays the first result when the same call is retried. Send one per user intent on writes. */
+                "Idempotency-Key"?: string;
+                /** @description Send `true` to run every check without changing anything. The answer is `{"dry_run": {"outcome": "would_run" | "would_propose", "input": {...}}}`. */
+                "Axivoy-Dry-Run"?: "true" | "false";
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                /**
+                 * @example {
+                 *       "bank_connection_id": 1
+                 *     }
+                 */
+                "application/json": {
+                    /** @description Bank connection id */
+                    bank_connection_id: number;
+                };
+            };
+        };
+        responses: {
+            /** @description The operation ran. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "result": {
+                     *         "bank_name": "Operating Checking",
+                     *         "disconnected": 1
+                     *       }
+                     *     }
+                     */
+                    "application/json": {
+                        result: {
+                            /** @description Account disconnected */
+                            bank_name?: string | null;
+                            /** @description Bank accounts disconnected (accounts sharing one bank login go together) */
+                            disconnected: number;
+                        };
+                    };
+                };
+            };
+            202: components["responses"]["Proposal"];
+            /** @description Refused: credits_exhausted. */
+            402: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: not_permitted, not_available, authority_off, data_class_blocked. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: not_found. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: idempotency_conflict, stale_state. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: operation_retired. */
+            410: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: invalid_input, domain_rule. */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: rate_limited. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+        };
+    };
+    "ops.customer_payments.bank_connections.list": {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Replays the first result when the same call is retried. Send one per user intent on writes. */
+                "Idempotency-Key"?: string;
+                /** @description Send `true` to run every check without changing anything. The answer is `{"dry_run": {"outcome": "would_run" | "would_propose", "input": {...}}}`. */
+                "Axivoy-Dry-Run"?: "true" | "false";
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                /** @example {} */
+                "application/json": {
+                    /** @description Cursor from the previous page's next_cursor. */
+                    cursor?: string | null;
+                    /** @description Rows per page (default 25). */
+                    limit?: number | null;
+                    /**
+                     * Format: date-time
+                     * @description Only rows changed at or after this instant, oldest change first, with deleted rows as tombstones.
+                     */
+                    updated_since?: string | null;
+                };
+            };
+        };
+        responses: {
+            /** @description The operation ran. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "result": {
+                     *         "items": [
+                     *           {
+                     *             "id": 1,
+                     *             "provider": "plaid",
+                     *             "institution_name": "Dickens PLC Bank",
+                     *             "bank_name": "Operating Checking",
+                     *             "bank_account_last4": "0761",
+                     *             "status": "active",
+                     *             "sync_failing": false,
+                     *             "last_sync_error": null,
+                     *             "last_synced_at": null,
+                     *             "updated_at": "2026-10-19T16:17:18Z"
+                     *           }
+                     *         ],
+                     *         "next_cursor": null
+                     *       }
+                     *     }
+                     */
+                    "application/json": {
+                        result: {
+                            /** @description One page of rows. */
+                            items: {
+                                /** @description The row's id. */
+                                id: number;
+                                /** @description Bank feed provider (plaid or stripe) */
+                                provider?: string | null;
+                                /** @description Bank */
+                                institution_name?: string | null;
+                                /** @description Account name */
+                                bank_name?: string | null;
+                                /** @description Account last four digits */
+                                bank_account_last4?: string | null;
+                                /** @description active, error (needs reconnect) or disconnected */
+                                status: string;
+                                /** @description True when recent syncs failed and are being retried */
+                                sync_failing: boolean;
+                                /** @description Why the last sync failed */
+                                last_sync_error?: string | null;
+                                /**
+                                 * Format: date-time
+                                 * @description Last successful sync
+                                 */
+                                last_synced_at?: string | null;
+                                /**
+                                 * Format: date-time
+                                 * @description Last change to the record
+                                 */
+                                updated_at?: string | null;
+                                /** @description True on a tombstone (the row was deleted or recycled); other fields are absent. */
+                                deleted?: boolean | null;
+                            }[];
+                            /** @description Pass as cursor for the next page; null on the last page. */
+                            next_cursor?: string | null;
+                        };
+                    };
+                };
+            };
+            202: components["responses"]["Proposal"];
+            /** @description Refused: credits_exhausted. */
+            402: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: not_permitted, not_available, authority_off, data_class_blocked. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: not_found. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: idempotency_conflict, stale_state. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: operation_retired. */
+            410: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: invalid_input, domain_rule. */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: rate_limited. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+        };
+    };
+    "ops.customer_payments.bank_connections.request_link": {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Replays the first result when the same call is retried. Send one per user intent on writes. */
+                "Idempotency-Key"?: string;
+                /** @description Send `true` to run every check without changing anything. The answer is `{"dry_run": {"outcome": "would_run" | "would_propose", "input": {...}}}`. */
+                "Axivoy-Dry-Run"?: "true" | "false";
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                /**
+                 * @example {
+                 *       "note": "The First Bank account is not linked yet."
+                 *     }
+                 */
+                "application/json": {
+                    /** @description Member to ask (one who may link bank accounts); default every such member */
+                    user_id?: number | null;
+                    /** @description Short note for the request (500 characters) */
+                    note?: string | null;
+                };
+            };
+        };
+        responses: {
+            /** @description The operation ran. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "result": {
+                     *         "request_id": 1,
+                     *         "requested_at": "2026-10-19T16:17:20Z",
+                     *         "notified_count": 2,
+                     *         "already_requested_count": 0
+                     *       }
+                     *     }
+                     */
+                    "application/json": {
+                        result: {
+                            /** @description Bank link request id (the earlier one when everyone asked was already asked in the last 24 hours) */
+                            request_id: number;
+                            /**
+                             * Format: date-time
+                             * @description When the request was made
+                             */
+                            requested_at: string;
+                            /** @description People notified by this call */
+                            notified_count: number;
+                            /** @description People skipped because they were asked in the last 24 hours */
+                            already_requested_count: number;
+                        };
+                    };
+                };
+            };
+            202: components["responses"]["Proposal"];
+            /** @description Refused: credits_exhausted. */
+            402: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: not_permitted, not_available, authority_off, data_class_blocked. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: not_found. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: idempotency_conflict, stale_state. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: operation_retired. */
+            410: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: invalid_input, domain_rule. */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: rate_limited. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+        };
+    };
     "ops.customer_payments.bank_connections.sync": {
         parameters: {
             query?: never;
@@ -62948,6 +63444,105 @@ export interface operations {
             };
         };
     };
+    "events.bank_connection.link_requested": {
+        parameters: {
+            query?: never;
+            header: {
+                /** @description `t=<unix seconds>,v1=<hex>`: HMAC-SHA256 of `{t}.{raw body}` with the endpoint secret. For 24 hours after a secret rotation a second `v1=` signed with the old secret follows. Compare in constant time and reject a `t` older than 300 seconds. */
+                "Axivoy-Signature": string;
+                /** @description Delivery id, the same on every retry of this delivery. */
+                "Axivoy-Webhook-Id": string;
+                /** @description The event `id`; dedupe on it. */
+                "Axivoy-Event-Id": string;
+                /** @description The event key, for example `load.created`. */
+                "Axivoy-Event-Type": string;
+                /** @description `true` on test sends from Settings, which also carry `"test": true` in the body. */
+                "Axivoy-Test"?: string;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                /**
+                 * @example {
+                 *       "id": "0192f3a4-5b6c-7d8e-9f01-23456789abcd",
+                 *       "type": "bank_connection.link_requested",
+                 *       "version": 1,
+                 *       "occurred_at": "2026-10-01T15:04:05Z",
+                 *       "effective_at": "2026-10-01T15:04:05Z",
+                 *       "tenant": 1,
+                 *       "subject": {
+                 *         "type": "bank_link_request",
+                 *         "id": 1
+                 *       },
+                 *       "sequence": 1,
+                 *       "facts": {
+                 *         "requested_by_kind": "agent",
+                 *         "recipient_count": 1,
+                 *         "has_note": true
+                 *       },
+                 *       "causation": {
+                 *         "invocation_id": null,
+                 *         "event_id": null,
+                 *         "subscription_id": null
+                 *       },
+                 *       "chain_depth": 0,
+                 *       "fetch": null
+                 *     }
+                 */
+                "application/json": {
+                    /** @description Event id; the same on every delivery of this event. */
+                    id: string;
+                    /** @constant */
+                    type: "bank_connection.link_requested";
+                    /** @constant */
+                    version: 1;
+                    /** Format: date-time */
+                    occurred_at: string;
+                    /**
+                     * Format: date-time
+                     * @description When it counts operationally; differs from `occurred_at` for back-dated facts.
+                     */
+                    effective_at: string;
+                    /** @description Workspace id. */
+                    tenant: number;
+                    subject: {
+                        type: string;
+                        id: number | string;
+                    };
+                    /** @description Increases per subject; apply events for one subject in this order. */
+                    sequence: number;
+                    facts: {
+                        requested_by_kind: string;
+                        recipient_count: number;
+                        has_note: boolean;
+                    };
+                    causation: {
+                        invocation_id?: string | null;
+                        event_id?: string | null;
+                        subscription_id?: number | null;
+                    };
+                    chain_depth: number;
+                    fetch: {
+                        operation?: string;
+                        input?: Record<string, never>;
+                    } | null;
+                    /** @description Present and `true` only on test sends. */
+                    test?: boolean;
+                };
+            };
+        };
+        responses: {
+            /** @description Received. Any other answer, a redirect or no answer within 10 seconds fails the try. */
+            "2XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     "events.compliance.item.expiring": {
         parameters: {
             query?: never;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axivoy/api",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "Typed client for the Axivoy API: operations, webhooks and errors.",
   "license": "MIT",
   "homepage": "https://app.axivoy.ai/developers",