squarefi-bff-api-module 1.36.77 → 1.36.78

package/dist/api/index.d.ts

@@ -10,6 +10,7 @@ import { list } from './list';
 import { massPayouts } from './mass-payouts';
 import { orders } from './orders';
 import { referrals } from './referrals';
+import { rfi } from './rfi';
 import { statements } from './statements';
 import { storage } from './storage';
 import { tenants } from './tenants';
@@ -30,6 +31,7 @@ type Api = {
     massPayouts: typeof massPayouts;
     orders: typeof orders;
     referrals: typeof referrals;
+    rfi: typeof rfi;
     statements: typeof statements;
     storage: typeof storage;
     tenants: typeof tenants;

package/dist/api/index.js

@@ -10,6 +10,7 @@ import { list } from './list';
 import { massPayouts } from './mass-payouts';
 import { orders } from './orders';
 import { referrals } from './referrals';
+import { rfi } from './rfi';
 import { statements } from './statements';
 import { storage } from './storage';
 import { tenants } from './tenants';
@@ -30,6 +31,7 @@ export const squarefi_bff_api_client = {
     massPayouts,
     orders,
     referrals,
+    rfi,
     statements,
     storage,
     tenants,

package/dist/api/rfi.d.ts

@@ -0,0 +1,11 @@
+import { API } from './types/types';
+/**
+ * Requests for information from compliance (SFI-2280), scoped by `wallet_id`. The client can only
+ * read and answer them: the spec declares no method to close, edit or delete one.
+ */
+export declare const rfi: {
+    list: ({ wallet_id, ...params }: API.Rfi.List.Request) => Promise<API.Rfi.List.Response>;
+    getById: ({ wallet_id, case_id }: API.Rfi.GetById.Request) => Promise<API.Rfi.GetById.Response>;
+    reply: ({ wallet_id, case_id, body, files, signal, timeout, }: API.Rfi.Reply.Request) => Promise<API.Rfi.Reply.Response>;
+    getAttachmentLink: ({ wallet_id, case_id, attachment_id, }: API.Rfi.GetAttachmentLink.Request) => Promise<API.Rfi.GetAttachmentLink.Response>;
+};

package/dist/api/rfi.js

@@ -0,0 +1,26 @@
+import { apiClientV1Frontend } from '../utils/apiClientFactory';
+/**
+ * Requests for information from compliance (SFI-2280), scoped by `wallet_id`. The client can only
+ * read and answer them: the spec declares no method to close, edit or delete one.
+ */
+export const rfi = {
+    list: ({ wallet_id, ...params }) => apiClientV1Frontend.getRequest(`/frontend/rfi/${wallet_id}`, { params }),
+    getById: ({ wallet_id, case_id }) => apiClientV1Frontend.getRequest(`/frontend/rfi/${wallet_id}/${case_id}`),
+    // Each file is its own part named `files` (repeated, not `files[]`) — the form verified live.
+    // Content-Type is left to the browser, which adds the multipart boundary. A reply carries up to
+    // 10 files of 20 MB, which the client's 60 s default timeout may not cover: pass `timeout`.
+    reply: ({ wallet_id, case_id, body, files, signal, timeout, }) => {
+        const formData = new FormData();
+        if (body)
+            formData.append('body', body);
+        files?.forEach((file) => formData.append('files', file));
+        return apiClientV1Frontend.postRequest(`/frontend/rfi/${wallet_id}/${case_id}/messages`, {
+            data: formData,
+            signal,
+            timeout,
+        });
+    },
+    // The signed link lives `expires_in` seconds (about 120): open it right away and request a new
+    // one for every download instead of storing it.
+    getAttachmentLink: ({ wallet_id, case_id, attachment_id, }) => apiClientV1Frontend.getRequest(`/frontend/rfi/${wallet_id}/${case_id}/attachments/${attachment_id}`),
+};

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

@@ -1661,6 +1661,52 @@ export declare namespace API {
         }
         export {};
     }
+    /**
+     * Requests for information (RFI, SFI-2280): compliance's questions about an account or its
+     * transactions, answered by the account's team with text and files.
+     *
+     * Every path is scoped by `wallet_id`, so each Request carries it. Responses are the frontend
+     * `{ success, data }` envelope as the spec declares it. Every `Rfi*` field is optional for now
+     * because the spec declares no `required`; the types tighten on the regeneration that adds it.
+     */
+    namespace Rfi {
+        type CasesRoot = pathsV1Frontend['/frontend/rfi/{wallet_id}'];
+        type CaseRoot = pathsV1Frontend['/frontend/rfi/{wallet_id}/{case_id}'];
+        type CaseMessagesRoot = pathsV1Frontend['/frontend/rfi/{wallet_id}/{case_id}/messages'];
+        type CaseAttachmentRoot = pathsV1Frontend['/frontend/rfi/{wallet_id}/{case_id}/attachments/{attachment_id}'];
+        export type Case = componentsV1Frontend['schemas']['RfiCase'];
+        export type CaseDetail = componentsV1Frontend['schemas']['RfiCaseDetail'];
+        export type Message = componentsV1Frontend['schemas']['RfiMessage'];
+        export type Attachment = componentsV1Frontend['schemas']['RfiAttachment'];
+        export type Transaction = componentsV1Frontend['schemas']['RfiTransaction'];
+        export type CaseStatus = NonNullable<Case['status']>;
+        export type CaseType = NonNullable<Case['type']>;
+        export type MessageAuthor = NonNullable<Message['author']>;
+        /** The list's `status` filter. `open` = `action_required` + `awaiting_compliance`; no case has it. */
+        export type ListStatus = NonNullable<List.Request['status']>;
+        export type Summary = NonNullable<NonNullable<List.Response['data']>['summary']>;
+        export namespace List {
+            type Request = CasesRoot['get']['parameters']['path'] & NonNullable<CasesRoot['get']['parameters']['query']>;
+            type Response = CasesRoot['get']['responses']['200']['content']['application/json'];
+        }
+        export namespace GetById {
+            type Request = CaseRoot['get']['parameters']['path'];
+            type Response = CaseRoot['get']['responses']['200']['content']['application/json'];
+        }
+        export namespace Reply {
+            type Request = CaseMessagesRoot['post']['parameters']['path'] & Omit<CaseMessagesRoot['post']['requestBody']['content']['multipart/form-data'], 'files'> & {
+                files?: File[];
+                signal?: AbortSignal;
+                timeout?: number;
+            };
+            type Response = CaseMessagesRoot['post']['responses']['201']['content']['application/json'];
+        }
+        export namespace GetAttachmentLink {
+            type Request = CaseAttachmentRoot['get']['parameters']['path'];
+            type Response = CaseAttachmentRoot['get']['responses']['200']['content']['application/json'];
+        }
+        export {};
+    }
     namespace Orders {
         namespace Create {
             namespace ByOrderType {

package/package.json

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