@mastra/vercel 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +63 -0
- package/src/Vercel.test.ts +61 -0
- package/src/assets/vercel.png +0 -0
- package/src/index.ts +67 -0
- package/src/openapi-components.ts +4184 -0
- package/src/openapi-paths.ts +52314 -0
- package/src/openapi.ts +28072 -0
|
@@ -0,0 +1,4184 @@
|
|
|
1
|
+
// @ts-nocheck
|
|
2
|
+
export type TComponents = {
|
|
3
|
+
schemas: {
|
|
4
|
+
ACLAction: {
|
|
5
|
+
description: 'Enum containing the actions that can be performed against a resource. Group operations are included.';
|
|
6
|
+
enum: ['create', 'delete', 'read', 'update', 'list', 'count'];
|
|
7
|
+
type: 'string';
|
|
8
|
+
};
|
|
9
|
+
AuthToken: {
|
|
10
|
+
description: 'Authentication token metadata.';
|
|
11
|
+
properties: {
|
|
12
|
+
activeAt: {
|
|
13
|
+
description: 'Timestamp (in milliseconds) of when the token was most recently used.';
|
|
14
|
+
examples: [1632816536002];
|
|
15
|
+
type: 'number';
|
|
16
|
+
};
|
|
17
|
+
createdAt: {
|
|
18
|
+
description: 'Timestamp (in milliseconds) of when the token was created.';
|
|
19
|
+
examples: [1632816536002];
|
|
20
|
+
type: 'number';
|
|
21
|
+
};
|
|
22
|
+
expiresAt: {
|
|
23
|
+
description: 'Timestamp (in milliseconds) of when the token expires.';
|
|
24
|
+
examples: [1632816536002];
|
|
25
|
+
type: 'number';
|
|
26
|
+
};
|
|
27
|
+
id: {
|
|
28
|
+
description: 'The unique identifier of the token.';
|
|
29
|
+
examples: ['5d9f2ebd38ddca62e5d51e9c1704c72530bdc8bfdd41e782a6687c48399e8391'];
|
|
30
|
+
type: 'string';
|
|
31
|
+
};
|
|
32
|
+
name: {
|
|
33
|
+
description: 'The human-readable name of the token.';
|
|
34
|
+
type: 'string';
|
|
35
|
+
};
|
|
36
|
+
origin: {
|
|
37
|
+
description: 'The origin of how the token was created.';
|
|
38
|
+
examples: ['github'];
|
|
39
|
+
type: 'string';
|
|
40
|
+
};
|
|
41
|
+
scopes: {
|
|
42
|
+
description: 'The access scopes granted to the token.';
|
|
43
|
+
items: {
|
|
44
|
+
oneOf: [
|
|
45
|
+
{
|
|
46
|
+
description: 'The access scopes granted to the token.';
|
|
47
|
+
properties: {
|
|
48
|
+
createdAt: {
|
|
49
|
+
type: 'number';
|
|
50
|
+
};
|
|
51
|
+
expiresAt: {
|
|
52
|
+
type: 'number';
|
|
53
|
+
};
|
|
54
|
+
origin: {
|
|
55
|
+
enum: ['saml', 'github', 'gitlab', 'bitbucket', 'email', 'manual'];
|
|
56
|
+
type: 'string';
|
|
57
|
+
};
|
|
58
|
+
type: {
|
|
59
|
+
enum: ['user'];
|
|
60
|
+
type: 'string';
|
|
61
|
+
};
|
|
62
|
+
};
|
|
63
|
+
required: ['type', 'origin', 'createdAt'];
|
|
64
|
+
type: 'object';
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
description: 'The access scopes granted to the token.';
|
|
68
|
+
properties: {
|
|
69
|
+
createdAt: {
|
|
70
|
+
type: 'number';
|
|
71
|
+
};
|
|
72
|
+
expiresAt: {
|
|
73
|
+
type: 'number';
|
|
74
|
+
};
|
|
75
|
+
origin: {
|
|
76
|
+
enum: ['saml', 'github', 'gitlab', 'bitbucket', 'email', 'manual'];
|
|
77
|
+
type: 'string';
|
|
78
|
+
};
|
|
79
|
+
teamId: {
|
|
80
|
+
type: 'string';
|
|
81
|
+
};
|
|
82
|
+
type: {
|
|
83
|
+
enum: ['team'];
|
|
84
|
+
type: 'string';
|
|
85
|
+
};
|
|
86
|
+
};
|
|
87
|
+
required: ['type', 'teamId', 'origin', 'createdAt'];
|
|
88
|
+
type: 'object';
|
|
89
|
+
},
|
|
90
|
+
];
|
|
91
|
+
};
|
|
92
|
+
type: 'array';
|
|
93
|
+
};
|
|
94
|
+
type: {
|
|
95
|
+
description: 'The type of the token.';
|
|
96
|
+
examples: ['oauth2-token'];
|
|
97
|
+
type: 'string';
|
|
98
|
+
};
|
|
99
|
+
};
|
|
100
|
+
required: ['id', 'name', 'type', 'activeAt', 'createdAt'];
|
|
101
|
+
type: 'object';
|
|
102
|
+
};
|
|
103
|
+
AuthUser: {
|
|
104
|
+
description: 'Data for the currently authenticated User.';
|
|
105
|
+
properties: {
|
|
106
|
+
activeDashboardViews: {
|
|
107
|
+
description: 'set of dashboard view preferences (cards or list) per scopeId';
|
|
108
|
+
items: {
|
|
109
|
+
description: 'set of dashboard view preferences (cards or list) per scopeId';
|
|
110
|
+
properties: {
|
|
111
|
+
scopeId: {
|
|
112
|
+
type: 'string';
|
|
113
|
+
};
|
|
114
|
+
viewPreference: {
|
|
115
|
+
enum: ['cards', 'list'];
|
|
116
|
+
type: 'string';
|
|
117
|
+
};
|
|
118
|
+
};
|
|
119
|
+
required: ['scopeId', 'viewPreference'];
|
|
120
|
+
type: 'object';
|
|
121
|
+
};
|
|
122
|
+
type: 'array';
|
|
123
|
+
};
|
|
124
|
+
avatar: {
|
|
125
|
+
description: 'SHA1 hash of the avatar for the User account. Can be used in conjuction with the ... endpoint to retrieve the avatar image.';
|
|
126
|
+
examples: ['22cb30c85ff45ac4c72de8981500006b28114aa1'];
|
|
127
|
+
type: ['string', 'null'];
|
|
128
|
+
};
|
|
129
|
+
billing: {
|
|
130
|
+
description: 'An object containing billing infomation associated with the User account.';
|
|
131
|
+
properties: {
|
|
132
|
+
addons: {
|
|
133
|
+
items: {
|
|
134
|
+
enum: ['custom-deployment-suffix', 'live-support'];
|
|
135
|
+
type: 'string';
|
|
136
|
+
};
|
|
137
|
+
type: ['array', 'null'];
|
|
138
|
+
};
|
|
139
|
+
address: {
|
|
140
|
+
properties: {
|
|
141
|
+
city: {
|
|
142
|
+
type: 'string';
|
|
143
|
+
};
|
|
144
|
+
country: {
|
|
145
|
+
type: 'string';
|
|
146
|
+
};
|
|
147
|
+
line1: {
|
|
148
|
+
type: 'string';
|
|
149
|
+
};
|
|
150
|
+
line2: {
|
|
151
|
+
type: 'string';
|
|
152
|
+
};
|
|
153
|
+
postalCode: {
|
|
154
|
+
type: 'string';
|
|
155
|
+
};
|
|
156
|
+
state: {
|
|
157
|
+
type: 'string';
|
|
158
|
+
};
|
|
159
|
+
};
|
|
160
|
+
required: ['line1'];
|
|
161
|
+
type: ['object', 'null'];
|
|
162
|
+
};
|
|
163
|
+
cancelation: {
|
|
164
|
+
type: ['number', 'null'];
|
|
165
|
+
};
|
|
166
|
+
contract: {
|
|
167
|
+
properties: {
|
|
168
|
+
end: {
|
|
169
|
+
type: 'number';
|
|
170
|
+
};
|
|
171
|
+
start: {
|
|
172
|
+
type: 'number';
|
|
173
|
+
};
|
|
174
|
+
};
|
|
175
|
+
required: ['start', 'end'];
|
|
176
|
+
type: ['object', 'null'];
|
|
177
|
+
};
|
|
178
|
+
controls: {
|
|
179
|
+
properties: {
|
|
180
|
+
analyticsSampleRateInPercent: {
|
|
181
|
+
type: ['number', 'null'];
|
|
182
|
+
};
|
|
183
|
+
analyticsSpendLimitInDollars: {
|
|
184
|
+
type: ['number', 'null'];
|
|
185
|
+
};
|
|
186
|
+
};
|
|
187
|
+
type: ['object', 'null'];
|
|
188
|
+
};
|
|
189
|
+
currency: {
|
|
190
|
+
enum: ['usd', 'eur'];
|
|
191
|
+
type: 'string';
|
|
192
|
+
};
|
|
193
|
+
email: {
|
|
194
|
+
type: ['string', 'null'];
|
|
195
|
+
};
|
|
196
|
+
invoiceItems: {
|
|
197
|
+
properties: {
|
|
198
|
+
analytics: {
|
|
199
|
+
description: 'Will be used to create an invoice item. The price must be in cents: 2000 for $20.';
|
|
200
|
+
properties: {
|
|
201
|
+
createdAt: {
|
|
202
|
+
type: 'number';
|
|
203
|
+
};
|
|
204
|
+
disabledAt: {
|
|
205
|
+
type: ['number', 'null'];
|
|
206
|
+
};
|
|
207
|
+
frequency: {
|
|
208
|
+
properties: {
|
|
209
|
+
interval: {
|
|
210
|
+
enum: ['month'];
|
|
211
|
+
type: 'string';
|
|
212
|
+
};
|
|
213
|
+
intervalCount: {
|
|
214
|
+
enum: [1, 3, 2, 6, 12];
|
|
215
|
+
type: 'number';
|
|
216
|
+
};
|
|
217
|
+
};
|
|
218
|
+
required: ['interval', 'intervalCount'];
|
|
219
|
+
type: 'object';
|
|
220
|
+
};
|
|
221
|
+
hidden: {
|
|
222
|
+
type: 'boolean';
|
|
223
|
+
};
|
|
224
|
+
maxQuantity: {
|
|
225
|
+
type: 'number';
|
|
226
|
+
};
|
|
227
|
+
name: {
|
|
228
|
+
type: 'string';
|
|
229
|
+
};
|
|
230
|
+
price: {
|
|
231
|
+
type: 'number';
|
|
232
|
+
};
|
|
233
|
+
quantity: {
|
|
234
|
+
type: 'number';
|
|
235
|
+
};
|
|
236
|
+
tier: {
|
|
237
|
+
type: 'number';
|
|
238
|
+
};
|
|
239
|
+
};
|
|
240
|
+
required: ['price', 'quantity', 'hidden'];
|
|
241
|
+
type: 'object';
|
|
242
|
+
};
|
|
243
|
+
analyticsUsage: {
|
|
244
|
+
properties: {
|
|
245
|
+
batch: {
|
|
246
|
+
type: 'number';
|
|
247
|
+
};
|
|
248
|
+
disabledAt: {
|
|
249
|
+
type: ['number', 'null'];
|
|
250
|
+
};
|
|
251
|
+
hidden: {
|
|
252
|
+
type: 'boolean';
|
|
253
|
+
};
|
|
254
|
+
name: {
|
|
255
|
+
type: 'string';
|
|
256
|
+
};
|
|
257
|
+
price: {
|
|
258
|
+
type: 'number';
|
|
259
|
+
};
|
|
260
|
+
threshold: {
|
|
261
|
+
type: 'number';
|
|
262
|
+
};
|
|
263
|
+
tier: {
|
|
264
|
+
type: 'number';
|
|
265
|
+
};
|
|
266
|
+
};
|
|
267
|
+
required: ['price', 'batch', 'threshold', 'hidden'];
|
|
268
|
+
type: 'object';
|
|
269
|
+
};
|
|
270
|
+
artifacts: {
|
|
271
|
+
properties: {
|
|
272
|
+
batch: {
|
|
273
|
+
type: 'number';
|
|
274
|
+
};
|
|
275
|
+
disabledAt: {
|
|
276
|
+
type: ['number', 'null'];
|
|
277
|
+
};
|
|
278
|
+
hidden: {
|
|
279
|
+
type: 'boolean';
|
|
280
|
+
};
|
|
281
|
+
name: {
|
|
282
|
+
type: 'string';
|
|
283
|
+
};
|
|
284
|
+
price: {
|
|
285
|
+
type: 'number';
|
|
286
|
+
};
|
|
287
|
+
threshold: {
|
|
288
|
+
type: 'number';
|
|
289
|
+
};
|
|
290
|
+
tier: {
|
|
291
|
+
type: 'number';
|
|
292
|
+
};
|
|
293
|
+
};
|
|
294
|
+
required: ['price', 'batch', 'threshold', 'hidden'];
|
|
295
|
+
type: 'object';
|
|
296
|
+
};
|
|
297
|
+
bandwidth: {
|
|
298
|
+
properties: {
|
|
299
|
+
batch: {
|
|
300
|
+
type: 'number';
|
|
301
|
+
};
|
|
302
|
+
disabledAt: {
|
|
303
|
+
type: ['number', 'null'];
|
|
304
|
+
};
|
|
305
|
+
hidden: {
|
|
306
|
+
type: 'boolean';
|
|
307
|
+
};
|
|
308
|
+
name: {
|
|
309
|
+
type: 'string';
|
|
310
|
+
};
|
|
311
|
+
price: {
|
|
312
|
+
type: 'number';
|
|
313
|
+
};
|
|
314
|
+
threshold: {
|
|
315
|
+
type: 'number';
|
|
316
|
+
};
|
|
317
|
+
tier: {
|
|
318
|
+
type: 'number';
|
|
319
|
+
};
|
|
320
|
+
};
|
|
321
|
+
required: ['price', 'batch', 'threshold', 'hidden'];
|
|
322
|
+
type: 'object';
|
|
323
|
+
};
|
|
324
|
+
builds: {
|
|
325
|
+
properties: {
|
|
326
|
+
batch: {
|
|
327
|
+
type: 'number';
|
|
328
|
+
};
|
|
329
|
+
disabledAt: {
|
|
330
|
+
type: ['number', 'null'];
|
|
331
|
+
};
|
|
332
|
+
hidden: {
|
|
333
|
+
type: 'boolean';
|
|
334
|
+
};
|
|
335
|
+
name: {
|
|
336
|
+
type: 'string';
|
|
337
|
+
};
|
|
338
|
+
price: {
|
|
339
|
+
type: 'number';
|
|
340
|
+
};
|
|
341
|
+
threshold: {
|
|
342
|
+
type: 'number';
|
|
343
|
+
};
|
|
344
|
+
tier: {
|
|
345
|
+
type: 'number';
|
|
346
|
+
};
|
|
347
|
+
};
|
|
348
|
+
required: ['price', 'batch', 'threshold', 'hidden'];
|
|
349
|
+
type: 'object';
|
|
350
|
+
};
|
|
351
|
+
concurrentBuilds: {
|
|
352
|
+
description: 'Will be used to create an invoice item. The price must be in cents: 2000 for $20.';
|
|
353
|
+
properties: {
|
|
354
|
+
createdAt: {
|
|
355
|
+
type: 'number';
|
|
356
|
+
};
|
|
357
|
+
disabledAt: {
|
|
358
|
+
type: ['number', 'null'];
|
|
359
|
+
};
|
|
360
|
+
frequency: {
|
|
361
|
+
properties: {
|
|
362
|
+
interval: {
|
|
363
|
+
enum: ['month'];
|
|
364
|
+
type: 'string';
|
|
365
|
+
};
|
|
366
|
+
intervalCount: {
|
|
367
|
+
enum: [1, 3, 2, 6, 12];
|
|
368
|
+
type: 'number';
|
|
369
|
+
};
|
|
370
|
+
};
|
|
371
|
+
required: ['interval', 'intervalCount'];
|
|
372
|
+
type: 'object';
|
|
373
|
+
};
|
|
374
|
+
hidden: {
|
|
375
|
+
type: 'boolean';
|
|
376
|
+
};
|
|
377
|
+
maxQuantity: {
|
|
378
|
+
type: 'number';
|
|
379
|
+
};
|
|
380
|
+
name: {
|
|
381
|
+
type: 'string';
|
|
382
|
+
};
|
|
383
|
+
price: {
|
|
384
|
+
type: 'number';
|
|
385
|
+
};
|
|
386
|
+
quantity: {
|
|
387
|
+
type: 'number';
|
|
388
|
+
};
|
|
389
|
+
tier: {
|
|
390
|
+
type: 'number';
|
|
391
|
+
};
|
|
392
|
+
};
|
|
393
|
+
required: ['price', 'quantity', 'hidden'];
|
|
394
|
+
type: 'object';
|
|
395
|
+
};
|
|
396
|
+
cronJobInvocation: {
|
|
397
|
+
properties: {
|
|
398
|
+
batch: {
|
|
399
|
+
type: 'number';
|
|
400
|
+
};
|
|
401
|
+
disabledAt: {
|
|
402
|
+
type: ['number', 'null'];
|
|
403
|
+
};
|
|
404
|
+
hidden: {
|
|
405
|
+
type: 'boolean';
|
|
406
|
+
};
|
|
407
|
+
name: {
|
|
408
|
+
type: 'string';
|
|
409
|
+
};
|
|
410
|
+
price: {
|
|
411
|
+
type: 'number';
|
|
412
|
+
};
|
|
413
|
+
threshold: {
|
|
414
|
+
type: 'number';
|
|
415
|
+
};
|
|
416
|
+
tier: {
|
|
417
|
+
type: 'number';
|
|
418
|
+
};
|
|
419
|
+
};
|
|
420
|
+
required: ['price', 'batch', 'threshold', 'hidden'];
|
|
421
|
+
type: 'object';
|
|
422
|
+
};
|
|
423
|
+
customCerts: {
|
|
424
|
+
description: 'Will be used to create an invoice item. The price must be in cents: 2000 for $20.';
|
|
425
|
+
properties: {
|
|
426
|
+
createdAt: {
|
|
427
|
+
type: 'number';
|
|
428
|
+
};
|
|
429
|
+
disabledAt: {
|
|
430
|
+
type: ['number', 'null'];
|
|
431
|
+
};
|
|
432
|
+
frequency: {
|
|
433
|
+
properties: {
|
|
434
|
+
interval: {
|
|
435
|
+
enum: ['month'];
|
|
436
|
+
type: 'string';
|
|
437
|
+
};
|
|
438
|
+
intervalCount: {
|
|
439
|
+
enum: [1, 3, 2, 6, 12];
|
|
440
|
+
type: 'number';
|
|
441
|
+
};
|
|
442
|
+
};
|
|
443
|
+
required: ['interval', 'intervalCount'];
|
|
444
|
+
type: 'object';
|
|
445
|
+
};
|
|
446
|
+
hidden: {
|
|
447
|
+
type: 'boolean';
|
|
448
|
+
};
|
|
449
|
+
maxQuantity: {
|
|
450
|
+
type: 'number';
|
|
451
|
+
};
|
|
452
|
+
name: {
|
|
453
|
+
type: 'string';
|
|
454
|
+
};
|
|
455
|
+
price: {
|
|
456
|
+
type: 'number';
|
|
457
|
+
};
|
|
458
|
+
quantity: {
|
|
459
|
+
type: 'number';
|
|
460
|
+
};
|
|
461
|
+
tier: {
|
|
462
|
+
type: 'number';
|
|
463
|
+
};
|
|
464
|
+
};
|
|
465
|
+
required: ['price', 'quantity', 'hidden'];
|
|
466
|
+
type: 'object';
|
|
467
|
+
};
|
|
468
|
+
edgeConfigRead: {
|
|
469
|
+
properties: {
|
|
470
|
+
batch: {
|
|
471
|
+
type: 'number';
|
|
472
|
+
};
|
|
473
|
+
disabledAt: {
|
|
474
|
+
type: ['number', 'null'];
|
|
475
|
+
};
|
|
476
|
+
hidden: {
|
|
477
|
+
type: 'boolean';
|
|
478
|
+
};
|
|
479
|
+
name: {
|
|
480
|
+
type: 'string';
|
|
481
|
+
};
|
|
482
|
+
price: {
|
|
483
|
+
type: 'number';
|
|
484
|
+
};
|
|
485
|
+
threshold: {
|
|
486
|
+
type: 'number';
|
|
487
|
+
};
|
|
488
|
+
tier: {
|
|
489
|
+
type: 'number';
|
|
490
|
+
};
|
|
491
|
+
};
|
|
492
|
+
required: ['price', 'batch', 'threshold', 'hidden'];
|
|
493
|
+
type: 'object';
|
|
494
|
+
};
|
|
495
|
+
edgeConfigWrite: {
|
|
496
|
+
properties: {
|
|
497
|
+
batch: {
|
|
498
|
+
type: 'number';
|
|
499
|
+
};
|
|
500
|
+
disabledAt: {
|
|
501
|
+
type: ['number', 'null'];
|
|
502
|
+
};
|
|
503
|
+
hidden: {
|
|
504
|
+
type: 'boolean';
|
|
505
|
+
};
|
|
506
|
+
name: {
|
|
507
|
+
type: 'string';
|
|
508
|
+
};
|
|
509
|
+
price: {
|
|
510
|
+
type: 'number';
|
|
511
|
+
};
|
|
512
|
+
threshold: {
|
|
513
|
+
type: 'number';
|
|
514
|
+
};
|
|
515
|
+
tier: {
|
|
516
|
+
type: 'number';
|
|
517
|
+
};
|
|
518
|
+
};
|
|
519
|
+
required: ['price', 'batch', 'threshold', 'hidden'];
|
|
520
|
+
type: 'object';
|
|
521
|
+
};
|
|
522
|
+
edgeFunctionExecutionUnits: {
|
|
523
|
+
properties: {
|
|
524
|
+
batch: {
|
|
525
|
+
type: 'number';
|
|
526
|
+
};
|
|
527
|
+
disabledAt: {
|
|
528
|
+
type: ['number', 'null'];
|
|
529
|
+
};
|
|
530
|
+
hidden: {
|
|
531
|
+
type: 'boolean';
|
|
532
|
+
};
|
|
533
|
+
name: {
|
|
534
|
+
type: 'string';
|
|
535
|
+
};
|
|
536
|
+
price: {
|
|
537
|
+
type: 'number';
|
|
538
|
+
};
|
|
539
|
+
threshold: {
|
|
540
|
+
type: 'number';
|
|
541
|
+
};
|
|
542
|
+
tier: {
|
|
543
|
+
type: 'number';
|
|
544
|
+
};
|
|
545
|
+
};
|
|
546
|
+
required: ['price', 'batch', 'threshold', 'hidden'];
|
|
547
|
+
type: 'object';
|
|
548
|
+
};
|
|
549
|
+
edgeMiddlewareInvocations: {
|
|
550
|
+
properties: {
|
|
551
|
+
batch: {
|
|
552
|
+
type: 'number';
|
|
553
|
+
};
|
|
554
|
+
disabledAt: {
|
|
555
|
+
type: ['number', 'null'];
|
|
556
|
+
};
|
|
557
|
+
hidden: {
|
|
558
|
+
type: 'boolean';
|
|
559
|
+
};
|
|
560
|
+
name: {
|
|
561
|
+
type: 'string';
|
|
562
|
+
};
|
|
563
|
+
price: {
|
|
564
|
+
type: 'number';
|
|
565
|
+
};
|
|
566
|
+
threshold: {
|
|
567
|
+
type: 'number';
|
|
568
|
+
};
|
|
569
|
+
tier: {
|
|
570
|
+
type: 'number';
|
|
571
|
+
};
|
|
572
|
+
};
|
|
573
|
+
required: ['price', 'batch', 'threshold', 'hidden'];
|
|
574
|
+
type: 'object';
|
|
575
|
+
};
|
|
576
|
+
enterprise: {
|
|
577
|
+
description: 'Will be used to create an invoice item. The price must be in cents: 2000 for $20.';
|
|
578
|
+
properties: {
|
|
579
|
+
createdAt: {
|
|
580
|
+
type: 'number';
|
|
581
|
+
};
|
|
582
|
+
disabledAt: {
|
|
583
|
+
type: ['number', 'null'];
|
|
584
|
+
};
|
|
585
|
+
frequency: {
|
|
586
|
+
properties: {
|
|
587
|
+
interval: {
|
|
588
|
+
enum: ['month'];
|
|
589
|
+
type: 'string';
|
|
590
|
+
};
|
|
591
|
+
intervalCount: {
|
|
592
|
+
enum: [1, 3, 2, 6, 12];
|
|
593
|
+
type: 'number';
|
|
594
|
+
};
|
|
595
|
+
};
|
|
596
|
+
required: ['interval', 'intervalCount'];
|
|
597
|
+
type: 'object';
|
|
598
|
+
};
|
|
599
|
+
hidden: {
|
|
600
|
+
type: 'boolean';
|
|
601
|
+
};
|
|
602
|
+
maxQuantity: {
|
|
603
|
+
type: 'number';
|
|
604
|
+
};
|
|
605
|
+
name: {
|
|
606
|
+
type: 'string';
|
|
607
|
+
};
|
|
608
|
+
price: {
|
|
609
|
+
type: 'number';
|
|
610
|
+
};
|
|
611
|
+
quantity: {
|
|
612
|
+
type: 'number';
|
|
613
|
+
};
|
|
614
|
+
tier: {
|
|
615
|
+
type: 'number';
|
|
616
|
+
};
|
|
617
|
+
};
|
|
618
|
+
required: ['price', 'quantity', 'hidden'];
|
|
619
|
+
type: 'object';
|
|
620
|
+
};
|
|
621
|
+
monitoring: {
|
|
622
|
+
description: 'Will be used to create an invoice item. The price must be in cents: 2000 for $20.';
|
|
623
|
+
properties: {
|
|
624
|
+
createdAt: {
|
|
625
|
+
type: 'number';
|
|
626
|
+
};
|
|
627
|
+
disabledAt: {
|
|
628
|
+
type: ['number', 'null'];
|
|
629
|
+
};
|
|
630
|
+
frequency: {
|
|
631
|
+
properties: {
|
|
632
|
+
interval: {
|
|
633
|
+
enum: ['month'];
|
|
634
|
+
type: 'string';
|
|
635
|
+
};
|
|
636
|
+
intervalCount: {
|
|
637
|
+
enum: [1, 3, 2, 6, 12];
|
|
638
|
+
type: 'number';
|
|
639
|
+
};
|
|
640
|
+
};
|
|
641
|
+
required: ['interval', 'intervalCount'];
|
|
642
|
+
type: 'object';
|
|
643
|
+
};
|
|
644
|
+
hidden: {
|
|
645
|
+
type: 'boolean';
|
|
646
|
+
};
|
|
647
|
+
maxQuantity: {
|
|
648
|
+
type: 'number';
|
|
649
|
+
};
|
|
650
|
+
name: {
|
|
651
|
+
type: 'string';
|
|
652
|
+
};
|
|
653
|
+
price: {
|
|
654
|
+
type: 'number';
|
|
655
|
+
};
|
|
656
|
+
quantity: {
|
|
657
|
+
type: 'number';
|
|
658
|
+
};
|
|
659
|
+
tier: {
|
|
660
|
+
type: 'number';
|
|
661
|
+
};
|
|
662
|
+
};
|
|
663
|
+
required: ['price', 'quantity', 'hidden'];
|
|
664
|
+
type: 'object';
|
|
665
|
+
};
|
|
666
|
+
monitoringMetric: {
|
|
667
|
+
properties: {
|
|
668
|
+
batch: {
|
|
669
|
+
type: 'number';
|
|
670
|
+
};
|
|
671
|
+
disabledAt: {
|
|
672
|
+
type: ['number', 'null'];
|
|
673
|
+
};
|
|
674
|
+
hidden: {
|
|
675
|
+
type: 'boolean';
|
|
676
|
+
};
|
|
677
|
+
name: {
|
|
678
|
+
type: 'string';
|
|
679
|
+
};
|
|
680
|
+
price: {
|
|
681
|
+
type: 'number';
|
|
682
|
+
};
|
|
683
|
+
threshold: {
|
|
684
|
+
type: 'number';
|
|
685
|
+
};
|
|
686
|
+
tier: {
|
|
687
|
+
type: 'number';
|
|
688
|
+
};
|
|
689
|
+
};
|
|
690
|
+
required: ['price', 'batch', 'threshold', 'hidden'];
|
|
691
|
+
type: 'object';
|
|
692
|
+
};
|
|
693
|
+
passwordProtection: {
|
|
694
|
+
description: 'Will be used to create an invoice item. The price must be in cents: 2000 for $20.';
|
|
695
|
+
properties: {
|
|
696
|
+
createdAt: {
|
|
697
|
+
type: 'number';
|
|
698
|
+
};
|
|
699
|
+
disabledAt: {
|
|
700
|
+
type: ['number', 'null'];
|
|
701
|
+
};
|
|
702
|
+
frequency: {
|
|
703
|
+
properties: {
|
|
704
|
+
interval: {
|
|
705
|
+
enum: ['month'];
|
|
706
|
+
type: 'string';
|
|
707
|
+
};
|
|
708
|
+
intervalCount: {
|
|
709
|
+
enum: [1, 3, 2, 6, 12];
|
|
710
|
+
type: 'number';
|
|
711
|
+
};
|
|
712
|
+
};
|
|
713
|
+
required: ['interval', 'intervalCount'];
|
|
714
|
+
type: 'object';
|
|
715
|
+
};
|
|
716
|
+
hidden: {
|
|
717
|
+
type: 'boolean';
|
|
718
|
+
};
|
|
719
|
+
maxQuantity: {
|
|
720
|
+
type: 'number';
|
|
721
|
+
};
|
|
722
|
+
name: {
|
|
723
|
+
type: 'string';
|
|
724
|
+
};
|
|
725
|
+
price: {
|
|
726
|
+
type: 'number';
|
|
727
|
+
};
|
|
728
|
+
quantity: {
|
|
729
|
+
type: 'number';
|
|
730
|
+
};
|
|
731
|
+
tier: {
|
|
732
|
+
type: 'number';
|
|
733
|
+
};
|
|
734
|
+
};
|
|
735
|
+
required: ['price', 'quantity', 'hidden'];
|
|
736
|
+
type: 'object';
|
|
737
|
+
};
|
|
738
|
+
previewDeploymentSuffix: {
|
|
739
|
+
description: 'Will be used to create an invoice item. The price must be in cents: 2000 for $20.';
|
|
740
|
+
properties: {
|
|
741
|
+
createdAt: {
|
|
742
|
+
type: 'number';
|
|
743
|
+
};
|
|
744
|
+
disabledAt: {
|
|
745
|
+
type: ['number', 'null'];
|
|
746
|
+
};
|
|
747
|
+
frequency: {
|
|
748
|
+
properties: {
|
|
749
|
+
interval: {
|
|
750
|
+
enum: ['month'];
|
|
751
|
+
type: 'string';
|
|
752
|
+
};
|
|
753
|
+
intervalCount: {
|
|
754
|
+
enum: [1, 3, 2, 6, 12];
|
|
755
|
+
type: 'number';
|
|
756
|
+
};
|
|
757
|
+
};
|
|
758
|
+
required: ['interval', 'intervalCount'];
|
|
759
|
+
type: 'object';
|
|
760
|
+
};
|
|
761
|
+
hidden: {
|
|
762
|
+
type: 'boolean';
|
|
763
|
+
};
|
|
764
|
+
maxQuantity: {
|
|
765
|
+
type: 'number';
|
|
766
|
+
};
|
|
767
|
+
name: {
|
|
768
|
+
type: 'string';
|
|
769
|
+
};
|
|
770
|
+
price: {
|
|
771
|
+
type: 'number';
|
|
772
|
+
};
|
|
773
|
+
quantity: {
|
|
774
|
+
type: 'number';
|
|
775
|
+
};
|
|
776
|
+
tier: {
|
|
777
|
+
type: 'number';
|
|
778
|
+
};
|
|
779
|
+
};
|
|
780
|
+
required: ['price', 'quantity', 'hidden'];
|
|
781
|
+
type: 'object';
|
|
782
|
+
};
|
|
783
|
+
pro: {
|
|
784
|
+
description: 'Will be used to create an invoice item. The price must be in cents: 2000 for $20.';
|
|
785
|
+
properties: {
|
|
786
|
+
createdAt: {
|
|
787
|
+
type: 'number';
|
|
788
|
+
};
|
|
789
|
+
disabledAt: {
|
|
790
|
+
type: ['number', 'null'];
|
|
791
|
+
};
|
|
792
|
+
frequency: {
|
|
793
|
+
properties: {
|
|
794
|
+
interval: {
|
|
795
|
+
enum: ['month'];
|
|
796
|
+
type: 'string';
|
|
797
|
+
};
|
|
798
|
+
intervalCount: {
|
|
799
|
+
enum: [1, 3, 2, 6, 12];
|
|
800
|
+
type: 'number';
|
|
801
|
+
};
|
|
802
|
+
};
|
|
803
|
+
required: ['interval', 'intervalCount'];
|
|
804
|
+
type: 'object';
|
|
805
|
+
};
|
|
806
|
+
hidden: {
|
|
807
|
+
type: 'boolean';
|
|
808
|
+
};
|
|
809
|
+
maxQuantity: {
|
|
810
|
+
type: 'number';
|
|
811
|
+
};
|
|
812
|
+
name: {
|
|
813
|
+
type: 'string';
|
|
814
|
+
};
|
|
815
|
+
price: {
|
|
816
|
+
type: 'number';
|
|
817
|
+
};
|
|
818
|
+
quantity: {
|
|
819
|
+
type: 'number';
|
|
820
|
+
};
|
|
821
|
+
tier: {
|
|
822
|
+
type: 'number';
|
|
823
|
+
};
|
|
824
|
+
};
|
|
825
|
+
required: ['price', 'quantity', 'hidden'];
|
|
826
|
+
type: 'object';
|
|
827
|
+
};
|
|
828
|
+
saml: {
|
|
829
|
+
description: 'Will be used to create an invoice item. The price must be in cents: 2000 for $20.';
|
|
830
|
+
properties: {
|
|
831
|
+
createdAt: {
|
|
832
|
+
type: 'number';
|
|
833
|
+
};
|
|
834
|
+
disabledAt: {
|
|
835
|
+
type: ['number', 'null'];
|
|
836
|
+
};
|
|
837
|
+
frequency: {
|
|
838
|
+
properties: {
|
|
839
|
+
interval: {
|
|
840
|
+
enum: ['month'];
|
|
841
|
+
type: 'string';
|
|
842
|
+
};
|
|
843
|
+
intervalCount: {
|
|
844
|
+
enum: [1, 3, 2, 6, 12];
|
|
845
|
+
type: 'number';
|
|
846
|
+
};
|
|
847
|
+
};
|
|
848
|
+
required: ['interval', 'intervalCount'];
|
|
849
|
+
type: 'object';
|
|
850
|
+
};
|
|
851
|
+
hidden: {
|
|
852
|
+
type: 'boolean';
|
|
853
|
+
};
|
|
854
|
+
maxQuantity: {
|
|
855
|
+
type: 'number';
|
|
856
|
+
};
|
|
857
|
+
name: {
|
|
858
|
+
type: 'string';
|
|
859
|
+
};
|
|
860
|
+
price: {
|
|
861
|
+
type: 'number';
|
|
862
|
+
};
|
|
863
|
+
quantity: {
|
|
864
|
+
type: 'number';
|
|
865
|
+
};
|
|
866
|
+
tier: {
|
|
867
|
+
type: 'number';
|
|
868
|
+
};
|
|
869
|
+
};
|
|
870
|
+
required: ['price', 'quantity', 'hidden'];
|
|
871
|
+
type: 'object';
|
|
872
|
+
};
|
|
873
|
+
serverlessFunctionExecution: {
|
|
874
|
+
properties: {
|
|
875
|
+
batch: {
|
|
876
|
+
type: 'number';
|
|
877
|
+
};
|
|
878
|
+
disabledAt: {
|
|
879
|
+
type: ['number', 'null'];
|
|
880
|
+
};
|
|
881
|
+
hidden: {
|
|
882
|
+
type: 'boolean';
|
|
883
|
+
};
|
|
884
|
+
name: {
|
|
885
|
+
type: 'string';
|
|
886
|
+
};
|
|
887
|
+
price: {
|
|
888
|
+
type: 'number';
|
|
889
|
+
};
|
|
890
|
+
threshold: {
|
|
891
|
+
type: 'number';
|
|
892
|
+
};
|
|
893
|
+
tier: {
|
|
894
|
+
type: 'number';
|
|
895
|
+
};
|
|
896
|
+
};
|
|
897
|
+
required: ['price', 'batch', 'threshold', 'hidden'];
|
|
898
|
+
type: 'object';
|
|
899
|
+
};
|
|
900
|
+
sourceImages: {
|
|
901
|
+
properties: {
|
|
902
|
+
batch: {
|
|
903
|
+
type: 'number';
|
|
904
|
+
};
|
|
905
|
+
disabledAt: {
|
|
906
|
+
type: ['number', 'null'];
|
|
907
|
+
};
|
|
908
|
+
hidden: {
|
|
909
|
+
type: 'boolean';
|
|
910
|
+
};
|
|
911
|
+
name: {
|
|
912
|
+
type: 'string';
|
|
913
|
+
};
|
|
914
|
+
price: {
|
|
915
|
+
type: 'number';
|
|
916
|
+
};
|
|
917
|
+
threshold: {
|
|
918
|
+
type: 'number';
|
|
919
|
+
};
|
|
920
|
+
tier: {
|
|
921
|
+
type: 'number';
|
|
922
|
+
};
|
|
923
|
+
};
|
|
924
|
+
required: ['price', 'batch', 'threshold', 'hidden'];
|
|
925
|
+
type: 'object';
|
|
926
|
+
};
|
|
927
|
+
ssoProtection: {
|
|
928
|
+
description: 'Will be used to create an invoice item. The price must be in cents: 2000 for $20.';
|
|
929
|
+
properties: {
|
|
930
|
+
createdAt: {
|
|
931
|
+
type: 'number';
|
|
932
|
+
};
|
|
933
|
+
disabledAt: {
|
|
934
|
+
type: ['number', 'null'];
|
|
935
|
+
};
|
|
936
|
+
frequency: {
|
|
937
|
+
properties: {
|
|
938
|
+
interval: {
|
|
939
|
+
enum: ['month'];
|
|
940
|
+
type: 'string';
|
|
941
|
+
};
|
|
942
|
+
intervalCount: {
|
|
943
|
+
enum: [1, 3, 2, 6, 12];
|
|
944
|
+
type: 'number';
|
|
945
|
+
};
|
|
946
|
+
};
|
|
947
|
+
required: ['interval', 'intervalCount'];
|
|
948
|
+
type: 'object';
|
|
949
|
+
};
|
|
950
|
+
hidden: {
|
|
951
|
+
type: 'boolean';
|
|
952
|
+
};
|
|
953
|
+
maxQuantity: {
|
|
954
|
+
type: 'number';
|
|
955
|
+
};
|
|
956
|
+
name: {
|
|
957
|
+
type: 'string';
|
|
958
|
+
};
|
|
959
|
+
price: {
|
|
960
|
+
type: 'number';
|
|
961
|
+
};
|
|
962
|
+
quantity: {
|
|
963
|
+
type: 'number';
|
|
964
|
+
};
|
|
965
|
+
tier: {
|
|
966
|
+
type: 'number';
|
|
967
|
+
};
|
|
968
|
+
};
|
|
969
|
+
required: ['price', 'quantity', 'hidden'];
|
|
970
|
+
type: 'object';
|
|
971
|
+
};
|
|
972
|
+
teamSeats: {
|
|
973
|
+
description: 'Will be used to create an invoice item. The price must be in cents: 2000 for $20.';
|
|
974
|
+
properties: {
|
|
975
|
+
createdAt: {
|
|
976
|
+
type: 'number';
|
|
977
|
+
};
|
|
978
|
+
disabledAt: {
|
|
979
|
+
type: ['number', 'null'];
|
|
980
|
+
};
|
|
981
|
+
frequency: {
|
|
982
|
+
properties: {
|
|
983
|
+
interval: {
|
|
984
|
+
enum: ['month'];
|
|
985
|
+
type: 'string';
|
|
986
|
+
};
|
|
987
|
+
intervalCount: {
|
|
988
|
+
enum: [1, 3, 2, 6, 12];
|
|
989
|
+
type: 'number';
|
|
990
|
+
};
|
|
991
|
+
};
|
|
992
|
+
required: ['interval', 'intervalCount'];
|
|
993
|
+
type: 'object';
|
|
994
|
+
};
|
|
995
|
+
hidden: {
|
|
996
|
+
type: 'boolean';
|
|
997
|
+
};
|
|
998
|
+
maxQuantity: {
|
|
999
|
+
type: 'number';
|
|
1000
|
+
};
|
|
1001
|
+
name: {
|
|
1002
|
+
type: 'string';
|
|
1003
|
+
};
|
|
1004
|
+
price: {
|
|
1005
|
+
type: 'number';
|
|
1006
|
+
};
|
|
1007
|
+
quantity: {
|
|
1008
|
+
type: 'number';
|
|
1009
|
+
};
|
|
1010
|
+
tier: {
|
|
1011
|
+
type: 'number';
|
|
1012
|
+
};
|
|
1013
|
+
};
|
|
1014
|
+
required: ['price', 'quantity', 'hidden'];
|
|
1015
|
+
type: 'object';
|
|
1016
|
+
};
|
|
1017
|
+
webAnalytics: {
|
|
1018
|
+
description: 'Will be used to create an invoice item. The price must be in cents: 2000 for $20.';
|
|
1019
|
+
properties: {
|
|
1020
|
+
createdAt: {
|
|
1021
|
+
type: 'number';
|
|
1022
|
+
};
|
|
1023
|
+
disabledAt: {
|
|
1024
|
+
type: ['number', 'null'];
|
|
1025
|
+
};
|
|
1026
|
+
frequency: {
|
|
1027
|
+
properties: {
|
|
1028
|
+
interval: {
|
|
1029
|
+
enum: ['month'];
|
|
1030
|
+
type: 'string';
|
|
1031
|
+
};
|
|
1032
|
+
intervalCount: {
|
|
1033
|
+
enum: [1, 3, 2, 6, 12];
|
|
1034
|
+
type: 'number';
|
|
1035
|
+
};
|
|
1036
|
+
};
|
|
1037
|
+
required: ['interval', 'intervalCount'];
|
|
1038
|
+
type: 'object';
|
|
1039
|
+
};
|
|
1040
|
+
hidden: {
|
|
1041
|
+
type: 'boolean';
|
|
1042
|
+
};
|
|
1043
|
+
maxQuantity: {
|
|
1044
|
+
type: 'number';
|
|
1045
|
+
};
|
|
1046
|
+
name: {
|
|
1047
|
+
type: 'string';
|
|
1048
|
+
};
|
|
1049
|
+
price: {
|
|
1050
|
+
type: 'number';
|
|
1051
|
+
};
|
|
1052
|
+
quantity: {
|
|
1053
|
+
type: 'number';
|
|
1054
|
+
};
|
|
1055
|
+
tier: {
|
|
1056
|
+
type: 'number';
|
|
1057
|
+
};
|
|
1058
|
+
};
|
|
1059
|
+
required: ['price', 'quantity', 'hidden'];
|
|
1060
|
+
type: 'object';
|
|
1061
|
+
};
|
|
1062
|
+
webAnalyticsEvent: {
|
|
1063
|
+
properties: {
|
|
1064
|
+
batch: {
|
|
1065
|
+
type: 'number';
|
|
1066
|
+
};
|
|
1067
|
+
disabledAt: {
|
|
1068
|
+
type: ['number', 'null'];
|
|
1069
|
+
};
|
|
1070
|
+
hidden: {
|
|
1071
|
+
type: 'boolean';
|
|
1072
|
+
};
|
|
1073
|
+
name: {
|
|
1074
|
+
type: 'string';
|
|
1075
|
+
};
|
|
1076
|
+
price: {
|
|
1077
|
+
type: 'number';
|
|
1078
|
+
};
|
|
1079
|
+
threshold: {
|
|
1080
|
+
type: 'number';
|
|
1081
|
+
};
|
|
1082
|
+
tier: {
|
|
1083
|
+
type: 'number';
|
|
1084
|
+
};
|
|
1085
|
+
};
|
|
1086
|
+
required: ['price', 'batch', 'threshold', 'hidden'];
|
|
1087
|
+
type: 'object';
|
|
1088
|
+
};
|
|
1089
|
+
};
|
|
1090
|
+
type: ['object', 'null'];
|
|
1091
|
+
};
|
|
1092
|
+
invoiceSettings: {
|
|
1093
|
+
properties: {
|
|
1094
|
+
footer: {
|
|
1095
|
+
type: 'string';
|
|
1096
|
+
};
|
|
1097
|
+
};
|
|
1098
|
+
type: 'object';
|
|
1099
|
+
};
|
|
1100
|
+
language: {
|
|
1101
|
+
type: ['string', 'null'];
|
|
1102
|
+
};
|
|
1103
|
+
name: {
|
|
1104
|
+
type: ['string', 'null'];
|
|
1105
|
+
};
|
|
1106
|
+
orbCustomerId: {
|
|
1107
|
+
type: 'string';
|
|
1108
|
+
};
|
|
1109
|
+
overdue: {
|
|
1110
|
+
type: ['boolean', 'null'];
|
|
1111
|
+
};
|
|
1112
|
+
period: {
|
|
1113
|
+
properties: {
|
|
1114
|
+
end: {
|
|
1115
|
+
type: 'number';
|
|
1116
|
+
};
|
|
1117
|
+
start: {
|
|
1118
|
+
type: 'number';
|
|
1119
|
+
};
|
|
1120
|
+
};
|
|
1121
|
+
required: ['start', 'end'];
|
|
1122
|
+
type: ['object', 'null'];
|
|
1123
|
+
};
|
|
1124
|
+
plan: {
|
|
1125
|
+
enum: ['hobby', 'enterprise', 'pro'];
|
|
1126
|
+
type: 'string';
|
|
1127
|
+
};
|
|
1128
|
+
platform: {
|
|
1129
|
+
enum: ['stripe', 'stripeTestMode'];
|
|
1130
|
+
type: 'string';
|
|
1131
|
+
};
|
|
1132
|
+
pricingExperiment: {
|
|
1133
|
+
enum: ['august-2022'];
|
|
1134
|
+
type: 'string';
|
|
1135
|
+
};
|
|
1136
|
+
programType: {
|
|
1137
|
+
enum: ['startup', 'agency'];
|
|
1138
|
+
type: 'string';
|
|
1139
|
+
};
|
|
1140
|
+
purchaseOrder: {
|
|
1141
|
+
type: ['string', 'null'];
|
|
1142
|
+
};
|
|
1143
|
+
status: {
|
|
1144
|
+
enum: ['active', 'canceled', 'trialing', 'overdue', 'expired'];
|
|
1145
|
+
type: 'string';
|
|
1146
|
+
};
|
|
1147
|
+
subscriptions: {
|
|
1148
|
+
items: {
|
|
1149
|
+
properties: {
|
|
1150
|
+
discount: {
|
|
1151
|
+
properties: {
|
|
1152
|
+
coupon: {
|
|
1153
|
+
properties: {
|
|
1154
|
+
amountOff: {
|
|
1155
|
+
type: ['number', 'null'];
|
|
1156
|
+
};
|
|
1157
|
+
duration: {
|
|
1158
|
+
enum: ['forever', 'repeating', 'once'];
|
|
1159
|
+
type: 'string';
|
|
1160
|
+
};
|
|
1161
|
+
durationInMonths: {
|
|
1162
|
+
type: ['number', 'null'];
|
|
1163
|
+
};
|
|
1164
|
+
id: {
|
|
1165
|
+
type: 'string';
|
|
1166
|
+
};
|
|
1167
|
+
name: {
|
|
1168
|
+
type: ['string', 'null'];
|
|
1169
|
+
};
|
|
1170
|
+
percentageOff: {
|
|
1171
|
+
type: ['number', 'null'];
|
|
1172
|
+
};
|
|
1173
|
+
};
|
|
1174
|
+
required: ['id', 'name', 'amountOff', 'percentageOff', 'durationInMonths', 'duration'];
|
|
1175
|
+
type: 'object';
|
|
1176
|
+
};
|
|
1177
|
+
id: {
|
|
1178
|
+
type: 'string';
|
|
1179
|
+
};
|
|
1180
|
+
};
|
|
1181
|
+
required: ['id', 'coupon'];
|
|
1182
|
+
type: ['object', 'null'];
|
|
1183
|
+
};
|
|
1184
|
+
frequency: {
|
|
1185
|
+
properties: {
|
|
1186
|
+
interval: {
|
|
1187
|
+
enum: ['month', 'day', 'week', 'year'];
|
|
1188
|
+
type: 'string';
|
|
1189
|
+
};
|
|
1190
|
+
intervalCount: {
|
|
1191
|
+
type: 'number';
|
|
1192
|
+
};
|
|
1193
|
+
};
|
|
1194
|
+
required: ['interval', 'intervalCount'];
|
|
1195
|
+
type: 'object';
|
|
1196
|
+
};
|
|
1197
|
+
id: {
|
|
1198
|
+
type: 'string';
|
|
1199
|
+
};
|
|
1200
|
+
items: {
|
|
1201
|
+
items: {
|
|
1202
|
+
properties: {
|
|
1203
|
+
amount: {
|
|
1204
|
+
type: 'number';
|
|
1205
|
+
};
|
|
1206
|
+
id: {
|
|
1207
|
+
type: 'string';
|
|
1208
|
+
};
|
|
1209
|
+
priceId: {
|
|
1210
|
+
type: 'string';
|
|
1211
|
+
};
|
|
1212
|
+
productId: {
|
|
1213
|
+
type: 'string';
|
|
1214
|
+
};
|
|
1215
|
+
quantity: {
|
|
1216
|
+
type: 'number';
|
|
1217
|
+
};
|
|
1218
|
+
};
|
|
1219
|
+
required: ['id', 'priceId', 'productId', 'amount', 'quantity'];
|
|
1220
|
+
type: 'object';
|
|
1221
|
+
};
|
|
1222
|
+
type: 'array';
|
|
1223
|
+
};
|
|
1224
|
+
period: {
|
|
1225
|
+
properties: {
|
|
1226
|
+
end: {
|
|
1227
|
+
type: 'number';
|
|
1228
|
+
};
|
|
1229
|
+
start: {
|
|
1230
|
+
type: 'number';
|
|
1231
|
+
};
|
|
1232
|
+
};
|
|
1233
|
+
required: ['start', 'end'];
|
|
1234
|
+
type: 'object';
|
|
1235
|
+
};
|
|
1236
|
+
trial: {
|
|
1237
|
+
properties: {
|
|
1238
|
+
end: {
|
|
1239
|
+
type: 'number';
|
|
1240
|
+
};
|
|
1241
|
+
start: {
|
|
1242
|
+
type: 'number';
|
|
1243
|
+
};
|
|
1244
|
+
};
|
|
1245
|
+
required: ['start', 'end'];
|
|
1246
|
+
type: ['object', 'null'];
|
|
1247
|
+
};
|
|
1248
|
+
};
|
|
1249
|
+
required: ['id', 'trial', 'period', 'frequency', 'discount', 'items'];
|
|
1250
|
+
type: 'object';
|
|
1251
|
+
};
|
|
1252
|
+
type: ['array', 'null'];
|
|
1253
|
+
};
|
|
1254
|
+
tax: {
|
|
1255
|
+
properties: {
|
|
1256
|
+
id: {
|
|
1257
|
+
type: 'string';
|
|
1258
|
+
};
|
|
1259
|
+
type: {
|
|
1260
|
+
type: 'string';
|
|
1261
|
+
};
|
|
1262
|
+
};
|
|
1263
|
+
required: ['type', 'id'];
|
|
1264
|
+
type: ['object', 'null'];
|
|
1265
|
+
};
|
|
1266
|
+
trial: {
|
|
1267
|
+
properties: {
|
|
1268
|
+
end: {
|
|
1269
|
+
type: 'number';
|
|
1270
|
+
};
|
|
1271
|
+
start: {
|
|
1272
|
+
type: 'number';
|
|
1273
|
+
};
|
|
1274
|
+
};
|
|
1275
|
+
required: ['start', 'end'];
|
|
1276
|
+
type: ['object', 'null'];
|
|
1277
|
+
};
|
|
1278
|
+
};
|
|
1279
|
+
required: ['period', 'plan'];
|
|
1280
|
+
type: ['object', 'null'];
|
|
1281
|
+
};
|
|
1282
|
+
createdAt: {
|
|
1283
|
+
description: 'UNIX timestamp (in milliseconds) when the User account was created.';
|
|
1284
|
+
examples: [1630748523395];
|
|
1285
|
+
type: 'number';
|
|
1286
|
+
};
|
|
1287
|
+
dismissedToasts: {
|
|
1288
|
+
description: 'A record of when, under a certain scopeId, a toast was dismissed';
|
|
1289
|
+
items: {
|
|
1290
|
+
description: 'A record of when, under a certain scopeId, a toast was dismissed';
|
|
1291
|
+
properties: {
|
|
1292
|
+
dismissals: {
|
|
1293
|
+
items: {
|
|
1294
|
+
properties: {
|
|
1295
|
+
createdAt: {
|
|
1296
|
+
type: 'number';
|
|
1297
|
+
};
|
|
1298
|
+
scopeId: {
|
|
1299
|
+
type: 'string';
|
|
1300
|
+
};
|
|
1301
|
+
};
|
|
1302
|
+
required: ['scopeId', 'createdAt'];
|
|
1303
|
+
type: 'object';
|
|
1304
|
+
};
|
|
1305
|
+
type: 'array';
|
|
1306
|
+
};
|
|
1307
|
+
name: {
|
|
1308
|
+
type: 'string';
|
|
1309
|
+
};
|
|
1310
|
+
};
|
|
1311
|
+
required: ['name', 'dismissals'];
|
|
1312
|
+
type: 'object';
|
|
1313
|
+
};
|
|
1314
|
+
type: 'array';
|
|
1315
|
+
};
|
|
1316
|
+
email: {
|
|
1317
|
+
description: 'Email address associated with the User account.';
|
|
1318
|
+
examples: ['me@example.com'];
|
|
1319
|
+
type: 'string';
|
|
1320
|
+
};
|
|
1321
|
+
favoriteProjects: {
|
|
1322
|
+
description: 'A list of projects across teams that a user has marked as a favorite.';
|
|
1323
|
+
items: {
|
|
1324
|
+
description: 'A list of projects across teams that a user has marked as a favorite.';
|
|
1325
|
+
properties: {
|
|
1326
|
+
projectId: {
|
|
1327
|
+
type: 'string';
|
|
1328
|
+
};
|
|
1329
|
+
scopeId: {
|
|
1330
|
+
type: 'string';
|
|
1331
|
+
};
|
|
1332
|
+
scopeSlug: {
|
|
1333
|
+
type: 'string';
|
|
1334
|
+
};
|
|
1335
|
+
};
|
|
1336
|
+
required: ['projectId', 'scopeId', 'scopeSlug'];
|
|
1337
|
+
type: 'object';
|
|
1338
|
+
};
|
|
1339
|
+
type: 'array';
|
|
1340
|
+
};
|
|
1341
|
+
hasTrialAvailable: {
|
|
1342
|
+
description: 'Whether the user has a trial available for a paid plan subscription.';
|
|
1343
|
+
type: 'boolean';
|
|
1344
|
+
};
|
|
1345
|
+
id: {
|
|
1346
|
+
description: "The User's unique identifier.";
|
|
1347
|
+
examples: ['AEIIDYVk59zbFF2Sxfyxxmua'];
|
|
1348
|
+
type: 'string';
|
|
1349
|
+
};
|
|
1350
|
+
importFlowGitNamespace: {
|
|
1351
|
+
oneOf: [
|
|
1352
|
+
{
|
|
1353
|
+
type: 'string';
|
|
1354
|
+
},
|
|
1355
|
+
{
|
|
1356
|
+
type: 'number';
|
|
1357
|
+
},
|
|
1358
|
+
];
|
|
1359
|
+
type: 'null';
|
|
1360
|
+
};
|
|
1361
|
+
importFlowGitNamespaceId: {
|
|
1362
|
+
oneOf: [
|
|
1363
|
+
{
|
|
1364
|
+
type: 'string';
|
|
1365
|
+
},
|
|
1366
|
+
{
|
|
1367
|
+
type: 'number';
|
|
1368
|
+
},
|
|
1369
|
+
];
|
|
1370
|
+
type: 'null';
|
|
1371
|
+
};
|
|
1372
|
+
importFlowGitProvider: {
|
|
1373
|
+
enum: ['github', 'gitlab', 'bitbucket'];
|
|
1374
|
+
type: 'string';
|
|
1375
|
+
};
|
|
1376
|
+
name: {
|
|
1377
|
+
description: 'Name associated with the User account, or `null` if none has been provided.';
|
|
1378
|
+
examples: ['John Doe'];
|
|
1379
|
+
type: ['string', 'null'];
|
|
1380
|
+
};
|
|
1381
|
+
preferredScopesAndGitNamespaces: {
|
|
1382
|
+
items: {
|
|
1383
|
+
properties: {
|
|
1384
|
+
gitNamespaceId: {
|
|
1385
|
+
oneOf: [
|
|
1386
|
+
{
|
|
1387
|
+
type: 'string';
|
|
1388
|
+
},
|
|
1389
|
+
{
|
|
1390
|
+
type: 'number';
|
|
1391
|
+
},
|
|
1392
|
+
];
|
|
1393
|
+
type: 'null';
|
|
1394
|
+
};
|
|
1395
|
+
scopeId: {
|
|
1396
|
+
type: 'string';
|
|
1397
|
+
};
|
|
1398
|
+
};
|
|
1399
|
+
required: ['scopeId', 'gitNamespaceId'];
|
|
1400
|
+
type: 'object';
|
|
1401
|
+
};
|
|
1402
|
+
type: 'array';
|
|
1403
|
+
};
|
|
1404
|
+
remoteCaching: {
|
|
1405
|
+
description: 'remote caching settings';
|
|
1406
|
+
properties: {
|
|
1407
|
+
enabled: {
|
|
1408
|
+
type: 'boolean';
|
|
1409
|
+
};
|
|
1410
|
+
};
|
|
1411
|
+
type: 'object';
|
|
1412
|
+
};
|
|
1413
|
+
resourceConfig: {
|
|
1414
|
+
description: 'An object containing infomation related to the amount of platform resources may be allocated to the User account.';
|
|
1415
|
+
properties: {
|
|
1416
|
+
awsAccountIds: {
|
|
1417
|
+
items: {
|
|
1418
|
+
type: 'string';
|
|
1419
|
+
};
|
|
1420
|
+
type: 'array';
|
|
1421
|
+
};
|
|
1422
|
+
awsAccountType: {
|
|
1423
|
+
type: 'string';
|
|
1424
|
+
};
|
|
1425
|
+
cfZoneName: {
|
|
1426
|
+
type: 'string';
|
|
1427
|
+
};
|
|
1428
|
+
concurrentBuilds: {
|
|
1429
|
+
type: 'number';
|
|
1430
|
+
};
|
|
1431
|
+
edgeConfigSize: {
|
|
1432
|
+
description: 'To overwrite the maximum size of an Edge Config per account. Size is in kilobytes, eg 64 leads to 64kB or 64_000 bytes worth of storage';
|
|
1433
|
+
type: 'number';
|
|
1434
|
+
};
|
|
1435
|
+
edgeConfigs: {
|
|
1436
|
+
description: 'To overwrite the number of Edge Configs an account can create.';
|
|
1437
|
+
type: 'number';
|
|
1438
|
+
};
|
|
1439
|
+
nodeType: {
|
|
1440
|
+
type: 'string';
|
|
1441
|
+
};
|
|
1442
|
+
};
|
|
1443
|
+
type: 'object';
|
|
1444
|
+
};
|
|
1445
|
+
softBlock: {
|
|
1446
|
+
description: 'When the User account has been "soft blocked", this property will contain the date when the restriction was enacted, and the identifier for why.';
|
|
1447
|
+
properties: {
|
|
1448
|
+
blockedAt: {
|
|
1449
|
+
type: 'number';
|
|
1450
|
+
};
|
|
1451
|
+
reason: {
|
|
1452
|
+
enum: [
|
|
1453
|
+
'FAIR_USE_LIMITS_EXCEEDED',
|
|
1454
|
+
'ENTERPRISE_TRIAL_ENDED',
|
|
1455
|
+
'BLOCKED_FOR_PLATFORM_ABUSE',
|
|
1456
|
+
'UNPAID_INVOICE',
|
|
1457
|
+
'SUBSCRIPTION_EXPIRED',
|
|
1458
|
+
'SUBSCRIPTION_CANCELED',
|
|
1459
|
+
];
|
|
1460
|
+
type: 'string';
|
|
1461
|
+
};
|
|
1462
|
+
};
|
|
1463
|
+
required: ['blockedAt', 'reason'];
|
|
1464
|
+
type: ['object', 'null'];
|
|
1465
|
+
};
|
|
1466
|
+
stagingPrefix: {
|
|
1467
|
+
description: 'Prefix that will be used in the URL of "Preview" deployments created by the User account.';
|
|
1468
|
+
type: 'string';
|
|
1469
|
+
};
|
|
1470
|
+
username: {
|
|
1471
|
+
description: 'Unique username associated with the User account.';
|
|
1472
|
+
examples: ['jdoe'];
|
|
1473
|
+
type: 'string';
|
|
1474
|
+
};
|
|
1475
|
+
};
|
|
1476
|
+
required: [
|
|
1477
|
+
'createdAt',
|
|
1478
|
+
'softBlock',
|
|
1479
|
+
'billing',
|
|
1480
|
+
'resourceConfig',
|
|
1481
|
+
'stagingPrefix',
|
|
1482
|
+
'hasTrialAvailable',
|
|
1483
|
+
'id',
|
|
1484
|
+
'email',
|
|
1485
|
+
'name',
|
|
1486
|
+
'username',
|
|
1487
|
+
'avatar',
|
|
1488
|
+
];
|
|
1489
|
+
type: 'object';
|
|
1490
|
+
};
|
|
1491
|
+
AuthUserLimited: {
|
|
1492
|
+
description: 'A limited form of data for the currently authenticated User, due to the authentication token missing privileges to read the full User data.';
|
|
1493
|
+
properties: {
|
|
1494
|
+
avatar: {
|
|
1495
|
+
description: 'SHA1 hash of the avatar for the User account. Can be used in conjuction with the ... endpoint to retrieve the avatar image.';
|
|
1496
|
+
examples: ['22cb30c85ff45ac4c72de8981500006b28114aa1'];
|
|
1497
|
+
type: ['string', 'null'];
|
|
1498
|
+
};
|
|
1499
|
+
email: {
|
|
1500
|
+
description: 'Email address associated with the User account.';
|
|
1501
|
+
examples: ['me@example.com'];
|
|
1502
|
+
type: 'string';
|
|
1503
|
+
};
|
|
1504
|
+
id: {
|
|
1505
|
+
description: "The User's unique identifier.";
|
|
1506
|
+
examples: ['AEIIDYVk59zbFF2Sxfyxxmua'];
|
|
1507
|
+
type: 'string';
|
|
1508
|
+
};
|
|
1509
|
+
limited: {
|
|
1510
|
+
description: 'Property indicating that this User data contains only limited information, due to the authentication token missing privileges to read the full User data. Re-login with email, GitHub, GitLab or Bitbucket in order to upgrade the authentication token with the necessary privileges.';
|
|
1511
|
+
type: 'boolean';
|
|
1512
|
+
};
|
|
1513
|
+
name: {
|
|
1514
|
+
description: 'Name associated with the User account, or `null` if none has been provided.';
|
|
1515
|
+
examples: ['John Doe'];
|
|
1516
|
+
type: ['string', 'null'];
|
|
1517
|
+
};
|
|
1518
|
+
username: {
|
|
1519
|
+
description: 'Unique username associated with the User account.';
|
|
1520
|
+
examples: ['jdoe'];
|
|
1521
|
+
type: 'string';
|
|
1522
|
+
};
|
|
1523
|
+
};
|
|
1524
|
+
required: ['limited', 'id', 'email', 'name', 'username', 'avatar'];
|
|
1525
|
+
type: 'object';
|
|
1526
|
+
};
|
|
1527
|
+
EdgeConfigItem: {
|
|
1528
|
+
description: 'The EdgeConfig.';
|
|
1529
|
+
properties: {
|
|
1530
|
+
createdAt: {
|
|
1531
|
+
type: 'number';
|
|
1532
|
+
};
|
|
1533
|
+
edgeConfigId: {
|
|
1534
|
+
type: 'string';
|
|
1535
|
+
};
|
|
1536
|
+
key: {
|
|
1537
|
+
type: 'string';
|
|
1538
|
+
};
|
|
1539
|
+
updatedAt: {
|
|
1540
|
+
type: 'number';
|
|
1541
|
+
};
|
|
1542
|
+
value: {
|
|
1543
|
+
$ref: '#/components/schemas/EdgeConfigItemValue';
|
|
1544
|
+
};
|
|
1545
|
+
};
|
|
1546
|
+
required: ['key', 'value', 'edgeConfigId', 'createdAt', 'updatedAt'];
|
|
1547
|
+
type: 'object';
|
|
1548
|
+
};
|
|
1549
|
+
EdgeConfigItemValue: {
|
|
1550
|
+
oneOf: [
|
|
1551
|
+
{
|
|
1552
|
+
type: 'string';
|
|
1553
|
+
},
|
|
1554
|
+
{
|
|
1555
|
+
type: 'number';
|
|
1556
|
+
},
|
|
1557
|
+
{
|
|
1558
|
+
type: 'boolean';
|
|
1559
|
+
},
|
|
1560
|
+
{
|
|
1561
|
+
type: 'object';
|
|
1562
|
+
},
|
|
1563
|
+
{
|
|
1564
|
+
items: {
|
|
1565
|
+
$ref: '#/components/schemas/EdgeConfigItemValue';
|
|
1566
|
+
};
|
|
1567
|
+
type: 'array';
|
|
1568
|
+
},
|
|
1569
|
+
];
|
|
1570
|
+
type: 'null';
|
|
1571
|
+
};
|
|
1572
|
+
EdgeConfigToken: {
|
|
1573
|
+
description: 'The EdgeConfig.';
|
|
1574
|
+
properties: {
|
|
1575
|
+
createdAt: {
|
|
1576
|
+
type: 'number';
|
|
1577
|
+
};
|
|
1578
|
+
edgeConfigId: {
|
|
1579
|
+
type: 'string';
|
|
1580
|
+
};
|
|
1581
|
+
id: {
|
|
1582
|
+
description: 'This is not the token itself, but rather an id to identify the token by';
|
|
1583
|
+
type: 'string';
|
|
1584
|
+
};
|
|
1585
|
+
label: {
|
|
1586
|
+
type: 'string';
|
|
1587
|
+
};
|
|
1588
|
+
token: {
|
|
1589
|
+
type: 'string';
|
|
1590
|
+
};
|
|
1591
|
+
};
|
|
1592
|
+
required: ['token', 'label', 'id', 'edgeConfigId', 'createdAt'];
|
|
1593
|
+
type: 'object';
|
|
1594
|
+
};
|
|
1595
|
+
FileTree: {
|
|
1596
|
+
description: 'A deployment file tree entry';
|
|
1597
|
+
properties: {
|
|
1598
|
+
children: {
|
|
1599
|
+
description: 'The list of children files of the directory (only valid for the `directory` type)';
|
|
1600
|
+
items: {
|
|
1601
|
+
$ref: '#/components/schemas/FileTree';
|
|
1602
|
+
};
|
|
1603
|
+
type: 'array';
|
|
1604
|
+
};
|
|
1605
|
+
contentType: {
|
|
1606
|
+
description: 'The content-type of the file (only valid for the `file` type)';
|
|
1607
|
+
examples: ['application/json'];
|
|
1608
|
+
type: 'string';
|
|
1609
|
+
};
|
|
1610
|
+
mode: {
|
|
1611
|
+
description: 'The file "mode" indicating file type and permissions.';
|
|
1612
|
+
type: 'number';
|
|
1613
|
+
};
|
|
1614
|
+
name: {
|
|
1615
|
+
description: 'The name of the file tree entry';
|
|
1616
|
+
examples: ['my-file.json'];
|
|
1617
|
+
type: 'string';
|
|
1618
|
+
};
|
|
1619
|
+
symlink: {
|
|
1620
|
+
description: 'Not currently used. See `file-list-to-tree.ts`.';
|
|
1621
|
+
type: 'string';
|
|
1622
|
+
};
|
|
1623
|
+
type: {
|
|
1624
|
+
description: 'String indicating the type of file tree entry.';
|
|
1625
|
+
enum: ['directory', 'file', 'symlink', 'lambda', 'middleware', 'invalid'];
|
|
1626
|
+
examples: ['file'];
|
|
1627
|
+
type: 'string';
|
|
1628
|
+
};
|
|
1629
|
+
uid: {
|
|
1630
|
+
description: 'The unique identifier of the file (only valid for the `file` type)';
|
|
1631
|
+
examples: ['2d4aad419917f15b1146e9e03ddc9bb31747e4d0'];
|
|
1632
|
+
type: 'string';
|
|
1633
|
+
};
|
|
1634
|
+
};
|
|
1635
|
+
required: ['name', 'type', 'mode'];
|
|
1636
|
+
type: 'object';
|
|
1637
|
+
};
|
|
1638
|
+
Pagination: {
|
|
1639
|
+
description: 'This object contains information related to the pagination of the current request, including the necessary parameters to get the next or previous page of data.';
|
|
1640
|
+
properties: {
|
|
1641
|
+
count: {
|
|
1642
|
+
description: 'Amount of items in the current page.';
|
|
1643
|
+
examples: [20];
|
|
1644
|
+
type: 'number';
|
|
1645
|
+
};
|
|
1646
|
+
next: {
|
|
1647
|
+
description: 'Timestamp that must be used to request the next page.';
|
|
1648
|
+
examples: [1540095775951];
|
|
1649
|
+
type: ['number', 'null'];
|
|
1650
|
+
};
|
|
1651
|
+
prev: {
|
|
1652
|
+
description: 'Timestamp that must be used to request the previous page.';
|
|
1653
|
+
examples: [1540095775951];
|
|
1654
|
+
type: ['number', 'null'];
|
|
1655
|
+
};
|
|
1656
|
+
};
|
|
1657
|
+
required: ['count', 'next', 'prev'];
|
|
1658
|
+
type: 'object';
|
|
1659
|
+
};
|
|
1660
|
+
Team: {
|
|
1661
|
+
description: 'Data representing a Team.';
|
|
1662
|
+
type: 'object';
|
|
1663
|
+
};
|
|
1664
|
+
TeamLimited: {
|
|
1665
|
+
description: 'A limited form of data representing a Team, due to the authentication token missing privileges to read the full Team data.';
|
|
1666
|
+
properties: {
|
|
1667
|
+
avatar: {
|
|
1668
|
+
description: 'The ID of the file used as avatar for this Team.';
|
|
1669
|
+
examples: ['6eb07268bcfadd309905ffb1579354084c24655c'];
|
|
1670
|
+
type: ['string', 'null'];
|
|
1671
|
+
};
|
|
1672
|
+
created: {
|
|
1673
|
+
description: 'Will remain undocumented. Remove in v3 API.';
|
|
1674
|
+
type: 'string';
|
|
1675
|
+
};
|
|
1676
|
+
createdAt: {
|
|
1677
|
+
description: 'UNIX timestamp (in milliseconds) when the Team was created.';
|
|
1678
|
+
examples: [1630748523395];
|
|
1679
|
+
type: 'number';
|
|
1680
|
+
};
|
|
1681
|
+
id: {
|
|
1682
|
+
description: "The Team's unique identifier.";
|
|
1683
|
+
examples: ['team_nllPyCtREAqxxdyFKbbMDlxd'];
|
|
1684
|
+
type: 'string';
|
|
1685
|
+
};
|
|
1686
|
+
limited: {
|
|
1687
|
+
description: "Property indicating that this Team data contains only limited information, due to the authentication token missing privileges to read the full Team data. Re-login with the Team's configured SAML Single Sign-On provider in order to upgrade the authentication token with the necessary privileges.";
|
|
1688
|
+
type: 'boolean';
|
|
1689
|
+
};
|
|
1690
|
+
membership: {
|
|
1691
|
+
oneOf: [
|
|
1692
|
+
{
|
|
1693
|
+
description: 'The membership of the authenticated User in relation to the Team.';
|
|
1694
|
+
properties: {
|
|
1695
|
+
accessRequestedAt: {
|
|
1696
|
+
type: 'number';
|
|
1697
|
+
};
|
|
1698
|
+
confirmed: {
|
|
1699
|
+
type: 'boolean';
|
|
1700
|
+
};
|
|
1701
|
+
confirmedAt: {
|
|
1702
|
+
type: 'number';
|
|
1703
|
+
};
|
|
1704
|
+
created: {
|
|
1705
|
+
type: 'number';
|
|
1706
|
+
};
|
|
1707
|
+
createdAt: {
|
|
1708
|
+
type: 'number';
|
|
1709
|
+
};
|
|
1710
|
+
joinedFrom: {
|
|
1711
|
+
properties: {
|
|
1712
|
+
commitId: {
|
|
1713
|
+
type: 'string';
|
|
1714
|
+
};
|
|
1715
|
+
dsyncConnectedAt: {
|
|
1716
|
+
type: 'number';
|
|
1717
|
+
};
|
|
1718
|
+
dsyncUserId: {
|
|
1719
|
+
type: 'string';
|
|
1720
|
+
};
|
|
1721
|
+
gitUserId: {
|
|
1722
|
+
oneOf: [
|
|
1723
|
+
{
|
|
1724
|
+
type: 'string';
|
|
1725
|
+
},
|
|
1726
|
+
{
|
|
1727
|
+
type: 'number';
|
|
1728
|
+
},
|
|
1729
|
+
];
|
|
1730
|
+
};
|
|
1731
|
+
gitUserLogin: {
|
|
1732
|
+
type: 'string';
|
|
1733
|
+
};
|
|
1734
|
+
idpUserId: {
|
|
1735
|
+
type: 'string';
|
|
1736
|
+
};
|
|
1737
|
+
origin: {
|
|
1738
|
+
enum: [
|
|
1739
|
+
'import',
|
|
1740
|
+
'saml',
|
|
1741
|
+
'mail',
|
|
1742
|
+
'link',
|
|
1743
|
+
'teams',
|
|
1744
|
+
'github',
|
|
1745
|
+
'gitlab',
|
|
1746
|
+
'bitbucket',
|
|
1747
|
+
'dsync',
|
|
1748
|
+
'feedback',
|
|
1749
|
+
'organization-teams',
|
|
1750
|
+
];
|
|
1751
|
+
type: 'string';
|
|
1752
|
+
};
|
|
1753
|
+
repoId: {
|
|
1754
|
+
type: 'string';
|
|
1755
|
+
};
|
|
1756
|
+
repoPath: {
|
|
1757
|
+
type: 'string';
|
|
1758
|
+
};
|
|
1759
|
+
ssoConnectedAt: {
|
|
1760
|
+
type: 'number';
|
|
1761
|
+
};
|
|
1762
|
+
ssoUserId: {
|
|
1763
|
+
type: 'string';
|
|
1764
|
+
};
|
|
1765
|
+
};
|
|
1766
|
+
required: ['origin'];
|
|
1767
|
+
type: 'object';
|
|
1768
|
+
};
|
|
1769
|
+
role: {
|
|
1770
|
+
enum: ['MEMBER', 'OWNER', 'VIEWER', 'DEVELOPER', 'BILLING'];
|
|
1771
|
+
type: 'string';
|
|
1772
|
+
};
|
|
1773
|
+
teamId: {
|
|
1774
|
+
type: 'string';
|
|
1775
|
+
};
|
|
1776
|
+
uid: {
|
|
1777
|
+
type: 'string';
|
|
1778
|
+
};
|
|
1779
|
+
};
|
|
1780
|
+
required: ['confirmed', 'confirmedAt', 'role', 'uid', 'createdAt', 'created'];
|
|
1781
|
+
type: 'object';
|
|
1782
|
+
},
|
|
1783
|
+
{
|
|
1784
|
+
description: 'The membership of the authenticated User in relation to the Team.';
|
|
1785
|
+
properties: {
|
|
1786
|
+
accessRequestedAt: {
|
|
1787
|
+
type: 'number';
|
|
1788
|
+
};
|
|
1789
|
+
confirmed: {
|
|
1790
|
+
type: 'boolean';
|
|
1791
|
+
};
|
|
1792
|
+
confirmedAt: {
|
|
1793
|
+
type: 'number';
|
|
1794
|
+
};
|
|
1795
|
+
created: {
|
|
1796
|
+
type: 'number';
|
|
1797
|
+
};
|
|
1798
|
+
createdAt: {
|
|
1799
|
+
type: 'number';
|
|
1800
|
+
};
|
|
1801
|
+
joinedFrom: {
|
|
1802
|
+
properties: {
|
|
1803
|
+
commitId: {
|
|
1804
|
+
type: 'string';
|
|
1805
|
+
};
|
|
1806
|
+
dsyncConnectedAt: {
|
|
1807
|
+
type: 'number';
|
|
1808
|
+
};
|
|
1809
|
+
dsyncUserId: {
|
|
1810
|
+
type: 'string';
|
|
1811
|
+
};
|
|
1812
|
+
gitUserId: {
|
|
1813
|
+
oneOf: [
|
|
1814
|
+
{
|
|
1815
|
+
type: 'string';
|
|
1816
|
+
},
|
|
1817
|
+
{
|
|
1818
|
+
type: 'number';
|
|
1819
|
+
},
|
|
1820
|
+
];
|
|
1821
|
+
};
|
|
1822
|
+
gitUserLogin: {
|
|
1823
|
+
type: 'string';
|
|
1824
|
+
};
|
|
1825
|
+
idpUserId: {
|
|
1826
|
+
type: 'string';
|
|
1827
|
+
};
|
|
1828
|
+
origin: {
|
|
1829
|
+
enum: [
|
|
1830
|
+
'import',
|
|
1831
|
+
'saml',
|
|
1832
|
+
'mail',
|
|
1833
|
+
'link',
|
|
1834
|
+
'teams',
|
|
1835
|
+
'github',
|
|
1836
|
+
'gitlab',
|
|
1837
|
+
'bitbucket',
|
|
1838
|
+
'dsync',
|
|
1839
|
+
'feedback',
|
|
1840
|
+
'organization-teams',
|
|
1841
|
+
];
|
|
1842
|
+
type: 'string';
|
|
1843
|
+
};
|
|
1844
|
+
repoId: {
|
|
1845
|
+
type: 'string';
|
|
1846
|
+
};
|
|
1847
|
+
repoPath: {
|
|
1848
|
+
type: 'string';
|
|
1849
|
+
};
|
|
1850
|
+
ssoConnectedAt: {
|
|
1851
|
+
type: 'number';
|
|
1852
|
+
};
|
|
1853
|
+
ssoUserId: {
|
|
1854
|
+
type: 'string';
|
|
1855
|
+
};
|
|
1856
|
+
};
|
|
1857
|
+
required: ['origin'];
|
|
1858
|
+
type: 'object';
|
|
1859
|
+
};
|
|
1860
|
+
role: {
|
|
1861
|
+
enum: ['MEMBER', 'OWNER', 'VIEWER', 'DEVELOPER', 'BILLING'];
|
|
1862
|
+
type: 'string';
|
|
1863
|
+
};
|
|
1864
|
+
teamId: {
|
|
1865
|
+
type: 'string';
|
|
1866
|
+
};
|
|
1867
|
+
uid: {
|
|
1868
|
+
type: 'string';
|
|
1869
|
+
};
|
|
1870
|
+
};
|
|
1871
|
+
required: ['confirmed', 'accessRequestedAt', 'role', 'uid', 'createdAt', 'created'];
|
|
1872
|
+
type: 'object';
|
|
1873
|
+
},
|
|
1874
|
+
];
|
|
1875
|
+
};
|
|
1876
|
+
name: {
|
|
1877
|
+
description: 'Name associated with the Team account, or `null` if none has been provided.';
|
|
1878
|
+
examples: ['My Team'];
|
|
1879
|
+
type: ['string', 'null'];
|
|
1880
|
+
};
|
|
1881
|
+
saml: {
|
|
1882
|
+
description: 'When "Single Sign-On (SAML)" is configured, this object contains information that allows the client-side to identify whether or not this Team has SAML enforced.';
|
|
1883
|
+
properties: {
|
|
1884
|
+
connection: {
|
|
1885
|
+
description: 'From T, pick a set of properties whose keys are in the union K';
|
|
1886
|
+
properties: {
|
|
1887
|
+
createdAt: {
|
|
1888
|
+
type: ['number', 'null'];
|
|
1889
|
+
};
|
|
1890
|
+
creator: {
|
|
1891
|
+
type: 'string';
|
|
1892
|
+
};
|
|
1893
|
+
domain: {
|
|
1894
|
+
type: 'string';
|
|
1895
|
+
};
|
|
1896
|
+
id: {
|
|
1897
|
+
type: 'string';
|
|
1898
|
+
};
|
|
1899
|
+
name: {
|
|
1900
|
+
type: 'string';
|
|
1901
|
+
};
|
|
1902
|
+
recordType: {
|
|
1903
|
+
enum: ['A', 'AAAA', 'ALIAS', 'CAA', 'CNAME', 'MX', 'SRV', 'TXT', 'NS'];
|
|
1904
|
+
type: 'string';
|
|
1905
|
+
};
|
|
1906
|
+
ttl: {
|
|
1907
|
+
type: 'number';
|
|
1908
|
+
};
|
|
1909
|
+
type: {
|
|
1910
|
+
enum: ['record', 'record-sys'];
|
|
1911
|
+
type: 'string';
|
|
1912
|
+
};
|
|
1913
|
+
value: {
|
|
1914
|
+
type: 'string';
|
|
1915
|
+
};
|
|
1916
|
+
};
|
|
1917
|
+
required: ['creator', 'domain', 'id', 'name', 'recordType', 'type', 'value'];
|
|
1918
|
+
type: 'object';
|
|
1919
|
+
};
|
|
1920
|
+
directory: {
|
|
1921
|
+
description: 'From T, pick a set of properties whose keys are in the union K';
|
|
1922
|
+
properties: {
|
|
1923
|
+
createdAt: {
|
|
1924
|
+
type: ['number', 'null'];
|
|
1925
|
+
};
|
|
1926
|
+
creator: {
|
|
1927
|
+
type: 'string';
|
|
1928
|
+
};
|
|
1929
|
+
domain: {
|
|
1930
|
+
type: 'string';
|
|
1931
|
+
};
|
|
1932
|
+
id: {
|
|
1933
|
+
type: 'string';
|
|
1934
|
+
};
|
|
1935
|
+
name: {
|
|
1936
|
+
type: 'string';
|
|
1937
|
+
};
|
|
1938
|
+
recordType: {
|
|
1939
|
+
enum: ['A', 'AAAA', 'ALIAS', 'CAA', 'CNAME', 'MX', 'SRV', 'TXT', 'NS'];
|
|
1940
|
+
type: 'string';
|
|
1941
|
+
};
|
|
1942
|
+
ttl: {
|
|
1943
|
+
type: 'number';
|
|
1944
|
+
};
|
|
1945
|
+
type: {
|
|
1946
|
+
enum: ['record', 'record-sys'];
|
|
1947
|
+
type: 'string';
|
|
1948
|
+
};
|
|
1949
|
+
value: {
|
|
1950
|
+
type: 'string';
|
|
1951
|
+
};
|
|
1952
|
+
};
|
|
1953
|
+
required: ['creator', 'domain', 'id', 'name', 'recordType', 'type', 'value'];
|
|
1954
|
+
type: 'object';
|
|
1955
|
+
};
|
|
1956
|
+
enforced: {
|
|
1957
|
+
description: "When `true`, interactions with the Team **must** be done with an authentication token that has been authenticated with the Team's SAML Single Sign-On provider.";
|
|
1958
|
+
type: 'boolean';
|
|
1959
|
+
};
|
|
1960
|
+
};
|
|
1961
|
+
required: ['enforced'];
|
|
1962
|
+
type: 'object';
|
|
1963
|
+
};
|
|
1964
|
+
slug: {
|
|
1965
|
+
description: "The Team's slug, which is unique across the Vercel platform.";
|
|
1966
|
+
examples: ['my-team'];
|
|
1967
|
+
type: 'string';
|
|
1968
|
+
};
|
|
1969
|
+
};
|
|
1970
|
+
required: ['limited', 'id', 'slug', 'name', 'avatar', 'membership', 'created', 'createdAt'];
|
|
1971
|
+
type: 'object';
|
|
1972
|
+
};
|
|
1973
|
+
UserEvent: {
|
|
1974
|
+
description: 'Array of events generated by the User.';
|
|
1975
|
+
properties: {
|
|
1976
|
+
createdAt: {
|
|
1977
|
+
description: 'Timestamp (in milliseconds) of when the event was generated.';
|
|
1978
|
+
examples: [1632859321020];
|
|
1979
|
+
type: 'number';
|
|
1980
|
+
};
|
|
1981
|
+
entities: {
|
|
1982
|
+
description: 'A list of "entities" within the event `text`. Useful for enhancing the displayed text with additional styling and links.';
|
|
1983
|
+
items: {
|
|
1984
|
+
description: 'A list of "entities" within the event `text`. Useful for enhancing the displayed text with additional styling and links.';
|
|
1985
|
+
properties: {
|
|
1986
|
+
end: {
|
|
1987
|
+
description: 'The index of where the entity ends within the `text` (non-inclusive).';
|
|
1988
|
+
examples: [3];
|
|
1989
|
+
type: 'number';
|
|
1990
|
+
};
|
|
1991
|
+
start: {
|
|
1992
|
+
description: 'The index of where the entity begins within the `text` (inclusive).';
|
|
1993
|
+
examples: [0];
|
|
1994
|
+
type: 'number';
|
|
1995
|
+
};
|
|
1996
|
+
type: {
|
|
1997
|
+
description: 'The type of entity.';
|
|
1998
|
+
enum: [
|
|
1999
|
+
'target',
|
|
2000
|
+
'author',
|
|
2001
|
+
'bitbucket_login',
|
|
2002
|
+
'bold',
|
|
2003
|
+
'deployment_host',
|
|
2004
|
+
'dns_record',
|
|
2005
|
+
'git_link',
|
|
2006
|
+
'github_login',
|
|
2007
|
+
'gitlab_login',
|
|
2008
|
+
'hook_name',
|
|
2009
|
+
'integration',
|
|
2010
|
+
'edge-config',
|
|
2011
|
+
'link',
|
|
2012
|
+
'project_name',
|
|
2013
|
+
'scaling_rules',
|
|
2014
|
+
'env_var_name',
|
|
2015
|
+
'system',
|
|
2016
|
+
];
|
|
2017
|
+
examples: ['author'];
|
|
2018
|
+
type: 'string';
|
|
2019
|
+
};
|
|
2020
|
+
};
|
|
2021
|
+
required: ['type', 'start', 'end'];
|
|
2022
|
+
type: 'object';
|
|
2023
|
+
};
|
|
2024
|
+
type: 'array';
|
|
2025
|
+
};
|
|
2026
|
+
id: {
|
|
2027
|
+
description: 'The unique identifier of the Event.';
|
|
2028
|
+
examples: ['uev_bfmMjiMnXfnPbT97dGdpJbCN'];
|
|
2029
|
+
type: 'string';
|
|
2030
|
+
};
|
|
2031
|
+
text: {
|
|
2032
|
+
description: 'The human-readable text of the Event.';
|
|
2033
|
+
examples: ['You logged in via GitHub'];
|
|
2034
|
+
type: 'string';
|
|
2035
|
+
};
|
|
2036
|
+
user: {
|
|
2037
|
+
description: 'Metadata for the User who generated the event.';
|
|
2038
|
+
properties: {
|
|
2039
|
+
avatar: {
|
|
2040
|
+
type: 'string';
|
|
2041
|
+
};
|
|
2042
|
+
email: {
|
|
2043
|
+
type: 'string';
|
|
2044
|
+
};
|
|
2045
|
+
slug: {
|
|
2046
|
+
type: 'string';
|
|
2047
|
+
};
|
|
2048
|
+
uid: {
|
|
2049
|
+
type: 'string';
|
|
2050
|
+
};
|
|
2051
|
+
username: {
|
|
2052
|
+
type: 'string';
|
|
2053
|
+
};
|
|
2054
|
+
};
|
|
2055
|
+
required: ['avatar', 'email', 'uid', 'username'];
|
|
2056
|
+
type: 'object';
|
|
2057
|
+
};
|
|
2058
|
+
userId: {
|
|
2059
|
+
description: 'The unique identifier of the User who generated the event.';
|
|
2060
|
+
examples: ['zTuNVUXEAvvnNN3IaqinkyMw'];
|
|
2061
|
+
type: 'string';
|
|
2062
|
+
};
|
|
2063
|
+
};
|
|
2064
|
+
required: ['id', 'text', 'entities', 'createdAt', 'userId'];
|
|
2065
|
+
type: 'object';
|
|
2066
|
+
};
|
|
2067
|
+
};
|
|
2068
|
+
securitySchemes: {
|
|
2069
|
+
bearerToken: {
|
|
2070
|
+
description: 'Default authentication mechanism';
|
|
2071
|
+
scheme: 'bearer';
|
|
2072
|
+
type: 'http';
|
|
2073
|
+
};
|
|
2074
|
+
oauth2: {
|
|
2075
|
+
flows: {
|
|
2076
|
+
authorizationCode: {
|
|
2077
|
+
authorizationUrl: 'https://api.vercel.com/oauth/authorize';
|
|
2078
|
+
scopes: {};
|
|
2079
|
+
tokenUrl: 'https://api.vercel.com/oauth/access_token';
|
|
2080
|
+
};
|
|
2081
|
+
};
|
|
2082
|
+
type: 'oauth2';
|
|
2083
|
+
};
|
|
2084
|
+
};
|
|
2085
|
+
};
|
|
2086
|
+
export const components = {
|
|
2087
|
+
schemas: {
|
|
2088
|
+
ACLAction: {
|
|
2089
|
+
description:
|
|
2090
|
+
'Enum containing the actions that can be performed against a resource. Group operations are included.',
|
|
2091
|
+
enum: ['create', 'delete', 'read', 'update', 'list', 'count'],
|
|
2092
|
+
type: 'string',
|
|
2093
|
+
},
|
|
2094
|
+
AuthToken: {
|
|
2095
|
+
description: 'Authentication token metadata.',
|
|
2096
|
+
properties: {
|
|
2097
|
+
activeAt: {
|
|
2098
|
+
description: 'Timestamp (in milliseconds) of when the token was most recently used.',
|
|
2099
|
+
examples: [1632816536002],
|
|
2100
|
+
type: 'number',
|
|
2101
|
+
},
|
|
2102
|
+
createdAt: {
|
|
2103
|
+
description: 'Timestamp (in milliseconds) of when the token was created.',
|
|
2104
|
+
examples: [1632816536002],
|
|
2105
|
+
type: 'number',
|
|
2106
|
+
},
|
|
2107
|
+
expiresAt: {
|
|
2108
|
+
description: 'Timestamp (in milliseconds) of when the token expires.',
|
|
2109
|
+
examples: [1632816536002],
|
|
2110
|
+
type: 'number',
|
|
2111
|
+
},
|
|
2112
|
+
id: {
|
|
2113
|
+
description: 'The unique identifier of the token.',
|
|
2114
|
+
examples: ['5d9f2ebd38ddca62e5d51e9c1704c72530bdc8bfdd41e782a6687c48399e8391'],
|
|
2115
|
+
type: 'string',
|
|
2116
|
+
},
|
|
2117
|
+
name: {
|
|
2118
|
+
description: 'The human-readable name of the token.',
|
|
2119
|
+
type: 'string',
|
|
2120
|
+
},
|
|
2121
|
+
origin: {
|
|
2122
|
+
description: 'The origin of how the token was created.',
|
|
2123
|
+
examples: ['github'],
|
|
2124
|
+
type: 'string',
|
|
2125
|
+
},
|
|
2126
|
+
scopes: {
|
|
2127
|
+
description: 'The access scopes granted to the token.',
|
|
2128
|
+
items: {
|
|
2129
|
+
oneOf: [
|
|
2130
|
+
{
|
|
2131
|
+
description: 'The access scopes granted to the token.',
|
|
2132
|
+
properties: {
|
|
2133
|
+
createdAt: {
|
|
2134
|
+
type: 'number',
|
|
2135
|
+
},
|
|
2136
|
+
expiresAt: {
|
|
2137
|
+
type: 'number',
|
|
2138
|
+
},
|
|
2139
|
+
origin: {
|
|
2140
|
+
enum: ['saml', 'github', 'gitlab', 'bitbucket', 'email', 'manual'],
|
|
2141
|
+
type: 'string',
|
|
2142
|
+
},
|
|
2143
|
+
type: {
|
|
2144
|
+
enum: ['user'],
|
|
2145
|
+
type: 'string',
|
|
2146
|
+
},
|
|
2147
|
+
},
|
|
2148
|
+
required: ['type', 'origin', 'createdAt'],
|
|
2149
|
+
type: 'object',
|
|
2150
|
+
},
|
|
2151
|
+
{
|
|
2152
|
+
description: 'The access scopes granted to the token.',
|
|
2153
|
+
properties: {
|
|
2154
|
+
createdAt: {
|
|
2155
|
+
type: 'number',
|
|
2156
|
+
},
|
|
2157
|
+
expiresAt: {
|
|
2158
|
+
type: 'number',
|
|
2159
|
+
},
|
|
2160
|
+
origin: {
|
|
2161
|
+
enum: ['saml', 'github', 'gitlab', 'bitbucket', 'email', 'manual'],
|
|
2162
|
+
type: 'string',
|
|
2163
|
+
},
|
|
2164
|
+
teamId: {
|
|
2165
|
+
type: 'string',
|
|
2166
|
+
},
|
|
2167
|
+
type: {
|
|
2168
|
+
enum: ['team'],
|
|
2169
|
+
type: 'string',
|
|
2170
|
+
},
|
|
2171
|
+
},
|
|
2172
|
+
required: ['type', 'teamId', 'origin', 'createdAt'],
|
|
2173
|
+
type: 'object',
|
|
2174
|
+
},
|
|
2175
|
+
],
|
|
2176
|
+
},
|
|
2177
|
+
type: 'array',
|
|
2178
|
+
},
|
|
2179
|
+
type: {
|
|
2180
|
+
description: 'The type of the token.',
|
|
2181
|
+
examples: ['oauth2-token'],
|
|
2182
|
+
type: 'string',
|
|
2183
|
+
},
|
|
2184
|
+
},
|
|
2185
|
+
required: ['id', 'name', 'type', 'activeAt', 'createdAt'],
|
|
2186
|
+
type: 'object',
|
|
2187
|
+
},
|
|
2188
|
+
AuthUser: {
|
|
2189
|
+
description: 'Data for the currently authenticated User.',
|
|
2190
|
+
properties: {
|
|
2191
|
+
activeDashboardViews: {
|
|
2192
|
+
description: 'set of dashboard view preferences (cards or list) per scopeId',
|
|
2193
|
+
items: {
|
|
2194
|
+
description: 'set of dashboard view preferences (cards or list) per scopeId',
|
|
2195
|
+
properties: {
|
|
2196
|
+
scopeId: {
|
|
2197
|
+
type: 'string',
|
|
2198
|
+
},
|
|
2199
|
+
viewPreference: {
|
|
2200
|
+
enum: ['cards', 'list'],
|
|
2201
|
+
type: 'string',
|
|
2202
|
+
},
|
|
2203
|
+
},
|
|
2204
|
+
required: ['scopeId', 'viewPreference'],
|
|
2205
|
+
type: 'object',
|
|
2206
|
+
},
|
|
2207
|
+
type: 'array',
|
|
2208
|
+
},
|
|
2209
|
+
avatar: {
|
|
2210
|
+
description:
|
|
2211
|
+
'SHA1 hash of the avatar for the User account. Can be used in conjuction with the ... endpoint to retrieve the avatar image.',
|
|
2212
|
+
examples: ['22cb30c85ff45ac4c72de8981500006b28114aa1'],
|
|
2213
|
+
type: ['string', 'null'],
|
|
2214
|
+
},
|
|
2215
|
+
billing: {
|
|
2216
|
+
description: 'An object containing billing infomation associated with the User account.',
|
|
2217
|
+
properties: {
|
|
2218
|
+
addons: {
|
|
2219
|
+
items: {
|
|
2220
|
+
enum: ['custom-deployment-suffix', 'live-support'],
|
|
2221
|
+
type: 'string',
|
|
2222
|
+
},
|
|
2223
|
+
type: ['array', 'null'],
|
|
2224
|
+
},
|
|
2225
|
+
address: {
|
|
2226
|
+
properties: {
|
|
2227
|
+
city: {
|
|
2228
|
+
type: 'string',
|
|
2229
|
+
},
|
|
2230
|
+
country: {
|
|
2231
|
+
type: 'string',
|
|
2232
|
+
},
|
|
2233
|
+
line1: {
|
|
2234
|
+
type: 'string',
|
|
2235
|
+
},
|
|
2236
|
+
line2: {
|
|
2237
|
+
type: 'string',
|
|
2238
|
+
},
|
|
2239
|
+
postalCode: {
|
|
2240
|
+
type: 'string',
|
|
2241
|
+
},
|
|
2242
|
+
state: {
|
|
2243
|
+
type: 'string',
|
|
2244
|
+
},
|
|
2245
|
+
},
|
|
2246
|
+
required: ['line1'],
|
|
2247
|
+
type: ['object', 'null'],
|
|
2248
|
+
},
|
|
2249
|
+
cancelation: {
|
|
2250
|
+
type: ['number', 'null'],
|
|
2251
|
+
},
|
|
2252
|
+
contract: {
|
|
2253
|
+
properties: {
|
|
2254
|
+
end: {
|
|
2255
|
+
type: 'number',
|
|
2256
|
+
},
|
|
2257
|
+
start: {
|
|
2258
|
+
type: 'number',
|
|
2259
|
+
},
|
|
2260
|
+
},
|
|
2261
|
+
required: ['start', 'end'],
|
|
2262
|
+
type: ['object', 'null'],
|
|
2263
|
+
},
|
|
2264
|
+
controls: {
|
|
2265
|
+
properties: {
|
|
2266
|
+
analyticsSampleRateInPercent: {
|
|
2267
|
+
type: ['number', 'null'],
|
|
2268
|
+
},
|
|
2269
|
+
analyticsSpendLimitInDollars: {
|
|
2270
|
+
type: ['number', 'null'],
|
|
2271
|
+
},
|
|
2272
|
+
},
|
|
2273
|
+
type: ['object', 'null'],
|
|
2274
|
+
},
|
|
2275
|
+
currency: {
|
|
2276
|
+
enum: ['usd', 'eur'],
|
|
2277
|
+
type: 'string',
|
|
2278
|
+
},
|
|
2279
|
+
email: {
|
|
2280
|
+
type: ['string', 'null'],
|
|
2281
|
+
},
|
|
2282
|
+
invoiceItems: {
|
|
2283
|
+
properties: {
|
|
2284
|
+
analytics: {
|
|
2285
|
+
description: 'Will be used to create an invoice item. The price must be in cents: 2000 for $20.',
|
|
2286
|
+
properties: {
|
|
2287
|
+
createdAt: {
|
|
2288
|
+
type: 'number',
|
|
2289
|
+
},
|
|
2290
|
+
disabledAt: {
|
|
2291
|
+
type: ['number', 'null'],
|
|
2292
|
+
},
|
|
2293
|
+
frequency: {
|
|
2294
|
+
properties: {
|
|
2295
|
+
interval: {
|
|
2296
|
+
enum: ['month'],
|
|
2297
|
+
type: 'string',
|
|
2298
|
+
},
|
|
2299
|
+
intervalCount: {
|
|
2300
|
+
enum: [1, 3, 2, 6, 12],
|
|
2301
|
+
type: 'number',
|
|
2302
|
+
},
|
|
2303
|
+
},
|
|
2304
|
+
required: ['interval', 'intervalCount'],
|
|
2305
|
+
type: 'object',
|
|
2306
|
+
},
|
|
2307
|
+
hidden: {
|
|
2308
|
+
type: 'boolean',
|
|
2309
|
+
},
|
|
2310
|
+
maxQuantity: {
|
|
2311
|
+
type: 'number',
|
|
2312
|
+
},
|
|
2313
|
+
name: {
|
|
2314
|
+
type: 'string',
|
|
2315
|
+
},
|
|
2316
|
+
price: {
|
|
2317
|
+
type: 'number',
|
|
2318
|
+
},
|
|
2319
|
+
quantity: {
|
|
2320
|
+
type: 'number',
|
|
2321
|
+
},
|
|
2322
|
+
tier: {
|
|
2323
|
+
type: 'number',
|
|
2324
|
+
},
|
|
2325
|
+
},
|
|
2326
|
+
required: ['price', 'quantity', 'hidden'],
|
|
2327
|
+
type: 'object',
|
|
2328
|
+
},
|
|
2329
|
+
analyticsUsage: {
|
|
2330
|
+
properties: {
|
|
2331
|
+
batch: {
|
|
2332
|
+
type: 'number',
|
|
2333
|
+
},
|
|
2334
|
+
disabledAt: {
|
|
2335
|
+
type: ['number', 'null'],
|
|
2336
|
+
},
|
|
2337
|
+
hidden: {
|
|
2338
|
+
type: 'boolean',
|
|
2339
|
+
},
|
|
2340
|
+
name: {
|
|
2341
|
+
type: 'string',
|
|
2342
|
+
},
|
|
2343
|
+
price: {
|
|
2344
|
+
type: 'number',
|
|
2345
|
+
},
|
|
2346
|
+
threshold: {
|
|
2347
|
+
type: 'number',
|
|
2348
|
+
},
|
|
2349
|
+
tier: {
|
|
2350
|
+
type: 'number',
|
|
2351
|
+
},
|
|
2352
|
+
},
|
|
2353
|
+
required: ['price', 'batch', 'threshold', 'hidden'],
|
|
2354
|
+
type: 'object',
|
|
2355
|
+
},
|
|
2356
|
+
artifacts: {
|
|
2357
|
+
properties: {
|
|
2358
|
+
batch: {
|
|
2359
|
+
type: 'number',
|
|
2360
|
+
},
|
|
2361
|
+
disabledAt: {
|
|
2362
|
+
type: ['number', 'null'],
|
|
2363
|
+
},
|
|
2364
|
+
hidden: {
|
|
2365
|
+
type: 'boolean',
|
|
2366
|
+
},
|
|
2367
|
+
name: {
|
|
2368
|
+
type: 'string',
|
|
2369
|
+
},
|
|
2370
|
+
price: {
|
|
2371
|
+
type: 'number',
|
|
2372
|
+
},
|
|
2373
|
+
threshold: {
|
|
2374
|
+
type: 'number',
|
|
2375
|
+
},
|
|
2376
|
+
tier: {
|
|
2377
|
+
type: 'number',
|
|
2378
|
+
},
|
|
2379
|
+
},
|
|
2380
|
+
required: ['price', 'batch', 'threshold', 'hidden'],
|
|
2381
|
+
type: 'object',
|
|
2382
|
+
},
|
|
2383
|
+
bandwidth: {
|
|
2384
|
+
properties: {
|
|
2385
|
+
batch: {
|
|
2386
|
+
type: 'number',
|
|
2387
|
+
},
|
|
2388
|
+
disabledAt: {
|
|
2389
|
+
type: ['number', 'null'],
|
|
2390
|
+
},
|
|
2391
|
+
hidden: {
|
|
2392
|
+
type: 'boolean',
|
|
2393
|
+
},
|
|
2394
|
+
name: {
|
|
2395
|
+
type: 'string',
|
|
2396
|
+
},
|
|
2397
|
+
price: {
|
|
2398
|
+
type: 'number',
|
|
2399
|
+
},
|
|
2400
|
+
threshold: {
|
|
2401
|
+
type: 'number',
|
|
2402
|
+
},
|
|
2403
|
+
tier: {
|
|
2404
|
+
type: 'number',
|
|
2405
|
+
},
|
|
2406
|
+
},
|
|
2407
|
+
required: ['price', 'batch', 'threshold', 'hidden'],
|
|
2408
|
+
type: 'object',
|
|
2409
|
+
},
|
|
2410
|
+
builds: {
|
|
2411
|
+
properties: {
|
|
2412
|
+
batch: {
|
|
2413
|
+
type: 'number',
|
|
2414
|
+
},
|
|
2415
|
+
disabledAt: {
|
|
2416
|
+
type: ['number', 'null'],
|
|
2417
|
+
},
|
|
2418
|
+
hidden: {
|
|
2419
|
+
type: 'boolean',
|
|
2420
|
+
},
|
|
2421
|
+
name: {
|
|
2422
|
+
type: 'string',
|
|
2423
|
+
},
|
|
2424
|
+
price: {
|
|
2425
|
+
type: 'number',
|
|
2426
|
+
},
|
|
2427
|
+
threshold: {
|
|
2428
|
+
type: 'number',
|
|
2429
|
+
},
|
|
2430
|
+
tier: {
|
|
2431
|
+
type: 'number',
|
|
2432
|
+
},
|
|
2433
|
+
},
|
|
2434
|
+
required: ['price', 'batch', 'threshold', 'hidden'],
|
|
2435
|
+
type: 'object',
|
|
2436
|
+
},
|
|
2437
|
+
concurrentBuilds: {
|
|
2438
|
+
description: 'Will be used to create an invoice item. The price must be in cents: 2000 for $20.',
|
|
2439
|
+
properties: {
|
|
2440
|
+
createdAt: {
|
|
2441
|
+
type: 'number',
|
|
2442
|
+
},
|
|
2443
|
+
disabledAt: {
|
|
2444
|
+
type: ['number', 'null'],
|
|
2445
|
+
},
|
|
2446
|
+
frequency: {
|
|
2447
|
+
properties: {
|
|
2448
|
+
interval: {
|
|
2449
|
+
enum: ['month'],
|
|
2450
|
+
type: 'string',
|
|
2451
|
+
},
|
|
2452
|
+
intervalCount: {
|
|
2453
|
+
enum: [1, 3, 2, 6, 12],
|
|
2454
|
+
type: 'number',
|
|
2455
|
+
},
|
|
2456
|
+
},
|
|
2457
|
+
required: ['interval', 'intervalCount'],
|
|
2458
|
+
type: 'object',
|
|
2459
|
+
},
|
|
2460
|
+
hidden: {
|
|
2461
|
+
type: 'boolean',
|
|
2462
|
+
},
|
|
2463
|
+
maxQuantity: {
|
|
2464
|
+
type: 'number',
|
|
2465
|
+
},
|
|
2466
|
+
name: {
|
|
2467
|
+
type: 'string',
|
|
2468
|
+
},
|
|
2469
|
+
price: {
|
|
2470
|
+
type: 'number',
|
|
2471
|
+
},
|
|
2472
|
+
quantity: {
|
|
2473
|
+
type: 'number',
|
|
2474
|
+
},
|
|
2475
|
+
tier: {
|
|
2476
|
+
type: 'number',
|
|
2477
|
+
},
|
|
2478
|
+
},
|
|
2479
|
+
required: ['price', 'quantity', 'hidden'],
|
|
2480
|
+
type: 'object',
|
|
2481
|
+
},
|
|
2482
|
+
cronJobInvocation: {
|
|
2483
|
+
properties: {
|
|
2484
|
+
batch: {
|
|
2485
|
+
type: 'number',
|
|
2486
|
+
},
|
|
2487
|
+
disabledAt: {
|
|
2488
|
+
type: ['number', 'null'],
|
|
2489
|
+
},
|
|
2490
|
+
hidden: {
|
|
2491
|
+
type: 'boolean',
|
|
2492
|
+
},
|
|
2493
|
+
name: {
|
|
2494
|
+
type: 'string',
|
|
2495
|
+
},
|
|
2496
|
+
price: {
|
|
2497
|
+
type: 'number',
|
|
2498
|
+
},
|
|
2499
|
+
threshold: {
|
|
2500
|
+
type: 'number',
|
|
2501
|
+
},
|
|
2502
|
+
tier: {
|
|
2503
|
+
type: 'number',
|
|
2504
|
+
},
|
|
2505
|
+
},
|
|
2506
|
+
required: ['price', 'batch', 'threshold', 'hidden'],
|
|
2507
|
+
type: 'object',
|
|
2508
|
+
},
|
|
2509
|
+
customCerts: {
|
|
2510
|
+
description: 'Will be used to create an invoice item. The price must be in cents: 2000 for $20.',
|
|
2511
|
+
properties: {
|
|
2512
|
+
createdAt: {
|
|
2513
|
+
type: 'number',
|
|
2514
|
+
},
|
|
2515
|
+
disabledAt: {
|
|
2516
|
+
type: ['number', 'null'],
|
|
2517
|
+
},
|
|
2518
|
+
frequency: {
|
|
2519
|
+
properties: {
|
|
2520
|
+
interval: {
|
|
2521
|
+
enum: ['month'],
|
|
2522
|
+
type: 'string',
|
|
2523
|
+
},
|
|
2524
|
+
intervalCount: {
|
|
2525
|
+
enum: [1, 3, 2, 6, 12],
|
|
2526
|
+
type: 'number',
|
|
2527
|
+
},
|
|
2528
|
+
},
|
|
2529
|
+
required: ['interval', 'intervalCount'],
|
|
2530
|
+
type: 'object',
|
|
2531
|
+
},
|
|
2532
|
+
hidden: {
|
|
2533
|
+
type: 'boolean',
|
|
2534
|
+
},
|
|
2535
|
+
maxQuantity: {
|
|
2536
|
+
type: 'number',
|
|
2537
|
+
},
|
|
2538
|
+
name: {
|
|
2539
|
+
type: 'string',
|
|
2540
|
+
},
|
|
2541
|
+
price: {
|
|
2542
|
+
type: 'number',
|
|
2543
|
+
},
|
|
2544
|
+
quantity: {
|
|
2545
|
+
type: 'number',
|
|
2546
|
+
},
|
|
2547
|
+
tier: {
|
|
2548
|
+
type: 'number',
|
|
2549
|
+
},
|
|
2550
|
+
},
|
|
2551
|
+
required: ['price', 'quantity', 'hidden'],
|
|
2552
|
+
type: 'object',
|
|
2553
|
+
},
|
|
2554
|
+
edgeConfigRead: {
|
|
2555
|
+
properties: {
|
|
2556
|
+
batch: {
|
|
2557
|
+
type: 'number',
|
|
2558
|
+
},
|
|
2559
|
+
disabledAt: {
|
|
2560
|
+
type: ['number', 'null'],
|
|
2561
|
+
},
|
|
2562
|
+
hidden: {
|
|
2563
|
+
type: 'boolean',
|
|
2564
|
+
},
|
|
2565
|
+
name: {
|
|
2566
|
+
type: 'string',
|
|
2567
|
+
},
|
|
2568
|
+
price: {
|
|
2569
|
+
type: 'number',
|
|
2570
|
+
},
|
|
2571
|
+
threshold: {
|
|
2572
|
+
type: 'number',
|
|
2573
|
+
},
|
|
2574
|
+
tier: {
|
|
2575
|
+
type: 'number',
|
|
2576
|
+
},
|
|
2577
|
+
},
|
|
2578
|
+
required: ['price', 'batch', 'threshold', 'hidden'],
|
|
2579
|
+
type: 'object',
|
|
2580
|
+
},
|
|
2581
|
+
edgeConfigWrite: {
|
|
2582
|
+
properties: {
|
|
2583
|
+
batch: {
|
|
2584
|
+
type: 'number',
|
|
2585
|
+
},
|
|
2586
|
+
disabledAt: {
|
|
2587
|
+
type: ['number', 'null'],
|
|
2588
|
+
},
|
|
2589
|
+
hidden: {
|
|
2590
|
+
type: 'boolean',
|
|
2591
|
+
},
|
|
2592
|
+
name: {
|
|
2593
|
+
type: 'string',
|
|
2594
|
+
},
|
|
2595
|
+
price: {
|
|
2596
|
+
type: 'number',
|
|
2597
|
+
},
|
|
2598
|
+
threshold: {
|
|
2599
|
+
type: 'number',
|
|
2600
|
+
},
|
|
2601
|
+
tier: {
|
|
2602
|
+
type: 'number',
|
|
2603
|
+
},
|
|
2604
|
+
},
|
|
2605
|
+
required: ['price', 'batch', 'threshold', 'hidden'],
|
|
2606
|
+
type: 'object',
|
|
2607
|
+
},
|
|
2608
|
+
edgeFunctionExecutionUnits: {
|
|
2609
|
+
properties: {
|
|
2610
|
+
batch: {
|
|
2611
|
+
type: 'number',
|
|
2612
|
+
},
|
|
2613
|
+
disabledAt: {
|
|
2614
|
+
type: ['number', 'null'],
|
|
2615
|
+
},
|
|
2616
|
+
hidden: {
|
|
2617
|
+
type: 'boolean',
|
|
2618
|
+
},
|
|
2619
|
+
name: {
|
|
2620
|
+
type: 'string',
|
|
2621
|
+
},
|
|
2622
|
+
price: {
|
|
2623
|
+
type: 'number',
|
|
2624
|
+
},
|
|
2625
|
+
threshold: {
|
|
2626
|
+
type: 'number',
|
|
2627
|
+
},
|
|
2628
|
+
tier: {
|
|
2629
|
+
type: 'number',
|
|
2630
|
+
},
|
|
2631
|
+
},
|
|
2632
|
+
required: ['price', 'batch', 'threshold', 'hidden'],
|
|
2633
|
+
type: 'object',
|
|
2634
|
+
},
|
|
2635
|
+
edgeMiddlewareInvocations: {
|
|
2636
|
+
properties: {
|
|
2637
|
+
batch: {
|
|
2638
|
+
type: 'number',
|
|
2639
|
+
},
|
|
2640
|
+
disabledAt: {
|
|
2641
|
+
type: ['number', 'null'],
|
|
2642
|
+
},
|
|
2643
|
+
hidden: {
|
|
2644
|
+
type: 'boolean',
|
|
2645
|
+
},
|
|
2646
|
+
name: {
|
|
2647
|
+
type: 'string',
|
|
2648
|
+
},
|
|
2649
|
+
price: {
|
|
2650
|
+
type: 'number',
|
|
2651
|
+
},
|
|
2652
|
+
threshold: {
|
|
2653
|
+
type: 'number',
|
|
2654
|
+
},
|
|
2655
|
+
tier: {
|
|
2656
|
+
type: 'number',
|
|
2657
|
+
},
|
|
2658
|
+
},
|
|
2659
|
+
required: ['price', 'batch', 'threshold', 'hidden'],
|
|
2660
|
+
type: 'object',
|
|
2661
|
+
},
|
|
2662
|
+
enterprise: {
|
|
2663
|
+
description: 'Will be used to create an invoice item. The price must be in cents: 2000 for $20.',
|
|
2664
|
+
properties: {
|
|
2665
|
+
createdAt: {
|
|
2666
|
+
type: 'number',
|
|
2667
|
+
},
|
|
2668
|
+
disabledAt: {
|
|
2669
|
+
type: ['number', 'null'],
|
|
2670
|
+
},
|
|
2671
|
+
frequency: {
|
|
2672
|
+
properties: {
|
|
2673
|
+
interval: {
|
|
2674
|
+
enum: ['month'],
|
|
2675
|
+
type: 'string',
|
|
2676
|
+
},
|
|
2677
|
+
intervalCount: {
|
|
2678
|
+
enum: [1, 3, 2, 6, 12],
|
|
2679
|
+
type: 'number',
|
|
2680
|
+
},
|
|
2681
|
+
},
|
|
2682
|
+
required: ['interval', 'intervalCount'],
|
|
2683
|
+
type: 'object',
|
|
2684
|
+
},
|
|
2685
|
+
hidden: {
|
|
2686
|
+
type: 'boolean',
|
|
2687
|
+
},
|
|
2688
|
+
maxQuantity: {
|
|
2689
|
+
type: 'number',
|
|
2690
|
+
},
|
|
2691
|
+
name: {
|
|
2692
|
+
type: 'string',
|
|
2693
|
+
},
|
|
2694
|
+
price: {
|
|
2695
|
+
type: 'number',
|
|
2696
|
+
},
|
|
2697
|
+
quantity: {
|
|
2698
|
+
type: 'number',
|
|
2699
|
+
},
|
|
2700
|
+
tier: {
|
|
2701
|
+
type: 'number',
|
|
2702
|
+
},
|
|
2703
|
+
},
|
|
2704
|
+
required: ['price', 'quantity', 'hidden'],
|
|
2705
|
+
type: 'object',
|
|
2706
|
+
},
|
|
2707
|
+
monitoring: {
|
|
2708
|
+
description: 'Will be used to create an invoice item. The price must be in cents: 2000 for $20.',
|
|
2709
|
+
properties: {
|
|
2710
|
+
createdAt: {
|
|
2711
|
+
type: 'number',
|
|
2712
|
+
},
|
|
2713
|
+
disabledAt: {
|
|
2714
|
+
type: ['number', 'null'],
|
|
2715
|
+
},
|
|
2716
|
+
frequency: {
|
|
2717
|
+
properties: {
|
|
2718
|
+
interval: {
|
|
2719
|
+
enum: ['month'],
|
|
2720
|
+
type: 'string',
|
|
2721
|
+
},
|
|
2722
|
+
intervalCount: {
|
|
2723
|
+
enum: [1, 3, 2, 6, 12],
|
|
2724
|
+
type: 'number',
|
|
2725
|
+
},
|
|
2726
|
+
},
|
|
2727
|
+
required: ['interval', 'intervalCount'],
|
|
2728
|
+
type: 'object',
|
|
2729
|
+
},
|
|
2730
|
+
hidden: {
|
|
2731
|
+
type: 'boolean',
|
|
2732
|
+
},
|
|
2733
|
+
maxQuantity: {
|
|
2734
|
+
type: 'number',
|
|
2735
|
+
},
|
|
2736
|
+
name: {
|
|
2737
|
+
type: 'string',
|
|
2738
|
+
},
|
|
2739
|
+
price: {
|
|
2740
|
+
type: 'number',
|
|
2741
|
+
},
|
|
2742
|
+
quantity: {
|
|
2743
|
+
type: 'number',
|
|
2744
|
+
},
|
|
2745
|
+
tier: {
|
|
2746
|
+
type: 'number',
|
|
2747
|
+
},
|
|
2748
|
+
},
|
|
2749
|
+
required: ['price', 'quantity', 'hidden'],
|
|
2750
|
+
type: 'object',
|
|
2751
|
+
},
|
|
2752
|
+
monitoringMetric: {
|
|
2753
|
+
properties: {
|
|
2754
|
+
batch: {
|
|
2755
|
+
type: 'number',
|
|
2756
|
+
},
|
|
2757
|
+
disabledAt: {
|
|
2758
|
+
type: ['number', 'null'],
|
|
2759
|
+
},
|
|
2760
|
+
hidden: {
|
|
2761
|
+
type: 'boolean',
|
|
2762
|
+
},
|
|
2763
|
+
name: {
|
|
2764
|
+
type: 'string',
|
|
2765
|
+
},
|
|
2766
|
+
price: {
|
|
2767
|
+
type: 'number',
|
|
2768
|
+
},
|
|
2769
|
+
threshold: {
|
|
2770
|
+
type: 'number',
|
|
2771
|
+
},
|
|
2772
|
+
tier: {
|
|
2773
|
+
type: 'number',
|
|
2774
|
+
},
|
|
2775
|
+
},
|
|
2776
|
+
required: ['price', 'batch', 'threshold', 'hidden'],
|
|
2777
|
+
type: 'object',
|
|
2778
|
+
},
|
|
2779
|
+
passwordProtection: {
|
|
2780
|
+
description: 'Will be used to create an invoice item. The price must be in cents: 2000 for $20.',
|
|
2781
|
+
properties: {
|
|
2782
|
+
createdAt: {
|
|
2783
|
+
type: 'number',
|
|
2784
|
+
},
|
|
2785
|
+
disabledAt: {
|
|
2786
|
+
type: ['number', 'null'],
|
|
2787
|
+
},
|
|
2788
|
+
frequency: {
|
|
2789
|
+
properties: {
|
|
2790
|
+
interval: {
|
|
2791
|
+
enum: ['month'],
|
|
2792
|
+
type: 'string',
|
|
2793
|
+
},
|
|
2794
|
+
intervalCount: {
|
|
2795
|
+
enum: [1, 3, 2, 6, 12],
|
|
2796
|
+
type: 'number',
|
|
2797
|
+
},
|
|
2798
|
+
},
|
|
2799
|
+
required: ['interval', 'intervalCount'],
|
|
2800
|
+
type: 'object',
|
|
2801
|
+
},
|
|
2802
|
+
hidden: {
|
|
2803
|
+
type: 'boolean',
|
|
2804
|
+
},
|
|
2805
|
+
maxQuantity: {
|
|
2806
|
+
type: 'number',
|
|
2807
|
+
},
|
|
2808
|
+
name: {
|
|
2809
|
+
type: 'string',
|
|
2810
|
+
},
|
|
2811
|
+
price: {
|
|
2812
|
+
type: 'number',
|
|
2813
|
+
},
|
|
2814
|
+
quantity: {
|
|
2815
|
+
type: 'number',
|
|
2816
|
+
},
|
|
2817
|
+
tier: {
|
|
2818
|
+
type: 'number',
|
|
2819
|
+
},
|
|
2820
|
+
},
|
|
2821
|
+
required: ['price', 'quantity', 'hidden'],
|
|
2822
|
+
type: 'object',
|
|
2823
|
+
},
|
|
2824
|
+
previewDeploymentSuffix: {
|
|
2825
|
+
description: 'Will be used to create an invoice item. The price must be in cents: 2000 for $20.',
|
|
2826
|
+
properties: {
|
|
2827
|
+
createdAt: {
|
|
2828
|
+
type: 'number',
|
|
2829
|
+
},
|
|
2830
|
+
disabledAt: {
|
|
2831
|
+
type: ['number', 'null'],
|
|
2832
|
+
},
|
|
2833
|
+
frequency: {
|
|
2834
|
+
properties: {
|
|
2835
|
+
interval: {
|
|
2836
|
+
enum: ['month'],
|
|
2837
|
+
type: 'string',
|
|
2838
|
+
},
|
|
2839
|
+
intervalCount: {
|
|
2840
|
+
enum: [1, 3, 2, 6, 12],
|
|
2841
|
+
type: 'number',
|
|
2842
|
+
},
|
|
2843
|
+
},
|
|
2844
|
+
required: ['interval', 'intervalCount'],
|
|
2845
|
+
type: 'object',
|
|
2846
|
+
},
|
|
2847
|
+
hidden: {
|
|
2848
|
+
type: 'boolean',
|
|
2849
|
+
},
|
|
2850
|
+
maxQuantity: {
|
|
2851
|
+
type: 'number',
|
|
2852
|
+
},
|
|
2853
|
+
name: {
|
|
2854
|
+
type: 'string',
|
|
2855
|
+
},
|
|
2856
|
+
price: {
|
|
2857
|
+
type: 'number',
|
|
2858
|
+
},
|
|
2859
|
+
quantity: {
|
|
2860
|
+
type: 'number',
|
|
2861
|
+
},
|
|
2862
|
+
tier: {
|
|
2863
|
+
type: 'number',
|
|
2864
|
+
},
|
|
2865
|
+
},
|
|
2866
|
+
required: ['price', 'quantity', 'hidden'],
|
|
2867
|
+
type: 'object',
|
|
2868
|
+
},
|
|
2869
|
+
pro: {
|
|
2870
|
+
description: 'Will be used to create an invoice item. The price must be in cents: 2000 for $20.',
|
|
2871
|
+
properties: {
|
|
2872
|
+
createdAt: {
|
|
2873
|
+
type: 'number',
|
|
2874
|
+
},
|
|
2875
|
+
disabledAt: {
|
|
2876
|
+
type: ['number', 'null'],
|
|
2877
|
+
},
|
|
2878
|
+
frequency: {
|
|
2879
|
+
properties: {
|
|
2880
|
+
interval: {
|
|
2881
|
+
enum: ['month'],
|
|
2882
|
+
type: 'string',
|
|
2883
|
+
},
|
|
2884
|
+
intervalCount: {
|
|
2885
|
+
enum: [1, 3, 2, 6, 12],
|
|
2886
|
+
type: 'number',
|
|
2887
|
+
},
|
|
2888
|
+
},
|
|
2889
|
+
required: ['interval', 'intervalCount'],
|
|
2890
|
+
type: 'object',
|
|
2891
|
+
},
|
|
2892
|
+
hidden: {
|
|
2893
|
+
type: 'boolean',
|
|
2894
|
+
},
|
|
2895
|
+
maxQuantity: {
|
|
2896
|
+
type: 'number',
|
|
2897
|
+
},
|
|
2898
|
+
name: {
|
|
2899
|
+
type: 'string',
|
|
2900
|
+
},
|
|
2901
|
+
price: {
|
|
2902
|
+
type: 'number',
|
|
2903
|
+
},
|
|
2904
|
+
quantity: {
|
|
2905
|
+
type: 'number',
|
|
2906
|
+
},
|
|
2907
|
+
tier: {
|
|
2908
|
+
type: 'number',
|
|
2909
|
+
},
|
|
2910
|
+
},
|
|
2911
|
+
required: ['price', 'quantity', 'hidden'],
|
|
2912
|
+
type: 'object',
|
|
2913
|
+
},
|
|
2914
|
+
saml: {
|
|
2915
|
+
description: 'Will be used to create an invoice item. The price must be in cents: 2000 for $20.',
|
|
2916
|
+
properties: {
|
|
2917
|
+
createdAt: {
|
|
2918
|
+
type: 'number',
|
|
2919
|
+
},
|
|
2920
|
+
disabledAt: {
|
|
2921
|
+
type: ['number', 'null'],
|
|
2922
|
+
},
|
|
2923
|
+
frequency: {
|
|
2924
|
+
properties: {
|
|
2925
|
+
interval: {
|
|
2926
|
+
enum: ['month'],
|
|
2927
|
+
type: 'string',
|
|
2928
|
+
},
|
|
2929
|
+
intervalCount: {
|
|
2930
|
+
enum: [1, 3, 2, 6, 12],
|
|
2931
|
+
type: 'number',
|
|
2932
|
+
},
|
|
2933
|
+
},
|
|
2934
|
+
required: ['interval', 'intervalCount'],
|
|
2935
|
+
type: 'object',
|
|
2936
|
+
},
|
|
2937
|
+
hidden: {
|
|
2938
|
+
type: 'boolean',
|
|
2939
|
+
},
|
|
2940
|
+
maxQuantity: {
|
|
2941
|
+
type: 'number',
|
|
2942
|
+
},
|
|
2943
|
+
name: {
|
|
2944
|
+
type: 'string',
|
|
2945
|
+
},
|
|
2946
|
+
price: {
|
|
2947
|
+
type: 'number',
|
|
2948
|
+
},
|
|
2949
|
+
quantity: {
|
|
2950
|
+
type: 'number',
|
|
2951
|
+
},
|
|
2952
|
+
tier: {
|
|
2953
|
+
type: 'number',
|
|
2954
|
+
},
|
|
2955
|
+
},
|
|
2956
|
+
required: ['price', 'quantity', 'hidden'],
|
|
2957
|
+
type: 'object',
|
|
2958
|
+
},
|
|
2959
|
+
serverlessFunctionExecution: {
|
|
2960
|
+
properties: {
|
|
2961
|
+
batch: {
|
|
2962
|
+
type: 'number',
|
|
2963
|
+
},
|
|
2964
|
+
disabledAt: {
|
|
2965
|
+
type: ['number', 'null'],
|
|
2966
|
+
},
|
|
2967
|
+
hidden: {
|
|
2968
|
+
type: 'boolean',
|
|
2969
|
+
},
|
|
2970
|
+
name: {
|
|
2971
|
+
type: 'string',
|
|
2972
|
+
},
|
|
2973
|
+
price: {
|
|
2974
|
+
type: 'number',
|
|
2975
|
+
},
|
|
2976
|
+
threshold: {
|
|
2977
|
+
type: 'number',
|
|
2978
|
+
},
|
|
2979
|
+
tier: {
|
|
2980
|
+
type: 'number',
|
|
2981
|
+
},
|
|
2982
|
+
},
|
|
2983
|
+
required: ['price', 'batch', 'threshold', 'hidden'],
|
|
2984
|
+
type: 'object',
|
|
2985
|
+
},
|
|
2986
|
+
sourceImages: {
|
|
2987
|
+
properties: {
|
|
2988
|
+
batch: {
|
|
2989
|
+
type: 'number',
|
|
2990
|
+
},
|
|
2991
|
+
disabledAt: {
|
|
2992
|
+
type: ['number', 'null'],
|
|
2993
|
+
},
|
|
2994
|
+
hidden: {
|
|
2995
|
+
type: 'boolean',
|
|
2996
|
+
},
|
|
2997
|
+
name: {
|
|
2998
|
+
type: 'string',
|
|
2999
|
+
},
|
|
3000
|
+
price: {
|
|
3001
|
+
type: 'number',
|
|
3002
|
+
},
|
|
3003
|
+
threshold: {
|
|
3004
|
+
type: 'number',
|
|
3005
|
+
},
|
|
3006
|
+
tier: {
|
|
3007
|
+
type: 'number',
|
|
3008
|
+
},
|
|
3009
|
+
},
|
|
3010
|
+
required: ['price', 'batch', 'threshold', 'hidden'],
|
|
3011
|
+
type: 'object',
|
|
3012
|
+
},
|
|
3013
|
+
ssoProtection: {
|
|
3014
|
+
description: 'Will be used to create an invoice item. The price must be in cents: 2000 for $20.',
|
|
3015
|
+
properties: {
|
|
3016
|
+
createdAt: {
|
|
3017
|
+
type: 'number',
|
|
3018
|
+
},
|
|
3019
|
+
disabledAt: {
|
|
3020
|
+
type: ['number', 'null'],
|
|
3021
|
+
},
|
|
3022
|
+
frequency: {
|
|
3023
|
+
properties: {
|
|
3024
|
+
interval: {
|
|
3025
|
+
enum: ['month'],
|
|
3026
|
+
type: 'string',
|
|
3027
|
+
},
|
|
3028
|
+
intervalCount: {
|
|
3029
|
+
enum: [1, 3, 2, 6, 12],
|
|
3030
|
+
type: 'number',
|
|
3031
|
+
},
|
|
3032
|
+
},
|
|
3033
|
+
required: ['interval', 'intervalCount'],
|
|
3034
|
+
type: 'object',
|
|
3035
|
+
},
|
|
3036
|
+
hidden: {
|
|
3037
|
+
type: 'boolean',
|
|
3038
|
+
},
|
|
3039
|
+
maxQuantity: {
|
|
3040
|
+
type: 'number',
|
|
3041
|
+
},
|
|
3042
|
+
name: {
|
|
3043
|
+
type: 'string',
|
|
3044
|
+
},
|
|
3045
|
+
price: {
|
|
3046
|
+
type: 'number',
|
|
3047
|
+
},
|
|
3048
|
+
quantity: {
|
|
3049
|
+
type: 'number',
|
|
3050
|
+
},
|
|
3051
|
+
tier: {
|
|
3052
|
+
type: 'number',
|
|
3053
|
+
},
|
|
3054
|
+
},
|
|
3055
|
+
required: ['price', 'quantity', 'hidden'],
|
|
3056
|
+
type: 'object',
|
|
3057
|
+
},
|
|
3058
|
+
teamSeats: {
|
|
3059
|
+
description: 'Will be used to create an invoice item. The price must be in cents: 2000 for $20.',
|
|
3060
|
+
properties: {
|
|
3061
|
+
createdAt: {
|
|
3062
|
+
type: 'number',
|
|
3063
|
+
},
|
|
3064
|
+
disabledAt: {
|
|
3065
|
+
type: ['number', 'null'],
|
|
3066
|
+
},
|
|
3067
|
+
frequency: {
|
|
3068
|
+
properties: {
|
|
3069
|
+
interval: {
|
|
3070
|
+
enum: ['month'],
|
|
3071
|
+
type: 'string',
|
|
3072
|
+
},
|
|
3073
|
+
intervalCount: {
|
|
3074
|
+
enum: [1, 3, 2, 6, 12],
|
|
3075
|
+
type: 'number',
|
|
3076
|
+
},
|
|
3077
|
+
},
|
|
3078
|
+
required: ['interval', 'intervalCount'],
|
|
3079
|
+
type: 'object',
|
|
3080
|
+
},
|
|
3081
|
+
hidden: {
|
|
3082
|
+
type: 'boolean',
|
|
3083
|
+
},
|
|
3084
|
+
maxQuantity: {
|
|
3085
|
+
type: 'number',
|
|
3086
|
+
},
|
|
3087
|
+
name: {
|
|
3088
|
+
type: 'string',
|
|
3089
|
+
},
|
|
3090
|
+
price: {
|
|
3091
|
+
type: 'number',
|
|
3092
|
+
},
|
|
3093
|
+
quantity: {
|
|
3094
|
+
type: 'number',
|
|
3095
|
+
},
|
|
3096
|
+
tier: {
|
|
3097
|
+
type: 'number',
|
|
3098
|
+
},
|
|
3099
|
+
},
|
|
3100
|
+
required: ['price', 'quantity', 'hidden'],
|
|
3101
|
+
type: 'object',
|
|
3102
|
+
},
|
|
3103
|
+
webAnalytics: {
|
|
3104
|
+
description: 'Will be used to create an invoice item. The price must be in cents: 2000 for $20.',
|
|
3105
|
+
properties: {
|
|
3106
|
+
createdAt: {
|
|
3107
|
+
type: 'number',
|
|
3108
|
+
},
|
|
3109
|
+
disabledAt: {
|
|
3110
|
+
type: ['number', 'null'],
|
|
3111
|
+
},
|
|
3112
|
+
frequency: {
|
|
3113
|
+
properties: {
|
|
3114
|
+
interval: {
|
|
3115
|
+
enum: ['month'],
|
|
3116
|
+
type: 'string',
|
|
3117
|
+
},
|
|
3118
|
+
intervalCount: {
|
|
3119
|
+
enum: [1, 3, 2, 6, 12],
|
|
3120
|
+
type: 'number',
|
|
3121
|
+
},
|
|
3122
|
+
},
|
|
3123
|
+
required: ['interval', 'intervalCount'],
|
|
3124
|
+
type: 'object',
|
|
3125
|
+
},
|
|
3126
|
+
hidden: {
|
|
3127
|
+
type: 'boolean',
|
|
3128
|
+
},
|
|
3129
|
+
maxQuantity: {
|
|
3130
|
+
type: 'number',
|
|
3131
|
+
},
|
|
3132
|
+
name: {
|
|
3133
|
+
type: 'string',
|
|
3134
|
+
},
|
|
3135
|
+
price: {
|
|
3136
|
+
type: 'number',
|
|
3137
|
+
},
|
|
3138
|
+
quantity: {
|
|
3139
|
+
type: 'number',
|
|
3140
|
+
},
|
|
3141
|
+
tier: {
|
|
3142
|
+
type: 'number',
|
|
3143
|
+
},
|
|
3144
|
+
},
|
|
3145
|
+
required: ['price', 'quantity', 'hidden'],
|
|
3146
|
+
type: 'object',
|
|
3147
|
+
},
|
|
3148
|
+
webAnalyticsEvent: {
|
|
3149
|
+
properties: {
|
|
3150
|
+
batch: {
|
|
3151
|
+
type: 'number',
|
|
3152
|
+
},
|
|
3153
|
+
disabledAt: {
|
|
3154
|
+
type: ['number', 'null'],
|
|
3155
|
+
},
|
|
3156
|
+
hidden: {
|
|
3157
|
+
type: 'boolean',
|
|
3158
|
+
},
|
|
3159
|
+
name: {
|
|
3160
|
+
type: 'string',
|
|
3161
|
+
},
|
|
3162
|
+
price: {
|
|
3163
|
+
type: 'number',
|
|
3164
|
+
},
|
|
3165
|
+
threshold: {
|
|
3166
|
+
type: 'number',
|
|
3167
|
+
},
|
|
3168
|
+
tier: {
|
|
3169
|
+
type: 'number',
|
|
3170
|
+
},
|
|
3171
|
+
},
|
|
3172
|
+
required: ['price', 'batch', 'threshold', 'hidden'],
|
|
3173
|
+
type: 'object',
|
|
3174
|
+
},
|
|
3175
|
+
},
|
|
3176
|
+
type: ['object', 'null'],
|
|
3177
|
+
},
|
|
3178
|
+
invoiceSettings: {
|
|
3179
|
+
properties: {
|
|
3180
|
+
footer: {
|
|
3181
|
+
type: 'string',
|
|
3182
|
+
},
|
|
3183
|
+
},
|
|
3184
|
+
type: 'object',
|
|
3185
|
+
},
|
|
3186
|
+
language: {
|
|
3187
|
+
type: ['string', 'null'],
|
|
3188
|
+
},
|
|
3189
|
+
name: {
|
|
3190
|
+
type: ['string', 'null'],
|
|
3191
|
+
},
|
|
3192
|
+
orbCustomerId: {
|
|
3193
|
+
type: 'string',
|
|
3194
|
+
},
|
|
3195
|
+
overdue: {
|
|
3196
|
+
type: ['boolean', 'null'],
|
|
3197
|
+
},
|
|
3198
|
+
period: {
|
|
3199
|
+
properties: {
|
|
3200
|
+
end: {
|
|
3201
|
+
type: 'number',
|
|
3202
|
+
},
|
|
3203
|
+
start: {
|
|
3204
|
+
type: 'number',
|
|
3205
|
+
},
|
|
3206
|
+
},
|
|
3207
|
+
required: ['start', 'end'],
|
|
3208
|
+
type: ['object', 'null'],
|
|
3209
|
+
},
|
|
3210
|
+
plan: {
|
|
3211
|
+
enum: ['hobby', 'enterprise', 'pro'],
|
|
3212
|
+
type: 'string',
|
|
3213
|
+
},
|
|
3214
|
+
platform: {
|
|
3215
|
+
enum: ['stripe', 'stripeTestMode'],
|
|
3216
|
+
type: 'string',
|
|
3217
|
+
},
|
|
3218
|
+
pricingExperiment: {
|
|
3219
|
+
enum: ['august-2022'],
|
|
3220
|
+
type: 'string',
|
|
3221
|
+
},
|
|
3222
|
+
programType: {
|
|
3223
|
+
enum: ['startup', 'agency'],
|
|
3224
|
+
type: 'string',
|
|
3225
|
+
},
|
|
3226
|
+
purchaseOrder: {
|
|
3227
|
+
type: ['string', 'null'],
|
|
3228
|
+
},
|
|
3229
|
+
status: {
|
|
3230
|
+
enum: ['active', 'canceled', 'trialing', 'overdue', 'expired'],
|
|
3231
|
+
type: 'string',
|
|
3232
|
+
},
|
|
3233
|
+
subscriptions: {
|
|
3234
|
+
items: {
|
|
3235
|
+
properties: {
|
|
3236
|
+
discount: {
|
|
3237
|
+
properties: {
|
|
3238
|
+
coupon: {
|
|
3239
|
+
properties: {
|
|
3240
|
+
amountOff: {
|
|
3241
|
+
type: ['number', 'null'],
|
|
3242
|
+
},
|
|
3243
|
+
duration: {
|
|
3244
|
+
enum: ['forever', 'repeating', 'once'],
|
|
3245
|
+
type: 'string',
|
|
3246
|
+
},
|
|
3247
|
+
durationInMonths: {
|
|
3248
|
+
type: ['number', 'null'],
|
|
3249
|
+
},
|
|
3250
|
+
id: {
|
|
3251
|
+
type: 'string',
|
|
3252
|
+
},
|
|
3253
|
+
name: {
|
|
3254
|
+
type: ['string', 'null'],
|
|
3255
|
+
},
|
|
3256
|
+
percentageOff: {
|
|
3257
|
+
type: ['number', 'null'],
|
|
3258
|
+
},
|
|
3259
|
+
},
|
|
3260
|
+
required: ['id', 'name', 'amountOff', 'percentageOff', 'durationInMonths', 'duration'],
|
|
3261
|
+
type: 'object',
|
|
3262
|
+
},
|
|
3263
|
+
id: {
|
|
3264
|
+
type: 'string',
|
|
3265
|
+
},
|
|
3266
|
+
},
|
|
3267
|
+
required: ['id', 'coupon'],
|
|
3268
|
+
type: ['object', 'null'],
|
|
3269
|
+
},
|
|
3270
|
+
frequency: {
|
|
3271
|
+
properties: {
|
|
3272
|
+
interval: {
|
|
3273
|
+
enum: ['month', 'day', 'week', 'year'],
|
|
3274
|
+
type: 'string',
|
|
3275
|
+
},
|
|
3276
|
+
intervalCount: {
|
|
3277
|
+
type: 'number',
|
|
3278
|
+
},
|
|
3279
|
+
},
|
|
3280
|
+
required: ['interval', 'intervalCount'],
|
|
3281
|
+
type: 'object',
|
|
3282
|
+
},
|
|
3283
|
+
id: {
|
|
3284
|
+
type: 'string',
|
|
3285
|
+
},
|
|
3286
|
+
items: {
|
|
3287
|
+
items: {
|
|
3288
|
+
properties: {
|
|
3289
|
+
amount: {
|
|
3290
|
+
type: 'number',
|
|
3291
|
+
},
|
|
3292
|
+
id: {
|
|
3293
|
+
type: 'string',
|
|
3294
|
+
},
|
|
3295
|
+
priceId: {
|
|
3296
|
+
type: 'string',
|
|
3297
|
+
},
|
|
3298
|
+
productId: {
|
|
3299
|
+
type: 'string',
|
|
3300
|
+
},
|
|
3301
|
+
quantity: {
|
|
3302
|
+
type: 'number',
|
|
3303
|
+
},
|
|
3304
|
+
},
|
|
3305
|
+
required: ['id', 'priceId', 'productId', 'amount', 'quantity'],
|
|
3306
|
+
type: 'object',
|
|
3307
|
+
},
|
|
3308
|
+
type: 'array',
|
|
3309
|
+
},
|
|
3310
|
+
period: {
|
|
3311
|
+
properties: {
|
|
3312
|
+
end: {
|
|
3313
|
+
type: 'number',
|
|
3314
|
+
},
|
|
3315
|
+
start: {
|
|
3316
|
+
type: 'number',
|
|
3317
|
+
},
|
|
3318
|
+
},
|
|
3319
|
+
required: ['start', 'end'],
|
|
3320
|
+
type: 'object',
|
|
3321
|
+
},
|
|
3322
|
+
trial: {
|
|
3323
|
+
properties: {
|
|
3324
|
+
end: {
|
|
3325
|
+
type: 'number',
|
|
3326
|
+
},
|
|
3327
|
+
start: {
|
|
3328
|
+
type: 'number',
|
|
3329
|
+
},
|
|
3330
|
+
},
|
|
3331
|
+
required: ['start', 'end'],
|
|
3332
|
+
type: ['object', 'null'],
|
|
3333
|
+
},
|
|
3334
|
+
},
|
|
3335
|
+
required: ['id', 'trial', 'period', 'frequency', 'discount', 'items'],
|
|
3336
|
+
type: 'object',
|
|
3337
|
+
},
|
|
3338
|
+
type: ['array', 'null'],
|
|
3339
|
+
},
|
|
3340
|
+
tax: {
|
|
3341
|
+
properties: {
|
|
3342
|
+
id: {
|
|
3343
|
+
type: 'string',
|
|
3344
|
+
},
|
|
3345
|
+
type: {
|
|
3346
|
+
type: 'string',
|
|
3347
|
+
},
|
|
3348
|
+
},
|
|
3349
|
+
required: ['type', 'id'],
|
|
3350
|
+
type: ['object', 'null'],
|
|
3351
|
+
},
|
|
3352
|
+
trial: {
|
|
3353
|
+
properties: {
|
|
3354
|
+
end: {
|
|
3355
|
+
type: 'number',
|
|
3356
|
+
},
|
|
3357
|
+
start: {
|
|
3358
|
+
type: 'number',
|
|
3359
|
+
},
|
|
3360
|
+
},
|
|
3361
|
+
required: ['start', 'end'],
|
|
3362
|
+
type: ['object', 'null'],
|
|
3363
|
+
},
|
|
3364
|
+
},
|
|
3365
|
+
required: ['period', 'plan'],
|
|
3366
|
+
type: ['object', 'null'],
|
|
3367
|
+
},
|
|
3368
|
+
createdAt: {
|
|
3369
|
+
description: 'UNIX timestamp (in milliseconds) when the User account was created.',
|
|
3370
|
+
examples: [1630748523395],
|
|
3371
|
+
type: 'number',
|
|
3372
|
+
},
|
|
3373
|
+
dismissedToasts: {
|
|
3374
|
+
description: 'A record of when, under a certain scopeId, a toast was dismissed',
|
|
3375
|
+
items: {
|
|
3376
|
+
description: 'A record of when, under a certain scopeId, a toast was dismissed',
|
|
3377
|
+
properties: {
|
|
3378
|
+
dismissals: {
|
|
3379
|
+
items: {
|
|
3380
|
+
properties: {
|
|
3381
|
+
createdAt: {
|
|
3382
|
+
type: 'number',
|
|
3383
|
+
},
|
|
3384
|
+
scopeId: {
|
|
3385
|
+
type: 'string',
|
|
3386
|
+
},
|
|
3387
|
+
},
|
|
3388
|
+
required: ['scopeId', 'createdAt'],
|
|
3389
|
+
type: 'object',
|
|
3390
|
+
},
|
|
3391
|
+
type: 'array',
|
|
3392
|
+
},
|
|
3393
|
+
name: {
|
|
3394
|
+
type: 'string',
|
|
3395
|
+
},
|
|
3396
|
+
},
|
|
3397
|
+
required: ['name', 'dismissals'],
|
|
3398
|
+
type: 'object',
|
|
3399
|
+
},
|
|
3400
|
+
type: 'array',
|
|
3401
|
+
},
|
|
3402
|
+
email: {
|
|
3403
|
+
description: 'Email address associated with the User account.',
|
|
3404
|
+
examples: ['me@example.com'],
|
|
3405
|
+
type: 'string',
|
|
3406
|
+
},
|
|
3407
|
+
favoriteProjects: {
|
|
3408
|
+
description: 'A list of projects across teams that a user has marked as a favorite.',
|
|
3409
|
+
items: {
|
|
3410
|
+
description: 'A list of projects across teams that a user has marked as a favorite.',
|
|
3411
|
+
properties: {
|
|
3412
|
+
projectId: {
|
|
3413
|
+
type: 'string',
|
|
3414
|
+
},
|
|
3415
|
+
scopeId: {
|
|
3416
|
+
type: 'string',
|
|
3417
|
+
},
|
|
3418
|
+
scopeSlug: {
|
|
3419
|
+
type: 'string',
|
|
3420
|
+
},
|
|
3421
|
+
},
|
|
3422
|
+
required: ['projectId', 'scopeId', 'scopeSlug'],
|
|
3423
|
+
type: 'object',
|
|
3424
|
+
},
|
|
3425
|
+
type: 'array',
|
|
3426
|
+
},
|
|
3427
|
+
hasTrialAvailable: {
|
|
3428
|
+
description: 'Whether the user has a trial available for a paid plan subscription.',
|
|
3429
|
+
type: 'boolean',
|
|
3430
|
+
},
|
|
3431
|
+
id: {
|
|
3432
|
+
description: "The User's unique identifier.",
|
|
3433
|
+
examples: ['AEIIDYVk59zbFF2Sxfyxxmua'],
|
|
3434
|
+
type: 'string',
|
|
3435
|
+
},
|
|
3436
|
+
importFlowGitNamespace: {
|
|
3437
|
+
oneOf: [
|
|
3438
|
+
{
|
|
3439
|
+
type: 'string',
|
|
3440
|
+
},
|
|
3441
|
+
{
|
|
3442
|
+
type: 'number',
|
|
3443
|
+
},
|
|
3444
|
+
],
|
|
3445
|
+
type: 'null',
|
|
3446
|
+
},
|
|
3447
|
+
importFlowGitNamespaceId: {
|
|
3448
|
+
oneOf: [
|
|
3449
|
+
{
|
|
3450
|
+
type: 'string',
|
|
3451
|
+
},
|
|
3452
|
+
{
|
|
3453
|
+
type: 'number',
|
|
3454
|
+
},
|
|
3455
|
+
],
|
|
3456
|
+
type: 'null',
|
|
3457
|
+
},
|
|
3458
|
+
importFlowGitProvider: {
|
|
3459
|
+
enum: ['github', 'gitlab', 'bitbucket'],
|
|
3460
|
+
type: 'string',
|
|
3461
|
+
},
|
|
3462
|
+
name: {
|
|
3463
|
+
description: 'Name associated with the User account, or `null` if none has been provided.',
|
|
3464
|
+
examples: ['John Doe'],
|
|
3465
|
+
type: ['string', 'null'],
|
|
3466
|
+
},
|
|
3467
|
+
preferredScopesAndGitNamespaces: {
|
|
3468
|
+
items: {
|
|
3469
|
+
properties: {
|
|
3470
|
+
gitNamespaceId: {
|
|
3471
|
+
oneOf: [
|
|
3472
|
+
{
|
|
3473
|
+
type: 'string',
|
|
3474
|
+
},
|
|
3475
|
+
{
|
|
3476
|
+
type: 'number',
|
|
3477
|
+
},
|
|
3478
|
+
],
|
|
3479
|
+
type: 'null',
|
|
3480
|
+
},
|
|
3481
|
+
scopeId: {
|
|
3482
|
+
type: 'string',
|
|
3483
|
+
},
|
|
3484
|
+
},
|
|
3485
|
+
required: ['scopeId', 'gitNamespaceId'],
|
|
3486
|
+
type: 'object',
|
|
3487
|
+
},
|
|
3488
|
+
type: 'array',
|
|
3489
|
+
},
|
|
3490
|
+
remoteCaching: {
|
|
3491
|
+
description: 'remote caching settings',
|
|
3492
|
+
properties: {
|
|
3493
|
+
enabled: {
|
|
3494
|
+
type: 'boolean',
|
|
3495
|
+
},
|
|
3496
|
+
},
|
|
3497
|
+
type: 'object',
|
|
3498
|
+
},
|
|
3499
|
+
resourceConfig: {
|
|
3500
|
+
description:
|
|
3501
|
+
'An object containing infomation related to the amount of platform resources may be allocated to the User account.',
|
|
3502
|
+
properties: {
|
|
3503
|
+
awsAccountIds: {
|
|
3504
|
+
items: {
|
|
3505
|
+
type: 'string',
|
|
3506
|
+
},
|
|
3507
|
+
type: 'array',
|
|
3508
|
+
},
|
|
3509
|
+
awsAccountType: {
|
|
3510
|
+
type: 'string',
|
|
3511
|
+
},
|
|
3512
|
+
cfZoneName: {
|
|
3513
|
+
type: 'string',
|
|
3514
|
+
},
|
|
3515
|
+
concurrentBuilds: {
|
|
3516
|
+
type: 'number',
|
|
3517
|
+
},
|
|
3518
|
+
edgeConfigSize: {
|
|
3519
|
+
description:
|
|
3520
|
+
'To overwrite the maximum size of an Edge Config per account. Size is in kilobytes, eg 64 leads to 64kB or 64_000 bytes worth of storage',
|
|
3521
|
+
type: 'number',
|
|
3522
|
+
},
|
|
3523
|
+
edgeConfigs: {
|
|
3524
|
+
description: 'To overwrite the number of Edge Configs an account can create.',
|
|
3525
|
+
type: 'number',
|
|
3526
|
+
},
|
|
3527
|
+
nodeType: {
|
|
3528
|
+
type: 'string',
|
|
3529
|
+
},
|
|
3530
|
+
},
|
|
3531
|
+
type: 'object',
|
|
3532
|
+
},
|
|
3533
|
+
softBlock: {
|
|
3534
|
+
description:
|
|
3535
|
+
'When the User account has been "soft blocked", this property will contain the date when the restriction was enacted, and the identifier for why.',
|
|
3536
|
+
properties: {
|
|
3537
|
+
blockedAt: {
|
|
3538
|
+
type: 'number',
|
|
3539
|
+
},
|
|
3540
|
+
reason: {
|
|
3541
|
+
enum: [
|
|
3542
|
+
'FAIR_USE_LIMITS_EXCEEDED',
|
|
3543
|
+
'ENTERPRISE_TRIAL_ENDED',
|
|
3544
|
+
'BLOCKED_FOR_PLATFORM_ABUSE',
|
|
3545
|
+
'UNPAID_INVOICE',
|
|
3546
|
+
'SUBSCRIPTION_EXPIRED',
|
|
3547
|
+
'SUBSCRIPTION_CANCELED',
|
|
3548
|
+
],
|
|
3549
|
+
type: 'string',
|
|
3550
|
+
},
|
|
3551
|
+
},
|
|
3552
|
+
required: ['blockedAt', 'reason'],
|
|
3553
|
+
type: ['object', 'null'],
|
|
3554
|
+
},
|
|
3555
|
+
stagingPrefix: {
|
|
3556
|
+
description: 'Prefix that will be used in the URL of "Preview" deployments created by the User account.',
|
|
3557
|
+
type: 'string',
|
|
3558
|
+
},
|
|
3559
|
+
username: {
|
|
3560
|
+
description: 'Unique username associated with the User account.',
|
|
3561
|
+
examples: ['jdoe'],
|
|
3562
|
+
type: 'string',
|
|
3563
|
+
},
|
|
3564
|
+
},
|
|
3565
|
+
required: [
|
|
3566
|
+
'createdAt',
|
|
3567
|
+
'softBlock',
|
|
3568
|
+
'billing',
|
|
3569
|
+
'resourceConfig',
|
|
3570
|
+
'stagingPrefix',
|
|
3571
|
+
'hasTrialAvailable',
|
|
3572
|
+
'id',
|
|
3573
|
+
'email',
|
|
3574
|
+
'name',
|
|
3575
|
+
'username',
|
|
3576
|
+
'avatar',
|
|
3577
|
+
],
|
|
3578
|
+
type: 'object',
|
|
3579
|
+
},
|
|
3580
|
+
AuthUserLimited: {
|
|
3581
|
+
description:
|
|
3582
|
+
'A limited form of data for the currently authenticated User, due to the authentication token missing privileges to read the full User data.',
|
|
3583
|
+
properties: {
|
|
3584
|
+
avatar: {
|
|
3585
|
+
description:
|
|
3586
|
+
'SHA1 hash of the avatar for the User account. Can be used in conjuction with the ... endpoint to retrieve the avatar image.',
|
|
3587
|
+
examples: ['22cb30c85ff45ac4c72de8981500006b28114aa1'],
|
|
3588
|
+
type: ['string', 'null'],
|
|
3589
|
+
},
|
|
3590
|
+
email: {
|
|
3591
|
+
description: 'Email address associated with the User account.',
|
|
3592
|
+
examples: ['me@example.com'],
|
|
3593
|
+
type: 'string',
|
|
3594
|
+
},
|
|
3595
|
+
id: {
|
|
3596
|
+
description: "The User's unique identifier.",
|
|
3597
|
+
examples: ['AEIIDYVk59zbFF2Sxfyxxmua'],
|
|
3598
|
+
type: 'string',
|
|
3599
|
+
},
|
|
3600
|
+
limited: {
|
|
3601
|
+
description:
|
|
3602
|
+
'Property indicating that this User data contains only limited information, due to the authentication token missing privileges to read the full User data. Re-login with email, GitHub, GitLab or Bitbucket in order to upgrade the authentication token with the necessary privileges.',
|
|
3603
|
+
type: 'boolean',
|
|
3604
|
+
},
|
|
3605
|
+
name: {
|
|
3606
|
+
description: 'Name associated with the User account, or `null` if none has been provided.',
|
|
3607
|
+
examples: ['John Doe'],
|
|
3608
|
+
type: ['string', 'null'],
|
|
3609
|
+
},
|
|
3610
|
+
username: {
|
|
3611
|
+
description: 'Unique username associated with the User account.',
|
|
3612
|
+
examples: ['jdoe'],
|
|
3613
|
+
type: 'string',
|
|
3614
|
+
},
|
|
3615
|
+
},
|
|
3616
|
+
required: ['limited', 'id', 'email', 'name', 'username', 'avatar'],
|
|
3617
|
+
type: 'object',
|
|
3618
|
+
},
|
|
3619
|
+
EdgeConfigItem: {
|
|
3620
|
+
description: 'The EdgeConfig.',
|
|
3621
|
+
properties: {
|
|
3622
|
+
createdAt: {
|
|
3623
|
+
type: 'number',
|
|
3624
|
+
},
|
|
3625
|
+
edgeConfigId: {
|
|
3626
|
+
type: 'string',
|
|
3627
|
+
},
|
|
3628
|
+
key: {
|
|
3629
|
+
type: 'string',
|
|
3630
|
+
},
|
|
3631
|
+
updatedAt: {
|
|
3632
|
+
type: 'number',
|
|
3633
|
+
},
|
|
3634
|
+
value: {
|
|
3635
|
+
$ref: '#/components/schemas/EdgeConfigItemValue',
|
|
3636
|
+
},
|
|
3637
|
+
},
|
|
3638
|
+
required: ['key', 'value', 'edgeConfigId', 'createdAt', 'updatedAt'],
|
|
3639
|
+
type: 'object',
|
|
3640
|
+
},
|
|
3641
|
+
EdgeConfigItemValue: {
|
|
3642
|
+
oneOf: [
|
|
3643
|
+
{
|
|
3644
|
+
type: 'string',
|
|
3645
|
+
},
|
|
3646
|
+
{
|
|
3647
|
+
type: 'number',
|
|
3648
|
+
},
|
|
3649
|
+
{
|
|
3650
|
+
type: 'boolean',
|
|
3651
|
+
},
|
|
3652
|
+
{
|
|
3653
|
+
type: 'object',
|
|
3654
|
+
},
|
|
3655
|
+
{
|
|
3656
|
+
items: {
|
|
3657
|
+
$ref: '#/components/schemas/EdgeConfigItemValue',
|
|
3658
|
+
},
|
|
3659
|
+
type: 'array',
|
|
3660
|
+
},
|
|
3661
|
+
],
|
|
3662
|
+
type: 'null',
|
|
3663
|
+
},
|
|
3664
|
+
EdgeConfigToken: {
|
|
3665
|
+
description: 'The EdgeConfig.',
|
|
3666
|
+
properties: {
|
|
3667
|
+
createdAt: {
|
|
3668
|
+
type: 'number',
|
|
3669
|
+
},
|
|
3670
|
+
edgeConfigId: {
|
|
3671
|
+
type: 'string',
|
|
3672
|
+
},
|
|
3673
|
+
id: {
|
|
3674
|
+
description: 'This is not the token itself, but rather an id to identify the token by',
|
|
3675
|
+
type: 'string',
|
|
3676
|
+
},
|
|
3677
|
+
label: {
|
|
3678
|
+
type: 'string',
|
|
3679
|
+
},
|
|
3680
|
+
token: {
|
|
3681
|
+
type: 'string',
|
|
3682
|
+
},
|
|
3683
|
+
},
|
|
3684
|
+
required: ['token', 'label', 'id', 'edgeConfigId', 'createdAt'],
|
|
3685
|
+
type: 'object',
|
|
3686
|
+
},
|
|
3687
|
+
FileTree: {
|
|
3688
|
+
description: 'A deployment file tree entry',
|
|
3689
|
+
properties: {
|
|
3690
|
+
children: {
|
|
3691
|
+
description: 'The list of children files of the directory (only valid for the `directory` type)',
|
|
3692
|
+
items: {
|
|
3693
|
+
$ref: '#/components/schemas/FileTree',
|
|
3694
|
+
},
|
|
3695
|
+
type: 'array',
|
|
3696
|
+
},
|
|
3697
|
+
contentType: {
|
|
3698
|
+
description: 'The content-type of the file (only valid for the `file` type)',
|
|
3699
|
+
examples: ['application/json'],
|
|
3700
|
+
type: 'string',
|
|
3701
|
+
},
|
|
3702
|
+
mode: {
|
|
3703
|
+
description: 'The file "mode" indicating file type and permissions.',
|
|
3704
|
+
type: 'number',
|
|
3705
|
+
},
|
|
3706
|
+
name: {
|
|
3707
|
+
description: 'The name of the file tree entry',
|
|
3708
|
+
examples: ['my-file.json'],
|
|
3709
|
+
type: 'string',
|
|
3710
|
+
},
|
|
3711
|
+
symlink: {
|
|
3712
|
+
description: 'Not currently used. See `file-list-to-tree.ts`.',
|
|
3713
|
+
type: 'string',
|
|
3714
|
+
},
|
|
3715
|
+
type: {
|
|
3716
|
+
description: 'String indicating the type of file tree entry.',
|
|
3717
|
+
enum: ['directory', 'file', 'symlink', 'lambda', 'middleware', 'invalid'],
|
|
3718
|
+
examples: ['file'],
|
|
3719
|
+
type: 'string',
|
|
3720
|
+
},
|
|
3721
|
+
uid: {
|
|
3722
|
+
description: 'The unique identifier of the file (only valid for the `file` type)',
|
|
3723
|
+
examples: ['2d4aad419917f15b1146e9e03ddc9bb31747e4d0'],
|
|
3724
|
+
type: 'string',
|
|
3725
|
+
},
|
|
3726
|
+
},
|
|
3727
|
+
required: ['name', 'type', 'mode'],
|
|
3728
|
+
type: 'object',
|
|
3729
|
+
},
|
|
3730
|
+
Pagination: {
|
|
3731
|
+
description:
|
|
3732
|
+
'This object contains information related to the pagination of the current request, including the necessary parameters to get the next or previous page of data.',
|
|
3733
|
+
properties: {
|
|
3734
|
+
count: {
|
|
3735
|
+
description: 'Amount of items in the current page.',
|
|
3736
|
+
examples: [20],
|
|
3737
|
+
type: 'number',
|
|
3738
|
+
},
|
|
3739
|
+
next: {
|
|
3740
|
+
description: 'Timestamp that must be used to request the next page.',
|
|
3741
|
+
examples: [1540095775951],
|
|
3742
|
+
type: ['number', 'null'],
|
|
3743
|
+
},
|
|
3744
|
+
prev: {
|
|
3745
|
+
description: 'Timestamp that must be used to request the previous page.',
|
|
3746
|
+
examples: [1540095775951],
|
|
3747
|
+
type: ['number', 'null'],
|
|
3748
|
+
},
|
|
3749
|
+
},
|
|
3750
|
+
required: ['count', 'next', 'prev'],
|
|
3751
|
+
type: 'object',
|
|
3752
|
+
},
|
|
3753
|
+
Team: {
|
|
3754
|
+
description: 'Data representing a Team.',
|
|
3755
|
+
type: 'object',
|
|
3756
|
+
},
|
|
3757
|
+
TeamLimited: {
|
|
3758
|
+
description:
|
|
3759
|
+
'A limited form of data representing a Team, due to the authentication token missing privileges to read the full Team data.',
|
|
3760
|
+
properties: {
|
|
3761
|
+
avatar: {
|
|
3762
|
+
description: 'The ID of the file used as avatar for this Team.',
|
|
3763
|
+
examples: ['6eb07268bcfadd309905ffb1579354084c24655c'],
|
|
3764
|
+
type: ['string', 'null'],
|
|
3765
|
+
},
|
|
3766
|
+
created: {
|
|
3767
|
+
description: 'Will remain undocumented. Remove in v3 API.',
|
|
3768
|
+
type: 'string',
|
|
3769
|
+
},
|
|
3770
|
+
createdAt: {
|
|
3771
|
+
description: 'UNIX timestamp (in milliseconds) when the Team was created.',
|
|
3772
|
+
examples: [1630748523395],
|
|
3773
|
+
type: 'number',
|
|
3774
|
+
},
|
|
3775
|
+
id: {
|
|
3776
|
+
description: "The Team's unique identifier.",
|
|
3777
|
+
examples: ['team_nllPyCtREAqxxdyFKbbMDlxd'],
|
|
3778
|
+
type: 'string',
|
|
3779
|
+
},
|
|
3780
|
+
limited: {
|
|
3781
|
+
description:
|
|
3782
|
+
"Property indicating that this Team data contains only limited information, due to the authentication token missing privileges to read the full Team data. Re-login with the Team's configured SAML Single Sign-On provider in order to upgrade the authentication token with the necessary privileges.",
|
|
3783
|
+
type: 'boolean',
|
|
3784
|
+
},
|
|
3785
|
+
membership: {
|
|
3786
|
+
oneOf: [
|
|
3787
|
+
{
|
|
3788
|
+
description: 'The membership of the authenticated User in relation to the Team.',
|
|
3789
|
+
properties: {
|
|
3790
|
+
accessRequestedAt: {
|
|
3791
|
+
type: 'number',
|
|
3792
|
+
},
|
|
3793
|
+
confirmed: {
|
|
3794
|
+
type: 'boolean',
|
|
3795
|
+
},
|
|
3796
|
+
confirmedAt: {
|
|
3797
|
+
type: 'number',
|
|
3798
|
+
},
|
|
3799
|
+
created: {
|
|
3800
|
+
type: 'number',
|
|
3801
|
+
},
|
|
3802
|
+
createdAt: {
|
|
3803
|
+
type: 'number',
|
|
3804
|
+
},
|
|
3805
|
+
joinedFrom: {
|
|
3806
|
+
properties: {
|
|
3807
|
+
commitId: {
|
|
3808
|
+
type: 'string',
|
|
3809
|
+
},
|
|
3810
|
+
dsyncConnectedAt: {
|
|
3811
|
+
type: 'number',
|
|
3812
|
+
},
|
|
3813
|
+
dsyncUserId: {
|
|
3814
|
+
type: 'string',
|
|
3815
|
+
},
|
|
3816
|
+
gitUserId: {
|
|
3817
|
+
oneOf: [
|
|
3818
|
+
{
|
|
3819
|
+
type: 'string',
|
|
3820
|
+
},
|
|
3821
|
+
{
|
|
3822
|
+
type: 'number',
|
|
3823
|
+
},
|
|
3824
|
+
],
|
|
3825
|
+
},
|
|
3826
|
+
gitUserLogin: {
|
|
3827
|
+
type: 'string',
|
|
3828
|
+
},
|
|
3829
|
+
idpUserId: {
|
|
3830
|
+
type: 'string',
|
|
3831
|
+
},
|
|
3832
|
+
origin: {
|
|
3833
|
+
enum: [
|
|
3834
|
+
'import',
|
|
3835
|
+
'saml',
|
|
3836
|
+
'mail',
|
|
3837
|
+
'link',
|
|
3838
|
+
'teams',
|
|
3839
|
+
'github',
|
|
3840
|
+
'gitlab',
|
|
3841
|
+
'bitbucket',
|
|
3842
|
+
'dsync',
|
|
3843
|
+
'feedback',
|
|
3844
|
+
'organization-teams',
|
|
3845
|
+
],
|
|
3846
|
+
type: 'string',
|
|
3847
|
+
},
|
|
3848
|
+
repoId: {
|
|
3849
|
+
type: 'string',
|
|
3850
|
+
},
|
|
3851
|
+
repoPath: {
|
|
3852
|
+
type: 'string',
|
|
3853
|
+
},
|
|
3854
|
+
ssoConnectedAt: {
|
|
3855
|
+
type: 'number',
|
|
3856
|
+
},
|
|
3857
|
+
ssoUserId: {
|
|
3858
|
+
type: 'string',
|
|
3859
|
+
},
|
|
3860
|
+
},
|
|
3861
|
+
required: ['origin'],
|
|
3862
|
+
type: 'object',
|
|
3863
|
+
},
|
|
3864
|
+
role: {
|
|
3865
|
+
enum: ['MEMBER', 'OWNER', 'VIEWER', 'DEVELOPER', 'BILLING'],
|
|
3866
|
+
type: 'string',
|
|
3867
|
+
},
|
|
3868
|
+
teamId: {
|
|
3869
|
+
type: 'string',
|
|
3870
|
+
},
|
|
3871
|
+
uid: {
|
|
3872
|
+
type: 'string',
|
|
3873
|
+
},
|
|
3874
|
+
},
|
|
3875
|
+
required: ['confirmed', 'confirmedAt', 'role', 'uid', 'createdAt', 'created'],
|
|
3876
|
+
type: 'object',
|
|
3877
|
+
},
|
|
3878
|
+
{
|
|
3879
|
+
description: 'The membership of the authenticated User in relation to the Team.',
|
|
3880
|
+
properties: {
|
|
3881
|
+
accessRequestedAt: {
|
|
3882
|
+
type: 'number',
|
|
3883
|
+
},
|
|
3884
|
+
confirmed: {
|
|
3885
|
+
type: 'boolean',
|
|
3886
|
+
},
|
|
3887
|
+
confirmedAt: {
|
|
3888
|
+
type: 'number',
|
|
3889
|
+
},
|
|
3890
|
+
created: {
|
|
3891
|
+
type: 'number',
|
|
3892
|
+
},
|
|
3893
|
+
createdAt: {
|
|
3894
|
+
type: 'number',
|
|
3895
|
+
},
|
|
3896
|
+
joinedFrom: {
|
|
3897
|
+
properties: {
|
|
3898
|
+
commitId: {
|
|
3899
|
+
type: 'string',
|
|
3900
|
+
},
|
|
3901
|
+
dsyncConnectedAt: {
|
|
3902
|
+
type: 'number',
|
|
3903
|
+
},
|
|
3904
|
+
dsyncUserId: {
|
|
3905
|
+
type: 'string',
|
|
3906
|
+
},
|
|
3907
|
+
gitUserId: {
|
|
3908
|
+
oneOf: [
|
|
3909
|
+
{
|
|
3910
|
+
type: 'string',
|
|
3911
|
+
},
|
|
3912
|
+
{
|
|
3913
|
+
type: 'number',
|
|
3914
|
+
},
|
|
3915
|
+
],
|
|
3916
|
+
},
|
|
3917
|
+
gitUserLogin: {
|
|
3918
|
+
type: 'string',
|
|
3919
|
+
},
|
|
3920
|
+
idpUserId: {
|
|
3921
|
+
type: 'string',
|
|
3922
|
+
},
|
|
3923
|
+
origin: {
|
|
3924
|
+
enum: [
|
|
3925
|
+
'import',
|
|
3926
|
+
'saml',
|
|
3927
|
+
'mail',
|
|
3928
|
+
'link',
|
|
3929
|
+
'teams',
|
|
3930
|
+
'github',
|
|
3931
|
+
'gitlab',
|
|
3932
|
+
'bitbucket',
|
|
3933
|
+
'dsync',
|
|
3934
|
+
'feedback',
|
|
3935
|
+
'organization-teams',
|
|
3936
|
+
],
|
|
3937
|
+
type: 'string',
|
|
3938
|
+
},
|
|
3939
|
+
repoId: {
|
|
3940
|
+
type: 'string',
|
|
3941
|
+
},
|
|
3942
|
+
repoPath: {
|
|
3943
|
+
type: 'string',
|
|
3944
|
+
},
|
|
3945
|
+
ssoConnectedAt: {
|
|
3946
|
+
type: 'number',
|
|
3947
|
+
},
|
|
3948
|
+
ssoUserId: {
|
|
3949
|
+
type: 'string',
|
|
3950
|
+
},
|
|
3951
|
+
},
|
|
3952
|
+
required: ['origin'],
|
|
3953
|
+
type: 'object',
|
|
3954
|
+
},
|
|
3955
|
+
role: {
|
|
3956
|
+
enum: ['MEMBER', 'OWNER', 'VIEWER', 'DEVELOPER', 'BILLING'],
|
|
3957
|
+
type: 'string',
|
|
3958
|
+
},
|
|
3959
|
+
teamId: {
|
|
3960
|
+
type: 'string',
|
|
3961
|
+
},
|
|
3962
|
+
uid: {
|
|
3963
|
+
type: 'string',
|
|
3964
|
+
},
|
|
3965
|
+
},
|
|
3966
|
+
required: ['confirmed', 'accessRequestedAt', 'role', 'uid', 'createdAt', 'created'],
|
|
3967
|
+
type: 'object',
|
|
3968
|
+
},
|
|
3969
|
+
],
|
|
3970
|
+
},
|
|
3971
|
+
name: {
|
|
3972
|
+
description: 'Name associated with the Team account, or `null` if none has been provided.',
|
|
3973
|
+
examples: ['My Team'],
|
|
3974
|
+
type: ['string', 'null'],
|
|
3975
|
+
},
|
|
3976
|
+
saml: {
|
|
3977
|
+
description:
|
|
3978
|
+
'When "Single Sign-On (SAML)" is configured, this object contains information that allows the client-side to identify whether or not this Team has SAML enforced.',
|
|
3979
|
+
properties: {
|
|
3980
|
+
connection: {
|
|
3981
|
+
description: 'From T, pick a set of properties whose keys are in the union K',
|
|
3982
|
+
properties: {
|
|
3983
|
+
createdAt: {
|
|
3984
|
+
type: ['number', 'null'],
|
|
3985
|
+
},
|
|
3986
|
+
creator: {
|
|
3987
|
+
type: 'string',
|
|
3988
|
+
},
|
|
3989
|
+
domain: {
|
|
3990
|
+
type: 'string',
|
|
3991
|
+
},
|
|
3992
|
+
id: {
|
|
3993
|
+
type: 'string',
|
|
3994
|
+
},
|
|
3995
|
+
name: {
|
|
3996
|
+
type: 'string',
|
|
3997
|
+
},
|
|
3998
|
+
recordType: {
|
|
3999
|
+
enum: ['A', 'AAAA', 'ALIAS', 'CAA', 'CNAME', 'MX', 'SRV', 'TXT', 'NS'],
|
|
4000
|
+
type: 'string',
|
|
4001
|
+
},
|
|
4002
|
+
ttl: {
|
|
4003
|
+
type: 'number',
|
|
4004
|
+
},
|
|
4005
|
+
type: {
|
|
4006
|
+
enum: ['record', 'record-sys'],
|
|
4007
|
+
type: 'string',
|
|
4008
|
+
},
|
|
4009
|
+
value: {
|
|
4010
|
+
type: 'string',
|
|
4011
|
+
},
|
|
4012
|
+
},
|
|
4013
|
+
required: ['creator', 'domain', 'id', 'name', 'recordType', 'type', 'value'],
|
|
4014
|
+
type: 'object',
|
|
4015
|
+
},
|
|
4016
|
+
directory: {
|
|
4017
|
+
description: 'From T, pick a set of properties whose keys are in the union K',
|
|
4018
|
+
properties: {
|
|
4019
|
+
createdAt: {
|
|
4020
|
+
type: ['number', 'null'],
|
|
4021
|
+
},
|
|
4022
|
+
creator: {
|
|
4023
|
+
type: 'string',
|
|
4024
|
+
},
|
|
4025
|
+
domain: {
|
|
4026
|
+
type: 'string',
|
|
4027
|
+
},
|
|
4028
|
+
id: {
|
|
4029
|
+
type: 'string',
|
|
4030
|
+
},
|
|
4031
|
+
name: {
|
|
4032
|
+
type: 'string',
|
|
4033
|
+
},
|
|
4034
|
+
recordType: {
|
|
4035
|
+
enum: ['A', 'AAAA', 'ALIAS', 'CAA', 'CNAME', 'MX', 'SRV', 'TXT', 'NS'],
|
|
4036
|
+
type: 'string',
|
|
4037
|
+
},
|
|
4038
|
+
ttl: {
|
|
4039
|
+
type: 'number',
|
|
4040
|
+
},
|
|
4041
|
+
type: {
|
|
4042
|
+
enum: ['record', 'record-sys'],
|
|
4043
|
+
type: 'string',
|
|
4044
|
+
},
|
|
4045
|
+
value: {
|
|
4046
|
+
type: 'string',
|
|
4047
|
+
},
|
|
4048
|
+
},
|
|
4049
|
+
required: ['creator', 'domain', 'id', 'name', 'recordType', 'type', 'value'],
|
|
4050
|
+
type: 'object',
|
|
4051
|
+
},
|
|
4052
|
+
enforced: {
|
|
4053
|
+
description:
|
|
4054
|
+
"When `true`, interactions with the Team **must** be done with an authentication token that has been authenticated with the Team's SAML Single Sign-On provider.",
|
|
4055
|
+
type: 'boolean',
|
|
4056
|
+
},
|
|
4057
|
+
},
|
|
4058
|
+
required: ['enforced'],
|
|
4059
|
+
type: 'object',
|
|
4060
|
+
},
|
|
4061
|
+
slug: {
|
|
4062
|
+
description: "The Team's slug, which is unique across the Vercel platform.",
|
|
4063
|
+
examples: ['my-team'],
|
|
4064
|
+
type: 'string',
|
|
4065
|
+
},
|
|
4066
|
+
},
|
|
4067
|
+
required: ['limited', 'id', 'slug', 'name', 'avatar', 'membership', 'created', 'createdAt'],
|
|
4068
|
+
type: 'object',
|
|
4069
|
+
},
|
|
4070
|
+
UserEvent: {
|
|
4071
|
+
description: 'Array of events generated by the User.',
|
|
4072
|
+
properties: {
|
|
4073
|
+
createdAt: {
|
|
4074
|
+
description: 'Timestamp (in milliseconds) of when the event was generated.',
|
|
4075
|
+
examples: [1632859321020],
|
|
4076
|
+
type: 'number',
|
|
4077
|
+
},
|
|
4078
|
+
entities: {
|
|
4079
|
+
description:
|
|
4080
|
+
'A list of "entities" within the event `text`. Useful for enhancing the displayed text with additional styling and links.',
|
|
4081
|
+
items: {
|
|
4082
|
+
description:
|
|
4083
|
+
'A list of "entities" within the event `text`. Useful for enhancing the displayed text with additional styling and links.',
|
|
4084
|
+
properties: {
|
|
4085
|
+
end: {
|
|
4086
|
+
description: 'The index of where the entity ends within the `text` (non-inclusive).',
|
|
4087
|
+
examples: [3],
|
|
4088
|
+
type: 'number',
|
|
4089
|
+
},
|
|
4090
|
+
start: {
|
|
4091
|
+
description: 'The index of where the entity begins within the `text` (inclusive).',
|
|
4092
|
+
examples: [0],
|
|
4093
|
+
type: 'number',
|
|
4094
|
+
},
|
|
4095
|
+
type: {
|
|
4096
|
+
description: 'The type of entity.',
|
|
4097
|
+
enum: [
|
|
4098
|
+
'target',
|
|
4099
|
+
'author',
|
|
4100
|
+
'bitbucket_login',
|
|
4101
|
+
'bold',
|
|
4102
|
+
'deployment_host',
|
|
4103
|
+
'dns_record',
|
|
4104
|
+
'git_link',
|
|
4105
|
+
'github_login',
|
|
4106
|
+
'gitlab_login',
|
|
4107
|
+
'hook_name',
|
|
4108
|
+
'integration',
|
|
4109
|
+
'edge-config',
|
|
4110
|
+
'link',
|
|
4111
|
+
'project_name',
|
|
4112
|
+
'scaling_rules',
|
|
4113
|
+
'env_var_name',
|
|
4114
|
+
'system',
|
|
4115
|
+
],
|
|
4116
|
+
examples: ['author'],
|
|
4117
|
+
type: 'string',
|
|
4118
|
+
},
|
|
4119
|
+
},
|
|
4120
|
+
required: ['type', 'start', 'end'],
|
|
4121
|
+
type: 'object',
|
|
4122
|
+
},
|
|
4123
|
+
type: 'array',
|
|
4124
|
+
},
|
|
4125
|
+
id: {
|
|
4126
|
+
description: 'The unique identifier of the Event.',
|
|
4127
|
+
examples: ['uev_bfmMjiMnXfnPbT97dGdpJbCN'],
|
|
4128
|
+
type: 'string',
|
|
4129
|
+
},
|
|
4130
|
+
text: {
|
|
4131
|
+
description: 'The human-readable text of the Event.',
|
|
4132
|
+
examples: ['You logged in via GitHub'],
|
|
4133
|
+
type: 'string',
|
|
4134
|
+
},
|
|
4135
|
+
user: {
|
|
4136
|
+
description: 'Metadata for the User who generated the event.',
|
|
4137
|
+
properties: {
|
|
4138
|
+
avatar: {
|
|
4139
|
+
type: 'string',
|
|
4140
|
+
},
|
|
4141
|
+
email: {
|
|
4142
|
+
type: 'string',
|
|
4143
|
+
},
|
|
4144
|
+
slug: {
|
|
4145
|
+
type: 'string',
|
|
4146
|
+
},
|
|
4147
|
+
uid: {
|
|
4148
|
+
type: 'string',
|
|
4149
|
+
},
|
|
4150
|
+
username: {
|
|
4151
|
+
type: 'string',
|
|
4152
|
+
},
|
|
4153
|
+
},
|
|
4154
|
+
required: ['avatar', 'email', 'uid', 'username'],
|
|
4155
|
+
type: 'object',
|
|
4156
|
+
},
|
|
4157
|
+
userId: {
|
|
4158
|
+
description: 'The unique identifier of the User who generated the event.',
|
|
4159
|
+
examples: ['zTuNVUXEAvvnNN3IaqinkyMw'],
|
|
4160
|
+
type: 'string',
|
|
4161
|
+
},
|
|
4162
|
+
},
|
|
4163
|
+
required: ['id', 'text', 'entities', 'createdAt', 'userId'],
|
|
4164
|
+
type: 'object',
|
|
4165
|
+
},
|
|
4166
|
+
},
|
|
4167
|
+
securitySchemes: {
|
|
4168
|
+
bearerToken: {
|
|
4169
|
+
description: 'Default authentication mechanism',
|
|
4170
|
+
scheme: 'bearer',
|
|
4171
|
+
type: 'http',
|
|
4172
|
+
},
|
|
4173
|
+
oauth2: {
|
|
4174
|
+
flows: {
|
|
4175
|
+
authorizationCode: {
|
|
4176
|
+
authorizationUrl: 'https://api.vercel.com/oauth/authorize',
|
|
4177
|
+
scopes: {},
|
|
4178
|
+
tokenUrl: 'https://api.vercel.com/oauth/access_token',
|
|
4179
|
+
},
|
|
4180
|
+
},
|
|
4181
|
+
type: 'oauth2',
|
|
4182
|
+
},
|
|
4183
|
+
},
|
|
4184
|
+
} as TComponents;
|