@stripe/extensibility-sdk 1.0.1 → 1.3.0

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

@@ -107,7 +107,7 @@ declare namespace Core {
 export { Core }
 
 /** @public */
-declare type Currency = 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'apt' | 'arb' | 'ars' | 'aud' | 'avax' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bhd' | 'bif' | 'bmd' | 'bnb' | 'bnd' | 'bob' | 'bov' | 'brl' | 'bsd' | 'btc' | 'btn' | 'buidl' | 'bwp' | 'byn' | 'byr' | 'bzd' | 'cad' | 'cdf' | 'celo' | 'che' | 'chf' | 'chw' | 'clf' | 'clp' | 'cny' | 'cop' | 'cou' | 'crc' | 'cuc' | 'cup' | 'cve' | 'czk' | 'dai' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'eek' | 'egp' | 'ern' | 'etb' | 'eth' | 'eur' | 'eurc' | 'fjd' | 'fkp' | 'frxusd' | 'gbp' | 'gel' | 'ghc' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gyd' | 'hkd' | 'hnl' | 'hrk' | 'htg' | 'huf' | 'hype' | 'idr' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'kzt' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'lzd' | 'm' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mru' | 'mur' | 'mvr' | 'mwk' | 'mxn' | 'mxv' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pen' | 'pgk' | 'php' | 'pkr' | 'pln' | 'pol' | 'pyg' | 'pyusd' | 'qar' | 'rd' | 're' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sll' | 'sol' | 'sos' | 'srd' | 'ssp' | 'std' | 'stn' | 'sui' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'trx' | 'try' | 'ttd' | 'twd' | 'tzs' | 'uah' | 'ugx' | 'usd' | 'usdb' | 'usdc' | 'usdg' | 'usdp' | 'usdt' | 'usn' | 'ustb' | 'uyi' | 'uyu' | 'uzs' | 'vef' | 'ves' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xcg' | 'xeur' | 'xlm' | 'xof' | 'xpf' | 'xpl' | 'xusd' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwg' | 'zwl';
+declare type Currency = 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'apt' | 'arb' | 'ars' | 'aud' | 'avax' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bhd' | 'bif' | 'bmd' | 'bnb' | 'bnd' | 'bob' | 'bov' | 'brl' | 'bsd' | 'btc' | 'btn' | 'buidl' | 'bwp' | 'byn' | 'byr' | 'bzd' | 'cad' | 'cdf' | 'celo' | 'che' | 'chf' | 'chw' | 'clf' | 'clp' | 'cny' | 'cop' | 'cou' | 'crc' | 'cuc' | 'cup' | 'cve' | 'czk' | 'dai' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'eek' | 'egp' | 'ern' | 'etb' | 'eth' | 'eur' | 'eurc' | 'fjd' | 'fkp' | 'frxusd' | 'gbp' | 'gel' | 'ghc' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gyd' | 'hkd' | 'hnl' | 'hrk' | 'htg' | 'huf' | 'hype' | 'idr' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'kzt' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'ltl' | 'lvl' | 'lyd' | 'lzd' | 'm' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mon' | 'mop' | 'mro' | 'mru' | 'mur' | 'mvr' | 'mwk' | 'mxn' | 'mxv' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'open_usd' | 'ord' | 'pab' | 'pen' | 'pgk' | 'php' | 'pkr' | 'pln' | 'pol' | 'pyg' | 'pyusd' | 'qar' | 'rd' | 're' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sll' | 'sol' | 'sos' | 'srd' | 'ssp' | 'std' | 'stn' | 'sui' | 'svc' | 'syp' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'trx' | 'try' | 'ttd' | 'twd' | 'tzs' | 'uah' | 'ugx' | 'usd' | 'usdb' | 'usdc' | 'usdg' | 'usdp' | 'usdsui' | 'usdt' | 'usn' | 'ustb' | 'uyi' | 'uyu' | 'uzs' | 'vef' | 'ves' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xcg' | 'xeur' | 'xlm' | 'xof' | 'xpf' | 'xpl' | 'xusd' | 'yer' | 'zar' | 'zmk' | 'zmw' | 'zwd' | 'zwg' | 'zwl';
 
 /** @public */
 declare namespace CustomAction {
@@ -117,7 +117,7 @@ declare namespace CustomAction {
      */
     interface GetFormStateResponse {
         /** Updated form field values. Use this to set defaults, clear dependent fields when a parent changes, or preserve matching values across schema changes. Only fields included here are updated. Omitted fields keep their current values. */
-        values: Record<string, unknown>;
+        values?: Record<string, unknown>;
         /** Per-field configuration keyed by field name. */
         config: Record<string, FormStateFieldConfig>;
     }
@@ -167,27 +167,7 @@ declare namespace CustomAction {
         /** Custom input data for the action, validated against the app's input_schema. Contains the field values configured by the user in the workflow builder. */
         customInput: Record<string, unknown>;
     }
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    function prepareArgsExecute(proto: unknown): ExecuteCustomActionRequest;
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    function prepareResultExecute(result: ExecuteCustomActionResponse): ExecuteCustomActionResponse;
     /* Excluded from this release type: $platformWrapExecute */
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    function prepareArgsGetFormState(proto: unknown): GetFormStateRequest;
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    function prepareResultGetFormState(result: GetFormStateResponse): GetFormStateResponse;
     /* Excluded from this release type: $platformWrapGetFormState */
     /**
      * Executes the custom action at workflow runtime. Called when a workflow triggers this action, with the configured input values.
@@ -251,7 +231,7 @@ declare namespace CustomAction_2 {
      */
     interface GetFormStateResponse {
         /** Updated form field values. Use this to set defaults, clear dependent fields when a parent changes, or preserve matching values across schema changes. Only fields included here are updated. Omitted fields keep their current values. */
-        values: Record<string, unknown>;
+        values?: Record<string, unknown>;
         /** Per-field configuration keyed by field name. */
         config: Record<string, FormStateFieldConfig>;
     }
@@ -301,27 +281,7 @@ declare namespace CustomAction_2 {
         /** Custom input data for the action, validated against the app's input_schema. Contains the field values configured by the user in the workflow builder. */
         customInput: Record<string, unknown>;
     }
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    function prepareArgsExecute(proto: unknown): ExecuteCustomActionRequest;
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    function prepareResultExecute(result: ExecuteCustomActionResponse): ExecuteCustomActionResponse;
     /* Excluded from this release type: $platformWrapExecute */
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    function prepareArgsGetFormState(proto: unknown): GetFormStateRequest;
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    function prepareResultGetFormState(result: GetFormStateResponse): GetFormStateResponse;
     /* Excluded from this release type: $platformWrapGetFormState */
     /**
      * Executes the custom action at workflow runtime. Called when a workflow triggers this action, with the configured input values.
@@ -397,27 +357,7 @@ declare namespace CustomerBalanceApplication {
         /** The current customer balance available to apply. Positive values indicate debits (the customer owes money), negative values indicate credits. */
         customerBalance: MonetaryAmount;
     }
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    function prepareArgsComputeAppliedCustomerBalance(proto: unknown): CustomerBalanceApplicationInput;
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    function prepareResultComputeAppliedCustomerBalance(result: CustomerBalanceApplicationResult): CustomerBalanceApplicationResult;
     /* Excluded from this release type: $platformWrapComputeAppliedCustomerBalance */
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    const prepareArgs: typeof prepareArgsComputeAppliedCustomerBalance;
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    const prepareResult: typeof prepareResultComputeAppliedCustomerBalance;
     /**
      * 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
@@ -855,27 +795,7 @@ declare namespace DiscountCalculation {
         /** Custom key-value pairs attached to the product. */
         metadata: Record<string, string>;
     }
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    function prepareArgsComputeDiscounts(proto: unknown): DiscountableItem;
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    function prepareResultComputeDiscounts(result: DiscountResult): DiscountResult;
     /* Excluded from this release type: $platformWrapComputeDiscounts */
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    const prepareArgs: typeof prepareArgsComputeDiscounts;
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    const prepareResult: typeof prepareResultComputeDiscounts;
     /**
      * Computes discount amounts for a discountable item and returns a discount result.
      * @public
@@ -975,8 +895,8 @@ declare namespace InvoiceCollectionOptions {
      * @public
      */
     interface InvoiceCollectionOptionsResult {
-        /** Override the auto-advancement setting. Set to false to keep the invoice in draft. Return null to use the default. */
-        autoAdvance?: boolean;
+        /** Override the auto-advancement setting. Set to false to keep the invoice in draft. */
+        autoAdvance: boolean;
     }
     /** @public */
     type InvoiceCollectionOptionsInput = ({
@@ -1027,27 +947,7 @@ declare namespace InvoiceCollectionOptions {
         /** The payment methods configured for this invoice. */
         paymentMethods: PaymentMethodType[];
     }
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    function prepareArgsOverrideOptions(proto: unknown): InvoiceCollectionOptionsInput;
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    function prepareResultOverrideOptions(result: InvoiceCollectionOptionsResult): InvoiceCollectionOptionsResult;
     /* Excluded from this release type: $platformWrapOverrideOptions */
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    const prepareArgs: typeof prepareArgsOverrideOptions;
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    const prepareResult: typeof prepareResultOverrideOptions;
     /**
      * Overrides invoice collection options before a draft invoice is created.
      * @public
@@ -1065,13 +965,13 @@ declare namespace InvoiceCollectionOptions {
  *
  * export default class MyInvoiceCollectionOptions implements Billing.InvoiceCollectionOptions<MyInvoiceCollectionOptionsConfig> {
  *   overrideOptions(
- *     _request: Billing.InvoiceCollectionOptions.InvoiceCollectionOptionsInput,
+ *     request: Billing.InvoiceCollectionOptions.InvoiceCollectionOptionsInput,
  *     _config: MyInvoiceCollectionOptionsConfig,
  *     _context: Context
  *   ) {
  *     // TODO: implement your collection setting logic here
  *
- *     return {};
+ *     return { autoAdvance: request.collectionOptions.autoAdvance };
  *   }
  * }
  *
@@ -1302,27 +1202,7 @@ declare namespace Prorations {
         name: string;
         metadata: Record<string, string>;
     }
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    function prepareArgsProrateItems(proto: unknown): ProrateItemsInput;
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    function prepareResultProrateItems(result: ProrateItemsResult): ProrateItemsResult;
     /* Excluded from this release type: $platformWrapProrateItems */
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    const prepareArgs: typeof prepareArgsProrateItems;
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    const prepareResult: typeof prepareResultProrateItems;
     /**
      * 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
@@ -1600,38 +1480,8 @@ declare namespace RecurringBillingItemHandling {
         /** The list of items to evaluate for creation. */
         items: Item[];
     }
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    function prepareArgsBeforeItemCreation(proto: unknown): BeforeItemCreationInput;
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    function prepareResultBeforeItemCreation(result: BeforeItemCreationResult): BeforeItemCreationResult;
     /* Excluded from this release type: $platformWrapBeforeItemCreation */
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    function prepareArgsFilterItems(proto: unknown): FilterItemsInput;
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    function prepareResultFilterItems(result: FilterItemsResult): FilterItemsResult;
     /* Excluded from this release type: $platformWrapFilterItems */
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    function prepareArgsGroupItems(proto: unknown): GroupItemsInput;
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    function prepareResultGroupItems(result: GroupItemsResult): GroupItemsResult;
     /* Excluded from this release type: $platformWrapGroupItems */
     /**
      * Runs before invoice items are created. Decides whether each item should be created or skipped.