@rebuy/rebuy 3.41.0 → 3.42.0

package/dist/schema/index.d.ts

@@ -55,6 +55,7 @@ export * from './postPurchaseSubscription';
 export * from './postPurchaseSubscriptionDisplay';
 export { PreparedPostPurchaseSubscription } from './postPurchaseSubscriptionProduct';
 export * from './postPurchaseTransition';
+export * from './postPurchaseUpgrade';
 export * from './postPurchaseVariantCatalog';
 export * from './postPurchaseVariantDefault';
 export * from './postPurchaseVariantDefaultContext';

package/dist/schema/postPurchaseAdmission.d.ts

@@ -1,4 +1,12 @@
 import { z } from 'zod';
+/**
+ * Absent means `purchase`, so every pre-upgrade wire is unchanged. `upgrade` adds the selected subscription and
+ * refunds the buyer's original one-time line of the same variant; the server binds that line, never the client.
+ */
+export declare const PurchaseAdmissionModeSchema: z.ZodEnum<{
+    purchase: "purchase";
+    upgrade: "upgrade";
+}>;
 export declare const PurchaseExpectedSchema: z.ZodObject<{
     buyerConsentToSubscriptions: z.ZodOptional<z.ZodBoolean>;
     changeset: z.ZodObject<{
@@ -52,6 +60,10 @@ export declare const PurchaseExpectedSchema: z.ZodObject<{
         productId: z.ZodNumber;
         productIndex: z.ZodNumber;
     }, z.core.$strict>>;
+    mode: z.ZodOptional<z.ZodEnum<{
+        purchase: "purchase";
+        upgrade: "upgrade";
+    }>>;
     progressRevision: z.ZodOptional<z.ZodNumber>;
     selection: z.ZodObject<{
         productId: z.ZodNumber;
@@ -116,6 +128,10 @@ export declare const PurchaseRequestSchema: z.ZodObject<{
             productId: z.ZodNumber;
             productIndex: z.ZodNumber;
         }, z.core.$strict>>;
+        mode: z.ZodOptional<z.ZodEnum<{
+            purchase: "purchase";
+            upgrade: "upgrade";
+        }>>;
         progressRevision: z.ZodOptional<z.ZodNumber>;
         selection: z.ZodObject<{
             productId: z.ZodNumber;
@@ -129,7 +145,15 @@ export declare const PurchaseRequestSchema: z.ZodObject<{
 export declare const PurchaseReceiptSchema: z.ZodObject<{
     admittedAt: z.ZodNumber;
     changesetToken: z.ZodString;
+    mode: z.ZodOptional<z.ZodEnum<{
+        purchase: "purchase";
+        upgrade: "upgrade";
+    }>>;
     operationId: z.ZodUUID;
+    originalLine: z.ZodOptional<z.ZodObject<{
+        quantity: z.ZodNumber;
+        variantId: z.ZodNumber;
+    }, z.core.$strict>>;
     requiresSubscriptionConsent: z.ZodBoolean;
     selection: z.ZodObject<{
         productId: z.ZodNumber;
@@ -142,7 +166,15 @@ export declare const PurchaseResponseSchema: z.ZodObject<{
     data: z.ZodObject<{
         admittedAt: z.ZodNumber;
         changesetToken: z.ZodString;
+        mode: z.ZodOptional<z.ZodEnum<{
+            purchase: "purchase";
+            upgrade: "upgrade";
+        }>>;
         operationId: z.ZodUUID;
+        originalLine: z.ZodOptional<z.ZodObject<{
+            quantity: z.ZodNumber;
+            variantId: z.ZodNumber;
+        }, z.core.$strict>>;
         requiresSubscriptionConsent: z.ZodBoolean;
         selection: z.ZodObject<{
             productId: z.ZodNumber;
@@ -156,3 +188,4 @@ export declare const PurchaseResponseSchema: z.ZodObject<{
 export type PurchaseReceipt = z.infer<typeof PurchaseReceiptSchema>;
 export type PurchaseExpected = z.infer<typeof PurchaseExpectedSchema>;
 export type PurchaseRequest = z.infer<typeof PurchaseRequestSchema>;
+export type PurchaseAdmissionMode = z.infer<typeof PurchaseAdmissionModeSchema>;

package/dist/schema/postPurchaseFollowups.d.ts

@@ -125,6 +125,53 @@ export declare const AcceptedFollowupsResponseSchema: z.ZodObject<{
             recordedAt: z.ZodNumber;
             operationId: z.ZodUUID;
         }, z.core.$strict>;
+        upgrade: z.ZodOptional<z.ZodObject<{
+            compensation: z.ZodNullable<z.ZodUnion<readonly [z.ZodObject<{
+                attemptedAt: z.ZodNumber;
+                status: z.ZodLiteral<"attempted">;
+            }, z.core.$strict>, z.ZodObject<{
+                attemptedAt: z.ZodNumber;
+                finishedAt: z.ZodNumber;
+                status: z.ZodEnum<{
+                    unknown: "unknown";
+                    failed: "failed";
+                    removed: "removed";
+                }>;
+            }, z.core.$strict>]>>;
+            operationId: z.ZodUUID;
+            refund: z.ZodNullable<z.ZodUnion<readonly [z.ZodObject<{
+                attemptedAt: z.ZodNumber;
+                status: z.ZodLiteral<"attempted">;
+            }, z.core.$strict>, z.ZodObject<{
+                attemptedAt: z.ZodNumber;
+                finishedAt: z.ZodNumber;
+                refundId: z.ZodString;
+                status: z.ZodLiteral<"refunded">;
+            }, z.core.$strict>, z.ZodObject<{
+                attemptedAt: z.ZodNumber;
+                finishedAt: z.ZodNumber;
+                status: z.ZodEnum<{
+                    unknown: "unknown";
+                    failed: "failed";
+                }>;
+            }, z.core.$strict>]>>;
+            review: z.ZodNullable<z.ZodObject<{
+                markedAt: z.ZodNumber;
+                marker: z.ZodUnion<readonly [z.ZodEnum<{
+                    unknown: "unknown";
+                    acknowledged: "acknowledged";
+                    rejected: "rejected";
+                }>, z.ZodEnum<{
+                    attempted: "attempted";
+                    unavailable: "unavailable";
+                }>]>;
+                reason: z.ZodEnum<{
+                    "refund-unknown": "refund-unknown";
+                    "compensation-failed": "compensation-failed";
+                    "compensation-unknown": "compensation-unknown";
+                }>;
+            }, z.core.$strict>>;
+        }, z.core.$strict>>;
     }, z.core.$strip>;
     successful: z.ZodLiteral<true>;
 }, z.core.$strip>;

package/dist/schema/postPurchaseProductCollectionView.d.ts

@@ -5,6 +5,44 @@ export declare const PostPurchaseProductCollectionView: z.ZodObject<{
         productId: z.ZodNumber;
         productIndex: z.ZodNumber;
         view: z.ZodUnion<readonly [z.ZodObject<{
+            changeset: z.ZodOptional<z.ZodObject<{
+                changes: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+                    discount: z.ZodOptional<z.ZodObject<{
+                        title: z.ZodString;
+                        value: z.ZodNumber;
+                        valueType: z.ZodEnum<{
+                            fixed_amount: "fixed_amount";
+                            percentage: "percentage";
+                        }>;
+                    }, z.core.$strip>>;
+                    quantity: z.ZodNumber;
+                    type: z.ZodLiteral<"add_variant">;
+                    variantId: z.ZodNumber;
+                }, z.core.$strip>, z.ZodObject<{
+                    price: z.ZodNumber;
+                    title: z.ZodString;
+                    type: z.ZodLiteral<"add_shipping_line">;
+                }, z.core.$strip>, z.ZodObject<{
+                    initialShippingPrice: z.ZodNumber;
+                    recurringShippingPrice: z.ZodNumber;
+                    shippingOption: z.ZodObject<{
+                        presentmentTitle: z.ZodString;
+                        title: z.ZodString;
+                    }, z.core.$strip>;
+                    discount: z.ZodOptional<z.ZodObject<{
+                        title: z.ZodString;
+                        value: z.ZodNumber;
+                        valueType: z.ZodEnum<{
+                            fixed_amount: "fixed_amount";
+                            percentage: "percentage";
+                        }>;
+                    }, z.core.$strip>>;
+                    quantity: z.ZodNumber;
+                    sellingPlanId: z.ZodNumber;
+                    type: z.ZodLiteral<"add_subscription">;
+                    variantId: z.ZodNumber;
+                }, z.core.$strip>]>>;
+            }, z.core.$strip>>;
             groupCatalog: z.ZodOptional<z.ZodObject<{
                 memberProductId: z.ZodNumber;
                 options: z.ZodArray<z.ZodObject<{

package/dist/schema/postPurchaseProductView.d.ts

@@ -2,8 +2,48 @@ import { z } from 'zod';
 /**
  * A prepared view shows exactly one description: plain `description`, or — when the merchant's rich
  * description wins the precedence — `description: null` with the standard-shape `descriptionDocument`.
+ * Only a prepared view may carry `changeset`: the unsigned changeset the server derived from this very
+ * preparation (the one admission later rebuilds and signs), ready for Shopify's `calculateChangeset`.
  */
 export declare const PostPurchaseProductView: z.ZodUnion<readonly [z.ZodObject<{
+    changeset: z.ZodOptional<z.ZodObject<{
+        changes: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+            discount: z.ZodOptional<z.ZodObject<{
+                title: z.ZodString;
+                value: z.ZodNumber;
+                valueType: z.ZodEnum<{
+                    fixed_amount: "fixed_amount";
+                    percentage: "percentage";
+                }>;
+            }, z.core.$strip>>;
+            quantity: z.ZodNumber;
+            type: z.ZodLiteral<"add_variant">;
+            variantId: z.ZodNumber;
+        }, z.core.$strip>, z.ZodObject<{
+            price: z.ZodNumber;
+            title: z.ZodString;
+            type: z.ZodLiteral<"add_shipping_line">;
+        }, z.core.$strip>, z.ZodObject<{
+            initialShippingPrice: z.ZodNumber;
+            recurringShippingPrice: z.ZodNumber;
+            shippingOption: z.ZodObject<{
+                presentmentTitle: z.ZodString;
+                title: z.ZodString;
+            }, z.core.$strip>;
+            discount: z.ZodOptional<z.ZodObject<{
+                title: z.ZodString;
+                value: z.ZodNumber;
+                valueType: z.ZodEnum<{
+                    fixed_amount: "fixed_amount";
+                    percentage: "percentage";
+                }>;
+            }, z.core.$strip>>;
+            quantity: z.ZodNumber;
+            sellingPlanId: z.ZodNumber;
+            type: z.ZodLiteral<"add_subscription">;
+            variantId: z.ZodNumber;
+        }, z.core.$strip>]>>;
+    }, z.core.$strip>>;
     groupCatalog: z.ZodOptional<z.ZodObject<{
         memberProductId: z.ZodNumber;
         options: z.ZodArray<z.ZodObject<{

package/dist/schema/postPurchaseRecovery.d.ts

@@ -39,6 +39,53 @@ export declare const PurchaseRecoveryResponseSchema: z.ZodObject<{
                 recordedAt: z.ZodNumber;
             }, z.core.$strict>>;
             operationId: z.ZodUUID;
+            upgrade: z.ZodOptional<z.ZodObject<{
+                compensation: z.ZodNullable<z.ZodUnion<readonly [z.ZodObject<{
+                    attemptedAt: z.ZodNumber;
+                    status: z.ZodLiteral<"attempted">;
+                }, z.core.$strict>, z.ZodObject<{
+                    attemptedAt: z.ZodNumber;
+                    finishedAt: z.ZodNumber;
+                    status: z.ZodEnum<{
+                        unknown: "unknown";
+                        failed: "failed";
+                        removed: "removed";
+                    }>;
+                }, z.core.$strict>]>>;
+                operationId: z.ZodUUID;
+                refund: z.ZodNullable<z.ZodUnion<readonly [z.ZodObject<{
+                    attemptedAt: z.ZodNumber;
+                    status: z.ZodLiteral<"attempted">;
+                }, z.core.$strict>, z.ZodObject<{
+                    attemptedAt: z.ZodNumber;
+                    finishedAt: z.ZodNumber;
+                    refundId: z.ZodString;
+                    status: z.ZodLiteral<"refunded">;
+                }, z.core.$strict>, z.ZodObject<{
+                    attemptedAt: z.ZodNumber;
+                    finishedAt: z.ZodNumber;
+                    status: z.ZodEnum<{
+                        unknown: "unknown";
+                        failed: "failed";
+                    }>;
+                }, z.core.$strict>]>>;
+                review: z.ZodNullable<z.ZodObject<{
+                    markedAt: z.ZodNumber;
+                    marker: z.ZodUnion<readonly [z.ZodEnum<{
+                        unknown: "unknown";
+                        acknowledged: "acknowledged";
+                        rejected: "rejected";
+                    }>, z.ZodEnum<{
+                        attempted: "attempted";
+                        unavailable: "unavailable";
+                    }>]>;
+                    reason: z.ZodEnum<{
+                        "refund-unknown": "refund-unknown";
+                        "compensation-failed": "compensation-failed";
+                        "compensation-unknown": "compensation-unknown";
+                    }>;
+                }, z.core.$strict>>;
+            }, z.core.$strict>>;
         }, z.core.$strict>>;
         progress: z.ZodOptional<z.ZodNullable<z.ZodObject<{
             closedAt: z.ZodNullable<z.ZodNumber>;

package/dist/schema/postPurchaseUpgrade.d.ts

@@ -0,0 +1,117 @@
+import { z } from 'zod';
+/**
+ * apiv2 `refund-product` for the upgrade's original one-time line. `failed` is a known refusal (nothing was
+ * refunded); `unknown` is a lost or ambiguous answer, which is never retried and never compensated blindly.
+ */
+export declare const UpgradeRefundProgressSchema: z.ZodUnion<readonly [z.ZodObject<{
+    attemptedAt: z.ZodNumber;
+    status: z.ZodLiteral<"attempted">;
+}, z.core.$strict>, z.ZodObject<{
+    attemptedAt: z.ZodNumber;
+    finishedAt: z.ZodNumber;
+    refundId: z.ZodString;
+    status: z.ZodLiteral<"refunded">;
+}, z.core.$strict>, z.ZodObject<{
+    attemptedAt: z.ZodNumber;
+    finishedAt: z.ZodNumber;
+    status: z.ZodEnum<{
+        unknown: "unknown";
+        failed: "failed";
+    }>;
+}, z.core.$strict>]>;
+/** apiv2 `remove-subscription-product`: the rollback that runs only after a known refund failure. */
+export declare const UpgradeCompensationProgressSchema: z.ZodUnion<readonly [z.ZodObject<{
+    attemptedAt: z.ZodNumber;
+    status: z.ZodLiteral<"attempted">;
+}, z.core.$strict>, z.ZodObject<{
+    attemptedAt: z.ZodNumber;
+    finishedAt: z.ZodNumber;
+    status: z.ZodEnum<{
+        unknown: "unknown";
+        failed: "failed";
+        removed: "removed";
+    }>;
+}, z.core.$strict>]>;
+/**
+ * Why the upgrade is left for a person; `marker` is the `subscription_rollback_failed` metafield write. A
+ * `marker` of `unavailable` means the marker could not be written, NOT that no review is needed: the review
+ * stands whatever the marker status.
+ */
+export declare const UpgradeReviewReasonSchema: z.ZodEnum<{
+    "refund-unknown": "refund-unknown";
+    "compensation-failed": "compensation-failed";
+    "compensation-unknown": "compensation-unknown";
+}>;
+export declare const UpgradeReviewProgressSchema: z.ZodObject<{
+    markedAt: z.ZodNumber;
+    marker: z.ZodUnion<readonly [z.ZodEnum<{
+        unknown: "unknown";
+        acknowledged: "acknowledged";
+        rejected: "rejected";
+    }>, z.ZodEnum<{
+        attempted: "attempted";
+        unavailable: "unavailable";
+    }>]>;
+    reason: z.ZodEnum<{
+        "refund-unknown": "refund-unknown";
+        "compensation-failed": "compensation-failed";
+        "compensation-unknown": "compensation-unknown";
+    }>;
+}, z.core.$strict>;
+/**
+ * The refund-compensation saga of one admitted upgrade, `null` steps not yet started. Compensation follows a
+ * known refund failure only, and a review is recorded exactly when the outcome is unresolved (an unknown
+ * refund, or a failed or unknown rollback), so a compensated or unresolved upgrade never reads as upgraded.
+ */
+export declare const UpgradeProgressSchema: z.ZodObject<{
+    compensation: z.ZodNullable<z.ZodUnion<readonly [z.ZodObject<{
+        attemptedAt: z.ZodNumber;
+        status: z.ZodLiteral<"attempted">;
+    }, z.core.$strict>, z.ZodObject<{
+        attemptedAt: z.ZodNumber;
+        finishedAt: z.ZodNumber;
+        status: z.ZodEnum<{
+            unknown: "unknown";
+            failed: "failed";
+            removed: "removed";
+        }>;
+    }, z.core.$strict>]>>;
+    operationId: z.ZodUUID;
+    refund: z.ZodNullable<z.ZodUnion<readonly [z.ZodObject<{
+        attemptedAt: z.ZodNumber;
+        status: z.ZodLiteral<"attempted">;
+    }, z.core.$strict>, z.ZodObject<{
+        attemptedAt: z.ZodNumber;
+        finishedAt: z.ZodNumber;
+        refundId: z.ZodString;
+        status: z.ZodLiteral<"refunded">;
+    }, z.core.$strict>, z.ZodObject<{
+        attemptedAt: z.ZodNumber;
+        finishedAt: z.ZodNumber;
+        status: z.ZodEnum<{
+            unknown: "unknown";
+            failed: "failed";
+        }>;
+    }, z.core.$strict>]>>;
+    review: z.ZodNullable<z.ZodObject<{
+        markedAt: z.ZodNumber;
+        marker: z.ZodUnion<readonly [z.ZodEnum<{
+            unknown: "unknown";
+            acknowledged: "acknowledged";
+            rejected: "rejected";
+        }>, z.ZodEnum<{
+            attempted: "attempted";
+            unavailable: "unavailable";
+        }>]>;
+        reason: z.ZodEnum<{
+            "refund-unknown": "refund-unknown";
+            "compensation-failed": "compensation-failed";
+            "compensation-unknown": "compensation-unknown";
+        }>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type UpgradeCompensationProgress = z.infer<typeof UpgradeCompensationProgressSchema>;
+export type UpgradeProgress = z.infer<typeof UpgradeProgressSchema>;
+export type UpgradeRefundProgress = z.infer<typeof UpgradeRefundProgressSchema>;
+export type UpgradeReviewProgress = z.infer<typeof UpgradeReviewProgressSchema>;
+export type UpgradeReviewReason = z.infer<typeof UpgradeReviewReasonSchema>;