squarefi-bff-api-module 1.29.2 → 1.30.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -41,5 +41,9 @@ export declare const orders: {
41
41
  L2F_WIRE_OFFRAMP: (data: API.Orders.V2.Create.ByOrderType.L2F_WIRE_OFFRAMP.Request) => Promise<API.Orders.V2.Create.ByOrderType.L2F_WIRE_OFFRAMP.Response>;
42
42
  };
43
43
  };
44
+ list: {
45
+ byWallet: ({ wallet_uuid, ...params }: API.Orders.V2.List.ByWallet.Request) => Promise<API.Orders.V2.List.ByWallet.Response>;
46
+ };
47
+ getById: ({ order_uuid }: API.Orders.V2.GetById.Request) => Promise<API.Orders.V2.GetById.Response>;
44
48
  };
45
49
  };
@@ -94,5 +94,14 @@ exports.orders = {
94
94
  [constants_1.OrderType.L2F_WIRE_OFFRAMP]: (data) => apiClientFactory_1.apiClientV1.postRequest('/v2/orders/L2F_WIRE_OFFRAMP', { data }),
95
95
  },
96
96
  },
97
+ list: {
98
+ byWallet: (_a) => {
99
+ var { wallet_uuid } = _a, params = __rest(_a, ["wallet_uuid"]);
100
+ return apiClientFactory_1.apiClientV1.getRequest(`/v2/orders/list/${wallet_uuid}`, {
101
+ params,
102
+ });
103
+ },
104
+ },
105
+ getById: ({ order_uuid }) => apiClientFactory_1.apiClientV1.getRequest(`/v2/orders/id/${order_uuid}`),
97
106
  },
98
107
  };
@@ -1451,6 +1451,145 @@ export declare namespace API {
1451
1451
  type Response = OrderInfo[];
1452
1452
  }
1453
1453
  }
1454
+ namespace List {
1455
+ namespace ByWallet {
1456
+ interface Request {
1457
+ wallet_uuid: string;
1458
+ offset?: number;
1459
+ limit?: number;
1460
+ sort_by?: string;
1461
+ sort_order?: 'asc' | 'desc';
1462
+ }
1463
+ interface L2FOriginatorAddress {
1464
+ address_line1?: string | null;
1465
+ city?: string | null;
1466
+ state?: string | null;
1467
+ postal_code?: string | null;
1468
+ country?: string | null;
1469
+ }
1470
+ interface L2FOriginatorProfile {
1471
+ name: string;
1472
+ address?: L2FOriginatorAddress;
1473
+ }
1474
+ interface L2FOriginatorAccountInfo {
1475
+ account_number: string;
1476
+ routing_number?: string | null;
1477
+ swift_bic?: string | null;
1478
+ institution_name?: string | null;
1479
+ }
1480
+ interface L2FOriginator {
1481
+ profile: L2FOriginatorProfile;
1482
+ account_information: L2FOriginatorAccountInfo;
1483
+ reference?: string | null;
1484
+ memo?: string | null;
1485
+ }
1486
+ interface OrderMeta {
1487
+ order_uuid: string;
1488
+ request_id?: string | null;
1489
+ billing_amount: number;
1490
+ billing_currency: string;
1491
+ billing_amount_currency: string;
1492
+ transaction_amount: number;
1493
+ transaction_currency: string;
1494
+ transaction_amount_currency: string;
1495
+ network_fee?: number | null;
1496
+ network_fee_currency?: string | null;
1497
+ exchange_rate: number;
1498
+ fee: number;
1499
+ fee_currency: string;
1500
+ from_currency_id: string;
1501
+ to_currency_id: string;
1502
+ chain_id?: number | null;
1503
+ counterparty_destination_id?: string | null;
1504
+ counterparty_account_id?: string | null;
1505
+ counterparty_account_name?: string | null;
1506
+ counterparty_account_nickname?: string | null;
1507
+ virtual_account_id?: string | null;
1508
+ virtual_account_name?: string | null;
1509
+ to_crypto_address?: string | null;
1510
+ reference?: string | null;
1511
+ note?: string | null;
1512
+ order_id?: string | null;
1513
+ originator?: L2FOriginator | null;
1514
+ sub_account_id?: string | null;
1515
+ to_address?: string | null;
1516
+ sub_account_currency?: string | null;
1517
+ crypto_transaction_hash?: string | null;
1518
+ }
1519
+ interface OrderItem {
1520
+ id: number;
1521
+ order_uuid: string;
1522
+ request_id?: string | null;
1523
+ wallet_uuid: string;
1524
+ from_uuid: string;
1525
+ to_uuid: string;
1526
+ amount_from: number;
1527
+ amount_to: number;
1528
+ order_type: string;
1529
+ status: 'PENDING' | 'PROCESSING' | 'COMPLETE' | 'FAILED' | 'CANCELED';
1530
+ created_at: string;
1531
+ updated_at?: string | null;
1532
+ sub_account_id?: string | null;
1533
+ meta: OrderMeta;
1534
+ info?: string | null;
1535
+ }
1536
+ type Response = OrderItem[];
1537
+ }
1538
+ }
1539
+ namespace GetById {
1540
+ interface Request {
1541
+ order_uuid: string;
1542
+ }
1543
+ type OrderMetaSimplified = Pick<API.Orders.V2.List.ByWallet.OrderMeta, 'order_uuid' | 'request_id' | 'counterparty_destination_id' | 'counterparty_account_id' | 'counterparty_account_name' | 'counterparty_account_nickname' | 'virtual_account_id' | 'virtual_account_name' | 'originator'>;
1544
+ interface CounterpartyAccount {
1545
+ id: string;
1546
+ name: string;
1547
+ type: string;
1548
+ email?: string | null;
1549
+ phone?: string | null;
1550
+ }
1551
+ interface ExternalBankingData {
1552
+ account_number: string;
1553
+ routing_number?: string | null;
1554
+ bank_name: string;
1555
+ swift_bic?: string | null;
1556
+ iban?: string | null;
1557
+ note?: string | null;
1558
+ }
1559
+ interface ExternalCryptoData {
1560
+ address: string;
1561
+ currency_id: string;
1562
+ memo?: string | null;
1563
+ }
1564
+ interface CounterpartyDestination {
1565
+ id: string;
1566
+ type: string;
1567
+ nickname?: string | null;
1568
+ counterparty_account: CounterpartyAccount;
1569
+ external_banking_data?: ExternalBankingData | null;
1570
+ external_crypto_data?: ExternalCryptoData | null;
1571
+ }
1572
+ interface VirtualAccountDetails {
1573
+ id: string;
1574
+ wallet_id: string;
1575
+ status: string;
1576
+ vendor_account_id: string;
1577
+ balance: number;
1578
+ account_currency_details: API.Currencies.Currency;
1579
+ destination_currency_details: API.Currencies.Currency;
1580
+ integration_vendor: API.VirtualAccounts.Programs.IntegrationVendor;
1581
+ account_details: API.VirtualAccounts.VirtualAccount.AccountDetails;
1582
+ }
1583
+ type OrderDetails = Omit<API.Orders.V2.List.ByWallet.OrderItem, 'meta' | 'updated_at' | 'request_id' | 'sub_account_id'> & {
1584
+ meta: OrderMetaSimplified;
1585
+ wallet: API.Wallets.Wallet;
1586
+ from_currency: API.Currencies.Currency;
1587
+ to_currency: API.Currencies.Currency;
1588
+ virtual_account?: VirtualAccountDetails | null;
1589
+ counterparty_destination?: CounterpartyDestination | null;
1590
+ };
1591
+ type Response = OrderDetails;
1592
+ }
1454
1593
  }
1455
1594
  }
1456
1595
  namespace Persona {
@@ -1677,7 +1816,7 @@ export declare namespace API {
1677
1816
  walletAddress: string;
1678
1817
  }
1679
1818
  namespace DepositInstruction {
1680
- type InstructionType = 'ACH' | 'FEDWIRE' | 'SWIFT' | 'SEPA_CT';
1819
+ type InstructionType = 'ACH' | 'FEDWIRE' | 'SWIFT' | 'SEPA_CT' | 'CHAPS' | 'FPS';
1681
1820
  interface Address {
1682
1821
  city: string;
1683
1822
  state: string;
@@ -1698,6 +1837,7 @@ export declare namespace API {
1698
1837
  account_routing_number?: string;
1699
1838
  swift_bic?: string;
1700
1839
  iban?: string;
1840
+ sort_code?: string;
1701
1841
  }
1702
1842
  interface ACH extends Common {
1703
1843
  instruction_type: 'ACH';
@@ -1722,7 +1862,21 @@ export declare namespace API {
1722
1862
  institution_address: Address;
1723
1863
  account_holder_address: Address;
1724
1864
  }
1725
- type DepositInstruction = ACH | FEDWIRE | SWIFT | Common;
1865
+ interface CHAPS extends Common {
1866
+ instruction_type: 'CHAPS';
1867
+ account_holder_name: string;
1868
+ sort_code: string;
1869
+ account_holder_address: Address;
1870
+ institution_address: Address;
1871
+ }
1872
+ interface FPS extends Common {
1873
+ instruction_type: 'FPS';
1874
+ account_holder_name: string;
1875
+ sort_code: string;
1876
+ account_holder_address: Address;
1877
+ institution_address: Address;
1878
+ }
1879
+ type DepositInstruction = ACH | FEDWIRE | SWIFT | SEPA | CHAPS | FPS | Common;
1726
1880
  }
1727
1881
  interface OrderType {
1728
1882
  order_type_id: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "squarefi-bff-api-module",
3
- "version": "1.29.2",
3
+ "version": "1.30.0",
4
4
  "description": "Squarefi BFF API client module",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
package/src/api/orders.ts CHANGED
@@ -238,5 +238,18 @@ export const orders = {
238
238
  ),
239
239
  },
240
240
  },
241
+
242
+ list: {
243
+ byWallet: ({
244
+ wallet_uuid,
245
+ ...params
246
+ }: API.Orders.V2.List.ByWallet.Request): Promise<API.Orders.V2.List.ByWallet.Response> =>
247
+ apiClientV1.getRequest<API.Orders.V2.List.ByWallet.Response>(`/v2/orders/list/${wallet_uuid}`, {
248
+ params,
249
+ }),
250
+ },
251
+
252
+ getById: ({ order_uuid }: API.Orders.V2.GetById.Request): Promise<API.Orders.V2.GetById.Response> =>
253
+ apiClientV1.getRequest<API.Orders.V2.GetById.Response>(`/v2/orders/id/${order_uuid}`),
241
254
  },
242
255
  };
@@ -1905,6 +1905,177 @@ export namespace API {
1905
1905
  export type Response = OrderInfo[];
1906
1906
  }
1907
1907
  }
1908
+
1909
+ export namespace List {
1910
+ export namespace ByWallet {
1911
+ export interface Request {
1912
+ wallet_uuid: string;
1913
+ offset?: number;
1914
+ limit?: number;
1915
+ sort_by?: string;
1916
+ sort_order?: 'asc' | 'desc';
1917
+ }
1918
+
1919
+ export interface L2FOriginatorAddress {
1920
+ address_line1?: string | null;
1921
+ city?: string | null;
1922
+ state?: string | null;
1923
+ postal_code?: string | null;
1924
+ country?: string | null;
1925
+ }
1926
+
1927
+ export interface L2FOriginatorProfile {
1928
+ name: string;
1929
+ address?: L2FOriginatorAddress;
1930
+ }
1931
+
1932
+ export interface L2FOriginatorAccountInfo {
1933
+ account_number: string;
1934
+ routing_number?: string | null;
1935
+ swift_bic?: string | null;
1936
+ institution_name?: string | null;
1937
+ }
1938
+
1939
+ export interface L2FOriginator {
1940
+ profile: L2FOriginatorProfile;
1941
+ account_information: L2FOriginatorAccountInfo;
1942
+ reference?: string | null;
1943
+ memo?: string | null;
1944
+ }
1945
+
1946
+ export interface OrderMeta {
1947
+ order_uuid: string;
1948
+ request_id?: string | null;
1949
+ billing_amount: number;
1950
+ billing_currency: string;
1951
+ billing_amount_currency: string;
1952
+ transaction_amount: number;
1953
+ transaction_currency: string;
1954
+ transaction_amount_currency: string;
1955
+ network_fee?: number | null;
1956
+ network_fee_currency?: string | null;
1957
+ exchange_rate: number;
1958
+ fee: number;
1959
+ fee_currency: string;
1960
+ from_currency_id: string;
1961
+ to_currency_id: string;
1962
+ chain_id?: number | null;
1963
+ counterparty_destination_id?: string | null;
1964
+ counterparty_account_id?: string | null;
1965
+ counterparty_account_name?: string | null;
1966
+ counterparty_account_nickname?: string | null;
1967
+ virtual_account_id?: string | null;
1968
+ virtual_account_name?: string | null;
1969
+ to_crypto_address?: string | null;
1970
+ reference?: string | null;
1971
+ note?: string | null;
1972
+ order_id?: string | null;
1973
+ originator?: L2FOriginator | null;
1974
+ sub_account_id?: string | null;
1975
+ to_address?: string | null;
1976
+ sub_account_currency?: string | null;
1977
+ crypto_transaction_hash?: string | null;
1978
+ }
1979
+
1980
+ export interface OrderItem {
1981
+ id: number;
1982
+ order_uuid: string;
1983
+ request_id?: string | null;
1984
+ wallet_uuid: string;
1985
+ from_uuid: string;
1986
+ to_uuid: string;
1987
+ amount_from: number;
1988
+ amount_to: number;
1989
+ order_type: string;
1990
+ status: 'PENDING' | 'PROCESSING' | 'COMPLETE' | 'FAILED' | 'CANCELED';
1991
+ created_at: string;
1992
+ updated_at?: string | null;
1993
+ sub_account_id?: string | null;
1994
+ meta: OrderMeta;
1995
+ info?: string | null;
1996
+ }
1997
+
1998
+ export type Response = OrderItem[];
1999
+ }
2000
+ }
2001
+
2002
+ export namespace GetById {
2003
+ export interface Request {
2004
+ order_uuid: string;
2005
+ }
2006
+
2007
+ // Упрощенная мета (без финансовых данных, они есть в amount_from/amount_to)
2008
+ export type OrderMetaSimplified = Pick<
2009
+ API.Orders.V2.List.ByWallet.OrderMeta,
2010
+ | 'order_uuid'
2011
+ | 'request_id'
2012
+ | 'counterparty_destination_id'
2013
+ | 'counterparty_account_id'
2014
+ | 'counterparty_account_name'
2015
+ | 'counterparty_account_nickname'
2016
+ | 'virtual_account_id'
2017
+ | 'virtual_account_name'
2018
+ | 'originator'
2019
+ >;
2020
+
2021
+ export interface CounterpartyAccount {
2022
+ id: string;
2023
+ name: string;
2024
+ type: string;
2025
+ email?: string | null;
2026
+ phone?: string | null;
2027
+ }
2028
+
2029
+ export interface ExternalBankingData {
2030
+ account_number: string;
2031
+ routing_number?: string | null;
2032
+ bank_name: string;
2033
+ swift_bic?: string | null;
2034
+ iban?: string | null;
2035
+ note?: string | null;
2036
+ }
2037
+
2038
+ export interface ExternalCryptoData {
2039
+ address: string;
2040
+ currency_id: string;
2041
+ memo?: string | null;
2042
+ }
2043
+
2044
+ export interface CounterpartyDestination {
2045
+ id: string;
2046
+ type: string;
2047
+ nickname?: string | null;
2048
+ counterparty_account: CounterpartyAccount;
2049
+ external_banking_data?: ExternalBankingData | null;
2050
+ external_crypto_data?: ExternalCryptoData | null;
2051
+ }
2052
+
2053
+ export interface VirtualAccountDetails {
2054
+ id: string;
2055
+ wallet_id: string;
2056
+ status: string;
2057
+ vendor_account_id: string;
2058
+ balance: number;
2059
+ account_currency_details: API.Currencies.Currency;
2060
+ destination_currency_details: API.Currencies.Currency;
2061
+ integration_vendor: API.VirtualAccounts.Programs.IntegrationVendor;
2062
+ account_details: API.VirtualAccounts.VirtualAccount.AccountDetails;
2063
+ }
2064
+
2065
+ export type OrderDetails = Omit<
2066
+ API.Orders.V2.List.ByWallet.OrderItem,
2067
+ 'meta' | 'updated_at' | 'request_id' | 'sub_account_id'
2068
+ > & {
2069
+ meta: OrderMetaSimplified;
2070
+ wallet: API.Wallets.Wallet;
2071
+ from_currency: API.Currencies.Currency;
2072
+ to_currency: API.Currencies.Currency;
2073
+ virtual_account?: VirtualAccountDetails | null;
2074
+ counterparty_destination?: CounterpartyDestination | null;
2075
+ };
2076
+
2077
+ export type Response = OrderDetails;
2078
+ }
1908
2079
  }
1909
2080
  }
1910
2081
 
@@ -2163,7 +2334,7 @@ export namespace API {
2163
2334
  }
2164
2335
 
2165
2336
  export namespace DepositInstruction {
2166
- export type InstructionType = 'ACH' | 'FEDWIRE' | 'SWIFT' | 'SEPA_CT';
2337
+ export type InstructionType = 'ACH' | 'FEDWIRE' | 'SWIFT' | 'SEPA_CT' | 'CHAPS' | 'FPS';
2167
2338
 
2168
2339
  export interface Address {
2169
2340
  city: string;
@@ -2186,6 +2357,7 @@ export namespace API {
2186
2357
  account_routing_number?: string;
2187
2358
  swift_bic?: string;
2188
2359
  iban?: string;
2360
+ sort_code?: string;
2189
2361
  }
2190
2362
  export interface ACH extends Common {
2191
2363
  instruction_type: 'ACH';
@@ -2212,7 +2384,23 @@ export namespace API {
2212
2384
  account_holder_address: Address;
2213
2385
  }
2214
2386
 
2215
- export type DepositInstruction = ACH | FEDWIRE | SWIFT | Common;
2387
+ export interface CHAPS extends Common {
2388
+ instruction_type: 'CHAPS';
2389
+ account_holder_name: string;
2390
+ sort_code: string;
2391
+ account_holder_address: Address;
2392
+ institution_address: Address;
2393
+ }
2394
+
2395
+ export interface FPS extends Common {
2396
+ instruction_type: 'FPS';
2397
+ account_holder_name: string;
2398
+ sort_code: string;
2399
+ account_holder_address: Address;
2400
+ institution_address: Address;
2401
+ }
2402
+
2403
+ export type DepositInstruction = ACH | FEDWIRE | SWIFT | SEPA | CHAPS | FPS | Common;
2216
2404
  }
2217
2405
 
2218
2406
  export interface OrderType {