@fleetless/contracts 6.1.0-next.1 → 6.1.0-next.2
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/CHANGELOG.md +6 -4
- package/artifacts/openapi.json +112 -56
- package/artifacts/routes.json +1 -1
- package/artifacts/schema/addon-catalogue-entry.schema.json +12 -6
- package/artifacts/schema/admin-plan-change-request.schema.json +24 -6
- package/artifacts/schema/asset-plan-limit-details.schema.json +14 -7
- package/artifacts/schema/org-addons.schema.json +10 -5
- package/artifacts/schema/org-lock.schema.json +4 -2
- package/artifacts/schema/org-locked-details.schema.json +2 -1
- package/artifacts/schema/org-plan-usage.schema.json +12 -6
- package/artifacts/schema/org-plan.schema.json +100 -50
- package/artifacts/schema/pending-plan-change.schema.json +22 -11
- package/artifacts/schema/plan-catalogue-entry.schema.json +46 -23
- package/artifacts/schema/plan-change-keep.schema.json +8 -4
- package/artifacts/schema/plan-change-request.schema.json +12 -6
- package/artifacts/schema/plan-features.schema.json +14 -7
- package/artifacts/schema/plan-limit-details.schema.json +14 -7
- package/artifacts/schema/plan-limits.schema.json +16 -8
- package/artifacts/schema/plan-overrides.schema.json +8 -0
- package/artifacts/schema/plan-prices.schema.json +8 -4
- package/artifacts/schema/plan-required-details.schema.json +6 -3
- package/dist/errors.js +31 -21
- package/dist/plans.d.ts +15 -33
- package/dist/plans.js +128 -83
- package/dist/routes.js +5 -4
- package/package.json +1 -1
|
@@ -9,14 +9,16 @@
|
|
|
9
9
|
"plus",
|
|
10
10
|
"pro",
|
|
11
11
|
"enterprise"
|
|
12
|
-
]
|
|
12
|
+
],
|
|
13
|
+
"description": "The org's current plan."
|
|
13
14
|
},
|
|
14
15
|
"currency": {
|
|
15
16
|
"type": "string",
|
|
16
17
|
"enum": [
|
|
17
18
|
"eur",
|
|
18
19
|
"usd"
|
|
19
|
-
]
|
|
20
|
+
],
|
|
21
|
+
"description": "The currency the org's prices are shown and billed in."
|
|
20
22
|
},
|
|
21
23
|
"period_ends_at": {
|
|
22
24
|
"type": "string",
|
|
@@ -30,27 +32,32 @@
|
|
|
30
32
|
"seats": {
|
|
31
33
|
"type": "integer",
|
|
32
34
|
"minimum": 0,
|
|
33
|
-
"maximum": 9007199254740991
|
|
35
|
+
"maximum": 9007199254740991,
|
|
36
|
+
"description": "Extra developer seats, one each."
|
|
34
37
|
},
|
|
35
38
|
"robots": {
|
|
36
39
|
"type": "integer",
|
|
37
40
|
"minimum": 0,
|
|
38
|
-
"maximum": 9007199254740991
|
|
41
|
+
"maximum": 9007199254740991,
|
|
42
|
+
"description": "Extra robots, one each."
|
|
39
43
|
},
|
|
40
44
|
"apps": {
|
|
41
45
|
"type": "integer",
|
|
42
46
|
"minimum": 0,
|
|
43
|
-
"maximum": 9007199254740991
|
|
47
|
+
"maximum": 9007199254740991,
|
|
48
|
+
"description": "Extra apps, one each."
|
|
44
49
|
},
|
|
45
50
|
"app_user_packs": {
|
|
46
51
|
"type": "integer",
|
|
47
52
|
"minimum": 0,
|
|
48
|
-
"maximum": 9007199254740991
|
|
53
|
+
"maximum": 9007199254740991,
|
|
54
|
+
"description": "Packs of five extra app users."
|
|
49
55
|
},
|
|
50
56
|
"live_video_packs": {
|
|
51
57
|
"type": "integer",
|
|
52
58
|
"minimum": 0,
|
|
53
|
-
"maximum": 9007199254740991
|
|
59
|
+
"maximum": 9007199254740991,
|
|
60
|
+
"description": "Packs of 250 extra hours of app-user live video per month."
|
|
54
61
|
}
|
|
55
62
|
},
|
|
56
63
|
"required": [
|
|
@@ -60,7 +67,8 @@
|
|
|
60
67
|
"app_user_packs",
|
|
61
68
|
"live_video_packs"
|
|
62
69
|
],
|
|
63
|
-
"additionalProperties": false
|
|
70
|
+
"additionalProperties": false,
|
|
71
|
+
"description": "The add-ons the org has bought. All zero on a plan without the `addons` feature."
|
|
64
72
|
},
|
|
65
73
|
"limits": {
|
|
66
74
|
"type": "object",
|
|
@@ -75,7 +83,8 @@
|
|
|
75
83
|
{
|
|
76
84
|
"type": "null"
|
|
77
85
|
}
|
|
78
|
-
]
|
|
86
|
+
],
|
|
87
|
+
"description": "Developers, owners included, plus pending team invitations."
|
|
79
88
|
},
|
|
80
89
|
"robots": {
|
|
81
90
|
"anyOf": [
|
|
@@ -87,7 +96,8 @@
|
|
|
87
96
|
{
|
|
88
97
|
"type": "null"
|
|
89
98
|
}
|
|
90
|
-
]
|
|
99
|
+
],
|
|
100
|
+
"description": "Robots in the org."
|
|
91
101
|
},
|
|
92
102
|
"apps": {
|
|
93
103
|
"anyOf": [
|
|
@@ -99,7 +109,8 @@
|
|
|
99
109
|
{
|
|
100
110
|
"type": "null"
|
|
101
111
|
}
|
|
102
|
-
]
|
|
112
|
+
],
|
|
113
|
+
"description": "Apps in the org."
|
|
103
114
|
},
|
|
104
115
|
"app_users": {
|
|
105
116
|
"anyOf": [
|
|
@@ -111,7 +122,8 @@
|
|
|
111
122
|
{
|
|
112
123
|
"type": "null"
|
|
113
124
|
}
|
|
114
|
-
]
|
|
125
|
+
],
|
|
126
|
+
"description": "App users across every app of the org, plus pending app-user invitations."
|
|
115
127
|
},
|
|
116
128
|
"live_video_ms_per_month": {
|
|
117
129
|
"anyOf": [
|
|
@@ -123,7 +135,8 @@
|
|
|
123
135
|
{
|
|
124
136
|
"type": "null"
|
|
125
137
|
}
|
|
126
|
-
]
|
|
138
|
+
],
|
|
139
|
+
"description": "Live video watched by app users in one UTC calendar month, in milliseconds, across the org. Console sessions do not count."
|
|
127
140
|
},
|
|
128
141
|
"asset_bytes_per_robot": {
|
|
129
142
|
"anyOf": [
|
|
@@ -135,7 +148,8 @@
|
|
|
135
148
|
{
|
|
136
149
|
"type": "null"
|
|
137
150
|
}
|
|
138
|
-
]
|
|
151
|
+
],
|
|
152
|
+
"description": "Asset storage per robot, in bytes (decimal: 1 GB = 1,000,000,000). The org stores up to robots × this value in total."
|
|
139
153
|
},
|
|
140
154
|
"history_days": {
|
|
141
155
|
"anyOf": [
|
|
@@ -147,7 +161,8 @@
|
|
|
147
161
|
{
|
|
148
162
|
"type": "null"
|
|
149
163
|
}
|
|
150
|
-
]
|
|
164
|
+
],
|
|
165
|
+
"description": "Days the org's robot history is kept."
|
|
151
166
|
},
|
|
152
167
|
"audit_days": {
|
|
153
168
|
"anyOf": [
|
|
@@ -159,7 +174,8 @@
|
|
|
159
174
|
{
|
|
160
175
|
"type": "null"
|
|
161
176
|
}
|
|
162
|
-
]
|
|
177
|
+
],
|
|
178
|
+
"description": "Days the org's audit log is kept."
|
|
163
179
|
}
|
|
164
180
|
},
|
|
165
181
|
"required": [
|
|
@@ -172,31 +188,39 @@
|
|
|
172
188
|
"history_days",
|
|
173
189
|
"audit_days"
|
|
174
190
|
],
|
|
175
|
-
"additionalProperties": false
|
|
191
|
+
"additionalProperties": false,
|
|
192
|
+
"description": "The org's effective limits: the plan's, raised by its add-ons, or an operator's override in their place. `null` means unlimited for a count, and 90 days for `history_days` and `audit_days`."
|
|
176
193
|
},
|
|
177
194
|
"features": {
|
|
178
195
|
"type": "object",
|
|
179
196
|
"properties": {
|
|
180
197
|
"app_mcp": {
|
|
181
|
-
"type": "boolean"
|
|
198
|
+
"type": "boolean",
|
|
199
|
+
"description": "An app's own MCP endpoint, for its app users."
|
|
182
200
|
},
|
|
183
201
|
"two_factor": {
|
|
184
|
-
"type": "boolean"
|
|
202
|
+
"type": "boolean",
|
|
203
|
+
"description": "Two-factor sign-in for developers."
|
|
185
204
|
},
|
|
186
205
|
"require_two_factor": {
|
|
187
|
-
"type": "boolean"
|
|
206
|
+
"type": "boolean",
|
|
207
|
+
"description": "An owner may require two-factor sign-in for every developer of the org."
|
|
188
208
|
},
|
|
189
209
|
"app_oidc": {
|
|
190
|
-
"type": "boolean"
|
|
210
|
+
"type": "boolean",
|
|
211
|
+
"description": "An app may let its users sign in through an OpenID Connect identity provider."
|
|
191
212
|
},
|
|
192
213
|
"hosted_logo": {
|
|
193
|
-
"type": "boolean"
|
|
214
|
+
"type": "boolean",
|
|
215
|
+
"description": "An app's hosted pages show its logo and accent colour, not only its name."
|
|
194
216
|
},
|
|
195
217
|
"audit_export": {
|
|
196
|
-
"type": "boolean"
|
|
218
|
+
"type": "boolean",
|
|
219
|
+
"description": "The audit log can be exported as CSV."
|
|
197
220
|
},
|
|
198
221
|
"addons": {
|
|
199
|
-
"type": "boolean"
|
|
222
|
+
"type": "boolean",
|
|
223
|
+
"description": "Add-ons can be bought on top of the plan."
|
|
200
224
|
}
|
|
201
225
|
},
|
|
202
226
|
"required": [
|
|
@@ -208,7 +232,8 @@
|
|
|
208
232
|
"audit_export",
|
|
209
233
|
"addons"
|
|
210
234
|
],
|
|
211
|
-
"additionalProperties": false
|
|
235
|
+
"additionalProperties": false,
|
|
236
|
+
"description": "What the org's plan unlocks."
|
|
212
237
|
},
|
|
213
238
|
"usage": {
|
|
214
239
|
"type": "object",
|
|
@@ -216,32 +241,38 @@
|
|
|
216
241
|
"seats": {
|
|
217
242
|
"type": "integer",
|
|
218
243
|
"minimum": 0,
|
|
219
|
-
"maximum": 9007199254740991
|
|
244
|
+
"maximum": 9007199254740991,
|
|
245
|
+
"description": "Developers, owners included, plus pending team invitations."
|
|
220
246
|
},
|
|
221
247
|
"robots": {
|
|
222
248
|
"type": "integer",
|
|
223
249
|
"minimum": 0,
|
|
224
|
-
"maximum": 9007199254740991
|
|
250
|
+
"maximum": 9007199254740991,
|
|
251
|
+
"description": "Robots in the org."
|
|
225
252
|
},
|
|
226
253
|
"apps": {
|
|
227
254
|
"type": "integer",
|
|
228
255
|
"minimum": 0,
|
|
229
|
-
"maximum": 9007199254740991
|
|
256
|
+
"maximum": 9007199254740991,
|
|
257
|
+
"description": "Apps in the org."
|
|
230
258
|
},
|
|
231
259
|
"app_users": {
|
|
232
260
|
"type": "integer",
|
|
233
261
|
"minimum": 0,
|
|
234
|
-
"maximum": 9007199254740991
|
|
262
|
+
"maximum": 9007199254740991,
|
|
263
|
+
"description": "App users across every app, plus pending app-user invitations."
|
|
235
264
|
},
|
|
236
265
|
"live_video_ms_this_month": {
|
|
237
266
|
"type": "integer",
|
|
238
267
|
"minimum": 0,
|
|
239
|
-
"maximum": 9007199254740991
|
|
268
|
+
"maximum": 9007199254740991,
|
|
269
|
+
"description": "Live video watched by app users in the current UTC calendar month, in milliseconds. Console sessions do not count."
|
|
240
270
|
},
|
|
241
271
|
"asset_bytes": {
|
|
242
272
|
"type": "integer",
|
|
243
273
|
"minimum": 0,
|
|
244
|
-
"maximum": 9007199254740991
|
|
274
|
+
"maximum": 9007199254740991,
|
|
275
|
+
"description": "Bytes the assets of every robot of the org occupy, together."
|
|
245
276
|
}
|
|
246
277
|
},
|
|
247
278
|
"required": [
|
|
@@ -252,7 +283,8 @@
|
|
|
252
283
|
"live_video_ms_this_month",
|
|
253
284
|
"asset_bytes"
|
|
254
285
|
],
|
|
255
|
-
"additionalProperties": false
|
|
286
|
+
"additionalProperties": false,
|
|
287
|
+
"description": "What the org uses now, counted the way each limit counts it."
|
|
256
288
|
},
|
|
257
289
|
"pending_change": {
|
|
258
290
|
"anyOf": [
|
|
@@ -266,7 +298,8 @@
|
|
|
266
298
|
"plus",
|
|
267
299
|
"pro",
|
|
268
300
|
"enterprise"
|
|
269
|
-
]
|
|
301
|
+
],
|
|
302
|
+
"description": "The plan the org moves to."
|
|
270
303
|
},
|
|
271
304
|
"reason": {
|
|
272
305
|
"type": "string",
|
|
@@ -275,7 +308,8 @@
|
|
|
275
308
|
"cancel",
|
|
276
309
|
"migration",
|
|
277
310
|
"lock"
|
|
278
|
-
]
|
|
311
|
+
],
|
|
312
|
+
"description": "Why the change is pending: `downgrade`, `cancel`, `migration` or `lock`."
|
|
279
313
|
},
|
|
280
314
|
"effective_at": {
|
|
281
315
|
"anyOf": [
|
|
@@ -287,7 +321,8 @@
|
|
|
287
321
|
{
|
|
288
322
|
"type": "null"
|
|
289
323
|
}
|
|
290
|
-
]
|
|
324
|
+
],
|
|
325
|
+
"description": "When the change takes effect. `null` only for a move off the beta whose date is not set yet."
|
|
291
326
|
},
|
|
292
327
|
"keep": {
|
|
293
328
|
"anyOf": [
|
|
@@ -300,7 +335,8 @@
|
|
|
300
335
|
"type": "string",
|
|
301
336
|
"format": "uuid",
|
|
302
337
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
|
|
303
|
-
}
|
|
338
|
+
},
|
|
339
|
+
"description": "The robots that stay, by id. Every other robot is deleted when the change takes effect."
|
|
304
340
|
},
|
|
305
341
|
"apps": {
|
|
306
342
|
"type": "array",
|
|
@@ -308,7 +344,8 @@
|
|
|
308
344
|
"type": "string",
|
|
309
345
|
"format": "uuid",
|
|
310
346
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
|
|
311
|
-
}
|
|
347
|
+
},
|
|
348
|
+
"description": "The apps that stay, by id. Every other app is deleted when the change takes effect."
|
|
312
349
|
},
|
|
313
350
|
"app_users": {
|
|
314
351
|
"type": "array",
|
|
@@ -316,7 +353,8 @@
|
|
|
316
353
|
"type": "string",
|
|
317
354
|
"format": "uuid",
|
|
318
355
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
|
|
319
|
-
}
|
|
356
|
+
},
|
|
357
|
+
"description": "The app users that stay, by id, across every app. Every other app user is deleted when the change takes effect."
|
|
320
358
|
},
|
|
321
359
|
"developers": {
|
|
322
360
|
"type": "array",
|
|
@@ -324,7 +362,8 @@
|
|
|
324
362
|
"type": "string",
|
|
325
363
|
"format": "uuid",
|
|
326
364
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
|
|
327
|
-
}
|
|
365
|
+
},
|
|
366
|
+
"description": "The developers that stay, by user id, owners never among them: every owner stays. Every other developer is removed from the org when the change takes effect."
|
|
328
367
|
}
|
|
329
368
|
},
|
|
330
369
|
"required": [
|
|
@@ -338,22 +377,26 @@
|
|
|
338
377
|
{
|
|
339
378
|
"type": "null"
|
|
340
379
|
}
|
|
341
|
-
]
|
|
380
|
+
],
|
|
381
|
+
"description": "What stays. `null` when the org already fits the target plan and nothing is deleted."
|
|
342
382
|
},
|
|
343
383
|
"history_days_after": {
|
|
344
384
|
"type": "integer",
|
|
345
385
|
"exclusiveMinimum": 0,
|
|
346
|
-
"maximum": 9007199254740991
|
|
386
|
+
"maximum": 9007199254740991,
|
|
387
|
+
"description": "Days of history and audit log the org keeps on the target plan."
|
|
347
388
|
},
|
|
348
389
|
"chosen_by": {
|
|
349
390
|
"type": "string",
|
|
350
391
|
"format": "uuid",
|
|
351
|
-
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
|
|
392
|
+
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
393
|
+
"description": "The user id of the owner who chose the change, or the nil UUID when Fleetless queued it."
|
|
352
394
|
},
|
|
353
395
|
"chosen_at": {
|
|
354
396
|
"type": "string",
|
|
355
397
|
"format": "date-time",
|
|
356
|
-
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
|
|
398
|
+
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
|
|
399
|
+
"description": "When the change was chosen."
|
|
357
400
|
}
|
|
358
401
|
},
|
|
359
402
|
"required": [
|
|
@@ -370,7 +413,8 @@
|
|
|
370
413
|
{
|
|
371
414
|
"type": "null"
|
|
372
415
|
}
|
|
373
|
-
]
|
|
416
|
+
],
|
|
417
|
+
"description": "A move to a lower plan that has not taken effect yet, or `null`."
|
|
374
418
|
},
|
|
375
419
|
"lock": {
|
|
376
420
|
"anyOf": [
|
|
@@ -382,12 +426,14 @@
|
|
|
382
426
|
"enum": [
|
|
383
427
|
"payment",
|
|
384
428
|
"migration"
|
|
385
|
-
]
|
|
429
|
+
],
|
|
430
|
+
"description": "`payment`: a payment is missing. `migration`: the org did not choose what stays when the beta ended."
|
|
386
431
|
},
|
|
387
432
|
"since": {
|
|
388
433
|
"type": "string",
|
|
389
434
|
"format": "date-time",
|
|
390
|
-
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
|
|
435
|
+
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
|
|
436
|
+
"description": "When the org was locked."
|
|
391
437
|
}
|
|
392
438
|
},
|
|
393
439
|
"required": [
|
|
@@ -399,7 +445,8 @@
|
|
|
399
445
|
{
|
|
400
446
|
"type": "null"
|
|
401
447
|
}
|
|
402
|
-
]
|
|
448
|
+
],
|
|
449
|
+
"description": "Why and since when the org is locked, or `null` when it is not."
|
|
403
450
|
},
|
|
404
451
|
"switch": {
|
|
405
452
|
"anyOf": [
|
|
@@ -416,10 +463,12 @@
|
|
|
416
463
|
{
|
|
417
464
|
"type": "null"
|
|
418
465
|
}
|
|
419
|
-
]
|
|
466
|
+
],
|
|
467
|
+
"description": "When the org moves from the beta onto its plan. `null` while the date is not set."
|
|
420
468
|
},
|
|
421
469
|
"needs_choice": {
|
|
422
|
-
"type": "boolean"
|
|
470
|
+
"type": "boolean",
|
|
471
|
+
"description": "Whether the org uses more than Basic allows, so an owner has to choose what stays before `at`."
|
|
423
472
|
}
|
|
424
473
|
},
|
|
425
474
|
"required": [
|
|
@@ -431,7 +480,8 @@
|
|
|
431
480
|
{
|
|
432
481
|
"type": "null"
|
|
433
482
|
}
|
|
434
|
-
]
|
|
483
|
+
],
|
|
484
|
+
"description": "Set only while the org is still on the beta; `null` for every other org."
|
|
435
485
|
}
|
|
436
486
|
},
|
|
437
487
|
"required": [
|
|
@@ -9,7 +9,8 @@
|
|
|
9
9
|
"plus",
|
|
10
10
|
"pro",
|
|
11
11
|
"enterprise"
|
|
12
|
-
]
|
|
12
|
+
],
|
|
13
|
+
"description": "The plan the org moves to."
|
|
13
14
|
},
|
|
14
15
|
"reason": {
|
|
15
16
|
"type": "string",
|
|
@@ -18,7 +19,8 @@
|
|
|
18
19
|
"cancel",
|
|
19
20
|
"migration",
|
|
20
21
|
"lock"
|
|
21
|
-
]
|
|
22
|
+
],
|
|
23
|
+
"description": "Why the change is pending: `downgrade`, `cancel`, `migration` or `lock`."
|
|
22
24
|
},
|
|
23
25
|
"effective_at": {
|
|
24
26
|
"anyOf": [
|
|
@@ -30,7 +32,8 @@
|
|
|
30
32
|
{
|
|
31
33
|
"type": "null"
|
|
32
34
|
}
|
|
33
|
-
]
|
|
35
|
+
],
|
|
36
|
+
"description": "When the change takes effect. `null` only for a move off the beta whose date is not set yet."
|
|
34
37
|
},
|
|
35
38
|
"keep": {
|
|
36
39
|
"anyOf": [
|
|
@@ -43,7 +46,8 @@
|
|
|
43
46
|
"type": "string",
|
|
44
47
|
"format": "uuid",
|
|
45
48
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
|
|
46
|
-
}
|
|
49
|
+
},
|
|
50
|
+
"description": "The robots that stay, by id. Every other robot is deleted when the change takes effect."
|
|
47
51
|
},
|
|
48
52
|
"apps": {
|
|
49
53
|
"type": "array",
|
|
@@ -51,7 +55,8 @@
|
|
|
51
55
|
"type": "string",
|
|
52
56
|
"format": "uuid",
|
|
53
57
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
|
|
54
|
-
}
|
|
58
|
+
},
|
|
59
|
+
"description": "The apps that stay, by id. Every other app is deleted when the change takes effect."
|
|
55
60
|
},
|
|
56
61
|
"app_users": {
|
|
57
62
|
"type": "array",
|
|
@@ -59,7 +64,8 @@
|
|
|
59
64
|
"type": "string",
|
|
60
65
|
"format": "uuid",
|
|
61
66
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
|
|
62
|
-
}
|
|
67
|
+
},
|
|
68
|
+
"description": "The app users that stay, by id, across every app. Every other app user is deleted when the change takes effect."
|
|
63
69
|
},
|
|
64
70
|
"developers": {
|
|
65
71
|
"type": "array",
|
|
@@ -67,7 +73,8 @@
|
|
|
67
73
|
"type": "string",
|
|
68
74
|
"format": "uuid",
|
|
69
75
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
|
|
70
|
-
}
|
|
76
|
+
},
|
|
77
|
+
"description": "The developers that stay, by user id, owners never among them: every owner stays. Every other developer is removed from the org when the change takes effect."
|
|
71
78
|
}
|
|
72
79
|
},
|
|
73
80
|
"required": [
|
|
@@ -81,22 +88,26 @@
|
|
|
81
88
|
{
|
|
82
89
|
"type": "null"
|
|
83
90
|
}
|
|
84
|
-
]
|
|
91
|
+
],
|
|
92
|
+
"description": "What stays. `null` when the org already fits the target plan and nothing is deleted."
|
|
85
93
|
},
|
|
86
94
|
"history_days_after": {
|
|
87
95
|
"type": "integer",
|
|
88
96
|
"exclusiveMinimum": 0,
|
|
89
|
-
"maximum": 9007199254740991
|
|
97
|
+
"maximum": 9007199254740991,
|
|
98
|
+
"description": "Days of history and audit log the org keeps on the target plan."
|
|
90
99
|
},
|
|
91
100
|
"chosen_by": {
|
|
92
101
|
"type": "string",
|
|
93
102
|
"format": "uuid",
|
|
94
|
-
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
|
|
103
|
+
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
104
|
+
"description": "The user id of the owner who chose the change, or the nil UUID when Fleetless queued it."
|
|
95
105
|
},
|
|
96
106
|
"chosen_at": {
|
|
97
107
|
"type": "string",
|
|
98
108
|
"format": "date-time",
|
|
99
|
-
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
|
|
109
|
+
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
|
|
110
|
+
"description": "When the change was chosen."
|
|
100
111
|
}
|
|
101
112
|
},
|
|
102
113
|
"required": [
|