squarefi-bff-api-module 1.19.0 → 1.19.2

package/CHANGELOG.md

@@ -5,12 +5,24 @@ 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
+## [1.19.1] - 2025-06-12
+
+### Changed
+
+- Updated OrderType enum: removed deprecated values, added replacements, and aligned API request types accordingly for consistency
+
+## [1.19.0] - 2025-06-12
 
 ### Added
 
 - Integrated Time-based One-Time Password (TOTP) functionality with new types and API client methods
 
+## [1.19.2] - 2025-06-17
+
+### Added
+
+- Added OTP request functionality with updated types to improve verification process
+
 ## [1.18.9] - 2025-05-24
 
 ### Added

package/dist/api/orders.d.ts

@@ -6,7 +6,7 @@ export declare const orders: {
     };
     create: {
         byOrderType: {
-            INTERNAL_TRANSFER: (data: API.Orders.Create.ByOrderType.INTERNAL_TRANSFER.Request) => Promise<API.Orders.Create.ByOrderType.INTERNAL_TRANSFER.Response>;
+            TRANSFER_INTERNAL: (data: API.Orders.Create.ByOrderType.INTERNAL_TRANSFER.Request) => Promise<API.Orders.Create.ByOrderType.INTERNAL_TRANSFER.Response>;
             WITHDRAWAL_CRYPTO: (data: API.Orders.Create.ByOrderType.WITHDRAWAL_CRYPTO.Request) => Promise<API.Orders.Create.ByOrderType.WITHDRAWAL_CRYPTO.Response>;
             TRANSFER_CARD_SUBACCOUNT: (data: API.Orders.Create.ByOrderType.TRANSFER_CARD_SUBACCOUNT.Request) => Promise<API.Orders.Create.ByOrderType.TRANSFER_CARD_SUBACCOUNT.Response>;
             TRANSFER_CARD_PREPAID: (data: API.Orders.Create.ByOrderType.TRANSFER_CARD_PREPAID.Request) => Promise<API.Orders.Create.ByOrderType.TRANSFER_CARD_PREPAID.Response>;

package/dist/api/orders.js

@@ -24,7 +24,7 @@ exports.orders = {
     },
     create: {
         byOrderType: {
-            [constants_1.OrderType.INTERNAL_TRANSFER]: (data) => apiClientFactory_1.apiClientV1.postRequest('/orders/INTERNAL_TRANSFER', {
+            [constants_1.OrderType.TRANSFER_INTERNAL]: (data) => apiClientFactory_1.apiClientV1.postRequest('/orders/INTERNAL_TRANSFER', {
                 data,
             }),
             [constants_1.OrderType.WITHDRAWAL_CRYPTO]: (data) => apiClientFactory_1.apiClientV1.postRequest('/orders/WITHDRAWAL_CRYPTO', {

package/dist/api/totp.d.ts

@@ -2,6 +2,7 @@ import { API } from './types/types';
 export declare const totp: {
     otp_verification: {
         create: (data: API.TOTP.OTPVerification.Create.Request) => Promise<API.TOTP.OTPVerification.Create.Response>;
+        request: (data: API.TOTP.OTPVerification.RequestOtp.Request) => Promise<API.TOTP.OTPVerification.RequestOtp.Response>;
         verify: (data: API.TOTP.OTPVerification.Verify.Request) => Promise<API.TOTP.OTPVerification.Verify.Response>;
         get: (id: string) => Promise<API.TOTP.OTPVerification.OTPVerificationInfo>;
     };

package/dist/api/totp.js

@@ -7,6 +7,11 @@ exports.totp = {
         create: (data) => {
             return apiClientFactory_1.apiClientTOTP.postRequest('/api/otp-verification', { data });
         },
+        request: (data) => {
+            return apiClientFactory_1.apiClientTOTP.postRequest('/api/otp-verification/request', {
+                data,
+            });
+        },
         verify: (data) => {
             return apiClientFactory_1.apiClientTOTP.postRequest('/api/otp-verification/verify', {
                 data,

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

@@ -1104,7 +1104,7 @@ export interface components {
              * @default UNVERIFIED
              * @enum {string|null}
              */
-            kyc_status: "APPROVED" | "DECLINED" | "PENDING" | "HOLD" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | null;
+            kyc_status: "APPROVED" | "DECLINED" | "PENDING" | "HOLD" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | null;
             referral_name: string | null;
             tenant_id: string;
             turnover_limit: number;
@@ -1746,7 +1746,7 @@ export interface components {
              * @default UNVERIFIED
              * @enum {string}
              */
-            status: "APPROVED" | "DECLINED" | "PENDING" | "HOLD" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED";
+            status: "APPROVED" | "DECLINED" | "PENDING" | "HOLD" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS";
             address?: components["schemas"]["KycAddressDto"] | null;
             beneficial_owners?: components["schemas"]["KycBeneficialOwnerDto"][] | null;
         };
@@ -1850,7 +1850,7 @@ export interface components {
         WalletKycRailDto: {
             message: string | null;
             /** @enum {string} */
-            readonly status: "APPROVED" | "DECLINED" | "PENDING" | "HOLD" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED";
+            readonly status: "APPROVED" | "DECLINED" | "PENDING" | "HOLD" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS";
             extra_actions?: components["schemas"]["WalletKycRailExtraActionDto"][];
             /** @description Accepted terms and conditions data */
             terms_and_conditions: components["schemas"]["WalletKycRailTermsAndConditionsDto"][];

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

@@ -1332,7 +1332,7 @@ export declare namespace API {
                 signal?: AbortSignal;
             }
             export interface WithdrawCryptoRequest extends CommonRequestParams {
-                order_type: OrderType.WITHDRAWAL_CRYPTO | OrderType.INTERNAL_TRANSFER | OrderType.OMNIBUS_CRYPTO_WITHDRAWAL;
+                order_type: OrderType.WITHDRAWAL_CRYPTO | OrderType.TRANSFER_INTERNAL | OrderType.OMNIBUS_CRYPTO_WITHDRAWAL;
                 to_address?: string;
             }
             export interface NonWithdrawCryptoRequest extends CommonRequestParams {
@@ -1403,32 +1403,49 @@ export declare namespace API {
             type OTPVerificationChannelInfo = {
                 channel: OTPVerificationChannelType;
                 validity: number;
+                max_requests: number;
             };
             type OTPVerificationInfo = {
-                id: string;
+                request_id: string;
                 status: OTPVerificationStatus;
                 created_at: string;
                 updated_at: string;
             };
             namespace Create {
                 type Request = {
-                    id: string;
+                    request_id: string;
                     amount: number;
                     order_type: string;
                     wallet_id: string;
-                    meta: {
-                        description: string;
+                    meta?: {
+                        currency?: string;
+                        description?: string;
                     };
                 };
                 type Response = {
-                    id: string;
+                    request_id: string;
                     status: OTPVerificationStatus;
                     channels: OTPVerificationChannelInfo[];
                 };
             }
+            namespace RequestOtp {
+                type Request = {
+                    request_id: string;
+                    channel: OTPVerificationChannelType;
+                };
+                type Response = {
+                    success?: boolean;
+                    error?: boolean;
+                    message?: string;
+                    details?: string;
+                    validity?: number;
+                    request_made?: number;
+                    max_requests?: number;
+                };
+            }
             namespace Verify {
                 type Request = {
-                    id: string;
+                    request_id: string;
                     channel: OTPVerificationChannelType;
                     otp: string;
                 };

package/dist/constants.d.ts

@@ -152,16 +152,17 @@ export declare enum CurrencyType {
 export declare enum OrderType {
     DEPOSIT_ISSUING_SA_CRYPTO_EXT = "DEPOSIT_ISSUING_SA_CRYPTO_EXT",
     DEPOSIT_ISSUING_SA_SEPA_EXT = "DEPOSIT_ISSUING_SA_SEPA_EXT",
-    DEPOSIT_ISSUING_SA_SWIFT_EXT = "DEPOSIT_ISSUING_SA_SWIFT_EXT",
-    DEPOSIT_ISSUING_SA_ACH_EXT = "DEPOSIT_ISSUING_SA_ACH_EXT",
-    DEPOSIT_ISSUING_SA_WIRE_EXT = "DEPOSIT_ISSUING_SA_WIRE_EXT",
-    WITHDRAWAL_FIAT_SEPA = "WITHDRAWAL_FIAT_SEPA",
+    DEPOSIT_CRYPTO = "DEPOSIT_CRYPTO",
+    DEPOSIT_FIAT_SEPA = "DEPOSIT_FIAT_SEPA",
+    DEPOSIT_FIAT_SWIFT = "DEPOSIT_FIAT_SWIFT",
+    EXCHANGE_CRYPTO_INTERNAL = "EXCHANGE_CRYPTO_INTERNAL",
     TRANSFER_CARD_PREPAID = "TRANSFER_CARD_PREPAID",
+    CARD_ISSUING_FEE = "CARD_ISSUING_FEE",
     TRANSFER_CARD_SUBACCOUNT = "TRANSFER_CARD_SUBACCOUNT",
-    WITHDRAWAL_CRYPTO = "WITHDRAWAL_CRYPTO",
-    EXCHANGE_CRYPTO_INTERNAL = "EXCHANGE_CRYPTO_INTERNAL",
     TRANSFER_CARD_WHOLESALE = "TRANSFER_CARD_WHOLESALE",
-    INTERNAL_TRANSFER = "INTERNAL_TRANSFER",
+    TRANSFER_INTERNAL = "TRANSFER_INTERNAL",
+    WITHDRAWAL_CRYPTO = "WITHDRAWAL_CRYPTO",
+    WITHDRAWAL_FIAT_SEPA = "WITHDRAWAL_FIAT_SEPA",
     HIFI_WIRE_ONRAMP = "HIFI_WIRE_ONRAMP",
     HIFI_ACH_ONRAMP = "HIFI_ACH_ONRAMP",
     HIFI_SEPA_ONRAMP = "HIFI_SEPA_ONRAMP",

package/dist/constants.js

@@ -175,20 +175,19 @@ var CurrencyType;
 })(CurrencyType || (exports.CurrencyType = CurrencyType = {}));
 var OrderType;
 (function (OrderType) {
-    // DEPOSIT_FIAT_SEPA = 'DEPOSIT_FIAT_SEPA', // deprecated, replaced by DEPOSIT_ISSUING_SA_SEPA_EXT
-    // DEPOSIT_FIAT_SWIFT = 'DEPOSIT_FIAT_SWIFT', // deprecated, replaced by DEPOSIT_ISSUING_SA_SWIFT_EXT
     OrderType["DEPOSIT_ISSUING_SA_CRYPTO_EXT"] = "DEPOSIT_ISSUING_SA_CRYPTO_EXT";
     OrderType["DEPOSIT_ISSUING_SA_SEPA_EXT"] = "DEPOSIT_ISSUING_SA_SEPA_EXT";
-    OrderType["DEPOSIT_ISSUING_SA_SWIFT_EXT"] = "DEPOSIT_ISSUING_SA_SWIFT_EXT";
-    OrderType["DEPOSIT_ISSUING_SA_ACH_EXT"] = "DEPOSIT_ISSUING_SA_ACH_EXT";
-    OrderType["DEPOSIT_ISSUING_SA_WIRE_EXT"] = "DEPOSIT_ISSUING_SA_WIRE_EXT";
-    OrderType["WITHDRAWAL_FIAT_SEPA"] = "WITHDRAWAL_FIAT_SEPA";
+    OrderType["DEPOSIT_CRYPTO"] = "DEPOSIT_CRYPTO";
+    OrderType["DEPOSIT_FIAT_SEPA"] = "DEPOSIT_FIAT_SEPA";
+    OrderType["DEPOSIT_FIAT_SWIFT"] = "DEPOSIT_FIAT_SWIFT";
+    OrderType["EXCHANGE_CRYPTO_INTERNAL"] = "EXCHANGE_CRYPTO_INTERNAL";
     OrderType["TRANSFER_CARD_PREPAID"] = "TRANSFER_CARD_PREPAID";
+    OrderType["CARD_ISSUING_FEE"] = "CARD_ISSUING_FEE";
     OrderType["TRANSFER_CARD_SUBACCOUNT"] = "TRANSFER_CARD_SUBACCOUNT";
-    OrderType["WITHDRAWAL_CRYPTO"] = "WITHDRAWAL_CRYPTO";
-    OrderType["EXCHANGE_CRYPTO_INTERNAL"] = "EXCHANGE_CRYPTO_INTERNAL";
     OrderType["TRANSFER_CARD_WHOLESALE"] = "TRANSFER_CARD_WHOLESALE";
-    OrderType["INTERNAL_TRANSFER"] = "INTERNAL_TRANSFER";
+    OrderType["TRANSFER_INTERNAL"] = "TRANSFER_INTERNAL";
+    OrderType["WITHDRAWAL_CRYPTO"] = "WITHDRAWAL_CRYPTO";
+    OrderType["WITHDRAWAL_FIAT_SEPA"] = "WITHDRAWAL_FIAT_SEPA";
     OrderType["HIFI_WIRE_ONRAMP"] = "HIFI_WIRE_ONRAMP";
     OrderType["HIFI_ACH_ONRAMP"] = "HIFI_ACH_ONRAMP";
     OrderType["HIFI_SEPA_ONRAMP"] = "HIFI_SEPA_ONRAMP";

package/package.json

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

package/src/api/orders.ts

@@ -15,7 +15,7 @@ export const orders = {
 
   create: {
     byOrderType: {
-      [OrderType.INTERNAL_TRANSFER]: (
+      [OrderType.TRANSFER_INTERNAL]: (
         data: API.Orders.Create.ByOrderType.INTERNAL_TRANSFER.Request
       ): Promise<API.Orders.Create.ByOrderType.INTERNAL_TRANSFER.Response> =>
         apiClientV1.postRequest<API.Orders.Create.ByOrderType.INTERNAL_TRANSFER.Response>('/orders/INTERNAL_TRANSFER', {

package/src/api/totp.ts

@@ -6,6 +6,13 @@ export const totp = {
     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 });
     },
+    request: (
+      data: API.TOTP.OTPVerification.RequestOtp.Request
+    ): Promise<API.TOTP.OTPVerification.RequestOtp.Response> => {
+      return apiClientTOTP.postRequest<API.TOTP.OTPVerification.RequestOtp.Response>('/api/otp-verification/request', {
+        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,

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

@@ -1105,7 +1105,7 @@ export interface components {
              * @default UNVERIFIED
              * @enum {string|null}
              */
-            kyc_status: "APPROVED" | "DECLINED" | "PENDING" | "HOLD" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | null;
+            kyc_status: "APPROVED" | "DECLINED" | "PENDING" | "HOLD" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | null;
             referral_name: string | null;
             tenant_id: string;
             turnover_limit: number;
@@ -1747,7 +1747,7 @@ export interface components {
              * @default UNVERIFIED
              * @enum {string}
              */
-            status: "APPROVED" | "DECLINED" | "PENDING" | "HOLD" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED";
+            status: "APPROVED" | "DECLINED" | "PENDING" | "HOLD" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS";
             address?: components["schemas"]["KycAddressDto"] | null;
             beneficial_owners?: components["schemas"]["KycBeneficialOwnerDto"][] | null;
         };
@@ -1851,7 +1851,7 @@ export interface components {
         WalletKycRailDto: {
             message: string | null;
             /** @enum {string} */
-            readonly status: "APPROVED" | "DECLINED" | "PENDING" | "HOLD" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED";
+            readonly status: "APPROVED" | "DECLINED" | "PENDING" | "HOLD" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS";
             extra_actions?: components["schemas"]["WalletKycRailExtraActionDto"][];
             /** @description Accepted terms and conditions data */
             terms_and_conditions: components["schemas"]["WalletKycRailTermsAndConditionsDto"][];

package/src/api/types/types.ts

@@ -1539,7 +1539,7 @@ export namespace API {
       }
 
       export interface WithdrawCryptoRequest extends CommonRequestParams {
-        order_type: OrderType.WITHDRAWAL_CRYPTO | OrderType.INTERNAL_TRANSFER | OrderType.OMNIBUS_CRYPTO_WITHDRAWAL;
+        order_type: OrderType.WITHDRAWAL_CRYPTO | OrderType.TRANSFER_INTERNAL | OrderType.OMNIBUS_CRYPTO_WITHDRAWAL;
         to_address?: string;
       }
 
@@ -1702,9 +1702,10 @@ export namespace API {
       export type OTPVerificationChannelInfo = {
         channel: OTPVerificationChannelType;
         validity: number;
+        max_requests: number;
       };
       export type OTPVerificationInfo = {
-        id: string;
+        request_id: string;
         status: OTPVerificationStatus;
         created_at: string;
         updated_at: string;
@@ -1712,25 +1713,43 @@ export namespace API {
 
       export namespace Create {
         export type Request = {
-          id: string;
+          request_id: string;
           amount: number;
           order_type: string;
           wallet_id: string;
-          meta: {
-            description: string;
+          meta?: {
+            currency?: string;
+            description?: string;
           };
         };
 
         export type Response = {
-          id: string;
+          request_id: string;
           status: OTPVerificationStatus;
           channels: OTPVerificationChannelInfo[];
         };
       }
 
+      export namespace RequestOtp {
+        export type Request = {
+          request_id: string;
+          channel: OTPVerificationChannelType;
+        };
+
+        export type Response = {
+          success?: boolean;
+          error?: boolean;
+          message?: string;
+          details?: string;
+          validity?: number;
+          request_made?: number;
+          max_requests?: number;
+        };
+      }
+
       export namespace Verify {
         export type Request = {
-          id: string;
+          request_id: string;
           channel: OTPVerificationChannelType;
           otp: string;
         };

package/src/constants.ts

@@ -183,20 +183,19 @@ export enum CurrencyType {
 }
 
 export enum OrderType {
-  // DEPOSIT_FIAT_SEPA = 'DEPOSIT_FIAT_SEPA', // deprecated, replaced by DEPOSIT_ISSUING_SA_SEPA_EXT
-  // DEPOSIT_FIAT_SWIFT = 'DEPOSIT_FIAT_SWIFT', // deprecated, replaced by DEPOSIT_ISSUING_SA_SWIFT_EXT
   DEPOSIT_ISSUING_SA_CRYPTO_EXT = 'DEPOSIT_ISSUING_SA_CRYPTO_EXT',
   DEPOSIT_ISSUING_SA_SEPA_EXT = 'DEPOSIT_ISSUING_SA_SEPA_EXT',
-  DEPOSIT_ISSUING_SA_SWIFT_EXT = 'DEPOSIT_ISSUING_SA_SWIFT_EXT',
-  DEPOSIT_ISSUING_SA_ACH_EXT = 'DEPOSIT_ISSUING_SA_ACH_EXT',
-  DEPOSIT_ISSUING_SA_WIRE_EXT = 'DEPOSIT_ISSUING_SA_WIRE_EXT',
-  WITHDRAWAL_FIAT_SEPA = 'WITHDRAWAL_FIAT_SEPA',
+  DEPOSIT_CRYPTO = 'DEPOSIT_CRYPTO',
+  DEPOSIT_FIAT_SEPA = 'DEPOSIT_FIAT_SEPA',
+  DEPOSIT_FIAT_SWIFT = 'DEPOSIT_FIAT_SWIFT',
+  EXCHANGE_CRYPTO_INTERNAL = 'EXCHANGE_CRYPTO_INTERNAL',
   TRANSFER_CARD_PREPAID = 'TRANSFER_CARD_PREPAID',
+  CARD_ISSUING_FEE = 'CARD_ISSUING_FEE',
   TRANSFER_CARD_SUBACCOUNT = 'TRANSFER_CARD_SUBACCOUNT',
-  WITHDRAWAL_CRYPTO = 'WITHDRAWAL_CRYPTO',
-  EXCHANGE_CRYPTO_INTERNAL = 'EXCHANGE_CRYPTO_INTERNAL',
   TRANSFER_CARD_WHOLESALE = 'TRANSFER_CARD_WHOLESALE',
-  INTERNAL_TRANSFER = 'INTERNAL_TRANSFER',
+  TRANSFER_INTERNAL = 'TRANSFER_INTERNAL',
+  WITHDRAWAL_CRYPTO = 'WITHDRAWAL_CRYPTO',
+  WITHDRAWAL_FIAT_SEPA = 'WITHDRAWAL_FIAT_SEPA',
   HIFI_WIRE_ONRAMP = 'HIFI_WIRE_ONRAMP',
   HIFI_ACH_ONRAMP = 'HIFI_ACH_ONRAMP',
   HIFI_SEPA_ONRAMP = 'HIFI_SEPA_ONRAMP',