squarefi-bff-api-module 1.5.16 → 1.6.0

package/dist/api/types.d.ts

@@ -1,4 +1,4 @@
-import { APIKeyRole, CardFormFactor, CardTransactionType, CardType, CurrencyType, KYCStatuses, OrderStatuses, OrderType, SortingDirection, SubAccountType, WalletTransactionMethod, WalletTransactionRecordType, WalletTransactionType } from '../constants';
+import { APIKeyRole, CardFormFactor, CardTransactionType, CardType, CounterpartyDestinationType, CounterpartyType, CurrencyType, KYCStatuses, OrderStatuses, OrderType, SortingDirection, SubAccountType, WalletTransactionMethod, WalletTransactionRecordType, WalletTransactionType } from '../constants';
 import { WalletType } from '../';
 export declare namespace API {
     namespace Auth {
@@ -317,6 +317,18 @@ export declare namespace API {
             type FiatAccountResponse = IssuingCardDetailItem;
         }
     }
+    namespace Chains {
+        interface Chain {
+            id: number;
+            name: string;
+            symbol: string;
+            is_beta: boolean | null;
+        }
+        type ChainList = {
+            count: number;
+            data: Chain[];
+        };
+    }
     namespace Common {
         namespace Pagination {
             interface Request {
@@ -336,6 +348,213 @@ export declare namespace API {
             }
         }
     }
+    namespace Counterparties {
+        interface Counterparty {
+            id: string;
+            email: string;
+            phone: string;
+            name: string;
+            nickname: string;
+            type: CounterpartyType | string;
+            created_at: string;
+        }
+        namespace Destination {
+            namespace List {
+                interface DestinationListItemCommonFields {
+                    id: string;
+                    nickname: string;
+                    type: CounterpartyDestinationType | string;
+                    created_at: string;
+                }
+                interface DestinationListItemExternalBankingData {
+                    account_number: string;
+                    routing_number: string;
+                    bank_name: string;
+                    note: string;
+                    swift_bic: string;
+                    address?: {
+                        city?: string;
+                        country_id?: number;
+                        postcode?: string;
+                        street1?: string;
+                        street2?: string;
+                        memo?: string;
+                    };
+                }
+                interface DestinationListItemExternalCryptoData {
+                    address: string;
+                    currency_id: string;
+                }
+                interface DestinationListItemWithExternalBankingData extends DestinationListItemCommonFields {
+                    type: CounterpartyDestinationType.DOMESTIC_WIRE | CounterpartyDestinationType.ACH | CounterpartyDestinationType.SWIFT | CounterpartyDestinationType.SEPA;
+                    external_banking_data: DestinationListItemExternalBankingData;
+                    external_crypto_data?: never;
+                }
+                interface DestinationListItemWithExternalCryptoData extends DestinationListItemCommonFields {
+                    type: CounterpartyDestinationType.CRYPTO_EXTERNAL | CounterpartyDestinationType.CRYPTO_INTERNAL;
+                    external_banking_data?: never;
+                    external_crypto_data: DestinationListItemExternalCryptoData;
+                }
+                type CounterpartyDestinationListItem = DestinationListItemWithExternalBankingData | DestinationListItemWithExternalCryptoData;
+                interface Request {
+                    wallet_id: string;
+                    counterparty_account_id: string;
+                    limit?: number;
+                    offset?: number;
+                    search?: string;
+                    type?: CounterpartyDestinationType | string;
+                    sort_by?: 'created_at' | 'nickname' | 'type';
+                    sort_order?: SortingDirection;
+                    filter?: {
+                        type?: CounterpartyDestinationType;
+                        nickname?: string;
+                        created_at?: string;
+                    };
+                }
+                type Response = {
+                    total: number;
+                    data: CounterpartyDestinationListItem[];
+                };
+            }
+            namespace Detail {
+                type DestinationDetailItemCommonFields = API.Counterparties.Destination.List.DestinationListItemCommonFields;
+                interface DestinationDetailItemExternalBankingData extends API.Counterparties.Destination.List.DestinationListItemExternalBankingData {
+                    address: API.Counterparties.Destination.List.DestinationListItemExternalBankingData['address'] & {
+                        country?: API.Location.Countries.Country;
+                    };
+                }
+                interface DestinationDetailItemExternalCryptoData extends API.Counterparties.Destination.List.DestinationListItemExternalCryptoData {
+                    currency: API.Currencies.Currency;
+                }
+                interface DestinationDetailItemWithExternalBankingData extends DestinationDetailItemCommonFields {
+                    type: CounterpartyDestinationType.DOMESTIC_WIRE | CounterpartyDestinationType.ACH | CounterpartyDestinationType.SWIFT | CounterpartyDestinationType.SEPA;
+                    external_banking_data: DestinationDetailItemExternalBankingData;
+                    external_crypto_data?: never;
+                }
+                interface DestinationDetailItemWithExternalCryptoData extends DestinationDetailItemCommonFields {
+                    type: CounterpartyDestinationType.CRYPTO_EXTERNAL | CounterpartyDestinationType.CRYPTO_INTERNAL;
+                    external_banking_data?: never;
+                    external_crypto_data: DestinationDetailItemExternalCryptoData;
+                }
+                type DestinationDetailItem = DestinationDetailItemWithExternalBankingData | DestinationDetailItemWithExternalCryptoData;
+                interface Request {
+                    wallet_id: string;
+                    counterparty_account_id: string;
+                    counterparty_destination_id: string;
+                }
+                type Response = DestinationDetailItem;
+            }
+            namespace Create {
+                interface Request {
+                    wallet_id: string;
+                    counterparty_account_id: string;
+                    type: CounterpartyDestinationType;
+                    nickname: string;
+                    external_banking_data?: API.Counterparties.Destination.Detail.DestinationDetailItemExternalBankingData;
+                    external_crypto_data?: API.Counterparties.Destination.Detail.DestinationDetailItemExternalCryptoData;
+                }
+                interface Response extends API.Counterparties.Destination.Detail.DestinationDetailItemCommonFields {
+                    id: string;
+                    nickname: string;
+                    created_at: string;
+                    type: CounterpartyDestinationType;
+                    external_banking_data?: API.Counterparties.Destination.Detail.DestinationDetailItemExternalBankingData;
+                    external_crypto_data?: API.Counterparties.Destination.Detail.DestinationDetailItemExternalCryptoData;
+                }
+            }
+            namespace Update {
+                interface Request {
+                    wallet_id: string;
+                    counterparty_account_id: string;
+                    counterparty_destination_id: string;
+                    nickname: string;
+                }
+                type Response = API.Counterparties.Destination.Detail.DestinationDetailItemCommonFields;
+            }
+        }
+        namespace GetById {
+            interface Request {
+                wallet_id: string;
+                counterparty_account_id: string;
+            }
+            type Response = Counterparty;
+        }
+        namespace List {
+            interface Request {
+                wallet_id: string;
+                offset?: number;
+                limit?: number;
+                sort_by?: 'created_at' | 'nickname' | 'type' | 'email' | 'phone';
+                sort_order?: SortingDirection;
+                filter?: {
+                    type?: CounterpartyDestinationType;
+                    nickname?: string;
+                    created_at?: string;
+                };
+            }
+            type Response = {
+                total: number;
+                data: Counterparty[];
+            };
+        }
+        namespace Create {
+            interface Request {
+                email: string;
+                phone: string;
+                wallet_id: string;
+                nickname: string;
+                type: CounterpartyType;
+            }
+            type Response = Counterparty;
+        }
+        namespace Update {
+            interface Request {
+                wallet_id: string;
+                counterparty_account_id: string;
+                nickname: string;
+            }
+            type Response = Counterparty;
+        }
+    }
+    namespace Currencies {
+        interface CommonCurrencyFields {
+            uuid: string;
+            decimal: number | null;
+            is_memo: boolean | null;
+            is_stablecoin: boolean;
+            is_enabled: boolean;
+            render_decimal: number;
+            meta: {
+                icon: string;
+                name: string;
+                symbol: string;
+                description: string;
+            };
+            type: CurrencyType;
+        }
+        export interface CryptoCurrency extends CommonCurrencyFields {
+            is_crypto: true;
+            meta: CommonCurrencyFields['meta'] & {
+                chain_id: number;
+                contract: string;
+                chain_name: string;
+            };
+        }
+        export interface FiatCurrency extends CommonCurrencyFields {
+            is_crypto: false;
+            meta: CommonCurrencyFields['meta'] & {
+                code: string;
+                iso_code: number;
+                sign: string;
+            };
+        }
+        export type Currency = CryptoCurrency | FiatCurrency;
+        export type CurrencyList = {
+            count: number;
+            data: Currency[];
+        };
+        export {};
+    }
     namespace Developer {
         namespace ApiCode {
             interface ApiCode {
@@ -594,188 +813,37 @@ export declare namespace API {
             }
         }
     }
-    namespace Currencies {
-        interface CommonCurrencyFields {
-            uuid: string;
-            decimal: number | null;
-            is_memo: boolean | null;
-            is_stablecoin: boolean;
-            is_enabled: boolean;
-            render_decimal: number;
-            meta: {
-                icon: string;
-                name: string;
-                symbol: string;
-                description: string;
-            };
-            type: CurrencyType;
-        }
-        export interface CryptoCurrency extends CommonCurrencyFields {
-            is_crypto: true;
-            meta: CommonCurrencyFields['meta'] & {
-                chain_id: number;
-                contract: string;
-                chain_name: string;
-            };
-        }
-        export interface FiatCurrency extends CommonCurrencyFields {
-            is_crypto: false;
-            meta: CommonCurrencyFields['meta'] & {
-                code: string;
-                iso_code: number;
-                sign: string;
-            };
-        }
-        export type Currency = CryptoCurrency | FiatCurrency;
-        export type CurrencyList = {
-            count: number;
-            data: Currency[];
-        };
-        export {};
-    }
-    namespace Chains {
-        interface Chain {
-            id: number;
-            name: string;
-            symbol: string;
-            is_beta: boolean | null;
-        }
-        type ChainList = {
-            count: number;
-            data: Chain[];
-        };
-    }
-    namespace Wallets {
-        interface WallletBalanceCryptoDetails {
-            uuid: string;
-            amount: number;
-            fiat_amount: number;
-            currency: API.Currencies.Currency;
-        }
-        interface WalletBalanceItem {
-            symbol: string;
-            icon: string;
-            name: string;
-            is_crypto: boolean;
-            decimal?: number | null;
-            amount: number;
-            fiat_amount: number;
-            details: WallletBalanceCryptoDetails[];
-        }
-        type WalletBalance = WalletBalanceItem[];
-        namespace WalletChain {
-            interface WalletChain {
-                uuid: string;
-                created_ad: string;
-                address: string;
-                wallet_uuid: string;
-                chain: number;
-            }
-            namespace Create {
-                interface Request {
-                    wallet_uuid: string;
-                    chain: number;
-                    label: string;
-                }
-                type Response = WalletChain;
-            }
-        }
-        interface Wallet {
-            uuid: string;
-            type: WalletType | string;
-            created_at: string;
-            fiat_total: number;
-            crypto_total: number;
-            total_amount: number;
-            balance: WalletBalance;
-        }
-        namespace WalletsList {
-            interface WalletsListItem {
-                type: WalletType | string;
-                uuid: string;
-                created_at: string;
-            }
-            type Response = {
-                total: number;
-                data: WalletsListItem[];
-            };
-        }
-        namespace WalletTransactions {
-            interface WalletTransactionMeta {
-                transaction_hash?: string;
-                fee?: number;
-                order_id?: string;
-                from_address?: string;
-                to_address?: string;
-                network_fee?: number;
-                network_fee_currency?: string;
-                fee_currency?: string;
-                billing_amount?: number;
-                utila_transaction?: string;
-                transcation_amount?: number;
-                transaction_amount?: number;
-                billing_amount_currency?: string;
-                transcation_amount_currency?: string;
-                transaction_amount_currency?: string;
-                exchange_rate?: number;
-                fiat_account_id?: string;
-                txid?: string;
-                chain_id?: number;
-                from_user_data?: number;
-                to_user_data?: number;
-                to_card_id?: string;
-                to_card_last4?: string;
-                to_fiat_account_id?: string;
-                to_vendor_id?: string;
-            }
-            interface Transaction {
+    namespace Location {
+        namespace Countries {
+            interface Country {
                 id: number;
-                created_at: string;
-                type: WalletTransactionType | string;
-                method: WalletTransactionMethod | string;
-                status: string;
-                amount: number;
-                from: string | null;
-                to: string | null;
-                wallet_id: string;
-                txid: string;
-                info: string;
-                currency: API.Currencies.Currency;
-                record_type: WalletTransactionRecordType | string;
-                meta?: WalletTransactionMeta;
-            }
-            interface DetailedTransaction {
-                id: number;
-                amount: number;
-                created_at: string;
-                from: string;
-                info: string;
-                status: string;
-                to: string;
-                txid: string;
-                type: WalletTransactionType | string;
-                wallet_id: string;
-                method: WalletTransactionMethod | string;
-                meta: WalletTransactionMeta;
-                record_type: WalletTransactionRecordType | string;
-                currency: API.Currencies.Currency;
-            }
-            namespace GetByUuid {
-                type Request = {
-                    wallet_uuid: string;
-                    uuid: string;
-                };
+                capital: string;
+                currency: string;
+                currency_name: string;
+                currency_symbol: string;
+                emoji: string;
+                emojiU: string;
+                flag: number;
+                iso2: string;
+                iso3: string;
+                latitude: number;
+                longitude: number;
+                name: string;
+                nationality: string;
+                native: string;
+                numeric_code: string;
+                phonecode: string;
+                region: string;
+                region_id: number;
+                subregion: string;
+                subregion_id: number;
+                timezones: object[];
+                tld: string;
+                translations: object[];
+                wikiDataId: string;
             }
-            namespace TransactionList {
-                type Request = {
-                    wallet_uuid: string;
-                    limit?: number;
-                    offset?: number;
-                };
-                type Response = {
-                    total: number;
-                    data: Transaction[];
-                };
+            namespace List {
+                type Response = API.Location.Countries.Country[];
             }
         }
     }
@@ -975,4 +1043,138 @@ export declare namespace API {
             }
         }
     }
+    namespace Wallets {
+        interface WallletBalanceCryptoDetails {
+            uuid: string;
+            amount: number;
+            fiat_amount: number;
+            currency: API.Currencies.Currency;
+        }
+        interface WalletBalanceItem {
+            symbol: string;
+            icon: string;
+            name: string;
+            is_crypto: boolean;
+            decimal?: number | null;
+            amount: number;
+            fiat_amount: number;
+            details: WallletBalanceCryptoDetails[];
+        }
+        type WalletBalance = WalletBalanceItem[];
+        namespace WalletChain {
+            interface WalletChain {
+                uuid: string;
+                created_ad: string;
+                address: string;
+                wallet_uuid: string;
+                chain: number;
+            }
+            namespace Create {
+                interface Request {
+                    wallet_uuid: string;
+                    chain: number;
+                    label: string;
+                }
+                type Response = WalletChain;
+            }
+        }
+        interface Wallet {
+            uuid: string;
+            type: WalletType | string;
+            created_at: string;
+            fiat_total: number;
+            crypto_total: number;
+            total_amount: number;
+            balance: WalletBalance;
+        }
+        namespace WalletsList {
+            interface WalletsListItem {
+                type: WalletType | string;
+                uuid: string;
+                created_at: string;
+            }
+            type Response = {
+                total: number;
+                data: WalletsListItem[];
+            };
+        }
+        namespace WalletTransactions {
+            interface WalletTransactionMeta {
+                transaction_hash?: string;
+                fee?: number;
+                order_id?: string;
+                from_address?: string;
+                to_address?: string;
+                network_fee?: number;
+                network_fee_currency?: string;
+                fee_currency?: string;
+                billing_amount?: number;
+                utila_transaction?: string;
+                transcation_amount?: number;
+                transaction_amount?: number;
+                billing_amount_currency?: string;
+                transcation_amount_currency?: string;
+                transaction_amount_currency?: string;
+                exchange_rate?: number;
+                fiat_account_id?: string;
+                txid?: string;
+                chain_id?: number;
+                from_user_data?: number;
+                to_user_data?: number;
+                to_card_id?: string;
+                to_card_last4?: string;
+                to_fiat_account_id?: string;
+                to_vendor_id?: string;
+            }
+            interface Transaction {
+                id: number;
+                created_at: string;
+                type: WalletTransactionType | string;
+                method: WalletTransactionMethod | string;
+                status: string;
+                amount: number;
+                from: string | null;
+                to: string | null;
+                wallet_id: string;
+                txid: string;
+                info: string;
+                currency: API.Currencies.Currency;
+                record_type: WalletTransactionRecordType | string;
+                meta?: WalletTransactionMeta;
+            }
+            interface DetailedTransaction {
+                id: number;
+                amount: number;
+                created_at: string;
+                from: string;
+                info: string;
+                status: string;
+                to: string;
+                txid: string;
+                type: WalletTransactionType | string;
+                wallet_id: string;
+                method: WalletTransactionMethod | string;
+                meta: WalletTransactionMeta;
+                record_type: WalletTransactionRecordType | string;
+                currency: API.Currencies.Currency;
+            }
+            namespace GetByUuid {
+                type Request = {
+                    wallet_uuid: string;
+                    uuid: string;
+                };
+            }
+            namespace TransactionList {
+                type Request = {
+                    wallet_uuid: string;
+                    limit?: number;
+                    offset?: number;
+                };
+                type Response = {
+                    total: number;
+                    data: Transaction[];
+                };
+            }
+        }
+    }
 }

package/dist/constants.d.ts

@@ -151,3 +151,15 @@ 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"
+}

package/dist/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SortingDirection = exports.APIKeyRole = exports.OrderType = exports.CurrencyType = exports.SubAccountType = exports.FiatAccountStatus = exports.CardStatus = exports.OrderStatuses = exports.KYCStatuses = exports.defaultPaginationParams = exports.walletType = exports.WalletTypeValues = exports.ResponseStatus = exports.RequestLoadingType = exports.RequestStatus = exports.WalletTransactionRecordType = exports.WalletTransactionMethod = exports.WalletTransactionType = exports.CardTransactionType = exports.CardType = exports.CardFormFactor = exports.AppEnviroment = exports.falsyValues = void 0;
+exports.CounterpartyDestinationType = exports.CounterpartyType = exports.SortingDirection = exports.APIKeyRole = exports.OrderType = exports.CurrencyType = exports.SubAccountType = exports.FiatAccountStatus = exports.CardStatus = exports.OrderStatuses = exports.KYCStatuses = exports.defaultPaginationParams = exports.walletType = exports.WalletTypeValues = exports.ResponseStatus = exports.RequestLoadingType = exports.RequestStatus = exports.WalletTransactionRecordType = exports.WalletTransactionMethod = exports.WalletTransactionType = exports.CardTransactionType = exports.CardType = exports.CardFormFactor = exports.AppEnviroment = exports.falsyValues = void 0;
 exports.falsyValues = ['false', '0', '', 'FALSE', false, null, undefined, NaN, 0];
 var AppEnviroment;
 (function (AppEnviroment) {
@@ -175,3 +175,17 @@ var SortingDirection;
     SortingDirection["ASC"] = "ASC";
     SortingDirection["DESC"] = "DESC";
 })(SortingDirection || (exports.SortingDirection = SortingDirection = {}));
+var CounterpartyType;
+(function (CounterpartyType) {
+    CounterpartyType["INDIVIDUAL"] = "INDIVIDUAL";
+    CounterpartyType["BUSINESS"] = "BUSINESS";
+})(CounterpartyType || (exports.CounterpartyType = CounterpartyType = {}));
+var CounterpartyDestinationType;
+(function (CounterpartyDestinationType) {
+    CounterpartyDestinationType["DOMESTIC_WIRE"] = "DOMESTIC_WIRE";
+    CounterpartyDestinationType["ACH"] = "ACH";
+    CounterpartyDestinationType["SWIFT"] = "SWIFT";
+    CounterpartyDestinationType["SEPA"] = "SEPA";
+    CounterpartyDestinationType["CRYPTO_EXTERNAL"] = "CRYPTO_EXTERNAL";
+    CounterpartyDestinationType["CRYPTO_INTERNAL"] = "CRYPTO_INTERNAL";
+})(CounterpartyDestinationType || (exports.CounterpartyDestinationType = CounterpartyDestinationType = {}));

package/package.json

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