@stripe/extensibility-sdk 1.0.1 → 1.3.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.
- package/README.md +17 -15
- package/dist/config-values/generate.cjs +1 -1
- package/dist/config-values/generate.d.ts +1 -1
- package/dist/config-values/generate.d.ts.map +1 -1
- package/dist/config-values/generate.js +1 -1
- package/dist/extensibility-sdk-alpha.d.ts +29 -157
- package/dist/extensibility-sdk-beta.d.ts +29 -157
- package/dist/extensibility-sdk-config-values-internal.d.ts +1 -1
- package/dist/extensibility-sdk-extensions-alpha.d.ts +7 -157
- package/dist/extensibility-sdk-extensions-beta.d.ts +7 -157
- package/dist/extensibility-sdk-extensions-billing-bill-discount_calculation-alpha.d.ts +631 -0
- package/dist/extensibility-sdk-extensions-billing-bill-discount_calculation-beta.d.ts +631 -0
- package/dist/extensibility-sdk-extensions-billing-bill-discount_calculation-internal.d.ts +666 -0
- package/dist/extensibility-sdk-extensions-billing-bill-discount_calculation-public.d.ts +631 -0
- package/dist/extensibility-sdk-extensions-billing-customer_balance_application-alpha.d.ts +475 -0
- package/dist/extensibility-sdk-extensions-billing-customer_balance_application-beta.d.ts +475 -0
- package/dist/extensibility-sdk-extensions-billing-customer_balance_application-internal.d.ts +510 -0
- package/dist/extensibility-sdk-extensions-billing-customer_balance_application-public.d.ts +475 -0
- package/dist/extensibility-sdk-extensions-billing-invoice_collection_options-alpha.d.ts +110 -0
- package/dist/extensibility-sdk-extensions-billing-invoice_collection_options-beta.d.ts +110 -0
- package/dist/extensibility-sdk-extensions-billing-invoice_collection_options-internal.d.ts +123 -0
- package/dist/extensibility-sdk-extensions-billing-invoice_collection_options-public.d.ts +110 -0
- package/dist/extensibility-sdk-extensions-billing-prorations-alpha.d.ts +607 -0
- package/dist/extensibility-sdk-extensions-billing-prorations-beta.d.ts +607 -0
- package/dist/extensibility-sdk-extensions-billing-prorations-internal.d.ts +642 -0
- package/dist/extensibility-sdk-extensions-billing-prorations-public.d.ts +607 -0
- package/dist/extensibility-sdk-extensions-billing-recurring_billing_item_handling-alpha.d.ts +735 -0
- package/dist/extensibility-sdk-extensions-billing-recurring_billing_item_handling-beta.d.ts +735 -0
- package/dist/extensibility-sdk-extensions-billing-recurring_billing_item_handling-internal.d.ts +772 -0
- package/dist/extensibility-sdk-extensions-billing-recurring_billing_item_handling-public.d.ts +735 -0
- package/dist/extensibility-sdk-extensions-core-workflows-custom_action-alpha.d.ts +126 -0
- package/dist/extensibility-sdk-extensions-core-workflows-custom_action-beta.d.ts +126 -0
- package/dist/extensibility-sdk-extensions-core-workflows-custom_action-internal.d.ts +140 -0
- package/dist/extensibility-sdk-extensions-core-workflows-custom_action-public.d.ts +126 -0
- package/dist/extensibility-sdk-extensions-extend-workflows-custom_action-alpha.d.ts +126 -0
- package/dist/extensibility-sdk-extensions-extend-workflows-custom_action-beta.d.ts +126 -0
- package/dist/extensibility-sdk-extensions-extend-workflows-custom_action-internal.d.ts +140 -0
- package/dist/extensibility-sdk-extensions-extend-workflows-custom_action-public.d.ts +126 -0
- package/dist/extensibility-sdk-extensions-internal.d.ts +7 -157
- package/dist/extensibility-sdk-extensions-public.d.ts +7 -157
- package/dist/extensibility-sdk-internal-internal.d.ts +2 -2
- package/dist/extensibility-sdk-internal.d.ts +145 -162
- package/dist/extensibility-sdk-public.d.ts +29 -157
- package/dist/extensibility-sdk-stdlib-alpha.d.ts +593 -0
- package/dist/extensibility-sdk-stdlib-beta.d.ts +593 -0
- package/dist/extensibility-sdk-stdlib-internal.d.ts +1096 -0
- package/dist/extensibility-sdk-stdlib-public.d.ts +593 -0
- package/dist/extensions/billing/bill/discount_calculation.cjs +437 -0
- package/dist/extensions/billing/bill/discount_calculation.d.ts +0 -20
- package/dist/extensions/billing/bill/discount_calculation.d.ts.map +1 -1
- package/dist/extensions/billing/bill/discount_calculation.js +430 -0
- package/dist/extensions/billing/customer_balance_application.cjs +297 -0
- package/dist/extensions/billing/customer_balance_application.d.ts +0 -20
- package/dist/extensions/billing/customer_balance_application.d.ts.map +1 -1
- package/dist/extensions/billing/customer_balance_application.js +284 -0
- package/dist/extensions/billing/invoice_collection_options.cjs +166 -0
- package/dist/extensions/billing/invoice_collection_options.d.ts +4 -24
- package/dist/extensions/billing/invoice_collection_options.d.ts.map +1 -1
- package/dist/extensions/billing/invoice_collection_options.js +155 -0
- package/dist/extensions/billing/prorations.cjs +501 -0
- package/dist/extensions/billing/prorations.d.ts +0 -20
- package/dist/extensions/billing/prorations.d.ts.map +1 -1
- package/dist/extensions/billing/prorations.js +492 -0
- package/dist/extensions/billing/recurring_billing_item_handling.cjs +639 -0
- package/dist/extensions/billing/recurring_billing_item_handling.d.ts +0 -30
- package/dist/extensions/billing/recurring_billing_item_handling.d.ts.map +1 -1
- package/dist/extensions/billing/recurring_billing_item_handling.js +632 -0
- package/dist/extensions/core/workflows/custom_action.cjs +124 -0
- package/dist/extensions/core/workflows/custom_action.d.ts +1 -21
- package/dist/extensions/core/workflows/custom_action.d.ts.map +1 -1
- package/dist/extensions/core/workflows/custom_action.js +111 -0
- package/dist/extensions/extend/workflows/custom_action.cjs +124 -0
- package/dist/extensions/extend/workflows/custom_action.d.ts +1 -21
- package/dist/extensions/extend/workflows/custom_action.d.ts.map +1 -1
- package/dist/extensions/extend/workflows/custom_action.js +111 -0
- package/dist/extensions/index.cjs +27 -265
- package/dist/extensions/index.js +27 -265
- package/dist/extensions/registry.d.ts +2 -2
- package/dist/extensions/registry.d.ts.map +1 -1
- package/dist/index.cjs +452 -2390
- package/dist/index.js +479 -2286
- package/dist/internal.cjs +22 -54
- package/dist/internal.js +22 -54
- package/dist/stdlib/generated.d.ts +1 -1
- package/dist/stdlib/generated.d.ts.map +1 -1
- package/dist/stdlib/index.cjs +2003 -0
- package/dist/stdlib/index.d.ts +2 -2
- package/dist/stdlib/index.d.ts.map +1 -1
- package/dist/stdlib/index.js +1943 -0
- package/dist/stdlib/transform-strategies.d.ts +46 -6
- package/dist/stdlib/transform-strategies.d.ts.map +1 -1
- package/dist/stdlib/types.d.ts +82 -0
- package/dist/stdlib/types.d.ts.map +1 -1
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/package.json +65 -1
- package/dist/stdlib/extension-method.d.ts +0 -27
- package/dist/stdlib/extension-method.d.ts.map +0 -1
|
@@ -72,6 +72,14 @@ declare type AnyTimeRange = {
|
|
|
72
72
|
value: 'other';
|
|
73
73
|
};
|
|
74
74
|
|
|
75
|
+
/* Excluded from this release type: _ApiJsonToProto */
|
|
76
|
+
|
|
77
|
+
/* Excluded from this release type: _ApiJsonToProtoStrategy */
|
|
78
|
+
|
|
79
|
+
/* Excluded from this release type: _ApiJsonToType */
|
|
80
|
+
|
|
81
|
+
/* Excluded from this release type: _ApiJsonToTypeStrategy */
|
|
82
|
+
|
|
75
83
|
/* Excluded from this release type: _apply */
|
|
76
84
|
|
|
77
85
|
/* Excluded from this release type: _applyConfig */
|
|
@@ -113,6 +121,8 @@ export declare type BrandSymbol = typeof __brand;
|
|
|
113
121
|
|
|
114
122
|
/* Excluded from this release type: _ConfigEnum */
|
|
115
123
|
|
|
124
|
+
/* Excluded from this release type: _ConfigStrategy */
|
|
125
|
+
|
|
116
126
|
/** @public */
|
|
117
127
|
export declare interface Context {
|
|
118
128
|
type: string;
|
|
@@ -130,7 +140,7 @@ declare namespace Core {
|
|
|
130
140
|
export { Core }
|
|
131
141
|
|
|
132
142
|
/** @public */
|
|
133
|
-
export 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';
|
|
143
|
+
export 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';
|
|
134
144
|
|
|
135
145
|
/** @public */
|
|
136
146
|
declare namespace CustomAction {
|
|
@@ -140,7 +150,7 @@ declare namespace CustomAction {
|
|
|
140
150
|
*/
|
|
141
151
|
interface GetFormStateResponse {
|
|
142
152
|
/** 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. */
|
|
143
|
-
values
|
|
153
|
+
values?: Record<string, unknown>;
|
|
144
154
|
/** Per-field configuration keyed by field name. */
|
|
145
155
|
config: Record<string, FormStateFieldConfig>;
|
|
146
156
|
}
|
|
@@ -190,27 +200,7 @@ declare namespace CustomAction {
|
|
|
190
200
|
/** 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. */
|
|
191
201
|
customInput: Record<string, unknown>;
|
|
192
202
|
}
|
|
193
|
-
/**
|
|
194
|
-
* @public
|
|
195
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
196
|
-
*/
|
|
197
|
-
function prepareArgsExecute(proto: unknown): ExecuteCustomActionRequest;
|
|
198
|
-
/**
|
|
199
|
-
* @public
|
|
200
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
201
|
-
*/
|
|
202
|
-
function prepareResultExecute(result: ExecuteCustomActionResponse): ExecuteCustomActionResponse;
|
|
203
203
|
/* Excluded from this release type: $platformWrapExecute */
|
|
204
|
-
/**
|
|
205
|
-
* @public
|
|
206
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
207
|
-
*/
|
|
208
|
-
function prepareArgsGetFormState(proto: unknown): GetFormStateRequest;
|
|
209
|
-
/**
|
|
210
|
-
* @public
|
|
211
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
212
|
-
*/
|
|
213
|
-
function prepareResultGetFormState(result: GetFormStateResponse): GetFormStateResponse;
|
|
214
204
|
/* Excluded from this release type: $platformWrapGetFormState */
|
|
215
205
|
/**
|
|
216
206
|
* Executes the custom action at workflow runtime. Called when a workflow triggers this action, with the configured input values.
|
|
@@ -274,7 +264,7 @@ declare namespace CustomAction_2 {
|
|
|
274
264
|
*/
|
|
275
265
|
interface GetFormStateResponse {
|
|
276
266
|
/** 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. */
|
|
277
|
-
values
|
|
267
|
+
values?: Record<string, unknown>;
|
|
278
268
|
/** Per-field configuration keyed by field name. */
|
|
279
269
|
config: Record<string, FormStateFieldConfig>;
|
|
280
270
|
}
|
|
@@ -324,27 +314,7 @@ declare namespace CustomAction_2 {
|
|
|
324
314
|
/** 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. */
|
|
325
315
|
customInput: Record<string, unknown>;
|
|
326
316
|
}
|
|
327
|
-
/**
|
|
328
|
-
* @public
|
|
329
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
330
|
-
*/
|
|
331
|
-
function prepareArgsExecute(proto: unknown): ExecuteCustomActionRequest;
|
|
332
|
-
/**
|
|
333
|
-
* @public
|
|
334
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
335
|
-
*/
|
|
336
|
-
function prepareResultExecute(result: ExecuteCustomActionResponse): ExecuteCustomActionResponse;
|
|
337
317
|
/* Excluded from this release type: $platformWrapExecute */
|
|
338
|
-
/**
|
|
339
|
-
* @public
|
|
340
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
341
|
-
*/
|
|
342
|
-
function prepareArgsGetFormState(proto: unknown): GetFormStateRequest;
|
|
343
|
-
/**
|
|
344
|
-
* @public
|
|
345
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
346
|
-
*/
|
|
347
|
-
function prepareResultGetFormState(result: GetFormStateResponse): GetFormStateResponse;
|
|
348
318
|
/* Excluded from this release type: $platformWrapGetFormState */
|
|
349
319
|
/**
|
|
350
320
|
* Executes the custom action at workflow runtime. Called when a workflow triggers this action, with the configured input values.
|
|
@@ -420,27 +390,7 @@ declare namespace CustomerBalanceApplication {
|
|
|
420
390
|
/** The current customer balance available to apply. Positive values indicate debits (the customer owes money), negative values indicate credits. */
|
|
421
391
|
customerBalance: MonetaryAmount;
|
|
422
392
|
}
|
|
423
|
-
/**
|
|
424
|
-
* @public
|
|
425
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
426
|
-
*/
|
|
427
|
-
function prepareArgsComputeAppliedCustomerBalance(proto: unknown): CustomerBalanceApplicationInput;
|
|
428
|
-
/**
|
|
429
|
-
* @public
|
|
430
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
431
|
-
*/
|
|
432
|
-
function prepareResultComputeAppliedCustomerBalance(result: CustomerBalanceApplicationResult): CustomerBalanceApplicationResult;
|
|
433
393
|
/* Excluded from this release type: $platformWrapComputeAppliedCustomerBalance */
|
|
434
|
-
/**
|
|
435
|
-
* @public
|
|
436
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
437
|
-
*/
|
|
438
|
-
const prepareArgs: typeof prepareArgsComputeAppliedCustomerBalance;
|
|
439
|
-
/**
|
|
440
|
-
* @public
|
|
441
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
442
|
-
*/
|
|
443
|
-
const prepareResult: typeof prepareResultComputeAppliedCustomerBalance;
|
|
444
394
|
/**
|
|
445
395
|
* 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.
|
|
446
396
|
* @public
|
|
@@ -909,27 +859,7 @@ declare namespace DiscountCalculation {
|
|
|
909
859
|
/** Custom key-value pairs attached to the product. */
|
|
910
860
|
metadata: Record<string, string>;
|
|
911
861
|
}
|
|
912
|
-
/**
|
|
913
|
-
* @public
|
|
914
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
915
|
-
*/
|
|
916
|
-
function prepareArgsComputeDiscounts(proto: unknown): DiscountableItem;
|
|
917
|
-
/**
|
|
918
|
-
* @public
|
|
919
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
920
|
-
*/
|
|
921
|
-
function prepareResultComputeDiscounts(result: DiscountResult): DiscountResult;
|
|
922
862
|
/* Excluded from this release type: $platformWrapComputeDiscounts */
|
|
923
|
-
/**
|
|
924
|
-
* @public
|
|
925
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
926
|
-
*/
|
|
927
|
-
const prepareArgs: typeof prepareArgsComputeDiscounts;
|
|
928
|
-
/**
|
|
929
|
-
* @public
|
|
930
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
931
|
-
*/
|
|
932
|
-
const prepareResult: typeof prepareResultComputeDiscounts;
|
|
933
863
|
/**
|
|
934
864
|
* Computes discount amounts for a discountable item and returns a discount result.
|
|
935
865
|
* @public
|
|
@@ -989,6 +919,8 @@ export declare type ExtractObjectTag<T> = T extends { readonly object: infer O }
|
|
|
989
919
|
|
|
990
920
|
/* Excluded from this release type: _identity */
|
|
991
921
|
|
|
922
|
+
/* Excluded from this release type: _IncomingRuntimeStrategy */
|
|
923
|
+
|
|
992
924
|
/** A branded integer — a `number` guaranteed to satisfy `Number.isInteger`. @public */
|
|
993
925
|
export declare type Integer = {
|
|
994
926
|
readonly [__integerBrand]: true;
|
|
@@ -1044,8 +976,8 @@ declare namespace InvoiceCollectionOptions {
|
|
|
1044
976
|
* @public
|
|
1045
977
|
*/
|
|
1046
978
|
interface InvoiceCollectionOptionsResult {
|
|
1047
|
-
/** Override the auto-advancement setting. Set to false to keep the invoice in draft.
|
|
1048
|
-
autoAdvance
|
|
979
|
+
/** Override the auto-advancement setting. Set to false to keep the invoice in draft. */
|
|
980
|
+
autoAdvance: boolean;
|
|
1049
981
|
}
|
|
1050
982
|
/** @public */
|
|
1051
983
|
type InvoiceCollectionOptionsInput = ({
|
|
@@ -1096,27 +1028,7 @@ declare namespace InvoiceCollectionOptions {
|
|
|
1096
1028
|
/** The payment methods configured for this invoice. */
|
|
1097
1029
|
paymentMethods: PaymentMethodType[];
|
|
1098
1030
|
}
|
|
1099
|
-
/**
|
|
1100
|
-
* @public
|
|
1101
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1102
|
-
*/
|
|
1103
|
-
function prepareArgsOverrideOptions(proto: unknown): InvoiceCollectionOptionsInput;
|
|
1104
|
-
/**
|
|
1105
|
-
* @public
|
|
1106
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1107
|
-
*/
|
|
1108
|
-
function prepareResultOverrideOptions(result: InvoiceCollectionOptionsResult): InvoiceCollectionOptionsResult;
|
|
1109
1031
|
/* Excluded from this release type: $platformWrapOverrideOptions */
|
|
1110
|
-
/**
|
|
1111
|
-
* @public
|
|
1112
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1113
|
-
*/
|
|
1114
|
-
const prepareArgs: typeof prepareArgsOverrideOptions;
|
|
1115
|
-
/**
|
|
1116
|
-
* @public
|
|
1117
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1118
|
-
*/
|
|
1119
|
-
const prepareResult: typeof prepareResultOverrideOptions;
|
|
1120
1032
|
/**
|
|
1121
1033
|
* Overrides invoice collection options before a draft invoice is created.
|
|
1122
1034
|
* @public
|
|
@@ -1134,13 +1046,13 @@ declare namespace InvoiceCollectionOptions {
|
|
|
1134
1046
|
*
|
|
1135
1047
|
* export default class MyInvoiceCollectionOptions implements Billing.InvoiceCollectionOptions<MyInvoiceCollectionOptionsConfig> {
|
|
1136
1048
|
* overrideOptions(
|
|
1137
|
-
*
|
|
1049
|
+
* request: Billing.InvoiceCollectionOptions.InvoiceCollectionOptionsInput,
|
|
1138
1050
|
* _config: MyInvoiceCollectionOptionsConfig,
|
|
1139
1051
|
* _context: Context
|
|
1140
1052
|
* ) {
|
|
1141
1053
|
* // TODO: implement your collection setting logic here
|
|
1142
1054
|
*
|
|
1143
|
-
* return {};
|
|
1055
|
+
* return { autoAdvance: request.collectionOptions.autoAdvance };
|
|
1144
1056
|
* }
|
|
1145
1057
|
* }
|
|
1146
1058
|
*
|
|
@@ -1182,6 +1094,8 @@ declare interface OneTime {
|
|
|
1182
1094
|
at: Date;
|
|
1183
1095
|
}
|
|
1184
1096
|
|
|
1097
|
+
/* Excluded from this release type: _OutgoingRuntimeStrategy */
|
|
1098
|
+
|
|
1185
1099
|
/**
|
|
1186
1100
|
* Represents a percentage number value (0-100).
|
|
1187
1101
|
* @format percent
|
|
@@ -1381,27 +1295,7 @@ declare namespace Prorations {
|
|
|
1381
1295
|
name: string;
|
|
1382
1296
|
metadata: Record<string, string>;
|
|
1383
1297
|
}
|
|
1384
|
-
/**
|
|
1385
|
-
* @public
|
|
1386
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1387
|
-
*/
|
|
1388
|
-
function prepareArgsProrateItems(proto: unknown): ProrateItemsInput;
|
|
1389
|
-
/**
|
|
1390
|
-
* @public
|
|
1391
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1392
|
-
*/
|
|
1393
|
-
function prepareResultProrateItems(result: ProrateItemsResult): ProrateItemsResult;
|
|
1394
1298
|
/* Excluded from this release type: $platformWrapProrateItems */
|
|
1395
|
-
/**
|
|
1396
|
-
* @public
|
|
1397
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1398
|
-
*/
|
|
1399
|
-
const prepareArgs: typeof prepareArgsProrateItems;
|
|
1400
|
-
/**
|
|
1401
|
-
* @public
|
|
1402
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1403
|
-
*/
|
|
1404
|
-
const prepareResult: typeof prepareResultProrateItems;
|
|
1405
1299
|
/**
|
|
1406
1300
|
* 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.
|
|
1407
1301
|
* @public
|
|
@@ -1440,6 +1334,10 @@ declare interface Prorations<Config> {
|
|
|
1440
1334
|
|
|
1441
1335
|
/* Excluded from this release type: _ProtoEnum */
|
|
1442
1336
|
|
|
1337
|
+
/* Excluded from this release type: _ProtoToApiJson */
|
|
1338
|
+
|
|
1339
|
+
/* Excluded from this release type: _ProtoToApiJsonStrategy */
|
|
1340
|
+
|
|
1443
1341
|
/* Excluded from this release type: _ProtoWireToType */
|
|
1444
1342
|
|
|
1445
1343
|
/* Excluded from this release type: _ProtoWireToTypeStrategy */
|
|
@@ -1685,38 +1583,8 @@ declare namespace RecurringBillingItemHandling {
|
|
|
1685
1583
|
/** The list of items to evaluate for creation. */
|
|
1686
1584
|
items: Item[];
|
|
1687
1585
|
}
|
|
1688
|
-
/**
|
|
1689
|
-
* @public
|
|
1690
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1691
|
-
*/
|
|
1692
|
-
function prepareArgsBeforeItemCreation(proto: unknown): BeforeItemCreationInput;
|
|
1693
|
-
/**
|
|
1694
|
-
* @public
|
|
1695
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1696
|
-
*/
|
|
1697
|
-
function prepareResultBeforeItemCreation(result: BeforeItemCreationResult): BeforeItemCreationResult;
|
|
1698
1586
|
/* Excluded from this release type: $platformWrapBeforeItemCreation */
|
|
1699
|
-
/**
|
|
1700
|
-
* @public
|
|
1701
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1702
|
-
*/
|
|
1703
|
-
function prepareArgsFilterItems(proto: unknown): FilterItemsInput;
|
|
1704
|
-
/**
|
|
1705
|
-
* @public
|
|
1706
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1707
|
-
*/
|
|
1708
|
-
function prepareResultFilterItems(result: FilterItemsResult): FilterItemsResult;
|
|
1709
1587
|
/* Excluded from this release type: $platformWrapFilterItems */
|
|
1710
|
-
/**
|
|
1711
|
-
* @public
|
|
1712
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1713
|
-
*/
|
|
1714
|
-
function prepareArgsGroupItems(proto: unknown): GroupItemsInput;
|
|
1715
|
-
/**
|
|
1716
|
-
* @public
|
|
1717
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1718
|
-
*/
|
|
1719
|
-
function prepareResultGroupItems(result: GroupItemsResult): GroupItemsResult;
|
|
1720
1588
|
/* Excluded from this release type: $platformWrapGroupItems */
|
|
1721
1589
|
/**
|
|
1722
1590
|
* Runs before invoice items are created. Decides whether each item should be created or skipped.
|
|
@@ -1894,6 +1762,10 @@ export declare function toConst<T>(value: T): DeepReadonly<T>;
|
|
|
1894
1762
|
|
|
1895
1763
|
/* Excluded from this release type: _translateUnion */
|
|
1896
1764
|
|
|
1765
|
+
/* Excluded from this release type: _TypeToApiJson */
|
|
1766
|
+
|
|
1767
|
+
/* Excluded from this release type: _TypeToApiJsonStrategy */
|
|
1768
|
+
|
|
1897
1769
|
/* Excluded from this release type: _TypeToProtoWire */
|
|
1898
1770
|
|
|
1899
1771
|
/* Excluded from this release type: _TypeToProtoWireStrategy */
|
|
@@ -98,7 +98,7 @@ export declare type ScalarFieldClassification = {
|
|
|
98
98
|
*
|
|
99
99
|
* @internal
|
|
100
100
|
*/
|
|
101
|
-
export declare const STDLIB_IMPORT_PATH = "@stripe/extensibility-sdk";
|
|
101
|
+
export declare const STDLIB_IMPORT_PATH = "@stripe/extensibility-sdk/stdlib";
|
|
102
102
|
|
|
103
103
|
/** @internal */
|
|
104
104
|
export declare type StructuralFieldClassification = {
|
|
@@ -107,7 +107,7 @@ declare namespace Core {
|
|
|
107
107
|
export { Core }
|
|
108
108
|
|
|
109
109
|
/** @public */
|
|
110
|
-
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';
|
|
110
|
+
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';
|
|
111
111
|
|
|
112
112
|
/** @public */
|
|
113
113
|
declare namespace CustomAction {
|
|
@@ -117,7 +117,7 @@ declare namespace CustomAction {
|
|
|
117
117
|
*/
|
|
118
118
|
interface GetFormStateResponse {
|
|
119
119
|
/** 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. */
|
|
120
|
-
values
|
|
120
|
+
values?: Record<string, unknown>;
|
|
121
121
|
/** Per-field configuration keyed by field name. */
|
|
122
122
|
config: Record<string, FormStateFieldConfig>;
|
|
123
123
|
}
|
|
@@ -167,27 +167,7 @@ declare namespace CustomAction {
|
|
|
167
167
|
/** 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. */
|
|
168
168
|
customInput: Record<string, unknown>;
|
|
169
169
|
}
|
|
170
|
-
/**
|
|
171
|
-
* @public
|
|
172
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
173
|
-
*/
|
|
174
|
-
function prepareArgsExecute(proto: unknown): ExecuteCustomActionRequest;
|
|
175
|
-
/**
|
|
176
|
-
* @public
|
|
177
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
178
|
-
*/
|
|
179
|
-
function prepareResultExecute(result: ExecuteCustomActionResponse): ExecuteCustomActionResponse;
|
|
180
170
|
/* Excluded from this release type: $platformWrapExecute */
|
|
181
|
-
/**
|
|
182
|
-
* @public
|
|
183
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
184
|
-
*/
|
|
185
|
-
function prepareArgsGetFormState(proto: unknown): GetFormStateRequest;
|
|
186
|
-
/**
|
|
187
|
-
* @public
|
|
188
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
189
|
-
*/
|
|
190
|
-
function prepareResultGetFormState(result: GetFormStateResponse): GetFormStateResponse;
|
|
191
171
|
/* Excluded from this release type: $platformWrapGetFormState */
|
|
192
172
|
/**
|
|
193
173
|
* 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 {
|
|
|
251
231
|
*/
|
|
252
232
|
interface GetFormStateResponse {
|
|
253
233
|
/** 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. */
|
|
254
|
-
values
|
|
234
|
+
values?: Record<string, unknown>;
|
|
255
235
|
/** Per-field configuration keyed by field name. */
|
|
256
236
|
config: Record<string, FormStateFieldConfig>;
|
|
257
237
|
}
|
|
@@ -301,27 +281,7 @@ declare namespace CustomAction_2 {
|
|
|
301
281
|
/** 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. */
|
|
302
282
|
customInput: Record<string, unknown>;
|
|
303
283
|
}
|
|
304
|
-
/**
|
|
305
|
-
* @public
|
|
306
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
307
|
-
*/
|
|
308
|
-
function prepareArgsExecute(proto: unknown): ExecuteCustomActionRequest;
|
|
309
|
-
/**
|
|
310
|
-
* @public
|
|
311
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
312
|
-
*/
|
|
313
|
-
function prepareResultExecute(result: ExecuteCustomActionResponse): ExecuteCustomActionResponse;
|
|
314
284
|
/* Excluded from this release type: $platformWrapExecute */
|
|
315
|
-
/**
|
|
316
|
-
* @public
|
|
317
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
318
|
-
*/
|
|
319
|
-
function prepareArgsGetFormState(proto: unknown): GetFormStateRequest;
|
|
320
|
-
/**
|
|
321
|
-
* @public
|
|
322
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
323
|
-
*/
|
|
324
|
-
function prepareResultGetFormState(result: GetFormStateResponse): GetFormStateResponse;
|
|
325
285
|
/* Excluded from this release type: $platformWrapGetFormState */
|
|
326
286
|
/**
|
|
327
287
|
* 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 {
|
|
|
397
357
|
/** The current customer balance available to apply. Positive values indicate debits (the customer owes money), negative values indicate credits. */
|
|
398
358
|
customerBalance: MonetaryAmount;
|
|
399
359
|
}
|
|
400
|
-
/**
|
|
401
|
-
* @public
|
|
402
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
403
|
-
*/
|
|
404
|
-
function prepareArgsComputeAppliedCustomerBalance(proto: unknown): CustomerBalanceApplicationInput;
|
|
405
|
-
/**
|
|
406
|
-
* @public
|
|
407
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
408
|
-
*/
|
|
409
|
-
function prepareResultComputeAppliedCustomerBalance(result: CustomerBalanceApplicationResult): CustomerBalanceApplicationResult;
|
|
410
360
|
/* Excluded from this release type: $platformWrapComputeAppliedCustomerBalance */
|
|
411
|
-
/**
|
|
412
|
-
* @public
|
|
413
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
414
|
-
*/
|
|
415
|
-
const prepareArgs: typeof prepareArgsComputeAppliedCustomerBalance;
|
|
416
|
-
/**
|
|
417
|
-
* @public
|
|
418
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
419
|
-
*/
|
|
420
|
-
const prepareResult: typeof prepareResultComputeAppliedCustomerBalance;
|
|
421
361
|
/**
|
|
422
362
|
* 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.
|
|
423
363
|
* @public
|
|
@@ -855,27 +795,7 @@ declare namespace DiscountCalculation {
|
|
|
855
795
|
/** Custom key-value pairs attached to the product. */
|
|
856
796
|
metadata: Record<string, string>;
|
|
857
797
|
}
|
|
858
|
-
/**
|
|
859
|
-
* @public
|
|
860
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
861
|
-
*/
|
|
862
|
-
function prepareArgsComputeDiscounts(proto: unknown): DiscountableItem;
|
|
863
|
-
/**
|
|
864
|
-
* @public
|
|
865
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
866
|
-
*/
|
|
867
|
-
function prepareResultComputeDiscounts(result: DiscountResult): DiscountResult;
|
|
868
798
|
/* Excluded from this release type: $platformWrapComputeDiscounts */
|
|
869
|
-
/**
|
|
870
|
-
* @public
|
|
871
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
872
|
-
*/
|
|
873
|
-
const prepareArgs: typeof prepareArgsComputeDiscounts;
|
|
874
|
-
/**
|
|
875
|
-
* @public
|
|
876
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
877
|
-
*/
|
|
878
|
-
const prepareResult: typeof prepareResultComputeDiscounts;
|
|
879
799
|
/**
|
|
880
800
|
* Computes discount amounts for a discountable item and returns a discount result.
|
|
881
801
|
* @public
|
|
@@ -975,8 +895,8 @@ declare namespace InvoiceCollectionOptions {
|
|
|
975
895
|
* @public
|
|
976
896
|
*/
|
|
977
897
|
interface InvoiceCollectionOptionsResult {
|
|
978
|
-
/** Override the auto-advancement setting. Set to false to keep the invoice in draft.
|
|
979
|
-
autoAdvance
|
|
898
|
+
/** Override the auto-advancement setting. Set to false to keep the invoice in draft. */
|
|
899
|
+
autoAdvance: boolean;
|
|
980
900
|
}
|
|
981
901
|
/** @public */
|
|
982
902
|
type InvoiceCollectionOptionsInput = ({
|
|
@@ -1027,27 +947,7 @@ declare namespace InvoiceCollectionOptions {
|
|
|
1027
947
|
/** The payment methods configured for this invoice. */
|
|
1028
948
|
paymentMethods: PaymentMethodType[];
|
|
1029
949
|
}
|
|
1030
|
-
/**
|
|
1031
|
-
* @public
|
|
1032
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1033
|
-
*/
|
|
1034
|
-
function prepareArgsOverrideOptions(proto: unknown): InvoiceCollectionOptionsInput;
|
|
1035
|
-
/**
|
|
1036
|
-
* @public
|
|
1037
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1038
|
-
*/
|
|
1039
|
-
function prepareResultOverrideOptions(result: InvoiceCollectionOptionsResult): InvoiceCollectionOptionsResult;
|
|
1040
950
|
/* Excluded from this release type: $platformWrapOverrideOptions */
|
|
1041
|
-
/**
|
|
1042
|
-
* @public
|
|
1043
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1044
|
-
*/
|
|
1045
|
-
const prepareArgs: typeof prepareArgsOverrideOptions;
|
|
1046
|
-
/**
|
|
1047
|
-
* @public
|
|
1048
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1049
|
-
*/
|
|
1050
|
-
const prepareResult: typeof prepareResultOverrideOptions;
|
|
1051
951
|
/**
|
|
1052
952
|
* Overrides invoice collection options before a draft invoice is created.
|
|
1053
953
|
* @public
|
|
@@ -1065,13 +965,13 @@ declare namespace InvoiceCollectionOptions {
|
|
|
1065
965
|
*
|
|
1066
966
|
* export default class MyInvoiceCollectionOptions implements Billing.InvoiceCollectionOptions<MyInvoiceCollectionOptionsConfig> {
|
|
1067
967
|
* overrideOptions(
|
|
1068
|
-
*
|
|
968
|
+
* request: Billing.InvoiceCollectionOptions.InvoiceCollectionOptionsInput,
|
|
1069
969
|
* _config: MyInvoiceCollectionOptionsConfig,
|
|
1070
970
|
* _context: Context
|
|
1071
971
|
* ) {
|
|
1072
972
|
* // TODO: implement your collection setting logic here
|
|
1073
973
|
*
|
|
1074
|
-
* return {};
|
|
974
|
+
* return { autoAdvance: request.collectionOptions.autoAdvance };
|
|
1075
975
|
* }
|
|
1076
976
|
* }
|
|
1077
977
|
*
|
|
@@ -1302,27 +1202,7 @@ declare namespace Prorations {
|
|
|
1302
1202
|
name: string;
|
|
1303
1203
|
metadata: Record<string, string>;
|
|
1304
1204
|
}
|
|
1305
|
-
/**
|
|
1306
|
-
* @public
|
|
1307
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1308
|
-
*/
|
|
1309
|
-
function prepareArgsProrateItems(proto: unknown): ProrateItemsInput;
|
|
1310
|
-
/**
|
|
1311
|
-
* @public
|
|
1312
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1313
|
-
*/
|
|
1314
|
-
function prepareResultProrateItems(result: ProrateItemsResult): ProrateItemsResult;
|
|
1315
1205
|
/* Excluded from this release type: $platformWrapProrateItems */
|
|
1316
|
-
/**
|
|
1317
|
-
* @public
|
|
1318
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1319
|
-
*/
|
|
1320
|
-
const prepareArgs: typeof prepareArgsProrateItems;
|
|
1321
|
-
/**
|
|
1322
|
-
* @public
|
|
1323
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1324
|
-
*/
|
|
1325
|
-
const prepareResult: typeof prepareResultProrateItems;
|
|
1326
1206
|
/**
|
|
1327
1207
|
* 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.
|
|
1328
1208
|
* @public
|
|
@@ -1600,38 +1480,8 @@ declare namespace RecurringBillingItemHandling {
|
|
|
1600
1480
|
/** The list of items to evaluate for creation. */
|
|
1601
1481
|
items: Item[];
|
|
1602
1482
|
}
|
|
1603
|
-
/**
|
|
1604
|
-
* @public
|
|
1605
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1606
|
-
*/
|
|
1607
|
-
function prepareArgsBeforeItemCreation(proto: unknown): BeforeItemCreationInput;
|
|
1608
|
-
/**
|
|
1609
|
-
* @public
|
|
1610
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1611
|
-
*/
|
|
1612
|
-
function prepareResultBeforeItemCreation(result: BeforeItemCreationResult): BeforeItemCreationResult;
|
|
1613
1483
|
/* Excluded from this release type: $platformWrapBeforeItemCreation */
|
|
1614
|
-
/**
|
|
1615
|
-
* @public
|
|
1616
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1617
|
-
*/
|
|
1618
|
-
function prepareArgsFilterItems(proto: unknown): FilterItemsInput;
|
|
1619
|
-
/**
|
|
1620
|
-
* @public
|
|
1621
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1622
|
-
*/
|
|
1623
|
-
function prepareResultFilterItems(result: FilterItemsResult): FilterItemsResult;
|
|
1624
1484
|
/* Excluded from this release type: $platformWrapFilterItems */
|
|
1625
|
-
/**
|
|
1626
|
-
* @public
|
|
1627
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1628
|
-
*/
|
|
1629
|
-
function prepareArgsGroupItems(proto: unknown): GroupItemsInput;
|
|
1630
|
-
/**
|
|
1631
|
-
* @public
|
|
1632
|
-
* @deprecated Platform dispatch handles wire/SDK conversion.
|
|
1633
|
-
*/
|
|
1634
|
-
function prepareResultGroupItems(result: GroupItemsResult): GroupItemsResult;
|
|
1635
1485
|
/* Excluded from this release type: $platformWrapGroupItems */
|
|
1636
1486
|
/**
|
|
1637
1487
|
* Runs before invoice items are created. Decides whether each item should be created or skipped.
|