@stripe/extensibility-sdk 0.22.4 → 0.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/dist/api-surface.d.ts.map +1 -0
  2. package/dist/config-values/generate.cjs +1 -1
  3. package/dist/config-values/generate.d.ts +2 -2
  4. package/dist/config-values/generate.d.ts.map +1 -1
  5. package/dist/config-values/generate.js +1 -1
  6. package/dist/extensibility-sdk-alpha.d.ts +1293 -1
  7. package/dist/extensibility-sdk-beta.d.ts +1293 -1
  8. package/dist/extensibility-sdk-config-values-internal.d.ts +2 -2
  9. package/dist/extensibility-sdk-extensions-alpha.d.ts +56 -77
  10. package/dist/extensibility-sdk-extensions-beta.d.ts +56 -77
  11. package/dist/extensibility-sdk-extensions-internal.d.ts +67 -110
  12. package/dist/extensibility-sdk-extensions-public.d.ts +56 -77
  13. package/dist/extensibility-sdk-internal.d.ts +1304 -1
  14. package/dist/extensibility-sdk-public.d.ts +1293 -1
  15. package/dist/extensions/billing/bill/discount_calculation.d.ts +3 -5
  16. package/dist/extensions/billing/customer_balance_application.d.ts +1 -3
  17. package/dist/extensions/billing/invoice_collection_setting.d.ts +11 -15
  18. package/dist/extensions/billing/prorations.d.ts +21 -30
  19. package/dist/extensions/billing/recurring_billing_item_handling.d.ts +23 -41
  20. package/dist/extensions/billing/types.d.ts +4 -4
  21. package/dist/extensions/core/workflows/custom_action.d.ts +2 -6
  22. package/dist/extensions/extend/workflows/custom_action.d.ts +2 -6
  23. package/dist/index.cjs +2317 -0
  24. package/dist/index.d.ts +2 -1
  25. package/dist/index.d.ts.map +1 -1
  26. package/dist/index.js +2320 -0
  27. package/dist/stdlib/decimal.d.ts +4 -40
  28. package/dist/stdlib/refs.d.ts +7 -21
  29. package/dist/stdlib/scalars.d.ts +16 -71
  30. package/dist/stdlib/type-utils.d.ts +1 -3
  31. package/dist/stdlib/types.d.ts +6 -6
  32. package/dist/tsconfig.build.tsbuildinfo +1 -1
  33. package/package.json +2 -10
  34. package/dist/extensibility-sdk-jsonschema-alpha.d.ts +0 -3
  35. package/dist/extensibility-sdk-jsonschema-beta.d.ts +0 -3
  36. package/dist/extensibility-sdk-jsonschema-internal.d.ts +0 -15
  37. package/dist/extensibility-sdk-jsonschema-public.d.ts +0 -3
  38. package/dist/jsonschema.cjs +0 -18
  39. package/dist/jsonschema.d.ts +0 -2
  40. package/dist/jsonschema.d.ts.map +0 -1
  41. package/dist/jsonschema.js +0 -0
@@ -4,7 +4,7 @@ import type { Decimal, _ConfigApplicationContext } from '../../../stdlib/index.j
4
4
  /** @public */
5
5
  export declare namespace DiscountCalculation {
6
6
  /** @public */
7
- 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';
7
+ 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';
8
8
  /** @public */
9
9
  type PricingTierMode = 'graduated' | 'volume';
10
10
  /** @public */
@@ -14,7 +14,7 @@ export declare namespace DiscountCalculation {
14
14
  /** @public */
15
15
  type UsageType = 'licensed' | 'metered';
16
16
  /** @public */
17
- type RecurringPriceInterval = 'day' | 'week' | 'month' | 'year';
17
+ type RecurringPriceInterval = 'day' | 'month' | 'week' | 'year';
18
18
  /**
19
19
  * The result of a discount calculation.
20
20
  * @public
@@ -174,9 +174,7 @@ export declare namespace DiscountCalculation {
174
174
  */
175
175
  function prepareResultComputeDiscounts(result: DiscountResult): DiscountResult;
176
176
  /** @internal */
177
- function $platformWrapComputeDiscounts(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => {
178
- computeDiscounts(...a: unknown[]): unknown;
179
- }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
177
+ function $platformWrapComputeDiscounts(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => { computeDiscounts(...a: unknown[]): unknown }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
180
178
  /**
181
179
  * @public
182
180
  * @deprecated Platform dispatch handles wire/SDK conversion.
@@ -32,9 +32,7 @@ export declare namespace CustomerBalanceApplication {
32
32
  */
33
33
  function prepareResultComputeAppliedCustomerBalance(result: CustomerBalanceApplicationResult): CustomerBalanceApplicationResult;
34
34
  /** @internal */
35
- function $platformWrapComputeAppliedCustomerBalance(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => {
36
- computeAppliedCustomerBalance(...a: unknown[]): unknown;
37
- }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
35
+ function $platformWrapComputeAppliedCustomerBalance(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => { computeAppliedCustomerBalance(...a: unknown[]): unknown }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
38
36
  /**
39
37
  * @public
40
38
  * @deprecated Platform dispatch handles wire/SDK conversion.
@@ -3,11 +3,11 @@ import type { _ConfigApplicationContext } from '../../stdlib/index.js';
3
3
  /** @public */
4
4
  export declare namespace InvoiceCollectionSetting {
5
5
  /** @public */
6
- type ParentType = 'subscription' | 'contract' | 'quote' | 'billing_cadence' | 'subscription_schedule' | 'standalone';
6
+ type ParentType = 'billing_cadence' | 'contract' | 'quote' | 'standalone' | 'subscription_schedule' | 'subscription';
7
7
  /** @public */
8
- 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';
8
+ 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';
9
9
  /** @public */
10
- type CollectionMethod = 'send_invoice' | 'charge_automatically';
10
+ type CollectionMethod = 'charge_automatically' | 'send_invoice';
11
11
  /**
12
12
  * The result of the invoice collection settings override extension.
13
13
  * @public
@@ -17,18 +17,16 @@ export declare namespace InvoiceCollectionSetting {
17
17
  autoAdvance?: boolean;
18
18
  }
19
19
  /** @public */
20
- type InvoiceCollectionRequest = {
21
- /** The current collection settings that would be applied to the invoice. */
22
- collectionSettings: CollectionSettings;
23
- /** The billing resource that triggered invoice creation. */
24
- parent: Parent;
25
- } & ({
26
- payer: 'customer';
20
+ type InvoiceCollectionRequest = ({
27
21
  customer: Customer;
22
+ payer: 'customer';
28
23
  } | {
29
- payer: 'other';
30
24
  otherPayer: string;
31
- });
25
+ payer: 'other';
26
+ }) & {
27
+ collectionSettings: CollectionSettings;
28
+ parent: Parent;
29
+ };
32
30
  /** @public */
33
31
  interface Customer {
34
32
  id: string;
@@ -69,9 +67,7 @@ export declare namespace InvoiceCollectionSetting {
69
67
  */
70
68
  function prepareResultCollectionOverride(result: InvoiceCollectionResponse): InvoiceCollectionResponse;
71
69
  /** @internal */
72
- function $platformWrapCollectionOverride(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => {
73
- collectionOverride(...a: unknown[]): unknown;
74
- }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
70
+ function $platformWrapCollectionOverride(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => { collectionOverride(...a: unknown[]): unknown }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
75
71
  /**
76
72
  * @public
77
73
  * @deprecated Platform dispatch handles wire/SDK conversion.
@@ -6,7 +6,7 @@ export declare namespace Prorations {
6
6
  /** @public */
7
7
  type PricingTierMode = 'graduated' | 'volume';
8
8
  /** @public */
9
- type RecurringPriceInterval = 'day' | 'week' | 'month' | 'year';
9
+ type RecurringPriceInterval = 'day' | 'month' | 'week' | 'year';
10
10
  /** @public */
11
11
  type PriceType = 'one_time' | 'recurring';
12
12
  /** @public */
@@ -44,37 +44,30 @@ export declare namespace Prorations {
44
44
  items: ProratableItem[];
45
45
  }
46
46
  /** @public */
47
- type ProratableItem = {
48
- /** Unique identifier for the item. */
49
- key: string;
50
- /** Either CREDIT or DEBIT based on whether the item is a credit or debit. */
51
- type: ItemType;
52
- /** Whether the item was generated from a proration event. */
53
- isProration: boolean;
54
- /** The time period this item covers. */
55
- servicePeriod: TimeRange;
56
- /** The default proration factor calculated by Stripe. */
57
- currentProrationFactor: Decimal;
58
- /** The duration of the price interval in seconds. */
59
- priceIntervalDuration: number;
60
- /** Information about the corresponding debit that a CREDIT item credits against. */
61
- correspondingDebit?: PreviousDebit;
62
- } & ({
63
- priceKind: 'price';
64
- price: Price;
47
+ type ProratableItem = ({
48
+ customPricingUnitOverageRate: CustomPricingUnitOverageRate;
49
+ priceKind: 'customPricingUnitOverageRate';
65
50
  } | {
66
- priceKind: 'licenseFee';
67
51
  licenseFee: LicenseFee;
52
+ priceKind: 'licenseFee';
68
53
  } | {
69
- priceKind: 'rateCardRate';
70
- rateCardRate: RateCardRate;
54
+ otherPriceKind: string;
55
+ priceKind: 'other';
71
56
  } | {
72
- priceKind: 'customPricingUnitOverageRate';
73
- customPricingUnitOverageRate: CustomPricingUnitOverageRate;
57
+ price: Price;
58
+ priceKind: 'price';
74
59
  } | {
75
- priceKind: 'other';
76
- otherPriceKind: string;
77
- });
60
+ priceKind: 'rateCardRate';
61
+ rateCardRate: RateCardRate;
62
+ }) & {
63
+ correspondingDebit?: PreviousDebit;
64
+ currentProrationFactor: Decimal;
65
+ isProration: boolean;
66
+ key: string;
67
+ priceIntervalDuration: number;
68
+ servicePeriod: TimeRange;
69
+ type: ItemType;
70
+ };
78
71
  /**
79
72
  * Information about a previous debit that a credit item offsets.
80
73
  * @public
@@ -172,9 +165,7 @@ export declare namespace Prorations {
172
165
  */
173
166
  function prepareResultProrateItems(result: ProrateItemsResult): ProrateItemsResult;
174
167
  /** @internal */
175
- function $platformWrapProrateItems(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => {
176
- prorateItems(...a: unknown[]): unknown;
177
- }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
168
+ function $platformWrapProrateItems(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => { prorateItems(...a: unknown[]): unknown }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
178
169
  /**
179
170
  * @public
180
171
  * @deprecated Platform dispatch handles wire/SDK conversion.
@@ -6,7 +6,7 @@ export declare namespace RecurringBillingItemHandling {
6
6
  /** @public */
7
7
  type PricingTierMode = 'graduated' | 'volume';
8
8
  /** @public */
9
- type RecurringPriceInterval = 'day' | 'week' | 'month' | 'year';
9
+ type RecurringPriceInterval = 'day' | 'month' | 'week' | 'year';
10
10
  /** @public */
11
11
  type PriceType = 'one_time' | 'recurring';
12
12
  /** @public */
@@ -50,33 +50,28 @@ export declare namespace RecurringBillingItemHandling {
50
50
  items: Item[];
51
51
  }
52
52
  /** @public */
53
- type Item = {
54
- /** Unique identifier for the item. */
55
- key: string;
56
- /** Either CREDIT or DEBIT based on whether the item is a credit or debit. */
57
- type: ItemType;
58
- /** Whether the item was generated from a proration event. */
59
- isProration: boolean;
60
- /** The time period this item covers. */
61
- servicePeriod: AnyTimeRange;
62
- /** The proration factor for this item. */
63
- prorationFactor: Decimal;
64
- } & ({
65
- priceKind: 'price';
66
- price: Price;
53
+ type Item = ({
54
+ customPricingUnitOverageRate: CustomPricingUnitOverageRate;
55
+ priceKind: 'customPricingUnitOverageRate';
67
56
  } | {
68
- priceKind: 'licenseFee';
69
57
  licenseFee: LicenseFee;
58
+ priceKind: 'licenseFee';
70
59
  } | {
71
- priceKind: 'rateCardRate';
72
- rateCardRate: RateCardRate;
60
+ otherPriceKind: string;
61
+ priceKind: 'other';
73
62
  } | {
74
- priceKind: 'customPricingUnitOverageRate';
75
- customPricingUnitOverageRate: CustomPricingUnitOverageRate;
63
+ price: Price;
64
+ priceKind: 'price';
76
65
  } | {
77
- priceKind: 'other';
78
- otherPriceKind: string;
79
- });
66
+ priceKind: 'rateCardRate';
67
+ rateCardRate: RateCardRate;
68
+ }) & {
69
+ isProration: boolean;
70
+ key: string;
71
+ prorationFactor: Decimal;
72
+ servicePeriod: AnyTimeRange;
73
+ type: ItemType;
74
+ };
80
75
  /** @public */
81
76
  interface CustomPricingUnitOverageRate {
82
77
  id: string;
@@ -188,17 +183,10 @@ export declare namespace RecurringBillingItemHandling {
188
183
  items: ItemWithCreationStrategy[];
189
184
  }
190
185
  /** @public */
191
- type ItemWithCreationStrategy = {
192
- /** The unique identifier of the item, matching a key from the input. */
193
- key: string;
194
- } & ({
195
- creationStrategy: 'doNotCreate';
196
- } | {
197
- creationStrategy: 'invoice';
198
- } | {
186
+ type ItemWithCreationStrategy = ({
199
187
  creationStrategy: 'other';
200
188
  otherCreationStrategy: string;
201
- });
189
+ } | { creationStrategy: 'doNotCreate' } | { creationStrategy: 'invoice' }) & { key: string };
202
190
  /** @public */
203
191
  type Invoice = Record<string, never>;
204
192
  /** @public */
@@ -222,9 +210,7 @@ export declare namespace RecurringBillingItemHandling {
222
210
  */
223
211
  function prepareResultBeforeItemCreation(result: BeforeItemCreationResult): BeforeItemCreationResult;
224
212
  /** @internal */
225
- function $platformWrapBeforeItemCreation(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => {
226
- beforeItemCreation(...a: unknown[]): unknown;
227
- }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
213
+ function $platformWrapBeforeItemCreation(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => { beforeItemCreation(...a: unknown[]): unknown }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
228
214
  /**
229
215
  * @public
230
216
  * @deprecated Platform dispatch handles wire/SDK conversion.
@@ -236,9 +222,7 @@ export declare namespace RecurringBillingItemHandling {
236
222
  */
237
223
  function prepareResultFilterItems(result: FilterItemsResult): FilterItemsResult;
238
224
  /** @internal */
239
- function $platformWrapFilterItems(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => {
240
- filterItems(...a: unknown[]): unknown;
241
- }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
225
+ function $platformWrapFilterItems(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => { filterItems(...a: unknown[]): unknown }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
242
226
  /**
243
227
  * @public
244
228
  * @deprecated Platform dispatch handles wire/SDK conversion.
@@ -250,9 +234,7 @@ export declare namespace RecurringBillingItemHandling {
250
234
  */
251
235
  function prepareResultGroupItems(result: GroupItemsResult): GroupItemsResult;
252
236
  /** @internal */
253
- function $platformWrapGroupItems(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => {
254
- groupItems(...a: unknown[]): unknown;
255
- }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
237
+ function $platformWrapGroupItems(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => { groupItems(...a: unknown[]): unknown }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
256
238
  /**
257
239
  * Runs before invoice items are created. Decides whether each item should be created or skipped.
258
240
  * @public
@@ -18,15 +18,15 @@ export interface TimeRange {
18
18
  }
19
19
  /** @public */
20
20
  export type AnyTimeRange = {
21
- value: 'oneTime';
22
21
  at: Date;
22
+ value: 'oneTime';
23
23
  } | {
24
- value: 'timeRange';
25
- startDate: Date;
26
24
  endDate: Date;
25
+ startDate: Date;
26
+ value: 'timeRange';
27
27
  } | {
28
- value: 'other';
29
28
  otherValue: string;
29
+ value: 'other';
30
30
  };
31
31
  /** @internal */
32
32
  export type { Currency, MonetaryAmount } from '../../stdlib/generated.js';
@@ -69,9 +69,7 @@ export declare namespace CustomAction {
69
69
  */
70
70
  function prepareResultExecute(result: ExecuteCustomActionResponse): ExecuteCustomActionResponse;
71
71
  /** @internal */
72
- function $platformWrapExecute(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => {
73
- execute(...a: unknown[]): unknown;
74
- }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
72
+ function $platformWrapExecute(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => { execute(...a: unknown[]): unknown }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
75
73
  /**
76
74
  * @public
77
75
  * @deprecated Platform dispatch handles wire/SDK conversion.
@@ -83,9 +81,7 @@ export declare namespace CustomAction {
83
81
  */
84
82
  function prepareResultGetFormState(result: GetFormStateResponse): GetFormStateResponse;
85
83
  /** @internal */
86
- function $platformWrapGetFormState(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => {
87
- getFormState(...a: unknown[]): unknown;
88
- }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
84
+ function $platformWrapGetFormState(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => { getFormState(...a: unknown[]): unknown }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
89
85
  /**
90
86
  * Executes the custom action at workflow runtime. Called when a workflow triggers this action, with the configured input values.
91
87
  * @public
@@ -69,9 +69,7 @@ export declare namespace CustomAction {
69
69
  */
70
70
  function prepareResultExecute(result: ExecuteCustomActionResponse): ExecuteCustomActionResponse;
71
71
  /** @internal */
72
- function $platformWrapExecute(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => {
73
- execute(...a: unknown[]): unknown;
74
- }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
72
+ function $platformWrapExecute(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => { execute(...a: unknown[]): unknown }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
75
73
  /**
76
74
  * @public
77
75
  * @deprecated Platform dispatch handles wire/SDK conversion.
@@ -83,9 +81,7 @@ export declare namespace CustomAction {
83
81
  */
84
82
  function prepareResultGetFormState(result: GetFormStateResponse): GetFormStateResponse;
85
83
  /** @internal */
86
- function $platformWrapGetFormState(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => {
87
- getFormState(...a: unknown[]): unknown;
88
- }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
84
+ function $platformWrapGetFormState(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => { getFormState(...a: unknown[]): unknown }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
89
85
  /**
90
86
  * Executes the custom action at workflow runtime. Called when a workflow triggers this action, with the configured input values.
91
87
  * @public