squarefi-bff-api-module 1.36.0 → 1.36.2

package/dist/api/types/autogen/apiV1External.types.d.ts

@@ -2011,7 +2011,7 @@ export interface paths {
                     sub_account_type?: "prepaid" | "balance";
                     /** @description Filter cards by status */
                     status?: "ACTIVE" | "INACTIVE" | "SUSPENDED" | "CANCELED";
-                    /** @description Filter cards by exact last 4 digits of the card number */
+                    /** @description Filter cards by last 4 digits of the card number (partial, case-insensitive match) */
                     last4?: string;
                     /** @description Number of items to skip */
                     offset?: number;
@@ -5494,7 +5494,8 @@ export interface paths {
          *     from the API key — presence of a rate row is treated as the enable flag.
          *
          *     Each returned item includes a `tenant_rates` object (`markup_percent`,
-         *     `markup_fixed`, `mon_min_usd`).
+         *     `markup_fixed`, `mon_min_usd`) and may expose product-facing guardrails
+         *     such as `min_amount`, `max_amount`, and `first_party_only`.
          *
          *     **Authentication**: x-api-key header required
          *
@@ -7522,8 +7523,9 @@ export interface components {
              * @description External vendor account ID
              */
             vendor_account_id?: string | null;
-            /** @description Bank account details for deposits */
+            /** @description Bank account details for deposits. Returned null when deposits are disabled for the account. */
             account_details?: components["schemas"]["BankAccountDetails"];
+            /** @description Deposit requisites. Returned null when deposits are disabled for the account. */
             deposit_instructions?: Record<string, never> | null;
             current_balance?: number | null;
             available_balance?: number | null;
@@ -7600,7 +7602,10 @@ export interface components {
             /** @description Array of order_type IDs */
             order_types?: string[];
             /** @description KYC rail configuration */
-            kyc_rails?: Record<string, never> | null;
+            kyc_rails?: {
+                /** @description When false, deposits are not accepted for accounts on this rail and their requisites are suppressed in public responses */
+                is_deposit_enabled?: boolean;
+            } | null;
             /**
              * Format: uuid
              * @description Required KYC rail ID
@@ -7616,6 +7621,18 @@ export interface components {
             is_internal?: boolean;
             payment_method?: string | null;
             is_trusted?: boolean;
+            /**
+             * @description Optional minimum amount the product should allow for this order type
+             * @example 100
+             */
+            min_amount?: number | null;
+            /**
+             * @description Optional maximum amount the product should allow for this order type
+             * @example 50000
+             */
+            max_amount?: number | null;
+            /** @description Whether payouts for this order type are limited to the wallet owner's own account */
+            first_party_only?: boolean;
             /** @description Tenant-specific billing rates (present when tenant context is available) */
             tenant_rates?: {
                 /**

package/dist/api/types/autogen/apiV1Frontend.types.d.ts

@@ -1736,7 +1736,7 @@ export interface paths {
                     sub_account_type?: "prepaid" | "balance";
                     /** @description Filter cards by status */
                     status?: "ACTIVE" | "INACTIVE" | "SUSPENDED" | "CANCELED";
-                    /** @description Filter cards by exact last 4 digits of the card number */
+                    /** @description Filter cards by last 4 digits of the card number (partial, case-insensitive match) */
                     last4?: string;
                     /** @description Number of items to skip */
                     offset?: number;
@@ -1845,6 +1845,16 @@ export interface paths {
                          * @example My Card
                          */
                         card_name: string;
+                        /**
+                         * Format: uuid
+                         * @description Optional. Binds the card to a wallet member so a scoped `user` role can
+                         *     access ONLY this card (view, sensitive data, transactions, freeze/unfreeze),
+                         *     and nothing else in the wallet (SFI-1382). Must be the `user_data.uuid` of an
+                         *     active member of the target wallet; resolved server-side to the card's owner.
+                         *
+                         * @example a1b2c3d4-e5f6-7890-abcd-ef1234567890
+                         */
+                        assigned_user_data_uuid?: string;
                         /**
                          * Format: email
                          * @deprecated
@@ -5222,6 +5232,129 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/frontend/orders/{order_id}/approve": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Approve an order
+         * @description Moves a PENDING order to PROCESSING, triggering its workflow. Validates the order's request_id via OTP.
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    order_id: string;
+                };
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /** Format: uuid */
+                        wallet_id: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description Order moved to PROCESSING */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example true */
+                            success?: boolean;
+                            data?: components["schemas"]["Order"];
+                        };
+                    };
+                };
+                /** @description Order is not in an approvable state */
+                409: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/frontend/orders/{order_id}/cancel": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Cancel an order
+         * @description Cancels a PENDING/FAILED order, cancels its workflow run, and refunds the blocked funds.
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    order_id: string;
+                };
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /** Format: uuid */
+                        wallet_id: string;
+                        reason?: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description Order canceled and funds refunded */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example true */
+                            success?: boolean;
+                            data?: components["schemas"]["Order"];
+                        };
+                    };
+                };
+                /** @description Order is not in a cancelable state */
+                409: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/frontend/orders/types": {
         parameters: {
             query?: never;
@@ -6162,7 +6295,8 @@ export interface paths {
          *     the enable flag.
          *
          *     Each returned item includes a `tenant_rates` object (`markup_percent`,
-         *     `markup_fixed`, `mon_min_usd`).
+         *     `markup_fixed`, `mon_min_usd`) and may expose product-facing guardrails
+         *     such as `min_amount`, `max_amount`, and `first_party_only`.
          *
          *     **Authentication**: Bearer token + x-tenant-id header
          *
@@ -6989,7 +7123,7 @@ export interface paths {
                                 /** Format: uuid */
                                 wallet_id?: string;
                                 /** @enum {string} */
-                                role?: "user" | "admin";
+                                role?: "auditor" | "user" | "admin";
                             };
                         };
                     };
@@ -7147,10 +7281,17 @@ export interface paths {
                         "application/json": {
                             success?: boolean;
                             data?: {
-                                /** @description Wallet name, or null if the wallet has no name set */
-                                wallet_name?: string | null;
+                                /**
+                                 * @description Display label for the wallet. The wallet's own name when set,
+                                 *     otherwise derived from its KYC entity: `business_name` for
+                                 *     businesses, `first_name last_name` for individuals, falling back
+                                 *     to "Business account" / "Individual account" / "New account".
+                                 *
+                                 * @example Acme LLC
+                                 */
+                                wallet_name?: string;
                                 /** @enum {string} */
-                                role?: "user" | "admin";
+                                role?: "auditor" | "user" | "admin";
                             };
                         };
                     };
@@ -7197,7 +7338,7 @@ export interface paths {
          * List wallets
          * @description Retrieves a list of wallets for the authenticated user (owned + shared via wallets_users).
          *
-         *     Each wallet includes `access_role` (owner/admin/manager/user) and `is_owner` boolean.
+         *     Each wallet includes `access_role` (owner/admin/user/auditor) and `is_owner` boolean.
          *
          *     **Authentication**: Bearer token with x-tenant-id header required
          *
@@ -7210,7 +7351,7 @@ export interface paths {
                     /** @description Number of items to return */
                     limit?: number;
                     /** @description Filter wallets by user's access role */
-                    role?: "owner" | "admin" | "manager" | "user";
+                    role?: "owner" | "admin" | "user" | "auditor";
                     /** @description Include shared wallets (via wallets_users table) */
                     include_shared?: boolean;
                     /** @description Field to sort the merged owned + shared wallet list by */
@@ -7236,8 +7377,13 @@ export interface paths {
                             data: {
                                 /** Format: uuid */
                                 uuid: string;
-                                /** @description Wallet display name (mirrors POST/PATCH responses) */
+                                /** @description Raw wallet name (may be null) */
                                 name: string | null;
+                                /**
+                                 * @description Computed label — wallet name, else KYC-derived (business_name / first+last), else "New account". Always present.
+                                 * @example Acme LLC
+                                 */
+                                display_name?: string;
                                 /** @description Avatar URL for the wallet */
                                 logo_url: string | null;
                                 /** Format: uuid */
@@ -7252,12 +7398,12 @@ export interface paths {
                                  *
                                  * @enum {string}
                                  */
-                                role: "owner" | "admin" | "manager" | "user";
+                                role: "owner" | "admin" | "user" | "auditor";
                                 /**
                                  * @description User's access role for this wallet
                                  * @enum {string}
                                  */
-                                access_role: "owner" | "admin" | "manager" | "user";
+                                access_role: "owner" | "admin" | "user" | "auditor";
                                 /** @description True if user is the wallet owner */
                                 is_owner: boolean;
                                 /** @description KYC entity attached to the wallet (joined from `kyc_entity`).
@@ -7305,7 +7451,11 @@ export interface paths {
          * Create wallet
          * @description Creates a new wallet for the authenticated user.
          *
-         *     - **name** is auto-generated if not provided (e.g., "Golden Vault 42")
+         *     - **name** — if provided (non-empty) it is used as-is.
+         *     - When **name** is omitted/blank, **empty_name** decides the fallback:
+         *       - `empty_name: false` or omitted (default) → a random placeholder name
+         *         is generated (e.g., "Golden Vault 42").
+         *       - `empty_name: true` → the wallet is created with `name: null`.
          *
          *     **Authentication**: Bearer token with x-tenant-id header required
          *
@@ -7321,10 +7471,18 @@ export interface paths {
                 content: {
                     "application/json": {
                         /**
-                         * @description Wallet name (auto-generated if not provided)
+                         * @description Wallet name. Used as-is when non-empty.
                          * @example My Main Wallet
                          */
                         name?: string;
+                        /**
+                         * @description Only relevant when `name` is omitted/blank.
+                         *     `true` → store `name: null`; `false`/omitted → generate a random name.
+                         *
+                         * @default false
+                         * @example true
+                         */
+                        empty_name?: boolean;
                     };
                 };
             };
@@ -7343,6 +7501,11 @@ export interface paths {
                                 uuid: string;
                                 /** @example Golden Vault 42 */
                                 name: string | null;
+                                /**
+                                 * @description Computed label — wallet name, else KYC-derived (business_name / first+last), else "New account". Always present.
+                                 * @example Golden Vault 42
+                                 */
+                                display_name?: string;
                                 logo_url: string | null;
                                 /** Format: uuid */
                                 tenant_id: string;
@@ -7610,6 +7773,11 @@ export interface paths {
                                 /** Format: uuid */
                                 uuid: string;
                                 name: string | null;
+                                /**
+                                 * @description Computed label — wallet name, else KYC-derived (business_name / first+last), else "New account". Always present.
+                                 * @example Acme LLC
+                                 */
+                                display_name?: string;
                                 logo_url: string | null;
                                 /** Format: uuid */
                                 tenant_id: string;
@@ -7651,12 +7819,12 @@ export interface paths {
                                  *
                                  * @enum {string}
                                  */
-                                role?: "owner" | "admin" | "manager" | "user";
+                                role?: "owner" | "admin" | "user" | "auditor";
                                 /**
                                  * @description User's role for this wallet (only present when called via member access)
                                  * @enum {string}
                                  */
-                                access_role?: "owner" | "admin" | "manager" | "user";
+                                access_role?: "owner" | "admin" | "user" | "auditor";
                                 is_owner?: boolean;
                             };
                         };
@@ -7735,6 +7903,11 @@ export interface paths {
                                 uuid: string;
                                 /** @example My Updated Wallet */
                                 name: string | null;
+                                /**
+                                 * @description Computed label — wallet name, else KYC-derived (business_name / first+last), else "New account". Always present.
+                                 * @example My Updated Wallet
+                                 */
+                                display_name?: string;
                                 logo_url: string | null;
                                 /** Format: uuid */
                                 tenant_id: string;
@@ -8496,7 +8669,7 @@ export interface paths {
                     /** @description Search by first_name, last_name, email, or phone */
                     search?: string;
                     /** @description Filter by role */
-                    role?: "owner" | "admin" | "user";
+                    role?: "owner" | "admin" | "user" | "auditor";
                     /** @description Filter by active status (default true) */
                     is_active?: boolean;
                 };
@@ -8522,7 +8695,7 @@ export interface paths {
                                 /** Format: uuid */
                                 user_data_uuid?: string;
                                 /** @enum {string} */
-                                role?: "owner" | "admin" | "user";
+                                role?: "owner" | "admin" | "user" | "auditor";
                                 is_active?: boolean;
                                 /** Format: date-time */
                                 created_at?: string;
@@ -8603,7 +8776,7 @@ export interface paths {
                          * @description Role to assign to the user
                          * @enum {string}
                          */
-                        role: "user" | "admin";
+                        role: "auditor" | "user" | "admin";
                     };
                 };
             };
@@ -8623,7 +8796,7 @@ export interface paths {
                                 /** Format: uuid */
                                 user_data_uuid?: string;
                                 /** @enum {string} */
-                                role?: "user" | "admin";
+                                role?: "auditor" | "user" | "admin";
                                 is_active?: boolean;
                                 /** Format: date-time */
                                 created_at?: string;
@@ -8784,7 +8957,7 @@ export interface paths {
                          * @description New role for the user
                          * @enum {string}
                          */
-                        role: "user" | "admin";
+                        role: "auditor" | "user" | "admin";
                     };
                 };
             };
@@ -9032,7 +9205,7 @@ export interface paths {
                     limit?: number;
                     /** @description When true — only used invites; when false — only pending; omit for all. */
                     is_completed?: boolean;
-                    role?: "user" | "admin";
+                    role?: "auditor" | "user" | "admin";
                     /** @description Case-insensitive search by email */
                     search?: string;
                 };
@@ -9081,7 +9254,7 @@ export interface paths {
          *
          *     **Rules:**
          *     - Only the wallet **owner** can create invites
-         *     - `role` must be one of: `user`, `admin` (owner cannot be assigned via invite)
+         *     - `role` must be one of: `auditor`, `user`, `admin` (owner cannot be assigned via invite)
          *     - If an active (not used, not expired) invite for the same email already exists,
          *       it is superseded (expired) and replaced with a new one
          *     - Cannot invite yourself
@@ -9113,7 +9286,7 @@ export interface paths {
                          * @description Role to assign on acceptance
                          * @enum {string}
                          */
-                        role: "user" | "admin";
+                        role: "auditor" | "user" | "admin";
                     };
                 };
             };
@@ -9426,8 +9599,9 @@ export interface components {
             /** Format: uuid */
             destination_currency?: string;
             vendor_account_id?: string | null;
-            /** @description Bank account details for deposits */
+            /** @description Bank account details for deposits. Returned null when deposits are disabled for the account. */
             account_details?: Record<string, never> | null;
+            /** @description Deposit requisites. Returned null when deposits are disabled for the account. */
             deposit_instructions?: Record<string, never> | null;
             current_balance?: number | null;
             available_balance?: number | null;
@@ -9556,7 +9730,7 @@ export interface components {
              * @description Role granted upon acceptance
              * @enum {string}
              */
-            role: "user" | "admin";
+            role: "auditor" | "user" | "admin";
             /** @description 16-char uppercase hex code delivered by email */
             code: string;
             /** Format: date-time */