@leaflow/sdk 0.54.4 → 0.55.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/dist/account/v1/index.d.ts +2 -2
- package/dist/account/v1/schema.d.ts +123 -122
- package/dist/assistant/v1/schema.d.ts +4 -0
- package/dist/billing/v1/index.d.ts +8 -2
- package/dist/billing/v1/schema.d.ts +174 -5
- package/dist/canopy/v1/schema.d.ts +113 -109
- package/dist/compute/v1/index.d.ts +4 -2
- package/dist/compute/v1/schema.d.ts +55 -0
- package/dist/dns/v1/index.d.ts +6 -6
- package/dist/dns/v1/schema.d.ts +4 -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 +156 -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 +119 -115
- package/dist/index.d.ts +1 -0
- package/dist/monitoring/v1/index.d.ts +4 -4
- package/dist/monitoring/v1/schema.d.ts +4 -0
- package/dist/notification/v1/schema.d.ts +4 -0
- package/dist/support/v1/schema.d.ts +4 -0
- package/dist/tunnel/v1/schema.d.ts +39 -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}` 成功时的响应体。 */
|
|
@@ -958,6 +958,10 @@ export interface components {
|
|
|
958
958
|
Error: {
|
|
959
959
|
code?: string;
|
|
960
960
|
message: string;
|
|
961
|
+
/**
|
|
962
|
+
* @description What a given `code` carries alongside the message. The keys depend on the code,
|
|
963
|
+
* and a client that does not recognise one ignores it.
|
|
964
|
+
*/
|
|
961
965
|
meta?: {
|
|
962
966
|
[key: string]: unknown;
|
|
963
967
|
};
|
|
@@ -624,6 +624,10 @@ export interface components {
|
|
|
624
624
|
Error: {
|
|
625
625
|
code?: string;
|
|
626
626
|
message: string;
|
|
627
|
+
/**
|
|
628
|
+
* @description What a given `code` carries alongside the message. The keys depend on the code,
|
|
629
|
+
* and a client that does not recognise one ignores it.
|
|
630
|
+
*/
|
|
627
631
|
meta?: {
|
|
628
632
|
[key: string]: unknown;
|
|
629
633
|
};
|
|
@@ -298,6 +298,10 @@ export interface components {
|
|
|
298
298
|
Error: {
|
|
299
299
|
code?: string;
|
|
300
300
|
message: string;
|
|
301
|
+
/**
|
|
302
|
+
* @description What a given `code` carries alongside the message. The keys depend on the code,
|
|
303
|
+
* and a client that does not recognise one ignores it.
|
|
304
|
+
*/
|
|
301
305
|
meta?: {
|
|
302
306
|
[key: string]: unknown;
|
|
303
307
|
};
|
|
@@ -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;
|
|
@@ -134,6 +134,10 @@ export interface components {
|
|
|
134
134
|
Error: {
|
|
135
135
|
code?: string;
|
|
136
136
|
message: string;
|
|
137
|
+
/**
|
|
138
|
+
* @description What a given `code` carries alongside the message. The keys depend on the code,
|
|
139
|
+
* and a client that does not recognise one ignores it.
|
|
140
|
+
*/
|
|
137
141
|
meta?: {
|
|
138
142
|
[key: string]: unknown;
|
|
139
143
|
};
|
|
@@ -142,22 +146,22 @@ export interface components {
|
|
|
142
146
|
};
|
|
143
147
|
SubscriptionResource: {
|
|
144
148
|
/**
|
|
145
|
-
* @description ready
|
|
149
|
+
* @description ready means every node has been distributed; preparing means distribution is still under way, and the link works either way
|
|
146
150
|
* @enum {string}
|
|
147
151
|
*/
|
|
148
152
|
status: "preparing" | "ready";
|
|
149
153
|
/** Format: date-time */
|
|
150
154
|
updated_at: string;
|
|
151
|
-
/** @description
|
|
155
|
+
/** @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
156
|
url: string;
|
|
153
157
|
/** Format: int64 */
|
|
154
158
|
version: number;
|
|
155
159
|
};
|
|
156
|
-
/** @description
|
|
160
|
+
/** @description The layer 4 tunnel of the current project. It answers a single question — whether the tunnel has been generated */
|
|
157
161
|
TunnelResource: {
|
|
158
162
|
/** Format: date-time */
|
|
159
163
|
created_at: string;
|
|
160
|
-
/** @description
|
|
164
|
+
/** @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
165
|
enabled: boolean;
|
|
162
166
|
/** Format: uuid */
|
|
163
167
|
id: string;
|
|
@@ -173,41 +177,41 @@ export interface components {
|
|
|
173
177
|
UsageResource: {
|
|
174
178
|
/**
|
|
175
179
|
* Format: int64
|
|
176
|
-
* @description
|
|
180
|
+
* @description Usage after the multiplier of each route has been applied. Quota is measured against this value
|
|
177
181
|
*/
|
|
178
182
|
billed_bytes: number;
|
|
179
183
|
over_quota: boolean;
|
|
180
|
-
/** @description
|
|
184
|
+
/** @description Last day of the current billing period (YYYY-MM-DD) */
|
|
181
185
|
period_end: string;
|
|
182
|
-
/** @description
|
|
186
|
+
/** @description First day of the current billing period (YYYY-MM-DD) */
|
|
183
187
|
period_start: string;
|
|
184
188
|
/**
|
|
185
189
|
* Format: int64
|
|
186
|
-
* @description
|
|
190
|
+
* @description The quota in force; 0 means unlimited
|
|
187
191
|
*/
|
|
188
192
|
quota_bytes: number;
|
|
189
193
|
/**
|
|
190
194
|
* Format: date-time
|
|
191
|
-
* @description
|
|
195
|
+
* @description When the quota was found to be exceeded; null while it has not been
|
|
192
196
|
*/
|
|
193
197
|
quota_exceeded_at: string | null;
|
|
194
198
|
/**
|
|
195
199
|
* Format: int64
|
|
196
|
-
* @description
|
|
200
|
+
* @description Bytes actually transferred. Quota is not measured against this value
|
|
197
201
|
*/
|
|
198
202
|
raw_bytes: number;
|
|
199
203
|
/** Format: int64 */
|
|
200
204
|
upload_bytes: number;
|
|
201
205
|
/**
|
|
202
206
|
* Format: double
|
|
203
|
-
* @description
|
|
207
|
+
* @description Usage as a percentage of the quota
|
|
204
208
|
*/
|
|
205
209
|
usage_percent: number;
|
|
206
210
|
};
|
|
207
211
|
UsageSeriesResource: {
|
|
208
212
|
/**
|
|
209
213
|
* Format: int64
|
|
210
|
-
* @description
|
|
214
|
+
* @description The number of days actually covered, which may have been clamped to the range 1–365
|
|
211
215
|
*/
|
|
212
216
|
days: number;
|
|
213
217
|
points: components["schemas"]["UsageDayResource"][];
|
|
@@ -369,7 +373,7 @@ export interface operations {
|
|
|
369
373
|
"list-l4-tunnel-usage-series": {
|
|
370
374
|
parameters: {
|
|
371
375
|
query?: {
|
|
372
|
-
/** @description
|
|
376
|
+
/** @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
377
|
days?: number;
|
|
374
378
|
};
|
|
375
379
|
header?: never;
|