rebilly-js-sdk 62.231.0 → 62.233.0

package/CHANGELOG.md

@@ -1,3 +1,3 @@
-## 62.231.0 (2026-10-22)
+## 62.233.0 (2026-10-22)
 
 This was a version bump only for rebilly-js-sdk to align it with other projects, there were no code changes.

package/dist/rebilly-js-sdk.d.cts

@@ -5590,7 +5590,8 @@ export interface corePaths {
      *
      * The `type` field specifies the action:
      * - `approve`: Approves payout requests in the `ready` status.
-     * - `block`: Blocks payout requests that are not blocked and can be blocked in their current status.
+     * - `block`: Blocks payout requests that can be blocked in their current status.
+     *   If `overwriteExisting` is `true`, already blocked payout requests receive the new block reason.
      * - `unblock`: Removes the block from blocked payout requests.
      * - `auto-allocate`: Creates allocations automatically for payout requests that can be allocated.
      * - `process`: Queues pending allocations of the payout requests in the batch for processing.
@@ -13799,7 +13800,11 @@ export interface coreComponents {
       canceledTime?: string | null;
       /** Specifies who initiated the cancellation. */
       canceledBy?: ("merchant" | "customer" | "rebilly") | null;
-      /** Category of the cancellation. */
+      /**
+       * Category of the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       */
       cancelCategory?:
         | (
             | "billing-failure"
@@ -13815,6 +13820,7 @@ export interface coreComponents {
             | "never-started"
             | "switched-plan"
             | "organization-deactivated"
+            | "sandbox-retention"
             | "other"
           )
         | null;
@@ -14451,7 +14457,11 @@ export interface coreComponents {
       cancellationTime?: string | null;
       /** Specifies who initiated the cancellation. */
       canceledBy?: ("merchant" | "customer" | "rebilly") | null;
-      /** Category of the cancellation. */
+      /**
+       * Category of the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       */
       cancelCategory?:
         | (
             | "billing-failure"
@@ -14465,6 +14475,9 @@ export interface coreComponents {
             | "too-expensive"
             | "never-started"
             | "switched-plan"
+            | "organization-deactivated"
+            | "delinquency"
+            | "sandbox-retention"
             | "other"
           )
         | null;
@@ -14765,7 +14778,12 @@ export interface coreComponents {
       appliedInvoiceId?: string | null;
       /** Specifies who initiated the cancellation. */
       canceledBy?: "merchant" | "customer" | "rebilly";
-      /** Reason for the cancellation. */
+      /**
+       * Reason for the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       * If a request includes it, a validation error is returned.
+       */
       reason?:
         | "did-not-use"
         | "did-not-want"
@@ -14776,7 +14794,10 @@ export interface coreComponents {
         | "contract-expired"
         | "too-expensive"
         | "other"
-        | "billing-failure";
+        | "billing-failure"
+        | "delinquency"
+        | "organization-deactivated"
+        | "sandbox-retention";
       /** Description of the cancellation reason in free form. */
       description?: string;
       /** Specifies if the customer gets a pro-rata credit for the time remaining between `churnTime` and order next renewal time. */
@@ -15061,7 +15082,12 @@ export interface coreComponents {
       appliedInvoiceId?: string | null;
       /** Specifies who initiated the cancellation. */
       canceledBy?: "merchant" | "customer" | "rebilly";
-      /** Reason for the cancellation. */
+      /**
+       * Reason for the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       * If a request includes it, a validation error is returned.
+       */
       reason?:
         | "did-not-use"
         | "did-not-want"
@@ -15072,7 +15098,10 @@ export interface coreComponents {
         | "contract-expired"
         | "too-expensive"
         | "other"
-        | "billing-failure";
+        | "billing-failure"
+        | "delinquency"
+        | "organization-deactivated"
+        | "sandbox-retention";
       /** Description of the cancellation reason in free form. */
       description?: string;
       /** Specifies if the customer gets a pro-rata credit for the time remaining between `churnTime` and subscription next renewal time. */
@@ -23219,6 +23248,8 @@ export interface coreComponents {
       reason: coreComponents["schemas"]["PayoutRequestBlockReason"];
       /** Additional description for blocking the payout requests in the batch. */
       description?: string | null;
+      /** Specifies if already blocked payout requests in the batch receive the new block reason. */
+      overwriteExisting?: boolean;
     };
     UnblockPayoutRequestBatchOperation: {
       /** Type of operation that removes the block from payout requests in the batch. */
@@ -26999,7 +27030,11 @@ export interface coreComponents {
       canceledTime?: string;
       /** Specifies who initiated the cancellation. */
       canceledBy?: "merchant" | "customer" | "rebilly";
-      /** Category of the cancellation. */
+      /**
+       * Category of the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       */
       cancelCategory?:
         | "billing-failure"
         | "delinquency"
@@ -27014,6 +27049,7 @@ export interface coreComponents {
         | "never-started"
         | "switched-plan"
         | "organization-deactivated"
+        | "sandbox-retention"
         | "other";
       /** Description of the cancellation reason in free form. */
       cancelDescription?: string;
@@ -43821,7 +43857,8 @@ export interface operations {
    *
    * The `type` field specifies the action:
    * - `approve`: Approves payout requests in the `ready` status.
-   * - `block`: Blocks payout requests that are not blocked and can be blocked in their current status.
+   * - `block`: Blocks payout requests that can be blocked in their current status.
+   *   If `overwriteExisting` is `true`, already blocked payout requests receive the new block reason.
    * - `unblock`: Removes the block from blocked payout requests.
    * - `auto-allocate`: Creates allocations automatically for payout requests that can be allocated.
    * - `process`: Queues pending allocations of the payout requests in the batch for processing.
@@ -54046,7 +54083,11 @@ export interface storefrontComponents {
       canceledTime?: string | null;
       /** Specifies who initiated the cancellation. */
       canceledBy?: ("merchant" | "customer" | "rebilly") | null;
-      /** Category of the cancellation. */
+      /**
+       * Category of the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       */
       cancelCategory?:
         | (
             | "billing-failure"
@@ -54062,6 +54103,7 @@ export interface storefrontComponents {
             | "never-started"
             | "switched-plan"
             | "organization-deactivated"
+            | "sandbox-retention"
             | "other"
           )
         | null;
@@ -54698,7 +54740,11 @@ export interface storefrontComponents {
       cancellationTime?: string | null;
       /** Specifies who initiated the cancellation. */
       canceledBy?: ("merchant" | "customer" | "rebilly") | null;
-      /** Category of the cancellation. */
+      /**
+       * Category of the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       */
       cancelCategory?:
         | (
             | "billing-failure"
@@ -54712,6 +54758,9 @@ export interface storefrontComponents {
             | "too-expensive"
             | "never-started"
             | "switched-plan"
+            | "organization-deactivated"
+            | "delinquency"
+            | "sandbox-retention"
             | "other"
           )
         | null;
@@ -55012,7 +55061,12 @@ export interface storefrontComponents {
       appliedInvoiceId?: string | null;
       /** Specifies who initiated the cancellation. */
       canceledBy?: "merchant" | "customer" | "rebilly";
-      /** Reason for the cancellation. */
+      /**
+       * Reason for the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       * If a request includes it, a validation error is returned.
+       */
       reason?:
         | "did-not-use"
         | "did-not-want"
@@ -55023,7 +55077,10 @@ export interface storefrontComponents {
         | "contract-expired"
         | "too-expensive"
         | "other"
-        | "billing-failure";
+        | "billing-failure"
+        | "delinquency"
+        | "organization-deactivated"
+        | "sandbox-retention";
       /** Description of the cancellation reason in free form. */
       description?: string;
       /** Specifies if the customer gets a pro-rata credit for the time remaining between `churnTime` and order next renewal time. */
@@ -55308,7 +55365,12 @@ export interface storefrontComponents {
       appliedInvoiceId?: string | null;
       /** Specifies who initiated the cancellation. */
       canceledBy?: "merchant" | "customer" | "rebilly";
-      /** Reason for the cancellation. */
+      /**
+       * Reason for the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       * If a request includes it, a validation error is returned.
+       */
       reason?:
         | "did-not-use"
         | "did-not-want"
@@ -55319,7 +55381,10 @@ export interface storefrontComponents {
         | "contract-expired"
         | "too-expensive"
         | "other"
-        | "billing-failure";
+        | "billing-failure"
+        | "delinquency"
+        | "organization-deactivated"
+        | "sandbox-retention";
       /** Description of the cancellation reason in free form. */
       description?: string;
       /** Specifies if the customer gets a pro-rata credit for the time remaining between `churnTime` and subscription next renewal time. */
@@ -63466,6 +63531,8 @@ export interface storefrontComponents {
       reason: storefrontComponents["schemas"]["PayoutRequestBlockReason"];
       /** Additional description for blocking the payout requests in the batch. */
       description?: string | null;
+      /** Specifies if already blocked payout requests in the batch receive the new block reason. */
+      overwriteExisting?: boolean;
     };
     UnblockPayoutRequestBatchOperation: {
       /** Type of operation that removes the block from payout requests in the batch. */
@@ -67246,7 +67313,11 @@ export interface storefrontComponents {
       canceledTime?: string;
       /** Specifies who initiated the cancellation. */
       canceledBy?: "merchant" | "customer" | "rebilly";
-      /** Category of the cancellation. */
+      /**
+       * Category of the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       */
       cancelCategory?:
         | "billing-failure"
         | "delinquency"
@@ -67261,6 +67332,7 @@ export interface storefrontComponents {
         | "never-started"
         | "switched-plan"
         | "organization-deactivated"
+        | "sandbox-retention"
         | "other";
       /** Description of the cancellation reason in free form. */
       cancelDescription?: string;
@@ -81521,7 +81593,11 @@ export interface reportsComponents {
       canceledTime?: string | null;
       /** Specifies who initiated the cancellation. */
       canceledBy?: ("merchant" | "customer" | "rebilly") | null;
-      /** Category of the cancellation. */
+      /**
+       * Category of the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       */
       cancelCategory?:
         | (
             | "billing-failure"
@@ -81537,6 +81613,7 @@ export interface reportsComponents {
             | "never-started"
             | "switched-plan"
             | "organization-deactivated"
+            | "sandbox-retention"
             | "other"
           )
         | null;
@@ -82173,7 +82250,11 @@ export interface reportsComponents {
       cancellationTime?: string | null;
       /** Specifies who initiated the cancellation. */
       canceledBy?: ("merchant" | "customer" | "rebilly") | null;
-      /** Category of the cancellation. */
+      /**
+       * Category of the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       */
       cancelCategory?:
         | (
             | "billing-failure"
@@ -82187,6 +82268,9 @@ export interface reportsComponents {
             | "too-expensive"
             | "never-started"
             | "switched-plan"
+            | "organization-deactivated"
+            | "delinquency"
+            | "sandbox-retention"
             | "other"
           )
         | null;
@@ -82487,7 +82571,12 @@ export interface reportsComponents {
       appliedInvoiceId?: string | null;
       /** Specifies who initiated the cancellation. */
       canceledBy?: "merchant" | "customer" | "rebilly";
-      /** Reason for the cancellation. */
+      /**
+       * Reason for the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       * If a request includes it, a validation error is returned.
+       */
       reason?:
         | "did-not-use"
         | "did-not-want"
@@ -82498,7 +82587,10 @@ export interface reportsComponents {
         | "contract-expired"
         | "too-expensive"
         | "other"
-        | "billing-failure";
+        | "billing-failure"
+        | "delinquency"
+        | "organization-deactivated"
+        | "sandbox-retention";
       /** Description of the cancellation reason in free form. */
       description?: string;
       /** Specifies if the customer gets a pro-rata credit for the time remaining between `churnTime` and order next renewal time. */
@@ -82783,7 +82875,12 @@ export interface reportsComponents {
       appliedInvoiceId?: string | null;
       /** Specifies who initiated the cancellation. */
       canceledBy?: "merchant" | "customer" | "rebilly";
-      /** Reason for the cancellation. */
+      /**
+       * Reason for the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       * If a request includes it, a validation error is returned.
+       */
       reason?:
         | "did-not-use"
         | "did-not-want"
@@ -82794,7 +82891,10 @@ export interface reportsComponents {
         | "contract-expired"
         | "too-expensive"
         | "other"
-        | "billing-failure";
+        | "billing-failure"
+        | "delinquency"
+        | "organization-deactivated"
+        | "sandbox-retention";
       /** Description of the cancellation reason in free form. */
       description?: string;
       /** Specifies if the customer gets a pro-rata credit for the time remaining between `churnTime` and subscription next renewal time. */
@@ -90941,6 +91041,8 @@ export interface reportsComponents {
       reason: reportsComponents["schemas"]["PayoutRequestBlockReason"];
       /** Additional description for blocking the payout requests in the batch. */
       description?: string | null;
+      /** Specifies if already blocked payout requests in the batch receive the new block reason. */
+      overwriteExisting?: boolean;
     };
     UnblockPayoutRequestBatchOperation: {
       /** Type of operation that removes the block from payout requests in the batch. */
@@ -94721,7 +94823,11 @@ export interface reportsComponents {
       canceledTime?: string;
       /** Specifies who initiated the cancellation. */
       canceledBy?: "merchant" | "customer" | "rebilly";
-      /** Category of the cancellation. */
+      /**
+       * Category of the cancellation.
+       *
+       * The `sandbox-retention` value is set only in the sandbox environment when a recurring order is canceled 90 days after creation.
+       */
       cancelCategory?:
         | "billing-failure"
         | "delinquency"
@@ -94736,6 +94842,7 @@ export interface reportsComponents {
         | "never-started"
         | "switched-plan"
         | "organization-deactivated"
+        | "sandbox-retention"
         | "other";
       /** Description of the cancellation reason in free form. */
       cancelDescription?: string;