@fleetless/contracts 6.1.0-next.1 → 6.1.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/CHANGELOG.md +8 -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,43 +9,52 @@
|
|
|
9
9
|
"plus",
|
|
10
10
|
"pro",
|
|
11
11
|
"enterprise"
|
|
12
|
-
]
|
|
12
|
+
],
|
|
13
|
+
"description": "The plan the org is on after this request."
|
|
13
14
|
},
|
|
14
15
|
"addons": {
|
|
16
|
+
"description": "Add-on counts to set. Counts not named stay as they are.",
|
|
15
17
|
"type": "object",
|
|
16
18
|
"properties": {
|
|
17
19
|
"seats": {
|
|
18
20
|
"type": "integer",
|
|
19
21
|
"minimum": 0,
|
|
20
|
-
"maximum": 9007199254740991
|
|
22
|
+
"maximum": 9007199254740991,
|
|
23
|
+
"description": "Extra developer seats, one each."
|
|
21
24
|
},
|
|
22
25
|
"robots": {
|
|
23
26
|
"type": "integer",
|
|
24
27
|
"minimum": 0,
|
|
25
|
-
"maximum": 9007199254740991
|
|
28
|
+
"maximum": 9007199254740991,
|
|
29
|
+
"description": "Extra robots, one each."
|
|
26
30
|
},
|
|
27
31
|
"apps": {
|
|
28
32
|
"type": "integer",
|
|
29
33
|
"minimum": 0,
|
|
30
|
-
"maximum": 9007199254740991
|
|
34
|
+
"maximum": 9007199254740991,
|
|
35
|
+
"description": "Extra apps, one each."
|
|
31
36
|
},
|
|
32
37
|
"app_user_packs": {
|
|
33
38
|
"type": "integer",
|
|
34
39
|
"minimum": 0,
|
|
35
|
-
"maximum": 9007199254740991
|
|
40
|
+
"maximum": 9007199254740991,
|
|
41
|
+
"description": "Packs of five extra app users."
|
|
36
42
|
},
|
|
37
43
|
"live_video_packs": {
|
|
38
44
|
"type": "integer",
|
|
39
45
|
"minimum": 0,
|
|
40
|
-
"maximum": 9007199254740991
|
|
46
|
+
"maximum": 9007199254740991,
|
|
47
|
+
"description": "Packs of 250 extra hours of app-user live video per month."
|
|
41
48
|
}
|
|
42
49
|
},
|
|
43
50
|
"additionalProperties": false
|
|
44
51
|
},
|
|
45
52
|
"overrides": {
|
|
53
|
+
"description": "Limits to override. `null` clears an override.",
|
|
46
54
|
"type": "object",
|
|
47
55
|
"properties": {
|
|
48
56
|
"seats": {
|
|
57
|
+
"description": "Replaces the plan's `seats`. `null` clears the override.",
|
|
49
58
|
"anyOf": [
|
|
50
59
|
{
|
|
51
60
|
"type": "integer",
|
|
@@ -58,6 +67,7 @@
|
|
|
58
67
|
]
|
|
59
68
|
},
|
|
60
69
|
"robots": {
|
|
70
|
+
"description": "Replaces the plan's `robots`. `null` clears the override.",
|
|
61
71
|
"anyOf": [
|
|
62
72
|
{
|
|
63
73
|
"type": "integer",
|
|
@@ -70,6 +80,7 @@
|
|
|
70
80
|
]
|
|
71
81
|
},
|
|
72
82
|
"apps": {
|
|
83
|
+
"description": "Replaces the plan's `apps`. `null` clears the override.",
|
|
73
84
|
"anyOf": [
|
|
74
85
|
{
|
|
75
86
|
"type": "integer",
|
|
@@ -82,6 +93,7 @@
|
|
|
82
93
|
]
|
|
83
94
|
},
|
|
84
95
|
"app_users": {
|
|
96
|
+
"description": "Replaces the plan's `app_users`. `null` clears the override.",
|
|
85
97
|
"anyOf": [
|
|
86
98
|
{
|
|
87
99
|
"type": "integer",
|
|
@@ -94,6 +106,7 @@
|
|
|
94
106
|
]
|
|
95
107
|
},
|
|
96
108
|
"live_video_ms_per_month": {
|
|
109
|
+
"description": "Replaces the plan's `live_video_ms_per_month`. `null` clears the override.",
|
|
97
110
|
"anyOf": [
|
|
98
111
|
{
|
|
99
112
|
"type": "integer",
|
|
@@ -106,6 +119,7 @@
|
|
|
106
119
|
]
|
|
107
120
|
},
|
|
108
121
|
"asset_bytes_per_robot": {
|
|
122
|
+
"description": "Replaces the plan's `asset_bytes_per_robot`. `null` clears the override.",
|
|
109
123
|
"anyOf": [
|
|
110
124
|
{
|
|
111
125
|
"type": "integer",
|
|
@@ -118,6 +132,7 @@
|
|
|
118
132
|
]
|
|
119
133
|
},
|
|
120
134
|
"history_days": {
|
|
135
|
+
"description": "Replaces the plan's `history_days`. `null` clears the override.",
|
|
121
136
|
"anyOf": [
|
|
122
137
|
{
|
|
123
138
|
"type": "integer",
|
|
@@ -130,6 +145,7 @@
|
|
|
130
145
|
]
|
|
131
146
|
},
|
|
132
147
|
"audit_days": {
|
|
148
|
+
"description": "Replaces the plan's `audit_days`. `null` clears the override.",
|
|
133
149
|
"anyOf": [
|
|
134
150
|
{
|
|
135
151
|
"type": "integer",
|
|
@@ -145,6 +161,7 @@
|
|
|
145
161
|
"additionalProperties": false
|
|
146
162
|
},
|
|
147
163
|
"currency": {
|
|
164
|
+
"description": "The currency the org is billed in.",
|
|
148
165
|
"type": "string",
|
|
149
166
|
"enum": [
|
|
150
167
|
"eur",
|
|
@@ -152,6 +169,7 @@
|
|
|
152
169
|
]
|
|
153
170
|
},
|
|
154
171
|
"period_ends_at": {
|
|
172
|
+
"description": "The end of the org's billing period. `null` falls back to the end of the current UTC month.",
|
|
155
173
|
"anyOf": [
|
|
156
174
|
{
|
|
157
175
|
"type": "string",
|
|
@@ -11,17 +11,20 @@
|
|
|
11
11
|
"app_users",
|
|
12
12
|
"live_video_ms_per_month",
|
|
13
13
|
"asset_bytes_per_robot"
|
|
14
|
-
]
|
|
14
|
+
],
|
|
15
|
+
"description": "The limit the action would exceed."
|
|
15
16
|
},
|
|
16
17
|
"used": {
|
|
17
18
|
"type": "integer",
|
|
18
19
|
"minimum": 0,
|
|
19
|
-
"maximum": 9007199254740991
|
|
20
|
+
"maximum": 9007199254740991,
|
|
21
|
+
"description": "How much of the limit the org uses now."
|
|
20
22
|
},
|
|
21
23
|
"max": {
|
|
22
24
|
"type": "integer",
|
|
23
25
|
"minimum": 0,
|
|
24
|
-
"maximum": 9007199254740991
|
|
26
|
+
"maximum": 9007199254740991,
|
|
27
|
+
"description": "The limit. For `asset_bytes_per_robot`, the org's whole pool: robots × the plan's bytes per robot."
|
|
25
28
|
},
|
|
26
29
|
"plan": {
|
|
27
30
|
"type": "string",
|
|
@@ -30,7 +33,8 @@
|
|
|
30
33
|
"plus",
|
|
31
34
|
"pro",
|
|
32
35
|
"enterprise"
|
|
33
|
-
]
|
|
36
|
+
],
|
|
37
|
+
"description": "The plan whose limit refused: the target plan while a move to a lower plan is pending."
|
|
34
38
|
},
|
|
35
39
|
"lifted_by": {
|
|
36
40
|
"type": "object",
|
|
@@ -49,7 +53,8 @@
|
|
|
49
53
|
{
|
|
50
54
|
"type": "null"
|
|
51
55
|
}
|
|
52
|
-
]
|
|
56
|
+
],
|
|
57
|
+
"description": "The cheapest higher plan that raises this limit, or `null` when none does."
|
|
53
58
|
},
|
|
54
59
|
"addon": {
|
|
55
60
|
"anyOf": [
|
|
@@ -66,14 +71,16 @@
|
|
|
66
71
|
{
|
|
67
72
|
"type": "null"
|
|
68
73
|
}
|
|
69
|
-
]
|
|
74
|
+
],
|
|
75
|
+
"description": "The add-on that raises this limit, when the org's plan can buy add-ons; otherwise `null`."
|
|
70
76
|
}
|
|
71
77
|
},
|
|
72
78
|
"required": [
|
|
73
79
|
"plan",
|
|
74
80
|
"addon"
|
|
75
81
|
],
|
|
76
|
-
"additionalProperties": false
|
|
82
|
+
"additionalProperties": false,
|
|
83
|
+
"description": "What would lift the limit."
|
|
77
84
|
},
|
|
78
85
|
"store_bytes": {
|
|
79
86
|
"type": "integer",
|
|
@@ -5,27 +5,32 @@
|
|
|
5
5
|
"seats": {
|
|
6
6
|
"type": "integer",
|
|
7
7
|
"minimum": 0,
|
|
8
|
-
"maximum": 9007199254740991
|
|
8
|
+
"maximum": 9007199254740991,
|
|
9
|
+
"description": "Extra developer seats, one each."
|
|
9
10
|
},
|
|
10
11
|
"robots": {
|
|
11
12
|
"type": "integer",
|
|
12
13
|
"minimum": 0,
|
|
13
|
-
"maximum": 9007199254740991
|
|
14
|
+
"maximum": 9007199254740991,
|
|
15
|
+
"description": "Extra robots, one each."
|
|
14
16
|
},
|
|
15
17
|
"apps": {
|
|
16
18
|
"type": "integer",
|
|
17
19
|
"minimum": 0,
|
|
18
|
-
"maximum": 9007199254740991
|
|
20
|
+
"maximum": 9007199254740991,
|
|
21
|
+
"description": "Extra apps, one each."
|
|
19
22
|
},
|
|
20
23
|
"app_user_packs": {
|
|
21
24
|
"type": "integer",
|
|
22
25
|
"minimum": 0,
|
|
23
|
-
"maximum": 9007199254740991
|
|
26
|
+
"maximum": 9007199254740991,
|
|
27
|
+
"description": "Packs of five extra app users."
|
|
24
28
|
},
|
|
25
29
|
"live_video_packs": {
|
|
26
30
|
"type": "integer",
|
|
27
31
|
"minimum": 0,
|
|
28
|
-
"maximum": 9007199254740991
|
|
32
|
+
"maximum": 9007199254740991,
|
|
33
|
+
"description": "Packs of 250 extra hours of app-user live video per month."
|
|
29
34
|
}
|
|
30
35
|
},
|
|
31
36
|
"required": [
|
|
@@ -7,12 +7,14 @@
|
|
|
7
7
|
"enum": [
|
|
8
8
|
"payment",
|
|
9
9
|
"migration"
|
|
10
|
-
]
|
|
10
|
+
],
|
|
11
|
+
"description": "`payment`: a payment is missing. `migration`: the org did not choose what stays when the beta ended."
|
|
11
12
|
},
|
|
12
13
|
"since": {
|
|
13
14
|
"type": "string",
|
|
14
15
|
"format": "date-time",
|
|
15
|
-
"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))$"
|
|
16
|
+
"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))$",
|
|
17
|
+
"description": "When the org was locked."
|
|
16
18
|
}
|
|
17
19
|
},
|
|
18
20
|
"required": [
|
|
@@ -5,32 +5,38 @@
|
|
|
5
5
|
"seats": {
|
|
6
6
|
"type": "integer",
|
|
7
7
|
"minimum": 0,
|
|
8
|
-
"maximum": 9007199254740991
|
|
8
|
+
"maximum": 9007199254740991,
|
|
9
|
+
"description": "Developers, owners included, plus pending team invitations."
|
|
9
10
|
},
|
|
10
11
|
"robots": {
|
|
11
12
|
"type": "integer",
|
|
12
13
|
"minimum": 0,
|
|
13
|
-
"maximum": 9007199254740991
|
|
14
|
+
"maximum": 9007199254740991,
|
|
15
|
+
"description": "Robots in the org."
|
|
14
16
|
},
|
|
15
17
|
"apps": {
|
|
16
18
|
"type": "integer",
|
|
17
19
|
"minimum": 0,
|
|
18
|
-
"maximum": 9007199254740991
|
|
20
|
+
"maximum": 9007199254740991,
|
|
21
|
+
"description": "Apps in the org."
|
|
19
22
|
},
|
|
20
23
|
"app_users": {
|
|
21
24
|
"type": "integer",
|
|
22
25
|
"minimum": 0,
|
|
23
|
-
"maximum": 9007199254740991
|
|
26
|
+
"maximum": 9007199254740991,
|
|
27
|
+
"description": "App users across every app, plus pending app-user invitations."
|
|
24
28
|
},
|
|
25
29
|
"live_video_ms_this_month": {
|
|
26
30
|
"type": "integer",
|
|
27
31
|
"minimum": 0,
|
|
28
|
-
"maximum": 9007199254740991
|
|
32
|
+
"maximum": 9007199254740991,
|
|
33
|
+
"description": "Live video watched by app users in the current UTC calendar month, in milliseconds. Console sessions do not count."
|
|
29
34
|
},
|
|
30
35
|
"asset_bytes": {
|
|
31
36
|
"type": "integer",
|
|
32
37
|
"minimum": 0,
|
|
33
|
-
"maximum": 9007199254740991
|
|
38
|
+
"maximum": 9007199254740991,
|
|
39
|
+
"description": "Bytes the assets of every robot of the org occupy, together."
|
|
34
40
|
}
|
|
35
41
|
},
|
|
36
42
|
"required": [
|