@rebilly/api 0.22.2 → 0.22.3

package/CHANGELOG.md

@@ -1,3 +1,3 @@
-## 0.22.2 (2026-11-11)
+## 0.22.3 (2026-11-11)
 
 This was a version bump only for rebilly-api to align it with other projects, there were no code changes.

package/dist/core-client.d.ts

@@ -8206,6 +8206,10 @@ export type PatchPayoutRequestBody = {
     canceledBy?: "customer" | "merchant" | "system";
     /**
      * Description of the cancellation reason.
+     * When a blocked payout request is canceled, the block reason is added to this description.
+     * For example, `Fraud confirmed` becomes `Fraud confirmed (blocked: fraud-suspected)`.
+     * If this field is omitted, the description is the block reason only, such as `blocked: fraud-suspected`.
+     * If the combined text is longer than 255 characters, the text before the block reason is shortened to fit.
      * @minLength 1
      * @maxLength 255
      */
@@ -8215,17 +8219,19 @@ export type PatchPayoutRequestBody = {
      */
     description?: string | null;
     /**
-     * Specifies whether the payout request is blocked or unblocked.
+     * Specifies if the payout request is blocked or unblocked.
      * This field can only be applied to payout requests in the following statuses:
      * `pending`, `ready`, `approved`, or `in-progress`.
      *
      * When a payout request is blocked, it cannot:
-     * - Transition to `ready`, `approved`, `in-progress`, `merged`, `split`, or `canceled`.
+     * - Transition to `ready`, `approved`, `in-progress`, `merged`, or `split`.
      * - Have allocations created.
      * - Start allocation processing.
-     * - Cancel pending allocations.
      *
-     * A blocked payout request can still transition to the `fulfilled` status if allocation processing starts before the payout request is blocked.
+     * Cancellation of the payout request and pending allocations remains available.
+     * When a blocked payout request is canceled, `blocked` is set to `false`, `blockReason` is set to `null`,
+     * and the block reason is added to `cancellationDescription`.
+     * If allocation processing starts before the payout request is blocked, the request still transitions to the `fulfilled` status.
      */
     blocked?: boolean;
     blockReason?: PayoutRequestBlockReason | null;

package/dist/core-client.schemas.d.ts

@@ -13559,11 +13559,14 @@ export type PayoutRequest = {
      */
     readonly status?: "pending" | "ready" | "approved" | "in-progress" | "fulfilled" | "canceled" | "split" | "merged";
     /**
-     * Specifies whether the payout request is blocked or unblocked.
+     * Specifies if the payout request is blocked or unblocked.
      *
-     * When blocked, the payout request cannot transition to `ready`, `approved`, `in-progress`, `merged`, `split`, or `canceled`.
-     * Allocation creation, allocation processing, and cancellation of pending allocations are also prevented.
-     * A blocked payout request can still transition to the `fulfilled` status if allocation processing starts before the payout request is blocked.
+     * When blocked, the payout request cannot transition to `ready`, `approved`, `in-progress`, `merged`, or `split`.
+     * Allocation creation and allocation processing are also blocked.
+     * Cancellation of the payout request and pending allocations remains available.
+     * When a blocked payout request is canceled, `blocked` is set to `false`, `blockReason` is set to `null`,
+     * and the block reason is added to the cancellation description.
+     * If allocation processing starts before the payout request is blocked, the request still transitions to the `fulfilled` status.
      */
     blocked?: boolean;
     blockReason?: PayoutRequestBlockReason | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rebilly/api",
-  "version": "0.22.2",
+  "version": "0.22.3",
   "description": "Rebilly Core and Storefront API clients generated from the OpenAPI definitions",
   "type": "module",
   "sideEffects": false,