@stripe/extensibility-sdk 0.22.4 → 0.23.0

package/dist/extensibility-sdk-config-values-internal.d.ts

@@ -94,11 +94,11 @@ export declare type ScalarFieldClassification = {
 };
 
 /**
- * The package specifier for the stdlib module used in generated import lines.
+ * The package specifier used in generated import lines for stdlib types.
  *
  * @internal
  */
-export declare const STDLIB_IMPORT_PATH = "@stripe/extensibility-sdk/stdlib";
+export declare const STDLIB_IMPORT_PATH = "@stripe/extensibility-sdk";
 
 /** @internal */
 export declare type StructuralFieldClassification = {

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

@@ -26,15 +26,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 {
@@ -643,7 +643,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 +653,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
@@ -871,11 +871,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 +885,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;
@@ -1017,7 +1015,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 +1053,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
@@ -1234,7 +1225,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 +1269,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 +1402,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 */

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

@@ -26,15 +26,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 {
@@ -643,7 +643,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 +653,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
@@ -871,11 +871,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 +885,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;
@@ -1017,7 +1015,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 +1053,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
@@ -1234,7 +1225,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 +1269,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 +1402,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 */