@openmeter/sdk 1.0.0-beta.210 → 1.0.0-beta.212
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/dist/cjs/src/client/apps.cjs +74 -1
- package/dist/cjs/src/client/apps.d.cts +44 -2
- package/dist/cjs/src/client/apps.js.map +1 -1
- package/dist/cjs/src/client/billing.cjs +47 -3
- package/dist/cjs/src/client/billing.d.cts +54 -3
- package/dist/cjs/src/client/billing.js.map +1 -1
- package/dist/cjs/src/client/customers.d.cts +8 -0
- package/dist/cjs/src/client/debug.cjs +27 -0
- package/dist/cjs/src/client/debug.d.cts +17 -0
- package/dist/cjs/src/client/debug.js.map +1 -0
- package/dist/cjs/src/client/entitlements.cjs +38 -1
- package/dist/cjs/src/client/entitlements.d.cts +85 -1
- package/dist/cjs/src/client/entitlements.js.map +1 -1
- package/dist/cjs/src/client/index.cjs +6 -0
- package/dist/cjs/src/client/index.d.cts +4 -0
- package/dist/cjs/src/client/index.js.map +1 -1
- package/dist/cjs/src/client/info.cjs +42 -0
- package/dist/cjs/src/client/info.d.cts +34 -0
- package/dist/cjs/src/client/info.js.map +1 -0
- package/dist/cjs/src/client/schemas.d.cts +991 -207
- package/dist/cjs/tsconfig.065c79dd.tsbuildinfo +1 -0
- package/dist/cjs/tsconfig.9b7a0781.tsbuildinfo +1 -0
- package/dist/src/client/apps.d.ts +44 -2
- package/dist/src/client/apps.js +72 -0
- package/dist/src/client/apps.js.map +1 -1
- package/dist/src/client/billing.d.ts +54 -3
- package/dist/src/client/billing.js +47 -3
- package/dist/src/client/billing.js.map +1 -1
- package/dist/src/client/customers.d.ts +8 -0
- package/dist/src/client/debug.d.ts +17 -0
- package/dist/src/client/debug.js +23 -0
- package/dist/src/client/debug.js.map +1 -0
- package/dist/src/client/entitlements.d.ts +85 -1
- package/dist/src/client/entitlements.js +38 -1
- package/dist/src/client/entitlements.js.map +1 -1
- package/dist/src/client/index.d.ts +4 -0
- package/dist/src/client/index.js +6 -0
- package/dist/src/client/index.js.map +1 -1
- package/dist/src/client/info.d.ts +34 -0
- package/dist/src/client/info.js +38 -0
- package/dist/src/client/info.js.map +1 -0
- package/dist/src/client/schemas.d.ts +991 -207
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +15 -15
- package/dist/cjs/tsconfig.1232d5e5.tsbuildinfo +0 -1
- package/dist/cjs/tsconfig.90ca0b5f.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'];
|
|
@@ -956,6 +1008,26 @@ export interface paths {
|
|
|
956
1008
|
patch?: never;
|
|
957
1009
|
trace?: never;
|
|
958
1010
|
};
|
|
1011
|
+
'/api/v1/marketplace/listings/{type}/install': {
|
|
1012
|
+
parameters: {
|
|
1013
|
+
query?: never;
|
|
1014
|
+
header?: never;
|
|
1015
|
+
path?: never;
|
|
1016
|
+
cookie?: never;
|
|
1017
|
+
};
|
|
1018
|
+
get?: never;
|
|
1019
|
+
put?: never;
|
|
1020
|
+
/**
|
|
1021
|
+
* Install app
|
|
1022
|
+
* @description Install an app from the marketplace.
|
|
1023
|
+
*/
|
|
1024
|
+
post: operations['marketplaceAppInstall'];
|
|
1025
|
+
delete?: never;
|
|
1026
|
+
options?: never;
|
|
1027
|
+
head?: never;
|
|
1028
|
+
patch?: never;
|
|
1029
|
+
trace?: never;
|
|
1030
|
+
};
|
|
959
1031
|
'/api/v1/marketplace/listings/{type}/install/apikey': {
|
|
960
1032
|
parameters: {
|
|
961
1033
|
query?: never;
|
|
@@ -967,7 +1039,7 @@ export interface paths {
|
|
|
967
1039
|
put?: never;
|
|
968
1040
|
/**
|
|
969
1041
|
* Install app via API key
|
|
970
|
-
* @description Install an marketplace via API Key.
|
|
1042
|
+
* @description Install an marketplace app via API Key.
|
|
971
1043
|
*/
|
|
972
1044
|
post: operations['marketplaceAppAPIKeyInstall'];
|
|
973
1045
|
delete?: never;
|
|
@@ -2241,28 +2313,7 @@ export interface components {
|
|
|
2241
2313
|
};
|
|
2242
2314
|
/** @description App.
|
|
2243
2315
|
* One of: stripe */
|
|
2244
|
-
App: components['schemas']['StripeApp'] | components['schemas']['SandboxApp'];
|
|
2245
|
-
/** @description Resource update operation model. */
|
|
2246
|
-
AppBaseReplaceUpdate: {
|
|
2247
|
-
/**
|
|
2248
|
-
* Display name
|
|
2249
|
-
* @description Human-readable name for the resource. Between 1 and 256 characters.
|
|
2250
|
-
*/
|
|
2251
|
-
name: string;
|
|
2252
|
-
/**
|
|
2253
|
-
* Description
|
|
2254
|
-
* @description Optional description of the resource. Maximum 1024 characters.
|
|
2255
|
-
*/
|
|
2256
|
-
description?: string;
|
|
2257
|
-
/**
|
|
2258
|
-
* Metadata
|
|
2259
|
-
* @description Additional metadata for the resource.
|
|
2260
|
-
*/
|
|
2261
|
-
metadata?: components['schemas']['Metadata'] | null;
|
|
2262
|
-
/** @description Default for the app type
|
|
2263
|
-
* Only one app of each type can be default. */
|
|
2264
|
-
default: boolean;
|
|
2265
|
-
};
|
|
2316
|
+
App: components['schemas']['StripeApp'] | components['schemas']['SandboxApp'] | components['schemas']['CustomInvoicingApp'];
|
|
2266
2317
|
/**
|
|
2267
2318
|
* @description App capability.
|
|
2268
2319
|
*
|
|
@@ -2319,6 +2370,8 @@ export interface components {
|
|
|
2319
2370
|
*/
|
|
2320
2371
|
id: string;
|
|
2321
2372
|
};
|
|
2373
|
+
/** @description App ReplaceUpdate Model */
|
|
2374
|
+
AppReplaceUpdate: components['schemas']['StripeAppReplaceUpdate'] | components['schemas']['SandboxAppReplaceUpdate'] | components['schemas']['CustomInvoicingAppReplaceUpdate'];
|
|
2322
2375
|
/**
|
|
2323
2376
|
* @description App installed status.
|
|
2324
2377
|
* @enum {string}
|
|
@@ -2328,7 +2381,7 @@ export interface components {
|
|
|
2328
2381
|
* @description Type of the app.
|
|
2329
2382
|
* @enum {string}
|
|
2330
2383
|
*/
|
|
2331
|
-
AppType: 'stripe' | 'sandbox';
|
|
2384
|
+
AppType: 'stripe' | 'sandbox' | 'custom_invoicing';
|
|
2332
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). */
|
|
2333
2386
|
BadRequestProblemResponse: components['schemas']['UnexpectedProblemResponse'];
|
|
2334
2387
|
/** @description The balance history window. */
|
|
@@ -3096,6 +3149,218 @@ export interface components {
|
|
|
3096
3149
|
* @example USD
|
|
3097
3150
|
*/
|
|
3098
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
|
+
};
|
|
3099
3364
|
/** @description Plan input for custom subscription creation (without key and version). */
|
|
3100
3365
|
CustomPlanInput: {
|
|
3101
3366
|
/**
|
|
@@ -3246,6 +3511,12 @@ export interface components {
|
|
|
3246
3511
|
* @example 01G65Z755AFWAKHE12NY0CQ9FH
|
|
3247
3512
|
*/
|
|
3248
3513
|
readonly currentSubscriptionId?: string;
|
|
3514
|
+
/**
|
|
3515
|
+
* Subscriptions
|
|
3516
|
+
* @description The subscriptions of the customer.
|
|
3517
|
+
* Only with the `subscriptions` expand option.
|
|
3518
|
+
*/
|
|
3519
|
+
readonly subscriptions?: components['schemas']['Subscription'][];
|
|
3249
3520
|
};
|
|
3250
3521
|
/** @description CustomerAccess describes what features the customer has access to. */
|
|
3251
3522
|
CustomerAccess: {
|
|
@@ -3257,8 +3528,12 @@ export interface components {
|
|
|
3257
3528
|
};
|
|
3258
3529
|
/** @description CustomerAppData
|
|
3259
3530
|
* Stores the app specific data for the customer.
|
|
3260
|
-
* One of: stripe, sandbox */
|
|
3261
|
-
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'];
|
|
3262
3537
|
/** @description Paginated response */
|
|
3263
3538
|
CustomerAppDataPaginatedResponse: {
|
|
3264
3539
|
/**
|
|
@@ -3326,6 +3601,11 @@ export interface components {
|
|
|
3326
3601
|
*/
|
|
3327
3602
|
billingAddress?: components['schemas']['Address'];
|
|
3328
3603
|
};
|
|
3604
|
+
/**
|
|
3605
|
+
* @description CustomerExpand specifies the parts of the customer to expand in the list output.
|
|
3606
|
+
* @enum {string}
|
|
3607
|
+
*/
|
|
3608
|
+
CustomerExpand: 'subscriptions';
|
|
3329
3609
|
/** @description Create Stripe checkout session with customer ID. */
|
|
3330
3610
|
CustomerId: {
|
|
3331
3611
|
/**
|
|
@@ -4742,6 +5022,11 @@ export interface components {
|
|
|
4742
5022
|
/** @description The cursor of the last item in the list. */
|
|
4743
5023
|
nextCursor?: string;
|
|
4744
5024
|
};
|
|
5025
|
+
/**
|
|
5026
|
+
* @description Install method of the application.
|
|
5027
|
+
* @enum {string}
|
|
5028
|
+
*/
|
|
5029
|
+
InstallMethod: 'with_oauth2' | 'with_api_key' | 'no_credentials_required';
|
|
4745
5030
|
/** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
|
|
4746
5031
|
InternalServerErrorProblemResponse: components['schemas']['UnexpectedProblemResponse'];
|
|
4747
5032
|
/** @description Invoice represents an invoice in the system. */
|
|
@@ -6024,6 +6309,10 @@ export interface components {
|
|
|
6024
6309
|
* "name": "Collect Payments",
|
|
6025
6310
|
* "description": "Stripe payments collects outstanding revenue with Stripe customer's default payment method."
|
|
6026
6311
|
* }
|
|
6312
|
+
* ],
|
|
6313
|
+
* "installMethods": [
|
|
6314
|
+
* "with_oauth2",
|
|
6315
|
+
* "with_api_key"
|
|
6027
6316
|
* ]
|
|
6028
6317
|
* }
|
|
6029
6318
|
*/
|
|
@@ -6036,6 +6325,10 @@ export interface components {
|
|
|
6036
6325
|
description: string;
|
|
6037
6326
|
/** @description The app's capabilities. */
|
|
6038
6327
|
capabilities: components['schemas']['AppCapability'][];
|
|
6328
|
+
/** @description Install methods.
|
|
6329
|
+
*
|
|
6330
|
+
* List of methods to install the app. */
|
|
6331
|
+
installMethods: components['schemas']['InstallMethod'][];
|
|
6039
6332
|
};
|
|
6040
6333
|
/** @description Paginated response */
|
|
6041
6334
|
MarketplaceListingPaginatedResponse: {
|
|
@@ -7079,6 +7372,16 @@ export interface components {
|
|
|
7079
7372
|
* @example 2024-01-01T01:01:01.001Z
|
|
7080
7373
|
*/
|
|
7081
7374
|
readonly deletedAt?: Date;
|
|
7375
|
+
/**
|
|
7376
|
+
* Annotations
|
|
7377
|
+
* @description Set of key-value pairs managed by the system. Cannot be modified by user.
|
|
7378
|
+
*/
|
|
7379
|
+
readonly annotations?: components['schemas']['Annotations'];
|
|
7380
|
+
/**
|
|
7381
|
+
* Metadata
|
|
7382
|
+
* @description Additional metadata for the resource.
|
|
7383
|
+
*/
|
|
7384
|
+
metadata?: components['schemas']['Metadata'];
|
|
7082
7385
|
/**
|
|
7083
7386
|
* Addon
|
|
7084
7387
|
* @description Partially populated add-on properties.
|
|
@@ -7119,78 +7422,68 @@ export interface components {
|
|
|
7119
7422
|
*/
|
|
7120
7423
|
maxQuantity?: number;
|
|
7121
7424
|
};
|
|
7122
|
-
/** @description
|
|
7425
|
+
/** @description A plan add-on assignment create request. */
|
|
7123
7426
|
PlanAddonCreate: {
|
|
7427
|
+
/**
|
|
7428
|
+
* Metadata
|
|
7429
|
+
* @description Additional metadata for the resource.
|
|
7430
|
+
*/
|
|
7431
|
+
metadata?: components['schemas']['Metadata'];
|
|
7432
|
+
/**
|
|
7433
|
+
* The plan phase from the add-on becomes purchasable
|
|
7434
|
+
* @description The key of the plan phase from the add-on becomes available for purchase.
|
|
7435
|
+
*/
|
|
7436
|
+
fromPlanPhase: string;
|
|
7437
|
+
/**
|
|
7438
|
+
* Max quantity of the add-on
|
|
7439
|
+
* @description The maximum number of times the add-on can be purchased for the plan.
|
|
7440
|
+
* It is not applicable for add-ons with single instance type.
|
|
7441
|
+
*/
|
|
7442
|
+
maxQuantity?: number;
|
|
7124
7443
|
/**
|
|
7125
7444
|
* Addon
|
|
7126
|
-
* @description
|
|
7445
|
+
* @description The add-on to create.
|
|
7127
7446
|
*/
|
|
7128
7447
|
addon: {
|
|
7129
7448
|
/**
|
|
7130
|
-
* ID
|
|
7131
7449
|
* @description The ID of the add-on.
|
|
7132
7450
|
* @example 01G65Z755AFWAKHE12NY0CQ9FH
|
|
7133
7451
|
*/
|
|
7134
7452
|
id: string;
|
|
7135
|
-
/**
|
|
7136
|
-
* Key
|
|
7137
|
-
* @description A semi-unique identifier for the resource.
|
|
7138
|
-
*/
|
|
7139
|
-
readonly key: string;
|
|
7140
|
-
/**
|
|
7141
|
-
* Version
|
|
7142
|
-
* @description The version of the Add-on which templates this instance.
|
|
7143
|
-
* @default 1
|
|
7144
|
-
*/
|
|
7145
|
-
readonly version: number;
|
|
7146
|
-
/**
|
|
7147
|
-
* InstanceType
|
|
7148
|
-
* @description The instance type of the add-on.
|
|
7149
|
-
*/
|
|
7150
|
-
readonly instanceType: components['schemas']['AddonInstanceType'];
|
|
7151
7453
|
};
|
|
7454
|
+
};
|
|
7455
|
+
/**
|
|
7456
|
+
* @description Order by options for plan add-on assignments.
|
|
7457
|
+
* @enum {string}
|
|
7458
|
+
*/
|
|
7459
|
+
PlanAddonOrderBy: 'id' | 'key' | 'version' | 'created_at' | 'updated_at';
|
|
7460
|
+
/** @description Paginated response */
|
|
7461
|
+
PlanAddonPaginatedResponse: {
|
|
7152
7462
|
/**
|
|
7153
|
-
* The
|
|
7154
|
-
* @
|
|
7463
|
+
* @description The total number of items.
|
|
7464
|
+
* @example 500
|
|
7155
7465
|
*/
|
|
7156
|
-
|
|
7466
|
+
totalCount: number;
|
|
7157
7467
|
/**
|
|
7158
|
-
*
|
|
7159
|
-
* @
|
|
7160
|
-
* It is not applicable for add-ons with single instance type.
|
|
7468
|
+
* @description The page index.
|
|
7469
|
+
* @example 1
|
|
7161
7470
|
*/
|
|
7162
|
-
|
|
7471
|
+
page: number;
|
|
7472
|
+
/**
|
|
7473
|
+
* @description The maximum number of items per page.
|
|
7474
|
+
* @example 100
|
|
7475
|
+
*/
|
|
7476
|
+
pageSize: number;
|
|
7477
|
+
/** @description The items in the current page. */
|
|
7478
|
+
items: components['schemas']['PlanAddon'][];
|
|
7163
7479
|
};
|
|
7164
7480
|
/** @description Resource update operation model. */
|
|
7165
7481
|
PlanAddonReplaceUpdate: {
|
|
7166
7482
|
/**
|
|
7167
|
-
*
|
|
7168
|
-
* @description
|
|
7483
|
+
* Metadata
|
|
7484
|
+
* @description Additional metadata for the resource.
|
|
7169
7485
|
*/
|
|
7170
|
-
|
|
7171
|
-
/**
|
|
7172
|
-
* ID
|
|
7173
|
-
* @description The ID of the add-on.
|
|
7174
|
-
* @example 01G65Z755AFWAKHE12NY0CQ9FH
|
|
7175
|
-
*/
|
|
7176
|
-
id: string;
|
|
7177
|
-
/**
|
|
7178
|
-
* Key
|
|
7179
|
-
* @description A semi-unique identifier for the resource.
|
|
7180
|
-
*/
|
|
7181
|
-
readonly key: string;
|
|
7182
|
-
/**
|
|
7183
|
-
* Version
|
|
7184
|
-
* @description The version of the Add-on which templates this instance.
|
|
7185
|
-
* @default 1
|
|
7186
|
-
*/
|
|
7187
|
-
readonly version: number;
|
|
7188
|
-
/**
|
|
7189
|
-
* InstanceType
|
|
7190
|
-
* @description The instance type of the add-on.
|
|
7191
|
-
*/
|
|
7192
|
-
readonly instanceType: components['schemas']['AddonInstanceType'];
|
|
7193
|
-
};
|
|
7486
|
+
metadata?: components['schemas']['Metadata'];
|
|
7194
7487
|
/**
|
|
7195
7488
|
* The plan phase from the add-on becomes purchasable
|
|
7196
7489
|
* @description The key of the plan phase from the add-on becomes available for purchase.
|
|
@@ -7822,6 +8115,32 @@ export interface components {
|
|
|
7822
8115
|
*/
|
|
7823
8116
|
type: 'sandbox';
|
|
7824
8117
|
};
|
|
8118
|
+
/** @description Resource update operation model. */
|
|
8119
|
+
SandboxAppReplaceUpdate: {
|
|
8120
|
+
/**
|
|
8121
|
+
* Display name
|
|
8122
|
+
* @description Human-readable name for the resource. Between 1 and 256 characters.
|
|
8123
|
+
*/
|
|
8124
|
+
name: string;
|
|
8125
|
+
/**
|
|
8126
|
+
* Description
|
|
8127
|
+
* @description Optional description of the resource. Maximum 1024 characters.
|
|
8128
|
+
*/
|
|
8129
|
+
description?: string;
|
|
8130
|
+
/**
|
|
8131
|
+
* Metadata
|
|
8132
|
+
* @description Additional metadata for the resource.
|
|
8133
|
+
*/
|
|
8134
|
+
metadata?: components['schemas']['Metadata'] | null;
|
|
8135
|
+
/** @description Default for the app type
|
|
8136
|
+
* Only one app of each type can be default. */
|
|
8137
|
+
default: boolean;
|
|
8138
|
+
/**
|
|
8139
|
+
* @description The app's type is Sandbox. (enum property replaced by openapi-typescript)
|
|
8140
|
+
* @enum {string}
|
|
8141
|
+
*/
|
|
8142
|
+
type: 'sandbox';
|
|
8143
|
+
};
|
|
7825
8144
|
/** @description Sandbox Customer App Data. */
|
|
7826
8145
|
SandboxCustomerAppData: {
|
|
7827
8146
|
/** @description The installed sandbox app this data belongs to. */
|
|
@@ -7882,6 +8201,10 @@ export interface components {
|
|
|
7882
8201
|
* "name": "Collect Payments",
|
|
7883
8202
|
* "description": "Stripe payments collects outstanding revenue with Stripe customer's default payment method."
|
|
7884
8203
|
* }
|
|
8204
|
+
* ],
|
|
8205
|
+
* "installMethods": [
|
|
8206
|
+
* "with_oauth2",
|
|
8207
|
+
* "with_api_key"
|
|
7885
8208
|
* ]
|
|
7886
8209
|
* },
|
|
7887
8210
|
* "createdAt": "2024-01-01T01:01:01.001Z",
|
|
@@ -7947,12 +8270,43 @@ export interface components {
|
|
|
7947
8270
|
*/
|
|
7948
8271
|
type: 'stripe';
|
|
7949
8272
|
/** @description The Stripe account ID. */
|
|
7950
|
-
stripeAccountId: string;
|
|
8273
|
+
readonly stripeAccountId: string;
|
|
7951
8274
|
/** @description Livemode, true if the app is in production mode. */
|
|
7952
|
-
livemode: boolean;
|
|
8275
|
+
readonly livemode: boolean;
|
|
7953
8276
|
/** @description The masked API key.
|
|
7954
8277
|
* Only shows the first 8 and last 3 characters. */
|
|
7955
|
-
maskedAPIKey: string;
|
|
8278
|
+
readonly maskedAPIKey: string;
|
|
8279
|
+
};
|
|
8280
|
+
/** @description Resource update operation model. */
|
|
8281
|
+
StripeAppReplaceUpdate: {
|
|
8282
|
+
/**
|
|
8283
|
+
* Display name
|
|
8284
|
+
* @description Human-readable name for the resource. Between 1 and 256 characters.
|
|
8285
|
+
*/
|
|
8286
|
+
name: string;
|
|
8287
|
+
/**
|
|
8288
|
+
* Description
|
|
8289
|
+
* @description Optional description of the resource. Maximum 1024 characters.
|
|
8290
|
+
*/
|
|
8291
|
+
description?: string;
|
|
8292
|
+
/**
|
|
8293
|
+
* Metadata
|
|
8294
|
+
* @description Additional metadata for the resource.
|
|
8295
|
+
*/
|
|
8296
|
+
metadata?: components['schemas']['Metadata'] | null;
|
|
8297
|
+
/** @description Default for the app type
|
|
8298
|
+
* Only one app of each type can be default. */
|
|
8299
|
+
default: boolean;
|
|
8300
|
+
/**
|
|
8301
|
+
* @description The app's type is Stripe. (enum property replaced by openapi-typescript)
|
|
8302
|
+
* @enum {string}
|
|
8303
|
+
*/
|
|
8304
|
+
type: 'stripe';
|
|
8305
|
+
/**
|
|
8306
|
+
* Format: password
|
|
8307
|
+
* @description The Stripe API key.
|
|
8308
|
+
*/
|
|
8309
|
+
secretAPIKey?: string;
|
|
7956
8310
|
};
|
|
7957
8311
|
/**
|
|
7958
8312
|
* @description Stripe CheckoutSession.mode
|
|
@@ -7986,6 +8340,31 @@ export interface components {
|
|
|
7986
8340
|
/** @description The Stripe default payment method ID. */
|
|
7987
8341
|
stripeDefaultPaymentMethodId?: string;
|
|
7988
8342
|
};
|
|
8343
|
+
/**
|
|
8344
|
+
* @description Stripe Customer App Data.
|
|
8345
|
+
* @example {
|
|
8346
|
+
* "type": "stripe",
|
|
8347
|
+
* "stripeCustomerId": "cus_xxxxxxxxxxxxxx"
|
|
8348
|
+
* }
|
|
8349
|
+
*/
|
|
8350
|
+
StripeCustomerAppDataCreateOrUpdateItem: {
|
|
8351
|
+
/**
|
|
8352
|
+
* App ID
|
|
8353
|
+
* @description The app ID.
|
|
8354
|
+
* If not provided, it will use the global default for the app type.
|
|
8355
|
+
* @example 01G65Z755AFWAKHE12NY0CQ9FH
|
|
8356
|
+
*/
|
|
8357
|
+
id?: string;
|
|
8358
|
+
/**
|
|
8359
|
+
* @description The app name. (enum property replaced by openapi-typescript)
|
|
8360
|
+
* @enum {string}
|
|
8361
|
+
*/
|
|
8362
|
+
type: 'stripe';
|
|
8363
|
+
/** @description The Stripe customer ID. */
|
|
8364
|
+
stripeCustomerId: string;
|
|
8365
|
+
/** @description The Stripe default payment method ID. */
|
|
8366
|
+
stripeDefaultPaymentMethodId?: string;
|
|
8367
|
+
};
|
|
7989
8368
|
/** @description The tax config for Stripe. */
|
|
7990
8369
|
StripeTaxConfig: {
|
|
7991
8370
|
/**
|
|
@@ -8335,7 +8714,7 @@ export interface components {
|
|
|
8335
8714
|
*/
|
|
8336
8715
|
readonly rateCards: components['schemas']['SubscriptionAddonRateCard'][];
|
|
8337
8716
|
};
|
|
8338
|
-
/** @description
|
|
8717
|
+
/** @description A subscription add-on create body. */
|
|
8339
8718
|
SubscriptionAddonCreate: {
|
|
8340
8719
|
/**
|
|
8341
8720
|
* Display name
|
|
@@ -8364,34 +8743,6 @@ export interface components {
|
|
|
8364
8743
|
* @example 2023-01-01T01:01:01.001Z
|
|
8365
8744
|
*/
|
|
8366
8745
|
activeTo?: Date;
|
|
8367
|
-
/**
|
|
8368
|
-
* Addon
|
|
8369
|
-
* @description Partially populated add-on properties.
|
|
8370
|
-
*/
|
|
8371
|
-
addon: {
|
|
8372
|
-
/**
|
|
8373
|
-
* ID
|
|
8374
|
-
* @description The ID of the add-on.
|
|
8375
|
-
* @example 01G65Z755AFWAKHE12NY0CQ9FH
|
|
8376
|
-
*/
|
|
8377
|
-
id: string;
|
|
8378
|
-
/**
|
|
8379
|
-
* Key
|
|
8380
|
-
* @description A semi-unique identifier for the resource.
|
|
8381
|
-
*/
|
|
8382
|
-
readonly key: string;
|
|
8383
|
-
/**
|
|
8384
|
-
* Version
|
|
8385
|
-
* @description The version of the Add-on which templates this instance.
|
|
8386
|
-
* @default 1
|
|
8387
|
-
*/
|
|
8388
|
-
readonly version: number;
|
|
8389
|
-
/**
|
|
8390
|
-
* InstanceType
|
|
8391
|
-
* @description The instance type of the add-on.
|
|
8392
|
-
*/
|
|
8393
|
-
readonly instanceType: components['schemas']['AddonInstanceType'];
|
|
8394
|
-
};
|
|
8395
8746
|
/**
|
|
8396
8747
|
* Quantity
|
|
8397
8748
|
* @description The quantity of the add-on. Always 1 for single instance add-ons.
|
|
@@ -8403,6 +8754,17 @@ export interface components {
|
|
|
8403
8754
|
* @description The timing of the operation. After the create or update, a new entry will be created in the timeline.
|
|
8404
8755
|
*/
|
|
8405
8756
|
timing: components['schemas']['SubscriptionTiming'];
|
|
8757
|
+
/**
|
|
8758
|
+
* Addon
|
|
8759
|
+
* @description The add-on to create.
|
|
8760
|
+
*/
|
|
8761
|
+
addon: {
|
|
8762
|
+
/**
|
|
8763
|
+
* @description The ID of the add-on.
|
|
8764
|
+
* @example 01G65Z755AFWAKHE12NY0CQ9FH
|
|
8765
|
+
*/
|
|
8766
|
+
id: string;
|
|
8767
|
+
};
|
|
8406
8768
|
};
|
|
8407
8769
|
/** @description A rate card for a subscription add-on. */
|
|
8408
8770
|
SubscriptionAddonRateCard: {
|
|
@@ -8467,11 +8829,6 @@ export interface components {
|
|
|
8467
8829
|
* @example 2023-01-01T01:01:01.001Z
|
|
8468
8830
|
*/
|
|
8469
8831
|
activeTo?: Date;
|
|
8470
|
-
/**
|
|
8471
|
-
* Addon
|
|
8472
|
-
* @description Partially populated add-on properties.
|
|
8473
|
-
*/
|
|
8474
|
-
addon?: Record<string, never>;
|
|
8475
8832
|
/**
|
|
8476
8833
|
* Quantity
|
|
8477
8834
|
* @description The quantity of the add-on. Always 1 for single instance add-ons.
|
|
@@ -8877,6 +9234,11 @@ export interface components {
|
|
|
8877
9234
|
* @description Stripe tax config.
|
|
8878
9235
|
*/
|
|
8879
9236
|
stripe?: components['schemas']['StripeTaxConfig'];
|
|
9237
|
+
/**
|
|
9238
|
+
* Custom invoicing tax config
|
|
9239
|
+
* @description Custom invoicing tax config.
|
|
9240
|
+
*/
|
|
9241
|
+
customInvoicing?: components['schemas']['CustomInvoicingTaxConfig'];
|
|
8880
9242
|
};
|
|
8881
9243
|
/**
|
|
8882
9244
|
* @description The mode of the tiered price.
|
|
@@ -9209,6 +9571,8 @@ export interface components {
|
|
|
9209
9571
|
/** @description The type of the app to install. */
|
|
9210
9572
|
'MarketplaceApiKeyInstallRequest.type': components['schemas']['AppType'];
|
|
9211
9573
|
/** @description The type of the app to install. */
|
|
9574
|
+
'MarketplaceInstallRequest.type': components['schemas']['AppType'];
|
|
9575
|
+
/** @description The type of the app to install. */
|
|
9212
9576
|
'MarketplaceOAuth2InstallAuthorizeRequest.type': components['schemas']['AppType'];
|
|
9213
9577
|
/** @description The order direction. */
|
|
9214
9578
|
'MeterOrderByOrdering.order': components['schemas']['SortOrder'];
|
|
@@ -9293,9 +9657,17 @@ export interface components {
|
|
|
9293
9657
|
* Default is 100. */
|
|
9294
9658
|
'Pagination.pageSize': number;
|
|
9295
9659
|
/** @description The order direction. */
|
|
9660
|
+
'PlanAddonOrderByOrdering.order': components['schemas']['SortOrder'];
|
|
9661
|
+
/** @description The order by field. */
|
|
9662
|
+
'PlanAddonOrderByOrdering.orderBy': components['schemas']['PlanAddonOrderBy'];
|
|
9663
|
+
/** @description The order direction. */
|
|
9296
9664
|
'PlanOrderByOrdering.order': components['schemas']['SortOrder'];
|
|
9297
9665
|
/** @description The order by field. */
|
|
9298
9666
|
'PlanOrderByOrdering.orderBy': components['schemas']['PlanOrderBy'];
|
|
9667
|
+
/** @description What parts of the customer output to expand */
|
|
9668
|
+
queryCustomerGet: components['schemas']['CustomerExpand'][];
|
|
9669
|
+
/** @description What parts of the list output to expand in listings */
|
|
9670
|
+
'queryCustomerList.expand': components['schemas']['CustomerExpand'][];
|
|
9299
9671
|
/** @description Include deleted customers. */
|
|
9300
9672
|
'queryCustomerList.includeDeleted': boolean;
|
|
9301
9673
|
/** @description Filter customers by key.
|
|
@@ -9332,11 +9704,11 @@ export type Address = components['schemas']['Address'];
|
|
|
9332
9704
|
export type Alignment = components['schemas']['Alignment'];
|
|
9333
9705
|
export type Annotations = components['schemas']['Annotations'];
|
|
9334
9706
|
export type App = components['schemas']['App'];
|
|
9335
|
-
export type AppBaseReplaceUpdate = components['schemas']['AppBaseReplaceUpdate'];
|
|
9336
9707
|
export type AppCapability = components['schemas']['AppCapability'];
|
|
9337
9708
|
export type AppCapabilityType = components['schemas']['AppCapabilityType'];
|
|
9338
9709
|
export type AppPaginatedResponse = components['schemas']['AppPaginatedResponse'];
|
|
9339
9710
|
export type AppReference = components['schemas']['AppReference'];
|
|
9711
|
+
export type AppReplaceUpdate = components['schemas']['AppReplaceUpdate'];
|
|
9340
9712
|
export type AppStatus = components['schemas']['AppStatus'];
|
|
9341
9713
|
export type AppType = components['schemas']['AppType'];
|
|
9342
9714
|
export type BadRequestProblemResponse = components['schemas']['BadRequestProblemResponse'];
|
|
@@ -9396,14 +9768,29 @@ export type CreateStripeCheckoutSessionResult = components['schemas']['CreateStr
|
|
|
9396
9768
|
export type CreditNoteOriginalInvoiceRef = components['schemas']['CreditNoteOriginalInvoiceRef'];
|
|
9397
9769
|
export type Currency = components['schemas']['Currency'];
|
|
9398
9770
|
export type CurrencyCode = components['schemas']['CurrencyCode'];
|
|
9771
|
+
export type CustomInvoicingApp = components['schemas']['CustomInvoicingApp'];
|
|
9772
|
+
export type CustomInvoicingAppReplaceUpdate = components['schemas']['CustomInvoicingAppReplaceUpdate'];
|
|
9773
|
+
export type CustomInvoicingCustomerAppData = components['schemas']['CustomInvoicingCustomerAppData'];
|
|
9774
|
+
export type CustomInvoicingDraftSynchronizedRequest = components['schemas']['CustomInvoicingDraftSynchronizedRequest'];
|
|
9775
|
+
export type CustomInvoicingFinalizedInvoicingRequest = components['schemas']['CustomInvoicingFinalizedInvoicingRequest'];
|
|
9776
|
+
export type CustomInvoicingFinalizedPaymentRequest = components['schemas']['CustomInvoicingFinalizedPaymentRequest'];
|
|
9777
|
+
export type CustomInvoicingFinalizedRequest = components['schemas']['CustomInvoicingFinalizedRequest'];
|
|
9778
|
+
export type CustomInvoicingLineDiscountExternalIdMapping = components['schemas']['CustomInvoicingLineDiscountExternalIdMapping'];
|
|
9779
|
+
export type CustomInvoicingLineExternalIdMapping = components['schemas']['CustomInvoicingLineExternalIdMapping'];
|
|
9780
|
+
export type CustomInvoicingPaymentTrigger = components['schemas']['CustomInvoicingPaymentTrigger'];
|
|
9781
|
+
export type CustomInvoicingSyncResult = components['schemas']['CustomInvoicingSyncResult'];
|
|
9782
|
+
export type CustomInvoicingTaxConfig = components['schemas']['CustomInvoicingTaxConfig'];
|
|
9783
|
+
export type CustomInvoicingUpdatePaymentStatusRequest = components['schemas']['CustomInvoicingUpdatePaymentStatusRequest'];
|
|
9399
9784
|
export type CustomPlanInput = components['schemas']['CustomPlanInput'];
|
|
9400
9785
|
export type CustomSubscriptionChange = components['schemas']['CustomSubscriptionChange'];
|
|
9401
9786
|
export type CustomSubscriptionCreate = components['schemas']['CustomSubscriptionCreate'];
|
|
9402
9787
|
export type Customer = components['schemas']['Customer'];
|
|
9403
9788
|
export type CustomerAccess = components['schemas']['CustomerAccess'];
|
|
9404
9789
|
export type CustomerAppData = components['schemas']['CustomerAppData'];
|
|
9790
|
+
export type CustomerAppDataCreateOrUpdateItem = components['schemas']['CustomerAppDataCreateOrUpdateItem'];
|
|
9405
9791
|
export type CustomerAppDataPaginatedResponse = components['schemas']['CustomerAppDataPaginatedResponse'];
|
|
9406
9792
|
export type CustomerCreate = components['schemas']['CustomerCreate'];
|
|
9793
|
+
export type CustomerExpand = components['schemas']['CustomerExpand'];
|
|
9407
9794
|
export type CustomerId = components['schemas']['CustomerId'];
|
|
9408
9795
|
export type CustomerKey = components['schemas']['CustomerKey'];
|
|
9409
9796
|
export type CustomerOrderBy = components['schemas']['CustomerOrderBy'];
|
|
@@ -9460,6 +9847,7 @@ export type IdResource = components['schemas']['IDResource'];
|
|
|
9460
9847
|
export type IngestEventsBody = components['schemas']['IngestEventsBody'];
|
|
9461
9848
|
export type IngestedEvent = components['schemas']['IngestedEvent'];
|
|
9462
9849
|
export type IngestedEventCursorPaginatedResponse = components['schemas']['IngestedEventCursorPaginatedResponse'];
|
|
9850
|
+
export type InstallMethod = components['schemas']['InstallMethod'];
|
|
9463
9851
|
export type InternalServerErrorProblemResponse = components['schemas']['InternalServerErrorProblemResponse'];
|
|
9464
9852
|
export type Invoice = components['schemas']['Invoice'];
|
|
9465
9853
|
export type InvoiceAppExternalIds = components['schemas']['InvoiceAppExternalIds'];
|
|
@@ -9566,6 +9954,8 @@ export type Period = components['schemas']['Period'];
|
|
|
9566
9954
|
export type Plan = components['schemas']['Plan'];
|
|
9567
9955
|
export type PlanAddon = components['schemas']['PlanAddon'];
|
|
9568
9956
|
export type PlanAddonCreate = components['schemas']['PlanAddonCreate'];
|
|
9957
|
+
export type PlanAddonOrderBy = components['schemas']['PlanAddonOrderBy'];
|
|
9958
|
+
export type PlanAddonPaginatedResponse = components['schemas']['PlanAddonPaginatedResponse'];
|
|
9569
9959
|
export type PlanAddonReplaceUpdate = components['schemas']['PlanAddonReplaceUpdate'];
|
|
9570
9960
|
export type PlanCreate = components['schemas']['PlanCreate'];
|
|
9571
9961
|
export type PlanOrderBy = components['schemas']['PlanOrderBy'];
|
|
@@ -9597,13 +9987,16 @@ export type RecurringPeriodIntervalEnum = components['schemas']['RecurringPeriod
|
|
|
9597
9987
|
export type RemovePhaseShifting = components['schemas']['RemovePhaseShifting'];
|
|
9598
9988
|
export type ResetEntitlementUsageInput = components['schemas']['ResetEntitlementUsageInput'];
|
|
9599
9989
|
export type SandboxApp = components['schemas']['SandboxApp'];
|
|
9990
|
+
export type SandboxAppReplaceUpdate = components['schemas']['SandboxAppReplaceUpdate'];
|
|
9600
9991
|
export type SandboxCustomerAppData = components['schemas']['SandboxCustomerAppData'];
|
|
9601
9992
|
export type ServiceUnavailableProblemResponse = components['schemas']['ServiceUnavailableProblemResponse'];
|
|
9602
9993
|
export type SortOrder = components['schemas']['SortOrder'];
|
|
9603
9994
|
export type StripeApiKeyInput = components['schemas']['StripeAPIKeyInput'];
|
|
9604
9995
|
export type StripeApp = components['schemas']['StripeApp'];
|
|
9996
|
+
export type StripeAppReplaceUpdate = components['schemas']['StripeAppReplaceUpdate'];
|
|
9605
9997
|
export type StripeCheckoutSessionMode = components['schemas']['StripeCheckoutSessionMode'];
|
|
9606
9998
|
export type StripeCustomerAppData = components['schemas']['StripeCustomerAppData'];
|
|
9999
|
+
export type StripeCustomerAppDataCreateOrUpdateItem = components['schemas']['StripeCustomerAppDataCreateOrUpdateItem'];
|
|
9607
10000
|
export type StripeTaxConfig = components['schemas']['StripeTaxConfig'];
|
|
9608
10001
|
export type StripeWebhookEvent = components['schemas']['StripeWebhookEvent'];
|
|
9609
10002
|
export type StripeWebhookResponse = components['schemas']['StripeWebhookResponse'];
|
|
@@ -9687,6 +10080,7 @@ export type ParameterInvoiceOrderByOrderingOrderBy = components['parameters']['I
|
|
|
9687
10080
|
export type ParameterLimitOffsetLimit = components['parameters']['LimitOffset.limit'];
|
|
9688
10081
|
export type ParameterLimitOffsetOffset = components['parameters']['LimitOffset.offset'];
|
|
9689
10082
|
export type ParameterMarketplaceApiKeyInstallRequestType = components['parameters']['MarketplaceApiKeyInstallRequest.type'];
|
|
10083
|
+
export type ParameterMarketplaceInstallRequestType = components['parameters']['MarketplaceInstallRequest.type'];
|
|
9690
10084
|
export type ParameterMarketplaceOAuth2InstallAuthorizeRequestType = components['parameters']['MarketplaceOAuth2InstallAuthorizeRequest.type'];
|
|
9691
10085
|
export type ParameterMeterOrderByOrderingOrder = components['parameters']['MeterOrderByOrdering.order'];
|
|
9692
10086
|
export type ParameterMeterOrderByOrderingOrderBy = components['parameters']['MeterOrderByOrdering.orderBy'];
|
|
@@ -9711,8 +10105,12 @@ export type ParameterOAuth2AuthorizationCodeGrantSuccessParamsCode = components[
|
|
|
9711
10105
|
export type ParameterOAuth2AuthorizationCodeGrantSuccessParamsState = components['parameters']['OAuth2AuthorizationCodeGrantSuccessParams.state'];
|
|
9712
10106
|
export type ParameterPaginationPage = components['parameters']['Pagination.page'];
|
|
9713
10107
|
export type ParameterPaginationPageSize = components['parameters']['Pagination.pageSize'];
|
|
10108
|
+
export type ParameterPlanAddonOrderByOrderingOrder = components['parameters']['PlanAddonOrderByOrdering.order'];
|
|
10109
|
+
export type ParameterPlanAddonOrderByOrderingOrderBy = components['parameters']['PlanAddonOrderByOrdering.orderBy'];
|
|
9714
10110
|
export type ParameterPlanOrderByOrderingOrder = components['parameters']['PlanOrderByOrdering.order'];
|
|
9715
10111
|
export type ParameterPlanOrderByOrderingOrderBy = components['parameters']['PlanOrderByOrdering.orderBy'];
|
|
10112
|
+
export type ParameterQueryCustomerGet = components['parameters']['queryCustomerGet'];
|
|
10113
|
+
export type ParameterQueryCustomerListExpand = components['parameters']['queryCustomerList.expand'];
|
|
9716
10114
|
export type ParameterQueryCustomerListIncludeDeleted = components['parameters']['queryCustomerList.includeDeleted'];
|
|
9717
10115
|
export type ParameterQueryCustomerListKey = components['parameters']['queryCustomerList.key'];
|
|
9718
10116
|
export type ParameterQueryCustomerListName = components['parameters']['queryCustomerList.name'];
|
|
@@ -9877,16 +10275,305 @@ export interface operations {
|
|
|
9877
10275
|
[name: string]: unknown;
|
|
9878
10276
|
};
|
|
9879
10277
|
content: {
|
|
9880
|
-
'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
|
|
10278
|
+
'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
|
|
10279
|
+
};
|
|
10280
|
+
};
|
|
10281
|
+
/** @description The server understood the request but refuses to authorize it. */
|
|
10282
|
+
403: {
|
|
10283
|
+
headers: {
|
|
10284
|
+
[name: string]: unknown;
|
|
10285
|
+
};
|
|
10286
|
+
content: {
|
|
10287
|
+
'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
|
|
10288
|
+
};
|
|
10289
|
+
};
|
|
10290
|
+
/** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
|
|
10291
|
+
412: {
|
|
10292
|
+
headers: {
|
|
10293
|
+
[name: string]: unknown;
|
|
10294
|
+
};
|
|
10295
|
+
content: {
|
|
10296
|
+
'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
|
|
10297
|
+
};
|
|
10298
|
+
};
|
|
10299
|
+
/** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
|
|
10300
|
+
500: {
|
|
10301
|
+
headers: {
|
|
10302
|
+
[name: string]: unknown;
|
|
10303
|
+
};
|
|
10304
|
+
content: {
|
|
10305
|
+
'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
|
|
10306
|
+
};
|
|
10307
|
+
};
|
|
10308
|
+
/** @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. */
|
|
10309
|
+
503: {
|
|
10310
|
+
headers: {
|
|
10311
|
+
[name: string]: unknown;
|
|
10312
|
+
};
|
|
10313
|
+
content: {
|
|
10314
|
+
'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
|
|
10315
|
+
};
|
|
10316
|
+
};
|
|
10317
|
+
/** @description An unexpected error response. */
|
|
10318
|
+
default: {
|
|
10319
|
+
headers: {
|
|
10320
|
+
[name: string]: unknown;
|
|
10321
|
+
};
|
|
10322
|
+
content: {
|
|
10323
|
+
'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
|
|
10324
|
+
};
|
|
10325
|
+
};
|
|
10326
|
+
};
|
|
10327
|
+
};
|
|
10328
|
+
getAddon: {
|
|
10329
|
+
parameters: {
|
|
10330
|
+
query?: {
|
|
10331
|
+
/** @description Include latest version of the add-on instead of the version in active state.
|
|
10332
|
+
*
|
|
10333
|
+
* Usage: `?includeLatest=true` */
|
|
10334
|
+
includeLatest?: boolean;
|
|
10335
|
+
};
|
|
10336
|
+
header?: never;
|
|
10337
|
+
path: {
|
|
10338
|
+
addonId: string;
|
|
10339
|
+
};
|
|
10340
|
+
cookie?: never;
|
|
10341
|
+
};
|
|
10342
|
+
requestBody?: never;
|
|
10343
|
+
responses: {
|
|
10344
|
+
/** @description The request has succeeded. */
|
|
10345
|
+
200: {
|
|
10346
|
+
headers: {
|
|
10347
|
+
[name: string]: unknown;
|
|
10348
|
+
};
|
|
10349
|
+
content: {
|
|
10350
|
+
'application/json': components['schemas']['Addon'];
|
|
10351
|
+
};
|
|
10352
|
+
};
|
|
10353
|
+
/** @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). */
|
|
10354
|
+
400: {
|
|
10355
|
+
headers: {
|
|
10356
|
+
[name: string]: unknown;
|
|
10357
|
+
};
|
|
10358
|
+
content: {
|
|
10359
|
+
'application/problem+json': components['schemas']['BadRequestProblemResponse'];
|
|
10360
|
+
};
|
|
10361
|
+
};
|
|
10362
|
+
/** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
|
|
10363
|
+
401: {
|
|
10364
|
+
headers: {
|
|
10365
|
+
[name: string]: unknown;
|
|
10366
|
+
};
|
|
10367
|
+
content: {
|
|
10368
|
+
'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
|
|
10369
|
+
};
|
|
10370
|
+
};
|
|
10371
|
+
/** @description The server understood the request but refuses to authorize it. */
|
|
10372
|
+
403: {
|
|
10373
|
+
headers: {
|
|
10374
|
+
[name: string]: unknown;
|
|
10375
|
+
};
|
|
10376
|
+
content: {
|
|
10377
|
+
'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
|
|
10378
|
+
};
|
|
10379
|
+
};
|
|
10380
|
+
/** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
|
|
10381
|
+
404: {
|
|
10382
|
+
headers: {
|
|
10383
|
+
[name: string]: unknown;
|
|
10384
|
+
};
|
|
10385
|
+
content: {
|
|
10386
|
+
'application/problem+json': components['schemas']['NotFoundProblemResponse'];
|
|
10387
|
+
};
|
|
10388
|
+
};
|
|
10389
|
+
/** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
|
|
10390
|
+
412: {
|
|
10391
|
+
headers: {
|
|
10392
|
+
[name: string]: unknown;
|
|
10393
|
+
};
|
|
10394
|
+
content: {
|
|
10395
|
+
'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
|
|
10396
|
+
};
|
|
10397
|
+
};
|
|
10398
|
+
/** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
|
|
10399
|
+
500: {
|
|
10400
|
+
headers: {
|
|
10401
|
+
[name: string]: unknown;
|
|
10402
|
+
};
|
|
10403
|
+
content: {
|
|
10404
|
+
'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
|
|
10405
|
+
};
|
|
10406
|
+
};
|
|
10407
|
+
/** @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. */
|
|
10408
|
+
503: {
|
|
10409
|
+
headers: {
|
|
10410
|
+
[name: string]: unknown;
|
|
10411
|
+
};
|
|
10412
|
+
content: {
|
|
10413
|
+
'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
|
|
10414
|
+
};
|
|
10415
|
+
};
|
|
10416
|
+
/** @description An unexpected error response. */
|
|
10417
|
+
default: {
|
|
10418
|
+
headers: {
|
|
10419
|
+
[name: string]: unknown;
|
|
10420
|
+
};
|
|
10421
|
+
content: {
|
|
10422
|
+
'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
|
|
10423
|
+
};
|
|
10424
|
+
};
|
|
10425
|
+
};
|
|
10426
|
+
};
|
|
10427
|
+
updateAddon: {
|
|
10428
|
+
parameters: {
|
|
10429
|
+
query?: never;
|
|
10430
|
+
header?: never;
|
|
10431
|
+
path: {
|
|
10432
|
+
addonId: string;
|
|
10433
|
+
};
|
|
10434
|
+
cookie?: never;
|
|
10435
|
+
};
|
|
10436
|
+
requestBody: {
|
|
10437
|
+
content: {
|
|
10438
|
+
'application/json': components['schemas']['AddonReplaceUpdate'];
|
|
10439
|
+
};
|
|
10440
|
+
};
|
|
10441
|
+
responses: {
|
|
10442
|
+
/** @description The request has succeeded. */
|
|
10443
|
+
200: {
|
|
10444
|
+
headers: {
|
|
10445
|
+
[name: string]: unknown;
|
|
10446
|
+
};
|
|
10447
|
+
content: {
|
|
10448
|
+
'application/json': components['schemas']['Addon'];
|
|
10449
|
+
};
|
|
10450
|
+
};
|
|
10451
|
+
/** @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). */
|
|
10452
|
+
400: {
|
|
10453
|
+
headers: {
|
|
10454
|
+
[name: string]: unknown;
|
|
10455
|
+
};
|
|
10456
|
+
content: {
|
|
10457
|
+
'application/problem+json': components['schemas']['BadRequestProblemResponse'];
|
|
10458
|
+
};
|
|
10459
|
+
};
|
|
10460
|
+
/** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
|
|
10461
|
+
401: {
|
|
10462
|
+
headers: {
|
|
10463
|
+
[name: string]: unknown;
|
|
10464
|
+
};
|
|
10465
|
+
content: {
|
|
10466
|
+
'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
|
|
10467
|
+
};
|
|
10468
|
+
};
|
|
10469
|
+
/** @description The server understood the request but refuses to authorize it. */
|
|
10470
|
+
403: {
|
|
10471
|
+
headers: {
|
|
10472
|
+
[name: string]: unknown;
|
|
10473
|
+
};
|
|
10474
|
+
content: {
|
|
10475
|
+
'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
|
|
10476
|
+
};
|
|
10477
|
+
};
|
|
10478
|
+
/** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
|
|
10479
|
+
404: {
|
|
10480
|
+
headers: {
|
|
10481
|
+
[name: string]: unknown;
|
|
10482
|
+
};
|
|
10483
|
+
content: {
|
|
10484
|
+
'application/problem+json': components['schemas']['NotFoundProblemResponse'];
|
|
10485
|
+
};
|
|
10486
|
+
};
|
|
10487
|
+
/** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
|
|
10488
|
+
412: {
|
|
10489
|
+
headers: {
|
|
10490
|
+
[name: string]: unknown;
|
|
10491
|
+
};
|
|
10492
|
+
content: {
|
|
10493
|
+
'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
|
|
10494
|
+
};
|
|
10495
|
+
};
|
|
10496
|
+
/** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
|
|
10497
|
+
500: {
|
|
10498
|
+
headers: {
|
|
10499
|
+
[name: string]: unknown;
|
|
10500
|
+
};
|
|
10501
|
+
content: {
|
|
10502
|
+
'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
|
|
10503
|
+
};
|
|
10504
|
+
};
|
|
10505
|
+
/** @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. */
|
|
10506
|
+
503: {
|
|
10507
|
+
headers: {
|
|
10508
|
+
[name: string]: unknown;
|
|
10509
|
+
};
|
|
10510
|
+
content: {
|
|
10511
|
+
'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
|
|
10512
|
+
};
|
|
10513
|
+
};
|
|
10514
|
+
/** @description An unexpected error response. */
|
|
10515
|
+
default: {
|
|
10516
|
+
headers: {
|
|
10517
|
+
[name: string]: unknown;
|
|
10518
|
+
};
|
|
10519
|
+
content: {
|
|
10520
|
+
'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
|
|
10521
|
+
};
|
|
10522
|
+
};
|
|
10523
|
+
};
|
|
10524
|
+
};
|
|
10525
|
+
deleteAddon: {
|
|
10526
|
+
parameters: {
|
|
10527
|
+
query?: never;
|
|
10528
|
+
header?: never;
|
|
10529
|
+
path: {
|
|
10530
|
+
addonId: string;
|
|
10531
|
+
};
|
|
10532
|
+
cookie?: never;
|
|
10533
|
+
};
|
|
10534
|
+
requestBody?: never;
|
|
10535
|
+
responses: {
|
|
10536
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
10537
|
+
204: {
|
|
10538
|
+
headers: {
|
|
10539
|
+
[name: string]: unknown;
|
|
10540
|
+
};
|
|
10541
|
+
content?: never;
|
|
10542
|
+
};
|
|
10543
|
+
/** @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). */
|
|
10544
|
+
400: {
|
|
10545
|
+
headers: {
|
|
10546
|
+
[name: string]: unknown;
|
|
10547
|
+
};
|
|
10548
|
+
content: {
|
|
10549
|
+
'application/problem+json': components['schemas']['BadRequestProblemResponse'];
|
|
10550
|
+
};
|
|
10551
|
+
};
|
|
10552
|
+
/** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
|
|
10553
|
+
401: {
|
|
10554
|
+
headers: {
|
|
10555
|
+
[name: string]: unknown;
|
|
10556
|
+
};
|
|
10557
|
+
content: {
|
|
10558
|
+
'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
|
|
10559
|
+
};
|
|
10560
|
+
};
|
|
10561
|
+
/** @description The server understood the request but refuses to authorize it. */
|
|
10562
|
+
403: {
|
|
10563
|
+
headers: {
|
|
10564
|
+
[name: string]: unknown;
|
|
10565
|
+
};
|
|
10566
|
+
content: {
|
|
10567
|
+
'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
|
|
9881
10568
|
};
|
|
9882
10569
|
};
|
|
9883
|
-
/** @description The server
|
|
9884
|
-
|
|
10570
|
+
/** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
|
|
10571
|
+
404: {
|
|
9885
10572
|
headers: {
|
|
9886
10573
|
[name: string]: unknown;
|
|
9887
10574
|
};
|
|
9888
10575
|
content: {
|
|
9889
|
-
'application/problem+json': components['schemas']['
|
|
10576
|
+
'application/problem+json': components['schemas']['NotFoundProblemResponse'];
|
|
9890
10577
|
};
|
|
9891
10578
|
};
|
|
9892
10579
|
/** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
|
|
@@ -9927,14 +10614,9 @@ export interface operations {
|
|
|
9927
10614
|
};
|
|
9928
10615
|
};
|
|
9929
10616
|
};
|
|
9930
|
-
|
|
10617
|
+
archiveAddon: {
|
|
9931
10618
|
parameters: {
|
|
9932
|
-
query?:
|
|
9933
|
-
/** @description Include latest version of the add-on instead of the version in active state.
|
|
9934
|
-
*
|
|
9935
|
-
* Usage: `?includeLatest=true` */
|
|
9936
|
-
includeLatest?: boolean;
|
|
9937
|
-
};
|
|
10619
|
+
query?: never;
|
|
9938
10620
|
header?: never;
|
|
9939
10621
|
path: {
|
|
9940
10622
|
addonId: string;
|
|
@@ -10026,7 +10708,7 @@ export interface operations {
|
|
|
10026
10708
|
};
|
|
10027
10709
|
};
|
|
10028
10710
|
};
|
|
10029
|
-
|
|
10711
|
+
publishAddon: {
|
|
10030
10712
|
parameters: {
|
|
10031
10713
|
query?: never;
|
|
10032
10714
|
header?: never;
|
|
@@ -10035,11 +10717,7 @@ export interface operations {
|
|
|
10035
10717
|
};
|
|
10036
10718
|
cookie?: never;
|
|
10037
10719
|
};
|
|
10038
|
-
requestBody
|
|
10039
|
-
content: {
|
|
10040
|
-
'application/json': components['schemas']['AddonReplaceUpdate'];
|
|
10041
|
-
};
|
|
10042
|
-
};
|
|
10720
|
+
requestBody?: never;
|
|
10043
10721
|
responses: {
|
|
10044
10722
|
/** @description The request has succeeded. */
|
|
10045
10723
|
200: {
|
|
@@ -10124,23 +10802,32 @@ export interface operations {
|
|
|
10124
10802
|
};
|
|
10125
10803
|
};
|
|
10126
10804
|
};
|
|
10127
|
-
|
|
10805
|
+
listApps: {
|
|
10128
10806
|
parameters: {
|
|
10129
|
-
query?:
|
|
10130
|
-
|
|
10131
|
-
|
|
10132
|
-
|
|
10807
|
+
query?: {
|
|
10808
|
+
/** @description Page index.
|
|
10809
|
+
*
|
|
10810
|
+
* Default is 1. */
|
|
10811
|
+
page?: components['parameters']['Pagination.page'];
|
|
10812
|
+
/** @description The maximum number of items per page.
|
|
10813
|
+
*
|
|
10814
|
+
* Default is 100. */
|
|
10815
|
+
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
10133
10816
|
};
|
|
10817
|
+
header?: never;
|
|
10818
|
+
path?: never;
|
|
10134
10819
|
cookie?: never;
|
|
10135
10820
|
};
|
|
10136
10821
|
requestBody?: never;
|
|
10137
10822
|
responses: {
|
|
10138
|
-
/** @description
|
|
10139
|
-
|
|
10823
|
+
/** @description The request has succeeded. */
|
|
10824
|
+
200: {
|
|
10140
10825
|
headers: {
|
|
10141
10826
|
[name: string]: unknown;
|
|
10142
10827
|
};
|
|
10143
|
-
content
|
|
10828
|
+
content: {
|
|
10829
|
+
'application/json': components['schemas']['AppPaginatedResponse'];
|
|
10830
|
+
};
|
|
10144
10831
|
};
|
|
10145
10832
|
/** @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). */
|
|
10146
10833
|
400: {
|
|
@@ -10169,15 +10856,6 @@ export interface operations {
|
|
|
10169
10856
|
'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
|
|
10170
10857
|
};
|
|
10171
10858
|
};
|
|
10172
|
-
/** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
|
|
10173
|
-
404: {
|
|
10174
|
-
headers: {
|
|
10175
|
-
[name: string]: unknown;
|
|
10176
|
-
};
|
|
10177
|
-
content: {
|
|
10178
|
-
'application/problem+json': components['schemas']['NotFoundProblemResponse'];
|
|
10179
|
-
};
|
|
10180
|
-
};
|
|
10181
10859
|
/** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
|
|
10182
10860
|
412: {
|
|
10183
10861
|
headers: {
|
|
@@ -10216,25 +10894,27 @@ export interface operations {
|
|
|
10216
10894
|
};
|
|
10217
10895
|
};
|
|
10218
10896
|
};
|
|
10219
|
-
|
|
10897
|
+
appCustomInvoicingDraftSynchronized: {
|
|
10220
10898
|
parameters: {
|
|
10221
10899
|
query?: never;
|
|
10222
10900
|
header?: never;
|
|
10223
10901
|
path: {
|
|
10224
|
-
|
|
10902
|
+
invoiceId: string;
|
|
10225
10903
|
};
|
|
10226
10904
|
cookie?: never;
|
|
10227
10905
|
};
|
|
10228
|
-
requestBody
|
|
10906
|
+
requestBody: {
|
|
10907
|
+
content: {
|
|
10908
|
+
'application/json': components['schemas']['CustomInvoicingDraftSynchronizedRequest'];
|
|
10909
|
+
};
|
|
10910
|
+
};
|
|
10229
10911
|
responses: {
|
|
10230
|
-
/** @description
|
|
10231
|
-
|
|
10912
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
10913
|
+
204: {
|
|
10232
10914
|
headers: {
|
|
10233
10915
|
[name: string]: unknown;
|
|
10234
10916
|
};
|
|
10235
|
-
content
|
|
10236
|
-
'application/json': components['schemas']['Addon'];
|
|
10237
|
-
};
|
|
10917
|
+
content?: never;
|
|
10238
10918
|
};
|
|
10239
10919
|
/** @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). */
|
|
10240
10920
|
400: {
|
|
@@ -10263,15 +10943,6 @@ export interface operations {
|
|
|
10263
10943
|
'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
|
|
10264
10944
|
};
|
|
10265
10945
|
};
|
|
10266
|
-
/** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
|
|
10267
|
-
404: {
|
|
10268
|
-
headers: {
|
|
10269
|
-
[name: string]: unknown;
|
|
10270
|
-
};
|
|
10271
|
-
content: {
|
|
10272
|
-
'application/problem+json': components['schemas']['NotFoundProblemResponse'];
|
|
10273
|
-
};
|
|
10274
|
-
};
|
|
10275
10946
|
/** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
|
|
10276
10947
|
412: {
|
|
10277
10948
|
headers: {
|
|
@@ -10310,25 +10981,27 @@ export interface operations {
|
|
|
10310
10981
|
};
|
|
10311
10982
|
};
|
|
10312
10983
|
};
|
|
10313
|
-
|
|
10984
|
+
appCustomInvoicingIssuingSynchronized: {
|
|
10314
10985
|
parameters: {
|
|
10315
10986
|
query?: never;
|
|
10316
10987
|
header?: never;
|
|
10317
10988
|
path: {
|
|
10318
|
-
|
|
10989
|
+
invoiceId: string;
|
|
10319
10990
|
};
|
|
10320
10991
|
cookie?: never;
|
|
10321
10992
|
};
|
|
10322
|
-
requestBody
|
|
10993
|
+
requestBody: {
|
|
10994
|
+
content: {
|
|
10995
|
+
'application/json': components['schemas']['CustomInvoicingFinalizedRequest'];
|
|
10996
|
+
};
|
|
10997
|
+
};
|
|
10323
10998
|
responses: {
|
|
10324
|
-
/** @description
|
|
10325
|
-
|
|
10999
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
11000
|
+
204: {
|
|
10326
11001
|
headers: {
|
|
10327
11002
|
[name: string]: unknown;
|
|
10328
11003
|
};
|
|
10329
|
-
content
|
|
10330
|
-
'application/json': components['schemas']['Addon'];
|
|
10331
|
-
};
|
|
11004
|
+
content?: never;
|
|
10332
11005
|
};
|
|
10333
11006
|
/** @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). */
|
|
10334
11007
|
400: {
|
|
@@ -10357,15 +11030,6 @@ export interface operations {
|
|
|
10357
11030
|
'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
|
|
10358
11031
|
};
|
|
10359
11032
|
};
|
|
10360
|
-
/** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
|
|
10361
|
-
404: {
|
|
10362
|
-
headers: {
|
|
10363
|
-
[name: string]: unknown;
|
|
10364
|
-
};
|
|
10365
|
-
content: {
|
|
10366
|
-
'application/problem+json': components['schemas']['NotFoundProblemResponse'];
|
|
10367
|
-
};
|
|
10368
|
-
};
|
|
10369
11033
|
/** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
|
|
10370
11034
|
412: {
|
|
10371
11035
|
headers: {
|
|
@@ -10404,32 +11068,27 @@ export interface operations {
|
|
|
10404
11068
|
};
|
|
10405
11069
|
};
|
|
10406
11070
|
};
|
|
10407
|
-
|
|
11071
|
+
appCustomInvoicingUpdatePaymentStatus: {
|
|
10408
11072
|
parameters: {
|
|
10409
|
-
query?:
|
|
10410
|
-
/** @description Page index.
|
|
10411
|
-
*
|
|
10412
|
-
* Default is 1. */
|
|
10413
|
-
page?: components['parameters']['Pagination.page'];
|
|
10414
|
-
/** @description The maximum number of items per page.
|
|
10415
|
-
*
|
|
10416
|
-
* Default is 100. */
|
|
10417
|
-
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
10418
|
-
};
|
|
11073
|
+
query?: never;
|
|
10419
11074
|
header?: never;
|
|
10420
|
-
path
|
|
11075
|
+
path: {
|
|
11076
|
+
invoiceId: string;
|
|
11077
|
+
};
|
|
10421
11078
|
cookie?: never;
|
|
10422
11079
|
};
|
|
10423
|
-
requestBody
|
|
11080
|
+
requestBody: {
|
|
11081
|
+
content: {
|
|
11082
|
+
'application/json': components['schemas']['CustomInvoicingUpdatePaymentStatusRequest'];
|
|
11083
|
+
};
|
|
11084
|
+
};
|
|
10424
11085
|
responses: {
|
|
10425
|
-
/** @description
|
|
10426
|
-
|
|
11086
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
11087
|
+
204: {
|
|
10427
11088
|
headers: {
|
|
10428
11089
|
[name: string]: unknown;
|
|
10429
11090
|
};
|
|
10430
|
-
content
|
|
10431
|
-
'application/json': components['schemas']['AppPaginatedResponse'];
|
|
10432
|
-
};
|
|
11091
|
+
content?: never;
|
|
10433
11092
|
};
|
|
10434
11093
|
/** @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). */
|
|
10435
11094
|
400: {
|
|
@@ -10601,7 +11260,7 @@ export interface operations {
|
|
|
10601
11260
|
};
|
|
10602
11261
|
requestBody: {
|
|
10603
11262
|
content: {
|
|
10604
|
-
'application/json': components['schemas']['
|
|
11263
|
+
'application/json': components['schemas']['AppReplaceUpdate'];
|
|
10605
11264
|
};
|
|
10606
11265
|
};
|
|
10607
11266
|
responses: {
|
|
@@ -13001,6 +13660,8 @@ export interface operations {
|
|
|
13001
13660
|
subject?: components['parameters']['queryCustomerList.subject'];
|
|
13002
13661
|
/** @description Filter customers by the plan key of their susbcription. */
|
|
13003
13662
|
planKey?: components['parameters']['queryCustomerList.planKey'];
|
|
13663
|
+
/** @description What parts of the list output to expand in listings */
|
|
13664
|
+
expand?: components['parameters']['queryCustomerList.expand'];
|
|
13004
13665
|
};
|
|
13005
13666
|
header?: never;
|
|
13006
13667
|
path?: never;
|
|
@@ -13171,7 +13832,10 @@ export interface operations {
|
|
|
13171
13832
|
};
|
|
13172
13833
|
getCustomer: {
|
|
13173
13834
|
parameters: {
|
|
13174
|
-
query?:
|
|
13835
|
+
query?: {
|
|
13836
|
+
/** @description What parts of the customer output to expand */
|
|
13837
|
+
expand?: components['parameters']['queryCustomerGet'];
|
|
13838
|
+
};
|
|
13175
13839
|
header?: never;
|
|
13176
13840
|
path: {
|
|
13177
13841
|
customerIdOrKey: string;
|
|
@@ -13663,7 +14327,7 @@ export interface operations {
|
|
|
13663
14327
|
};
|
|
13664
14328
|
requestBody: {
|
|
13665
14329
|
content: {
|
|
13666
|
-
'application/json': components['schemas']['
|
|
14330
|
+
'application/json': components['schemas']['CustomerAppDataCreateOrUpdateItem'][];
|
|
13667
14331
|
};
|
|
13668
14332
|
};
|
|
13669
14333
|
responses: {
|
|
@@ -15488,6 +16152,101 @@ export interface operations {
|
|
|
15488
16152
|
};
|
|
15489
16153
|
};
|
|
15490
16154
|
};
|
|
16155
|
+
marketplaceAppInstall: {
|
|
16156
|
+
parameters: {
|
|
16157
|
+
query?: never;
|
|
16158
|
+
header?: never;
|
|
16159
|
+
path: {
|
|
16160
|
+
/** @description The type of the app to install. */
|
|
16161
|
+
type: components['parameters']['MarketplaceInstallRequest.type'];
|
|
16162
|
+
};
|
|
16163
|
+
cookie?: never;
|
|
16164
|
+
};
|
|
16165
|
+
requestBody: {
|
|
16166
|
+
content: {
|
|
16167
|
+
'application/json': {
|
|
16168
|
+
/** @description Name of the application to install.
|
|
16169
|
+
*
|
|
16170
|
+
* If not set defaults to the marketplace item's description. */
|
|
16171
|
+
name?: string;
|
|
16172
|
+
};
|
|
16173
|
+
};
|
|
16174
|
+
};
|
|
16175
|
+
responses: {
|
|
16176
|
+
/** @description The request has succeeded. */
|
|
16177
|
+
200: {
|
|
16178
|
+
headers: {
|
|
16179
|
+
[name: string]: unknown;
|
|
16180
|
+
};
|
|
16181
|
+
content: {
|
|
16182
|
+
'application/json': components['schemas']['MarketplaceInstallResponse'];
|
|
16183
|
+
};
|
|
16184
|
+
};
|
|
16185
|
+
/** @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). */
|
|
16186
|
+
400: {
|
|
16187
|
+
headers: {
|
|
16188
|
+
[name: string]: unknown;
|
|
16189
|
+
};
|
|
16190
|
+
content: {
|
|
16191
|
+
'application/problem+json': components['schemas']['BadRequestProblemResponse'];
|
|
16192
|
+
};
|
|
16193
|
+
};
|
|
16194
|
+
/** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
|
|
16195
|
+
401: {
|
|
16196
|
+
headers: {
|
|
16197
|
+
[name: string]: unknown;
|
|
16198
|
+
};
|
|
16199
|
+
content: {
|
|
16200
|
+
'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
|
|
16201
|
+
};
|
|
16202
|
+
};
|
|
16203
|
+
/** @description The server understood the request but refuses to authorize it. */
|
|
16204
|
+
403: {
|
|
16205
|
+
headers: {
|
|
16206
|
+
[name: string]: unknown;
|
|
16207
|
+
};
|
|
16208
|
+
content: {
|
|
16209
|
+
'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
|
|
16210
|
+
};
|
|
16211
|
+
};
|
|
16212
|
+
/** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
|
|
16213
|
+
412: {
|
|
16214
|
+
headers: {
|
|
16215
|
+
[name: string]: unknown;
|
|
16216
|
+
};
|
|
16217
|
+
content: {
|
|
16218
|
+
'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
|
|
16219
|
+
};
|
|
16220
|
+
};
|
|
16221
|
+
/** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
|
|
16222
|
+
500: {
|
|
16223
|
+
headers: {
|
|
16224
|
+
[name: string]: unknown;
|
|
16225
|
+
};
|
|
16226
|
+
content: {
|
|
16227
|
+
'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
|
|
16228
|
+
};
|
|
16229
|
+
};
|
|
16230
|
+
/** @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. */
|
|
16231
|
+
503: {
|
|
16232
|
+
headers: {
|
|
16233
|
+
[name: string]: unknown;
|
|
16234
|
+
};
|
|
16235
|
+
content: {
|
|
16236
|
+
'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
|
|
16237
|
+
};
|
|
16238
|
+
};
|
|
16239
|
+
/** @description An unexpected error response. */
|
|
16240
|
+
default: {
|
|
16241
|
+
headers: {
|
|
16242
|
+
[name: string]: unknown;
|
|
16243
|
+
};
|
|
16244
|
+
content: {
|
|
16245
|
+
'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
|
|
16246
|
+
};
|
|
16247
|
+
};
|
|
16248
|
+
};
|
|
16249
|
+
};
|
|
15491
16250
|
marketplaceAppAPIKeyInstall: {
|
|
15492
16251
|
parameters: {
|
|
15493
16252
|
query?: never;
|
|
@@ -18382,7 +19141,32 @@ export interface operations {
|
|
|
18382
19141
|
};
|
|
18383
19142
|
listPlanAddons: {
|
|
18384
19143
|
parameters: {
|
|
18385
|
-
query?:
|
|
19144
|
+
query?: {
|
|
19145
|
+
/** @description Include deleted plan add-on assignments.
|
|
19146
|
+
*
|
|
19147
|
+
* Usage: `?includeDeleted=true` */
|
|
19148
|
+
includeDeleted?: boolean;
|
|
19149
|
+
/** @description Filter by addon.id attribute. */
|
|
19150
|
+
id?: string[];
|
|
19151
|
+
/** @description Filter by addon.key attribute. */
|
|
19152
|
+
key?: string[];
|
|
19153
|
+
/** @description Filter by addon.key and addon.version attributes. */
|
|
19154
|
+
keyVersion?: {
|
|
19155
|
+
[key: string]: number[];
|
|
19156
|
+
};
|
|
19157
|
+
/** @description Page index.
|
|
19158
|
+
*
|
|
19159
|
+
* Default is 1. */
|
|
19160
|
+
page?: components['parameters']['Pagination.page'];
|
|
19161
|
+
/** @description The maximum number of items per page.
|
|
19162
|
+
*
|
|
19163
|
+
* Default is 100. */
|
|
19164
|
+
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
19165
|
+
/** @description The order direction. */
|
|
19166
|
+
order?: components['parameters']['PlanAddonOrderByOrdering.order'];
|
|
19167
|
+
/** @description The order by field. */
|
|
19168
|
+
orderBy?: components['parameters']['PlanAddonOrderByOrdering.orderBy'];
|
|
19169
|
+
};
|
|
18386
19170
|
header?: never;
|
|
18387
19171
|
path: {
|
|
18388
19172
|
planId: string;
|
|
@@ -18397,7 +19181,7 @@ export interface operations {
|
|
|
18397
19181
|
[name: string]: unknown;
|
|
18398
19182
|
};
|
|
18399
19183
|
content: {
|
|
18400
|
-
'application/json': components['schemas']['
|
|
19184
|
+
'application/json': components['schemas']['PlanAddonPaginatedResponse'];
|
|
18401
19185
|
};
|
|
18402
19186
|
};
|
|
18403
19187
|
/** @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). */
|