squarefi-bff-api-module 1.36.93 → 1.36.94

package/dist/api/frontend.d.ts

@@ -88,4 +88,11 @@ export declare const frontend: {
         get: () => Promise<API.Frontend.NotificationPreferences.Get.Response>;
         update: (data: API.Frontend.NotificationPreferences.Update.Request) => Promise<API.Frontend.NotificationPreferences.Update.Response>;
     };
+    notifications: {
+        list: (params?: API.Frontend.Notifications.List.Request) => Promise<API.Frontend.Notifications.List.Response>;
+        unreadCount: () => Promise<API.Frontend.Notifications.UnreadCount.Response>;
+        markRead: (data: API.Frontend.Notifications.MarkRead.Request) => Promise<API.Frontend.Notifications.MarkRead.Response>;
+        markAllRead: () => Promise<API.Frontend.Notifications.MarkAllRead.Response>;
+        realtimeToken: () => Promise<API.Frontend.Notifications.RealtimeToken.Response>;
+    };
 };

package/dist/api/frontend.js

@@ -168,4 +168,16 @@ export const frontend = {
         get: () => apiClientV1Frontend.getRequest('/frontend/notification-preferences'),
         update: (data) => apiClientV1Frontend.putRequest('/frontend/notification-preferences', { data }),
     },
+    // Server-checked (400 VALIDATION_ERROR): `limit` 1-50 (20 by default), `cursor` up to 200 chars, 1-100 uuid
+    // `notification_ids`. The feed ends only on `next_cursor: null`; the count and mark-all-read span every wallet.
+    notifications: {
+        list: (params = {}) => apiClientV1Frontend.getRequest('/frontend/notifications', {
+            params,
+        }),
+        unreadCount: () => apiClientV1Frontend.getRequest('/frontend/notifications/unread-count'),
+        markRead: (data) => apiClientV1Frontend.postRequest('/frontend/notifications/mark-read', { data }),
+        markAllRead: () => apiClientV1Frontend.postRequest('/frontend/notifications/mark-all-read'),
+        // 503 REALTIME_DISABLED when realtime delivery is off for the deployment.
+        realtimeToken: () => apiClientV1Frontend.postRequest('/frontend/notifications/realtime-token'),
+    },
 };

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

@@ -2572,7 +2572,7 @@ export interface paths {
                         "application/json": components["schemas"]["ApiErrorResponse"];
                     };
                 };
-                /** @description Cardholder is live at the vendor, or its review is still running */
+                /** @description Cardholder is live at the vendor, or its review is still running. On a program that issues under the wallet's company: `WALLET_BUSINESS_NOT_ONBOARDED` (the wallet's business has not been registered with the card issuer) or `WALLET_BUSINESS_NOT_APPROVED` (its review is not approved yet). */
                 409: {
                     headers: {
                         [name: string]: unknown;

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

@@ -6239,7 +6239,7 @@ export interface paths {
                     };
                     content?: never;
                 };
-                /** @description Cardholder is live at the vendor, or its review is still running */
+                /** @description Cardholder is live at the vendor, or its review is still running. On a program that issues under the wallet's company: `WALLET_BUSINESS_NOT_ONBOARDED` (the wallet's business has not been registered with the card issuer) or `WALLET_BUSINESS_NOT_APPROVED` (its review is not approved yet). */
                 409: {
                     headers: {
                         [name: string]: unknown;

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

@@ -6936,7 +6936,7 @@ export interface paths {
                     };
                     content?: never;
                 };
-                /** @description Cardholder is live at the vendor, or its review is still running */
+                /** @description Cardholder is live at the vendor, or its review is still running. On a program that issues under the wallet's company: `WALLET_BUSINESS_NOT_ONBOARDED` (the wallet's business has not been registered with the card issuer) or `WALLET_BUSINESS_NOT_APPROVED` (its review is not approved yet). */
                 409: {
                     headers: {
                         [name: string]: unknown;

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

@@ -916,6 +916,42 @@ export declare namespace API {
             }
             export {};
         }
+        namespace Notifications {
+            type NotificationsRoot = pathsV1Frontend['/frontend/notifications'];
+            type UnreadCountRoot = pathsV1Frontend['/frontend/notifications/unread-count'];
+            type MarkReadRoot = pathsV1Frontend['/frontend/notifications/mark-read'];
+            type MarkAllReadRoot = pathsV1Frontend['/frontend/notifications/mark-all-read'];
+            type RealtimeTokenRoot = pathsV1Frontend['/frontend/notifications/realtime-token'];
+            type NotificationView = componentsV1Frontend['schemas']['NotificationView'];
+            export type Notification = Omit<NotificationView, 'payload'> & {
+                payload: Record<string, unknown>;
+            };
+            export type Type = NotificationView['type'];
+            export namespace List {
+                type RawResponse = NotificationsRoot['get']['responses'][200]['content']['application/json'];
+                export type Request = NonNullable<NotificationsRoot['get']['parameters']['query']>;
+                export type Response = Omit<RawResponse, 'data'> & {
+                    data?: Omit<NonNullable<RawResponse['data']>, 'items'> & {
+                        items?: Notification[];
+                    };
+                };
+                export {};
+            }
+            export namespace UnreadCount {
+                type Response = UnreadCountRoot['get']['responses'][200]['content']['application/json'];
+            }
+            export namespace MarkRead {
+                type Request = MarkReadRoot['post']['requestBody']['content']['application/json'];
+                type Response = MarkReadRoot['post']['responses'][200]['content']['application/json'];
+            }
+            export namespace MarkAllRead {
+                type Response = MarkAllReadRoot['post']['responses'][200]['content']['application/json'];
+            }
+            export namespace RealtimeToken {
+                type Response = RealtimeTokenRoot['post']['responses'][200]['content']['application/json'];
+            }
+            export {};
+        }
         namespace Issuing {
             type CardsRoot = pathsV1Frontend['/frontend/issuing/cards'];
             type CardRoot = pathsV1Frontend['/frontend/issuing/cards/{card_id}'];

package/package.json

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