squarefi-bff-api-module 1.36.38 → 1.36.39

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.
@@ -5013,8 +5013,16 @@ export interface paths {
5013
5013
  * @example b2f3d8c1-4a7e-4d22-9c5f-1e6a8d0b2a44
5014
5014
  */
5015
5015
  counterparty_destination_id: string;
5016
- /** @example 50 */
5016
+ /**
5017
+ * @description Amount to send, in `from_currency_id` units. With `is_reverse: true` — the amount the receiver must be credited.
5018
+ * @example 50
5019
+ */
5017
5020
  amount: number;
5021
+ /**
5022
+ * @description Optional. When true, `amount` is the receive-amount and the debited amount is grossed up with fees.
5023
+ * @default false
5024
+ */
5025
+ is_reverse?: boolean;
5018
5026
  /**
5019
5027
  * Format: date-time
5020
5028
  * @description Optional. Schedule the transfer for a future time (min 1 hour, max 90 days ahead). No funds are reserved; after approval the order waits in EXPECTED status and executes automatically.
@@ -5969,8 +5969,8 @@ export interface paths {
5969
5969
  cookie?: never;
5970
5970
  };
5971
5971
  /**
5972
- * Effective delivery-channel preferences
5973
- * @description Full channel list with defaults applied. `IN_APP` is always enabled (cannot be disabled).
5972
+ * Effective notification preferences
5973
+ * @description Both dimensions in full with defaults applied — delivery channels (`IN_APP` is always enabled) and notification categories (every category is user-configurable).
5974
5974
  */
5975
5975
  get: {
5976
5976
  parameters: {
@@ -5981,7 +5981,7 @@ export interface paths {
5981
5981
  };
5982
5982
  requestBody?: never;
5983
5983
  responses: {
5984
- /** @description Effective preference per channel. */
5984
+ /** @description Effective preference per channel and per category. */
5985
5985
  200: {
5986
5986
  headers: {
5987
5987
  [name: string]: unknown;
@@ -5992,6 +5992,7 @@ export interface paths {
5992
5992
  success?: boolean;
5993
5993
  data?: {
5994
5994
  preferences?: components["schemas"]["NotificationPreference"][];
5995
+ categories?: components["schemas"]["NotificationCategoryPreference"][];
5995
5996
  };
5996
5997
  };
5997
5998
  };
@@ -6000,8 +6001,8 @@ export interface paths {
6000
6001
  };
6001
6002
  };
6002
6003
  /**
6003
- * Update delivery-channel preferences
6004
- * @description Bulk upsert. Disabling `IN_APP` is rejected with 400 (`INBOX_CHANNEL_LOCKED`). Changes apply from the next delivery.
6004
+ * Update notification preferences
6005
+ * @description Bulk upsert of either or both dimensions. Disabling the `IN_APP` channel is rejected with 400 (`INBOX_CHANNEL_LOCKED`). A disabled category mutes push and email for its notifications; the inbox always receives them. Changes apply from the next delivery.
6005
6006
  */
6006
6007
  put: {
6007
6008
  parameters: {
@@ -6013,12 +6014,13 @@ export interface paths {
6013
6014
  requestBody: {
6014
6015
  content: {
6015
6016
  "application/json": {
6016
- preferences: components["schemas"]["NotificationPreference"][];
6017
+ preferences?: components["schemas"]["NotificationPreference"][];
6018
+ categories?: components["schemas"]["NotificationCategoryPreference"][];
6017
6019
  };
6018
6020
  };
6019
6021
  };
6020
6022
  responses: {
6021
- /** @description Effective preference list after the update. */
6023
+ /** @description Effective preferences of both dimensions after the update. */
6022
6024
  200: {
6023
6025
  headers: {
6024
6026
  [name: string]: unknown;
@@ -6029,6 +6031,7 @@ export interface paths {
6029
6031
  success?: boolean;
6030
6032
  data?: {
6031
6033
  preferences?: components["schemas"]["NotificationPreference"][];
6034
+ categories?: components["schemas"]["NotificationCategoryPreference"][];
6032
6035
  };
6033
6036
  };
6034
6037
  };
@@ -6598,7 +6601,13 @@ export interface paths {
6598
6601
  * @description Counterparty destination of type INTERNAL (points at the receiver wallet).
6599
6602
  */
6600
6603
  counterparty_destination_id: string;
6604
+ /** @description Amount to send, in `from_currency_id` units. With `is_reverse: true` — the amount the receiver must be credited. */
6601
6605
  amount: number;
6606
+ /**
6607
+ * @description When true, `amount` is the receive-amount and the debited amount is grossed up with fees.
6608
+ * @default false
6609
+ */
6610
+ is_reverse?: boolean;
6602
6611
  /**
6603
6612
  * Format: date-time
6604
6613
  * @description Optional. Schedule the transfer for a future time (min 1 hour, max 90 days ahead). No funds are reserved; after approval the order waits in EXPECTED status and executes automatically.
@@ -13005,7 +13014,12 @@ export interface components {
13005
13014
  };
13006
13015
  NotificationPreference: {
13007
13016
  /** @enum {string} */
13008
- channel: "IN_APP" | "PUSH";
13017
+ channel: "IN_APP" | "PUSH" | "EMAIL";
13018
+ enabled: boolean;
13019
+ };
13020
+ NotificationCategoryPreference: {
13021
+ /** @enum {string} */
13022
+ category: "TRANSACTIONS" | "COMPLIANCE";
13009
13023
  enabled: boolean;
13010
13024
  };
13011
13025
  };
@@ -2570,7 +2570,13 @@ export interface paths {
2570
2570
  * @description Counterparty destination of type INTERNAL (points at the receiver wallet).
2571
2571
  */
2572
2572
  counterparty_destination_id: string;
2573
+ /** @description Amount to send, in `from_currency_id` units. With `is_reverse: true` — the amount the receiver must be credited. */
2573
2574
  amount: number;
2575
+ /**
2576
+ * @description When true, `amount` is the receive-amount and the debited amount is grossed up with fees.
2577
+ * @default false
2578
+ */
2579
+ is_reverse?: boolean;
2574
2580
  /**
2575
2581
  * Format: date-time
2576
2582
  * @description Optional. Schedule the transfer for a future time (min 1 hour, max 90 days ahead). No funds are reserved; after approval the order waits in EXPECTED status and executes automatically.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "squarefi-bff-api-module",
3
- "version": "1.36.38",
3
+ "version": "1.36.39",
4
4
  "description": "Squarefi BFF API client module",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",