squarefi-bff-api-module 1.36.109 → 1.36.110

package/dist/api/frontend.d.ts

@@ -105,6 +105,15 @@ export declare const frontend: {
             };
         };
     };
+    aml: {
+        quote: ({ wallet_id, ...params }: API.Frontend.Aml.Quote.Request) => Promise<API.Frontend.Aml.Quote.Response>;
+        screenings: {
+            create: ({ wallet_id, idempotency_key, ...data }: API.Frontend.Aml.Screenings.Create.Request) => Promise<API.Frontend.Aml.Screenings.Create.Response>;
+            list: ({ wallet_id, ...params }: API.Frontend.Aml.Screenings.List.Request) => Promise<API.Frontend.Aml.Screenings.List.Response>;
+            getById: ({ wallet_id, id, }: API.Frontend.Aml.Screenings.GetById.Request) => Promise<API.Frontend.Aml.Screenings.GetById.Response>;
+            report: ({ wallet_id, id, }: API.Frontend.Aml.Screenings.Report.Request) => Promise<API.Frontend.Aml.Screenings.Report.Response>;
+        };
+    };
     reference: {
         exchangeRates: {
             list: (params?: API.Frontend.Reference.ExchangeRates.List.Request) => Promise<API.Frontend.Reference.ExchangeRates.List.Response>;
@@ -115,6 +124,12 @@ export declare const frontend: {
         orderTypes: {
             list: (params?: API.Frontend.Reference.OrderTypes.List.Request) => Promise<API.Frontend.Reference.OrderTypes.List.Response>;
         };
+        currencies: {
+            list: (params?: API.Frontend.Reference.Currencies.List.Request) => Promise<API.Frontend.Reference.Currencies.List.Response>;
+        };
+        chains: {
+            list: (params?: API.Frontend.Reference.Chains.List.Request) => Promise<API.Frontend.Reference.Chains.List.Response>;
+        };
     };
     notificationPreferences: {
         get: () => Promise<API.Frontend.NotificationPreferences.Get.Response>;

package/dist/api/frontend.js

@@ -228,6 +228,21 @@ export const frontend = {
             },
         },
     },
+    // AML screening of crypto addresses. `quote` charges nothing; `screenings.create` charges the fee (an `AML_CHECK`
+    // order) and answers `PENDING` — wait for the realtime `WALLET_AML_SCREENINGS` hint, then `getById`, do not poll.
+    aml: {
+        quote: ({ wallet_id, ...params }) => apiClientV1Frontend.getRequest(`/frontend/aml/${wallet_id}/quote`, { params }),
+        screenings: {
+            create: ({ wallet_id, idempotency_key, ...data }) => apiClientV1Frontend.postRequest(`/frontend/aml/${wallet_id}/screenings`, {
+                data,
+                headers: idempotency_key ? { 'Idempotency-Key': idempotency_key } : undefined,
+            }),
+            list: ({ wallet_id, ...params }) => apiClientV1Frontend.getRequest(`/frontend/aml/${wallet_id}/screenings`, { params }),
+            getById: ({ wallet_id, id, }) => apiClientV1Frontend.getRequest(`/frontend/aml/${wallet_id}/screenings/${id}`),
+            // With `responseType: 'blob'` an error body (JSON) arrives as a Blob too.
+            report: ({ wallet_id, id, }) => apiClientV1Frontend.getRequest(`/frontend/aml/${wallet_id}/screenings/${id}/report`, { responseType: 'blob' }),
+        },
+    },
     reference: {
         // Frontend twin of `exchange.byOrderType.*` (legacy `GET /exchange/`): the same tenant pairs, but paged in
         // memory — 50 per page by default, 500 at most, in no particular order — and behind the bearer session.
@@ -247,6 +262,18 @@ export const frontend = {
         orderTypes: {
             list: (params = {}) => apiClientV1Frontend.getRequest('/frontend/reference/order_types', { params }),
         },
+        // `aml_supported`: the tenant's AML provider can screen addresses on the token's network; always `false` while
+        // screening is off for the tenant. The backend pages it (50 by default), so the whole list is asked for by default.
+        currencies: {
+            list: (params = {}) => apiClientV1Frontend.getRequest('/frontend/reference/currencies', { params: { limit: 500, ...params } }),
+        },
+        // `aml_supported`: the tenant's AML provider can screen addresses on the network; always `false` while screening
+        // is off for the tenant. Paged like `currencies`, so the whole list is asked for by default.
+        chains: {
+            list: (params = {}) => apiClientV1Frontend.getRequest('/frontend/reference/chains', {
+                params: { limit: 500, ...params },
+            }),
+        },
     },
     // IN_APP stays on (400 INBOX_CHANNEL_LOCKED); channels vary by tenant (TELEGRAM needs a bot); PUT upserts any subset.
     notificationPreferences: {

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

@@ -1031,6 +1031,48 @@ export declare namespace API {
             }
             export {};
         }
+        namespace Aml {
+            type QuoteRoot = pathsV1Frontend['/frontend/aml/{wallet_id}/quote'];
+            type ScreeningsRoot = pathsV1Frontend['/frontend/aml/{wallet_id}/screenings'];
+            type ScreeningRoot = pathsV1Frontend['/frontend/aml/{wallet_id}/screenings/{id}'];
+            type ReportRoot = pathsV1Frontend['/frontend/aml/{wallet_id}/screenings/{id}/report'];
+            type Schemas = componentsV1Frontend['schemas'];
+            export type Screening = Schemas['AmlScreening'];
+            export type Quote = Schemas['AmlScreeningQuote'];
+            export type Result = Schemas['AmlScreeningResult'];
+            export type CheckedCategory = Schemas['AmlCheckedCategory'];
+            export type Asset = Schemas['AmlScreeningAsset'];
+            export type Provider = Schemas['AmlProvider'];
+            export namespace Quote {
+                type Request = QuoteRoot['get']['parameters']['path'] & QuoteRoot['get']['parameters']['query'];
+                type Response = QuoteRoot['get']['responses'][200]['content']['application/json'];
+            }
+            export namespace Screenings {
+                namespace Create {
+                    type Request = ScreeningsRoot['post']['parameters']['path'] & ScreeningsRoot['post']['requestBody']['content']['application/json'] & {
+                        /**
+                         * Sent as the `Idempotency-Key` header, 8–128 characters: a retry with the same key returns the
+                         * screening the first call created instead of charging again.
+                         */
+                        idempotency_key?: NonNullable<ScreeningsRoot['post']['parameters']['header']>['Idempotency-Key'];
+                    };
+                    type Response = ScreeningsRoot['post']['responses'][201]['content']['application/json'];
+                }
+                namespace List {
+                    type Request = ScreeningsRoot['get']['parameters']['path'] & NonNullable<ScreeningsRoot['get']['parameters']['query']>;
+                    type Response = ScreeningsRoot['get']['responses'][200]['content']['application/json'];
+                }
+                namespace GetById {
+                    type Request = ScreeningRoot['get']['parameters']['path'];
+                    type Response = ScreeningRoot['get']['responses'][200]['content']['application/json'];
+                }
+                namespace Report {
+                    type Request = ReportRoot['get']['parameters']['path'];
+                    type Response = Blob;
+                }
+            }
+            export {};
+        }
         namespace Reference {
             namespace ExchangeRates {
                 type ExchangeRatesRoot = pathsV1Frontend['/frontend/reference/exchange_rates'];
@@ -1061,6 +1103,24 @@ export declare namespace API {
                 }
                 export {};
             }
+            namespace Currencies {
+                type CurrenciesRoot = pathsV1Frontend['/frontend/reference/currencies'];
+                export type Currency = componentsV1Frontend['schemas']['ReferenceCurrency'];
+                export namespace List {
+                    type Request = NonNullable<CurrenciesRoot['get']['parameters']['query']>;
+                    type Response = CurrenciesRoot['get']['responses'][200]['content']['application/json'];
+                }
+                export {};
+            }
+            namespace Chains {
+                type ChainsRoot = pathsV1Frontend['/frontend/reference/chains'];
+                export type Chain = componentsV1Frontend['schemas']['ReferenceChain'];
+                export namespace List {
+                    type Request = NonNullable<ChainsRoot['get']['parameters']['query']>;
+                    type Response = ChainsRoot['get']['responses'][200]['content']['application/json'];
+                }
+                export {};
+            }
         }
         namespace NotificationPreferences {
             type NotificationPreferencesRoot = pathsV1Frontend['/frontend/notification-preferences'];

package/dist/constants.d.ts

@@ -168,7 +168,8 @@ export declare enum OrderType {
     REFUND_CARD_SUBACCOUNT = "REFUND_CARD_SUBACCOUNT",
     ADJUSTMENT = "ADJUSTMENT",
     MONTHLY_FEE = "MONTHLY_FEE",
-    REFERRAL_PAYOUT = "REFERRAL_PAYOUT"
+    REFERRAL_PAYOUT = "REFERRAL_PAYOUT",
+    AML_CHECK = "AML_CHECK"
 }
 export declare enum WalletTransactionRecordType {
     CARD_PROVIDER_DEPOSIT = "CARD_PROVIDER_DEPOSIT",
@@ -292,8 +293,9 @@ export declare enum WalletTransactionRecordType {
     REFERRAL_PAYOUT = "REFERRAL_PAYOUT"
 }
 export type OrderTypeMissingInWalletTransactionRecordType = Exclude<EnumValues<OrderType>, EnumValues<WalletTransactionRecordType>>;
-export declare const orderTypeIncludedInWalletTransactionRecordTypeCheck: IsUnionSubset<EnumValues<OrderType>, EnumValues<WalletTransactionRecordType>>;
-export type OrderTypeIncludedInWalletTransactionRecordTypeMismatch = UnionSubsetMismatch<EnumValues<OrderType>, EnumValues<WalletTransactionRecordType>>;
+type OrderTypeWithoutRecordType = EnumValues<OrderType.AML_CHECK>;
+export declare const orderTypeIncludedInWalletTransactionRecordTypeCheck: IsUnionSubset<Exclude<EnumValues<OrderType>, OrderTypeWithoutRecordType>, EnumValues<WalletTransactionRecordType>>;
+export type OrderTypeIncludedInWalletTransactionRecordTypeMismatch = UnionSubsetMismatch<Exclude<EnumValues<OrderType>, OrderTypeWithoutRecordType>, EnumValues<WalletTransactionRecordType>>;
 type BackendOrderTypeId = componentsV1Frontend['schemas']['OrderTypeId'] | componentsV1Tenant['schemas']['OrderTypeId'] | componentsV1External['schemas']['OrderTypeId'] | componentsV1Legacy['schemas']['OrderTypeId'];
 export declare const backendOrderTypeIdIncludedInOrderTypeCheck: IsUnionSubset<BackendOrderTypeId, EnumValues<OrderType>>;
 export type BackendOrderTypeIdIncludedInOrderTypeMismatch = UnionSubsetMismatch<BackendOrderTypeId, EnumValues<OrderType>>;

package/dist/constants.js

@@ -166,6 +166,8 @@ export var OrderType;
     OrderType["ADJUSTMENT"] = "ADJUSTMENT";
     OrderType["MONTHLY_FEE"] = "MONTHLY_FEE";
     OrderType["REFERRAL_PAYOUT"] = "REFERRAL_PAYOUT";
+    // Not in WalletTransactionRecordType, see OrderTypeWithoutRecordType.
+    OrderType["AML_CHECK"] = "AML_CHECK";
     // when extend do not forget to add new order type to the enum WalletTransactionRecordType
 })(OrderType || (OrderType = {}));
 export var WalletTransactionRecordType;

package/package.json

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