squarefi-bff-api-module 1.36.1 → 1.36.2

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.
@@ -7523,11 +7523,9 @@ export interface components {
7523
7523
  * @description External vendor account ID
7524
7524
  */
7525
7525
  vendor_account_id?: string | null;
7526
- /** @description When false, deposit_instructions and account_details are returned as null (deposits disabled for this account) */
7527
- is_deposit_enabled?: boolean;
7528
- /** @description Bank account details for deposits. Returned null when is_deposit_enabled is false. */
7526
+ /** @description Bank account details for deposits. Returned null when deposits are disabled for the account. */
7529
7527
  account_details?: components["schemas"]["BankAccountDetails"];
7530
- /** @description Deposit requisites. Returned null when is_deposit_enabled is false. */
7528
+ /** @description Deposit requisites. Returned null when deposits are disabled for the account. */
7531
7529
  deposit_instructions?: Record<string, never> | null;
7532
7530
  current_balance?: number | null;
7533
7531
  available_balance?: number | null;
@@ -7604,7 +7602,10 @@ export interface components {
7604
7602
  /** @description Array of order_type IDs */
7605
7603
  order_types?: string[];
7606
7604
  /** @description KYC rail configuration */
7607
- kyc_rails?: Record<string, never> | null;
7605
+ kyc_rails?: {
7606
+ /** @description When false, deposits are not accepted for accounts on this rail and their requisites are suppressed in public responses */
7607
+ is_deposit_enabled?: boolean;
7608
+ } | null;
7608
7609
  /**
7609
7610
  * Format: uuid
7610
7611
  * @description Required KYC rail ID
@@ -1845,6 +1845,16 @@ export interface paths {
1845
1845
  * @example My Card
1846
1846
  */
1847
1847
  card_name: string;
1848
+ /**
1849
+ * Format: uuid
1850
+ * @description Optional. Binds the card to a wallet member so a scoped `user` role can
1851
+ * access ONLY this card (view, sensitive data, transactions, freeze/unfreeze),
1852
+ * and nothing else in the wallet (SFI-1382). Must be the `user_data.uuid` of an
1853
+ * active member of the target wallet; resolved server-side to the card's owner.
1854
+ *
1855
+ * @example a1b2c3d4-e5f6-7890-abcd-ef1234567890
1856
+ */
1857
+ assigned_user_data_uuid?: string;
1848
1858
  /**
1849
1859
  * Format: email
1850
1860
  * @deprecated
@@ -7113,7 +7123,7 @@ export interface paths {
7113
7123
  /** Format: uuid */
7114
7124
  wallet_id?: string;
7115
7125
  /** @enum {string} */
7116
- role?: "user" | "admin";
7126
+ role?: "auditor" | "user" | "admin";
7117
7127
  };
7118
7128
  };
7119
7129
  };
@@ -7281,7 +7291,7 @@ export interface paths {
7281
7291
  */
7282
7292
  wallet_name?: string;
7283
7293
  /** @enum {string} */
7284
- role?: "user" | "admin";
7294
+ role?: "auditor" | "user" | "admin";
7285
7295
  };
7286
7296
  };
7287
7297
  };
@@ -7328,7 +7338,7 @@ export interface paths {
7328
7338
  * List wallets
7329
7339
  * @description Retrieves a list of wallets for the authenticated user (owned + shared via wallets_users).
7330
7340
  *
7331
- * Each wallet includes `access_role` (owner/admin/manager/user) and `is_owner` boolean.
7341
+ * Each wallet includes `access_role` (owner/admin/user/auditor) and `is_owner` boolean.
7332
7342
  *
7333
7343
  * **Authentication**: Bearer token with x-tenant-id header required
7334
7344
  *
@@ -7341,7 +7351,7 @@ export interface paths {
7341
7351
  /** @description Number of items to return */
7342
7352
  limit?: number;
7343
7353
  /** @description Filter wallets by user's access role */
7344
- role?: "owner" | "admin" | "manager" | "user";
7354
+ role?: "owner" | "admin" | "user" | "auditor";
7345
7355
  /** @description Include shared wallets (via wallets_users table) */
7346
7356
  include_shared?: boolean;
7347
7357
  /** @description Field to sort the merged owned + shared wallet list by */
@@ -7388,12 +7398,12 @@ export interface paths {
7388
7398
  *
7389
7399
  * @enum {string}
7390
7400
  */
7391
- role: "owner" | "admin" | "manager" | "user";
7401
+ role: "owner" | "admin" | "user" | "auditor";
7392
7402
  /**
7393
7403
  * @description User's access role for this wallet
7394
7404
  * @enum {string}
7395
7405
  */
7396
- access_role: "owner" | "admin" | "manager" | "user";
7406
+ access_role: "owner" | "admin" | "user" | "auditor";
7397
7407
  /** @description True if user is the wallet owner */
7398
7408
  is_owner: boolean;
7399
7409
  /** @description KYC entity attached to the wallet (joined from `kyc_entity`).
@@ -7809,12 +7819,12 @@ export interface paths {
7809
7819
  *
7810
7820
  * @enum {string}
7811
7821
  */
7812
- role?: "owner" | "admin" | "manager" | "user";
7822
+ role?: "owner" | "admin" | "user" | "auditor";
7813
7823
  /**
7814
7824
  * @description User's role for this wallet (only present when called via member access)
7815
7825
  * @enum {string}
7816
7826
  */
7817
- access_role?: "owner" | "admin" | "manager" | "user";
7827
+ access_role?: "owner" | "admin" | "user" | "auditor";
7818
7828
  is_owner?: boolean;
7819
7829
  };
7820
7830
  };
@@ -8659,7 +8669,7 @@ export interface paths {
8659
8669
  /** @description Search by first_name, last_name, email, or phone */
8660
8670
  search?: string;
8661
8671
  /** @description Filter by role */
8662
- role?: "owner" | "admin" | "user";
8672
+ role?: "owner" | "admin" | "user" | "auditor";
8663
8673
  /** @description Filter by active status (default true) */
8664
8674
  is_active?: boolean;
8665
8675
  };
@@ -8685,7 +8695,7 @@ export interface paths {
8685
8695
  /** Format: uuid */
8686
8696
  user_data_uuid?: string;
8687
8697
  /** @enum {string} */
8688
- role?: "owner" | "admin" | "user";
8698
+ role?: "owner" | "admin" | "user" | "auditor";
8689
8699
  is_active?: boolean;
8690
8700
  /** Format: date-time */
8691
8701
  created_at?: string;
@@ -8766,7 +8776,7 @@ export interface paths {
8766
8776
  * @description Role to assign to the user
8767
8777
  * @enum {string}
8768
8778
  */
8769
- role: "user" | "admin";
8779
+ role: "auditor" | "user" | "admin";
8770
8780
  };
8771
8781
  };
8772
8782
  };
@@ -8786,7 +8796,7 @@ export interface paths {
8786
8796
  /** Format: uuid */
8787
8797
  user_data_uuid?: string;
8788
8798
  /** @enum {string} */
8789
- role?: "user" | "admin";
8799
+ role?: "auditor" | "user" | "admin";
8790
8800
  is_active?: boolean;
8791
8801
  /** Format: date-time */
8792
8802
  created_at?: string;
@@ -8947,7 +8957,7 @@ export interface paths {
8947
8957
  * @description New role for the user
8948
8958
  * @enum {string}
8949
8959
  */
8950
- role: "user" | "admin";
8960
+ role: "auditor" | "user" | "admin";
8951
8961
  };
8952
8962
  };
8953
8963
  };
@@ -9195,7 +9205,7 @@ export interface paths {
9195
9205
  limit?: number;
9196
9206
  /** @description When true — only used invites; when false — only pending; omit for all. */
9197
9207
  is_completed?: boolean;
9198
- role?: "user" | "admin";
9208
+ role?: "auditor" | "user" | "admin";
9199
9209
  /** @description Case-insensitive search by email */
9200
9210
  search?: string;
9201
9211
  };
@@ -9244,7 +9254,7 @@ export interface paths {
9244
9254
  *
9245
9255
  * **Rules:**
9246
9256
  * - Only the wallet **owner** can create invites
9247
- * - `role` must be one of: `user`, `admin` (owner cannot be assigned via invite)
9257
+ * - `role` must be one of: `auditor`, `user`, `admin` (owner cannot be assigned via invite)
9248
9258
  * - If an active (not used, not expired) invite for the same email already exists,
9249
9259
  * it is superseded (expired) and replaced with a new one
9250
9260
  * - Cannot invite yourself
@@ -9276,7 +9286,7 @@ export interface paths {
9276
9286
  * @description Role to assign on acceptance
9277
9287
  * @enum {string}
9278
9288
  */
9279
- role: "user" | "admin";
9289
+ role: "auditor" | "user" | "admin";
9280
9290
  };
9281
9291
  };
9282
9292
  };
@@ -9589,11 +9599,9 @@ export interface components {
9589
9599
  /** Format: uuid */
9590
9600
  destination_currency?: string;
9591
9601
  vendor_account_id?: string | null;
9592
- /** @description When false, deposit_instructions and account_details are returned as null (deposits disabled for this account) */
9593
- is_deposit_enabled?: boolean;
9594
- /** @description Bank account details for deposits. Returned null when is_deposit_enabled is false. */
9602
+ /** @description Bank account details for deposits. Returned null when deposits are disabled for the account. */
9595
9603
  account_details?: Record<string, never> | null;
9596
- /** @description Deposit requisites. Returned null when is_deposit_enabled is false. */
9604
+ /** @description Deposit requisites. Returned null when deposits are disabled for the account. */
9597
9605
  deposit_instructions?: Record<string, never> | null;
9598
9606
  current_balance?: number | null;
9599
9607
  available_balance?: number | null;
@@ -9722,7 +9730,7 @@ export interface components {
9722
9730
  * @description Role granted upon acceptance
9723
9731
  * @enum {string}
9724
9732
  */
9725
- role: "user" | "admin";
9733
+ role: "auditor" | "user" | "admin";
9726
9734
  /** @description 16-char uppercase hex code delivered by email */
9727
9735
  code: string;
9728
9736
  /** Format: date-time */
@@ -7628,6 +7628,8 @@ export interface components {
7628
7628
  id?: string;
7629
7629
  type?: string;
7630
7630
  name?: string;
7631
+ /** @description When false, deposits are not accepted for accounts on this rail and their requisites are suppressed in public responses */
7632
+ is_deposit_enabled?: boolean;
7631
7633
  } | null;
7632
7634
  /** @description Tenant-specific billing rates */
7633
7635
  tenant_rates?: {
@@ -7736,7 +7738,7 @@ export interface components {
7736
7738
  account_currency?: string;
7737
7739
  /** Format: uuid */
7738
7740
  destination_currency?: string;
7739
- /** @description Whether deposits are enabled for this account. When false, public (Frontend/Developer) responses suppress deposit_instructions/account_details; admin responses still expose them. */
7741
+ /** @description Whether deposits are enabled for this account, resolved from the account's KYC rail (virtual_accounts_programs.kyc_rails.is_deposit_enabled). When false, public (Frontend/Developer) responses suppress deposit_instructions/account_details; admin responses still expose them. */
7740
7742
  is_deposit_enabled?: boolean;
7741
7743
  /** @description Bank deposit instructions grouped by instruction type (ACH, FEDWIRE, SWIFT) */
7742
7744
  deposit_instructions?: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "squarefi-bff-api-module",
3
- "version": "1.36.1",
3
+ "version": "1.36.2",
4
4
  "description": "Squarefi BFF API client module",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",