squarefi-bff-api-module 1.36.92 → 1.36.93

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.
@@ -80,6 +80,9 @@ export declare const frontend: {
80
80
  exchangeRates: {
81
81
  list: (params?: API.Frontend.Reference.ExchangeRates.List.Request) => Promise<API.Frontend.Reference.ExchangeRates.List.Response>;
82
82
  };
83
+ orderTypes: {
84
+ list: (params?: API.Frontend.Reference.OrderTypes.List.Request) => Promise<API.Frontend.Reference.OrderTypes.List.Response>;
85
+ };
83
86
  };
84
87
  notificationPreferences: {
85
88
  get: () => Promise<API.Frontend.NotificationPreferences.Get.Response>;
@@ -158,6 +158,10 @@ export const frontend = {
158
158
  exchangeRates: {
159
159
  list: (params = {}) => apiClientV1Frontend.getRequest('/frontend/reference/exchange_rates', { params }),
160
160
  },
161
+ // Only the types enabled for the tenant (a `tenant_order_type_rates` row), paged — 50 by default, 500 at most.
162
+ orderTypes: {
163
+ list: (params = {}) => apiClientV1Frontend.getRequest('/frontend/reference/order_types', { params }),
164
+ },
161
165
  },
162
166
  // IN_APP stays on (400 INBOX_CHANNEL_LOCKED); channels vary by tenant (TELEGRAM needs a bot); PUT upserts any subset.
163
167
  notificationPreferences: {
@@ -5016,7 +5016,7 @@ export interface paths {
5016
5016
  * with `status`. Any other value is rejected with 400.
5017
5017
  *
5018
5018
  * Every key is checked before the query runs (SFI-2693): an unknown field, a value of the
5019
- * wrong type (e.g. a status that does not exist, a non-uuid id) or an object on a plain
5019
+ * wrong type (e.g. a status that does not exist, an `order_type` that is neither enabled for the tenant — see `/reference/order_types` — nor among the wallet's orders, or a non-uuid id) or an object on a plain
5020
5020
  * field answers 400 `INVALID_REQUEST`, and `details.field` names the field. An object is
5021
5021
  * accepted on `meta` only — `[{"meta":{"direction":"out"}}]` matches `meta->>direction`.
5022
5022
  * */
@@ -5025,8 +5025,10 @@ export interface paths {
5025
5025
  date_to?: string;
5026
5026
  /** @description Part of the recipient's name or nickname (`meta.counterparty_account_name`,
5027
5027
  * `meta.counterparty_account_nickname`), case-insensitive. Combines with `filters`,
5028
- * sorting and pagination; `pagination` counts the matches only. Up to 100 characters;
5029
- * `*`, `%`, `"` and `\` are ignored.
5028
+ * sorting and pagination; `pagination` counts the matches only. `*`, `%`, `"` and `\`
5029
+ * are ignored without splitting the word (`des%ign` finds "Design"); `_` matches itself.
5030
+ * Up to 100 characters: a longer value answers 400 `INVALID_REQUEST` with
5031
+ * `details.field` = `search`.
5030
5032
  * */
5031
5033
  search?: string;
5032
5034
  /** @description If `true`, includes dust orders (amount below render threshold for either currency). Defaults to `false` — dust orders are hidden. */
@@ -9841,7 +9841,7 @@ export interface paths {
9841
9841
  * Any other value is rejected with 400.
9842
9842
  *
9843
9843
  * Every key is checked before the query runs (SFI-2693): an unknown field, a value of the
9844
- * wrong type (e.g. a status that does not exist, a non-uuid id) or an object on a plain
9844
+ * wrong type (e.g. a status that does not exist, an `order_type` that is neither enabled for the tenant — see `/reference/order_types` — nor among the wallet's orders, or a non-uuid id) or an object on a plain
9845
9845
  * field answers 400 `INVALID_REQUEST`, and `details.field` names the field. An object is
9846
9846
  * accepted on `meta` only — `[{"meta":{"direction":"out"}}]` matches `meta->>direction`.
9847
9847
  * */
@@ -9850,8 +9850,10 @@ export interface paths {
9850
9850
  date_to?: string;
9851
9851
  /** @description Part of the recipient's name or nickname (`meta.counterparty_account_name`,
9852
9852
  * `meta.counterparty_account_nickname`), case-insensitive. Combines with `filters`,
9853
- * sorting and pagination; `pagination` counts the matches only. Up to 100 characters;
9854
- * `*`, `%`, `"` and `\` are ignored.
9853
+ * sorting and pagination; `pagination` counts the matches only. `*`, `%`, `"` and `\`
9854
+ * are ignored without splitting the word (`des%ign` finds "Design"); `_` matches itself.
9855
+ * Up to 100 characters: a longer value answers 400 `INVALID_REQUEST` with
9856
+ * `details.field` = `search`.
9855
9857
  * */
9856
9858
  search?: string;
9857
9859
  /** @description If `true`, includes dust orders (amount below render threshold for either currency). Defaults to `false` — dust orders are hidden. */
@@ -9879,7 +9881,7 @@ export interface paths {
9879
9881
  };
9880
9882
  };
9881
9883
  };
9882
- /** @description `INVALID_REQUEST` — `filters` is not a JSON array, `mass_payout_id` / `rfi_case_id` is not a uuid, `scheduled` is not `all` / `upcoming` / `past`, or a filter names an unknown field or carries a value of the wrong type (`details.field` names it) */
9884
+ /** @description `INVALID_REQUEST` — `filters` is not a JSON array, `mass_payout_id` / `rfi_case_id` is not a uuid, `scheduled` is not `all` / `upcoming` / `past`, a filter names an unknown field or carries a value of the wrong type, or `search` is longer than 100 characters (`details.field` names the field) */
9883
9885
  400: {
9884
9886
  headers: {
9885
9887
  [name: string]: unknown;
@@ -10041,15 +10043,17 @@ export interface paths {
10041
10043
  * Any other value is rejected with 400.
10042
10044
  *
10043
10045
  * Every key is checked before the query runs (SFI-2693): an unknown field, a value of the
10044
- * wrong type (e.g. a status that does not exist, a non-uuid id) or an object on a plain
10046
+ * wrong type (e.g. a status that does not exist, an `order_type` that is neither enabled for the tenant — see `/reference/order_types` — nor among the wallet's orders, or a non-uuid id) or an object on a plain
10045
10047
  * field answers 400 `INVALID_REQUEST`, and `details.field` names the field. An object is
10046
10048
  * accepted on `meta` only — `[{"meta":{"direction":"out"}}]` matches `meta->>direction`.
10047
10049
  * */
10048
10050
  filters?: string;
10049
10051
  /** @description Part of the recipient's name or nickname (`meta.counterparty_account_name`,
10050
10052
  * `meta.counterparty_account_nickname`), case-insensitive. Combines with `filters`,
10051
- * sorting and pagination; `pagination` counts the matches only. Up to 100 characters;
10052
- * `*`, `%`, `"` and `\` are ignored.
10053
+ * sorting and pagination; `pagination` counts the matches only. `*`, `%`, `"` and `\`
10054
+ * are ignored without splitting the word (`des%ign` finds "Design"); `_` matches itself.
10055
+ * Up to 100 characters: a longer value answers 400 `INVALID_REQUEST` with
10056
+ * `details.field` = `search`.
10053
10057
  * */
10054
10058
  search?: string;
10055
10059
  /** @description If `true`, includes dust orders (amount below render threshold for either currency). Defaults to `false` — dust orders are hidden. */
@@ -10072,7 +10076,7 @@ export interface paths {
10072
10076
  "text/csv": string;
10073
10077
  };
10074
10078
  };
10075
- /** @description `INVALID_REQUEST` — `filters` is not a JSON array, `mass_payout_id` / `rfi_case_id` is not a uuid, `scheduled` is not `all` / `upcoming` / `past`, or a filter names an unknown field or carries a value of the wrong type (`details.field` names it) */
10079
+ /** @description `INVALID_REQUEST` — `filters` is not a JSON array, `mass_payout_id` / `rfi_case_id` is not a uuid, `scheduled` is not `all` / `upcoming` / `past`, a filter names an unknown field or carries a value of the wrong type, or `search` is longer than 100 characters (`details.field` names the field) */
10076
10080
  400: {
10077
10081
  headers: {
10078
10082
  [name: string]: unknown;
@@ -2697,8 +2697,8 @@ export interface paths {
2697
2697
  *
2698
2698
  * **Filter Examples:**
2699
2699
  * - Filter by status: `[{"status":"COMPLETE"}]`
2700
- * - Filter by order type: `[{"order_type":"EXCHANGE"}]`
2701
- * - Multiple filters: `[{"status":"PENDING"},{"order_type":"L2F_WIRE_OFFRAMP"}]`
2700
+ * - Filter by order type: `[{"order_type":"EXCHANGE_OMNI"}]`
2701
+ * - Multiple filters: `[{"status":"PENDING"},{"order_type":"WITHDRAWAL_CRYPTO"}]`
2702
2702
  * - Filter by meta field: `[{"meta->>workflow_status":"PROCESSING"}]`
2703
2703
  * - Find an order by your own reference: `[{"meta->>reference":"invoice-2026-04-001"}]`
2704
2704
  *
@@ -2721,7 +2721,7 @@ export interface paths {
2721
2721
  *
2722
2722
  * **Available filter fields:**
2723
2723
  * - `status` - Order status (PENDING, PROCESSING, COMPLETE, FAILED, CANCELED)
2724
- * - `order_type` - Order type (EXCHANGE, WITHDRAWAL_CRYPTO, L2F_WIRE_OFFRAMP, etc.)
2724
+ * - `order_type` - Order type (EXCHANGE_OMNI, WITHDRAWAL_CRYPTO, etc.)
2725
2725
  * - `from_uuid` - Source currency UUID
2726
2726
  * - `to_uuid` - Destination currency UUID
2727
2727
  * - `meta->>key` - JSONB meta field by key with the text operator (e.g., {"meta->>workflow_status":"PROCESSING"})
@@ -2733,7 +2733,7 @@ export interface paths {
2733
2733
  * - By your own reference: `[{"meta->>reference":"invoice-2026-04-001"}]`
2734
2734
  *
2735
2735
  * Every key is checked before the query runs (SFI-2693): an unknown field, a value of the
2736
- * wrong type (e.g. a status that does not exist, a non-uuid id) or an object on a plain
2736
+ * wrong type (e.g. a status that does not exist, an `order_type` that is neither enabled for the tenant — see `/reference/order_types` — nor among the wallet's orders, or a non-uuid id) or an object on a plain
2737
2737
  * field answers 400 `INVALID_REQUEST`, and `details.field` names the field. An object is
2738
2738
  * accepted on `meta` only — `[{"meta":{"direction":"out"}}]` matches `meta->>direction`.
2739
2739
  *
@@ -2746,8 +2746,10 @@ export interface paths {
2746
2746
  date_to?: string;
2747
2747
  /** @description Part of the recipient's name or nickname (`meta.counterparty_account_name`,
2748
2748
  * `meta.counterparty_account_nickname`), case-insensitive. Combines with `filters`,
2749
- * sorting and pagination; `pagination` counts the matches only. Up to 100 characters;
2750
- * `*`, `%`, `"` and `\` are ignored.
2749
+ * sorting and pagination; `pagination` counts the matches only. `*`, `%`, `"` and `\`
2750
+ * are ignored without splitting the word (`des%ign` finds "Design"); `_` matches itself.
2751
+ * Up to 100 characters: a longer value answers 400 `INVALID_REQUEST` with
2752
+ * `details.field` = `search`.
2751
2753
  * */
2752
2754
  search?: string;
2753
2755
  /** @description If `true`, includes dust orders (amount below render threshold for either currency). Defaults to `false` — dust orders are hidden. */
@@ -3383,7 +3383,7 @@ export interface paths {
3383
3383
  * `status`. Malformed JSON or a non-array value is rejected with 400.
3384
3384
  *
3385
3385
  * Every key is checked before the query runs (SFI-2693): an unknown field, a value of the
3386
- * wrong type (e.g. a status that does not exist, a non-uuid id) or an object on a plain
3386
+ * wrong type (e.g. a status that does not exist, an `order_type` that is neither enabled for the tenant — see `/reference/order_types` — nor among the wallet's orders, or a non-uuid id) or an object on a plain
3387
3387
  * field answers 400 `INVALID_REQUEST`, and `details.field` names the field. An object is
3388
3388
  * accepted on `meta` only — `[{"meta":{"direction":"out"}}]` matches `meta->>direction`.
3389
3389
  *
@@ -3396,8 +3396,10 @@ export interface paths {
3396
3396
  date_to?: string;
3397
3397
  /** @description Part of the recipient's name or nickname (`meta.counterparty_account_name`,
3398
3398
  * `meta.counterparty_account_nickname`), case-insensitive. Combines with `filters`,
3399
- * sorting and pagination; `pagination` counts the matches only. Up to 100 characters;
3400
- * `*`, `%`, `"` and `\` are ignored.
3399
+ * sorting and pagination; `pagination` counts the matches only. `*`, `%`, `"` and `\`
3400
+ * are ignored without splitting the word (`des%ign` finds "Design"); `_` matches itself.
3401
+ * Up to 100 characters: a longer value answers 400 `INVALID_REQUEST` with
3402
+ * `details.field` = `search`.
3401
3403
  * */
3402
3404
  search?: string;
3403
3405
  /** @description If `true`, includes dust orders (amount below render threshold for either currency). Defaults to `false` — dust orders are hidden. */
@@ -3425,7 +3427,7 @@ export interface paths {
3425
3427
  };
3426
3428
  };
3427
3429
  };
3428
- /** @description Invalid `filters` (not a JSON array), non-uuid `mass_payout_id`, `scheduled` other than `all` / `upcoming` / `past`, or a filter with an unknown field or a value of the wrong type (`details.field` names it) */
3430
+ /** @description Invalid `filters` (not a JSON array), non-uuid `mass_payout_id`, `scheduled` other than `all` / `upcoming` / `past`, a filter with an unknown field or a value of the wrong type, or `search` longer than 100 characters (`details.field` names the field) */
3429
3431
  400: {
3430
3432
  headers: {
3431
3433
  [name: string]: unknown;
@@ -891,6 +891,15 @@ export declare namespace API {
891
891
  }
892
892
  export {};
893
893
  }
894
+ namespace OrderTypes {
895
+ type OrderTypesRoot = pathsV1Frontend['/frontend/reference/order_types'];
896
+ export type OrderType = componentsV1Frontend['schemas']['ReferenceOrderType'];
897
+ export namespace List {
898
+ type Request = NonNullable<OrderTypesRoot['get']['parameters']['query']>;
899
+ type Response = OrderTypesRoot['get']['responses'][200]['content']['application/json'];
900
+ }
901
+ export {};
902
+ }
894
903
  }
895
904
  namespace NotificationPreferences {
896
905
  type NotificationPreferencesRoot = pathsV1Frontend['/frontend/notification-preferences'];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "squarefi-bff-api-module",
3
- "version": "1.36.92",
3
+ "version": "1.36.93",
4
4
  "description": "Squarefi BFF API client module",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",