autumn-js 1.2.46 → 1.2.48

package/dist/backend/index.mjs

@@ -1,27 +1,27 @@
 import "./chunk-WYDGEDEU.mjs";
 import "./chunk-VXND2UDT.mjs";
-import "./chunk-KW47VZ73.mjs";
+import "./chunk-2OI2ZLQY.mjs";
 import {
   createCoreHandler
-} from "./chunk-SBZEXVB4.mjs";
-import "./chunk-RPUV2OZA.mjs";
-import "./chunk-MOHYGUMA.mjs";
-import "./chunk-TBQ27LIK.mjs";
-import "./chunk-J44WR3QZ.mjs";
+} from "./chunk-JGCKPJXX.mjs";
 import "./chunk-TSF4YCUO.mjs";
 import {
   buildRouter
 } from "./chunk-UAR3TMWI.mjs";
+import "./chunk-QEJJM4BY.mjs";
 import {
   routeConfigs
-} from "./chunk-UJS4Q7J4.mjs";
+} from "./chunk-2OM5IYSI.mjs";
+import "./chunk-IXUCY7AU.mjs";
 import "./chunk-OTXV5FY7.mjs";
-import {
-  secretKeyCheck
-} from "./chunk-VZIMT7AO.mjs";
 import {
   sanitizeBody
 } from "./chunk-I7CD6EB6.mjs";
+import {
+  secretKeyCheck
+} from "./chunk-VZIMT7AO.mjs";
+import "./chunk-TBQ27LIK.mjs";
+import "./chunk-J44WR3QZ.mjs";
 import {
   backendError,
   backendSuccess,

package/dist/backend/{routeTypes-DnUY8ksp.d.mts → routeTypes-6-0oSlbI.d.mts}

@@ -10012,6 +10012,375 @@ type CreateReferralCodeResponse = {
     createdAt: number;
 };
 
+/**
+ * When the reward is granted: on redemption, or when the redeemer checks out.
+ */
+declare const RedeemOnRequest: {
+    readonly CustomerCreation: "customer_creation";
+    readonly Checkout: "checkout";
+};
+/**
+ * When the reward is granted: on redemption, or when the redeemer checks out.
+ */
+type RedeemOnRequest = ClosedEnum<typeof RedeemOnRequest>;
+/**
+ * Who receives the reward: the referrer only, or both parties.
+ */
+declare const ReceivedByRequest: {
+    readonly Referrer: "referrer";
+    readonly All: "all";
+};
+/**
+ * Who receives the reward: the referrer only, or both parties.
+ */
+type ReceivedByRequest = ClosedEnum<typeof ReceivedByRequest>;
+type CreateReferralProgramParams = {
+    id: string;
+    rewardId: string;
+    /**
+     * When the reward is granted: on redemption, or when the redeemer checks out.
+     */
+    redeemOn: RedeemOnRequest;
+    /**
+     * Who receives the reward: the referrer only, or both parties.
+     */
+    receivedBy: ReceivedByRequest;
+    /**
+     * A positive redemption limit, or null for unlimited redemptions.
+     */
+    maxRedemptions?: number | null | undefined;
+    /**
+     * Required when redeem_on is checkout. Plan IDs must be unique.
+     */
+    planIds?: Array<string> | null | undefined;
+    /**
+     * Whether checkouts that start a trial should skip granting the reward.
+     */
+    excludeTrial?: boolean | null | undefined;
+};
+/**
+ * When the reward is granted: on redemption, or when the redeemer checks out.
+ */
+declare const RedeemOnResponse: {
+    readonly CustomerCreation: "customer_creation";
+    readonly Checkout: "checkout";
+};
+/**
+ * When the reward is granted: on redemption, or when the redeemer checks out.
+ */
+type RedeemOnResponse = OpenEnum<typeof RedeemOnResponse>;
+/**
+ * Who receives the reward: the referrer only, or both parties.
+ */
+declare const ReceivedByResponse: {
+    readonly Referrer: "referrer";
+    readonly All: "all";
+};
+/**
+ * Who receives the reward: the referrer only, or both parties.
+ */
+type ReceivedByResponse = OpenEnum<typeof ReceivedByResponse>;
+/**
+ * OK
+ */
+type CreateReferralProgramResponse = {
+    /**
+     * The unique identifier for the referral program.
+     */
+    id: string;
+    /**
+     * The ID of the reward granted when a code is redeemed.
+     */
+    rewardId: string;
+    /**
+     * When the reward is granted: on redemption, or when the redeemer checks out.
+     */
+    redeemOn: RedeemOnResponse;
+    /**
+     * Who receives the reward: the referrer only, or both parties.
+     */
+    receivedBy: ReceivedByResponse;
+    /**
+     * The maximum number of times a referral code can be redeemed.
+     */
+    maxRedemptions?: number | null | undefined;
+    /**
+     * The plans whose checkout triggers the reward. Only used when redeem_on is checkout.
+     */
+    planIds?: Array<string> | null | undefined;
+    /**
+     * Whether checkouts that start a trial should skip granting the reward.
+     */
+    excludeTrial?: boolean | null | undefined;
+    /**
+     * The Unix timestamp (in milliseconds) when the referral program was created.
+     */
+    createdAt: number;
+};
+
+declare const DurationTypeRequestBody: {
+    readonly OneOff: "one_off";
+    readonly Months: "months";
+    readonly Forever: "forever";
+};
+type DurationTypeRequestBody = ClosedEnum<typeof DurationTypeRequestBody>;
+/**
+ * Use a positive integer length for months, and null for one_off or forever.
+ */
+type CreateRewardDuration = {
+    type: DurationTypeRequestBody;
+    length: number | null;
+};
+type CreateRewardCouponPromoCode = {
+    code: string;
+    globalMaxRedemption?: number | null | undefined;
+    firstTimeTransaction?: boolean | null | undefined;
+};
+declare const CouponTypeRequestBody: {
+    readonly PercentageDiscount: "percentage_discount";
+    readonly FixedDiscount: "fixed_discount";
+};
+type CouponTypeRequestBody = ClosedEnum<typeof CouponTypeRequestBody>;
+/**
+ * Provide exactly one of coupon or feature_grant, not both.
+ */
+type CreateRewardCouponRequest = {
+    id: string;
+    name: string;
+    /**
+     * Use a positive integer length for months, and null for one_off or forever.
+     */
+    duration: CreateRewardDuration;
+    /**
+     * Plan IDs must be unique.
+     */
+    planIds: Array<string> | null;
+    /**
+     * Promo code values must be unique.
+     */
+    promoCodes: Array<CreateRewardCouponPromoCode>;
+    type: CouponTypeRequestBody;
+    /**
+     * Percentage discounts must be at most 100; fixed discounts must be positive.
+     */
+    value: number;
+};
+/**
+ * The unit of time the grant lasts.
+ */
+declare const ExpiryTypeRequestBody: {
+    readonly Day: "day";
+    readonly Week: "week";
+    readonly Month: "month";
+    readonly Year: "year";
+};
+/**
+ * The unit of time the grant lasts.
+ */
+type ExpiryTypeRequestBody = ClosedEnum<typeof ExpiryTypeRequestBody>;
+type ExpiryRequest = {
+    /**
+     * The unit of time the grant lasts.
+     */
+    type: ExpiryTypeRequestBody;
+    /**
+     * The positive integer count of periods before the grant expires.
+     */
+    length: number;
+};
+type CreateRewardGrant = {
+    featureId: string;
+    /**
+     * A positive amount to grant, or null for boolean features.
+     */
+    included: number | null;
+    expiry: ExpiryRequest | null;
+};
+type CreateRewardFeatureGrantPromoCode = {
+    code: string;
+    /**
+     * A positive redemption limit, or null for unlimited uses.
+     */
+    maxUses: number | null;
+};
+/**
+ * Provide exactly one of coupon or feature_grant, not both.
+ */
+type CreateRewardFeatureGrantRequest = {
+    id: string;
+    name: string;
+    /**
+     * Feature IDs must be unique.
+     */
+    grants: Array<CreateRewardGrant>;
+    /**
+     * Promo code values must be unique.
+     */
+    promoCodes: Array<CreateRewardFeatureGrantPromoCode>;
+};
+type CreateRewardParams = {
+    /**
+     * Provide exactly one of coupon or feature_grant, not both.
+     */
+    coupon?: CreateRewardCouponRequest | undefined;
+    /**
+     * Provide exactly one of coupon or feature_grant, not both.
+     */
+    featureGrant?: CreateRewardFeatureGrantRequest | undefined;
+};
+/**
+ * The type of discount: percentage_discount, fixed_discount, or invoice_credits.
+ */
+declare const CreateRewardCouponTypeResponse: {
+    readonly PercentageDiscount: "percentage_discount";
+    readonly FixedDiscount: "fixed_discount";
+    readonly InvoiceCredits: "invoice_credits";
+};
+/**
+ * The type of discount: percentage_discount, fixed_discount, or invoice_credits.
+ */
+type CreateRewardCouponTypeResponse = OpenEnum<typeof CreateRewardCouponTypeResponse>;
+/**
+ * The unit of time the duration is measured in.
+ */
+declare const CreateRewardDurationTypeResponse: {
+    readonly OneOff: "one_off";
+    readonly Months: "months";
+    readonly Forever: "forever";
+};
+/**
+ * The unit of time the duration is measured in.
+ */
+type CreateRewardDurationTypeResponse = OpenEnum<typeof CreateRewardDurationTypeResponse>;
+/**
+ * How long the coupon applies once redeemed.
+ */
+type CreateRewardDurationResponse = {
+    /**
+     * The unit of time the duration is measured in.
+     */
+    type: CreateRewardDurationTypeResponse;
+    /**
+     * The number of `type` periods the duration lasts, or null when the type has no length (e.g. one_off, forever).
+     */
+    length: number | null;
+};
+type CreateRewardCouponPromoCodeResponse = {
+    /**
+     * The promo code customers enter to redeem the coupon.
+     */
+    code: string;
+    /**
+     * Maximum number of times this promo code can be redeemed across all customers, or null for unlimited.
+     */
+    globalMaxRedemption?: number | null | undefined;
+    /**
+     * Whether this promo code can only be applied to a customer's first transaction.
+     */
+    firstTimeTransaction?: boolean | null | undefined;
+};
+type CreateRewardCouponResponse = {
+    /**
+     * The unique identifier for the coupon.
+     */
+    id: string;
+    /**
+     * A human-readable name for the coupon.
+     */
+    name?: string | null | undefined;
+    /**
+     * The type of discount: percentage_discount, fixed_discount, or invoice_credits.
+     */
+    type: CreateRewardCouponTypeResponse;
+    /**
+     * The discount value. A percentage for percentage_discount, or an amount for fixed_discount / invoice_credits.
+     */
+    value: number;
+    /**
+     * How long the coupon applies once redeemed.
+     */
+    duration: CreateRewardDurationResponse;
+    /**
+     * The plan IDs the coupon applies to, or null when it applies to all plans.
+     */
+    planIds: Array<string> | null;
+    promoCodes: Array<CreateRewardCouponPromoCodeResponse>;
+    /**
+     * The Unix timestamp (in milliseconds) when the coupon was created.
+     */
+    createdAt: number;
+};
+/**
+ * The unit of time the grant lasts.
+ */
+declare const CreateRewardExpiryTypeResponse: {
+    readonly Day: "day";
+    readonly Week: "week";
+    readonly Month: "month";
+    readonly Year: "year";
+};
+/**
+ * The unit of time the grant lasts.
+ */
+type CreateRewardExpiryTypeResponse = OpenEnum<typeof CreateRewardExpiryTypeResponse>;
+type CreateRewardExpiryResponse = {
+    /**
+     * The unit of time the grant lasts.
+     */
+    type: CreateRewardExpiryTypeResponse;
+    /**
+     * The positive integer count of periods before the grant expires.
+     */
+    length: number;
+};
+type CreateRewardGrantResponse = {
+    /**
+     * The feature ID this grant applies to.
+     */
+    featureId: string;
+    /**
+     * The amount of the feature granted, or null for boolean features.
+     */
+    included: number | null;
+    /**
+     * How long the granted amount lasts before expiring, or null for a permanent grant.
+     */
+    expiry: CreateRewardExpiryResponse | null;
+};
+type CreateRewardFeatureGrantPromoCodeResponse = {
+    /**
+     * The promo code customers enter to redeem the feature grant.
+     */
+    code: string;
+    /**
+     * Maximum number of times this promo code can be redeemed, or null for unlimited.
+     */
+    maxUses: number | null;
+};
+type CreateRewardFeatureGrantResponse = {
+    /**
+     * The unique identifier for the feature grant.
+     */
+    id: string;
+    /**
+     * A human-readable name for the feature grant.
+     */
+    name?: string | null | undefined;
+    grants: Array<CreateRewardGrantResponse>;
+    promoCodes: Array<CreateRewardFeatureGrantPromoCodeResponse>;
+    /**
+     * The Unix timestamp (in milliseconds) when the feature grant was created.
+     */
+    createdAt: number;
+};
+/**
+ * OK
+ */
+type CreateRewardResponse = {
+    coupon?: CreateRewardCouponResponse | undefined;
+    featureGrant?: CreateRewardFeatureGrantResponse | undefined;
+};
+
 /**
  * Unit of time for the trial ('day', 'month', 'year').
  */
@@ -10994,7 +11363,7 @@ type CreateScheduleParams = {
      */
     freeTrial?: CreateScheduleFreeTrialParams | null | undefined;
     /**
-     * Currency used to bill the immediate phase.
+     * Three-letter Stripe-supported currency code used to bill the immediate phase (for example, 'usd').
      */
     currency?: string | undefined;
     /**
@@ -18800,7 +19169,7 @@ type RewardsListParams = {};
 /**
  * The type of discount: percentage_discount, fixed_discount, or invoice_credits.
  */
-declare const CouponType: {
+declare const ListRewardsCouponType: {
     readonly PercentageDiscount: "percentage_discount";
     readonly FixedDiscount: "fixed_discount";
     readonly InvoiceCredits: "invoice_credits";
@@ -18808,11 +19177,11 @@ declare const CouponType: {
 /**
  * The type of discount: percentage_discount, fixed_discount, or invoice_credits.
  */
-type CouponType = OpenEnum<typeof CouponType>;
+type ListRewardsCouponType = OpenEnum<typeof ListRewardsCouponType>;
 /**
  * The unit of time the duration is measured in.
  */
-declare const DurationType: {
+declare const ListRewardsDurationType: {
     readonly OneOff: "one_off";
     readonly Months: "months";
     readonly Forever: "forever";
@@ -18820,7 +19189,7 @@ declare const DurationType: {
 /**
  * The unit of time the duration is measured in.
  */
-type DurationType = OpenEnum<typeof DurationType>;
+type ListRewardsDurationType = OpenEnum<typeof ListRewardsDurationType>;
 /**
  * How long the coupon applies once redeemed.
  */
@@ -18828,13 +19197,13 @@ type ListRewardsDuration = {
     /**
      * The unit of time the duration is measured in.
      */
-    type: DurationType;
+    type: ListRewardsDurationType;
     /**
      * The number of `type` periods the duration lasts, or null when the type has no length (e.g. one_off, forever).
      */
     length: number | null;
 };
-type CouponPromoCode = {
+type ListRewardsCouponPromoCode = {
     /**
      * The promo code customers enter to redeem the coupon.
      */
@@ -18860,7 +19229,7 @@ type Coupon = {
     /**
      * The type of discount: percentage_discount, fixed_discount, or invoice_credits.
      */
-    type: CouponType;
+    type: ListRewardsCouponType;
     /**
      * The discount value. A percentage for percentage_discount, or an amount for fixed_discount / invoice_credits.
      */
@@ -18876,36 +19245,36 @@ type Coupon = {
     /**
      * The promo codes customers can use to redeem the coupon.
      */
-    promoCodes: Array<CouponPromoCode>;
+    promoCodes: Array<ListRewardsCouponPromoCode>;
     /**
      * The Unix timestamp (in milliseconds) when the coupon was created.
      */
     createdAt: number;
 };
 /**
- * The unit of time the duration is measured in.
+ * The unit of time the grant lasts.
  */
-declare const ExpiryType: {
+declare const ListRewardsExpiryType: {
     readonly Day: "day";
     readonly Week: "week";
     readonly Month: "month";
     readonly Year: "year";
 };
 /**
- * The unit of time the duration is measured in.
+ * The unit of time the grant lasts.
  */
-type ExpiryType = OpenEnum<typeof ExpiryType>;
-type Expiry = {
+type ListRewardsExpiryType = OpenEnum<typeof ListRewardsExpiryType>;
+type ListRewardsExpiry = {
     /**
-     * The unit of time the duration is measured in.
+     * The unit of time the grant lasts.
      */
-    type: ExpiryType;
+    type: ListRewardsExpiryType;
     /**
-     * The number of `type` periods the duration lasts, or null when the type has no length (e.g. one_off, forever).
+     * The positive integer count of periods before the grant expires.
      */
-    length: number | null;
+    length: number;
 };
-type Grant = {
+type ListRewardsGrant = {
     /**
      * The feature ID this grant applies to.
      */
@@ -18917,9 +19286,9 @@ type Grant = {
     /**
      * How long the granted amount lasts before expiring, or null for a permanent grant.
      */
-    expiry: Expiry | null;
+    expiry: ListRewardsExpiry | null;
 };
-type FeatureGrantPromoCode = {
+type ListRewardsFeatureGrantPromoCode = {
     /**
      * The promo code customers enter to redeem the feature grant.
      */
@@ -18941,11 +19310,11 @@ type FeatureGrant = {
     /**
      * The feature grants awarded when the grant is redeemed.
      */
-    grants: Array<Grant>;
+    grants: Array<ListRewardsGrant>;
     /**
      * The promo codes customers can use to redeem the feature grant.
      */
-    promoCodes: Array<FeatureGrantPromoCode>;
+    promoCodes: Array<ListRewardsFeatureGrantPromoCode>;
     /**
      * The Unix timestamp (in milliseconds) when the feature grant was created.
      */
@@ -32075,13 +32444,13 @@ declare class Billing extends ClientSDK {
      * @example
      * ```typescript
      * // Schedule a transition from a trial plan to a paid plan
-     * const response = await client.billing.createSchedule({ customerId: "cus_123", phases: [{"startsAt":1785760797907,"plans":[{"planId":"trial_plan"}]},{"startsAt":1786970397907,"plans":[{"planId":"pro_plan"}]}] });
+     * const response = await client.billing.createSchedule({ customerId: "cus_123", phases: [{"startsAt":"now","plans":[{"planId":"trial_plan"}]},{"startingAfter":{"durationType":"month","durationCount":1},"plans":[{"planId":"pro_plan"}]}] });
      * ```
      *
      * @param customerId - The ID of the customer to create the schedule for.
      * @param entityId - Optional entity ID for an entity-scoped schedule. (optional)
      * @param freeTrial - Free trial configuration applied to every plan in the immediate phase. (optional)
-     * @param currency - Currency used to bill the immediate phase. (optional)
+     * @param currency - Three-letter Stripe-supported currency code used to bill the immediate phase (for example, 'usd'). (optional)
      * @param invoiceMode - Invoice mode creates and sends an invoice instead of charging the customer's payment method immediately for the first phase. (optional)
      * @param discounts - List of discounts to apply to the immediate phase. Each discount can be an Autumn reward ID, Stripe coupon ID, or Stripe promotion code. (optional)
      * @param successUrl - URL to redirect to after successful checkout. (optional)
@@ -32919,9 +33288,17 @@ declare class Referrals extends ClientSDK {
      * Redeem a referral code for a customer.
      */
     redeemCode(request: RedeemReferralCodeParams, options?: RequestOptions): Promise<RedeemReferralCodeResponse>;
+    /**
+     * Create a referral program linked to an existing reward.
+     */
+    createProgram(request: CreateReferralProgramParams, options?: RequestOptions): Promise<CreateReferralProgramResponse>;
 }
 
 declare class Rewards extends ClientSDK {
+    /**
+     * Create a coupon or feature grant.
+     */
+    create(request: CreateRewardParams, options?: RequestOptions): Promise<CreateRewardResponse>;
     /**
      * List the coupons and feature grants configured for the org.
      */