squarefi-bff-api-module 1.36.68 → 1.36.70

package/dist/api/frontend.d.ts

@@ -67,4 +67,8 @@ export declare const frontend: {
             list: (params?: API.Frontend.Reference.ExchangeRates.List.Request) => Promise<API.Frontend.Reference.ExchangeRates.List.Response>;
         };
     };
+    notificationPreferences: {
+        get: () => Promise<API.Frontend.NotificationPreferences.Get.Response>;
+        update: (data: API.Frontend.NotificationPreferences.Update.Request) => Promise<API.Frontend.NotificationPreferences.Update.Response>;
+    };
 };

package/dist/api/frontend.js

@@ -138,4 +138,9 @@ export const frontend = {
             list: (params = {}) => apiClientV1Frontend.getRequest('/frontend/reference/exchange_rates', { params }),
         },
     },
+    // IN_APP stays on (400 INBOX_CHANNEL_LOCKED); channels vary by tenant (TELEGRAM needs a bot); PUT upserts any subset.
+    notificationPreferences: {
+        get: () => apiClientV1Frontend.getRequest('/frontend/notification-preferences'),
+        update: (data) => apiClientV1Frontend.putRequest('/frontend/notification-preferences', { data }),
+    },
 };

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

@@ -1996,7 +1996,7 @@ export interface paths {
                         "application/json": components["schemas"]["ApiErrorResponse"];
                     };
                 };
-                /** @description Cardholder with this email already exists in this wallet + issuing_program. `error.details.cardholder_id` names the conflicting cardholder (when it could be resolved) so the client can adopt it instead of dead-ending.
+                /** @description A cardholder already exists for this person in this wallet + issuing_program — the member named by `user_data_id` already holds one, or one carries this email. `error.details.cardholder_id` names it (when it could be resolved) so the client can adopt it instead of dead-ending. When `user_data_id` names a member who may adopt the row, the row is first completed from that member's KYC dossier: empty identity fields and document photos of a type it does not hold are filled in, and nothing already on it is changed.
                  *      */
                 409: {
                     headers: {

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

@@ -5438,7 +5438,7 @@ export interface paths {
                     };
                     content?: never;
                 };
-                /** @description Cardholder with this email already exists in this wallet + issuing_program. `error.details.cardholder_id` names the conflicting cardholder (when it could be resolved) so the client can adopt it instead of dead-ending.
+                /** @description A cardholder already exists for this person in this wallet + issuing_program — the member named by `user_data_id` already holds one, or one carries this email. `error.details.cardholder_id` names it (when it could be resolved) so the client can adopt it instead of dead-ending. When `user_data_id` names a member who may adopt the row, the row is first completed from that member's KYC dossier: empty identity fields and document photos of a type it does not hold are filled in, and nothing already on it is changed. Re-read the row for its refreshed `missing_kyc_fields`.
                  *      */
                 409: {
                     headers: {
@@ -5749,6 +5749,13 @@ export interface paths {
          *       demands (a required document — usually the selfie — was never captured). Read
          *       `required_level` to name the bar ("requires FULL verification"). Same remediation as
          *       `NEEDS_VERIFICATION`, run to add the missing step.
+         *     - `NEEDS_COMPLETION` — an ACTIVE cardholder is linked (`cardholder_id`), but it does not
+         *       hold what the program's ISSUANCE bar asks for — typically one written before that bar
+         *       existed. Creating a card now is refused with `400`; `will_require` names the same
+         *       fields that 400 would. Nothing is submitted again: `PATCH` the fields, and for the
+         *       document photos call `POST /cardholders` with the member's `user_data_id` — it answers
+         *       `409` with this `cardholder_id` after completing the row from the member's KYC
+         *       dossier. When the member has not passed that verification, run it first.
          *     - `NEEDS_RESUBMIT` — the VENDOR's review of the cardholder came back rejected (or asked
          *       for part of the dossier again). Not a dead end: fix what `reject_reason` names —
          *       `PATCH` the field, or re-upload and re-attach the document — then call
@@ -5767,7 +5774,8 @@ export interface paths {
          *
          *     **`will_require`**: fields the client should expect to collect BY HAND (same vocabulary
          *     as the submit 400 `missing` list, e.g. `address.line1`, `tax_identification_number`,
-         *     `email or phone`). For `DRAFT` it is the draft's actual leftovers; for `CAN_CREATE` it
+         *     `email or phone`). For `DRAFT` it is the draft's actual leftovers; for `NEEDS_COMPLETION`
+         *     it is what the card create refuses the row over; for `CAN_CREATE` it
          *     is a projection that assumes the KYC dossier covers what it usually covers — the created
          *     draft's `missing_kyc_fields` is the authoritative version.
          *
@@ -5813,10 +5821,10 @@ export interface paths {
                                 /** Format: uuid */
                                 user_data_id: string;
                                 /** @enum {string} */
-                                verdict: "READY" | "DRAFT" | "CAN_CREATE" | "PENDING" | "NEEDS_VERIFICATION" | "NEEDS_VERIFICATION_UPGRADE" | "NEEDS_RESUBMIT" | "ISSUER_REVIEW_PENDING" | "REJECTED" | "NOT_MEMBER";
+                                verdict: "READY" | "DRAFT" | "CAN_CREATE" | "PENDING" | "NEEDS_VERIFICATION" | "NEEDS_VERIFICATION_UPGRADE" | "NEEDS_COMPLETION" | "NEEDS_RESUBMIT" | "ISSUER_REVIEW_PENDING" | "REJECTED" | "NOT_MEMBER";
                                 /**
                                  * Format: uuid
-                                 * @description The linked cardholder for READY / DRAFT / NEEDS_RESUBMIT / ISSUER_REVIEW_PENDING verdicts
+                                 * @description The linked cardholder for READY / DRAFT / NEEDS_COMPLETION / NEEDS_RESUBMIT / ISSUER_REVIEW_PENDING verdicts
                                  *
                                  */
                                 cardholder_id: string | null;
@@ -12715,11 +12723,11 @@ export interface paths {
          *     **Access Control**: Any active wallet member. The response shape depends on the caller's role and
          *     is told apart by `access_role`:
          *     - `owner` / `admin` / `auditor` — the full wallet (`WalletDetails`): identity, KYC, `balance`,
-         *       `fiat_accounts`, `base_currency` and the totals.
+         *       `fiat_accounts`, `base_currency`, the totals and `api_access_enabled`.
          *     - `user` — a shell-only wallet (`WalletDetailsScopedUser`): `uuid`, `id`, `name`, `display_name`,
          *       `tenant_id`, `kyc_entity_id`, `kyc_info`, `created_at` + the role fields. `logo_url`, `balance`, `fiat_accounts`,
-         *       `base_currency`, `fiat_total`, `crypto_total`, `pending_balance` and `total_amount` are absent
-         *       (not null) for that role — check `access_role` before reading them.
+         *       `base_currency`, `fiat_total`, `crypto_total`, `pending_balance`, `total_amount` and `api_access_enabled`
+         *       are absent (not null) for that role — check `access_role` before reading them.
          *
          */
         get: {
@@ -12882,6 +12890,215 @@ export interface paths {
         };
         trace?: never;
     };
+    "/frontend/wallets/{wallet_id}/logo": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Upload wallet logo
+         * @description Uploads the company logo of the wallet and points `logo_url` at it. Replaces the legacy
+         *     `POST /wallets/{wallet_id}/logo`, which answered `{ fullPath }`: this endpoint answers with the
+         *     updated wallet — read the new URL from `data.logo_url`.
+         *
+         *     The file is checked by its content: PNG, JPEG or WebP, at most 1 MB. SVG is refused.
+         *     The previous logo file is kept in storage; only the wallet's pointer changes.
+         *
+         *     **Rate limit**: 10 uploads per hour per wallet; over it the endpoint answers `429 RATE_LIMIT_EXCEEDED`.
+         *
+         *     **Authentication**: Bearer token with x-tenant-id header required
+         *
+         *     **Access Control**: Owner or admin of the wallet; wallet KYC must be APPROVED
+         *
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description The ID of the wallet */
+                    wallet_id: string;
+                };
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "multipart/form-data": {
+                        /**
+                         * Format: binary
+                         * @description PNG, JPEG or WebP image, at most 1 MB.
+                         */
+                        file: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description Logo uploaded. `data` is the updated wallet, the same shape `PATCH /frontend/wallets/{wallet_id}` returns. */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example true */
+                            success: boolean;
+                            data: {
+                                /** Format: uuid */
+                                uuid: string;
+                                name: string | null;
+                                /** @description Computed label — wallet name, else KYC-derived (business_name / first+last), else "New account". Always present. */
+                                display_name: string;
+                                /**
+                                 * @description Public URL of the uploaded logo.
+                                 * @example https://api.example.com/storage/logo/0b5c2f4e-6a1d-4c8e-9f3a-2d7b1e5c8a90/7f1e2d3c-4b5a-4968-8776-5a4b3c2d1e0f.png
+                                 */
+                                logo_url: string;
+                                /** Format: uuid */
+                                tenant_id: string;
+                                /** Format: date-time */
+                                created_at: string;
+                                /** Format: uuid */
+                                kyc_entity_id: string | null;
+                                kyc_info: components["schemas"]["WalletKycInfo"] | null;
+                            };
+                            /** @example Wallet logo uploaded successfully */
+                            message: string;
+                        };
+                    };
+                };
+                /** @description No file, more than one file, a file over 1 MB, or content that is not a PNG, JPEG or WebP image
+                 *     (`INVALID_WALLET_LOGO`).
+                 *      */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Caller is not owner/admin of the wallet, or wallet KYC not approved */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Wallet not found */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description More than 10 logo uploads for this wallet within the last hour (`RATE_LIMIT_EXCEEDED`) */
+                429: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Server error */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Logo upload is not configured on this server */
+                503: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        /**
+         * Reset wallet logo
+         * @description Removes the company logo of the wallet: `logo_url` becomes `null`. Idempotent — resetting a wallet
+         *     without a logo succeeds the same way.
+         *
+         *     **Authentication**: Bearer token with x-tenant-id header required
+         *
+         *     **Access Control**: Owner or admin of the wallet; wallet KYC must be APPROVED
+         *
+         */
+        delete: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description The ID of the wallet */
+                    wallet_id: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Logo removed. `data` is the updated wallet, the same shape `PATCH /frontend/wallets/{wallet_id}` returns. */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example true */
+                            success: boolean;
+                            data: {
+                                /** Format: uuid */
+                                uuid: string;
+                                name: string | null;
+                                /** @description Computed label — wallet name, else KYC-derived (business_name / first+last), else "New account". Always present. */
+                                display_name: string;
+                                /**
+                                 * @description Always `null` after a reset.
+                                 * @example null
+                                 */
+                                logo_url: string | null;
+                                /** Format: uuid */
+                                tenant_id: string;
+                                /** Format: date-time */
+                                created_at: string;
+                                /** Format: uuid */
+                                kyc_entity_id: string | null;
+                                kyc_info: components["schemas"]["WalletKycInfo"] | null;
+                            };
+                            /** @example Wallet logo removed successfully */
+                            message: string;
+                        };
+                    };
+                };
+                /** @description Caller is not owner/admin of the wallet, or wallet KYC not approved */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Wallet not found */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Server error */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/frontend/wallets/{wallet_id}/balance": {
         parameters: {
             query?: never;
@@ -16288,6 +16505,11 @@ export interface components {
             crypto_total: number;
             pending_balance: number;
             total_amount: number;
+            /**
+             * @description Whether the wallet may use the developer API (`/api/*` with a wallet-bound key). Off by default; only a platform owner switches it. While `false`, API keys of this wallet are refused with `403 WALLET_API_DISABLED`.
+             * @example false
+             */
+            api_access_enabled: boolean;
             /**
              * @description The caller's role for this wallet. Never `user` on this shape. (enum property replaced by openapi-typescript)
              * @enum {string}
@@ -16301,7 +16523,7 @@ export interface components {
             /** @description `true` exactly when `access_role` is `owner`. */
             is_owner: boolean;
         };
-        /** @description Shell-only wallet read for the scoped `user` role: identity, KYC and display name. No main-account financials are ever included — `logo_url`, `balance`, `fiat_accounts`, `base_currency`, `fiat_total`, `crypto_total`, `pending_balance` and `total_amount` are absent, not null. Check `access_role` before reading balances. */
+        /** @description Shell-only wallet read for the scoped `user` role: identity, KYC and display name. No main-account financials are ever included — `logo_url`, `balance`, `fiat_accounts`, `base_currency`, `fiat_total`, `crypto_total`, `pending_balance`, `total_amount` and `api_access_enabled` are absent, not null. Check `access_role` before reading balances. */
         WalletDetailsScopedUser: {
             /** Format: uuid */
             uuid: string;

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

@@ -762,6 +762,21 @@ export declare namespace API {
                 export {};
             }
         }
+        namespace NotificationPreferences {
+            type NotificationPreferencesRoot = pathsV1Frontend['/frontend/notification-preferences'];
+            export type ChannelPreference = componentsV1Frontend['schemas']['NotificationPreference'];
+            export type CategoryPreference = componentsV1Frontend['schemas']['NotificationCategoryPreference'];
+            export type Channel = ChannelPreference['channel'];
+            export type Category = CategoryPreference['category'];
+            export namespace Get {
+                type Response = NotificationPreferencesRoot['get']['responses'][200]['content']['application/json'];
+            }
+            export namespace Update {
+                type Request = NotificationPreferencesRoot['put']['requestBody']['content']['application/json'];
+                type Response = NotificationPreferencesRoot['put']['responses'][200]['content']['application/json'];
+            }
+            export {};
+        }
         namespace Issuing {
             type CardsRoot = pathsV1Frontend['/frontend/issuing/cards'];
             type CardRoot = pathsV1Frontend['/frontend/issuing/cards/{card_id}'];
@@ -2940,6 +2955,11 @@ export declare namespace API {
                 type Request = operations['UserController_updateMyUserData']['requestBody']['content']['application/json'];
                 type Response = operations['UserController_updateMyUserData']['responses']['200']['content']['application/json'];
             }
+            namespace Logo {
+                namespace Upload {
+                    type Response = operations['UserController_uploadLogoFile']['responses']['200']['content']['application/json'];
+                }
+            }
         }
         namespace Verification {
             type Flow = components['schemas']['UserVerificationFlow'];
@@ -2960,6 +2980,7 @@ export declare namespace API {
         }
         type WalletsRoot = pathsV1Frontend['/frontend/wallets'];
         type WalletByIdRoot = pathsV1Frontend['/frontend/wallets/{wallet_id}'];
+        type WalletLogoRoot = pathsV1Frontend['/frontend/wallets/{wallet_id}/logo'];
         type WalletBalanceRoot = pathsV1Frontend['/frontend/wallets/{wallet_id}/balance'];
         type WalletDashboardRoot = pathsV1Frontend['/frontend/wallets/{wallet_id}/dashboard'];
         type WalletAddressesRoot = pathsV1Frontend['/frontend/wallets/{wallet_id}/addresses'];
@@ -2996,6 +3017,18 @@ export declare namespace API {
                 type Response = WalletByIdRoot['patch']['responses']['200']['content']['application/json'];
             }
         }
+        export namespace Logo {
+            namespace Upload {
+                type Request = WalletLogoRoot['post']['parameters']['path'] & {
+                    file: File;
+                };
+                type Response = WalletLogoRoot['post']['responses']['200']['content']['application/json'];
+            }
+            namespace Delete {
+                type Request = WalletLogoRoot['delete']['parameters']['path'];
+                type Response = WalletLogoRoot['delete']['responses']['200']['content']['application/json'];
+            }
+        }
         export namespace Balance {
             type Request = WalletBalanceRoot['get']['parameters']['path'] & NonNullable<WalletBalanceRoot['get']['parameters']['query']>;
             type Response = WalletBalanceRoot['get']['responses']['200']['content']['application/json'];

package/dist/api/user.d.ts

@@ -6,6 +6,10 @@ export declare const user: {
     userData: {
         get: (options?: GetUserDataOptions) => Promise<API.User.UserData.Get.Response>;
         update: (data: API.User.UserData.Update.Request) => Promise<API.User.UserData.Update.Response>;
+        logo: {
+            upload: (file: File) => Promise<API.User.UserData.Logo.Upload.Response>;
+            delete: () => Promise<void>;
+        };
     };
     verification: {
         init: (data: API.User.Verification.Init.Request) => Promise<API.User.Verification.Init.Response>;

package/dist/api/user.js

@@ -3,6 +3,16 @@ export const user = {
     userData: {
         get: (options) => apiClientV2.getRequest('/user/user-data', options?.bypassUnauthorizedHandler ? { context: { bypassUnauthorizedHandler: true } } : undefined),
         update: (data) => apiClientV2.patchRequest('/user/user-data', { data }),
+        logo: {
+            upload: (file) => {
+                const formData = new FormData();
+                formData.append('file', file);
+                return apiClientV2.postRequest('/user/user-data/logo', {
+                    data: formData,
+                });
+            },
+            delete: () => apiClientV2.deleteRequest('/user/user-data/logo'),
+        },
     },
     verification: {
         // Starts (or moves up) the per-user Sumsub level for the requested step and returns the WebSDK

package/dist/api/wallets.d.ts

@@ -4,6 +4,10 @@ export declare const wallets: {
     getAll: (params?: API.Wallets.WalletsList.Request) => Promise<API.Wallets.WalletsList.Response>;
     getByUuid: ({ wallet_id, ...params }: API.Wallets.Wallet.GetByUuid.Request) => Promise<API.Wallets.Wallet.GetByUuid.Response>;
     update: ({ wallet_id, ...data }: API.Wallets.Wallet.Update.Request) => Promise<API.Wallets.Wallet.Update.Response>;
+    logo: {
+        upload: ({ wallet_id, file }: API.Wallets.Logo.Upload.Request) => Promise<API.Wallets.Logo.Upload.Response>;
+        delete: ({ wallet_id }: API.Wallets.Logo.Delete.Request) => Promise<API.Wallets.Logo.Delete.Response>;
+    };
     getBalance: ({ wallet_id, ...params }: API.Wallets.Balance.Request) => Promise<API.Wallets.Balance.Response>;
     getDashboard: ({ wallet_id, ...params }: API.Wallets.Dashboard.Request) => Promise<API.Wallets.Dashboard.Response>;
     addresses: {

package/dist/api/wallets.js

@@ -9,6 +9,18 @@ export const wallets = {
     update: ({ wallet_id, ...data }) => apiClientV1Frontend.patchRequest(`/frontend/wallets/${wallet_id}`, {
         data,
     }),
+    // Company logo. Both calls answer with the updated wallet (read `data.logo_url`), unlike the legacy apiV2
+    // `POST /wallets/{wallet_id}/logo` and its `{ fullPath }`. Owner/admin only; the wallet's KYC must be APPROVED.
+    logo: {
+        upload: ({ wallet_id, file }) => {
+            const formData = new FormData();
+            formData.append('file', file);
+            return apiClientV1Frontend.postRequest(`/frontend/wallets/${wallet_id}/logo`, {
+                data: formData,
+            });
+        },
+        delete: ({ wallet_id }) => apiClientV1Frontend.deleteRequest(`/frontend/wallets/${wallet_id}/logo`),
+    },
     getBalance: ({ wallet_id, ...params }) => apiClientV1Frontend.getRequest(`/frontend/wallets/${wallet_id}/balance`, { params }),
     getDashboard: ({ wallet_id, ...params }) => apiClientV1Frontend.getRequest(`/frontend/wallets/${wallet_id}/dashboard`, { params }),
     addresses: {

package/dist/utils/apiClientFactory.js

@@ -47,6 +47,10 @@ export const createApiClient = ({ baseURL, isBearerToken, tenantId }) => {
         };
     });
     instance.interceptors.response.use((response) => response, (error) => {
+        // A request the caller aborted (e.g. `useOrderCalc` superseding a stale calc) is not a failure.
+        if (axios.isCancel(error)) {
+            return Promise.reject(error);
+        }
         if (typeof window === 'undefined') {
             return Promise.reject(error);
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "squarefi-bff-api-module",
-  "version": "1.36.68",
+  "version": "1.36.70",
   "description": "Squarefi BFF API client module",
   "type": "module",
   "main": "./dist/index.js",