@stripe/extensibility-sdk 1.1.0 → 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.
Files changed (97) hide show
  1. package/README.md +17 -15
  2. package/dist/config-values/generate.cjs +1 -1
  3. package/dist/config-values/generate.d.ts +1 -1
  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 +29 -157
  7. package/dist/extensibility-sdk-beta.d.ts +29 -157
  8. package/dist/extensibility-sdk-config-values-internal.d.ts +1 -1
  9. package/dist/extensibility-sdk-extensions-alpha.d.ts +7 -157
  10. package/dist/extensibility-sdk-extensions-beta.d.ts +7 -157
  11. package/dist/extensibility-sdk-extensions-billing-bill-discount_calculation-alpha.d.ts +631 -0
  12. package/dist/extensibility-sdk-extensions-billing-bill-discount_calculation-beta.d.ts +631 -0
  13. package/dist/extensibility-sdk-extensions-billing-bill-discount_calculation-internal.d.ts +666 -0
  14. package/dist/extensibility-sdk-extensions-billing-bill-discount_calculation-public.d.ts +631 -0
  15. package/dist/extensibility-sdk-extensions-billing-customer_balance_application-alpha.d.ts +475 -0
  16. package/dist/extensibility-sdk-extensions-billing-customer_balance_application-beta.d.ts +475 -0
  17. package/dist/extensibility-sdk-extensions-billing-customer_balance_application-internal.d.ts +510 -0
  18. package/dist/extensibility-sdk-extensions-billing-customer_balance_application-public.d.ts +475 -0
  19. package/dist/extensibility-sdk-extensions-billing-invoice_collection_options-alpha.d.ts +110 -0
  20. package/dist/extensibility-sdk-extensions-billing-invoice_collection_options-beta.d.ts +110 -0
  21. package/dist/extensibility-sdk-extensions-billing-invoice_collection_options-internal.d.ts +123 -0
  22. package/dist/extensibility-sdk-extensions-billing-invoice_collection_options-public.d.ts +110 -0
  23. package/dist/extensibility-sdk-extensions-billing-prorations-alpha.d.ts +607 -0
  24. package/dist/extensibility-sdk-extensions-billing-prorations-beta.d.ts +607 -0
  25. package/dist/extensibility-sdk-extensions-billing-prorations-internal.d.ts +642 -0
  26. package/dist/extensibility-sdk-extensions-billing-prorations-public.d.ts +607 -0
  27. package/dist/extensibility-sdk-extensions-billing-recurring_billing_item_handling-alpha.d.ts +735 -0
  28. package/dist/extensibility-sdk-extensions-billing-recurring_billing_item_handling-beta.d.ts +735 -0
  29. package/dist/extensibility-sdk-extensions-billing-recurring_billing_item_handling-internal.d.ts +772 -0
  30. package/dist/extensibility-sdk-extensions-billing-recurring_billing_item_handling-public.d.ts +735 -0
  31. package/dist/extensibility-sdk-extensions-core-workflows-custom_action-alpha.d.ts +126 -0
  32. package/dist/extensibility-sdk-extensions-core-workflows-custom_action-beta.d.ts +126 -0
  33. package/dist/extensibility-sdk-extensions-core-workflows-custom_action-internal.d.ts +140 -0
  34. package/dist/extensibility-sdk-extensions-core-workflows-custom_action-public.d.ts +126 -0
  35. package/dist/extensibility-sdk-extensions-extend-workflows-custom_action-alpha.d.ts +126 -0
  36. package/dist/extensibility-sdk-extensions-extend-workflows-custom_action-beta.d.ts +126 -0
  37. package/dist/extensibility-sdk-extensions-extend-workflows-custom_action-internal.d.ts +140 -0
  38. package/dist/extensibility-sdk-extensions-extend-workflows-custom_action-public.d.ts +126 -0
  39. package/dist/extensibility-sdk-extensions-internal.d.ts +7 -157
  40. package/dist/extensibility-sdk-extensions-public.d.ts +7 -157
  41. package/dist/extensibility-sdk-internal-internal.d.ts +2 -2
  42. package/dist/extensibility-sdk-internal.d.ts +145 -162
  43. package/dist/extensibility-sdk-public.d.ts +29 -157
  44. package/dist/extensibility-sdk-stdlib-alpha.d.ts +593 -0
  45. package/dist/extensibility-sdk-stdlib-beta.d.ts +593 -0
  46. package/dist/extensibility-sdk-stdlib-internal.d.ts +1096 -0
  47. package/dist/extensibility-sdk-stdlib-public.d.ts +593 -0
  48. package/dist/extensions/billing/bill/discount_calculation.cjs +437 -0
  49. package/dist/extensions/billing/bill/discount_calculation.d.ts +0 -20
  50. package/dist/extensions/billing/bill/discount_calculation.d.ts.map +1 -1
  51. package/dist/extensions/billing/bill/discount_calculation.js +430 -0
  52. package/dist/extensions/billing/customer_balance_application.cjs +297 -0
  53. package/dist/extensions/billing/customer_balance_application.d.ts +0 -20
  54. package/dist/extensions/billing/customer_balance_application.d.ts.map +1 -1
  55. package/dist/extensions/billing/customer_balance_application.js +284 -0
  56. package/dist/extensions/billing/invoice_collection_options.cjs +166 -0
  57. package/dist/extensions/billing/invoice_collection_options.d.ts +4 -24
  58. package/dist/extensions/billing/invoice_collection_options.d.ts.map +1 -1
  59. package/dist/extensions/billing/invoice_collection_options.js +155 -0
  60. package/dist/extensions/billing/prorations.cjs +501 -0
  61. package/dist/extensions/billing/prorations.d.ts +0 -20
  62. package/dist/extensions/billing/prorations.d.ts.map +1 -1
  63. package/dist/extensions/billing/prorations.js +492 -0
  64. package/dist/extensions/billing/recurring_billing_item_handling.cjs +639 -0
  65. package/dist/extensions/billing/recurring_billing_item_handling.d.ts +0 -30
  66. package/dist/extensions/billing/recurring_billing_item_handling.d.ts.map +1 -1
  67. package/dist/extensions/billing/recurring_billing_item_handling.js +632 -0
  68. package/dist/extensions/core/workflows/custom_action.cjs +124 -0
  69. package/dist/extensions/core/workflows/custom_action.d.ts +1 -21
  70. package/dist/extensions/core/workflows/custom_action.d.ts.map +1 -1
  71. package/dist/extensions/core/workflows/custom_action.js +111 -0
  72. package/dist/extensions/extend/workflows/custom_action.cjs +124 -0
  73. package/dist/extensions/extend/workflows/custom_action.d.ts +1 -21
  74. package/dist/extensions/extend/workflows/custom_action.d.ts.map +1 -1
  75. package/dist/extensions/extend/workflows/custom_action.js +111 -0
  76. package/dist/extensions/index.cjs +27 -265
  77. package/dist/extensions/index.js +27 -265
  78. package/dist/extensions/registry.d.ts +2 -2
  79. package/dist/extensions/registry.d.ts.map +1 -1
  80. package/dist/index.cjs +452 -2390
  81. package/dist/index.js +479 -2286
  82. package/dist/internal.cjs +22 -54
  83. package/dist/internal.js +22 -54
  84. package/dist/stdlib/generated.d.ts +1 -1
  85. package/dist/stdlib/generated.d.ts.map +1 -1
  86. package/dist/stdlib/index.cjs +2003 -0
  87. package/dist/stdlib/index.d.ts +2 -2
  88. package/dist/stdlib/index.d.ts.map +1 -1
  89. package/dist/stdlib/index.js +1943 -0
  90. package/dist/stdlib/transform-strategies.d.ts +46 -6
  91. package/dist/stdlib/transform-strategies.d.ts.map +1 -1
  92. package/dist/stdlib/types.d.ts +82 -0
  93. package/dist/stdlib/types.d.ts.map +1 -1
  94. package/dist/tsconfig.build.tsbuildinfo +1 -1
  95. package/package.json +65 -1
  96. package/dist/stdlib/extension-method.d.ts +0 -27
  97. package/dist/stdlib/extension-method.d.ts.map +0 -1
package/README.md CHANGED
@@ -177,27 +177,27 @@ Key types:
177
177
 
178
178
  ---
179
179
 
180
- ### Core
180
+ ### Extend
181
181
 
182
- #### `Core.Workflows.CustomAction`
182
+ #### `Extend.Workflows.CustomAction`
183
183
 
184
184
  Implements a custom action callable from Stripe workflows. `execute` is required;
185
185
  `getFormState` is optional and drives dynamic form rendering.
186
186
 
187
187
  ```typescript
188
- import type { Core, Context } from '@stripe/extensibility-sdk/extensions';
188
+ import type { Extend, Context } from '@stripe/extensibility-sdk/extensions';
189
189
 
190
190
  interface MyConfig extends Record<string, unknown> {
191
191
  webhookEndpoint: string;
192
192
  webhookPath: string;
193
193
  }
194
194
 
195
- export default class MyExtension implements Core.Workflows.CustomAction<MyConfig> {
195
+ export default class MyExtension implements Extend.Workflows.CustomAction<MyConfig> {
196
196
  async execute(
197
- request: Core.Workflows.CustomAction.ExecuteCustomActionRequest,
197
+ request: Extend.Workflows.CustomAction.ExecuteCustomActionRequest,
198
198
  config: MyConfig,
199
199
  _context: Context
200
- ): Promise<Core.Workflows.CustomAction.ExecuteCustomActionResponse> {
200
+ ): Promise<Extend.Workflows.CustomAction.ExecuteCustomActionResponse> {
201
201
  const { customInput } = request;
202
202
 
203
203
  await endpointFetch({
@@ -211,10 +211,10 @@ export default class MyExtension implements Core.Workflows.CustomAction<MyConfig
211
211
  }
212
212
 
213
213
  async getFormState(
214
- request: Core.Workflows.CustomAction.GetFormStateRequest,
214
+ request: Extend.Workflows.CustomAction.GetFormStateRequest,
215
215
  _config: MyConfig,
216
216
  _context: Context
217
- ): Promise<Core.Workflows.CustomAction.GetFormStateResponse> {
217
+ ): Promise<Extend.Workflows.CustomAction.GetFormStateResponse> {
218
218
  return { values: request.values, config: {} };
219
219
  }
220
220
  }
@@ -222,12 +222,14 @@ export default class MyExtension implements Core.Workflows.CustomAction<MyConfig
222
222
 
223
223
  Key types:
224
224
 
225
- | Type | Description |
226
- | ----------------------------- | ---------------------------------------------------------------------- |
227
- | `ExecuteCustomActionRequest` | `{ customInput: Record<string, unknown> }` |
228
- | `ExecuteCustomActionResponse` | `Record<string, never>` (empty object) |
229
- | `GetFormStateRequest` | `{ values: Record<string, unknown>; changedField?: string }` |
230
- | `GetFormStateResponse` | `{ values: Record<string, unknown>; config: Record<string, unknown> }` |
225
+ | Type | Description |
226
+ | ----------------------------- | ----------------------------------------------------------------------------------- |
227
+ | `ExecuteCustomActionRequest` | `{ customInput: Record<string, unknown> }` |
228
+ | `ExecuteCustomActionResponse` | `Record<string, never>` (empty object) |
229
+ | `GetFormStateRequest` | `{ values: Record<string, unknown>; changedField?: string }` |
230
+ | `GetFormStateResponse` | `{ values: Record<string, unknown>; config: Record<string, FormStateFieldConfig> }` |
231
+ | `FormStateFieldConfig` | Per-field config: `options`, `schema`, `disabled?`, `hidden?`, `warning?`, `error?` |
232
+ | `SelectOption` | `{ value: string; label: string }` |
231
233
 
232
234
  Both `execute` and `getFormState` may return synchronously or as `Promise`.
233
235
 
@@ -241,7 +243,7 @@ Every extension method receives a `Context` as its third argument:
241
243
  import type { Context } from '@stripe/extensibility-sdk/extensions';
242
244
 
243
245
  function handleContext(context: Context) {
244
- console.log(context.type); // e.g. "core.workflows.custom_workflow_action"
246
+ console.log(context.type); // e.g. "extend.workflows.custom_action"
245
247
  console.log(context.id); // unique call ID, for debugging
246
248
  console.log(context.livemode);
247
249
  console.log(context.stripeContext); // set for cross-account calls
@@ -163,7 +163,7 @@ function isStdlibDecimalType(type) {
163
163
  }
164
164
 
165
165
  // src/config-values/generate.ts
166
- var STDLIB_IMPORT_PATH = "@stripe/extensibility-sdk";
166
+ var STDLIB_IMPORT_PATH = "@stripe/extensibility-sdk/stdlib";
167
167
  function generateConfigDescriptor(result) {
168
168
  const usedImports = /* @__PURE__ */ new Set();
169
169
  const usedTypeImports = /* @__PURE__ */ new Set();
@@ -13,7 +13,7 @@ export { analyzeConfigType, analyzeConfigTypeInProject, type ConfigAnalysisResul
13
13
  *
14
14
  * @internal
15
15
  */
16
- export declare const STDLIB_IMPORT_PATH = "@stripe/extensibility-sdk";
16
+ export declare const STDLIB_IMPORT_PATH = "@stripe/extensibility-sdk/stdlib";
17
17
  /**
18
18
  * Generated TypeScript source and imports for a config descriptor.
19
19
  *
@@ -1 +1 @@
1
- {"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../../src/config-values/generate.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAuB,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAG5E,OAAO,EACL,iBAAiB,EACjB,0BAA0B,EAC1B,KAAK,oBAAoB,EACzB,KAAK,WAAW,EAChB,KAAK,yBAAyB,EAC9B,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,KAAK,yBAAyB,EAC9B,KAAK,6BAA6B,GACnC,MAAM,YAAY,CAAC;AAMpB;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,8BAA8B,CAAC;AAE9D;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,kFAAkF;IAClF,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,yDAAyD;IACzD,eAAe,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IACrC,6DAA6D;IAC7D,mBAAmB,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;CAC1C;AAED;;;;;;;;GAQG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,oBAAoB,GAC3B,yBAAyB,CA8C3B"}
1
+ {"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../../src/config-values/generate.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAuB,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAG5E,OAAO,EACL,iBAAiB,EACjB,0BAA0B,EAC1B,KAAK,oBAAoB,EACzB,KAAK,WAAW,EAChB,KAAK,yBAAyB,EAC9B,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,KAAK,yBAAyB,EAC9B,KAAK,6BAA6B,GACnC,MAAM,YAAY,CAAC;AAMpB;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,qCAAqC,CAAC;AAErE;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,kFAAkF;IAClF,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,yDAAyD;IACzD,eAAe,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IACrC,6DAA6D;IAC7D,mBAAmB,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;CAC1C;AAED;;;;;;;;GAQG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,oBAAoB,GAC3B,yBAAyB,CA8C3B"}
@@ -134,7 +134,7 @@ function isStdlibDecimalType(type) {
134
134
  }
135
135
 
136
136
  // src/config-values/generate.ts
137
- var STDLIB_IMPORT_PATH = "@stripe/extensibility-sdk";
137
+ var STDLIB_IMPORT_PATH = "@stripe/extensibility-sdk/stdlib";
138
138
  function generateConfigDescriptor(result) {
139
139
  const usedImports = /* @__PURE__ */ new Set();
140
140
  const usedTypeImports = /* @__PURE__ */ new Set();
@@ -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: Record<string, unknown>;
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: Record<string, unknown>;
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. Return null to use the default. */
1048
- autoAdvance?: boolean;
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
- * _request: Billing.InvoiceCollectionOptions.InvoiceCollectionOptionsInput,
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 */