squarefi-bff-api-module 1.22.7 → 1.22.9

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.
Files changed (11) hide show
  1. package/dist/api/orders.d.ts +1 -0
  2. package/dist/api/orders.js +3 -6
  3. package/dist/api/types/autogen/apiV2.types.d.ts +4 -8
  4. package/dist/api/types/types.d.ts +40 -18
  5. package/dist/constants.d.ts +2 -1
  6. package/dist/constants.js +1 -0
  7. package/package.json +1 -1
  8. package/src/api/orders.ts +9 -6
  9. package/src/api/types/autogen/apiV2.types.ts +4 -8
  10. package/src/api/types/types.ts +45 -18
  11. package/src/constants.ts +1 -0
package/dist/api/orders.d.ts CHANGED
@@ -37,6 +37,7 @@ export declare const orders: {
37
37
  HIFI_SEPA_OFFRAMP: (data: API.Orders.V2.Create.ByOrderType.HIFI_SEPA_OFFRAMP.Request) => Promise<API.Orders.V2.Create.ByOrderType.HIFI_SEPA_OFFRAMP.Response>;
38
38
  OMNIBUS_CRYPTO_TRANSFER: (data: API.Orders.V2.Create.ByOrderType.OMNIBUS_CRYPTO_TRANSFER.Request) => Promise<API.Orders.V2.Create.ByOrderType.OMNIBUS_CRYPTO_TRANSFER.Response>;
39
39
  HIFI_CRYPTO_TRANSFER: (data: API.Orders.V2.Create.ByOrderType.HIFI_CRYPTO_TRANSFER.Request) => Promise<API.Orders.V2.Create.ByOrderType.HIFI_CRYPTO_TRANSFER.Response>;
40
+ SEGREGATED_CRYPTO_TRANSFER: (data: API.Orders.V2.Create.ByOrderType.SEGREGATED_CRYPTO_TRANSFER.Request) => Promise<API.Orders.V2.Create.ByOrderType.SEGREGATED_CRYPTO_TRANSFER.Response>;
40
41
  TBD_SWIFT_WITHDRAWAL: (data: API.Orders.V2.Create.ByOrderType.TBD_SWIFT_WITHDRAWAL.Request) => Promise<API.Orders.V2.Create.ByOrderType.TBD_SWIFT_WITHDRAWAL.Response>;
41
42
  };
42
43
  };
package/dist/api/orders.js CHANGED
@@ -91,13 +91,10 @@ exports.orders = {
91
91
  [constants_1.OrderType.HIFI_ACH_OFFRAMP]: (data) => apiClientFactory_1.apiClientV1.postRequest('/v2/orders/HIFI_ACH_OFFRAMP', {
92
92
  data,
93
93
  }),
94
- [constants_1.OrderType.HIFI_SEPA_OFFRAMP]: (data) => apiClientFactory_1.apiClientV1.postRequest('/v2/orders/HIFI_SEPA_OFFRAMP', {
95
- data,
96
- }),
97
- [constants_1.OrderType.OMNIBUS_CRYPTO_TRANSFER]: (data) => apiClientFactory_1.apiClientV1.postRequest('/v2/orders/OMNIBUS_CRYPTO_TRANSFER', {
98
- data,
99
- }),
94
+ [constants_1.OrderType.HIFI_SEPA_OFFRAMP]: (data) => apiClientFactory_1.apiClientV1.postRequest('/v2/orders/HIFI_SEPA_OFFRAMP', { data }),
95
+ [constants_1.OrderType.OMNIBUS_CRYPTO_TRANSFER]: (data) => apiClientFactory_1.apiClientV1.postRequest('/v2/orders/OMNIBUS_CRYPTO_TRANSFER', { data }),
100
96
  [constants_1.OrderType.HIFI_CRYPTO_TRANSFER]: (data) => apiClientFactory_1.apiClientV1.postRequest('/v2/orders/HIFI_CRYPTO_TRANSFER', { data }),
97
+ [constants_1.OrderType.SEGREGATED_CRYPTO_TRANSFER]: (data) => apiClientFactory_1.apiClientV1.postRequest('/v2/orders/SEGREGATED_CRYPTO_TRANSFER', { data }),
101
98
  [constants_1.OrderType.TBD_SWIFT_WITHDRAWAL]: (
102
99
  // TODO: ITS MOCK ORDER TYPE
103
100
  data) => apiClientFactory_1.apiClientV1.postRequest('/v2/orders/TBD_SWIFT_WITHDRAWAL', { data }),
package/dist/api/types/autogen/apiV2.types.d.ts CHANGED
@@ -1181,11 +1181,9 @@ export interface components {
1181
1181
  id: number;
1182
1182
  amount: number;
1183
1183
  created_at: string;
1184
- from: string | null;
1185
1184
  info: string | null;
1186
1185
  /** @enum {string} */
1187
1186
  status: "complete" | "pending" | "canceled" | "failed" | "processing" | "new";
1188
- to: string | null;
1189
1187
  txid: string | null;
1190
1188
  /** @enum {string} */
1191
1189
  type: "deposit_crypto" | "withdrawal_crypto" | "deposit_fiat" | "withdrawal_fiat" | "deposit_vcard" | "withdrawal_vcard" | "deposit" | "withdrawal";
@@ -1199,10 +1197,8 @@ export interface components {
1199
1197
  };
1200
1198
  TransactionsFilter: {
1201
1199
  created_at?: string;
1202
- from?: string | null;
1203
1200
  /** @enum {string} */
1204
1201
  status?: "complete" | "pending" | "canceled" | "failed" | "processing" | "new";
1205
- to?: string | null;
1206
1202
  /** @enum {string} */
1207
1203
  type?: "deposit_crypto" | "withdrawal_crypto" | "deposit_fiat" | "withdrawal_fiat" | "deposit_vcard" | "withdrawal_vcard" | "deposit" | "withdrawal";
1208
1204
  /** @enum {string|null} */
@@ -1241,7 +1237,7 @@ export interface components {
1241
1237
  code: string | null;
1242
1238
  name: string;
1243
1239
  /** @enum {string|null} */
1244
- type: "individual" | "business" | null;
1240
+ type: "individual" | "business" | "universal" | null;
1245
1241
  /** @description Current terms and conditions data */
1246
1242
  terms_and_conditions?: components["schemas"]["KycRailTermsAndConditionsEntity"][];
1247
1243
  };
@@ -1594,7 +1590,7 @@ export interface components {
1594
1590
  };
1595
1591
  KycEntityDto: {
1596
1592
  /** @enum {string} */
1597
- type: "individual" | "business";
1593
+ type: "individual" | "business" | "universal";
1598
1594
  id_number?: string | null;
1599
1595
  /** @enum {string|null} */
1600
1596
  id_type?: "PASSPORT" | "ID_CARD" | "DRIVERS" | "NIN" | null;
@@ -1685,7 +1681,7 @@ export interface components {
1685
1681
  };
1686
1682
  CreateOrUpdateKycEntityDto: {
1687
1683
  /** @enum {string} */
1688
- type: "individual" | "business";
1684
+ type: "individual" | "business" | "universal";
1689
1685
  id_number?: string | null;
1690
1686
  /** @enum {string|null} */
1691
1687
  id_type?: "PASSPORT" | "ID_CARD" | "DRIVERS" | "NIN" | null;
@@ -4292,7 +4288,7 @@ export interface operations {
4292
4288
  header?: never;
4293
4289
  path: {
4294
4290
  wallet_id: string;
4295
- type: "individual" | "business";
4291
+ type: "individual" | "business" | "universal";
4296
4292
  };
4297
4293
  cookie?: never;
4298
4294
  };
package/dist/api/types/types.d.ts CHANGED
@@ -1723,6 +1723,42 @@ export declare namespace API {
1723
1723
  id: string;
1724
1724
  }
1725
1725
  }
1726
+ namespace SEGREGATED_CRYPTO_TRANSFER {
1727
+ interface Request {
1728
+ request_id: string;
1729
+ counterparty_account_id: string;
1730
+ amount: number;
1731
+ wallet_id: string;
1732
+ wallet_account_id: string;
1733
+ from_currency_id: string;
1734
+ }
1735
+ interface Response {
1736
+ created_at: string;
1737
+ order_uuid: string;
1738
+ wallet_uuid: string;
1739
+ from_uuid: string;
1740
+ to_uuid: string;
1741
+ amount_from: number;
1742
+ order_type: 'OMNIBUS_CRYPTO_WITHDRAWAL';
1743
+ status: OrderStatuses;
1744
+ amount_to: number;
1745
+ info: string;
1746
+ meta: {
1747
+ fee: number;
1748
+ order_uuid: string;
1749
+ to_address: string;
1750
+ fee_currency: string;
1751
+ request_id: string;
1752
+ counterparty_account_id: string;
1753
+ billing_amount: number;
1754
+ billing_currency: string;
1755
+ transaction_amount: number;
1756
+ transaction_currency: string;
1757
+ network_fee: number;
1758
+ };
1759
+ id: string;
1760
+ }
1761
+ }
1726
1762
  namespace HIFI_CRYPTO_TRANSFER {
1727
1763
  interface Request {
1728
1764
  request_id: string;
@@ -2077,32 +2113,18 @@ export declare namespace API {
2077
2113
  namespace UpdateUser {
2078
2114
  namespace Phone {
2079
2115
  namespace RequestOTP {
2080
- type Request = {
2081
- phone: string;
2082
- access_token: string;
2083
- refresh_token: string;
2084
- };
2116
+ type Request = operations['AuthenticatedUserController_changePhone']['requestBody']['content']['application/json'];
2085
2117
  }
2086
2118
  namespace Confirm {
2087
- type Request = {
2088
- phone: string;
2089
- token: string;
2090
- };
2119
+ type Request = operations['AuthenticatedUserController_changePhoneNumberConfirm']['requestBody']['content']['application/json'];
2091
2120
  }
2092
2121
  }
2093
2122
  namespace Email {
2094
2123
  namespace RequestOTP {
2095
- type Request = {
2096
- email: string;
2097
- access_token: string;
2098
- refresh_token: string;
2099
- };
2124
+ type Request = operations['AuthenticatedUserController_changeEmail']['requestBody']['content']['application/json'];
2100
2125
  }
2101
2126
  namespace Confirm {
2102
- type Request = {
2103
- email: string;
2104
- token: string;
2105
- };
2127
+ type Request = operations['AuthenticatedUserController_changeEmail']['requestBody']['content']['application/json'];
2106
2128
  }
2107
2129
  }
2108
2130
  }
package/dist/constants.d.ts CHANGED
@@ -186,7 +186,8 @@ export declare enum OrderType {
186
186
  HIFI_SEPA_OFFRAMP = "HIFI_SEPA_OFFRAMP",
187
187
  HIFI_CRYPTO_TRANSFER = "HIFI_CRYPTO_TRANSFER",
188
188
  OMNIBUS_CRYPTO_TRANSFER = "OMNIBUS_CRYPTO_TRANSFER",
189
- TBD_SWIFT_WITHDRAWAL = "TBD_SWIFT_WITHDRAWAL"
189
+ TBD_SWIFT_WITHDRAWAL = "TBD_SWIFT_WITHDRAWAL",// not implemented yet
190
+ SEGREGATED_CRYPTO_TRANSFER = "SEGREGATED_CRYPTO_TRANSFER"
190
191
  }
191
192
  export declare enum APIKeyRole {
192
193
  READ_ONLY = "READ_ONLY",
package/dist/constants.js CHANGED
@@ -212,6 +212,7 @@ var OrderType;
212
212
  OrderType["HIFI_CRYPTO_TRANSFER"] = "HIFI_CRYPTO_TRANSFER";
213
213
  OrderType["OMNIBUS_CRYPTO_TRANSFER"] = "OMNIBUS_CRYPTO_TRANSFER";
214
214
  OrderType["TBD_SWIFT_WITHDRAWAL"] = "TBD_SWIFT_WITHDRAWAL";
215
+ OrderType["SEGREGATED_CRYPTO_TRANSFER"] = "SEGREGATED_CRYPTO_TRANSFER";
215
216
  })(OrderType || (exports.OrderType = OrderType = {}));
216
217
  var APIKeyRole;
217
218
  (function (APIKeyRole) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "squarefi-bff-api-module",
3
- "version": "1.22.7",
3
+ "version": "1.22.9",
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
@@ -191,9 +191,7 @@ export const orders = {
191
191
  ): Promise<API.Orders.V2.Create.ByOrderType.HIFI_SEPA_OFFRAMP.Response> =>
192
192
  apiClientV1.postRequest<API.Orders.V2.Create.ByOrderType.HIFI_SEPA_OFFRAMP.Response>(
193
193
  '/v2/orders/HIFI_SEPA_OFFRAMP',
194
- {
195
- data,
196
- }
194
+ { data }
197
195
  ),
198
196
 
199
197
  [OrderType.OMNIBUS_CRYPTO_TRANSFER]: (
@@ -201,9 +199,7 @@ export const orders = {
201
199
  ): Promise<API.Orders.V2.Create.ByOrderType.OMNIBUS_CRYPTO_TRANSFER.Response> =>
202
200
  apiClientV1.postRequest<API.Orders.V2.Create.ByOrderType.OMNIBUS_CRYPTO_TRANSFER.Response>(
203
201
  '/v2/orders/OMNIBUS_CRYPTO_TRANSFER',
204
- {
205
- data,
206
- }
202
+ { data }
207
203
  ),
208
204
 
209
205
  [OrderType.HIFI_CRYPTO_TRANSFER]: (
@@ -213,6 +209,13 @@ export const orders = {
213
209
  '/v2/orders/HIFI_CRYPTO_TRANSFER',
214
210
  { data }
215
211
  ),
212
+ [OrderType.SEGREGATED_CRYPTO_TRANSFER]: (
213
+ data: API.Orders.V2.Create.ByOrderType.SEGREGATED_CRYPTO_TRANSFER.Request
214
+ ): Promise<API.Orders.V2.Create.ByOrderType.SEGREGATED_CRYPTO_TRANSFER.Response> =>
215
+ apiClientV1.postRequest<API.Orders.V2.Create.ByOrderType.SEGREGATED_CRYPTO_TRANSFER.Response>(
216
+ '/v2/orders/SEGREGATED_CRYPTO_TRANSFER',
217
+ { data }
218
+ ),
216
219
 
217
220
  [OrderType.TBD_SWIFT_WITHDRAWAL]: (
218
221
  // TODO: ITS MOCK ORDER TYPE
package/src/api/types/autogen/apiV2.types.ts CHANGED
@@ -1182,11 +1182,9 @@ export interface components {
1182
1182
  id: number;
1183
1183
  amount: number;
1184
1184
  created_at: string;
1185
- from: string | null;
1186
1185
  info: string | null;
1187
1186
  /** @enum {string} */
1188
1187
  status: "complete" | "pending" | "canceled" | "failed" | "processing" | "new";
1189
- to: string | null;
1190
1188
  txid: string | null;
1191
1189
  /** @enum {string} */
1192
1190
  type: "deposit_crypto" | "withdrawal_crypto" | "deposit_fiat" | "withdrawal_fiat" | "deposit_vcard" | "withdrawal_vcard" | "deposit" | "withdrawal";
@@ -1200,10 +1198,8 @@ export interface components {
1200
1198
  };
1201
1199
  TransactionsFilter: {
1202
1200
  created_at?: string;
1203
- from?: string | null;
1204
1201
  /** @enum {string} */
1205
1202
  status?: "complete" | "pending" | "canceled" | "failed" | "processing" | "new";
1206
- to?: string | null;
1207
1203
  /** @enum {string} */
1208
1204
  type?: "deposit_crypto" | "withdrawal_crypto" | "deposit_fiat" | "withdrawal_fiat" | "deposit_vcard" | "withdrawal_vcard" | "deposit" | "withdrawal";
1209
1205
  /** @enum {string|null} */
@@ -1242,7 +1238,7 @@ export interface components {
1242
1238
  code: string | null;
1243
1239
  name: string;
1244
1240
  /** @enum {string|null} */
1245
- type: "individual" | "business" | null;
1241
+ type: "individual" | "business" | "universal" | null;
1246
1242
  /** @description Current terms and conditions data */
1247
1243
  terms_and_conditions?: components["schemas"]["KycRailTermsAndConditionsEntity"][];
1248
1244
  };
@@ -1595,7 +1591,7 @@ export interface components {
1595
1591
  };
1596
1592
  KycEntityDto: {
1597
1593
  /** @enum {string} */
1598
- type: "individual" | "business";
1594
+ type: "individual" | "business" | "universal";
1599
1595
  id_number?: string | null;
1600
1596
  /** @enum {string|null} */
1601
1597
  id_type?: "PASSPORT" | "ID_CARD" | "DRIVERS" | "NIN" | null;
@@ -1686,7 +1682,7 @@ export interface components {
1686
1682
  };
1687
1683
  CreateOrUpdateKycEntityDto: {
1688
1684
  /** @enum {string} */
1689
- type: "individual" | "business";
1685
+ type: "individual" | "business" | "universal";
1690
1686
  id_number?: string | null;
1691
1687
  /** @enum {string|null} */
1692
1688
  id_type?: "PASSPORT" | "ID_CARD" | "DRIVERS" | "NIN" | null;
@@ -4293,7 +4289,7 @@ export interface operations {
4293
4289
  header?: never;
4294
4290
  path: {
4295
4291
  wallet_id: string;
4296
- type: "individual" | "business";
4292
+ type: "individual" | "business" | "universal";
4297
4293
  };
4298
4294
  cookie?: never;
4299
4295
  };
package/src/api/types/types.ts CHANGED
@@ -2041,6 +2041,43 @@ export namespace API {
2041
2041
  id: string;
2042
2042
  }
2043
2043
  }
2044
+ export namespace SEGREGATED_CRYPTO_TRANSFER {
2045
+ export interface Request {
2046
+ request_id: string;
2047
+ counterparty_account_id: string;
2048
+ amount: number;
2049
+ wallet_id: string;
2050
+ wallet_account_id: string;
2051
+ from_currency_id: string;
2052
+ }
2053
+
2054
+ export interface Response {
2055
+ created_at: string;
2056
+ order_uuid: string;
2057
+ wallet_uuid: string;
2058
+ from_uuid: string;
2059
+ to_uuid: string;
2060
+ amount_from: number;
2061
+ order_type: 'OMNIBUS_CRYPTO_WITHDRAWAL';
2062
+ status: OrderStatuses;
2063
+ amount_to: number;
2064
+ info: string;
2065
+ meta: {
2066
+ fee: number;
2067
+ order_uuid: string;
2068
+ to_address: string;
2069
+ fee_currency: string;
2070
+ request_id: string;
2071
+ counterparty_account_id: string;
2072
+ billing_amount: number;
2073
+ billing_currency: string;
2074
+ transaction_amount: number;
2075
+ transaction_currency: string;
2076
+ network_fee: number;
2077
+ };
2078
+ id: string;
2079
+ }
2080
+ }
2044
2081
  export namespace HIFI_CRYPTO_TRANSFER {
2045
2082
  export interface Request {
2046
2083
  request_id: string;
@@ -2439,34 +2476,24 @@ export namespace API {
2439
2476
  export namespace UpdateUser {
2440
2477
  export namespace Phone {
2441
2478
  export namespace RequestOTP {
2442
- export type Request = {
2443
- phone: string;
2444
- access_token: string;
2445
- refresh_token: string;
2446
- };
2479
+ export type Request =
2480
+ operations['AuthenticatedUserController_changePhone']['requestBody']['content']['application/json'];
2447
2481
  }
2448
2482
  export namespace Confirm {
2449
- export type Request = {
2450
- phone: string;
2451
- token: string;
2452
- };
2483
+ export type Request =
2484
+ operations['AuthenticatedUserController_changePhoneNumberConfirm']['requestBody']['content']['application/json'];
2453
2485
  }
2454
2486
  }
2455
2487
 
2456
2488
  export namespace Email {
2457
2489
  export namespace RequestOTP {
2458
- export type Request = {
2459
- email: string;
2460
- access_token: string;
2461
- refresh_token: string;
2462
- };
2490
+ export type Request =
2491
+ operations['AuthenticatedUserController_changeEmail']['requestBody']['content']['application/json'];
2463
2492
  }
2464
2493
 
2465
2494
  export namespace Confirm {
2466
- export type Request = {
2467
- email: string;
2468
- token: string;
2469
- };
2495
+ export type Request =
2496
+ operations['AuthenticatedUserController_changeEmail']['requestBody']['content']['application/json'];
2470
2497
  }
2471
2498
  }
2472
2499
  }
package/src/constants.ts CHANGED
@@ -220,6 +220,7 @@ export enum OrderType {
220
220
  HIFI_CRYPTO_TRANSFER = 'HIFI_CRYPTO_TRANSFER',
221
221
  OMNIBUS_CRYPTO_TRANSFER = 'OMNIBUS_CRYPTO_TRANSFER',
222
222
  TBD_SWIFT_WITHDRAWAL = 'TBD_SWIFT_WITHDRAWAL', // not implemented yet
223
+ SEGREGATED_CRYPTO_TRANSFER = 'SEGREGATED_CRYPTO_TRANSFER',
223
224
  }
224
225
 
225
226
  export enum APIKeyRole {