squarefi-bff-api-module 1.18.6 → 1.18.8

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.
package/CHANGELOG.md CHANGED
@@ -5,6 +5,22 @@ All notable changes to this project will be documented in this file.
5
5
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
6
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
 
8
+ ## [1.18.8] - 2025-05-24
9
+
10
+ ### Added
11
+
12
+ - Restructured orderTypes to include a list method and defined OrderTypes namespace with detailed OrderInfo type
13
+
14
+ ### Fixed
15
+
16
+ - Updated Response type to reflect VirtualAccount structure
17
+
18
+ ## [1.18.7] - 2025-05-24
19
+
20
+ ### Added
21
+
22
+ - Integrated virtual accounts into API structure for enhanced functionality
23
+
8
24
  ## [1.18.6] - 2025-05-24
9
25
 
10
26
  ### Added
@@ -9,6 +9,7 @@ import { orders } from './orders';
9
9
  import { persona } from './persona';
10
10
  import { tenants } from './tenants';
11
11
  import { user } from './user';
12
+ import { virtualAccounts } from './virtual-accounts';
12
13
  import { wallets } from './wallets';
13
14
  type Api = {
14
15
  auth: typeof auth;
@@ -22,6 +23,7 @@ type Api = {
22
23
  persona: typeof persona;
23
24
  tenants: typeof tenants;
24
25
  user: typeof user;
26
+ virtualAccounts: typeof virtualAccounts;
25
27
  wallets: typeof wallets;
26
28
  };
27
29
  export declare const squarefi_bff_api_client: Api;
package/dist/api/index.js CHANGED
@@ -12,6 +12,7 @@ const orders_1 = require("./orders");
12
12
  const persona_1 = require("./persona");
13
13
  const tenants_1 = require("./tenants");
14
14
  const user_1 = require("./user");
15
+ const virtual_accounts_1 = require("./virtual-accounts");
15
16
  const wallets_1 = require("./wallets");
16
17
  exports.squarefi_bff_api_client = {
17
18
  auth: auth_1.auth,
@@ -25,5 +26,6 @@ exports.squarefi_bff_api_client = {
25
26
  persona: persona_1.persona,
26
27
  tenants: tenants_1.tenants,
27
28
  user: user_1.user,
29
+ virtualAccounts: virtual_accounts_1.virtualAccounts,
28
30
  wallets: wallets_1.wallets,
29
31
  };
@@ -1,8 +1,9 @@
1
1
  import { API } from './types/types';
2
- import { OrderType } from '../constants';
3
2
  export declare const orders: {
4
3
  calc: ({ signal, ...params }: API.Orders.Calc.Request) => Promise<API.Orders.Calc.Response>;
5
- orderTypes: () => Promise<OrderType[]>;
4
+ orderTypes: {
5
+ list: () => Promise<API.Orders.OrderTypes.List.Response>;
6
+ };
6
7
  create: {
7
8
  byOrderType: {
8
9
  INTERNAL_TRANSFER: (data: API.Orders.Create.ByOrderType.INTERNAL_TRANSFER.Request) => Promise<API.Orders.Create.ByOrderType.INTERNAL_TRANSFER.Response>;
@@ -19,7 +19,9 @@ exports.orders = {
19
19
  var { signal } = _a, params = __rest(_a, ["signal"]);
20
20
  return apiClientFactory_1.apiClientV1.getRequest('/orders/calc', { params, signal });
21
21
  },
22
- orderTypes: () => apiClientFactory_1.apiClientV1.getRequest('/orders/order_types'),
22
+ orderTypes: {
23
+ list: () => apiClientFactory_1.apiClientV1.getRequest('/orders/order_types'),
24
+ },
23
25
  create: {
24
26
  byOrderType: {
25
27
  [constants_1.OrderType.INTERNAL_TRANSFER]: (data) => apiClientFactory_1.apiClientV1.postRequest('/orders/INTERNAL_TRANSFER', {
@@ -980,23 +980,6 @@ export interface paths {
980
980
  patch?: never;
981
981
  trace?: never;
982
982
  };
983
- "/wallet-persona-references/{wallet_id}": {
984
- parameters: {
985
- query?: never;
986
- header?: never;
987
- path?: never;
988
- cookie?: never;
989
- };
990
- get?: never;
991
- put?: never;
992
- /** Get or Create */
993
- post: operations["WalletPersonaReferenceController_findOrCreate"];
994
- delete?: never;
995
- options?: never;
996
- head?: never;
997
- patch?: never;
998
- trace?: never;
999
- };
1000
983
  "/kyc/integration-persona-templates": {
1001
984
  parameters: {
1002
985
  query?: never;
@@ -1617,6 +1600,7 @@ export interface components {
1617
1600
  country_id: number | null;
1618
1601
  postal_code?: string | null;
1619
1602
  state_province_region?: string | null;
1603
+ id?: string;
1620
1604
  };
1621
1605
  KycBeneficialOwnerDto: {
1622
1606
  auth_letter_url: string | null;
@@ -1655,6 +1639,7 @@ export interface components {
1655
1639
  supplementary_url: string | null;
1656
1640
  tax_identification_number: string | null;
1657
1641
  selfie_url?: string | null;
1642
+ id?: string;
1658
1643
  address?: components["schemas"]["KycAddressDto"] | null;
1659
1644
  };
1660
1645
  KycEntityDto: {
@@ -2062,7 +2047,6 @@ export interface components {
2062
2047
  /** @example inq_E6U4KitBucNKpfrDMb997AaTkQTt */
2063
2048
  inquiryId: string | null;
2064
2049
  };
2065
- WalletPersonaReferenceEntityDto: Record<string, never>;
2066
2050
  IntegrationPersonaTemplateEntityDto: Record<string, never>;
2067
2051
  FindAllIntegrationPersonaTemplatesResponseDto: {
2068
2052
  /** @example 20 */
@@ -4430,41 +4414,6 @@ export interface operations {
4430
4414
  };
4431
4415
  };
4432
4416
  };
4433
- WalletPersonaReferenceController_findOrCreate: {
4434
- parameters: {
4435
- query?: never;
4436
- header?: never;
4437
- path: {
4438
- wallet_id: string;
4439
- };
4440
- cookie?: never;
4441
- };
4442
- requestBody?: never;
4443
- responses: {
4444
- 201: {
4445
- headers: {
4446
- [name: string]: unknown;
4447
- };
4448
- content: {
4449
- "application/json": components["schemas"]["WalletPersonaReferenceEntityDto"];
4450
- };
4451
- };
4452
- /** @description Unauthorized */
4453
- 401: {
4454
- headers: {
4455
- [name: string]: unknown;
4456
- };
4457
- content?: never;
4458
- };
4459
- /** @description You don`t have access to current wallet */
4460
- 403: {
4461
- headers: {
4462
- [name: string]: unknown;
4463
- };
4464
- content?: never;
4465
- };
4466
- };
4467
- };
4468
4417
  IntegrationPersonaTemplateController_findAll: {
4469
4418
  parameters: {
4470
4419
  query?: never;
@@ -1350,6 +1350,20 @@ export declare namespace API {
1350
1350
  }
1351
1351
  export {};
1352
1352
  }
1353
+ namespace OrderTypes {
1354
+ interface OrderInfo {
1355
+ id: string;
1356
+ transaction_type: string;
1357
+ description: string | null;
1358
+ direction: 'deposit' | 'withdrawal';
1359
+ is_internal: boolean;
1360
+ kyc_rails_id: string | null;
1361
+ payment_method: OrderType | string;
1362
+ }
1363
+ namespace List {
1364
+ type Response = OrderInfo[];
1365
+ }
1366
+ }
1353
1367
  namespace Status {
1354
1368
  interface Response {
1355
1369
  id: number;
@@ -1380,7 +1394,7 @@ export declare namespace API {
1380
1394
  wallet_id: string;
1381
1395
  va_programs_id: string;
1382
1396
  }
1383
- type Response = null;
1397
+ type Response = API.VirtualAccounts.VirtualAccount.VirtualAccount;
1384
1398
  }
1385
1399
  namespace GetByUuid {
1386
1400
  interface Request {
@@ -1,6 +1,6 @@
1
1
  import { API } from './types/types';
2
2
  export declare const virtualAccounts: {
3
- create: (data: API.VirtualAccounts.Create.Request) => Promise<null>;
3
+ create: (data: API.VirtualAccounts.Create.Request) => Promise<API.VirtualAccounts.VirtualAccount.VirtualAccount>;
4
4
  getAll: ({ wallet_uuid, ...params }: API.VirtualAccounts.GetAll.Request) => Promise<API.VirtualAccounts.GetAll.Response>;
5
5
  getByUuid: ({ uuid }: API.VirtualAccounts.GetByUuid.Request) => Promise<API.VirtualAccounts.VirtualAccount.VirtualAccount>;
6
6
  programs: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "squarefi-bff-api-module",
3
- "version": "1.18.6",
3
+ "version": "1.18.8",
4
4
  "description": "Squarefi BFF API client module",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
package/src/api/index.ts CHANGED
@@ -10,6 +10,7 @@ import { orders } from './orders';
10
10
  import { persona } from './persona';
11
11
  import { tenants } from './tenants';
12
12
  import { user } from './user';
13
+ import { virtualAccounts } from './virtual-accounts';
13
14
  import { wallets } from './wallets';
14
15
 
15
16
  type Api = {
@@ -24,6 +25,7 @@ type Api = {
24
25
  persona: typeof persona;
25
26
  tenants: typeof tenants;
26
27
  user: typeof user;
28
+ virtualAccounts: typeof virtualAccounts;
27
29
  wallets: typeof wallets;
28
30
  };
29
31
 
@@ -39,5 +41,6 @@ export const squarefi_bff_api_client: Api = {
39
41
  persona,
40
42
  tenants,
41
43
  user,
44
+ virtualAccounts,
42
45
  wallets,
43
46
  };
package/src/api/orders.ts CHANGED
@@ -8,7 +8,10 @@ export const orders = {
8
8
  calc: ({ signal, ...params }: API.Orders.Calc.Request): Promise<API.Orders.Calc.Response> =>
9
9
  apiClientV1.getRequest<API.Orders.Calc.Response>('/orders/calc', { params, signal }),
10
10
 
11
- orderTypes: (): Promise<OrderType[]> => apiClientV1.getRequest<OrderType[]>('/orders/order_types'),
11
+ orderTypes: {
12
+ list: (): Promise<API.Orders.OrderTypes.List.Response> =>
13
+ apiClientV1.getRequest<API.Orders.OrderTypes.List.Response>('/orders/order_types'),
14
+ },
12
15
 
13
16
  create: {
14
17
  byOrderType: {
@@ -981,23 +981,6 @@ export interface paths {
981
981
  patch?: never;
982
982
  trace?: never;
983
983
  };
984
- "/wallet-persona-references/{wallet_id}": {
985
- parameters: {
986
- query?: never;
987
- header?: never;
988
- path?: never;
989
- cookie?: never;
990
- };
991
- get?: never;
992
- put?: never;
993
- /** Get or Create */
994
- post: operations["WalletPersonaReferenceController_findOrCreate"];
995
- delete?: never;
996
- options?: never;
997
- head?: never;
998
- patch?: never;
999
- trace?: never;
1000
- };
1001
984
  "/kyc/integration-persona-templates": {
1002
985
  parameters: {
1003
986
  query?: never;
@@ -1618,6 +1601,7 @@ export interface components {
1618
1601
  country_id: number | null;
1619
1602
  postal_code?: string | null;
1620
1603
  state_province_region?: string | null;
1604
+ id?: string;
1621
1605
  };
1622
1606
  KycBeneficialOwnerDto: {
1623
1607
  auth_letter_url: string | null;
@@ -1656,6 +1640,7 @@ export interface components {
1656
1640
  supplementary_url: string | null;
1657
1641
  tax_identification_number: string | null;
1658
1642
  selfie_url?: string | null;
1643
+ id?: string;
1659
1644
  address?: components["schemas"]["KycAddressDto"] | null;
1660
1645
  };
1661
1646
  KycEntityDto: {
@@ -2063,7 +2048,6 @@ export interface components {
2063
2048
  /** @example inq_E6U4KitBucNKpfrDMb997AaTkQTt */
2064
2049
  inquiryId: string | null;
2065
2050
  };
2066
- WalletPersonaReferenceEntityDto: Record<string, never>;
2067
2051
  IntegrationPersonaTemplateEntityDto: Record<string, never>;
2068
2052
  FindAllIntegrationPersonaTemplatesResponseDto: {
2069
2053
  /** @example 20 */
@@ -4431,41 +4415,6 @@ export interface operations {
4431
4415
  };
4432
4416
  };
4433
4417
  };
4434
- WalletPersonaReferenceController_findOrCreate: {
4435
- parameters: {
4436
- query?: never;
4437
- header?: never;
4438
- path: {
4439
- wallet_id: string;
4440
- };
4441
- cookie?: never;
4442
- };
4443
- requestBody?: never;
4444
- responses: {
4445
- 201: {
4446
- headers: {
4447
- [name: string]: unknown;
4448
- };
4449
- content: {
4450
- "application/json": components["schemas"]["WalletPersonaReferenceEntityDto"];
4451
- };
4452
- };
4453
- /** @description Unauthorized */
4454
- 401: {
4455
- headers: {
4456
- [name: string]: unknown;
4457
- };
4458
- content?: never;
4459
- };
4460
- /** @description You don`t have access to current wallet */
4461
- 403: {
4462
- headers: {
4463
- [name: string]: unknown;
4464
- };
4465
- content?: never;
4466
- };
4467
- };
4468
- };
4469
4418
  IntegrationPersonaTemplateController_findAll: {
4470
4419
  parameters: {
4471
4420
  query?: never;
@@ -1557,6 +1557,22 @@ export namespace API {
1557
1557
  }
1558
1558
  }
1559
1559
 
1560
+ export namespace OrderTypes {
1561
+ export interface OrderInfo {
1562
+ id: string;
1563
+ transaction_type: string;
1564
+ description: string | null;
1565
+ direction: 'deposit' | 'withdrawal';
1566
+ is_internal: boolean;
1567
+ kyc_rails_id: string | null;
1568
+ payment_method: OrderType | string;
1569
+ }
1570
+
1571
+ export namespace List {
1572
+ export type Response = OrderInfo[];
1573
+ }
1574
+ }
1575
+
1560
1576
  // export namespace OffRamp {
1561
1577
  // // deprecated
1562
1578
  // export interface Item {
@@ -1676,7 +1692,7 @@ export namespace API {
1676
1692
  va_programs_id: string;
1677
1693
  }
1678
1694
 
1679
- export type Response = null;
1695
+ export type Response = API.VirtualAccounts.VirtualAccount.VirtualAccount;
1680
1696
  }
1681
1697
 
1682
1698
  export namespace GetByUuid {