@stripe/extensibility-sdk 0.22.4 → 0.24.0

package/dist/extensibility-sdk-extensions-beta.d.ts

@@ -1,3 +1,8 @@
+/**
+ * @deprecated Import from `@stripe/extensibility-sdk` instead.
+ * @packageDocumentation
+ */
+
 /**
  * Opaque brand symbol used as a property key in SDK branded types.
  *
@@ -26,15 +31,15 @@ declare const __stripeType: unique symbol;
 
 /** @public */
 declare type AnyTimeRange = {
-    value: 'oneTime';
     at: Date;
+    value: 'oneTime';
 } | {
-    value: 'timeRange';
-    startDate: Date;
     endDate: Date;
+    startDate: Date;
+    value: 'timeRange';
 } | {
-    value: 'other';
     otherValue: string;
+    value: 'other';
 };
 
 declare namespace Bill {
@@ -164,22 +169,21 @@ declare namespace CustomAction {
      * Executes the custom action at workflow runtime. Called when a workflow triggers this action, with the configured input values.
      * @public
      */
-    type ExecuteFunction<Config extends Record<string, unknown>> = (request: ExecuteCustomActionRequest, config: Config, context: Context) => ExecuteCustomActionResponse | PromiseLike<ExecuteCustomActionResponse>;
+    type ExecuteFunction<Config> = (request: ExecuteCustomActionRequest, config: Config, context: Context) => ExecuteCustomActionResponse | PromiseLike<ExecuteCustomActionResponse>;
     /**
      * Returns the current form state for the action's configuration UI. Called at configuration time (not runtime) to power dynamic form behavior, including dropdown options, dynamic JSON schemas, field visibility, and validation.
      * @public
      */
-    type GetFormStateFunction<Config extends Record<string, unknown>> = (request: GetFormStateRequest, config: Config, context: Context) => GetFormStateResponse | PromiseLike<GetFormStateResponse>;
+    type GetFormStateFunction<Config> = (request: GetFormStateRequest, config: Config, context: Context) => GetFormStateResponse | PromiseLike<GetFormStateResponse>;
 }
 
 /**
  * @example
  * ```ts
- * import type { Core } from '@stripe/extensibility-sdk/extensions';
- * import type { Context } from '@stripe/extensibility-sdk/extensions';
+ * import type { Core, Context } from '@stripe/extensibility-sdk';
  *
  * // eslint-disable-next-line @typescript-eslint/no-empty-object-type
- * interface MyCustomActionConfig extends Record<string, unknown> {}
+ * interface MyCustomActionConfig {}
  *
  * export default class MyCustomAction implements Core.Workflows
  * .CustomAction<MyCustomActionConfig> {
@@ -210,7 +214,7 @@ declare namespace CustomAction {
  * ```
  * @public
  */
-declare interface CustomAction<Config extends Record<string, unknown>> {
+declare interface CustomAction<Config> {
     execute: CustomAction.ExecuteFunction<Config>;
     getFormState?: CustomAction.GetFormStateFunction<Config>;
 }
@@ -299,22 +303,21 @@ declare namespace CustomAction_2 {
      * Executes the custom action at workflow runtime. Called when a workflow triggers this action, with the configured input values.
      * @public
      */
-    type ExecuteFunction<Config extends Record<string, unknown>> = (request: ExecuteCustomActionRequest, config: Config, context: Context) => ExecuteCustomActionResponse | PromiseLike<ExecuteCustomActionResponse>;
+    type ExecuteFunction<Config> = (request: ExecuteCustomActionRequest, config: Config, context: Context) => ExecuteCustomActionResponse | PromiseLike<ExecuteCustomActionResponse>;
     /**
      * Returns the current form state for the action's configuration UI. Called at configuration time (not runtime) to power dynamic form behavior, including dropdown options, dynamic JSON schemas, field visibility, and validation.
      * @public
      */
-    type GetFormStateFunction<Config extends Record<string, unknown>> = (request: GetFormStateRequest, config: Config, context: Context) => GetFormStateResponse | PromiseLike<GetFormStateResponse>;
+    type GetFormStateFunction<Config> = (request: GetFormStateRequest, config: Config, context: Context) => GetFormStateResponse | PromiseLike<GetFormStateResponse>;
 }
 
 /**
  * @example
  * ```ts
- * import type { Extend } from '@stripe/extensibility-sdk/extensions';
- * import type { Context } from '@stripe/extensibility-sdk/extensions';
+ * import type { Extend, Context } from '@stripe/extensibility-sdk';
  *
  * // eslint-disable-next-line @typescript-eslint/no-empty-object-type
- * interface MyCustomActionConfig extends Record<string, unknown> {}
+ * interface MyCustomActionConfig {}
  *
  * export default class MyCustomAction implements Extend.Workflows
  *   .CustomAction<MyCustomActionConfig> {
@@ -345,7 +348,7 @@ declare namespace CustomAction_2 {
  * ```
  * @public
  */
-declare interface CustomAction_2<Config extends Record<string, unknown>> {
+declare interface CustomAction_2<Config> {
     execute: CustomAction_2.ExecuteFunction<Config>;
     getFormState?: CustomAction_2.GetFormStateFunction<Config>;
 }
@@ -395,21 +398,21 @@ declare namespace CustomerBalanceApplication {
      * Determines how much of the customer's balance to apply toward a bill total. The script receives the invoice total and current customer balance, then returns how much of that balance to apply.
      * @public
      */
-    type ComputeAppliedCustomerBalanceFunction<Config extends Record<string, unknown>> = (request: CustomerBalanceApplicationInput, config: Config, context: Context) => CustomerBalanceApplicationResult;
+    type ComputeAppliedCustomerBalanceFunction<Config> = (request: CustomerBalanceApplicationInput, config: Config, context: Context) => CustomerBalanceApplicationResult;
 }
 
 /**
  * @example
  * ```ts
- * import type { Billing, Context } from '@stripe/extensibility-sdk/extensions';
+ * import type { Billing, Context } from '@stripe/extensibility-sdk';
  *
  * // eslint-disable-next-line @typescript-eslint/no-empty-object-type
- * interface MyCustomerBalanceApplicationConfig extends Record<string, unknown> {}
+ * interface MyBalanceAppConfig {}
  *
- * export default class MyCustomerBalanceApplication implements Billing.CustomerBalanceApplication<MyCustomerBalanceApplicationConfig> {
+ * export default class MyBalanceApp implements Billing.CustomerBalanceApplication<MyBalanceAppConfig> {
  *   computeAppliedCustomerBalance(
  *     request: Billing.CustomerBalanceApplication.CustomerBalanceApplicationInput,
- *     _config: MyCustomerBalanceApplicationConfig,
+ *     _config: MyBalanceAppConfig,
  *     _context: Context
  *   ) {
  *     // TODO: implement your customer balance logic here
@@ -423,7 +426,7 @@ declare namespace CustomerBalanceApplication {
  * ```
  * @public
  */
-declare interface CustomerBalanceApplication<Config extends Record<string, unknown>> {
+declare interface CustomerBalanceApplication<Config> {
     computeAppliedCustomerBalance: CustomerBalanceApplication.ComputeAppliedCustomerBalanceFunction<Config>;
 }
 
@@ -643,7 +646,7 @@ export declare const DecimalRoundingPresets: Readonly<{
 /** @public */
 declare namespace DiscountCalculation {
     /** @public */
-    type BillingReason = 'automatic_pending_invoice_item_invoice' | 'manual' | 'subscription' | 'subscription_create' | 'subscription_cycle' | 'subscription_cancel' | 'subscription_threshold' | 'subscription_trial_ended' | 'subscription_update' | 'upcoming' | 'quote_accept';
+    type BillingReason = 'automatic_pending_invoice_item_invoice' | 'manual' | 'quote_accept' | 'subscription_cancel' | 'subscription_create' | 'subscription_cycle' | 'subscription_threshold' | 'subscription_trial_ended' | 'subscription_update' | 'subscription' | 'upcoming';
     /** @public */
     type PricingTierMode = 'graduated' | 'volume';
     /** @public */
@@ -653,7 +656,7 @@ declare namespace DiscountCalculation {
     /** @public */
     type UsageType = 'licensed' | 'metered';
     /** @public */
-    type RecurringPriceInterval = 'day' | 'week' | 'month' | 'year';
+    type RecurringPriceInterval = 'day' | 'month' | 'week' | 'year';
     /**
      * The result of a discount calculation.
      * @public
@@ -827,17 +830,16 @@ declare namespace DiscountCalculation {
      * Computes discount amounts for a discountable item and returns a discount result.
      * @public
      */
-    type ComputeDiscountsFunction<Config extends Record<string, unknown>> = (request: DiscountableItem, config: Config, context: Context) => DiscountResult;
+    type ComputeDiscountsFunction<Config> = (request: DiscountableItem, config: Config, context: Context) => DiscountResult;
 }
 
 /**
  * @example
  * ```ts
- * import type { Billing } from '@stripe/extensibility-sdk/extensions';
- * import type { Context } from '@stripe/extensibility-sdk/extensions';
+ * import type { Billing, Context } from '@stripe/extensibility-sdk';
  *
  * // eslint-disable-next-line @typescript-eslint/no-empty-object-type
- * interface MyDiscountCalculationConfig extends Record<string, unknown> {}
+ * interface MyDiscountCalculationConfig {}
  *
  * export default class MyDiscountCalculation implements Billing.Bill
  *   .DiscountCalculation<MyDiscountCalculationConfig> {
@@ -857,7 +859,7 @@ declare namespace DiscountCalculation {
  * ```
  * @public
  */
-declare interface DiscountCalculation<Config extends Record<string, unknown>> {
+declare interface DiscountCalculation<Config> {
     computeDiscounts: DiscountCalculation.ComputeDiscountsFunction<Config>;
 }
 
@@ -871,11 +873,11 @@ export { Extend }
 /** @public */
 declare namespace InvoiceCollectionSetting {
     /** @public */
-    type ParentType = 'subscription' | 'contract' | 'quote' | 'billing_cadence' | 'subscription_schedule' | 'standalone';
+    type ParentType = 'billing_cadence' | 'contract' | 'quote' | 'standalone' | 'subscription_schedule' | 'subscription';
     /** @public */
-    type PaymentMethodType = 'card' | 'ach_debit' | 'ach_credit_transfer' | 'sepa_debit' | 'sepa_credit_transfer' | 'bacs_debit' | 'au_becs_debit' | 'us_bank_account' | 'link' | 'boleto' | 'oxxo' | 'ideal' | 'bancontact' | 'giropay' | 'eps' | 'p24' | 'sofort' | 'alipay' | 'wechat_pay' | 'klarna' | 'affirm' | 'afterpay_clearpay' | 'cashapp' | 'paypal' | 'multibanco' | 'konbini' | 'promptpay' | 'paynow' | 'grabpay' | 'fpx';
+    type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'boleto' | 'card' | 'cashapp' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'klarna' | 'konbini' | 'link' | 'multibanco' | 'oxxo' | 'p24' | 'paynow' | 'paypal' | 'promptpay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'us_bank_account' | 'wechat_pay';
     /** @public */
-    type CollectionMethod = 'send_invoice' | 'charge_automatically';
+    type CollectionMethod = 'charge_automatically' | 'send_invoice';
     /**
      * The result of the invoice collection settings override extension.
      * @public
@@ -885,18 +887,16 @@ declare namespace InvoiceCollectionSetting {
         autoAdvance?: boolean;
     }
     /** @public */
-    type InvoiceCollectionRequest = {
-        /** The current collection settings that would be applied to the invoice. */
-        collectionSettings: CollectionSettings;
-        /** The billing resource that triggered invoice creation. */
-        parent: Parent;
-    } & ({
-        payer: 'customer';
+    type InvoiceCollectionRequest = ({
         customer: Customer;
+        payer: 'customer';
     } | {
-        payer: 'other';
         otherPayer: string;
-    });
+        payer: 'other';
+    }) & {
+        collectionSettings: CollectionSettings;
+        parent: Parent;
+    };
     /** @public */
     interface Customer {
         id: string;
@@ -951,16 +951,16 @@ declare namespace InvoiceCollectionSetting {
      * Overrides invoice collection settings before a draft invoice is created.
      * @public
      */
-    type CollectionOverrideFunction<Config extends Record<string, unknown>> = (request: InvoiceCollectionRequest, config: Config, context: Context) => InvoiceCollectionResponse;
+    type CollectionOverrideFunction<Config> = (request: InvoiceCollectionRequest, config: Config, context: Context) => InvoiceCollectionResponse;
 }
 
 /**
  * @example
  * ```ts
- * import type { Billing, Context } from '@stripe/extensibility-sdk/extensions';
+ * import type { Billing, Context } from '@stripe/extensibility-sdk';
  *
  * // eslint-disable-next-line @typescript-eslint/no-empty-object-type
- * interface MyInvoiceCollectionSettingConfig extends Record<string, unknown> {}
+ * interface MyInvoiceCollectionSettingConfig {}
  *
  * export default class MyInvoiceCollectionSetting implements Billing.InvoiceCollectionSetting<MyInvoiceCollectionSettingConfig> {
  *   collectionOverride(
@@ -977,7 +977,7 @@ declare namespace InvoiceCollectionSetting {
  * ```
  * @public
  */
-declare interface InvoiceCollectionSetting<Config extends Record<string, unknown>> {
+declare interface InvoiceCollectionSetting<Config> {
     collectionOverride: InvoiceCollectionSetting.CollectionOverrideFunction<Config>;
 }
 
@@ -1017,7 +1017,7 @@ declare namespace Prorations {
     /** @public */
     type PricingTierMode = 'graduated' | 'volume';
     /** @public */
-    type RecurringPriceInterval = 'day' | 'week' | 'month' | 'year';
+    type RecurringPriceInterval = 'day' | 'month' | 'week' | 'year';
     /** @public */
     type PriceType = 'one_time' | 'recurring';
     /** @public */
@@ -1055,37 +1055,30 @@ declare namespace Prorations {
         items: ProratableItem[];
     }
     /** @public */
-    type ProratableItem = {
-        /** Unique identifier for the item. */
-        key: string;
-        /** Either CREDIT or DEBIT based on whether the item is a credit or debit. */
-        type: ItemType;
-        /** Whether the item was generated from a proration event. */
-        isProration: boolean;
-        /** The time period this item covers. */
-        servicePeriod: TimeRange;
-        /** The default proration factor calculated by Stripe. */
-        currentProrationFactor: Decimal;
-        /** The duration of the price interval in seconds. */
-        priceIntervalDuration: number;
-        /** Information about the corresponding debit that a CREDIT item credits against. */
-        correspondingDebit?: PreviousDebit;
-    } & ({
-        priceKind: 'price';
-        price: Price;
+    type ProratableItem = ({
+        customPricingUnitOverageRate: CustomPricingUnitOverageRate;
+        priceKind: 'customPricingUnitOverageRate';
     } | {
-        priceKind: 'licenseFee';
         licenseFee: LicenseFee;
+        priceKind: 'licenseFee';
     } | {
-        priceKind: 'rateCardRate';
-        rateCardRate: RateCardRate;
+        otherPriceKind: string;
+        priceKind: 'other';
     } | {
-        priceKind: 'customPricingUnitOverageRate';
-        customPricingUnitOverageRate: CustomPricingUnitOverageRate;
+        price: Price;
+        priceKind: 'price';
     } | {
-        priceKind: 'other';
-        otherPriceKind: string;
-    });
+        priceKind: 'rateCardRate';
+        rateCardRate: RateCardRate;
+    }) & {
+        correspondingDebit?: PreviousDebit;
+        currentProrationFactor: Decimal;
+        isProration: boolean;
+        key: string;
+        priceIntervalDuration: number;
+        servicePeriod: TimeRange;
+        type: ItemType;
+    };
     /**
      * Information about a previous debit that a credit item offsets.
      * @public
@@ -1197,16 +1190,16 @@ declare namespace Prorations {
      * Calculates prorated amounts for subscription items when changes occur mid-billing period. The script receives the invoice items, then returns computed proration factors for each item.
      * @public
      */
-    type ProrateItemsFunction<Config extends Record<string, unknown>> = (request: ProrateItemsInput, config: Config, context: Context) => ProrateItemsResult;
+    type ProrateItemsFunction<Config> = (request: ProrateItemsInput, config: Config, context: Context) => ProrateItemsResult;
 }
 
 /**
  * @example
  * ```ts
- * import type { Billing, Context } from '@stripe/extensibility-sdk/extensions';
+ * import type { Billing, Context } from '@stripe/extensibility-sdk';
  *
  * // eslint-disable-next-line @typescript-eslint/no-empty-object-type
- * interface MyProrationsConfig extends Record<string, unknown> {}
+ * interface MyProrationsConfig {}
  *
  * export default class MyProrations implements Billing.Prorations<MyProrationsConfig> {
  *   prorateItems(
@@ -1225,7 +1218,7 @@ declare namespace Prorations {
  * ```
  * @public
  */
-declare interface Prorations<Config extends Record<string, unknown>> {
+declare interface Prorations<Config> {
     prorateItems: Prorations.ProrateItemsFunction<Config>;
 }
 
@@ -1234,7 +1227,7 @@ declare namespace RecurringBillingItemHandling {
     /** @public */
     type PricingTierMode = 'graduated' | 'volume';
     /** @public */
-    type RecurringPriceInterval = 'day' | 'week' | 'month' | 'year';
+    type RecurringPriceInterval = 'day' | 'month' | 'week' | 'year';
     /** @public */
     type PriceType = 'one_time' | 'recurring';
     /** @public */
@@ -1278,33 +1271,28 @@ declare namespace RecurringBillingItemHandling {
         items: Item[];
     }
     /** @public */
-    type Item = {
-        /** Unique identifier for the item. */
-        key: string;
-        /** Either CREDIT or DEBIT based on whether the item is a credit or debit. */
-        type: ItemType;
-        /** Whether the item was generated from a proration event. */
-        isProration: boolean;
-        /** The time period this item covers. */
-        servicePeriod: AnyTimeRange;
-        /** The proration factor for this item. */
-        prorationFactor: Decimal;
-    } & ({
-        priceKind: 'price';
-        price: Price;
+    type Item = ({
+        customPricingUnitOverageRate: CustomPricingUnitOverageRate;
+        priceKind: 'customPricingUnitOverageRate';
     } | {
-        priceKind: 'licenseFee';
         licenseFee: LicenseFee;
+        priceKind: 'licenseFee';
     } | {
-        priceKind: 'rateCardRate';
-        rateCardRate: RateCardRate;
+        otherPriceKind: string;
+        priceKind: 'other';
     } | {
-        priceKind: 'customPricingUnitOverageRate';
-        customPricingUnitOverageRate: CustomPricingUnitOverageRate;
+        price: Price;
+        priceKind: 'price';
     } | {
-        priceKind: 'other';
-        otherPriceKind: string;
-    });
+        priceKind: 'rateCardRate';
+        rateCardRate: RateCardRate;
+    }) & {
+        isProration: boolean;
+        key: string;
+        prorationFactor: Decimal;
+        servicePeriod: AnyTimeRange;
+        type: ItemType;
+    };
     /** @public */
     interface CustomPricingUnitOverageRate {
         id: string;
@@ -1416,17 +1404,10 @@ declare namespace RecurringBillingItemHandling {
         items: ItemWithCreationStrategy[];
     }
     /** @public */
-    type ItemWithCreationStrategy = {
-        /** The unique identifier of the item, matching a key from the input. */
-        key: string;
-    } & ({
-        creationStrategy: 'doNotCreate';
-    } | {
-        creationStrategy: 'invoice';
-    } | {
+    type ItemWithCreationStrategy = ({
         creationStrategy: 'other';
         otherCreationStrategy: string;
-    });
+    } | { creationStrategy: 'doNotCreate' } | { creationStrategy: 'invoice' }) & { key: string };
     /** @public */
     type Invoice = Record<string, never>;
     /** @public */
@@ -1476,26 +1457,26 @@ declare namespace RecurringBillingItemHandling {
      * Runs before invoice items are created. Decides whether each item should be created or skipped.
      * @public
      */
-    type BeforeItemCreationFunction<Config extends Record<string, unknown>> = (request: BeforeItemCreationInput, config: Config, context: Context) => BeforeItemCreationResult;
+    type BeforeItemCreationFunction<Config> = (request: BeforeItemCreationInput, config: Config, context: Context) => BeforeItemCreationResult;
     /**
      * Runs before invoices are created. Decides which items to include on the invoice. Items not included are deferred as pending invoice items.
      * @public
      */
-    type FilterItemsFunction<Config extends Record<string, unknown>> = (request: FilterItemsInput, config: Config, context: Context) => FilterItemsResult;
+    type FilterItemsFunction<Config> = (request: FilterItemsInput, config: Config, context: Context) => FilterItemsResult;
     /**
      * Runs before invoices are created. Decides how items are grouped across one or more invoices.
      * @public
      */
-    type GroupItemsFunction<Config extends Record<string, unknown>> = (request: GroupItemsInput, config: Config, context: Context) => GroupItemsResult;
+    type GroupItemsFunction<Config> = (request: GroupItemsInput, config: Config, context: Context) => GroupItemsResult;
 }
 
 /**
  * @example
  * ```ts
- * import type { Billing, Context } from '@stripe/extensibility-sdk/extensions';
+ * import type { Billing, Context } from '@stripe/extensibility-sdk';
  *
  * // eslint-disable-next-line @typescript-eslint/no-empty-object-type
- * interface MyRecurringBillingItemHandlingConfig extends Record<string, unknown> {}
+ * interface MyRecurringBillingItemHandlingConfig {}
  *
  * export default class MyRecurringBillingItemHandling implements Billing.RecurringBillingItemHandling<MyRecurringBillingItemHandlingConfig> {
  *   beforeItemCreation(
@@ -1538,7 +1519,7 @@ declare namespace RecurringBillingItemHandling {
  * ```
  * @public
  */
-declare interface RecurringBillingItemHandling<Config extends Record<string, unknown>> {
+declare interface RecurringBillingItemHandling<Config> {
     beforeItemCreation: RecurringBillingItemHandling.BeforeItemCreationFunction<Config>;
     filterItems: RecurringBillingItemHandling.FilterItemsFunction<Config>;
     groupItems: RecurringBillingItemHandling.GroupItemsFunction<Config>;