squarefi-bff-api-module 1.36.38 → 1.36.40

package/dist/api/frontend.d.ts

@@ -14,6 +14,18 @@ export declare const frontend: {
             deposit: ({ card_id, ...data }: API.Frontend.Issuing.Cards.Deposit.Request) => Promise<API.Frontend.Issuing.Cards.Deposit.Response>;
             withdraw: ({ card_id, ...data }: API.Frontend.Issuing.Cards.Withdraw.Request) => Promise<API.Frontend.Issuing.Cards.Withdraw.Response>;
         };
+        cardholders: {
+            list: (params?: API.Frontend.Issuing.Cardholders.List.Request) => Promise<API.Frontend.Issuing.Cardholders.List.Response>;
+            create: (data: API.Frontend.Issuing.Cardholders.Create.Request) => Promise<API.Frontend.Issuing.Cardholders.Create.Response>;
+            getById: ({ cardholder_id, ...params }: API.Frontend.Issuing.Cardholders.Get.Request) => Promise<API.Frontend.Issuing.Cardholders.Get.Response>;
+            delete: ({ cardholder_id, ...params }: API.Frontend.Issuing.Cardholders.Delete.Request) => Promise<API.Frontend.Issuing.Cardholders.Delete.Response>;
+            submit: ({ cardholder_id, ...params }: API.Frontend.Issuing.Cardholders.Submit.Request) => Promise<API.Frontend.Issuing.Cardholders.Submit.Response>;
+            documents: {
+                upload: ({ wallet_id, ...files }: API.Frontend.Issuing.Cardholders.Documents.Upload.Request) => Promise<API.Frontend.Issuing.Cardholders.Documents.Upload.Response>;
+                discard: ({ document_id, ...params }: API.Frontend.Issuing.Cardholders.Documents.Discard.Request) => Promise<void>;
+                attach: ({ cardholder_id, wallet_id, ...data }: API.Frontend.Issuing.Cardholders.Documents.Attach.Request) => Promise<API.Frontend.Issuing.Cardholders.Documents.Attach.Response>;
+            };
+        };
         subAccounts: {
             deposit: ({ sub_account_id, ...data }: API.Frontend.Issuing.SubAccounts.Deposit.Request) => Promise<API.Frontend.Issuing.SubAccounts.Deposit.Response>;
             withdraw: ({ sub_account_id, ...data }: API.Frontend.Issuing.SubAccounts.Withdraw.Request) => Promise<API.Frontend.Issuing.SubAccounts.Withdraw.Response>;

package/dist/api/frontend.js

@@ -23,6 +23,43 @@ export const frontend = {
             deposit: ({ card_id, ...data }) => apiClientV1Frontend.postRequest(`/frontend/issuing/cards/${card_id}/deposit`, { data }),
             withdraw: ({ card_id, ...data }) => apiClientV1Frontend.postRequest(`/frontend/issuing/cards/${card_id}/withdraw`, { data }),
         },
+        // Cardholder create flow (see the OpenAPI spec for details):
+        //   1. `cardholders.create` — creates a DRAFT; no vendor is contacted. In `user_data_id` mode
+        //      the KYC documents are seeded from the verified user, so step 2 is usually unnecessary.
+        //   2. `cardholders.documents.upload` (one file per request, before or after the draft exists)
+        //      + `cardholders.documents.attach` — attach the returned upload ids to the draft.
+        //   3. `cardholders.submit` — registers at the vendor and flips the cardholder to ACTIVE.
+        // All write endpoints require the ADMIN role on the wallet; `wallet_id` travels as a query
+        // parameter for access validation.
+        cardholders: {
+            list: (params = {}) => apiClientV1Frontend.getRequest('/frontend/issuing/cardholders', { params }),
+            create: (data) => apiClientV1Frontend.postRequest('/frontend/issuing/cardholders', { data }),
+            getById: ({ cardholder_id, ...params }) => apiClientV1Frontend.getRequest(`/frontend/issuing/cardholders/${cardholder_id}`, { params }),
+            delete: ({ cardholder_id, ...params }) => apiClientV1Frontend.deleteRequest(`/frontend/issuing/cardholders/${cardholder_id}`, { params }),
+            // Retryable: a failed submit leaves the draft untouched, so it can be called again once the
+            // dossier is complete (a `400 CARDHOLDER_SUBMISSION_INCOMPLETE` lists what is missing in
+            // `error.details.missing`). While a review is running — or once the cardholder is live —
+            // another submit returns `409 CARDHOLDER_NOT_DRAFT`.
+            submit: ({ cardholder_id, ...params }) => apiClientV1Frontend.postRequest(`/frontend/issuing/cardholders/${cardholder_id}/submit`, { params }),
+            documents: {
+                // Send the file the camera produced, unchanged (no crop/resize/re-encode — the vendor's
+                // tampering check can flag a re-encoded photo as forgery), one file per request so the UI
+                // can show per-file progress and retry. Content-Type is set by the browser via FormData.
+                upload: ({ wallet_id, ...files }) => {
+                    const formData = new FormData();
+                    Object.entries(files).forEach(([type, file]) => {
+                        if (file)
+                            formData.append(type, file);
+                    });
+                    return apiClientV1Frontend.postRequest('/frontend/issuing/cardholder-documents', { data: formData, params: { wallet_id } });
+                },
+                // Only uploads not yet attached to a cardholder can be discarded (attached ones answer 409);
+                // an upload that is never attached is deleted by a cleanup sweep anyway.
+                discard: ({ document_id, ...params }) => apiClientV1Frontend.deleteRequest(`/frontend/issuing/cardholder-documents/${document_id}`, { params }),
+                // Attaching a document of a type the cardholder already has replaces the previous one.
+                attach: ({ cardholder_id, wallet_id, ...data }) => apiClientV1Frontend.postRequest(`/frontend/issuing/cardholders/${cardholder_id}/documents`, { data, params: { wallet_id } }),
+            },
+        },
         subAccounts: {
             deposit: ({ sub_account_id, ...data }) => apiClientV1Frontend.postRequest(`/frontend/issuing/sub-accounts/${sub_account_id}/deposit`, { data }),
             // Concurrent withdrawals on the same sub-account are rejected with `409`. The currency is

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

@@ -5013,8 +5013,16 @@ export interface paths {
                          * @example b2f3d8c1-4a7e-4d22-9c5f-1e6a8d0b2a44
                          */
                         counterparty_destination_id: string;
-                        /** @example 50 */
+                        /**
+                         * @description Amount to send, in `from_currency_id` units. With `is_reverse: true` — the amount the receiver must be credited.
+                         * @example 50
+                         */
                         amount: number;
+                        /**
+                         * @description Optional. When true, `amount` is the receive-amount and the debited amount is grossed up with fees.
+                         * @default false
+                         */
+                        is_reverse?: boolean;
                         /**
                          * Format: date-time
                          * @description Optional. Schedule the transfer for a future time (min 1 hour, max 90 days ahead). No funds are reserved; after approval the order waits in EXPECTED status and executes automatically.

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

@@ -5969,8 +5969,8 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * Effective delivery-channel preferences
-         * @description Full channel list with defaults applied. `IN_APP` is always enabled (cannot be disabled).
+         * Effective notification preferences
+         * @description Both dimensions in full with defaults applied — delivery channels (`IN_APP` is always enabled) and notification categories (every category is user-configurable).
          */
         get: {
             parameters: {
@@ -5981,7 +5981,7 @@ export interface paths {
             };
             requestBody?: never;
             responses: {
-                /** @description Effective preference per channel. */
+                /** @description Effective preference per channel and per category. */
                 200: {
                     headers: {
                         [name: string]: unknown;
@@ -5992,6 +5992,7 @@ export interface paths {
                             success?: boolean;
                             data?: {
                                 preferences?: components["schemas"]["NotificationPreference"][];
+                                categories?: components["schemas"]["NotificationCategoryPreference"][];
                             };
                         };
                     };
@@ -6000,8 +6001,8 @@ export interface paths {
             };
         };
         /**
-         * Update delivery-channel preferences
-         * @description Bulk upsert. Disabling `IN_APP` is rejected with 400 (`INBOX_CHANNEL_LOCKED`). Changes apply from the next delivery.
+         * Update notification preferences
+         * @description Bulk upsert of either or both dimensions. Disabling the `IN_APP` channel is rejected with 400 (`INBOX_CHANNEL_LOCKED`). A disabled category mutes push and email for its notifications; the inbox always receives them. Changes apply from the next delivery.
          */
         put: {
             parameters: {
@@ -6013,12 +6014,13 @@ export interface paths {
             requestBody: {
                 content: {
                     "application/json": {
-                        preferences: components["schemas"]["NotificationPreference"][];
+                        preferences?: components["schemas"]["NotificationPreference"][];
+                        categories?: components["schemas"]["NotificationCategoryPreference"][];
                     };
                 };
             };
             responses: {
-                /** @description Effective preference list after the update. */
+                /** @description Effective preferences of both dimensions after the update. */
                 200: {
                     headers: {
                         [name: string]: unknown;
@@ -6029,6 +6031,7 @@ export interface paths {
                             success?: boolean;
                             data?: {
                                 preferences?: components["schemas"]["NotificationPreference"][];
+                                categories?: components["schemas"]["NotificationCategoryPreference"][];
                             };
                         };
                     };
@@ -6598,7 +6601,13 @@ export interface paths {
                          * @description Counterparty destination of type INTERNAL (points at the receiver wallet).
                          */
                         counterparty_destination_id: string;
+                        /** @description Amount to send, in `from_currency_id` units. With `is_reverse: true` — the amount the receiver must be credited. */
                         amount: number;
+                        /**
+                         * @description When true, `amount` is the receive-amount and the debited amount is grossed up with fees.
+                         * @default false
+                         */
+                        is_reverse?: boolean;
                         /**
                          * Format: date-time
                          * @description Optional. Schedule the transfer for a future time (min 1 hour, max 90 days ahead). No funds are reserved; after approval the order waits in EXPECTED status and executes automatically.
@@ -13005,7 +13014,12 @@ export interface components {
         };
         NotificationPreference: {
             /** @enum {string} */
-            channel: "IN_APP" | "PUSH";
+            channel: "IN_APP" | "PUSH" | "EMAIL";
+            enabled: boolean;
+        };
+        NotificationCategoryPreference: {
+            /** @enum {string} */
+            category: "TRANSACTIONS" | "COMPLIANCE";
             enabled: boolean;
         };
     };

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

@@ -2570,7 +2570,13 @@ export interface paths {
                          * @description Counterparty destination of type INTERNAL (points at the receiver wallet).
                          */
                         counterparty_destination_id: string;
+                        /** @description Amount to send, in `from_currency_id` units. With `is_reverse: true` — the amount the receiver must be credited. */
                         amount: number;
+                        /**
+                         * @description When true, `amount` is the receive-amount and the debited amount is grossed up with fees.
+                         * @default false
+                         */
+                        is_reverse?: boolean;
                         /**
                          * Format: date-time
                          * @description Optional. Schedule the transfer for a future time (min 1 hour, max 90 days ahead). No funds are reserved; after approval the order waits in EXPECTED status and executes automatically.

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

@@ -676,6 +676,11 @@ export declare namespace API {
             type CardWithdrawRoot = pathsV1Frontend['/frontend/issuing/cards/{card_id}/withdraw'];
             type SubAccountDepositRoot = pathsV1Frontend['/frontend/issuing/sub-accounts/{sub_account_id}/deposit'];
             type SubAccountWithdrawRoot = pathsV1Frontend['/frontend/issuing/sub-accounts/{sub_account_id}/withdraw'];
+            type CardholdersRoot = pathsV1Frontend['/frontend/issuing/cardholders'];
+            type CardholderRoot = pathsV1Frontend['/frontend/issuing/cardholders/{cardholder_id}'];
+            type CardholderSubmitRoot = pathsV1Frontend['/frontend/issuing/cardholders/{cardholder_id}/submit'];
+            type CardholderDocumentsUploadRoot = pathsV1Frontend['/frontend/issuing/cardholder-documents'];
+            type CardholderAttachDocumentsRoot = pathsV1Frontend['/frontend/issuing/cardholders/{cardholder_id}/documents'];
             type WithOrderStatus<T extends {
                 data?: {
                     status?: string;
@@ -718,6 +723,64 @@ export declare namespace API {
                     type Response = SubAccounts.Withdraw.Response;
                 }
             }
+            export namespace Cardholders {
+                type Cardholder = componentsV1Frontend['schemas']['IssuingCardholder'];
+                namespace List {
+                    type Request = NonNullable<CardholdersRoot['get']['parameters']['query']>;
+                    type Response = CardholdersRoot['get']['responses']['200']['content']['application/json'];
+                }
+                namespace Create {
+                    type Request = CardholdersRoot['post']['requestBody']['content']['application/json'];
+                    type Response = CardholdersRoot['post']['responses']['201']['content']['application/json'];
+                }
+                namespace Get {
+                    type Request = {
+                        cardholder_id: string;
+                    } & NonNullable<CardholderRoot['get']['parameters']['query']>;
+                    type Response = CardholderRoot['get']['responses']['200']['content']['application/json'];
+                }
+                namespace Delete {
+                    type Request = {
+                        cardholder_id: string;
+                    } & NonNullable<CardholderRoot['delete']['parameters']['query']>;
+                    type Response = CardholderRoot['delete']['responses']['200']['content']['application/json'];
+                }
+                namespace Submit {
+                    type Request = {
+                        cardholder_id: string;
+                    } & CardholderSubmitRoot['post']['parameters']['query'];
+                    type Response = CardholderSubmitRoot['post']['responses']['200']['content']['application/json'];
+                }
+                namespace Documents {
+                    type DocumentType = keyof CardholderDocumentsUploadRoot['post']['requestBody']['content']['multipart/form-data'];
+                    namespace Upload {
+                        type Request = {
+                            wallet_id: string;
+                        } & {
+                            [K in DocumentType]?: File | Blob;
+                        };
+                        type Response = CardholderDocumentsUploadRoot['post']['responses']['201']['content']['application/json'];
+                        type Document = NonNullable<NonNullable<Response['data']>['documents']>[number];
+                    }
+                    namespace Discard {
+                        type Request = {
+                            document_id: string;
+                            wallet_id: string;
+                        };
+                    }
+                    namespace Attach {
+                        export type Request = {
+                            cardholder_id: string;
+                            wallet_id: string;
+                        } & CardholderAttachDocumentsRoot['post']['requestBody']['content']['application/json'];
+                        type RawResponse = CardholderAttachDocumentsRoot['post']['responses']['200']['content']['application/json'];
+                        export type Response = Omit<RawResponse, 'data'> & {
+                            data?: Cardholder;
+                        };
+                        export {};
+                    }
+                }
+            }
             export {};
         }
     }

package/package.json

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