@stripe/extensibility-sdk 1.0.1 → 1.3.0

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

@@ -0,0 +1,110 @@
+/* Excluded from this release type: _ConfigApplicationContext */
+
+/** @public */
+declare interface Context {
+    type: string;
+    id: string;
+    livemode: boolean;
+    stripeContext?: string;
+    clockTime?: string;
+}
+
+/** @public */
+export declare namespace InvoiceCollectionOptions {
+    /** @public */
+    export type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'blik' | '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 */
+    export type CollectionMethod = 'charge_automatically' | 'send_invoice';
+    /**
+     * The result of the invoice collection options override extension.
+     * @public
+     */
+    export interface InvoiceCollectionOptionsResult {
+        /** Override the auto-advancement setting. Set to false to keep the invoice in draft. */
+        autoAdvance: boolean;
+    }
+    /** @public */
+    export type InvoiceCollectionOptionsInput = ({
+        customer: Customer;
+        payer: 'customer';
+    } | {
+        otherPayer: string;
+        payer: 'other';
+    } | { payer?: never }) & ({
+        invoiceParentType: 'other';
+        otherInvoiceParentType: string;
+    } | {
+        invoiceParentType: 'subscription';
+        subscription: SubscriptionParent;
+    } | { invoiceParentType: 'cadence' } | { invoiceParentType: 'contract' } | { invoiceParentType: 'quote' } | { invoiceParentType: 'schedule' } | { invoiceParentType?: never }) & { collectionOptions: CollectionOptions };
+    /** @public */
+    export interface Customer {
+        id: string;
+        metadata: Record<string, string>;
+    }
+    /** @public */
+    export type ContractParent = Record<string, never>;
+    /**
+     * The Subscription that triggered the invoice creation.
+     * @public
+     */
+    export interface SubscriptionParent {
+        /** The unique identifier for the subscription. */
+        id: string;
+        /** The metadata of the subscription. */
+        metadata: Record<string, string>;
+    }
+    /** @public */
+    export type ScheduleParent = Record<string, never>;
+    /** @public */
+    export type QuoteParent = Record<string, never>;
+    /** @public */
+    export type CadenceParent = Record<string, never>;
+    /**
+     * The collection options for an invoice.
+     * @public
+     */
+    export interface CollectionOptions {
+        /** Whether the invoice automatically advances through its lifecycle. */
+        autoAdvance: boolean;
+        /** The payment collection method: charge_automatically or send_invoice. */
+        collectionMethod: CollectionMethod;
+        /** The payment methods configured for this invoice. */
+        paymentMethods: PaymentMethodType[];
+    }
+    /* Excluded from this release type: $platformWrapOverrideOptions */
+    /**
+     * Overrides invoice collection options before a draft invoice is created.
+     * @public
+     */
+    export type OverrideOptionsFunction<Config> = (request: InvoiceCollectionOptionsInput, config: Config, context: Context) => InvoiceCollectionOptionsResult;
+}
+
+/**
+ * @example
+ * ```ts
+ * import type { Billing, Context } from '@stripe/extensibility-sdk';
+ *
+ * // eslint-disable-next-line @typescript-eslint/no-empty-object-type
+ * interface MyInvoiceCollectionOptionsConfig {}
+ *
+ * export default class MyInvoiceCollectionOptions implements Billing.InvoiceCollectionOptions<MyInvoiceCollectionOptionsConfig> {
+ *   overrideOptions(
+ *     request: Billing.InvoiceCollectionOptions.InvoiceCollectionOptionsInput,
+ *     _config: MyInvoiceCollectionOptionsConfig,
+ *     _context: Context
+ *   ) {
+ *     // TODO: implement your collection setting logic here
+ *
+ *     return { autoAdvance: request.collectionOptions.autoAdvance };
+ *   }
+ * }
+ *
+ * ```
+ * @public
+ */
+export declare interface InvoiceCollectionOptions<Config> {
+    overrideOptions: InvoiceCollectionOptions.OverrideOptionsFunction<Config>;
+}
+
+export { }

package/dist/extensibility-sdk-extensions-billing-invoice_collection_options-internal.d.ts

@@ -0,0 +1,123 @@
+/**
+ * Context values threaded into config application at runtime.
+ *
+ * The platform dispatch layer builds this from the extension context
+ * (`_configAppContextFromContext`) and passes it through the config
+ * transformer into `_applyConfig`.
+ *
+ * @internal
+ */
+declare interface _ConfigApplicationContext {
+    /** ISO 8601 clock time for Billing test clocks. */
+    clockTime?: string;
+}
+
+/** @public */
+declare interface Context {
+    type: string;
+    id: string;
+    livemode: boolean;
+    stripeContext?: string;
+    clockTime?: string;
+}
+
+/** @public */
+export declare namespace InvoiceCollectionOptions {
+    /** @public */
+    export type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'blik' | '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 */
+    export type CollectionMethod = 'charge_automatically' | 'send_invoice';
+    /**
+     * The result of the invoice collection options override extension.
+     * @public
+     */
+    export interface InvoiceCollectionOptionsResult {
+        /** Override the auto-advancement setting. Set to false to keep the invoice in draft. */
+        autoAdvance: boolean;
+    }
+    /** @public */
+    export type InvoiceCollectionOptionsInput = ({
+        customer: Customer;
+        payer: 'customer';
+    } | {
+        otherPayer: string;
+        payer: 'other';
+    } | { payer?: never }) & ({
+        invoiceParentType: 'other';
+        otherInvoiceParentType: string;
+    } | {
+        invoiceParentType: 'subscription';
+        subscription: SubscriptionParent;
+    } | { invoiceParentType: 'cadence' } | { invoiceParentType: 'contract' } | { invoiceParentType: 'quote' } | { invoiceParentType: 'schedule' } | { invoiceParentType?: never }) & { collectionOptions: CollectionOptions };
+    /** @public */
+    export interface Customer {
+        id: string;
+        metadata: Record<string, string>;
+    }
+    /** @public */
+    export type ContractParent = Record<string, never>;
+    /**
+     * The Subscription that triggered the invoice creation.
+     * @public
+     */
+    export interface SubscriptionParent {
+        /** The unique identifier for the subscription. */
+        id: string;
+        /** The metadata of the subscription. */
+        metadata: Record<string, string>;
+    }
+    /** @public */
+    export type ScheduleParent = Record<string, never>;
+    /** @public */
+    export type QuoteParent = Record<string, never>;
+    /** @public */
+    export type CadenceParent = Record<string, never>;
+    /**
+     * The collection options for an invoice.
+     * @public
+     */
+    export interface CollectionOptions {
+        /** Whether the invoice automatically advances through its lifecycle. */
+        autoAdvance: boolean;
+        /** The payment collection method: charge_automatically or send_invoice. */
+        collectionMethod: CollectionMethod;
+        /** The payment methods configured for this invoice. */
+        paymentMethods: PaymentMethodType[];
+    }
+    /** @internal */
+    export function $platformWrapOverrideOptions(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => { overrideOptions(...a: unknown[]): unknown }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
+    /**
+     * Overrides invoice collection options before a draft invoice is created.
+     * @public
+     */
+    export type OverrideOptionsFunction<Config> = (request: InvoiceCollectionOptionsInput, config: Config, context: Context) => InvoiceCollectionOptionsResult;
+}
+
+/**
+ * @example
+ * ```ts
+ * import type { Billing, Context } from '@stripe/extensibility-sdk';
+ *
+ * // eslint-disable-next-line @typescript-eslint/no-empty-object-type
+ * interface MyInvoiceCollectionOptionsConfig {}
+ *
+ * export default class MyInvoiceCollectionOptions implements Billing.InvoiceCollectionOptions<MyInvoiceCollectionOptionsConfig> {
+ *   overrideOptions(
+ *     request: Billing.InvoiceCollectionOptions.InvoiceCollectionOptionsInput,
+ *     _config: MyInvoiceCollectionOptionsConfig,
+ *     _context: Context
+ *   ) {
+ *     // TODO: implement your collection setting logic here
+ *
+ *     return { autoAdvance: request.collectionOptions.autoAdvance };
+ *   }
+ * }
+ *
+ * ```
+ * @public
+ */
+export declare interface InvoiceCollectionOptions<Config> {
+    overrideOptions: InvoiceCollectionOptions.OverrideOptionsFunction<Config>;
+}
+
+export { }

package/dist/extensibility-sdk-extensions-billing-invoice_collection_options-public.d.ts

@@ -0,0 +1,110 @@
+/* Excluded from this release type: _ConfigApplicationContext */
+
+/** @public */
+declare interface Context {
+    type: string;
+    id: string;
+    livemode: boolean;
+    stripeContext?: string;
+    clockTime?: string;
+}
+
+/** @public */
+export declare namespace InvoiceCollectionOptions {
+    /** @public */
+    export type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'blik' | '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 */
+    export type CollectionMethod = 'charge_automatically' | 'send_invoice';
+    /**
+     * The result of the invoice collection options override extension.
+     * @public
+     */
+    export interface InvoiceCollectionOptionsResult {
+        /** Override the auto-advancement setting. Set to false to keep the invoice in draft. */
+        autoAdvance: boolean;
+    }
+    /** @public */
+    export type InvoiceCollectionOptionsInput = ({
+        customer: Customer;
+        payer: 'customer';
+    } | {
+        otherPayer: string;
+        payer: 'other';
+    } | { payer?: never }) & ({
+        invoiceParentType: 'other';
+        otherInvoiceParentType: string;
+    } | {
+        invoiceParentType: 'subscription';
+        subscription: SubscriptionParent;
+    } | { invoiceParentType: 'cadence' } | { invoiceParentType: 'contract' } | { invoiceParentType: 'quote' } | { invoiceParentType: 'schedule' } | { invoiceParentType?: never }) & { collectionOptions: CollectionOptions };
+    /** @public */
+    export interface Customer {
+        id: string;
+        metadata: Record<string, string>;
+    }
+    /** @public */
+    export type ContractParent = Record<string, never>;
+    /**
+     * The Subscription that triggered the invoice creation.
+     * @public
+     */
+    export interface SubscriptionParent {
+        /** The unique identifier for the subscription. */
+        id: string;
+        /** The metadata of the subscription. */
+        metadata: Record<string, string>;
+    }
+    /** @public */
+    export type ScheduleParent = Record<string, never>;
+    /** @public */
+    export type QuoteParent = Record<string, never>;
+    /** @public */
+    export type CadenceParent = Record<string, never>;
+    /**
+     * The collection options for an invoice.
+     * @public
+     */
+    export interface CollectionOptions {
+        /** Whether the invoice automatically advances through its lifecycle. */
+        autoAdvance: boolean;
+        /** The payment collection method: charge_automatically or send_invoice. */
+        collectionMethod: CollectionMethod;
+        /** The payment methods configured for this invoice. */
+        paymentMethods: PaymentMethodType[];
+    }
+    /* Excluded from this release type: $platformWrapOverrideOptions */
+    /**
+     * Overrides invoice collection options before a draft invoice is created.
+     * @public
+     */
+    export type OverrideOptionsFunction<Config> = (request: InvoiceCollectionOptionsInput, config: Config, context: Context) => InvoiceCollectionOptionsResult;
+}
+
+/**
+ * @example
+ * ```ts
+ * import type { Billing, Context } from '@stripe/extensibility-sdk';
+ *
+ * // eslint-disable-next-line @typescript-eslint/no-empty-object-type
+ * interface MyInvoiceCollectionOptionsConfig {}
+ *
+ * export default class MyInvoiceCollectionOptions implements Billing.InvoiceCollectionOptions<MyInvoiceCollectionOptionsConfig> {
+ *   overrideOptions(
+ *     request: Billing.InvoiceCollectionOptions.InvoiceCollectionOptionsInput,
+ *     _config: MyInvoiceCollectionOptionsConfig,
+ *     _context: Context
+ *   ) {
+ *     // TODO: implement your collection setting logic here
+ *
+ *     return { autoAdvance: request.collectionOptions.autoAdvance };
+ *   }
+ * }
+ *
+ * ```
+ * @public
+ */
+export declare interface InvoiceCollectionOptions<Config> {
+    overrideOptions: InvoiceCollectionOptions.OverrideOptionsFunction<Config>;
+}
+
+export { }