squarefi-bff-api-module 1.32.1 → 1.32.2

package/dist/api/types/types.js

@@ -0,0 +1 @@
+export {};

package/dist/api/user.d.ts

@@ -0,0 +1,18 @@
+import { API } from './types/types';
+export declare const user: {
+    get: () => Promise<API.User.Get.Response>;
+    userData: {
+        get: () => Promise<API.User.UserData.Get.Response>;
+        update: (data: API.User.UserData.Update.Request) => Promise<API.User.UserData.Update.Response>;
+    };
+    update: {
+        phone: {
+            request: (data: API.User.UpdateUser.Phone.RequestOTP.Request) => Promise<void>;
+            confirm: (data: API.User.UpdateUser.Phone.Confirm.Request) => Promise<void>;
+        };
+        email: {
+            request: (data: API.User.UpdateUser.Email.RequestOTP.Request) => Promise<void>;
+            confirm: (data: API.User.UpdateUser.Email.Confirm.Request) => Promise<void>;
+        };
+    };
+};

package/dist/api/user.js

@@ -0,0 +1,18 @@
+import { apiClientV2 } from '../utils/apiClientFactory';
+export const user = {
+    get: () => apiClientV2.getRequest('/user'),
+    userData: {
+        get: () => apiClientV2.getRequest('/user/user-data'),
+        update: (data) => apiClientV2.patchRequest('/user/user-data', { data }),
+    },
+    update: {
+        phone: {
+            request: (data) => apiClientV2.patchRequest('/user/phone', { data }),
+            confirm: (data) => apiClientV2.postRequest('/user/phone', { data }),
+        },
+        email: {
+            request: (data) => apiClientV2.patchRequest('/user/email', { data }),
+            confirm: (data) => apiClientV2.postRequest('/user/email', { data }),
+        },
+    },
+};

package/dist/api/virtual-accounts.d.ts

@@ -0,0 +1,9 @@
+import { API } from './types/types';
+export declare const virtualAccounts: {
+    create: (data: API.VirtualAccounts.Create.Request) => Promise<API.VirtualAccounts.VirtualAccount.VirtualAccountDetailItem>;
+    getAll: ({ wallet_uuid, ...params }: API.VirtualAccounts.GetAll.Request) => Promise<API.VirtualAccounts.GetAll.Response>;
+    getByUuid: ({ uuid }: API.VirtualAccounts.GetByUuid.Request) => Promise<API.VirtualAccounts.VirtualAccount.VirtualAccountDetailItem>;
+    programs: {
+        list: (params: API.VirtualAccounts.Programs.List.Request) => Promise<API.VirtualAccounts.Programs.List.Response>;
+    };
+};

package/dist/api/virtual-accounts.js

@@ -0,0 +1,9 @@
+import { apiClientV1 } from '../utils/apiClientFactory';
+export const virtualAccounts = {
+    create: (data) => apiClientV1.postRequest('/virtual_account', { data }),
+    getAll: ({ wallet_uuid, ...params }) => apiClientV1.getRequest(`/virtual_account/list/${wallet_uuid}`, { params }),
+    getByUuid: ({ uuid }) => apiClientV1.getRequest(`/virtual_account/${uuid}`),
+    programs: {
+        list: (params) => apiClientV1.getRequest('/virtual_account/programs/list', { params }),
+    },
+};

package/dist/api/wallets.d.ts

@@ -0,0 +1,24 @@
+import { API } from './types/types';
+import { WalletTypeValues } from '../constants';
+export declare const wallets: {
+    create: (type: WalletTypeValues) => Promise<void>;
+    getAll: (params: API.Wallets.WalletsList.Request) => Promise<API.Wallets.WalletsList.Response>;
+    getByUuid: (uuid: string) => Promise<API.Wallets.Wallet>;
+    addresses: {
+        create: (data: API.Wallets.WalletChain.Create.Request) => Promise<API.Wallets.WalletChain.Create.Response>;
+        get: {
+            byWalletUuid: {
+                byChainId: (wallet_uuid: string, chain_id: number) => Promise<API.Wallets.WalletChain.WalletChain>;
+            };
+        };
+    };
+    transactions: {
+        byWalletUuid: {
+            getAll: (data: API.Wallets.WalletTransactions.TransactionList.Request) => Promise<API.Wallets.WalletTransactions.TransactionList.Response>;
+            getByUuid: ({ wallet_uuid, uuid, }: API.Wallets.WalletTransactions.GetByUuid.Request) => Promise<API.Wallets.WalletTransactions.DetailedTransaction>;
+        };
+        csv: {
+            getByWalletUuid: ({ wallet_uuid, ...params }: API.Wallets.WalletTransactions.TransactionList.ExportCsv.Request) => Promise<API.Wallets.WalletTransactions.TransactionList.ExportCsv.Response>;
+        };
+    };
+};

package/dist/api/wallets.js

@@ -0,0 +1,30 @@
+import { apiClientV2 } from '../utils/apiClientFactory';
+import { defaultPaginationParams } from '../constants';
+export const wallets = {
+    create: (type) => apiClientV2.postRequest('/wallets', { data: { type } }),
+    getAll: (params) => apiClientV2.getRequest('/wallets', { params }),
+    getByUuid: (uuid) => apiClientV2.getRequest(`/wallets/${uuid}`),
+    addresses: {
+        create: (data) => {
+            const { wallet_uuid, chain, label } = data;
+            return apiClientV2.postRequest(`/wallets/${wallet_uuid}/addresses/${chain}`, { data: { label } });
+        },
+        get: {
+            byWalletUuid: {
+                byChainId: (wallet_uuid, chain_id) => apiClientV2.getRequest(`/wallets/${wallet_uuid}/addresses/${chain_id}`),
+            },
+        },
+    },
+    transactions: {
+        byWalletUuid: {
+            getAll: async (data) => {
+                const { wallet_uuid, limit = defaultPaginationParams.limit, offset = defaultPaginationParams.offset, ...params } = data;
+                return apiClientV2.getRequest(`/wallets/${wallet_uuid}/transactions`, { params: { limit, offset, ...params } });
+            },
+            getByUuid: ({ wallet_uuid, uuid, }) => apiClientV2.getRequest(`/wallets/${wallet_uuid}/transactions/${uuid}`),
+        },
+        csv: {
+            getByWalletUuid: ({ wallet_uuid, ...params }) => apiClientV2.getRequest(`/wallets/${wallet_uuid}/transactions/export/csv`, { params }),
+        },
+    },
+};

package/dist/constants.d.ts

@@ -0,0 +1,303 @@
+export type ValueWithLabel = {
+    value: string;
+    label: string;
+};
+export type WalletType = {
+    [key: string]: ValueWithLabel;
+};
+export declare const falsyValues: (string | number | boolean | null | undefined)[];
+export declare enum AppEnviroment {
+    WEB = "web",
+    TELEGRAM = "telegram"
+}
+export declare enum CardFormFactor {
+    VIRTUAL = "VIRTUAL",
+    PHYSICAL = "PHYSICAL"
+}
+export declare enum CardType {
+    CREDIT = "CREDIT",
+    DEBIT = "DEBIT"
+}
+export declare enum CardTransactionType {
+    AUTHORIZATION = "AUTHORIZATION",
+    CLEARING = "CLEARING",
+    REFUND = "REFUND",
+    REVERSAL = "REVERSAL",
+    ORIGINAL_CREDIT = "ORIGINAL_CREDIT",
+    FEE = "FEE",
+    DEPOSIT = "DEPOSIT",
+    WITHDRAWAL = "WITHDRAWAL",
+    PAYMENT = "PAYMENT",
+    PURCHASE = "PURCHASE"
+}
+export declare enum WalletTransactionType {
+    DEPOSIT = "deposit",
+    WITHDRAWAL = "withdrawal"
+}
+export declare enum WalletTransactionMethod {
+    P2P = "p2p",
+    CRYPTO = "crypto",
+    BANK_TRANSFER = "bank_transfer",
+    EXCHANGE = "exchange",
+    SBP = "sbp"
+}
+export declare enum WalletTransactionStatus {
+    COMPLETE = "complete",
+    PENDING = "pending",
+    CANCELED = "canceled",
+    FAILED = "failed",
+    PROCESSING = "processing",
+    NEW = "new"
+}
+export declare enum OrderPaymentMethod {
+    ACH = "ACH",
+    SEPA = "SEPA",
+    SWIFT = "SWIFT",
+    DOMESTIC_WIRE = "DOMESTIC_WIRE",
+    CRYPTO_EXTERNAL = "CRYPTO_EXTERNAL",
+    CRYPTO_INTERNAL = "CRYPTO_INTERNAL",
+    CHAPS = "CHAPS",
+    FPS = "FPS"
+}
+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_CRYPTO = "DEPOSIT_CRYPTO",
+    DEPOSIT_FIAT_SEPA = "DEPOSIT_FIAT_SEPA",
+    DEPOSIT_FIAT_SWIFT = "DEPOSIT_FIAT_SWIFT",
+    EXCHANGE_CRYPTO_INTERNAL = "EXCHANGE_CRYPTO_INTERNAL",
+    EXCHANGE_OMNI = "EXCHANGE_OMNI",
+    TRANSFER_CARD_PREPAID = "TRANSFER_CARD_PREPAID",
+    CARD_ISSUING_FEE = "CARD_ISSUING_FEE",
+    TRANSFER_CARD_SUBACCOUNT = "TRANSFER_CARD_SUBACCOUNT",
+    TRANSFER_CARD_WHOLESALE = "TRANSFER_CARD_WHOLESALE",
+    TRANSFER_INTERNAL = "TRANSFER_INTERNAL",
+    WITHDRAWAL_CRYPTO = "WITHDRAWAL_CRYPTO",
+    WITHDRAWAL_FIAT_SEPA = "WITHDRAWAL_FIAT_SEPA",
+    HIFI_WIRE_ONRAMP = "HIFI_WIRE_ONRAMP",
+    HIFI_WIRE_OFFRAMP = "HIFI_WIRE_OFFRAMP",
+    HIFI_WIRE_DEPOSIT = "HIFI_WIRE_DEPOSIT",
+    HIFI_WIRE_WITHDRAWAL = "HIFI_WIRE_WITHDRAWAL",
+    HIFI_ACH_ONRAMP = "HIFI_ACH_ONRAMP",
+    HIFI_ACH_OFFRAMP = "HIFI_ACH_OFFRAMP",
+    HIFI_ACH_DEPOSIT = "HIFI_ACH_DEPOSIT",
+    HIFI_ACH_WITHDRAWAL = "HIFI_ACH_WITHDRAWAL",
+    HIFI_SEPA_ONRAMP = "HIFI_SEPA_ONRAMP",
+    HIFI_SEPA_OFFRAMP = "HIFI_SEPA_OFFRAMP",
+    HIFI_SEPA_DEPOSIT = "HIFI_SEPA_DEPOSIT",
+    HIFI_SEPA_WITHDRAWAL = "HIFI_SEPA_WITHDRAWAL",
+    HIFI_CRYPTO_TRANSFER = "HIFI_CRYPTO_TRANSFER",
+    HIFI_CRYPTO_WITHDRAWAL = "HIFI_CRYPTO_WITHDRAWAL",
+    HIFI_CRYPTO_DEPOSIT = "HIFI_CRYPTO_DEPOSIT",
+    OMNIBUS_CRYPTO_TRANSFER = "OMNIBUS_CRYPTO_TRANSFER",
+    RN_CARDS_OFFRAMP = "RN_CARDS_OFFRAMP",
+    TBD_SWIFT_WITHDRAWAL = "TBD_SWIFT_WITHDRAWAL",// not implemented yet
+    SEGREGATED_CRYPTO_TRANSFER = "SEGREGATED_CRYPTO_TRANSFER",
+    L2F_ACH_ONRAMP = "L2F_ACH_ONRAMP",
+    L2F_ACH_OFFRAMP = "L2F_ACH_OFFRAMP",
+    L2F_ACH_DEPOSIT = "L2F_ACH_DEPOSIT",
+    L2F_ACH_WITHDRAWAL = "L2F_ACH_WITHDRAWAL",
+    L2F_WIRE_ONRAMP = "L2F_WIRE_ONRAMP",
+    L2F_WIRE_OFFRAMP = "L2F_WIRE_OFFRAMP",
+    L2F_WIRE_DEPOSIT = "L2F_WIRE_DEPOSIT",
+    L2F_WIRE_WITHDRAWAL = "L2F_WIRE_WITHDRAWAL",
+    L2F_SWIFT_ONRAMP = "L2F_SWIFT_ONRAMP",
+    L2F_SWIFT_OFFRAMP = "L2F_SWIFT_OFFRAMP",
+    L2F_SWIFT_DEPOSIT = "L2F_SWIFT_DEPOSIT",
+    L2F_SWIFT_WITHDRAWAL = "L2F_SWIFT_WITHDRAWAL",
+    L2F_SEPA_ONRAMP = "L2F_SEPA_ONRAMP",
+    L2F_SEPA_OFFRAMP = "L2F_SEPA_OFFRAMP",
+    L2F_SEPA_DEPOSIT = "L2F_SEPA_DEPOSIT",
+    L2F_SEPA_WITHDRAWAL = "L2F_SEPA_WITHDRAWAL",
+    L2F_CRYPTO_WITHDRAWAL = "L2F_CRYPTO_WITHDRAWAL",
+    L2F_CRYPTO_DEPOSIT = "L2F_CRYPTO_DEPOSIT",
+    OMNIBUS_CRYPTO_WITHDRAWAL = "OMNIBUS_CRYPTO_WITHDRAWAL",
+    WITHDRAW_CARD_PREPAID = "WITHDRAW_CARD_PREPAID",
+    WITHDRAW_CARD_SUBACCOUNT = "WITHDRAW_CARD_SUBACCOUNT"
+}
+export declare enum WalletTransactionRecordType {
+    CARD_PROVIDER_DEPOSIT = "CARD_PROVIDER_DEPOSIT",
+    CARD_PROVIDER_REFUND = "CARD_PROVIDER_REFUND",
+    DEPOSIT = "DEPOSIT",
+    DEPOSIT_CRYPTO_EXTERNAL = "DEPOSIT_CRYPTO_EXTERNAL",
+    DEPOSIT_CRYPTO_INTERNAL = "DEPOSIT_CRYPTO_INTERNAL",
+    DEPOSIT_INTERNAL = "DEPOSIT_INTERNAL",
+    DEPOSIT_MANUAL = "DEPOSIT_MANUAL",
+    EXCHANGE_CRYPTO_INTERNAL = "EXCHANGE_CRYPTO_INTERNAL",
+    EXCHANGE_OMNI = "EXCHANGE_OMNI",
+    EXT_EXCHANGE = "EXT_EXCHANGE",
+    FEE = "FEE",
+    NETWORK_FEE = "NETWORK_FEE",
+    OFFRAMP_ACHWIRE = "OFFRAMP_ACHWIRE",
+    OFFRAMP_SEPA = "OFFRAMP_SEPA",
+    OMNIBUS_CRYPTO_TRANSFER = "OMNIBUS_CRYPTO_TRANSFER",
+    ONRAMP_ACHWIRE = "ONRAMP_ACHWIRE",
+    ONRAMP_SEPA = "ONRAMP_SEPA",
+    REFUND = "REFUND",
+    RN_CARDS_OFFRAMP = "RN_CARDS_OFFRAMP",
+    TRANSFER_CARD_PREPAID = "TRANSFER_CARD_PREPAID",
+    TRANSFER_CARD_SUBACCOUNT = "TRANSFER_CARD_SUBACCOUNT",
+    TRANSFER_CARD_WHOLESALE = "TRANSFER_CARD_WHOLESALE",
+    TRANSFER_INTERNAL = "TRANSFER_INTERNAL",
+    SEGREGATED_CRYPTO_TRANSFER = "SEGREGATED_CRYPTO_TRANSFER",
+    WHOLESALE_CARD_DEPOSIT = "WHOLESALE_CARD_DEPOSIT",
+    WITHDRAWAL = "WITHDRAWAL",
+    WITHDRAWAL_CRYPTO_EXTERNAL = "WITHDRAWAL_CRYPTO_EXTERNAL",
+    WITHDRAWAL_CRYPTO_INTERNAL = "WITHDRAWAL_CRYPTO_INTERNAL",
+    WITHDRAWAL_INTERNAL = "WITHDRAWAL_INTERNAL",
+    WITHDRAW_CARD_PREPAID = "WITHDRAW_CARD_PREPAID",
+    WITHDRAW_CARD_SUBACCOUNT = "WITHDRAW_CARD_SUBACCOUNT",
+    L2F_ACH_ONRAMP = "L2F_ACH_ONRAMP",
+    L2F_ACH_OFFRAMP = "L2F_ACH_OFFRAMP",
+    L2F_ACH_DEPOSIT = "L2F_ACH_DEPOSIT",
+    L2F_ACH_WITHDRAWAL = "L2F_ACH_WITHDRAWAL",
+    L2F_WIRE_ONRAMP = "L2F_WIRE_ONRAMP",
+    L2F_WIRE_OFFRAMP = "L2F_WIRE_OFFRAMP",
+    L2F_WIRE_DEPOSIT = "L2F_WIRE_DEPOSIT",
+    L2F_WIRE_WITHDRAWAL = "L2F_WIRE_WITHDRAWAL",
+    L2F_SWIFT_ONRAMP = "L2F_SWIFT_ONRAMP",
+    L2F_SWIFT_OFFRAMP = "L2F_SWIFT_OFFRAMP",
+    L2F_SWIFT_DEPOSIT = "L2F_SWIFT_DEPOSIT",
+    L2F_SWIFT_WITHDRAWAL = "L2F_SWIFT_WITHDRAWAL",
+    L2F_SEPA_ONRAMP = "L2F_SEPA_ONRAMP",
+    L2F_SEPA_OFFRAMP = "L2F_SEPA_OFFRAMP",
+    L2F_SEPA_DEPOSIT = "L2F_SEPA_DEPOSIT",
+    L2F_SEPA_WITHDRAWAL = "L2F_SEPA_WITHDRAWAL",
+    L2F_CRYPTO_WITHDRAWAL = "L2F_CRYPTO_WITHDRAWAL",
+    L2F_CRYPTO_DEPOSIT = "L2F_CRYPTO_DEPOSIT",
+    HIFI_WIRE_ONRAMP = "HIFI_WIRE_ONRAMP",
+    HIFI_WIRE_OFFRAMP = "HIFI_WIRE_OFFRAMP",
+    HIFI_WIRE_DEPOSIT = "HIFI_WIRE_DEPOSIT",
+    HIFI_WIRE_WITHDRAWAL = "HIFI_WIRE_WITHDRAWAL",
+    HIFI_ACH_ONRAMP = "HIFI_ACH_ONRAMP",
+    HIFI_ACH_OFFRAMP = "HIFI_ACH_OFFRAMP",
+    HIFI_ACH_DEPOSIT = "HIFI_ACH_DEPOSIT",
+    HIFI_ACH_WITHDRAWAL = "HIFI_ACH_WITHDRAWAL",
+    HIFI_SEPA_ONRAMP = "HIFI_SEPA_ONRAMP",
+    HIFI_SEPA_OFFRAMP = "HIFI_SEPA_OFFRAMP",
+    HIFI_SEPA_DEPOSIT = "HIFI_SEPA_DEPOSIT",
+    HIFI_SEPA_WITHDRAWAL = "HIFI_SEPA_WITHDRAWAL",
+    HIFI_CRYPTO_TRANSFER = "HIFI_CRYPTO_TRANSFER",
+    HIFI_CRYPTO_WITHDRAWAL = "HIFI_CRYPTO_WITHDRAWAL",
+    HIFI_CRYPTO_DEPOSIT = "HIFI_CRYPTO_DEPOSIT"
+}
+export declare enum RequestStatus {
+    NONE = "none",
+    PENDING = "pending",
+    FULLFILLED = "fulfilled",
+    REJECTED = "rejected"
+}
+export declare enum RequestLoadingType {
+    NORMAL = "normal",
+    TRANSPARENT = "transparent"
+}
+export declare enum ResponseStatus {
+    BAD_REQUEST = 400,
+    UNAUTHORIZED = 401,
+    FORBIDDEN = 403,
+    NOT_FOUND = 404,
+    VERIFICATION_EXPIRED = 419,
+    UNPROCESSABLE_ENTITY = 422,
+    USER_BLOCKED = 423,
+    SERVER_ERROR = 500
+}
+export declare enum WalletTypeValues {
+    BUSINESS = "business",
+    PERSONAL = "personal",
+    P2P = "trading",
+    ESCROW = "escrow",
+    MERCHANT = "merchant",
+    EXCHANGE = "exchange",
+    STAKING = "staking",
+    VAULT = "vault"
+}
+export declare const walletType: WalletType;
+export declare const defaultPaginationParams: {
+    limit: number;
+    offset: number;
+    isLastPage: boolean;
+};
+export declare enum CalcType {
+    ONRAMP = "onramp",
+    OFFRAMP = "offramp",
+    WITHDRAWAL = "withdrawal"
+}
+export declare enum KYCStatuses {
+    APPROVED = "APPROVED",
+    DECLINED = "DECLINED",
+    PENDING = "PENDING",
+    HOLD = "HOLD",
+    DOUBLE = "DOUBLE",
+    SOFT_REJECT = "SOFT_REJECT",
+    REJECT = "REJECT",
+    UNVERIFIED = "UNVERIFIED"
+}
+export declare enum OrderStatuses {
+    NEW = "NEW",
+    PENDING = "PENDING",
+    PROCESSING = "PROCESSING",
+    CANCELED = "CANCELED",
+    COMPLETE = "COMPLETE",
+    ERROR = "ERROR",
+    FAILED = "FAILED"
+}
+export declare enum CardStatus {
+    ACTIVE = "ACTIVE",
+    FROZEN = "FROZEN",
+    BLOCKED = "BLOCKED",
+    INACTIVE = "INACTIVE",
+    CANCELED = "CANCELED",
+    CLOSED = "CLOSED"
+}
+export declare enum IssuingProgramStatus {
+    ACTIVE = "ACTIVE",
+    ARCHIVED = "ARCHIVED"
+}
+export declare enum SubAccountStatus {
+    ACTIVE = "ACTIVE",
+    BLOCKED = "BLOCKED",
+    INACTIVE = "INACTIVE",
+    CANCELED = "CANCELED"
+}
+export declare enum SubAccountType {
+    PREPAID = "prepaid",
+    BALANCE = "balance"
+}
+export declare enum CurrencyType {
+    TOKEN = "token",
+    NATIVE = "native",
+    FIAT = "fiat"
+}
+export declare enum APIKeyRole {
+    READ_ONLY = "READ_ONLY",
+    DEVELOPER = "DEVELOPER",
+    PRODUCTION = "PRODUCTION"
+}
+export declare enum SortingDirection {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export declare enum CounterpartyType {
+    INDIVIDUAL = "INDIVIDUAL",
+    BUSINESS = "BUSINESS"
+}
+export declare enum CounterpartyDestinationType {
+    DOMESTIC_WIRE = "DOMESTIC_WIRE",
+    ACH = "ACH",
+    SWIFT = "SWIFT",
+    SEPA = "SEPA",
+    CRYPTO_EXTERNAL = "CRYPTO_EXTERNAL",
+    CRYPTO_INTERNAL = "CRYPTO_INTERNAL"
+}
+export declare enum CardTransactionStatus {
+    APPROVED = "APPROVED",
+    CLEARED = "CLEARED",
+    COMPLETED = "COMPLETED",
+    EXPIRED = "EXPIRED",
+    FAILED = "FAILED",
+    CANCELLED = "CANCELLED",
+    CANCELED = "CANCELED",
+    PENDING = "PENDING",
+    REVERSED = "REVERSED",
+    DECLINED = "DECLINED"
+}