@leaflow/sdk 0.0.0-dev.125.ged02bc4 → 0.0.0-dev.129.g409f04f
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/account/v1/index.d.ts +2 -2
- package/dist/account/v1/schema.d.ts +148 -122
- package/dist/assistant/v1/schema.d.ts +29 -0
- package/dist/billing/v1/index.d.ts +8 -2
- package/dist/billing/v1/schema.d.ts +184 -5
- package/dist/canopy/v1/schema.d.ts +138 -109
- package/dist/compute/v1/index.d.ts +4 -2
- package/dist/compute/v1/schema.d.ts +80 -0
- package/dist/dns/v1/index.d.ts +6 -6
- package/dist/dns/v1/schema.d.ts +29 -0
- package/dist/fleet/v1/index.d.ts +6 -0
- package/dist/fleet/v1/index.js +5 -0
- package/dist/fleet/v1/schema.d.ts +181 -0
- package/dist/fleet/v1/schema.js +5 -0
- package/dist/iam/v1/index.d.ts +4 -4
- package/dist/iam/v1/schema.d.ts +144 -115
- package/dist/index.d.ts +1 -0
- package/dist/monitoring/v1/index.d.ts +4 -4
- package/dist/monitoring/v1/schema.d.ts +29 -0
- package/dist/notification/v1/schema.d.ts +29 -0
- package/dist/support/v1/schema.d.ts +29 -0
- package/dist/tunnel/v1/schema.d.ts +64 -35
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -4,6 +4,7 @@ export type * as billing from "./billing/v1/index.js";
|
|
|
4
4
|
export type * as canopy from "./canopy/v1/index.js";
|
|
5
5
|
export type * as compute from "./compute/v1/index.js";
|
|
6
6
|
export type * as dns from "./dns/v1/index.js";
|
|
7
|
+
export type * as fleet from "./fleet/v1/index.js";
|
|
7
8
|
export type * as iam from "./iam/v1/index.js";
|
|
8
9
|
export type * as monitoring from "./monitoring/v1/index.js";
|
|
9
10
|
export type * as notification from "./notification/v1/index.js";
|
|
@@ -66,14 +66,14 @@ export type ListServersResult = operations["list-servers"]["responses"][200]["co
|
|
|
66
66
|
export type ListServersQuery = operations["list-servers"]["parameters"]["query"];
|
|
67
67
|
/** `GET /api/v1/servers/{serverId}` 成功时的响应体。 */
|
|
68
68
|
export type GetServerResult = operations["get-server"]["responses"][200]["content"]["application/json"];
|
|
69
|
-
/** `PATCH /api/v1/servers/{serverId}` 成功时的响应体。 */
|
|
70
|
-
export type UpdateServerResult = operations["update-server"]["responses"][200]["content"]["application/json"];
|
|
71
|
-
/** `PATCH /api/v1/servers/{serverId}` 的请求体。 */
|
|
72
|
-
export type UpdateServerBody = NonNullable<operations["update-server"]["requestBody"]>["content"]["application/json"];
|
|
73
69
|
/** `PUT /api/v1/servers/{serverId}` 成功时的响应体。 */
|
|
74
70
|
export type EnableServerMonitoringResult = operations["enable-server-monitoring"]["responses"][200]["content"]["application/json"];
|
|
75
71
|
/** `PUT /api/v1/servers/{serverId}` 的请求体。 */
|
|
76
72
|
export type EnableServerMonitoringBody = NonNullable<operations["enable-server-monitoring"]["requestBody"]>["content"]["application/json"];
|
|
73
|
+
/** `PATCH /api/v1/servers/{serverId}` 成功时的响应体。 */
|
|
74
|
+
export type UpdateServerResult = operations["update-server"]["responses"][200]["content"]["application/json"];
|
|
75
|
+
/** `PATCH /api/v1/servers/{serverId}` 的请求体。 */
|
|
76
|
+
export type UpdateServerBody = NonNullable<operations["update-server"]["requestBody"]>["content"]["application/json"];
|
|
77
77
|
/** `POST /api/v1/servers/{serverId}/psk` 成功时的响应体。 */
|
|
78
78
|
export type RotateAgentPskResult = operations["rotate-agent-psk"]["responses"][200]["content"]["application/json"];
|
|
79
79
|
/** `GET /api/v1/servers/{serverId}/web-checks/{checkId}` 成功时的响应体。 */
|
|
@@ -959,6 +959,12 @@ export interface components {
|
|
|
959
959
|
code?: string;
|
|
960
960
|
message: string;
|
|
961
961
|
meta?: {
|
|
962
|
+
/**
|
|
963
|
+
* @description Present on every response whose `code` is `VALIDATION_FAILED`, and on no
|
|
964
|
+
* other response.
|
|
965
|
+
*/
|
|
966
|
+
violations?: components["schemas"]["Violation"][];
|
|
967
|
+
} & {
|
|
962
968
|
[key: string]: unknown;
|
|
963
969
|
};
|
|
964
970
|
/** Format: int64 */
|
|
@@ -2030,6 +2036,29 @@ export interface components {
|
|
|
2030
2036
|
/** @description Your own domain, such as status.acme.com. It must already point at the status page by CNAME */
|
|
2031
2037
|
domain: string;
|
|
2032
2038
|
};
|
|
2039
|
+
/**
|
|
2040
|
+
* @description A single mismatch between the request and the contract.
|
|
2041
|
+
*
|
|
2042
|
+
* Use `field` to locate the input, `rule` to decide what to tell the user, and
|
|
2043
|
+
* `reason` only for diagnostics.
|
|
2044
|
+
*/
|
|
2045
|
+
Violation: {
|
|
2046
|
+
/**
|
|
2047
|
+
* @description Dot-separated path to the field, such as `name` or
|
|
2048
|
+
* `schedule.0.start_time_seconds`.
|
|
2049
|
+
*/
|
|
2050
|
+
field: string;
|
|
2051
|
+
/**
|
|
2052
|
+
* @description The JSON Schema keyword that failed, such as `minLength`, `minimum` or
|
|
2053
|
+
* `pattern`.
|
|
2054
|
+
*/
|
|
2055
|
+
rule: string;
|
|
2056
|
+
/**
|
|
2057
|
+
* @description The validator's own wording, in English. Intended for diagnostics; do not
|
|
2058
|
+
* display it to end users.
|
|
2059
|
+
*/
|
|
2060
|
+
reason?: string;
|
|
2061
|
+
};
|
|
2033
2062
|
};
|
|
2034
2063
|
responses: never;
|
|
2035
2064
|
parameters: never;
|
|
@@ -625,6 +625,12 @@ export interface components {
|
|
|
625
625
|
code?: string;
|
|
626
626
|
message: string;
|
|
627
627
|
meta?: {
|
|
628
|
+
/**
|
|
629
|
+
* @description Present on every response whose `code` is `VALIDATION_FAILED`, and on no
|
|
630
|
+
* other response.
|
|
631
|
+
*/
|
|
632
|
+
violations?: components["schemas"]["Violation"][];
|
|
633
|
+
} & {
|
|
628
634
|
[key: string]: unknown;
|
|
629
635
|
};
|
|
630
636
|
/** Format: int64 */
|
|
@@ -1088,6 +1094,29 @@ export interface components {
|
|
|
1088
1094
|
/** @description The authorization token for this subscription, passed back to the realtime server by the client library */
|
|
1089
1095
|
auth: string;
|
|
1090
1096
|
};
|
|
1097
|
+
/**
|
|
1098
|
+
* @description A single mismatch between the request and the contract.
|
|
1099
|
+
*
|
|
1100
|
+
* Use `field` to locate the input, `rule` to decide what to tell the user, and
|
|
1101
|
+
* `reason` only for diagnostics.
|
|
1102
|
+
*/
|
|
1103
|
+
Violation: {
|
|
1104
|
+
/**
|
|
1105
|
+
* @description Dot-separated path to the field, such as `name` or
|
|
1106
|
+
* `schedule.0.start_time_seconds`.
|
|
1107
|
+
*/
|
|
1108
|
+
field: string;
|
|
1109
|
+
/**
|
|
1110
|
+
* @description The JSON Schema keyword that failed, such as `minLength`, `minimum` or
|
|
1111
|
+
* `pattern`.
|
|
1112
|
+
*/
|
|
1113
|
+
rule: string;
|
|
1114
|
+
/**
|
|
1115
|
+
* @description The validator's own wording, in English. Intended for diagnostics; do not
|
|
1116
|
+
* display it to end users.
|
|
1117
|
+
*/
|
|
1118
|
+
reason?: string;
|
|
1119
|
+
};
|
|
1091
1120
|
};
|
|
1092
1121
|
responses: never;
|
|
1093
1122
|
parameters: {
|
|
@@ -299,6 +299,12 @@ export interface components {
|
|
|
299
299
|
code?: string;
|
|
300
300
|
message: string;
|
|
301
301
|
meta?: {
|
|
302
|
+
/**
|
|
303
|
+
* @description Present on every response whose `code` is `VALIDATION_FAILED`, and on no
|
|
304
|
+
* other response.
|
|
305
|
+
*/
|
|
306
|
+
violations?: components["schemas"]["Violation"][];
|
|
307
|
+
} & {
|
|
302
308
|
[key: string]: unknown;
|
|
303
309
|
};
|
|
304
310
|
/** Format: int64 */
|
|
@@ -552,6 +558,29 @@ export interface components {
|
|
|
552
558
|
/** Format: int64 */
|
|
553
559
|
total: number;
|
|
554
560
|
};
|
|
561
|
+
/**
|
|
562
|
+
* @description A single mismatch between the request and the contract.
|
|
563
|
+
*
|
|
564
|
+
* Use `field` to locate the input, `rule` to decide what to tell the user, and
|
|
565
|
+
* `reason` only for diagnostics.
|
|
566
|
+
*/
|
|
567
|
+
Violation: {
|
|
568
|
+
/**
|
|
569
|
+
* @description Dot-separated path to the field, such as `name` or
|
|
570
|
+
* `schedule.0.start_time_seconds`.
|
|
571
|
+
*/
|
|
572
|
+
field: string;
|
|
573
|
+
/**
|
|
574
|
+
* @description The JSON Schema keyword that failed, such as `minLength`, `minimum` or
|
|
575
|
+
* `pattern`.
|
|
576
|
+
*/
|
|
577
|
+
rule: string;
|
|
578
|
+
/**
|
|
579
|
+
* @description The validator's own wording, in English. Intended for diagnostics; do not
|
|
580
|
+
* display it to end users.
|
|
581
|
+
*/
|
|
582
|
+
reason?: string;
|
|
583
|
+
};
|
|
555
584
|
};
|
|
556
585
|
responses: never;
|
|
557
586
|
parameters: never;
|
|
@@ -11,20 +11,20 @@ export interface paths {
|
|
|
11
11
|
cookie?: never;
|
|
12
12
|
};
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
15
|
-
* @description
|
|
14
|
+
* Get the layer 4 tunnel of the current project
|
|
15
|
+
* @description `TUNNEL_NOT_FOUND` means no tunnel has been generated yet.
|
|
16
16
|
*
|
|
17
|
-
*
|
|
17
|
+
* 403 `TUNNEL_NOT_ENTITLED` states something else: the project has not been entitled to layer 4 at all.
|
|
18
18
|
*
|
|
19
|
-
*
|
|
19
|
+
* The subscription address, the usage and the quota each have their own endpoint and are not repeated here.
|
|
20
20
|
*/
|
|
21
21
|
get: operations["get-l4-tunnel"];
|
|
22
22
|
put?: never;
|
|
23
23
|
/**
|
|
24
|
-
*
|
|
25
|
-
* @description
|
|
24
|
+
* Generate the layer 4 tunnel
|
|
25
|
+
* @description **Idempotent**: calling it again returns the existing tunnel rather than an error.
|
|
26
26
|
*
|
|
27
|
-
*
|
|
27
|
+
* Read the address from the subscription endpoint afterwards; it is not returned here.
|
|
28
28
|
*/
|
|
29
29
|
post: operations["generate-l4-tunnel"];
|
|
30
30
|
delete?: never;
|
|
@@ -41,12 +41,12 @@ export interface paths {
|
|
|
41
41
|
cookie?: never;
|
|
42
42
|
};
|
|
43
43
|
/**
|
|
44
|
-
*
|
|
45
|
-
* @description
|
|
44
|
+
* Get the subscription address
|
|
45
|
+
* @description **This URL is a credential, equivalent to a password.** It yields every node of the project along with their passwords. It is returned here alone, and appears neither in the tunnel itself nor in any list.
|
|
46
46
|
*
|
|
47
|
-
*
|
|
47
|
+
* Do not call this endpoint before the user asks for the address.
|
|
48
48
|
*
|
|
49
|
-
* `status`
|
|
49
|
+
* A `status` of `preparing` leaves the link usable; its contents are derived at the moment it is fetched.
|
|
50
50
|
*/
|
|
51
51
|
get: operations["get-l4-tunnel-subscription"];
|
|
52
52
|
put?: never;
|
|
@@ -67,14 +67,14 @@ export interface paths {
|
|
|
67
67
|
get?: never;
|
|
68
68
|
put?: never;
|
|
69
69
|
/**
|
|
70
|
-
*
|
|
71
|
-
* @description
|
|
70
|
+
* Rotate the subscription address and the node passwords
|
|
71
|
+
* @description **This is the remedy for an exposed credential, and every subscription already distributed stops working at once.**
|
|
72
72
|
*
|
|
73
|
-
*
|
|
73
|
+
* The subscription token and the node passwords are replaced together, so every client has to fetch the subscription again before it can carry on. Confirm that this is the intended outcome before calling.
|
|
74
74
|
*
|
|
75
|
-
*
|
|
75
|
+
* A tunnel disabled by the platform cannot be rotated (`TUNNEL_DISABLED_FOR_ROTATE`); resolve the cause first.
|
|
76
76
|
*
|
|
77
|
-
*
|
|
77
|
+
* Read the new address from the subscription endpoint afterwards; **it is not returned here**.
|
|
78
78
|
*/
|
|
79
79
|
post: operations["rotate-l4-tunnel-subscription"];
|
|
80
80
|
delete?: never;
|
|
@@ -91,10 +91,10 @@ export interface paths {
|
|
|
91
91
|
cookie?: never;
|
|
92
92
|
};
|
|
93
93
|
/**
|
|
94
|
-
*
|
|
95
|
-
* @description
|
|
94
|
+
* Get the usage of the current period
|
|
95
|
+
* @description Read live.
|
|
96
96
|
*
|
|
97
|
-
*
|
|
97
|
+
* Only `billed_bytes` decides whether the quota is exceeded: a route may carry a multiplier such as 1.5× or 0×, so `raw_bytes`, the volume actually transferred, need not equal it. A `quota_bytes` of 0 means unlimited.
|
|
98
98
|
*/
|
|
99
99
|
get: operations["get-l4-tunnel-usage"];
|
|
100
100
|
put?: never;
|
|
@@ -113,10 +113,10 @@ export interface paths {
|
|
|
113
113
|
cookie?: never;
|
|
114
114
|
};
|
|
115
115
|
/**
|
|
116
|
-
*
|
|
117
|
-
* @description
|
|
116
|
+
* Get daily usage
|
|
117
|
+
* @description Cut by calendar day. A day carrying no traffic is absent rather than zero, so a chart has to fill the date axis itself.
|
|
118
118
|
*
|
|
119
|
-
*
|
|
119
|
+
* These days do not sum to the usage of the current period, which is cut by billing period. Resetting the usage of the current period leaves every daily total in place.
|
|
120
120
|
*/
|
|
121
121
|
get: operations["list-l4-tunnel-usage-series"];
|
|
122
122
|
put?: never;
|
|
@@ -135,6 +135,12 @@ export interface components {
|
|
|
135
135
|
code?: string;
|
|
136
136
|
message: string;
|
|
137
137
|
meta?: {
|
|
138
|
+
/**
|
|
139
|
+
* @description Present on every response whose `code` is `VALIDATION_FAILED`, and on no
|
|
140
|
+
* other response.
|
|
141
|
+
*/
|
|
142
|
+
violations?: components["schemas"]["Violation"][];
|
|
143
|
+
} & {
|
|
138
144
|
[key: string]: unknown;
|
|
139
145
|
};
|
|
140
146
|
/** Format: int64 */
|
|
@@ -142,22 +148,22 @@ export interface components {
|
|
|
142
148
|
};
|
|
143
149
|
SubscriptionResource: {
|
|
144
150
|
/**
|
|
145
|
-
* @description ready
|
|
151
|
+
* @description ready means every node has been distributed; preparing means distribution is still under way, and the link works either way
|
|
146
152
|
* @enum {string}
|
|
147
153
|
*/
|
|
148
154
|
status: "preparing" | "ready";
|
|
149
155
|
/** Format: date-time */
|
|
150
156
|
updated_at: string;
|
|
151
|
-
/** @description
|
|
157
|
+
/** @description The subscription address. It is a long-lived credential equivalent to a password; do not forward it or share a screenshot of it */
|
|
152
158
|
url: string;
|
|
153
159
|
/** Format: int64 */
|
|
154
160
|
version: number;
|
|
155
161
|
};
|
|
156
|
-
/** @description
|
|
162
|
+
/** @description The layer 4 tunnel of the current project. It answers a single question — whether the tunnel has been generated */
|
|
157
163
|
TunnelResource: {
|
|
158
164
|
/** Format: date-time */
|
|
159
165
|
created_at: string;
|
|
160
|
-
/** @description
|
|
166
|
+
/** @description Whether the tunnel is currently usable. false means the platform has disabled it — for an unpaid balance, a violation, or a suspended project — and the cause has to be resolved first */
|
|
161
167
|
enabled: boolean;
|
|
162
168
|
/** Format: uuid */
|
|
163
169
|
id: string;
|
|
@@ -173,45 +179,68 @@ export interface components {
|
|
|
173
179
|
UsageResource: {
|
|
174
180
|
/**
|
|
175
181
|
* Format: int64
|
|
176
|
-
* @description
|
|
182
|
+
* @description Usage after the multiplier of each route has been applied. Quota is measured against this value
|
|
177
183
|
*/
|
|
178
184
|
billed_bytes: number;
|
|
179
185
|
over_quota: boolean;
|
|
180
|
-
/** @description
|
|
186
|
+
/** @description Last day of the current billing period (YYYY-MM-DD) */
|
|
181
187
|
period_end: string;
|
|
182
|
-
/** @description
|
|
188
|
+
/** @description First day of the current billing period (YYYY-MM-DD) */
|
|
183
189
|
period_start: string;
|
|
184
190
|
/**
|
|
185
191
|
* Format: int64
|
|
186
|
-
* @description
|
|
192
|
+
* @description The quota in force; 0 means unlimited
|
|
187
193
|
*/
|
|
188
194
|
quota_bytes: number;
|
|
189
195
|
/**
|
|
190
196
|
* Format: date-time
|
|
191
|
-
* @description
|
|
197
|
+
* @description When the quota was found to be exceeded; null while it has not been
|
|
192
198
|
*/
|
|
193
199
|
quota_exceeded_at: string | null;
|
|
194
200
|
/**
|
|
195
201
|
* Format: int64
|
|
196
|
-
* @description
|
|
202
|
+
* @description Bytes actually transferred. Quota is not measured against this value
|
|
197
203
|
*/
|
|
198
204
|
raw_bytes: number;
|
|
199
205
|
/** Format: int64 */
|
|
200
206
|
upload_bytes: number;
|
|
201
207
|
/**
|
|
202
208
|
* Format: double
|
|
203
|
-
* @description
|
|
209
|
+
* @description Usage as a percentage of the quota
|
|
204
210
|
*/
|
|
205
211
|
usage_percent: number;
|
|
206
212
|
};
|
|
207
213
|
UsageSeriesResource: {
|
|
208
214
|
/**
|
|
209
215
|
* Format: int64
|
|
210
|
-
* @description
|
|
216
|
+
* @description The number of days actually covered, which may have been clamped to the range 1–365
|
|
211
217
|
*/
|
|
212
218
|
days: number;
|
|
213
219
|
points: components["schemas"]["UsageDayResource"][];
|
|
214
220
|
};
|
|
221
|
+
/**
|
|
222
|
+
* @description A single mismatch between the request and the contract.
|
|
223
|
+
*
|
|
224
|
+
* Use `field` to locate the input, `rule` to decide what to tell the user, and
|
|
225
|
+
* `reason` only for diagnostics.
|
|
226
|
+
*/
|
|
227
|
+
Violation: {
|
|
228
|
+
/**
|
|
229
|
+
* @description Dot-separated path to the field, such as `name` or
|
|
230
|
+
* `schedule.0.start_time_seconds`.
|
|
231
|
+
*/
|
|
232
|
+
field: string;
|
|
233
|
+
/**
|
|
234
|
+
* @description The JSON Schema keyword that failed, such as `minLength`, `minimum` or
|
|
235
|
+
* `pattern`.
|
|
236
|
+
*/
|
|
237
|
+
rule: string;
|
|
238
|
+
/**
|
|
239
|
+
* @description The validator's own wording, in English. Intended for diagnostics; do not
|
|
240
|
+
* display it to end users.
|
|
241
|
+
*/
|
|
242
|
+
reason?: string;
|
|
243
|
+
};
|
|
215
244
|
};
|
|
216
245
|
responses: never;
|
|
217
246
|
parameters: never;
|
|
@@ -369,7 +398,7 @@ export interface operations {
|
|
|
369
398
|
"list-l4-tunnel-usage-series": {
|
|
370
399
|
parameters: {
|
|
371
400
|
query?: {
|
|
372
|
-
/** @description
|
|
401
|
+
/** @description How many days to cover. 0 requests the default of 30; the range accepted is 1–365, and a larger value is clamped to it */
|
|
373
402
|
days?: number;
|
|
374
403
|
};
|
|
375
404
|
header?: never;
|