@stripe/extensibility-sdk 0.25.0 → 0.27.1

package/dist/extensions/billing/invoice_collection_setting.d.ts

@@ -1,117 +0,0 @@
-import type { Context } from '../context.js';
-import type { _ConfigApplicationContext } from '../../stdlib/index.js';
-/** @public */
-export declare namespace InvoiceCollectionSetting {
-    /** @public */
-    type ParentType = 'subscription' | 'contract' | 'quote' | 'billing_cadence' | 'subscription_schedule' | 'standalone';
-    /** @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';
-    /** @public */
-    type CollectionMethod = 'send_invoice' | 'charge_automatically';
-    /**
-     * The result of the invoice collection settings override extension.
-     * @public
-     */
-    interface InvoiceCollectionResponse {
-        /** Override the auto-advancement setting. Set to false to keep the invoice in draft. Return null to use the default. */
-        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';
-        customer: Customer;
-    } | {
-        payer: 'other';
-        otherPayer: string;
-    });
-    /** @public */
-    interface Customer {
-        id: string;
-        metadata: Record<string, string>;
-    }
-    /**
-     * The parent resource that triggered the invoice creation.
-     * @public
-     */
-    interface Parent {
-        /** The type of parent resource (for example, subscription or contract). */
-        type: ParentType;
-        /** Custom key-value pairs attached to the parent resource. */
-        metadata: Record<string, string>;
-    }
-    /**
-     * The collection settings for an invoice.
-     * @public
-     */
-    interface CollectionSettings {
-        /** Whether the invoice automatically advances through its lifecycle. */
-        autoAdvance: boolean;
-        /** The payment collection method: charge_automatically or send_invoice. */
-        collectionMethod: CollectionMethod;
-        /** The delay before the invoice is finalized, in hours. */
-        finalizationGracePeriod: number;
-        /** The payment methods configured for this invoice. */
-        paymentMethods: PaymentMethodType[];
-    }
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    function prepareArgsCollectionOverride(proto: unknown): InvoiceCollectionRequest;
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    function prepareResultCollectionOverride(result: InvoiceCollectionResponse): InvoiceCollectionResponse;
-    /** @internal */
-    function $platformWrapCollectionOverride(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => {
-        collectionOverride(...a: unknown[]): unknown;
-    }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    const prepareArgs: typeof prepareArgsCollectionOverride;
-    /**
-     * @public
-     * @deprecated Platform dispatch handles wire/SDK conversion.
-     */
-    const prepareResult: typeof prepareResultCollectionOverride;
-    /**
-     * Overrides invoice collection settings before a draft invoice is created.
-     * @public
-     */
-    type CollectionOverrideFunction<Config> = (request: InvoiceCollectionRequest, config: Config, context: Context) => InvoiceCollectionResponse;
-}
-/**
- * @example
- * ```ts
- * import type { Billing, Context } from '@stripe/extensibility-sdk';
- *
- * // eslint-disable-next-line @typescript-eslint/no-empty-object-type
- * interface MyInvoiceCollectionSettingConfig {}
- *
- * export default class MyInvoiceCollectionSetting implements Billing.InvoiceCollectionSetting<MyInvoiceCollectionSettingConfig> {
- *   collectionOverride(
- *     _request: Billing.InvoiceCollectionSetting.InvoiceCollectionRequest,
- *     _config: MyInvoiceCollectionSettingConfig,
- *     _context: Context
- *   ) {
- *     // TODO: implement your collection setting logic here
- *
- *     return {};
- *   }
- * }
- *
- * ```
- * @public
- */
-export interface InvoiceCollectionSetting<Config> {
-    collectionOverride: InvoiceCollectionSetting.CollectionOverrideFunction<Config>;
-}
-//# sourceMappingURL=invoice_collection_setting.d.ts.map

package/dist/extensions/billing/invoice_collection_setting.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"invoice_collection_setting.d.ts","sourceRoot":"","sources":["../../../src/extensions/billing/invoice_collection_setting.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAE7C,OAAO,KAAK,EAEV,yBAAyB,EAI1B,MAAM,uBAAuB,CAAC;AAwB/B,cAAc;AACd,yBAAiB,wBAAwB,CAAC;IACxC,cAAc;IACd,KAAY,UAAU,GAClB,cAAc,GACd,UAAU,GACV,OAAO,GACP,iBAAiB,GACjB,uBAAuB,GACvB,YAAY,CAAC;IAEjB,cAAc;IACd,KAAY,iBAAiB,GACzB,MAAM,GACN,WAAW,GACX,qBAAqB,GACrB,YAAY,GACZ,sBAAsB,GACtB,YAAY,GACZ,eAAe,GACf,iBAAiB,GACjB,MAAM,GACN,QAAQ,GACR,MAAM,GACN,OAAO,GACP,YAAY,GACZ,SAAS,GACT,KAAK,GACL,KAAK,GACL,QAAQ,GACR,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,QAAQ,GACR,mBAAmB,GACnB,SAAS,GACT,QAAQ,GACR,YAAY,GACZ,SAAS,GACT,WAAW,GACX,QAAQ,GACR,SAAS,GACT,KAAK,CAAC;IAEV,cAAc;IACd,KAAY,gBAAgB,GAAG,cAAc,GAAG,sBAAsB,CAAC;IAEvE;;;OAGG;IACH,UAAiB,yBAAyB;QACxC,wHAAwH;QACxH,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB;IAED,cAAc;IACd,KAAY,wBAAwB,GAAG;QACrC,4EAA4E;QAC5E,kBAAkB,EAAE,kBAAkB,CAAC;QACvC,4DAA4D;QAC5D,MAAM,EAAE,MAAM,CAAC;KAChB,GAAG,CACA;QAAE,KAAK,EAAE,UAAU,CAAC;QAAC,QAAQ,EAAE,QAAQ,CAAA;KAAE,GACzC;QAAE,KAAK,EAAE,OAAO,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CACzC,CAAC;IAEF,cAAc;IACd,UAAiB,QAAQ;QACvB,EAAE,EAAE,MAAM,CAAC;QACX,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAClC;IAED;;;OAGG;IACH,UAAiB,MAAM;QACrB,2EAA2E;QAC3E,IAAI,EAAE,UAAU,CAAC;QACjB,8DAA8D;QAC9D,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAClC;IAED;;;OAGG;IACH,UAAiB,kBAAkB;QACjC,wEAAwE;QACxE,WAAW,EAAE,OAAO,CAAC;QACrB,2EAA2E;QAC3E,gBAAgB,EAAE,gBAAgB,CAAC;QACnC,2DAA2D;QAC3D,uBAAuB,EAAE,MAAM,CAAC;QAChC,uDAAuD;QACvD,cAAc,EAAE,iBAAiB,EAAE,CAAC;KACrC;IAuHD;;;OAGG;IACH,SAAgB,6BAA6B,CAC3C,KAAK,EAAE,OAAO,GACb,wBAAwB,CAW1B;IAED;;;OAGG;IACH,SAAgB,+BAA+B,CAC7C,MAAM,EAAE,yBAAyB,GAChC,yBAAyB,CAQ3B;IAED,gBAAgB;IAChB,SAAgB,+BAA+B,CAC7C,iBAAiB,CAAC,EAAE,CAClB,UAAU,EAAE,OAAO,EACnB,MAAM,EAAE,yBAAyB,KAC9B,OAAO,GACX,CACD,GAAG,EAAE,UAAU;QAAE,kBAAkB,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAA;KAAE,EAC/D,QAAQ,EAAE,OAAO,EACjB,UAAU,EAAE,OAAO,EACnB,GAAG,EAAE,OAAO,KACT,OAAO,CA0BX;IAID;;;OAGG;IACI,MAAM,WAAW,sCAAoB,CAAC;IAG7C;;;OAGG;IACI,MAAM,aAAa,wCAAsB,CAAC;IAEjD;;;OAGG;IACH,KAAY,0BAA0B,CAAC,MAAM,IAAI,CAC/C,OAAO,EAAE,wBAAwB,EACjC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,OAAO,KACb,yBAAyB,CAAC;CAChC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,wBAAwB,CAAC,MAAM;IAC9C,kBAAkB,EAAE,wBAAwB,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC;CACjF"}