squarefi-bff-api-module 1.18.13 → 1.19.0

package/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.19.0] - 2025-05-25
+
+### Added
+
+- Integrated Time-based One-Time Password (TOTP) functionality with new types and API client methods
+
 ## [1.18.9] - 2025-05-24
 
 ### Added

package/README.md

@@ -1,187 +1,140 @@
-# Squarefi BFF API Module
+# Squarefi BFF API SDK
 
-A professional TypeScript/JavaScript SDK for seamless integration with Squarefi BFF API.
+A fully-typed TypeScript / JavaScript SDK for effortless interaction with the Squarefi **Back-For-Front** (BFF) API.
+
+---
+
+## ✨ Why use this SDK?
+
+• Built-in token lifecycle management (refresh, revoke, storage helpers).  
+• Strict TypeScript types generated from the OpenAPI contract.  
+• Axios-powered HTTP client with automatic tenant & environment headers.  
+• First-class support for **Telegram Mini-Apps** as well as Web.  
+• Batteries included: constants, helpers & cryptography utilities.  
+• Zero-config – just provide your API URLs and tenant id.
+
+---
 
 ## 📦 Installation
 
 ```bash
+# npm
+yarn add squarefi-bff-api-module
+# or
 npm install squarefi-bff-api-module
 ```
 
-## 🔧 Usage
+The package ships with `.d.ts` files so no additional typings are required.
 
-```typescript
-import { squarefi_bff_api_client } from 'squarefi-bff-api-module';
+---
 
-// Authentication
-await squarefi_bff_api_client.auth.signin.omni.email({
-  email: 'user@example.com',
-  invite_code: 'optional_invite_code',
-  referrer: 'optional_referrer',
-  redirect_url: 'optional_redirect_url',
-});
+## ⚡️ Quick start
+
+```ts
+import { squarefi_bff_api_client as api, OrderType } from 'squarefi-bff-api-module';
 
-// Telegram authentication
-await squarefi_bff_api_client.auth.signin.telegram({
-  tg_id: 123456789,
-  hash: 'telegram_hash',
-  init_data_raw: 'telegram_init_data',
+// 1) Authenticate (choose the strategy that suits your flow)
+await api.auth.signin.omni.email({
+  email: 'alice@example.com',
+  invite_code: 'optional',
 });
 
-// Password authentication
-await squarefi_bff_api_client.auth.signin.password('user@example.com', 'password');
+// 2) Make authorised calls – tokens are forwarded automatically.
+const wallets = await api.wallets.getAll();
+const firstWalletUuid = wallets[0].uuid;
+
+const cards = await api.issuing.cards.byWalletUuid.getAll({
+  wallet_uuid: firstWalletUuid,
+});
 
-// OTP verification
-await squarefi_bff_api_client.auth.otp.verify.email('user@example.com', 'otp_token');
-await squarefi_bff_api_client.auth.otp.verify.phone('+1234567890', 'otp_token');
+// 3) Exchange rates helper
+await api.exchange.byOrderType[OrderType.DEPOSIT_FIAT_SEPA].getByFromCurrency(firstWalletUuid);
+```
 
-// User operations
-const userData = await squarefi_bff_api_client.user.get();
-const userProfile = await squarefi_bff_api_client.user.userData.get();
+See the [Examples](#examples) section below for more real-life snippets.
 
-// Wallet operations
-const wallets = await squarefi_bff_api_client.wallets.getAll();
-const walletDetails = await squarefi_bff_api_client.wallets.getByUuid('wallet_uuid');
+---
 
-// Card operations
-const cards = await squarefi_bff_api_client.issuing.cards.byWalletUuid.getAll({
-  wallet_uuid: 'wallet_uuid',
-  limit: 10,
-  offset: 0,
-});
+## 🌐 Environment variables
 
-// Exchange operations
-const exchangeRates = await squarefi_bff_api_client.exchange.byOrderType[OrderType.DEPOSIT_FIAT_SEPA].getByFromCurrency(
-  'from_uuid'
-);
+The SDK reads connection details from process-level variables. When bundling for the browser, tools like **Vite**, **Webpack DefinePlugin**, or **Next.js** can safely inline those values at build time.
 
-// System operations (currencies, chains, countries)
-const currencies = await squarefi_bff_api_client.list.currencies.getAll();
-const chains = await squarefi_bff_api_client.list.chains.getAll();
-const countries = await squarefi_bff_api_client.list.countries.getAll();
-```
+| Name                       | Description                                                          | Required                      | Example                       |
+| -------------------------- | -------------------------------------------------------------------- | ----------------------------- | ----------------------------- |
+| `API_URL`                  | Base URL of the BFF **v1** service                                   | ✅                            | `https://api-v1.squarefi.com` |
+| `API_V2_URL`               | Base URL of the BFF **v2** service                                   | ✅                            | `https://api-v2.squarefi.com` |
+| `API_TOTP_URL`             | Base URL of the **TOTP / OTP** micro-service                         | ⚠️ _If you use TOTP features_ | `https://totp.squarefi.com`   |
+| `TENANT_ID`                | Your tenant / organisation identifier                                | ✅                            | `tenant_12345`                |
+| `LOGOUT_URL`               | Frontend route where the user is redirected when refresh token fails | ❌                            | `/auth/logout`                |
+| `SERVER_PUBLIC_KEY_BASE64` | PEM encoded key (base64) used for request signing                    | ✅                            | `MIIBIjANBgkqh…`              |
 
-## 📚 Available API Modules
-
-Access different API functionalities through the client:
-
-- `squarefi_bff_api_client.auth` - Authentication and authorization
-  - OTP verification (email/phone)
-  - Sign in (email/phone/telegram/password)
-  - Sign up (email/telegram)
-  - Token refresh
-- `squarefi_bff_api_client.counterparties` - Counterparty management
-  - List, create, update counterparties
-  - Manage counterparty destinations
-- `squarefi_bff_api_client.developer` - Developer tools
-  - API key management
-  - Vendor management
-- `squarefi_bff_api_client.exchange` - Currency exchange operations
-  - Get exchange rates by order type
-  - Get rates by currency
-- `squarefi_bff_api_client.issuing` - Card issuing operations
-  - Create and manage cards
-  - Card limits and controls
-  - Transaction history
-  - Card status management
-- `squarefi_bff_api_client.kyc` - Know Your Customer procedures
-  - Sumsub integration
-  - Persona inquiries initialization
-- `squarefi_bff_api_client.list` - System data operations
-  - Currencies list (`/system/currencies`)
-  - Chains list (`/system/chains`)
-  - Countries list (`/system/countries`)
-- `squarefi_bff_api_client.orders` - Order management
-  - Create orders by type
-  - Calculate exchange rates
-  - Support for INTERNAL_TRANSFER order type
-- `squarefi_bff_api_client.rails` - KYC onboarding rails
-  - Manage onboarding rails and flows
-- `squarefi_bff_api_client.forms` - KYC forms
-  - Manage and submit KYC forms
-- `squarefi_bff_api_client.tenants` - Tenant management operations
-  - Tenant configuration
-- `squarefi_bff_api_client.user` - User profile operations
-  - Get/update user data
-  - Update contact information
-  - OTP verification
-- `squarefi_bff_api_client.wallets` - Crypto wallet operations
-  - Create and manage wallets
-  - Address management
-  - Transaction history
-  - Balance tracking
-
-## ⚙️ Environment Variables
-
-| Variable                 | Description                                   | Required | Example              |
-| ------------------------ | --------------------------------------------- | -------- | -------------------- |
-| API_URL                  | Base URL for the Squarefi BFF API             | Yes      | `https://api-v1.url` |
-| API_V2_URL               | Base URL for the Squarefi BFF API             | Yes      | `https://api-v2.url` |
-| TENANT_ID                | Your tenant identifier                        | Yes      | `tenant_12345`       |
-| LOGOUT_URL               | Your frontend-app logout route                | No       | '/auth/logout'       |
-| SERVER_PUBLIC_KEY_BASE64 | Server provides base64-encoded PEM format key | Yes      | 'example'            |
-
-## 🚀 Features
-
-- 🔒 Built-in token management and authentication
-- 📱 Telegram integration support
-- 💪 Full TypeScript support with strict typing
-- 🔄 Axios-based HTTP client
-- 📦 Comprehensive constants and types
-- 🛡️ Secure request handling
-- 🔑 Multi-tenant support
-- 🧩 Persona KYC integration
-- 📝 Rails and Forms modules for flexible onboarding/compliance
-
-## 🛠️ Development
-
-### Prerequisites
-
-- Node.js (Latest LTS version)
-- npm or yarn
-
-### Setup
+> ℹ️ When running in Node.js you can place these variables in a `.env` file and load them with [dotenv](https://npmjs.com/package/dotenv).
 
-```bash
-# Install dependencies
-npm install
+---
 
-# Build the package
-npm run build
+## 🗺️ API surface
 
-# Run tests
-npm test
-```
+`squarefi_bff_api_client` is a plain object where every property is a namespaced group of operations. The list below reflects the current SDK version (v1.18.13).
 
-## 🔐 Security
+| Namespace           | Highlights                                                          |
+| ------------------- | ------------------------------------------------------------------- |
+| **auth**            | Omni/Telegram/Password sign-in & sign-up, token refresh, OTP verify |
+| **counterparties**  | CRUD for counterparties & their destinations                        |
+| **developer**       | Vendor & API key management                                         |
+| **exchange**        | Exchange rates per order type / currency                            |
+| **issuing**         | Virtual & physical cards, limits, controls, transactions            |
+| **kyc**             | Sumsub flows, rails & form submission                               |
+| **list**            | Static system lists – currencies, chains, countries                 |
+| **orders**          | Create / calculate orders (including internal transfer)             |
+| **persona**         | Persona in-app KYC inquiries                                        |
+| **tenants**         | Tenant configuration                                                |
+| **totp**            | TOTP generation / verification / revoke helpers                     |
+| **user**            | User profile, contacts, OTP verification                            |
+| **virtualAccounts** | Create & manage virtual IBAN accounts                               |
+| **wallets**         | Wallet creation, addresses, balances, history                       |
 
-The module implements industry-standard security practices:
+> 📝 Every method returns a typed `Promise<Response>` so you get IDE autocompletion & compile-time safety.
 
-- Secure token management
-- Request signing
-- Rate limiting protection
-- HTTPS enforcement
-- Multi-tenant isolation
+---
 
-## Dependencies
+## 🛠️ Development & contributing
 
-### Main Dependencies
+1. Fork the repo and install dependencies:
+   ```bash
+   git clone https://github.com/squarefi-tech/bff-api-module-npm.git
+   cd bff-api-module-npm
+   npm ci
+   ```
+2. Generate/update OpenAPI types (if the backend spec changed):
+   ```bash
+   npm run generate:openapi-types
+   ```
+3. Run the linter & the test suite:
+   ```bash
+   npm test
+   ```
+4. Build the package:
+   ```bash
+   npm run build
+   ```
 
-- axios: 1.6.7
-- @telegram-apps/sdk-react: 3.1.2
+Please open a PR once the checks are green. All contributions are welcome! 🤝
 
-### Peer Dependencies
+---
 
-- react: >=18.x.x
+## 🔐 Security policy
 
-## 📝 Changelog
+If you discover a vulnerability, **do NOT** open a public issue. Instead please email *security@squarefi.com* with the details and we will respond promptly.
 
-See [CHANGELOG.md](https://github.com/squarefi-tech/bff-api-module-npm/blob/main/CHANGELOG.md) for a list of changes and updates.
+---
 
 ## 📄 License
 
-MIT
+[MIT](./LICENSE)
+
+---
 
-## 🔗 Repository
+## 🔗 Links
 
-This package is available on [GitHub](https://github.com/squarefi-tech/bff-api-module-npm) and [npm](https://www.npmjs.com/package/squarefi-bff-api-module).
+• NPM – https://www.npmjs.com/package/squarefi-bff-api-module  
+• GitHub – https://github.com/squarefi-tech/bff-api-module-npm

package/dist/api/index.d.ts

@@ -8,6 +8,7 @@ import { list } from './list';
 import { orders } from './orders';
 import { persona } from './persona';
 import { tenants } from './tenants';
+import { totp } from './totp';
 import { user } from './user';
 import { virtualAccounts } from './virtual-accounts';
 import { wallets } from './wallets';
@@ -22,6 +23,7 @@ type Api = {
     orders: typeof orders;
     persona: typeof persona;
     tenants: typeof tenants;
+    totp: typeof totp;
     user: typeof user;
     virtualAccounts: typeof virtualAccounts;
     wallets: typeof wallets;

package/dist/api/index.js

@@ -11,6 +11,7 @@ const list_1 = require("./list");
 const orders_1 = require("./orders");
 const persona_1 = require("./persona");
 const tenants_1 = require("./tenants");
+const totp_1 = require("./totp");
 const user_1 = require("./user");
 const virtual_accounts_1 = require("./virtual-accounts");
 const wallets_1 = require("./wallets");
@@ -25,6 +26,7 @@ exports.squarefi_bff_api_client = {
     orders: orders_1.orders,
     persona: persona_1.persona,
     tenants: tenants_1.tenants,
+    totp: totp_1.totp,
     user: user_1.user,
     virtualAccounts: virtual_accounts_1.virtualAccounts,
     wallets: wallets_1.wallets,

package/dist/api/totp.d.ts

@@ -0,0 +1,15 @@
+import { API } from './types/types';
+export declare const totp: {
+    otp_verification: {
+        create: (data: API.TOTP.OTPVerification.Create.Request) => Promise<API.TOTP.OTPVerification.Create.Response>;
+        verify: (data: API.TOTP.OTPVerification.Verify.Request) => Promise<API.TOTP.OTPVerification.Verify.Response>;
+        get: (id: string) => Promise<API.TOTP.OTPVerification.OTPVerificationInfo>;
+    };
+    totp: {
+        generate: (data: API.TOTP.TOTP.Generate.Request) => Promise<API.TOTP.TOTP.Generate.Response>;
+        verify: (data: API.TOTP.TOTP.Verify.Request) => Promise<API.TOTP.TOTP.Verify.Response>;
+        revoke: (data: API.TOTP.TOTP.Revoke.Request) => Promise<API.TOTP.TOTP.Revoke.Response>;
+        activate: (data: API.TOTP.TOTP.Activate.Request) => Promise<API.TOTP.TOTP.Activate.Response>;
+        generateEncrypted: (data: API.TOTP.TOTP.GenerateEncrypted.Request) => Promise<API.TOTP.TOTP.GenerateEncrypted.Response>;
+    };
+};

package/dist/api/totp.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.totp = void 0;
+const apiClientFactory_1 = require("../utils/apiClientFactory");
+exports.totp = {
+    otp_verification: {
+        create: (data) => {
+            return apiClientFactory_1.apiClientTOTP.postRequest('/api/otp-verification', { data });
+        },
+        verify: (data) => {
+            return apiClientFactory_1.apiClientTOTP.postRequest('/api/otp-verification/verify', {
+                data,
+            });
+        },
+        get: (id) => {
+            return apiClientFactory_1.apiClientTOTP.getRequest(`/api/otp-verification/${id}`);
+        },
+    },
+    totp: {
+        generate: (data) => {
+            return apiClientFactory_1.apiClientTOTP.postRequest('/api/totp/generate', { data });
+        },
+        verify: (data) => {
+            return apiClientFactory_1.apiClientTOTP.postRequest('/api/totp/verify', { data });
+        },
+        revoke: (data) => {
+            return apiClientFactory_1.apiClientTOTP.postRequest('/api/totp/revoke', { data });
+        },
+        activate: (data) => {
+            return apiClientFactory_1.apiClientTOTP.postRequest('/api/totp/activate', { data });
+        },
+        generateEncrypted: (data) => {
+            return apiClientFactory_1.apiClientTOTP.postRequest('/api/totp/generate-encrypted', {
+                data,
+            });
+        },
+    },
+};

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

@@ -683,7 +683,7 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/webhook/kyc/hifi-bridge": {
+    "/webhook/kyc/hifibridge": {
         parameters: {
             query?: never;
             header?: never;
@@ -806,6 +806,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/storage/kyc/{folderId}/{fileId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get KYC file by ID */
+        get: operations["StorageController_getKycFile"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/counterparties/{wallet_id}": {
         parameters: {
             query?: never;
@@ -1703,7 +1720,8 @@ export interface components {
             proof_of_address_url?: string | null;
             proof_of_ownership_url?: string | null;
             /** @enum {string|null} */
-            purpose?: "PAY_SUPPLIERS" | "PAY_SERVICE_PROVIDERS" | "GOODS_MERCHANDISE_COMMODITIES" | "FREELANCERS_CONTRACTORS_PAYROLL" | "FINANCIAL_SERVICES_LOANS_INVESTMENTS" | "TAX_REGULATORY_FEES" | "LEGAL_SERVICES" | "OPERATIONAL_EXPENSES" | "SUBSCRIPTIONS" | "TRAVEL_RELATED_EXPENSES" | "INSURANCE" | "ADVERTISING_MARKETING_EXPENSES" | "EQUIPMENT_MACHINERY" | "TECHNOLOGY_SERVICES" | "EDUCATION_RELATED_EXPENSES" | "TREASURY_PAYMENTS" | "FX_SERVICES" | "OTHER" | "ONLINE_MARKETPLACE_TRADING" | "OFFLINE_TRADING" | null;
+            purpose?: "charitable_donations" | "ecommerce_retail_payments" | "investment_purposes" | "other" | "payments_to_friends_or_family_abroad" | "payroll" | "personal_or_living_expenses" | "protect_wealth" | "purchase_goods_and_services" | "receive_payments_for_goods_and_services" | "tax_optimization" | "third_party_money_transmission" | "treasury_management" | "operating_a_company" | "receive_payment_for_freelancing" | "receive_salary" | null;
+            purpose_other?: string | null;
             registration_number?: string | null;
             share_structure_url?: string | null;
             sof_eu_questionnaire?: components["schemas"]["KycEntitySofEuQuestionnaireEntity"] | null;
@@ -1793,7 +1811,8 @@ export interface components {
             proof_of_address_url?: string | null;
             proof_of_ownership_url?: string | null;
             /** @enum {string|null} */
-            purpose?: "PAY_SUPPLIERS" | "PAY_SERVICE_PROVIDERS" | "GOODS_MERCHANDISE_COMMODITIES" | "FREELANCERS_CONTRACTORS_PAYROLL" | "FINANCIAL_SERVICES_LOANS_INVESTMENTS" | "TAX_REGULATORY_FEES" | "LEGAL_SERVICES" | "OPERATIONAL_EXPENSES" | "SUBSCRIPTIONS" | "TRAVEL_RELATED_EXPENSES" | "INSURANCE" | "ADVERTISING_MARKETING_EXPENSES" | "EQUIPMENT_MACHINERY" | "TECHNOLOGY_SERVICES" | "EDUCATION_RELATED_EXPENSES" | "TREASURY_PAYMENTS" | "FX_SERVICES" | "OTHER" | "ONLINE_MARKETPLACE_TRADING" | "OFFLINE_TRADING" | null;
+            purpose?: "charitable_donations" | "ecommerce_retail_payments" | "investment_purposes" | "other" | "payments_to_friends_or_family_abroad" | "payroll" | "personal_or_living_expenses" | "protect_wealth" | "purchase_goods_and_services" | "receive_payments_for_goods_and_services" | "tax_optimization" | "third_party_money_transmission" | "treasury_management" | "operating_a_company" | "receive_payment_for_freelancing" | "receive_salary" | null;
+            purpose_other?: string | null;
             registration_number?: string | null;
             share_structure_url?: string | null;
             sof_eu_questionnaire?: components["schemas"]["KycEntitySofEuQuestionnaireEntity"] | null;
@@ -3834,6 +3853,28 @@ export interface operations {
             };
         };
     };
+    StorageController_getKycFile: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                folderId: string;
+                fileId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/octet-stream": string;
+                };
+            };
+        };
+    };
     CounterpartyAccountsController_findAll: {
         parameters: {
             query?: {

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

@@ -1396,6 +1396,120 @@ export declare namespace API {
             }
         }
     }
+    namespace TOTP {
+        namespace OTPVerification {
+            type OTPVerificationChannelType = 'EMAIL' | 'SMS' | 'TOTP' | 'APP';
+            type OTPVerificationStatus = 'PENDING' | 'APPROVED' | 'DENIED';
+            type OTPVerificationChannelInfo = {
+                channel: OTPVerificationChannelType;
+                validity: number;
+            };
+            type OTPVerificationInfo = {
+                id: string;
+                status: OTPVerificationStatus;
+                created_at: string;
+                updated_at: string;
+            };
+            namespace Create {
+                type Request = {
+                    id: string;
+                    amount: number;
+                    order_type: string;
+                    wallet_id: string;
+                    meta: {
+                        description: string;
+                    };
+                };
+                type Response = {
+                    id: string;
+                    status: OTPVerificationStatus;
+                    channels: OTPVerificationChannelInfo[];
+                };
+            }
+            namespace Verify {
+                type Request = {
+                    id: string;
+                    channel: OTPVerificationChannelType;
+                    otp: string;
+                };
+                type Response = {
+                    success?: boolean;
+                    error?: boolean;
+                    message?: string;
+                    details?: string;
+                };
+            }
+        }
+        namespace TOTP {
+            namespace Generate {
+                type Request = {
+                    user_name: string;
+                    service_name: string;
+                };
+                type Response = {
+                    success?: boolean;
+                    error?: boolean;
+                    message?: string;
+                    data?: {
+                        id: string;
+                        qrCode: string;
+                        secret: string;
+                    };
+                };
+            }
+            namespace Verify {
+                type Request = {
+                    token: string;
+                    otp: string;
+                };
+                type Response = {
+                    success?: boolean;
+                    error?: boolean;
+                    message?: string;
+                    details?: string;
+                };
+            }
+            namespace Revoke {
+                type Request = {
+                    token: string;
+                };
+                type Response = {
+                    success?: boolean;
+                    error?: boolean;
+                    message?: string;
+                    details?: string;
+                };
+            }
+            namespace Activate {
+                type Request = {
+                    token: string;
+                };
+                type Response = {
+                    success?: boolean;
+                    error?: boolean;
+                    message?: string;
+                    details?: string;
+                    data?: {
+                        activated: boolean;
+                    };
+                };
+            }
+            namespace GenerateEncrypted {
+                type Request = {
+                    user_name: string;
+                    service_name: string;
+                    public_key: string;
+                };
+                type Response = {
+                    success?: boolean;
+                    error?: boolean;
+                    message?: string;
+                    details?: string;
+                    data?: string;
+                };
+            }
+        }
+    }
     namespace VirtualAccounts {
         namespace Create {
             interface Request {

package/dist/utils/apiClientFactory.d.ts

@@ -22,4 +22,10 @@ export declare const apiClientV2: {
     deleteRequest: (url: string, config?: AxiosRequestConfig) => Promise<any>;
     getRequest: <T>(url: string, config?: AxiosRequestConfig) => Promise<T>;
 };
+export declare const apiClientTOTP: {
+    patchRequest: <T>(url: string, config?: AxiosRequestConfig) => Promise<T>;
+    postRequest: <T>(url: string, config?: AxiosRequestConfig) => Promise<T>;
+    deleteRequest: (url: string, config?: AxiosRequestConfig) => Promise<any>;
+    getRequest: <T>(url: string, config?: AxiosRequestConfig) => Promise<T>;
+};
 export {};

package/dist/utils/apiClientFactory.js

@@ -22,9 +22,9 @@ var __rest = (this && this.__rest) || function (s, e) {
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _a, _b, _c, _d;
+var _a, _b, _c, _d, _e;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.apiClientV2 = exports.apiClientV1 = exports.createApiClient = void 0;
+exports.apiClientTOTP = exports.apiClientV2 = exports.apiClientV1 = exports.createApiClient = void 0;
 /* eslint-disable no-console */
 const sdk_react_1 = require("@telegram-apps/sdk-react");
 const axios_1 = __importDefault(require("axios"));
@@ -35,8 +35,9 @@ const tokensFactory_1 = require("../utils/tokensFactory");
 // eslint-disable-next-line no-constant-condition
 const apiV1BaseURL = (_a = process.env.API_URL) !== null && _a !== void 0 ? _a : 'ENV variable API_URL is not defined';
 const apiV2BaseURL = (_b = process.env.API_V2_URL) !== null && _b !== void 0 ? _b : 'ENV variable API_V2_URL is not defined';
-const envTenantId = (_c = process.env.TENANT_ID) !== null && _c !== void 0 ? _c : 'ENV variable TENANT_ID is not defined';
-const envLogoutURL = (_d = process.env.LOGOUT_URL) !== null && _d !== void 0 ? _d : '/auth/logout';
+const apiTOTPBaseURL = (_c = process.env.API_TOTP_URL) !== null && _c !== void 0 ? _c : 'ENV variable API_TOTP_URL is not defined';
+const envTenantId = (_d = process.env.TENANT_ID) !== null && _d !== void 0 ? _d : 'ENV variable TENANT_ID is not defined';
+const envLogoutURL = (_e = process.env.LOGOUT_URL) !== null && _e !== void 0 ? _e : '/auth/logout';
 const createApiClient = ({ baseURL, isBearerToken, tenantId }) => {
     const instance = axios_1.default.create({
         baseURL,
@@ -139,3 +140,8 @@ exports.apiClientV2 = (0, exports.createApiClient)({
     isBearerToken: true,
     tenantId: envTenantId,
 });
+exports.apiClientTOTP = (0, exports.createApiClient)({
+    baseURL: apiTOTPBaseURL,
+    isBearerToken: true,
+    tenantId: envTenantId,
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "squarefi-bff-api-module",
-  "version": "1.18.13",
+  "version": "1.19.0",
   "description": "Squarefi BFF API client module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/scripts/generate-openapi-types.ts

@@ -10,7 +10,7 @@ type ApiDocsData = {
 
 const apiDocsData: ApiDocsData[] = [
   {
-    url: process.env.API_V2_URL,
+    url: process.env.API_DOCS_V2_URL,
     name: 'apiV2',
   },
 ];

package/src/api/index.ts

@@ -9,6 +9,7 @@ import { list } from './list';
 import { orders } from './orders';
 import { persona } from './persona';
 import { tenants } from './tenants';
+import { totp } from './totp';
 import { user } from './user';
 import { virtualAccounts } from './virtual-accounts';
 import { wallets } from './wallets';
@@ -24,6 +25,7 @@ type Api = {
   orders: typeof orders;
   persona: typeof persona;
   tenants: typeof tenants;
+  totp: typeof totp;
   user: typeof user;
   virtualAccounts: typeof virtualAccounts;
   wallets: typeof wallets;
@@ -40,6 +42,7 @@ export const squarefi_bff_api_client: Api = {
   orders,
   persona,
   tenants,
+  totp,
   user,
   virtualAccounts,
   wallets,

package/src/api/totp.ts

@@ -0,0 +1,39 @@
+import { apiClientTOTP } from '../utils/apiClientFactory';
+import { API } from './types/types';
+
+export const totp = {
+  otp_verification: {
+    create: (data: API.TOTP.OTPVerification.Create.Request): Promise<API.TOTP.OTPVerification.Create.Response> => {
+      return apiClientTOTP.postRequest<API.TOTP.OTPVerification.Create.Response>('/api/otp-verification', { data });
+    },
+    verify: (data: API.TOTP.OTPVerification.Verify.Request): Promise<API.TOTP.OTPVerification.Verify.Response> => {
+      return apiClientTOTP.postRequest<API.TOTP.OTPVerification.Verify.Response>('/api/otp-verification/verify', {
+        data,
+      });
+    },
+    get: (id: string): Promise<API.TOTP.OTPVerification.OTPVerificationInfo> => {
+      return apiClientTOTP.getRequest<API.TOTP.OTPVerification.OTPVerificationInfo>(`/api/otp-verification/${id}`);
+    },
+  },
+  totp: {
+    generate: (data: API.TOTP.TOTP.Generate.Request): Promise<API.TOTP.TOTP.Generate.Response> => {
+      return apiClientTOTP.postRequest<API.TOTP.TOTP.Generate.Response>('/api/totp/generate', { data });
+    },
+    verify: (data: API.TOTP.TOTP.Verify.Request): Promise<API.TOTP.TOTP.Verify.Response> => {
+      return apiClientTOTP.postRequest<API.TOTP.TOTP.Verify.Response>('/api/totp/verify', { data });
+    },
+    revoke: (data: API.TOTP.TOTP.Revoke.Request): Promise<API.TOTP.TOTP.Revoke.Response> => {
+      return apiClientTOTP.postRequest<API.TOTP.TOTP.Revoke.Response>('/api/totp/revoke', { data });
+    },
+    activate: (data: API.TOTP.TOTP.Activate.Request): Promise<API.TOTP.TOTP.Activate.Response> => {
+      return apiClientTOTP.postRequest<API.TOTP.TOTP.Activate.Response>('/api/totp/activate', { data });
+    },
+    generateEncrypted: (
+      data: API.TOTP.TOTP.GenerateEncrypted.Request
+    ): Promise<API.TOTP.TOTP.GenerateEncrypted.Response> => {
+      return apiClientTOTP.postRequest<API.TOTP.TOTP.GenerateEncrypted.Response>('/api/totp/generate-encrypted', {
+        data,
+      });
+    },
+  },
+};

package/src/api/types/autogen/apiV2.types.ts

@@ -684,7 +684,7 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/webhook/kyc/hifi-bridge": {
+    "/webhook/kyc/hifibridge": {
         parameters: {
             query?: never;
             header?: never;
@@ -807,6 +807,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/storage/kyc/{folderId}/{fileId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get KYC file by ID */
+        get: operations["StorageController_getKycFile"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/counterparties/{wallet_id}": {
         parameters: {
             query?: never;
@@ -1704,7 +1721,8 @@ export interface components {
             proof_of_address_url?: string | null;
             proof_of_ownership_url?: string | null;
             /** @enum {string|null} */
-            purpose?: "PAY_SUPPLIERS" | "PAY_SERVICE_PROVIDERS" | "GOODS_MERCHANDISE_COMMODITIES" | "FREELANCERS_CONTRACTORS_PAYROLL" | "FINANCIAL_SERVICES_LOANS_INVESTMENTS" | "TAX_REGULATORY_FEES" | "LEGAL_SERVICES" | "OPERATIONAL_EXPENSES" | "SUBSCRIPTIONS" | "TRAVEL_RELATED_EXPENSES" | "INSURANCE" | "ADVERTISING_MARKETING_EXPENSES" | "EQUIPMENT_MACHINERY" | "TECHNOLOGY_SERVICES" | "EDUCATION_RELATED_EXPENSES" | "TREASURY_PAYMENTS" | "FX_SERVICES" | "OTHER" | "ONLINE_MARKETPLACE_TRADING" | "OFFLINE_TRADING" | null;
+            purpose?: "charitable_donations" | "ecommerce_retail_payments" | "investment_purposes" | "other" | "payments_to_friends_or_family_abroad" | "payroll" | "personal_or_living_expenses" | "protect_wealth" | "purchase_goods_and_services" | "receive_payments_for_goods_and_services" | "tax_optimization" | "third_party_money_transmission" | "treasury_management" | "operating_a_company" | "receive_payment_for_freelancing" | "receive_salary" | null;
+            purpose_other?: string | null;
             registration_number?: string | null;
             share_structure_url?: string | null;
             sof_eu_questionnaire?: components["schemas"]["KycEntitySofEuQuestionnaireEntity"] | null;
@@ -1794,7 +1812,8 @@ export interface components {
             proof_of_address_url?: string | null;
             proof_of_ownership_url?: string | null;
             /** @enum {string|null} */
-            purpose?: "PAY_SUPPLIERS" | "PAY_SERVICE_PROVIDERS" | "GOODS_MERCHANDISE_COMMODITIES" | "FREELANCERS_CONTRACTORS_PAYROLL" | "FINANCIAL_SERVICES_LOANS_INVESTMENTS" | "TAX_REGULATORY_FEES" | "LEGAL_SERVICES" | "OPERATIONAL_EXPENSES" | "SUBSCRIPTIONS" | "TRAVEL_RELATED_EXPENSES" | "INSURANCE" | "ADVERTISING_MARKETING_EXPENSES" | "EQUIPMENT_MACHINERY" | "TECHNOLOGY_SERVICES" | "EDUCATION_RELATED_EXPENSES" | "TREASURY_PAYMENTS" | "FX_SERVICES" | "OTHER" | "ONLINE_MARKETPLACE_TRADING" | "OFFLINE_TRADING" | null;
+            purpose?: "charitable_donations" | "ecommerce_retail_payments" | "investment_purposes" | "other" | "payments_to_friends_or_family_abroad" | "payroll" | "personal_or_living_expenses" | "protect_wealth" | "purchase_goods_and_services" | "receive_payments_for_goods_and_services" | "tax_optimization" | "third_party_money_transmission" | "treasury_management" | "operating_a_company" | "receive_payment_for_freelancing" | "receive_salary" | null;
+            purpose_other?: string | null;
             registration_number?: string | null;
             share_structure_url?: string | null;
             sof_eu_questionnaire?: components["schemas"]["KycEntitySofEuQuestionnaireEntity"] | null;
@@ -3835,6 +3854,28 @@ export interface operations {
             };
         };
     };
+    StorageController_getKycFile: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                folderId: string;
+                fileId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/octet-stream": string;
+                };
+            };
+        };
+    };
     CounterpartyAccountsController_findAll: {
         parameters: {
             query?: {

package/src/api/types/types.ts

@@ -1695,6 +1695,134 @@ export namespace API {
     }
   }
 
+  export namespace TOTP {
+    export namespace OTPVerification {
+      export type OTPVerificationChannelType = 'EMAIL' | 'SMS' | 'TOTP' | 'APP';
+      export type OTPVerificationStatus = 'PENDING' | 'APPROVED' | 'DENIED';
+      export type OTPVerificationChannelInfo = {
+        channel: OTPVerificationChannelType;
+        validity: number;
+      };
+      export type OTPVerificationInfo = {
+        id: string;
+        status: OTPVerificationStatus;
+        created_at: string;
+        updated_at: string;
+      };
+
+      export namespace Create {
+        export type Request = {
+          id: string;
+          amount: number;
+          order_type: string;
+          wallet_id: string;
+          meta: {
+            description: string;
+          };
+        };
+
+        export type Response = {
+          id: string;
+          status: OTPVerificationStatus;
+          channels: OTPVerificationChannelInfo[];
+        };
+      }
+
+      export namespace Verify {
+        export type Request = {
+          id: string;
+          channel: OTPVerificationChannelType;
+          otp: string;
+        };
+
+        export type Response = {
+          success?: boolean;
+          error?: boolean;
+          message?: string;
+          details?: string;
+        };
+      }
+    }
+    export namespace TOTP {
+      export namespace Generate {
+        export type Request = {
+          user_name: string;
+          service_name: string;
+        };
+
+        export type Response = {
+          success?: boolean;
+          error?: boolean;
+          message?: string;
+          data?: {
+            id: string;
+            qrCode: string;
+            secret: string;
+          };
+        };
+      }
+
+      export namespace Verify {
+        export type Request = {
+          token: string;
+          otp: string;
+        };
+
+        export type Response = {
+          success?: boolean;
+          error?: boolean;
+          message?: string;
+          details?: string;
+        };
+      }
+
+      export namespace Revoke {
+        export type Request = {
+          token: string;
+        };
+
+        export type Response = {
+          success?: boolean;
+          error?: boolean;
+          message?: string;
+          details?: string;
+        };
+      }
+
+      export namespace Activate {
+        export type Request = {
+          token: string;
+        };
+
+        export type Response = {
+          success?: boolean;
+          error?: boolean;
+          message?: string;
+          details?: string;
+          data?: {
+            activated: boolean;
+          };
+        };
+      }
+
+      export namespace GenerateEncrypted {
+        export type Request = {
+          user_name: string;
+          service_name: string;
+          public_key: string;
+        };
+
+        export type Response = {
+          success?: boolean;
+          error?: boolean;
+          message?: string;
+          details?: string;
+          data?: string;
+        };
+      }
+    }
+  }
+
   export namespace VirtualAccounts {
     export namespace Create {
       export interface Request {

package/src/utils/apiClientFactory.ts

@@ -12,6 +12,7 @@ import { deleteTokens, refreshTokens } from '../utils/tokensFactory';
 
 const apiV1BaseURL = process.env.API_URL ?? 'ENV variable API_URL is not defined';
 const apiV2BaseURL = process.env.API_V2_URL ?? 'ENV variable API_V2_URL is not defined';
+const apiTOTPBaseURL = process.env.API_TOTP_URL ?? 'ENV variable API_TOTP_URL is not defined';
 const envTenantId = process.env.TENANT_ID ?? 'ENV variable TENANT_ID is not defined';
 const envLogoutURL = process.env.LOGOUT_URL ?? '/auth/logout';
 
@@ -161,3 +162,9 @@ export const apiClientV2 = createApiClient({
   isBearerToken: true,
   tenantId: envTenantId,
 });
+
+export const apiClientTOTP = createApiClient({
+  baseURL: apiTOTPBaseURL,
+  isBearerToken: true,
+  tenantId: envTenantId,
+});