squarefi-bff-api-module 1.34.22 → 1.34.24

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.
@@ -39,6 +39,10 @@ export declare const orders: {
39
39
  L2F_SWIFT_OFFRAMP: (data: API.Orders.V2.Create.ByOrderType.L2F_SWIFT_OFFRAMP.Request) => Promise<API.Orders.V2.Create.ByOrderType.L2F_SWIFT_OFFRAMP.Response>;
40
40
  L2F_ACH_OFFRAMP: (data: API.Orders.V2.Create.ByOrderType.L2F_ACH_OFFRAMP.Request) => Promise<API.Orders.V2.Create.ByOrderType.L2F_ACH_OFFRAMP.Response>;
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
+ L2F_CHAPS_OFFRAMP: (data: API.Orders.V2.Create.ByOrderType.L2F_CHAPS_OFFRAMP.Request) => Promise<API.Orders.V2.Create.ByOrderType.L2F_CHAPS_OFFRAMP.Response>;
43
+ L2F_FPS_OFFRAMP: (data: API.Orders.V2.Create.ByOrderType.L2F_FPS_OFFRAMP.Request) => Promise<API.Orders.V2.Create.ByOrderType.L2F_FPS_OFFRAMP.Response>;
44
+ BRL_WIRE_OFFRAMP: (data: API.Orders.V2.Create.ByOrderType.BRL_WIRE_OFFRAMP.Request) => Promise<API.Orders.V2.Create.ByOrderType.BRL_WIRE_OFFRAMP.Response>;
45
+ BRL_ACH_OFFRAMP: (data: API.Orders.V2.Create.ByOrderType.BRL_ACH_OFFRAMP.Request) => Promise<API.Orders.V2.Create.ByOrderType.BRL_ACH_OFFRAMP.Response>;
42
46
  };
43
47
  };
44
48
  list: {
@@ -72,6 +72,10 @@ export const orders = {
72
72
  [OrderType.L2F_SWIFT_OFFRAMP]: (data) => apiClientV1.postRequest('/v2/orders/L2F_SWIFT_OFFRAMP', { data }),
73
73
  [OrderType.L2F_ACH_OFFRAMP]: (data) => apiClientV1.postRequest('/v2/orders/L2F_ACH_OFFRAMP', { data }),
74
74
  [OrderType.L2F_WIRE_OFFRAMP]: (data) => apiClientV1.postRequest('/v2/orders/L2F_WIRE_OFFRAMP', { data }),
75
+ [OrderType.L2F_CHAPS_OFFRAMP]: (data) => apiClientV1.postRequest('/v2/orders/L2F_CHAPS_OFFRAMP', { data }),
76
+ [OrderType.L2F_FPS_OFFRAMP]: (data) => apiClientV1.postRequest('/v2/orders/L2F_FPS_OFFRAMP', { data }),
77
+ [OrderType.BRL_WIRE_OFFRAMP]: (data) => apiClientV1.postRequest('/v2/orders/BRL_WIRE_OFFRAMP', { data }),
78
+ [OrderType.BRL_ACH_OFFRAMP]: (data) => apiClientV1.postRequest('/v2/orders/BRL_ACH_OFFRAMP', { data }),
75
79
  },
76
80
  },
77
81
  list: {
@@ -2035,6 +2035,8 @@ export interface components {
2035
2035
  id: string;
2036
2036
  code: string | null;
2037
2037
  name: string;
2038
+ /** @description When false, submitting to this rail is disabled. The rail is still returned in lists; only the submit action is blocked. */
2039
+ is_submit_available: boolean;
2038
2040
  wallet_rail: components["schemas"]["WalletKycRailDto"] | null;
2039
2041
  terms_and_conditions: components["schemas"]["WalletKycRailTermsAndConditionsDto"][];
2040
2042
  };
@@ -1320,7 +1320,14 @@ export declare namespace API {
1320
1320
  };
1321
1321
  }
1322
1322
  interface L2FResponse extends BaseOrderResponse {
1323
- order_type: 'L2F_SEPA_OFFRAMP' | 'L2F_SWIFT_OFFRAMP' | 'L2F_ACH_OFFRAMP' | 'L2F_WIRE_OFFRAMP';
1323
+ order_type: 'L2F_SEPA_OFFRAMP' | 'L2F_SWIFT_OFFRAMP' | 'L2F_ACH_OFFRAMP' | 'L2F_WIRE_OFFRAMP' | 'L2F_CHAPS_OFFRAMP' | 'L2F_FPS_OFFRAMP';
1324
+ meta: {
1325
+ request_id: string;
1326
+ virtual_account_id: string;
1327
+ };
1328
+ }
1329
+ interface BraleResponse extends BaseOrderResponse {
1330
+ order_type: 'BRL_WIRE_OFFRAMP' | 'BRL_ACH_OFFRAMP';
1324
1331
  meta: {
1325
1332
  request_id: string;
1326
1333
  virtual_account_id: string;
@@ -1420,6 +1427,34 @@ export declare namespace API {
1420
1427
  order_type: 'L2F_WIRE_OFFRAMP';
1421
1428
  };
1422
1429
  }
1430
+ namespace L2F_CHAPS_OFFRAMP {
1431
+ type Request = Common.Request.OrderWithVirtualAccountParams & Common.Request.OrderWithCounterpartyParams;
1432
+ type Response = Common.Response.L2FResponse & {
1433
+ order_type: 'L2F_CHAPS_OFFRAMP';
1434
+ };
1435
+ }
1436
+ namespace L2F_FPS_OFFRAMP {
1437
+ type Request = Common.Request.OrderWithVirtualAccountParams & Common.Request.OrderWithCounterpartyParams;
1438
+ type Response = Common.Response.L2FResponse & {
1439
+ order_type: 'L2F_FPS_OFFRAMP';
1440
+ };
1441
+ }
1442
+ namespace BRL_WIRE_OFFRAMP {
1443
+ type Request = Common.Request.OrderWithCounterpartyParams & {
1444
+ virtual_account_id?: string;
1445
+ };
1446
+ type Response = Common.Response.BraleResponse & {
1447
+ order_type: 'BRL_WIRE_OFFRAMP';
1448
+ };
1449
+ }
1450
+ namespace BRL_ACH_OFFRAMP {
1451
+ type Request = Common.Request.OrderWithCounterpartyParams & {
1452
+ virtual_account_id?: string;
1453
+ };
1454
+ type Response = Common.Response.BraleResponse & {
1455
+ order_type: 'BRL_ACH_OFFRAMP';
1456
+ };
1457
+ }
1423
1458
  }
1424
1459
  }
1425
1460
  namespace OrderTypes {
@@ -1,5 +1,5 @@
1
1
  import { API } from '.';
2
- import { IsEnumEqualToUnion, EnumUnionMismatch } from './utils/types';
2
+ import { EnumValues, IsEnumEqualToUnion, EnumUnionMismatch, IsUnionSubset, UnionSubsetMismatch } from './utils/types';
3
3
  export type ValueWithLabel = {
4
4
  value: string;
5
5
  label: string;
@@ -120,15 +120,29 @@ export declare enum OrderType {
120
120
  OMNIBUS_INTERNAL_TRANSFER = "OMNIBUS_INTERNAL_TRANSFER",
121
121
  WITHDRAW_CARD_PREPAID = "WITHDRAW_CARD_PREPAID",
122
122
  WITHDRAW_CARD_SUBACCOUNT = "WITHDRAW_CARD_SUBACCOUNT",
123
- AUTO_CONVERT_CRYPTO = "AUTO_CONVERT_CRYPTO"
123
+ AUTO_CONVERT_CRYPTO = "AUTO_CONVERT_CRYPTO",
124
+ L2F_FPS_OFFRAMP = "L2F_FPS_OFFRAMP",
125
+ L2F_FPS_ONRAMP = "L2F_FPS_ONRAMP",
126
+ L2F_CHAPS_OFFRAMP = "L2F_CHAPS_OFFRAMP",
127
+ L2F_CHAPS_ONRAMP = "L2F_CHAPS_ONRAMP",
128
+ BRL_ACH_OFFRAMP = "BRL_ACH_OFFRAMP",
129
+ BRL_ACH_ONRAMP = "BRL_ACH_ONRAMP",
130
+ BRL_WIRE_OFFRAMP = "BRL_WIRE_OFFRAMP",
131
+ BRL_WIRE_ONRAMP = "BRL_WIRE_ONRAMP"
124
132
  }
125
133
  export declare enum WalletTransactionRecordType {
126
134
  CARD_PROVIDER_DEPOSIT = "CARD_PROVIDER_DEPOSIT",
127
135
  CARD_PROVIDER_REFUND = "CARD_PROVIDER_REFUND",
128
136
  CARD_PROVIDER_WITHDRAWAL = "CARD_PROVIDER_WITHDRAWAL",
137
+ CARD_ISSUING_FEE = "CARD_ISSUING_FEE",
129
138
  DEPOSIT = "DEPOSIT",
139
+ DEPOSIT_CRYPTO = "DEPOSIT_CRYPTO",
130
140
  DEPOSIT_CRYPTO_EXTERNAL = "DEPOSIT_CRYPTO_EXTERNAL",
131
141
  DEPOSIT_CRYPTO_INTERNAL = "DEPOSIT_CRYPTO_INTERNAL",
142
+ DEPOSIT_FIAT_SEPA = "DEPOSIT_FIAT_SEPA",
143
+ DEPOSIT_FIAT_SWIFT = "DEPOSIT_FIAT_SWIFT",
144
+ DEPOSIT_ISSUING_SA_CRYPTO_EXT = "DEPOSIT_ISSUING_SA_CRYPTO_EXT",
145
+ DEPOSIT_ISSUING_SA_SEPA_EXT = "DEPOSIT_ISSUING_SA_SEPA_EXT",
132
146
  DEPOSIT_INTERNAL = "DEPOSIT_INTERNAL",
133
147
  DEPOSIT_MANUAL = "DEPOSIT_MANUAL",
134
148
  EXCHANGE_CRYPTO_INTERNAL = "EXCHANGE_CRYPTO_INTERNAL",
@@ -174,6 +188,7 @@ export declare enum WalletTransactionRecordType {
174
188
  L2F_SEPA_WITHDRAWAL = "L2F_SEPA_WITHDRAWAL",
175
189
  L2F_CRYPTO_WITHDRAWAL = "L2F_CRYPTO_WITHDRAWAL",
176
190
  L2F_CRYPTO_DEPOSIT = "L2F_CRYPTO_DEPOSIT",
191
+ OMNIBUS_CRYPTO_WITHDRAWAL = "OMNIBUS_CRYPTO_WITHDRAWAL",
177
192
  HIFI_WIRE_ONRAMP = "HIFI_WIRE_ONRAMP",
178
193
  HIFI_WIRE_OFFRAMP = "HIFI_WIRE_OFFRAMP",
179
194
  HIFI_WIRE_DEPOSIT = "HIFI_WIRE_DEPOSIT",
@@ -189,8 +204,22 @@ export declare enum WalletTransactionRecordType {
189
204
  HIFI_CRYPTO_TRANSFER = "HIFI_CRYPTO_TRANSFER",
190
205
  HIFI_CRYPTO_WITHDRAWAL = "HIFI_CRYPTO_WITHDRAWAL",
191
206
  HIFI_CRYPTO_DEPOSIT = "HIFI_CRYPTO_DEPOSIT",
192
- AUTO_CONVERT_CRYPTO = "AUTO_CONVERT_CRYPTO"
207
+ TBD_SWIFT_WITHDRAWAL = "TBD_SWIFT_WITHDRAWAL",
208
+ AUTO_CONVERT_CRYPTO = "AUTO_CONVERT_CRYPTO",
209
+ WITHDRAWAL_CRYPTO = "WITHDRAWAL_CRYPTO",
210
+ WITHDRAWAL_FIAT_SEPA = "WITHDRAWAL_FIAT_SEPA",
211
+ L2F_FPS_OFFRAMP = "L2F_FPS_OFFRAMP",
212
+ L2F_FPS_ONRAMP = "L2F_FPS_ONRAMP",
213
+ L2F_CHAPS_OFFRAMP = "L2F_CHAPS_OFFRAMP",
214
+ L2F_CHAPS_ONRAMP = "L2F_CHAPS_ONRAMP",
215
+ BRL_ACH_OFFRAMP = "BRL_ACH_OFFRAMP",
216
+ BRL_ACH_ONRAMP = "BRL_ACH_ONRAMP",
217
+ BRL_WIRE_OFFRAMP = "BRL_WIRE_OFFRAMP",
218
+ BRL_WIRE_ONRAMP = "BRL_WIRE_ONRAMP"
193
219
  }
220
+ export type OrderTypeMissingInWalletTransactionRecordType = Exclude<EnumValues<OrderType>, EnumValues<WalletTransactionRecordType>>;
221
+ export declare const orderTypeIncludedInWalletTransactionRecordTypeCheck: IsUnionSubset<EnumValues<OrderType>, EnumValues<WalletTransactionRecordType>>;
222
+ export type OrderTypeIncludedInWalletTransactionRecordTypeMismatch = UnionSubsetMismatch<EnumValues<OrderType>, EnumValues<WalletTransactionRecordType>>;
194
223
  export declare enum RequestStatus {
195
224
  NONE = "none",
196
225
  PENDING = "pending",
package/dist/constants.js CHANGED
@@ -122,15 +122,30 @@ export var OrderType;
122
122
  OrderType["WITHDRAW_CARD_PREPAID"] = "WITHDRAW_CARD_PREPAID";
123
123
  OrderType["WITHDRAW_CARD_SUBACCOUNT"] = "WITHDRAW_CARD_SUBACCOUNT";
124
124
  OrderType["AUTO_CONVERT_CRYPTO"] = "AUTO_CONVERT_CRYPTO";
125
+ OrderType["L2F_FPS_OFFRAMP"] = "L2F_FPS_OFFRAMP";
126
+ OrderType["L2F_FPS_ONRAMP"] = "L2F_FPS_ONRAMP";
127
+ OrderType["L2F_CHAPS_OFFRAMP"] = "L2F_CHAPS_OFFRAMP";
128
+ OrderType["L2F_CHAPS_ONRAMP"] = "L2F_CHAPS_ONRAMP";
129
+ OrderType["BRL_ACH_OFFRAMP"] = "BRL_ACH_OFFRAMP";
130
+ OrderType["BRL_ACH_ONRAMP"] = "BRL_ACH_ONRAMP";
131
+ OrderType["BRL_WIRE_OFFRAMP"] = "BRL_WIRE_OFFRAMP";
132
+ OrderType["BRL_WIRE_ONRAMP"] = "BRL_WIRE_ONRAMP";
133
+ // when extend do not forget to add new order type to the enum WalletTransactionRecordType
125
134
  })(OrderType || (OrderType = {}));
126
135
  export var WalletTransactionRecordType;
127
136
  (function (WalletTransactionRecordType) {
128
137
  WalletTransactionRecordType["CARD_PROVIDER_DEPOSIT"] = "CARD_PROVIDER_DEPOSIT";
129
138
  WalletTransactionRecordType["CARD_PROVIDER_REFUND"] = "CARD_PROVIDER_REFUND";
130
139
  WalletTransactionRecordType["CARD_PROVIDER_WITHDRAWAL"] = "CARD_PROVIDER_WITHDRAWAL";
140
+ WalletTransactionRecordType["CARD_ISSUING_FEE"] = "CARD_ISSUING_FEE";
131
141
  WalletTransactionRecordType["DEPOSIT"] = "DEPOSIT";
142
+ WalletTransactionRecordType["DEPOSIT_CRYPTO"] = "DEPOSIT_CRYPTO";
132
143
  WalletTransactionRecordType["DEPOSIT_CRYPTO_EXTERNAL"] = "DEPOSIT_CRYPTO_EXTERNAL";
133
144
  WalletTransactionRecordType["DEPOSIT_CRYPTO_INTERNAL"] = "DEPOSIT_CRYPTO_INTERNAL";
145
+ WalletTransactionRecordType["DEPOSIT_FIAT_SEPA"] = "DEPOSIT_FIAT_SEPA";
146
+ WalletTransactionRecordType["DEPOSIT_FIAT_SWIFT"] = "DEPOSIT_FIAT_SWIFT";
147
+ WalletTransactionRecordType["DEPOSIT_ISSUING_SA_CRYPTO_EXT"] = "DEPOSIT_ISSUING_SA_CRYPTO_EXT";
148
+ WalletTransactionRecordType["DEPOSIT_ISSUING_SA_SEPA_EXT"] = "DEPOSIT_ISSUING_SA_SEPA_EXT";
134
149
  WalletTransactionRecordType["DEPOSIT_INTERNAL"] = "DEPOSIT_INTERNAL";
135
150
  WalletTransactionRecordType["DEPOSIT_MANUAL"] = "DEPOSIT_MANUAL";
136
151
  WalletTransactionRecordType["EXCHANGE_CRYPTO_INTERNAL"] = "EXCHANGE_CRYPTO_INTERNAL";
@@ -176,6 +191,7 @@ export var WalletTransactionRecordType;
176
191
  WalletTransactionRecordType["L2F_SEPA_WITHDRAWAL"] = "L2F_SEPA_WITHDRAWAL";
177
192
  WalletTransactionRecordType["L2F_CRYPTO_WITHDRAWAL"] = "L2F_CRYPTO_WITHDRAWAL";
178
193
  WalletTransactionRecordType["L2F_CRYPTO_DEPOSIT"] = "L2F_CRYPTO_DEPOSIT";
194
+ WalletTransactionRecordType["OMNIBUS_CRYPTO_WITHDRAWAL"] = "OMNIBUS_CRYPTO_WITHDRAWAL";
179
195
  WalletTransactionRecordType["HIFI_WIRE_ONRAMP"] = "HIFI_WIRE_ONRAMP";
180
196
  WalletTransactionRecordType["HIFI_WIRE_OFFRAMP"] = "HIFI_WIRE_OFFRAMP";
181
197
  WalletTransactionRecordType["HIFI_WIRE_DEPOSIT"] = "HIFI_WIRE_DEPOSIT";
@@ -191,8 +207,20 @@ export var WalletTransactionRecordType;
191
207
  WalletTransactionRecordType["HIFI_CRYPTO_TRANSFER"] = "HIFI_CRYPTO_TRANSFER";
192
208
  WalletTransactionRecordType["HIFI_CRYPTO_WITHDRAWAL"] = "HIFI_CRYPTO_WITHDRAWAL";
193
209
  WalletTransactionRecordType["HIFI_CRYPTO_DEPOSIT"] = "HIFI_CRYPTO_DEPOSIT";
210
+ WalletTransactionRecordType["TBD_SWIFT_WITHDRAWAL"] = "TBD_SWIFT_WITHDRAWAL";
194
211
  WalletTransactionRecordType["AUTO_CONVERT_CRYPTO"] = "AUTO_CONVERT_CRYPTO";
212
+ WalletTransactionRecordType["WITHDRAWAL_CRYPTO"] = "WITHDRAWAL_CRYPTO";
213
+ WalletTransactionRecordType["WITHDRAWAL_FIAT_SEPA"] = "WITHDRAWAL_FIAT_SEPA";
214
+ WalletTransactionRecordType["L2F_FPS_OFFRAMP"] = "L2F_FPS_OFFRAMP";
215
+ WalletTransactionRecordType["L2F_FPS_ONRAMP"] = "L2F_FPS_ONRAMP";
216
+ WalletTransactionRecordType["L2F_CHAPS_OFFRAMP"] = "L2F_CHAPS_OFFRAMP";
217
+ WalletTransactionRecordType["L2F_CHAPS_ONRAMP"] = "L2F_CHAPS_ONRAMP";
218
+ WalletTransactionRecordType["BRL_ACH_OFFRAMP"] = "BRL_ACH_OFFRAMP";
219
+ WalletTransactionRecordType["BRL_ACH_ONRAMP"] = "BRL_ACH_ONRAMP";
220
+ WalletTransactionRecordType["BRL_WIRE_OFFRAMP"] = "BRL_WIRE_OFFRAMP";
221
+ WalletTransactionRecordType["BRL_WIRE_ONRAMP"] = "BRL_WIRE_ONRAMP";
195
222
  })(WalletTransactionRecordType || (WalletTransactionRecordType = {}));
223
+ export const orderTypeIncludedInWalletTransactionRecordTypeCheck = true;
196
224
  export var RequestStatus;
197
225
  (function (RequestStatus) {
198
226
  RequestStatus["NONE"] = "none";
@@ -7,3 +7,8 @@ export type EnumUnionMismatch<E, U> = {
7
7
  hasMismatch: [EnumValuesMissingInUnion<E, U>, UnionValuesMissingInEnum<E, U>] extends [never, never] ? false : true;
8
8
  };
9
9
  export type IsEnumEqualToUnion<E, U> = [EnumValues<E>] extends [U] ? [U] extends [EnumValues<E>] ? true : false : false;
10
+ export type IsUnionSubset<SubsetUnion, SupersetUnion> = Exclude<SubsetUnion, SupersetUnion> extends never ? true : false;
11
+ export type UnionSubsetMismatch<SubsetUnion, SupersetUnion> = {
12
+ subsetMissingInSuperset: Exclude<SubsetUnion, SupersetUnion>;
13
+ hasMismatch: Exclude<SubsetUnion, SupersetUnion> extends never ? false : true;
14
+ };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "squarefi-bff-api-module",
3
- "version": "1.34.22",
3
+ "version": "1.34.24",
4
4
  "description": "Squarefi BFF API client module",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",