@openmeter/sdk 1.0.0-beta.211 → 1.0.0-beta.213

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 (65) hide show
  1. package/dist/cjs/src/client/apps.cjs +74 -1
  2. package/dist/cjs/src/client/apps.d.cts +43 -2
  3. package/dist/cjs/src/client/apps.js.map +1 -1
  4. package/dist/cjs/src/client/billing.cjs +47 -3
  5. package/dist/cjs/src/client/billing.d.cts +54 -3
  6. package/dist/cjs/src/client/billing.js.map +1 -1
  7. package/dist/cjs/src/client/customers.d.cts +5 -0
  8. package/dist/cjs/src/client/debug.cjs +27 -0
  9. package/dist/cjs/src/client/debug.d.cts +17 -0
  10. package/dist/cjs/src/client/debug.js.map +1 -0
  11. package/dist/cjs/src/client/entitlements.cjs +38 -1
  12. package/dist/cjs/src/client/entitlements.d.cts +85 -1
  13. package/dist/cjs/src/client/entitlements.js.map +1 -1
  14. package/dist/cjs/src/client/events.cjs +48 -13
  15. package/dist/cjs/src/client/events.d.cts +6 -1
  16. package/dist/cjs/src/client/events.js.map +1 -1
  17. package/dist/cjs/src/client/index.cjs +6 -0
  18. package/dist/cjs/src/client/index.d.cts +4 -0
  19. package/dist/cjs/src/client/index.js.map +1 -1
  20. package/dist/cjs/src/client/info.cjs +42 -0
  21. package/dist/cjs/src/client/info.d.cts +34 -0
  22. package/dist/cjs/src/client/info.js.map +1 -0
  23. package/dist/cjs/src/client/meters.cjs +19 -0
  24. package/dist/cjs/src/client/meters.d.cts +24 -0
  25. package/dist/cjs/src/client/meters.js.map +1 -1
  26. package/dist/cjs/src/client/schemas.d.cts +653 -45
  27. package/dist/cjs/src/zod/index.cjs +11328 -0
  28. package/dist/cjs/src/zod/index.d.cts +20105 -0
  29. package/dist/cjs/src/zod/index.js.map +1 -0
  30. package/dist/cjs/tsconfig.2452f99b.tsbuildinfo +1 -0
  31. package/dist/cjs/tsconfig.4cad059c.tsbuildinfo +1 -0
  32. package/dist/src/client/apps.d.ts +43 -2
  33. package/dist/src/client/apps.js +72 -0
  34. package/dist/src/client/apps.js.map +1 -1
  35. package/dist/src/client/billing.d.ts +54 -3
  36. package/dist/src/client/billing.js +47 -3
  37. package/dist/src/client/billing.js.map +1 -1
  38. package/dist/src/client/customers.d.ts +5 -0
  39. package/dist/src/client/debug.d.ts +17 -0
  40. package/dist/src/client/debug.js +23 -0
  41. package/dist/src/client/debug.js.map +1 -0
  42. package/dist/src/client/entitlements.d.ts +85 -1
  43. package/dist/src/client/entitlements.js +38 -1
  44. package/dist/src/client/entitlements.js.map +1 -1
  45. package/dist/src/client/events.d.ts +6 -1
  46. package/dist/src/client/events.js +48 -10
  47. package/dist/src/client/events.js.map +1 -1
  48. package/dist/src/client/index.d.ts +4 -0
  49. package/dist/src/client/index.js +6 -0
  50. package/dist/src/client/index.js.map +1 -1
  51. package/dist/src/client/info.d.ts +34 -0
  52. package/dist/src/client/info.js +38 -0
  53. package/dist/src/client/info.js.map +1 -0
  54. package/dist/src/client/meters.d.ts +24 -0
  55. package/dist/src/client/meters.js +19 -0
  56. package/dist/src/client/meters.js.map +1 -1
  57. package/dist/src/client/schemas.d.ts +653 -45
  58. package/dist/src/zod/index.d.ts +20105 -0
  59. package/dist/src/zod/index.js +11302 -0
  60. package/dist/src/zod/index.js.map +1 -0
  61. package/dist/tsconfig.tsbuildinfo +1 -1
  62. package/orval.config.ts +35 -0
  63. package/package.json +30 -16
  64. package/dist/cjs/tsconfig.341d9ef4.tsbuildinfo +0 -1
  65. package/dist/cjs/tsconfig.523d9ac8.tsbuildinfo +0 -1
@@ -113,6 +113,57 @@ export interface paths {
113
113
  patch?: never;
114
114
  trace?: never;
115
115
  };
116
+ '/api/v1/apps/custom-invoicing/{invoiceId}/draft/synchronized': {
117
+ parameters: {
118
+ query?: never;
119
+ header?: never;
120
+ path?: never;
121
+ cookie?: never;
122
+ };
123
+ get?: never;
124
+ put?: never;
125
+ /** Submit draft synchronization results */
126
+ post: operations['appCustomInvoicingDraftSynchronized'];
127
+ delete?: never;
128
+ options?: never;
129
+ head?: never;
130
+ patch?: never;
131
+ trace?: never;
132
+ };
133
+ '/api/v1/apps/custom-invoicing/{invoiceId}/issuing/synchronized': {
134
+ parameters: {
135
+ query?: never;
136
+ header?: never;
137
+ path?: never;
138
+ cookie?: never;
139
+ };
140
+ get?: never;
141
+ put?: never;
142
+ /** Submit issuing synchronization results */
143
+ post: operations['appCustomInvoicingIssuingSynchronized'];
144
+ delete?: never;
145
+ options?: never;
146
+ head?: never;
147
+ patch?: never;
148
+ trace?: never;
149
+ };
150
+ '/api/v1/apps/custom-invoicing/{invoiceId}/payment/status': {
151
+ parameters: {
152
+ query?: never;
153
+ header?: never;
154
+ path?: never;
155
+ cookie?: never;
156
+ };
157
+ get?: never;
158
+ put?: never;
159
+ /** Update payment status */
160
+ post: operations['appCustomInvoicingUpdatePaymentStatus'];
161
+ delete?: never;
162
+ options?: never;
163
+ head?: never;
164
+ patch?: never;
165
+ trace?: never;
166
+ };
116
167
  '/api/v1/apps/{id}': {
117
168
  parameters: {
118
169
  query?: never;
@@ -151,6 +202,7 @@ export interface paths {
151
202
  get?: never;
152
203
  /**
153
204
  * Update Stripe API key
205
+ * @deprecated
154
206
  * @description Update the Stripe API key.
155
207
  */
156
208
  put: operations['updateStripeAPIKey'];
@@ -2261,28 +2313,7 @@ export interface components {
2261
2313
  };
2262
2314
  /** @description App.
2263
2315
  * One of: stripe */
2264
- App: components['schemas']['StripeApp'] | components['schemas']['SandboxApp'];
2265
- /** @description Resource update operation model. */
2266
- AppBaseReplaceUpdate: {
2267
- /**
2268
- * Display name
2269
- * @description Human-readable name for the resource. Between 1 and 256 characters.
2270
- */
2271
- name: string;
2272
- /**
2273
- * Description
2274
- * @description Optional description of the resource. Maximum 1024 characters.
2275
- */
2276
- description?: string;
2277
- /**
2278
- * Metadata
2279
- * @description Additional metadata for the resource.
2280
- */
2281
- metadata?: components['schemas']['Metadata'] | null;
2282
- /** @description Default for the app type
2283
- * Only one app of each type can be default. */
2284
- default: boolean;
2285
- };
2316
+ App: components['schemas']['StripeApp'] | components['schemas']['SandboxApp'] | components['schemas']['CustomInvoicingApp'];
2286
2317
  /**
2287
2318
  * @description App capability.
2288
2319
  *
@@ -2339,6 +2370,8 @@ export interface components {
2339
2370
  */
2340
2371
  id: string;
2341
2372
  };
2373
+ /** @description App ReplaceUpdate Model */
2374
+ AppReplaceUpdate: components['schemas']['StripeAppReplaceUpdate'] | components['schemas']['SandboxAppReplaceUpdate'] | components['schemas']['CustomInvoicingAppReplaceUpdate'];
2342
2375
  /**
2343
2376
  * @description App installed status.
2344
2377
  * @enum {string}
@@ -2348,7 +2381,7 @@ export interface components {
2348
2381
  * @description Type of the app.
2349
2382
  * @enum {string}
2350
2383
  */
2351
- AppType: 'stripe' | 'sandbox';
2384
+ AppType: 'stripe' | 'sandbox' | 'custom_invoicing';
2352
2385
  /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
2353
2386
  BadRequestProblemResponse: components['schemas']['UnexpectedProblemResponse'];
2354
2387
  /** @description The balance history window. */
@@ -3116,6 +3149,218 @@ export interface components {
3116
3149
  * @example USD
3117
3150
  */
3118
3151
  CurrencyCode: string;
3152
+ /** @description Custom Invoicing app can be used for interface with any invoicing or payment system.
3153
+ *
3154
+ * This app provides ways to manipulate invoices and payments, however the integration
3155
+ * must rely on Notifications API to get notified about invoice changes. */
3156
+ CustomInvoicingApp: {
3157
+ /**
3158
+ * ID
3159
+ * @description A unique identifier for the resource.
3160
+ * @example 01G65Z755AFWAKHE12NY0CQ9FH
3161
+ */
3162
+ readonly id: string;
3163
+ /**
3164
+ * Display name
3165
+ * @description Human-readable name for the resource. Between 1 and 256 characters.
3166
+ */
3167
+ name: string;
3168
+ /**
3169
+ * Description
3170
+ * @description Optional description of the resource. Maximum 1024 characters.
3171
+ */
3172
+ description?: string;
3173
+ /**
3174
+ * Metadata
3175
+ * @description Additional metadata for the resource.
3176
+ */
3177
+ metadata?: components['schemas']['Metadata'] | null;
3178
+ /**
3179
+ * Creation Time
3180
+ * Format: date-time
3181
+ * @description Timestamp of when the resource was created.
3182
+ * @example 2024-01-01T01:01:01.001Z
3183
+ */
3184
+ readonly createdAt: Date;
3185
+ /**
3186
+ * Last Update Time
3187
+ * Format: date-time
3188
+ * @description Timestamp of when the resource was last updated.
3189
+ * @example 2024-01-01T01:01:01.001Z
3190
+ */
3191
+ readonly updatedAt: Date;
3192
+ /**
3193
+ * Deletion Time
3194
+ * Format: date-time
3195
+ * @description Timestamp of when the resource was permanently deleted.
3196
+ * @example 2024-01-01T01:01:01.001Z
3197
+ */
3198
+ readonly deletedAt?: Date;
3199
+ /** @description The marketplace listing that this installed app is based on. */
3200
+ readonly listing: components['schemas']['MarketplaceListing'];
3201
+ /** @description Status of the app connection. */
3202
+ readonly status: components['schemas']['AppStatus'];
3203
+ /** @description Default for the app type
3204
+ * Only one app of each type can be default. */
3205
+ default: boolean;
3206
+ /**
3207
+ * @description The app's type is CustomInvoicing. (enum property replaced by openapi-typescript)
3208
+ * @enum {string}
3209
+ */
3210
+ type: 'custom_invoicing';
3211
+ /** @description Enable draft.sync hook.
3212
+ *
3213
+ * If the hook is not enabled, the invoice will be progressed to the next state automatically. */
3214
+ enableDraftSyncHook: boolean;
3215
+ /** @description Enable issuing.sync hook.
3216
+ *
3217
+ * If the hook is not enabled, the invoice will be progressed to the next state automatically. */
3218
+ enableIssuingSyncHook: boolean;
3219
+ };
3220
+ /** @description Resource update operation model. */
3221
+ CustomInvoicingAppReplaceUpdate: {
3222
+ /**
3223
+ * Display name
3224
+ * @description Human-readable name for the resource. Between 1 and 256 characters.
3225
+ */
3226
+ name: string;
3227
+ /**
3228
+ * Description
3229
+ * @description Optional description of the resource. Maximum 1024 characters.
3230
+ */
3231
+ description?: string;
3232
+ /**
3233
+ * Metadata
3234
+ * @description Additional metadata for the resource.
3235
+ */
3236
+ metadata?: components['schemas']['Metadata'] | null;
3237
+ /** @description Default for the app type
3238
+ * Only one app of each type can be default. */
3239
+ default: boolean;
3240
+ /**
3241
+ * @description The app's type is CustomInvoicing. (enum property replaced by openapi-typescript)
3242
+ * @enum {string}
3243
+ */
3244
+ type: 'custom_invoicing';
3245
+ /** @description Enable draft.sync hook.
3246
+ *
3247
+ * If the hook is not enabled, the invoice will be progressed to the next state automatically. */
3248
+ enableDraftSyncHook: boolean;
3249
+ /** @description Enable issuing.sync hook.
3250
+ *
3251
+ * If the hook is not enabled, the invoice will be progressed to the next state automatically. */
3252
+ enableIssuingSyncHook: boolean;
3253
+ };
3254
+ /** @description Custom Invoicing Customer App Data. */
3255
+ CustomInvoicingCustomerAppData: {
3256
+ /** @description The installed custom invoicing app this data belongs to. */
3257
+ readonly app?: components['schemas']['CustomInvoicingApp'];
3258
+ /**
3259
+ * App ID
3260
+ * @description The app ID.
3261
+ * If not provided, it will use the global default for the app type.
3262
+ * @example 01G65Z755AFWAKHE12NY0CQ9FH
3263
+ */
3264
+ id?: string;
3265
+ /**
3266
+ * @description The app name. (enum property replaced by openapi-typescript)
3267
+ * @enum {string}
3268
+ */
3269
+ type: 'custom_invoicing';
3270
+ /** @description Metadata to be used by the custom invoicing provider. */
3271
+ metadata?: components['schemas']['Metadata'];
3272
+ };
3273
+ /** @description Information to finalize the draft details of an invoice. */
3274
+ CustomInvoicingDraftSynchronizedRequest: {
3275
+ /** @description The result of the synchronization. */
3276
+ invoicing?: components['schemas']['CustomInvoicingSyncResult'];
3277
+ };
3278
+ /** @description Information to finalize the invoicing details of an invoice. */
3279
+ CustomInvoicingFinalizedInvoicingRequest: {
3280
+ /** @description If set the invoice's number will be set to this value. */
3281
+ invoiceNumber?: components['schemas']['InvoiceNumber'];
3282
+ /**
3283
+ * Format: date-time
3284
+ * @description If set the invoice's sent to customer at will be set to this value.
3285
+ * @example 2023-01-01T01:01:01.001Z
3286
+ */
3287
+ sentToCustomerAt?: Date;
3288
+ };
3289
+ /** @description Information to finalize the payment details of an invoice. */
3290
+ CustomInvoicingFinalizedPaymentRequest: {
3291
+ /** @description If set the invoice's payment external ID will be set to this value. */
3292
+ externalId?: string;
3293
+ };
3294
+ /** @description Information to finalize the invoice.
3295
+ *
3296
+ * If invoicing.invoiceNumber is not set, then a new invoice number will be generated (INV- prefix). */
3297
+ CustomInvoicingFinalizedRequest: {
3298
+ /** @description The result of the synchronization. */
3299
+ invoicing?: components['schemas']['CustomInvoicingFinalizedInvoicingRequest'];
3300
+ /** @description The result of the payment synchronization. */
3301
+ payment?: components['schemas']['CustomInvoicingFinalizedPaymentRequest'];
3302
+ };
3303
+ /** @description Mapping between line discounts and external IDs. */
3304
+ CustomInvoicingLineDiscountExternalIdMapping: {
3305
+ /**
3306
+ * @description The line discount ID.
3307
+ * @example 01G65Z755AFWAKHE12NY0CQ9FH
3308
+ */
3309
+ lineDiscountId: string;
3310
+ /** @description The external ID (e.g. custom invoicing system's ID). */
3311
+ externalId: string;
3312
+ };
3313
+ /** @description Mapping between lines and external IDs. */
3314
+ CustomInvoicingLineExternalIdMapping: {
3315
+ /**
3316
+ * @description The line ID.
3317
+ * @example 01G65Z755AFWAKHE12NY0CQ9FH
3318
+ */
3319
+ lineId: string;
3320
+ /** @description The external ID (e.g. custom invoicing system's ID). */
3321
+ externalId: string;
3322
+ };
3323
+ /**
3324
+ * @description Payment trigger to execute on a finalized invoice.
3325
+ * @enum {string}
3326
+ */
3327
+ CustomInvoicingPaymentTrigger: 'paid' | 'payment_failed' | 'payment_uncollectible' | 'payment_overdue' | 'action_required' | 'void';
3328
+ /** @description Information to synchronize the invoice.
3329
+ *
3330
+ * Can be used to store external app's IDs on the invoice or lines. */
3331
+ CustomInvoicingSyncResult: {
3332
+ /** @description If set the invoice's number will be set to this value. */
3333
+ invoiceNumber?: components['schemas']['InvoiceNumber'];
3334
+ /** @description If set the invoice's invoicing external ID will be set to this value. */
3335
+ externalId?: string;
3336
+ /** @description If set the invoice's line external IDs will be set to this value.
3337
+ *
3338
+ * This can be used to reference the external system's entities in the
3339
+ * invoice. */
3340
+ lineExternalIds?: components['schemas']['CustomInvoicingLineExternalIdMapping'][];
3341
+ /** @description If set the invoice's line discount external IDs will be set to this value.
3342
+ *
3343
+ * This can be used to reference the external system's entities in the
3344
+ * invoice. */
3345
+ lineDiscountExternalIds?: components['schemas']['CustomInvoicingLineDiscountExternalIdMapping'][];
3346
+ };
3347
+ /** @description Custom invoicing tax config. */
3348
+ CustomInvoicingTaxConfig: {
3349
+ /**
3350
+ * Tax code
3351
+ * @description Tax code.
3352
+ *
3353
+ * The tax code should be interpreted by the custom invoicing provider.
3354
+ */
3355
+ code: string;
3356
+ };
3357
+ /** @description Update payment status request.
3358
+ *
3359
+ * Can be used to manipulate invoice's payment status (when custominvoicing app is being used). */
3360
+ CustomInvoicingUpdatePaymentStatusRequest: {
3361
+ /** @description The trigger to be executed on the invoice. */
3362
+ trigger: components['schemas']['CustomInvoicingPaymentTrigger'];
3363
+ };
3119
3364
  /** @description Plan input for custom subscription creation (without key and version). */
3120
3365
  CustomPlanInput: {
3121
3366
  /**
@@ -3283,8 +3528,12 @@ export interface components {
3283
3528
  };
3284
3529
  /** @description CustomerAppData
3285
3530
  * Stores the app specific data for the customer.
3286
- * One of: stripe, sandbox */
3287
- CustomerAppData: components['schemas']['StripeCustomerAppData'] | components['schemas']['SandboxCustomerAppData'];
3531
+ * One of: stripe, sandbox, custom_invoicing */
3532
+ CustomerAppData: components['schemas']['StripeCustomerAppData'] | components['schemas']['SandboxCustomerAppData'] | components['schemas']['CustomInvoicingCustomerAppData'];
3533
+ /** @description CustomerAppData
3534
+ * Stores the app specific data for the customer.
3535
+ * One of: stripe, sandbox, custom_invoicing */
3536
+ CustomerAppDataCreateOrUpdateItem: components['schemas']['StripeCustomerAppDataCreateOrUpdateItem'] | components['schemas']['SandboxCustomerAppData'] | components['schemas']['CustomInvoicingCustomerAppData'];
3288
3537
  /** @description Paginated response */
3289
3538
  CustomerAppDataPaginatedResponse: {
3290
3539
  /**
@@ -6223,8 +6472,6 @@ export interface components {
6223
6472
  * @description Named JSONPath expressions to extract the group by values from the event data.
6224
6473
  *
6225
6474
  * Keys must be unique and consist only alphanumeric and underscore characters.
6226
- *
6227
- * TODO: add key format enforcement
6228
6475
  * @example {
6229
6476
  * "type": "$.type"
6230
6477
  * }
@@ -6307,8 +6554,6 @@ export interface components {
6307
6554
  * @description Named JSONPath expressions to extract the group by values from the event data.
6308
6555
  *
6309
6556
  * Keys must be unique and consist only alphanumeric and underscore characters.
6310
- *
6311
- * TODO: add key format enforcement
6312
6557
  * @example {
6313
6558
  * "type": "$.type"
6314
6559
  * }
@@ -6438,8 +6683,6 @@ export interface components {
6438
6683
  * @description Named JSONPath expressions to extract the group by values from the event data.
6439
6684
  *
6440
6685
  * Keys must be unique and consist only alphanumeric and underscore characters.
6441
- *
6442
- * TODO: add key format enforcement
6443
6686
  * @example {
6444
6687
  * "type": "$.type"
6445
6688
  * }
@@ -7866,6 +8109,32 @@ export interface components {
7866
8109
  */
7867
8110
  type: 'sandbox';
7868
8111
  };
8112
+ /** @description Resource update operation model. */
8113
+ SandboxAppReplaceUpdate: {
8114
+ /**
8115
+ * Display name
8116
+ * @description Human-readable name for the resource. Between 1 and 256 characters.
8117
+ */
8118
+ name: string;
8119
+ /**
8120
+ * Description
8121
+ * @description Optional description of the resource. Maximum 1024 characters.
8122
+ */
8123
+ description?: string;
8124
+ /**
8125
+ * Metadata
8126
+ * @description Additional metadata for the resource.
8127
+ */
8128
+ metadata?: components['schemas']['Metadata'] | null;
8129
+ /** @description Default for the app type
8130
+ * Only one app of each type can be default. */
8131
+ default: boolean;
8132
+ /**
8133
+ * @description The app's type is Sandbox. (enum property replaced by openapi-typescript)
8134
+ * @enum {string}
8135
+ */
8136
+ type: 'sandbox';
8137
+ };
7869
8138
  /** @description Sandbox Customer App Data. */
7870
8139
  SandboxCustomerAppData: {
7871
8140
  /** @description The installed sandbox app this data belongs to. */
@@ -7995,12 +8264,43 @@ export interface components {
7995
8264
  */
7996
8265
  type: 'stripe';
7997
8266
  /** @description The Stripe account ID. */
7998
- stripeAccountId: string;
8267
+ readonly stripeAccountId: string;
7999
8268
  /** @description Livemode, true if the app is in production mode. */
8000
- livemode: boolean;
8269
+ readonly livemode: boolean;
8001
8270
  /** @description The masked API key.
8002
8271
  * Only shows the first 8 and last 3 characters. */
8003
- maskedAPIKey: string;
8272
+ readonly maskedAPIKey: string;
8273
+ };
8274
+ /** @description Resource update operation model. */
8275
+ StripeAppReplaceUpdate: {
8276
+ /**
8277
+ * Display name
8278
+ * @description Human-readable name for the resource. Between 1 and 256 characters.
8279
+ */
8280
+ name: string;
8281
+ /**
8282
+ * Description
8283
+ * @description Optional description of the resource. Maximum 1024 characters.
8284
+ */
8285
+ description?: string;
8286
+ /**
8287
+ * Metadata
8288
+ * @description Additional metadata for the resource.
8289
+ */
8290
+ metadata?: components['schemas']['Metadata'] | null;
8291
+ /** @description Default for the app type
8292
+ * Only one app of each type can be default. */
8293
+ default: boolean;
8294
+ /**
8295
+ * @description The app's type is Stripe. (enum property replaced by openapi-typescript)
8296
+ * @enum {string}
8297
+ */
8298
+ type: 'stripe';
8299
+ /**
8300
+ * Format: password
8301
+ * @description The Stripe API key.
8302
+ */
8303
+ secretAPIKey?: string;
8004
8304
  };
8005
8305
  /**
8006
8306
  * @description Stripe CheckoutSession.mode
@@ -8034,14 +8334,39 @@ export interface components {
8034
8334
  /** @description The Stripe default payment method ID. */
8035
8335
  stripeDefaultPaymentMethodId?: string;
8036
8336
  };
8037
- /** @description The tax config for Stripe. */
8038
- StripeTaxConfig: {
8039
- /**
8040
- * Tax code
8041
- * @description Product tax code.
8042
- *
8043
- * See: https://docs.stripe.com/tax/tax-codes
8044
- * @example txcd_10000000
8337
+ /**
8338
+ * @description Stripe Customer App Data.
8339
+ * @example {
8340
+ * "type": "stripe",
8341
+ * "stripeCustomerId": "cus_xxxxxxxxxxxxxx"
8342
+ * }
8343
+ */
8344
+ StripeCustomerAppDataCreateOrUpdateItem: {
8345
+ /**
8346
+ * App ID
8347
+ * @description The app ID.
8348
+ * If not provided, it will use the global default for the app type.
8349
+ * @example 01G65Z755AFWAKHE12NY0CQ9FH
8350
+ */
8351
+ id?: string;
8352
+ /**
8353
+ * @description The app name. (enum property replaced by openapi-typescript)
8354
+ * @enum {string}
8355
+ */
8356
+ type: 'stripe';
8357
+ /** @description The Stripe customer ID. */
8358
+ stripeCustomerId: string;
8359
+ /** @description The Stripe default payment method ID. */
8360
+ stripeDefaultPaymentMethodId?: string;
8361
+ };
8362
+ /** @description The tax config for Stripe. */
8363
+ StripeTaxConfig: {
8364
+ /**
8365
+ * Tax code
8366
+ * @description Product tax code.
8367
+ *
8368
+ * See: https://docs.stripe.com/tax/tax-codes
8369
+ * @example txcd_10000000
8045
8370
  */
8046
8371
  code: string;
8047
8372
  };
@@ -8903,6 +9228,11 @@ export interface components {
8903
9228
  * @description Stripe tax config.
8904
9229
  */
8905
9230
  stripe?: components['schemas']['StripeTaxConfig'];
9231
+ /**
9232
+ * Custom invoicing tax config
9233
+ * @description Custom invoicing tax config.
9234
+ */
9235
+ customInvoicing?: components['schemas']['CustomInvoicingTaxConfig'];
8906
9236
  };
8907
9237
  /**
8908
9238
  * @description The mode of the tiered price.
@@ -9368,11 +9698,11 @@ export type Address = components['schemas']['Address'];
9368
9698
  export type Alignment = components['schemas']['Alignment'];
9369
9699
  export type Annotations = components['schemas']['Annotations'];
9370
9700
  export type App = components['schemas']['App'];
9371
- export type AppBaseReplaceUpdate = components['schemas']['AppBaseReplaceUpdate'];
9372
9701
  export type AppCapability = components['schemas']['AppCapability'];
9373
9702
  export type AppCapabilityType = components['schemas']['AppCapabilityType'];
9374
9703
  export type AppPaginatedResponse = components['schemas']['AppPaginatedResponse'];
9375
9704
  export type AppReference = components['schemas']['AppReference'];
9705
+ export type AppReplaceUpdate = components['schemas']['AppReplaceUpdate'];
9376
9706
  export type AppStatus = components['schemas']['AppStatus'];
9377
9707
  export type AppType = components['schemas']['AppType'];
9378
9708
  export type BadRequestProblemResponse = components['schemas']['BadRequestProblemResponse'];
@@ -9432,12 +9762,26 @@ export type CreateStripeCheckoutSessionResult = components['schemas']['CreateStr
9432
9762
  export type CreditNoteOriginalInvoiceRef = components['schemas']['CreditNoteOriginalInvoiceRef'];
9433
9763
  export type Currency = components['schemas']['Currency'];
9434
9764
  export type CurrencyCode = components['schemas']['CurrencyCode'];
9765
+ export type CustomInvoicingApp = components['schemas']['CustomInvoicingApp'];
9766
+ export type CustomInvoicingAppReplaceUpdate = components['schemas']['CustomInvoicingAppReplaceUpdate'];
9767
+ export type CustomInvoicingCustomerAppData = components['schemas']['CustomInvoicingCustomerAppData'];
9768
+ export type CustomInvoicingDraftSynchronizedRequest = components['schemas']['CustomInvoicingDraftSynchronizedRequest'];
9769
+ export type CustomInvoicingFinalizedInvoicingRequest = components['schemas']['CustomInvoicingFinalizedInvoicingRequest'];
9770
+ export type CustomInvoicingFinalizedPaymentRequest = components['schemas']['CustomInvoicingFinalizedPaymentRequest'];
9771
+ export type CustomInvoicingFinalizedRequest = components['schemas']['CustomInvoicingFinalizedRequest'];
9772
+ export type CustomInvoicingLineDiscountExternalIdMapping = components['schemas']['CustomInvoicingLineDiscountExternalIdMapping'];
9773
+ export type CustomInvoicingLineExternalIdMapping = components['schemas']['CustomInvoicingLineExternalIdMapping'];
9774
+ export type CustomInvoicingPaymentTrigger = components['schemas']['CustomInvoicingPaymentTrigger'];
9775
+ export type CustomInvoicingSyncResult = components['schemas']['CustomInvoicingSyncResult'];
9776
+ export type CustomInvoicingTaxConfig = components['schemas']['CustomInvoicingTaxConfig'];
9777
+ export type CustomInvoicingUpdatePaymentStatusRequest = components['schemas']['CustomInvoicingUpdatePaymentStatusRequest'];
9435
9778
  export type CustomPlanInput = components['schemas']['CustomPlanInput'];
9436
9779
  export type CustomSubscriptionChange = components['schemas']['CustomSubscriptionChange'];
9437
9780
  export type CustomSubscriptionCreate = components['schemas']['CustomSubscriptionCreate'];
9438
9781
  export type Customer = components['schemas']['Customer'];
9439
9782
  export type CustomerAccess = components['schemas']['CustomerAccess'];
9440
9783
  export type CustomerAppData = components['schemas']['CustomerAppData'];
9784
+ export type CustomerAppDataCreateOrUpdateItem = components['schemas']['CustomerAppDataCreateOrUpdateItem'];
9441
9785
  export type CustomerAppDataPaginatedResponse = components['schemas']['CustomerAppDataPaginatedResponse'];
9442
9786
  export type CustomerCreate = components['schemas']['CustomerCreate'];
9443
9787
  export type CustomerExpand = components['schemas']['CustomerExpand'];
@@ -9637,13 +9981,16 @@ export type RecurringPeriodIntervalEnum = components['schemas']['RecurringPeriod
9637
9981
  export type RemovePhaseShifting = components['schemas']['RemovePhaseShifting'];
9638
9982
  export type ResetEntitlementUsageInput = components['schemas']['ResetEntitlementUsageInput'];
9639
9983
  export type SandboxApp = components['schemas']['SandboxApp'];
9984
+ export type SandboxAppReplaceUpdate = components['schemas']['SandboxAppReplaceUpdate'];
9640
9985
  export type SandboxCustomerAppData = components['schemas']['SandboxCustomerAppData'];
9641
9986
  export type ServiceUnavailableProblemResponse = components['schemas']['ServiceUnavailableProblemResponse'];
9642
9987
  export type SortOrder = components['schemas']['SortOrder'];
9643
9988
  export type StripeApiKeyInput = components['schemas']['StripeAPIKeyInput'];
9644
9989
  export type StripeApp = components['schemas']['StripeApp'];
9990
+ export type StripeAppReplaceUpdate = components['schemas']['StripeAppReplaceUpdate'];
9645
9991
  export type StripeCheckoutSessionMode = components['schemas']['StripeCheckoutSessionMode'];
9646
9992
  export type StripeCustomerAppData = components['schemas']['StripeCustomerAppData'];
9993
+ export type StripeCustomerAppDataCreateOrUpdateItem = components['schemas']['StripeCustomerAppDataCreateOrUpdateItem'];
9647
9994
  export type StripeTaxConfig = components['schemas']['StripeTaxConfig'];
9648
9995
  export type StripeWebhookEvent = components['schemas']['StripeWebhookEvent'];
9649
9996
  export type StripeWebhookResponse = components['schemas']['StripeWebhookResponse'];
@@ -10541,6 +10888,267 @@ export interface operations {
10541
10888
  };
10542
10889
  };
10543
10890
  };
10891
+ appCustomInvoicingDraftSynchronized: {
10892
+ parameters: {
10893
+ query?: never;
10894
+ header?: never;
10895
+ path: {
10896
+ invoiceId: string;
10897
+ };
10898
+ cookie?: never;
10899
+ };
10900
+ requestBody: {
10901
+ content: {
10902
+ 'application/json': components['schemas']['CustomInvoicingDraftSynchronizedRequest'];
10903
+ };
10904
+ };
10905
+ responses: {
10906
+ /** @description There is no content to send for this request, but the headers may be useful. */
10907
+ 204: {
10908
+ headers: {
10909
+ [name: string]: unknown;
10910
+ };
10911
+ content?: never;
10912
+ };
10913
+ /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
10914
+ 400: {
10915
+ headers: {
10916
+ [name: string]: unknown;
10917
+ };
10918
+ content: {
10919
+ 'application/problem+json': components['schemas']['BadRequestProblemResponse'];
10920
+ };
10921
+ };
10922
+ /** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
10923
+ 401: {
10924
+ headers: {
10925
+ [name: string]: unknown;
10926
+ };
10927
+ content: {
10928
+ 'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
10929
+ };
10930
+ };
10931
+ /** @description The server understood the request but refuses to authorize it. */
10932
+ 403: {
10933
+ headers: {
10934
+ [name: string]: unknown;
10935
+ };
10936
+ content: {
10937
+ 'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
10938
+ };
10939
+ };
10940
+ /** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
10941
+ 412: {
10942
+ headers: {
10943
+ [name: string]: unknown;
10944
+ };
10945
+ content: {
10946
+ 'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
10947
+ };
10948
+ };
10949
+ /** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
10950
+ 500: {
10951
+ headers: {
10952
+ [name: string]: unknown;
10953
+ };
10954
+ content: {
10955
+ 'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
10956
+ };
10957
+ };
10958
+ /** @description The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. */
10959
+ 503: {
10960
+ headers: {
10961
+ [name: string]: unknown;
10962
+ };
10963
+ content: {
10964
+ 'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
10965
+ };
10966
+ };
10967
+ /** @description An unexpected error response. */
10968
+ default: {
10969
+ headers: {
10970
+ [name: string]: unknown;
10971
+ };
10972
+ content: {
10973
+ 'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
10974
+ };
10975
+ };
10976
+ };
10977
+ };
10978
+ appCustomInvoicingIssuingSynchronized: {
10979
+ parameters: {
10980
+ query?: never;
10981
+ header?: never;
10982
+ path: {
10983
+ invoiceId: string;
10984
+ };
10985
+ cookie?: never;
10986
+ };
10987
+ requestBody: {
10988
+ content: {
10989
+ 'application/json': components['schemas']['CustomInvoicingFinalizedRequest'];
10990
+ };
10991
+ };
10992
+ responses: {
10993
+ /** @description There is no content to send for this request, but the headers may be useful. */
10994
+ 204: {
10995
+ headers: {
10996
+ [name: string]: unknown;
10997
+ };
10998
+ content?: never;
10999
+ };
11000
+ /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
11001
+ 400: {
11002
+ headers: {
11003
+ [name: string]: unknown;
11004
+ };
11005
+ content: {
11006
+ 'application/problem+json': components['schemas']['BadRequestProblemResponse'];
11007
+ };
11008
+ };
11009
+ /** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
11010
+ 401: {
11011
+ headers: {
11012
+ [name: string]: unknown;
11013
+ };
11014
+ content: {
11015
+ 'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
11016
+ };
11017
+ };
11018
+ /** @description The server understood the request but refuses to authorize it. */
11019
+ 403: {
11020
+ headers: {
11021
+ [name: string]: unknown;
11022
+ };
11023
+ content: {
11024
+ 'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
11025
+ };
11026
+ };
11027
+ /** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
11028
+ 412: {
11029
+ headers: {
11030
+ [name: string]: unknown;
11031
+ };
11032
+ content: {
11033
+ 'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
11034
+ };
11035
+ };
11036
+ /** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
11037
+ 500: {
11038
+ headers: {
11039
+ [name: string]: unknown;
11040
+ };
11041
+ content: {
11042
+ 'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
11043
+ };
11044
+ };
11045
+ /** @description The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. */
11046
+ 503: {
11047
+ headers: {
11048
+ [name: string]: unknown;
11049
+ };
11050
+ content: {
11051
+ 'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
11052
+ };
11053
+ };
11054
+ /** @description An unexpected error response. */
11055
+ default: {
11056
+ headers: {
11057
+ [name: string]: unknown;
11058
+ };
11059
+ content: {
11060
+ 'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
11061
+ };
11062
+ };
11063
+ };
11064
+ };
11065
+ appCustomInvoicingUpdatePaymentStatus: {
11066
+ parameters: {
11067
+ query?: never;
11068
+ header?: never;
11069
+ path: {
11070
+ invoiceId: string;
11071
+ };
11072
+ cookie?: never;
11073
+ };
11074
+ requestBody: {
11075
+ content: {
11076
+ 'application/json': components['schemas']['CustomInvoicingUpdatePaymentStatusRequest'];
11077
+ };
11078
+ };
11079
+ responses: {
11080
+ /** @description There is no content to send for this request, but the headers may be useful. */
11081
+ 204: {
11082
+ headers: {
11083
+ [name: string]: unknown;
11084
+ };
11085
+ content?: never;
11086
+ };
11087
+ /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
11088
+ 400: {
11089
+ headers: {
11090
+ [name: string]: unknown;
11091
+ };
11092
+ content: {
11093
+ 'application/problem+json': components['schemas']['BadRequestProblemResponse'];
11094
+ };
11095
+ };
11096
+ /** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
11097
+ 401: {
11098
+ headers: {
11099
+ [name: string]: unknown;
11100
+ };
11101
+ content: {
11102
+ 'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
11103
+ };
11104
+ };
11105
+ /** @description The server understood the request but refuses to authorize it. */
11106
+ 403: {
11107
+ headers: {
11108
+ [name: string]: unknown;
11109
+ };
11110
+ content: {
11111
+ 'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
11112
+ };
11113
+ };
11114
+ /** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
11115
+ 412: {
11116
+ headers: {
11117
+ [name: string]: unknown;
11118
+ };
11119
+ content: {
11120
+ 'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
11121
+ };
11122
+ };
11123
+ /** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
11124
+ 500: {
11125
+ headers: {
11126
+ [name: string]: unknown;
11127
+ };
11128
+ content: {
11129
+ 'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
11130
+ };
11131
+ };
11132
+ /** @description The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. */
11133
+ 503: {
11134
+ headers: {
11135
+ [name: string]: unknown;
11136
+ };
11137
+ content: {
11138
+ 'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
11139
+ };
11140
+ };
11141
+ /** @description An unexpected error response. */
11142
+ default: {
11143
+ headers: {
11144
+ [name: string]: unknown;
11145
+ };
11146
+ content: {
11147
+ 'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
11148
+ };
11149
+ };
11150
+ };
11151
+ };
10544
11152
  getApp: {
10545
11153
  parameters: {
10546
11154
  query?: never;
@@ -10646,7 +11254,7 @@ export interface operations {
10646
11254
  };
10647
11255
  requestBody: {
10648
11256
  content: {
10649
- 'application/json': components['schemas']['AppBaseReplaceUpdate'];
11257
+ 'application/json': components['schemas']['AppReplaceUpdate'];
10650
11258
  };
10651
11259
  };
10652
11260
  responses: {
@@ -13713,7 +14321,7 @@ export interface operations {
13713
14321
  };
13714
14322
  requestBody: {
13715
14323
  content: {
13716
- 'application/json': components['schemas']['CustomerAppData'][];
14324
+ 'application/json': components['schemas']['CustomerAppDataCreateOrUpdateItem'][];
13717
14325
  };
13718
14326
  };
13719
14327
  responses: {