squarefi-bff-api-module 1.36.10 → 1.36.12

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.
@@ -7561,12 +7561,10 @@ export interface components {
7561
7561
  * @description External vendor account ID
7562
7562
  */
7563
7563
  vendor_account_id?: string | null;
7564
- /** @description Bank account details for deposits. Returned null when deposits are disabled for the account. */
7564
+ /** @description Bank account details for deposits, derived from deposit_instructions. Returned null when deposits are disabled for the account. */
7565
7565
  account_details?: components["schemas"]["BankAccountDetails"];
7566
- /** @description Deposit requisites. Returned null when deposits are disabled for the account. */
7566
+ /** @description Deposit requisites (source of truth). Returned null when deposits are disabled for the account. */
7567
7567
  deposit_instructions?: Record<string, never> | null;
7568
- current_balance?: number | null;
7569
- available_balance?: number | null;
7570
7568
  /** @description Additional metadata from vendor */
7571
7569
  meta?: Record<string, never> | null;
7572
7570
  /**
@@ -5809,6 +5809,95 @@ export interface paths {
5809
5809
  patch?: never;
5810
5810
  trace?: never;
5811
5811
  };
5812
+ "/frontend/orders/{order_id}/comment": {
5813
+ parameters: {
5814
+ query?: never;
5815
+ header?: never;
5816
+ path?: never;
5817
+ cookie?: never;
5818
+ };
5819
+ get?: never;
5820
+ /**
5821
+ * Set or clear an order's comment
5822
+ * @description Saves (or edits) a single free-text comment attached to an order
5823
+ * (incoming or outgoing). Useful for noting who an incoming crypto deposit
5824
+ * came from. Send `comment: null` or an empty string to clear it.
5825
+ *
5826
+ * The response includes the saved `comment` plus audit metadata
5827
+ * (`comment_updated_by` = editor's user_data uuid, `comment_updated_at`).
5828
+ *
5829
+ * **Access Control**: caller must be `admin` or `owner` of the order's wallet.
5830
+ *
5831
+ */
5832
+ put: {
5833
+ parameters: {
5834
+ query?: never;
5835
+ header?: never;
5836
+ path: {
5837
+ order_id: string;
5838
+ };
5839
+ cookie?: never;
5840
+ };
5841
+ requestBody: {
5842
+ content: {
5843
+ "application/json": {
5844
+ /** Format: uuid */
5845
+ wallet_id: string;
5846
+ /** @description Comment text. `null` or empty clears the comment. */
5847
+ comment?: string | null;
5848
+ };
5849
+ };
5850
+ };
5851
+ responses: {
5852
+ /** @description Comment saved */
5853
+ 200: {
5854
+ headers: {
5855
+ [name: string]: unknown;
5856
+ };
5857
+ content: {
5858
+ "application/json": {
5859
+ /** @example true */
5860
+ success?: boolean;
5861
+ data?: components["schemas"]["Order"];
5862
+ };
5863
+ };
5864
+ };
5865
+ /** @description Validation error (e.g. comment too long) */
5866
+ 400: {
5867
+ headers: {
5868
+ [name: string]: unknown;
5869
+ };
5870
+ content: {
5871
+ "application/json": components["schemas"]["ErrorResponse"];
5872
+ };
5873
+ };
5874
+ /** @description Access denied (insufficient wallet role / wrong wallet) */
5875
+ 403: {
5876
+ headers: {
5877
+ [name: string]: unknown;
5878
+ };
5879
+ content: {
5880
+ "application/json": components["schemas"]["ErrorResponse"];
5881
+ };
5882
+ };
5883
+ /** @description Order not found */
5884
+ 404: {
5885
+ headers: {
5886
+ [name: string]: unknown;
5887
+ };
5888
+ content: {
5889
+ "application/json": components["schemas"]["ErrorResponse"];
5890
+ };
5891
+ };
5892
+ };
5893
+ };
5894
+ post?: never;
5895
+ delete?: never;
5896
+ options?: never;
5897
+ head?: never;
5898
+ patch?: never;
5899
+ trace?: never;
5900
+ };
5812
5901
  "/frontend/orders/types": {
5813
5902
  parameters: {
5814
5903
  query?: never;
@@ -10490,12 +10579,10 @@ export interface components {
10490
10579
  /** Format: uuid */
10491
10580
  destination_currency?: string;
10492
10581
  vendor_account_id?: string | null;
10493
- /** @description Bank account details for deposits. Returned null when deposits are disabled for the account. */
10582
+ /** @description Bank account details for deposits, derived from deposit_instructions. Returned null when deposits are disabled for the account. */
10494
10583
  account_details?: Record<string, never> | null;
10495
- /** @description Deposit requisites. Returned null when deposits are disabled for the account. */
10584
+ /** @description Deposit requisites (source of truth). Returned null when deposits are disabled for the account. */
10496
10585
  deposit_instructions?: Record<string, never> | null;
10497
- current_balance?: number | null;
10498
- available_balance?: number | null;
10499
10586
  meta?: Record<string, never> | null;
10500
10587
  /** Format: date-time */
10501
10588
  created_at?: string;
@@ -754,67 +754,6 @@ export interface paths {
754
754
  patch?: never;
755
755
  trace?: never;
756
756
  };
757
- "/api/kyc/sumsub/generate_token": {
758
- parameters: {
759
- query?: never;
760
- header?: never;
761
- path?: never;
762
- cookie?: never;
763
- };
764
- get?: never;
765
- put?: never;
766
- /**
767
- * Generate Sumsub access token
768
- * @deprecated
769
- * @description Generate a Sumsub access token for KYC verification
770
- */
771
- post: {
772
- parameters: {
773
- query?: never;
774
- header?: never;
775
- path?: never;
776
- cookie?: never;
777
- };
778
- requestBody: {
779
- content: {
780
- "application/json": {
781
- /** @description The user data ID */
782
- user_data_id: number;
783
- };
784
- };
785
- };
786
- responses: {
787
- /** @description Sumsub access token */
788
- 200: {
789
- headers: {
790
- [name: string]: unknown;
791
- };
792
- content: {
793
- "application/json": {
794
- /** @example .-v2 */
795
- token?: string;
796
- /** @example 232323 */
797
- user_data_id?: number;
798
- };
799
- };
800
- };
801
- /** @description Bad request */
802
- 400: {
803
- headers: {
804
- [name: string]: unknown;
805
- };
806
- content: {
807
- "application/json": components["schemas"]["Error"];
808
- };
809
- };
810
- };
811
- };
812
- delete?: never;
813
- options?: never;
814
- head?: never;
815
- patch?: never;
816
- trace?: never;
817
- };
818
757
  "/crypto": {
819
758
  parameters: {
820
759
  query?: never;
@@ -5208,18 +5147,8 @@ export interface paths {
5208
5147
  integration_vendor_id?: string;
5209
5148
  /** @description Vendor's account ID */
5210
5149
  vendor_account_id?: string;
5211
- /** @description Status at vendor side (OPEN, CLOSED, etc.) */
5212
- vendor_status?: string;
5213
- /** @description Current balance */
5214
- current_balance?: number;
5215
- /** @description Available balance for withdrawal */
5216
- available_balance?: number;
5217
5150
  /** @description Customer name on the account */
5218
5151
  customer_name?: string;
5219
- /** @description Asset type identifier (e.g., FIAT_TESTNET_USD) */
5220
- asset_type_id?: string;
5221
- /** @description Deposit type (PUSH, PULL) */
5222
- deposit_type?: string;
5223
5152
  /** @description Additional metadata */
5224
5153
  meta?: Record<string, never>;
5225
5154
  /** @description Rail/vendor specific account details */
@@ -3407,6 +3407,80 @@ export interface paths {
3407
3407
  patch?: never;
3408
3408
  trace?: never;
3409
3409
  };
3410
+ "/admin/orders/{order_id}/comment": {
3411
+ parameters: {
3412
+ query?: never;
3413
+ header?: never;
3414
+ path?: never;
3415
+ cookie?: never;
3416
+ };
3417
+ get?: never;
3418
+ /**
3419
+ * Set or clear an order's comment
3420
+ * @description Saves (or edits) the single free-text comment attached to an order
3421
+ * (incoming or outgoing). Tenant-scoped: the order must belong to the
3422
+ * caller's tenant. Send `comment: null` or an empty string to clear it.
3423
+ *
3424
+ */
3425
+ put: {
3426
+ parameters: {
3427
+ query?: never;
3428
+ header?: never;
3429
+ path: {
3430
+ /** @description Order ID to comment on */
3431
+ order_id: string;
3432
+ };
3433
+ cookie?: never;
3434
+ };
3435
+ requestBody: {
3436
+ content: {
3437
+ "application/json": {
3438
+ /** @description Comment text. `null` or empty clears the comment. */
3439
+ comment?: string | null;
3440
+ };
3441
+ };
3442
+ };
3443
+ responses: {
3444
+ /** @description Comment saved */
3445
+ 200: {
3446
+ headers: {
3447
+ [name: string]: unknown;
3448
+ };
3449
+ content: {
3450
+ "application/json": {
3451
+ /** @example true */
3452
+ success?: boolean;
3453
+ data?: components["schemas"]["TenantOrder"];
3454
+ };
3455
+ };
3456
+ };
3457
+ /** @description Validation error (e.g. comment too long) */
3458
+ 400: {
3459
+ headers: {
3460
+ [name: string]: unknown;
3461
+ };
3462
+ content: {
3463
+ "application/json": components["schemas"]["ErrorResponse"];
3464
+ };
3465
+ };
3466
+ /** @description Order not found */
3467
+ 404: {
3468
+ headers: {
3469
+ [name: string]: unknown;
3470
+ };
3471
+ content: {
3472
+ "application/json": components["schemas"]["ErrorResponse"];
3473
+ };
3474
+ };
3475
+ };
3476
+ };
3477
+ post?: never;
3478
+ delete?: never;
3479
+ options?: never;
3480
+ head?: never;
3481
+ patch?: never;
3482
+ trace?: never;
3483
+ };
3410
3484
  "/admin/orders/{order_id}": {
3411
3485
  parameters: {
3412
3486
  query?: never;
@@ -1860,6 +1860,7 @@ export interface components {
1860
1860
  vendors_and_counterparties?: ("SELF" | "MERCHANTS_SUPPLIERS" | "CUSTOMERS" | "EMPLOYEES" | "CONTRACTORS" | "FRIENDS" | "FAMILY")[] | null;
1861
1861
  stablecoin_primary_purpose?: string[] | null;
1862
1862
  stablecoin_primary_purpose_other?: string | null;
1863
+ stablecoin_activity?: string | null;
1863
1864
  pep_declaration?: boolean | null;
1864
1865
  pep_full_name?: string | null;
1865
1866
  pep_relationship?: string | null;
@@ -1995,6 +1996,7 @@ export interface components {
1995
1996
  vendors_and_counterparties?: ("SELF" | "MERCHANTS_SUPPLIERS" | "CUSTOMERS" | "EMPLOYEES" | "CONTRACTORS" | "FRIENDS" | "FAMILY")[] | null;
1996
1997
  stablecoin_primary_purpose?: string[] | null;
1997
1998
  stablecoin_primary_purpose_other?: string | null;
1999
+ stablecoin_activity?: string | null;
1998
2000
  pep_declaration?: boolean | null;
1999
2001
  pep_full_name?: string | null;
2000
2002
  pep_relationship?: string | null;
@@ -2299,6 +2301,11 @@ export interface components {
2299
2301
  /** @enum {string} */
2300
2302
  default_theme_mode: "dark" | "light";
2301
2303
  enable_kyc: boolean;
2304
+ /** @example [
2305
+ * "individual",
2306
+ * "business"
2307
+ * ] */
2308
+ allowed_kyc_entity_types: ("individual" | "business" | "universal")[] | null;
2302
2309
  tg_bot_name: string | null;
2303
2310
  theme_switch: boolean;
2304
2311
  enable_exchange: boolean;
@@ -1688,6 +1688,7 @@ export declare namespace API {
1688
1688
  updated_at: string;
1689
1689
  deleted_at?: string | null;
1690
1690
  is_deleted?: boolean | null;
1691
+ internal_wallet_data_id?: string | null;
1691
1692
  counterparty_account: CounterpartyAccount;
1692
1693
  external_banking_data?: ExternalBankingData | null;
1693
1694
  external_crypto_data?: ExternalCryptoData | null;
@@ -1702,12 +1703,6 @@ export declare namespace API {
1702
1703
  postal_code: string;
1703
1704
  country_code: string;
1704
1705
  }
1705
- interface VirtualAccountAccountDetails {
1706
- rail_account_id: string;
1707
- rail_asset_type: string;
1708
- rail_product_id: string;
1709
- rail_customer_id: string;
1710
- }
1711
1706
  interface VirtualAccountDetails {
1712
1707
  id: string;
1713
1708
  created_at: string;
@@ -1726,20 +1721,32 @@ export declare namespace API {
1726
1721
  asset_type_id: string;
1727
1722
  deposit_type: string;
1728
1723
  meta?: Record<string, unknown>;
1729
- account_details: VirtualAccountAccountDetails;
1724
+ is_deposit_enabled?: boolean;
1730
1725
  deposit_instructions?: API.VirtualAccounts.VirtualAccount.DepositInstruction.DepositInstruction[];
1731
1726
  account_currency_details: API.Currencies.SimplifiedCurrency;
1732
1727
  destination_currency_details: API.Currencies.SimplifiedCurrency;
1733
1728
  integration_vendor: IntegrationVendorExtended;
1734
1729
  }
1735
1730
  type OrderDetails = API.Orders.V2.List.ByWallet.OrderItem & {
1736
- request_id: string;
1731
+ request_id?: string | null;
1737
1732
  updated_at: string;
1738
- wallet: API.Wallets.SimplifiedWallet;
1733
+ fee?: number | null;
1734
+ fee_currency_id?: string | null;
1735
+ network_fee?: number | null;
1736
+ network_fee_currency_id?: string | null;
1737
+ exchange_rate?: number | null;
1738
+ from_currency_id?: string | null;
1739
+ to_currency_id?: string | null;
1740
+ workflow_run_id?: string | null;
1741
+ wallet: {
1742
+ uuid: string;
1743
+ tenant_id: string;
1744
+ };
1739
1745
  from_currency: API.Currencies.SimplifiedCurrency;
1740
1746
  to_currency: API.Currencies.SimplifiedCurrency;
1741
1747
  virtual_account?: VirtualAccountDetails | null;
1742
1748
  counterparty_destination?: CounterpartyDestination | null;
1749
+ documents?: unknown[];
1743
1750
  };
1744
1751
  type Response = OrderDetails;
1745
1752
  }
@@ -1932,28 +1939,6 @@ export declare namespace API {
1932
1939
  name: string;
1933
1940
  address: string;
1934
1941
  }
1935
- interface AccountDetails {
1936
- bankName: string;
1937
- bankAddress: string;
1938
- beneficiary: API.VirtualAccounts.VirtualAccount.Beneficiary;
1939
- swiftCode: string;
1940
- ach?: {
1941
- accountNumber: string;
1942
- routingNumber: string;
1943
- };
1944
- rtp?: {
1945
- accountNumber: string;
1946
- routingNumber: string;
1947
- };
1948
- wire?: {
1949
- accountNumber: string;
1950
- routingNumber: string;
1951
- };
1952
- swift?: {
1953
- accountNumber: string;
1954
- routingNumber: string;
1955
- };
1956
- }
1957
1942
  interface PaymentRail {
1958
1943
  currency: string;
1959
1944
  paymentRail: string[];
@@ -2042,13 +2027,11 @@ export declare namespace API {
2042
2027
  destination_address: string;
2043
2028
  integration_vendor_id: string;
2044
2029
  vendor_account_id: string;
2045
- account_details: API.VirtualAccounts.VirtualAccount.AccountDetails;
2046
2030
  virtual_accounts_program: API.VirtualAccounts.Programs.Program;
2047
2031
  deposit_instructions?: API.VirtualAccounts.VirtualAccount.DepositInstruction.DepositInstruction[];
2048
2032
  }
2049
2033
  interface VirtualAccountDetailItem {
2050
2034
  account_currency: string;
2051
- account_details: API.VirtualAccounts.VirtualAccount.AccountDetails;
2052
2035
  balance: number;
2053
2036
  crypto_deposit_details: {
2054
2037
  currency_id: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "squarefi-bff-api-module",
3
- "version": "1.36.10",
3
+ "version": "1.36.12",
4
4
  "description": "Squarefi BFF API client module",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",