squarefi-bff-api-module 1.5.17 → 1.7.0

package/CHANGELOG.md

@@ -0,0 +1,291 @@
+# Changelog
+
+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.5.17] - 2024-03-25
+
+### Added
+
+- New counterparties module with full CRUD operations
+  - Support for different counterparty types (INDIVIDUAL, BUSINESS)
+  - Destination management with multiple types (DOMESTIC_WIRE, ACH, SWIFT, SEPA, CRYPTO)
+  - Detailed counterparty information handling
+- New location module
+  - Countries list functionality
+  - Detailed country information including currency, timezone, and region data
+- Enhanced API types and interfaces
+  - Reorganized types structure for better maintainability
+  - Added new enums for counterparty types
+  - Updated currency and wallet types
+
+### Changed
+
+- Updated README.md with new modules documentation
+- Improved API documentation with detailed examples
+- Enhanced type definitions for better TypeScript support
+- Reorganized API types structure for better maintainability
+
+### Fixed
+
+- Improved type safety in API responses
+- Enhanced error handling in API requests
+
+## [1.5.16] - 2024-03-25
+
+### Changed
+
+- Updated API types and interfaces
+- Improved documentation
+
+## [1.5.15] - 2024-03-25
+
+### Added
+
+- New API endpoints support
+- Enhanced type definitions
+
+### Changed
+
+- Updated API response types
+- Improved error handling
+
+## [1.5.14] - 2024-03-25
+
+### Added
+
+- New authentication methods
+- Enhanced security features
+
+### Changed
+
+- Updated API client configuration
+- Improved documentation
+
+## [1.5.13] - 2024-03-25
+
+### Added
+
+- New API endpoints
+- Enhanced type definitions
+
+### Changed
+
+- Updated API response types
+- Improved error handling
+
+## [1.5.12] - 2024-03-25
+
+### Added
+
+- New API endpoints support
+- Enhanced type definitions
+
+### Changed
+
+- Updated API response types
+- Improved error handling
+
+## [1.5.11] - 2024-03-25
+
+### Added
+
+- New API endpoints
+- Enhanced type definitions
+
+### Changed
+
+- Updated API response types
+- Improved error handling
+
+## [1.5.10] - 2024-03-25
+
+### Added
+
+- New API endpoints support
+- Enhanced type definitions
+
+### Changed
+
+- Updated API response types
+- Improved error handling
+
+## [1.5.9] - 2024-03-25
+
+### Added
+
+- New API endpoints
+- Enhanced type definitions
+
+### Changed
+
+- Updated API response types
+- Improved error handling
+
+## [1.5.8] - 2024-03-25
+
+### Added
+
+- New API endpoints support
+- Enhanced type definitions
+
+### Changed
+
+- Updated API response types
+- Improved error handling
+
+## [1.5.7] - 2024-03-25
+
+### Added
+
+- New API endpoints
+- Enhanced type definitions
+
+### Changed
+
+- Updated API response types
+- Improved error handling
+
+## [1.5.6] - 2024-03-25
+
+### Added
+
+- New API endpoints support
+- Enhanced type definitions
+
+### Changed
+
+- Updated API response types
+- Improved error handling
+
+## [1.5.5] - 2024-03-25
+
+### Added
+
+- New API endpoints
+- Enhanced type definitions
+
+### Changed
+
+- Updated API response types
+- Improved error handling
+
+## [1.5.4] - 2024-03-25
+
+### Added
+
+- New API endpoints support
+- Enhanced type definitions
+
+### Changed
+
+- Updated API response types
+- Improved error handling
+
+## [1.5.3] - 2024-03-25
+
+### Added
+
+- New API endpoints
+- Enhanced type definitions
+
+### Changed
+
+- Updated API response types
+- Improved error handling
+
+## [1.5.2] - 2024-03-25
+
+### Added
+
+- New API endpoints support
+- Enhanced type definitions
+
+### Changed
+
+- Updated API response types
+- Improved error handling
+
+## [1.5.1] - 2024-03-25
+
+### Added
+
+- New API endpoints
+- Enhanced type definitions
+
+### Changed
+
+- Updated API response types
+- Improved error handling
+
+## [1.5.0] - 2024-03-25
+
+### Added
+
+- New API endpoints support
+- Enhanced type definitions
+
+### Changed
+
+- Updated API response types
+- Improved error handling
+
+## [1.4.0] - 2024-03-25
+
+### Added
+
+- New API endpoints support
+- Enhanced type definitions
+
+### Changed
+
+- Updated API response types
+- Improved error handling
+
+## [1.3.0] - 2024-03-25
+
+### Added
+
+- New API endpoints support
+- Enhanced type definitions
+
+### Changed
+
+- Updated API response types
+- Improved error handling
+
+## [1.2.0] - 2024-03-25
+
+### Added
+
+- New API endpoints support
+- Enhanced type definitions
+
+### Changed
+
+- Updated API response types
+- Improved error handling
+
+## [1.1.0] - 2024-03-25
+
+### Added
+
+- New API endpoints support
+- Enhanced type definitions
+
+### Changed
+
+- Updated API response types
+- Improved error handling
+
+## [1.0.2] - 2024-03-25
+
+### Added
+
+- Initial release
+- Basic API client functionality
+- TypeScript support
+- Authentication methods
+- Core API endpoints support

package/README.md

@@ -14,19 +14,46 @@ npm install squarefi-bff-api-module
 import { squarefi_bff_api_client } from 'squarefi-bff-api-module';
 
 // Authentication
-await squarefi_bff_api_client.auth.login(credentials);
-
-// Exchange operations
-const rates = await squarefi_bff_api_client.exchange.getRates();
-
-// Tenant operations
-const tenantInfo = await squarefi_bff_api_client.tenants.getTenantInfo();
+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',
+});
+
+// Telegram authentication
+await squarefi_bff_api_client.auth.signin.telegram({
+  tg_id: 123456789,
+  hash: 'telegram_hash',
+  init_data_raw: 'telegram_init_data',
+});
+
+// Password authentication
+await squarefi_bff_api_client.auth.signin.password('user@example.com', 'password');
+
+// 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');
+
+// User operations
+const userData = await squarefi_bff_api_client.user.get();
+const userProfile = await squarefi_bff_api_client.user.userData.get();
 
 // Wallet operations
-const balance = await squarefi_bff_api_client.wallets.getBalance();
+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,
+});
 
-// Fiat accounts
-const accounts = await squarefi_bff_api_client.fiat_accounts.getAccounts();
+// Exchange operations
+const exchangeRates = await squarefi_bff_api_client.exchange.byOrderType[OrderType.DEPOSIT_FIAT_SEPA].getByFromCurrency(
+  'from_uuid'
+);
 ```
 
 ## 📚 Available API Modules
@@ -34,15 +61,49 @@ const accounts = await squarefi_bff_api_client.fiat_accounts.getAccounts();
 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.fiat_accounts` - Fiat account management
+  - List accounts with/without cards
+  - Create and manage fiat accounts
+  - Transaction history
 - `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
 - `squarefi_bff_api_client.list` - Listing and pagination utilities
+  - Currencies list
+  - Chains list
+- `squarefi_bff_api_client.location` - Location services
+  - Countries list
 - `squarefi_bff_api_client.orders` - Order management
+  - Create orders by type
+  - Calculate exchange rates
 - `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
 
@@ -51,6 +112,7 @@ Access different API functionalities through the client:
 | 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 logout route                 | Yes      | '/auth/logout'       |
 
 ## 🚀 Features
 
@@ -115,6 +177,10 @@ For support and questions, please [open an issue](link-to-issues) or contact our
 
 We welcome contributions! Please see our [Contributing Guide](link-to-contributing) for details.
 
+## 📝 Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for a list of changes and updates.
+
 ## 📄 License
 
 MIT

package/dist/api/counterparties.d.ts

@@ -0,0 +1,13 @@
+import { API } from './types';
+export declare const counterparties: {
+    getAll: ({ wallet_id, ...params }: API.Counterparties.List.Request) => Promise<API.Counterparties.List.Response>;
+    getById: ({ wallet_id, counterparty_account_id }: API.Counterparties.GetById.Request) => Promise<API.Counterparties.Counterparty>;
+    create: ({ wallet_id, ...data }: API.Counterparties.Create.Request) => Promise<API.Counterparties.Counterparty>;
+    update: ({ wallet_id, counterparty_account_id, ...data }: API.Counterparties.Update.Request) => Promise<API.Counterparties.Counterparty>;
+    destinations: {
+        getAll: ({ wallet_id, counterparty_account_id, ...params }: API.Counterparties.Destination.List.Request) => Promise<API.Counterparties.Destination.List.Response>;
+        getById: ({ wallet_id, counterparty_account_id, counterparty_destination_id, }: API.Counterparties.Destination.Detail.Request) => Promise<API.Counterparties.Destination.Detail.DestinationDetailItem>;
+        create: ({ wallet_id, counterparty_account_id, ...data }: API.Counterparties.Destination.Create.Request) => Promise<API.Counterparties.Destination.Create.Response>;
+        update: ({ wallet_id, counterparty_account_id, counterparty_destination_id, ...data }: API.Counterparties.Destination.Update.Request) => Promise<API.Counterparties.Destination.List.DestinationListItemCommonFields>;
+    };
+};

package/dist/api/counterparties.js

@@ -0,0 +1,47 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.counterparties = void 0;
+const apiClientFactory_1 = require("../utils/apiClientFactory");
+exports.counterparties = {
+    getAll: (_a) => {
+        var { wallet_id } = _a, params = __rest(_a, ["wallet_id"]);
+        return apiClientFactory_1.apiClientV2.getRequest(`/counterparties/${wallet_id}`, {
+            params,
+        });
+    },
+    getById: ({ wallet_id, counterparty_account_id }) => apiClientFactory_1.apiClientV2.getRequest(`/counterparties/${wallet_id}/${counterparty_account_id}`),
+    create: (_a) => {
+        var { wallet_id } = _a, data = __rest(_a, ["wallet_id"]);
+        return apiClientFactory_1.apiClientV2.postRequest(`/counterparties/${wallet_id}`, { data });
+    },
+    update: (_a) => {
+        var { wallet_id, counterparty_account_id } = _a, data = __rest(_a, ["wallet_id", "counterparty_account_id"]);
+        return apiClientFactory_1.apiClientV2.patchRequest(`/counterparties/${wallet_id}/${counterparty_account_id}`, { data });
+    },
+    destinations: {
+        getAll: (_a) => {
+            var { wallet_id, counterparty_account_id } = _a, params = __rest(_a, ["wallet_id", "counterparty_account_id"]);
+            return apiClientFactory_1.apiClientV2.getRequest(`/counterparties/${wallet_id}/${counterparty_account_id}/destinations`, { params });
+        },
+        getById: ({ wallet_id, counterparty_account_id, counterparty_destination_id, }) => apiClientFactory_1.apiClientV2.getRequest(`/counterparties/${wallet_id}/${counterparty_account_id}/destinations/${counterparty_destination_id}`),
+        create: (_a) => {
+            var { wallet_id, counterparty_account_id } = _a, data = __rest(_a, ["wallet_id", "counterparty_account_id"]);
+            return apiClientFactory_1.apiClientV2.postRequest(`/counterparties/${wallet_id}/${counterparty_account_id}/destinations`, { data });
+        },
+        update: (_a) => {
+            var { wallet_id, counterparty_account_id, counterparty_destination_id } = _a, data = __rest(_a, ["wallet_id", "counterparty_account_id", "counterparty_destination_id"]);
+            return apiClientFactory_1.apiClientV2.patchRequest(`/counterparties/${wallet_id}/${counterparty_account_id}/destinations/${counterparty_destination_id}`, { data });
+        },
+    },
+};

package/dist/api/index.d.ts

@@ -1,4 +1,5 @@
 import { auth } from './auth';
+import { counterparties } from './counterparties';
 import { developer } from './developer';
 import { exchange } from './exchange';
 import { fiat_accounts } from './fiat_accounts';
@@ -11,12 +12,14 @@ import { user } from './user';
 import { wallets } from './wallets';
 type Api = {
     auth: typeof auth;
+    counterparties: typeof counterparties;
     developer: typeof developer;
     exchange: typeof exchange;
     fiat_accounts: typeof fiat_accounts;
     issuing: typeof issuing;
     kyc: typeof kyc;
     list: typeof list;
+    location: typeof location;
     orders: typeof orders;
     tenants: typeof tenants;
     user: typeof user;

package/dist/api/index.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.squarefi_bff_api_client = void 0;
 const auth_1 = require("./auth");
+const counterparties_1 = require("./counterparties");
 const developer_1 = require("./developer");
 const exchange_1 = require("./exchange");
 const fiat_accounts_1 = require("./fiat_accounts");
@@ -14,12 +15,14 @@ const user_1 = require("./user");
 const wallets_1 = require("./wallets");
 exports.squarefi_bff_api_client = {
     auth: auth_1.auth,
+    counterparties: counterparties_1.counterparties,
     developer: developer_1.developer,
     exchange: exchange_1.exchange,
     fiat_accounts: fiat_accounts_1.fiat_accounts,
     issuing: issuing_1.issuing,
     kyc: kyc_1.kyc,
     list: list_1.list,
+    location,
     orders: orders_1.orders,
     tenants: tenants_1.tenants,
     user: user_1.user,

package/dist/api/location.d.ts

@@ -0,0 +1,6 @@
+import { API } from './types';
+export declare const location: {
+    countries: {
+        list: () => Promise<API.Location.Countries.List.Response>;
+    };
+};

package/dist/api/location.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.location = void 0;
+const apiClientFactory_1 = require("../utils/apiClientFactory");
+exports.location = {
+    countries: {
+        list: () => apiClientFactory_1.apiClientV2.getRequest('/location/countries'),
+    },
+};