@leaflow/sdk 0.0.0-dev.21.g192ee50 → 0.0.0-dev.212.gea1bf06
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/README.md +13 -1
- package/dist/account/v1/client.d.ts +4 -0
- package/dist/account/v1/client.js +7 -0
- package/dist/account/v1/index.d.ts +33 -22
- package/dist/account/v1/index.js +4 -4
- package/dist/account/v1/schema.d.ts +307 -89
- package/dist/assistant/v1/client.d.ts +4 -0
- package/dist/assistant/v1/client.js +7 -0
- package/dist/assistant/v1/index.d.ts +71 -40
- package/dist/assistant/v1/index.js +4 -4
- package/dist/assistant/v1/schema.d.ts +1204 -139
- package/dist/billing/v1/client.d.ts +4 -0
- package/dist/billing/v1/client.js +7 -0
- package/dist/billing/v1/index.d.ts +45 -0
- package/dist/billing/v1/index.js +5 -0
- package/dist/billing/v1/schema.d.ts +1404 -0
- package/dist/billing/v1/schema.js +5 -0
- package/dist/billingaccount/v1/client.d.ts +4 -0
- package/dist/billingaccount/v1/client.js +7 -0
- package/dist/billingaccount/v1/index.d.ts +151 -0
- package/dist/billingaccount/v1/index.js +5 -0
- package/dist/billingaccount/v1/schema.d.ts +4265 -0
- package/dist/billingaccount/v1/schema.js +5 -0
- package/dist/canopy/v1/client.d.ts +4 -0
- package/dist/canopy/v1/client.js +7 -0
- package/dist/canopy/v1/index.d.ts +24 -23
- package/dist/canopy/v1/index.js +4 -4
- package/dist/canopy/v1/schema.d.ts +113 -109
- package/dist/compute/v1/client.d.ts +4 -0
- package/dist/compute/v1/client.js +7 -0
- package/dist/compute/v1/index.d.ts +188 -125
- package/dist/compute/v1/index.js +4 -4
- package/dist/compute/v1/schema.d.ts +1953 -281
- package/dist/dns/v1/client.d.ts +4 -0
- package/dist/dns/v1/client.js +7 -0
- package/dist/dns/v1/index.d.ts +43 -0
- package/dist/dns/v1/index.js +5 -0
- package/dist/dns/v1/schema.d.ts +887 -0
- package/dist/dns/v1/schema.js +5 -0
- package/dist/iam/v1/client.d.ts +4 -0
- package/dist/iam/v1/client.js +7 -0
- package/dist/iam/v1/index.d.ts +55 -32
- package/dist/iam/v1/index.js +4 -4
- package/dist/iam/v1/schema.d.ts +521 -88
- package/dist/index.d.ts +12 -7
- package/dist/index.js +20 -5
- package/dist/monitoring/v1/client.d.ts +4 -0
- package/dist/monitoring/v1/client.js +7 -0
- package/dist/monitoring/v1/index.d.ts +130 -49
- package/dist/monitoring/v1/index.js +4 -4
- package/dist/monitoring/v1/schema.d.ts +2420 -527
- package/dist/notification/v1/client.d.ts +4 -0
- package/dist/notification/v1/client.js +7 -0
- package/dist/notification/v1/index.d.ts +77 -0
- package/dist/notification/v1/index.js +5 -0
- package/dist/notification/v1/schema.d.ts +2048 -0
- package/dist/notification/v1/schema.js +5 -0
- package/dist/support/v1/client.d.ts +4 -0
- package/dist/support/v1/client.js +7 -0
- package/dist/support/v1/index.d.ts +51 -0
- package/dist/support/v1/index.js +5 -0
- package/dist/support/v1/schema.d.ts +1082 -0
- package/dist/support/v1/schema.js +5 -0
- package/dist/tunnel/v1/client.d.ts +4 -0
- package/dist/tunnel/v1/client.js +7 -0
- package/dist/tunnel/v1/index.d.ts +8 -7
- package/dist/tunnel/v1/index.js +4 -4
- package/dist/tunnel/v1/schema.d.ts +40 -34
- package/package.json +26 -10
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { type ClientOptions } from "openapi-fetch";
|
|
2
|
+
import type { paths } from "./schema.js";
|
|
3
|
+
/** A client for the tunnel service. Pass baseUrl to override the address. */
|
|
4
|
+
export declare function client(options?: ClientOptions): import("openapi-fetch").Client<paths, `${string}/${string}`>;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
// Code generated from the contract's servers[0]. DO NOT EDIT.
|
|
2
|
+
import createClient, {} from "openapi-fetch";
|
|
3
|
+
const defaultBaseUrl = "https://tunnel.leaflow.cloud";
|
|
4
|
+
/** A client for the tunnel service. Pass baseUrl to override the address. */
|
|
5
|
+
export function client(options = {}) {
|
|
6
|
+
return createClient({ baseUrl: defaultBaseUrl, ...options });
|
|
7
|
+
}
|
|
@@ -1,16 +1,17 @@
|
|
|
1
1
|
export type { paths, components, operations, webhooks } from "./schema.js";
|
|
2
|
+
export { client } from "./client.js";
|
|
2
3
|
import type { operations } from "./schema.js";
|
|
3
|
-
/** `GET /api/v1/tunnel/l4
|
|
4
|
+
/** The success response body of `GET /api/v1/tunnel/l4`. */
|
|
4
5
|
export type GetL4TunnelResult = operations["get-l4-tunnel"]["responses"][200]["content"]["application/json"];
|
|
5
|
-
/** `POST /api/v1/tunnel/l4
|
|
6
|
+
/** The success response body of `POST /api/v1/tunnel/l4`. */
|
|
6
7
|
export type GenerateL4TunnelResult = operations["generate-l4-tunnel"]["responses"][200]["content"]["application/json"];
|
|
7
|
-
/** `GET /api/v1/tunnel/l4/subscription
|
|
8
|
+
/** The success response body of `GET /api/v1/tunnel/l4/subscription`. */
|
|
8
9
|
export type GetL4TunnelSubscriptionResult = operations["get-l4-tunnel-subscription"]["responses"][200]["content"]["application/json"];
|
|
9
|
-
/** `POST /api/v1/tunnel/l4/subscription/rotate
|
|
10
|
+
/** The success response body of `POST /api/v1/tunnel/l4/subscription/rotate`. */
|
|
10
11
|
export type RotateL4TunnelSubscriptionResult = operations["rotate-l4-tunnel-subscription"]["responses"][200]["content"]["application/json"];
|
|
11
|
-
/** `GET /api/v1/tunnel/l4/usage
|
|
12
|
+
/** The success response body of `GET /api/v1/tunnel/l4/usage`. */
|
|
12
13
|
export type GetL4TunnelUsageResult = operations["get-l4-tunnel-usage"]["responses"][200]["content"]["application/json"];
|
|
13
|
-
/** `GET /api/v1/tunnel/l4/usage/series
|
|
14
|
+
/** The success response body of `GET /api/v1/tunnel/l4/usage/series`. */
|
|
14
15
|
export type ListL4TunnelUsageSeriesResult = operations["list-l4-tunnel-usage-series"]["responses"][200]["content"]["application/json"];
|
|
15
|
-
/** `GET /api/v1/tunnel/l4/usage/series
|
|
16
|
+
/** The query parameters of `GET /api/v1/tunnel/l4/usage/series`. */
|
|
16
17
|
export type ListL4TunnelUsageSeriesQuery = operations["list-l4-tunnel-usage-series"]["parameters"]["query"];
|
package/dist/tunnel/v1/index.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
//
|
|
1
|
+
// Code generated by scripts/generate.mjs. DO NOT EDIT.
|
|
2
2
|
//
|
|
3
|
-
//
|
|
4
|
-
//
|
|
5
|
-
export {};
|
|
3
|
+
// The aliases replace the operations[...] subscript chain with a name. The raw paths /
|
|
4
|
+
// components / operations are exported as well: paths is what createClient<paths>() takes.
|
|
5
|
+
export { client } from "./client.js";
|
|
@@ -11,18 +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
|
+
*
|
|
19
|
+
* The subscription address, the usage and the quota each have their own endpoint and are not repeated here.
|
|
18
20
|
*/
|
|
19
21
|
get: operations["get-l4-tunnel"];
|
|
20
22
|
put?: never;
|
|
21
23
|
/**
|
|
22
|
-
*
|
|
23
|
-
* @description
|
|
24
|
+
* Generate the layer 4 tunnel
|
|
25
|
+
* @description **Idempotent**: calling it again returns the existing tunnel rather than an error.
|
|
24
26
|
*
|
|
25
|
-
*
|
|
27
|
+
* Read the address from the subscription endpoint afterwards; it is not returned here.
|
|
26
28
|
*/
|
|
27
29
|
post: operations["generate-l4-tunnel"];
|
|
28
30
|
delete?: never;
|
|
@@ -39,12 +41,12 @@ export interface paths {
|
|
|
39
41
|
cookie?: never;
|
|
40
42
|
};
|
|
41
43
|
/**
|
|
42
|
-
*
|
|
43
|
-
* @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.
|
|
44
46
|
*
|
|
45
|
-
*
|
|
47
|
+
* Do not call this endpoint before the user asks for the address.
|
|
46
48
|
*
|
|
47
|
-
* `status`
|
|
49
|
+
* A `status` of `preparing` leaves the link usable; its contents are derived at the moment it is fetched.
|
|
48
50
|
*/
|
|
49
51
|
get: operations["get-l4-tunnel-subscription"];
|
|
50
52
|
put?: never;
|
|
@@ -65,14 +67,14 @@ export interface paths {
|
|
|
65
67
|
get?: never;
|
|
66
68
|
put?: never;
|
|
67
69
|
/**
|
|
68
|
-
*
|
|
69
|
-
* @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.**
|
|
70
72
|
*
|
|
71
|
-
*
|
|
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.
|
|
72
74
|
*
|
|
73
|
-
*
|
|
75
|
+
* A tunnel disabled by the platform cannot be rotated (`TUNNEL_DISABLED_FOR_ROTATE`); resolve the cause first.
|
|
74
76
|
*
|
|
75
|
-
*
|
|
77
|
+
* Read the new address from the subscription endpoint afterwards; **it is not returned here**.
|
|
76
78
|
*/
|
|
77
79
|
post: operations["rotate-l4-tunnel-subscription"];
|
|
78
80
|
delete?: never;
|
|
@@ -89,10 +91,10 @@ export interface paths {
|
|
|
89
91
|
cookie?: never;
|
|
90
92
|
};
|
|
91
93
|
/**
|
|
92
|
-
*
|
|
93
|
-
* @description
|
|
94
|
+
* Get the usage of the current period
|
|
95
|
+
* @description Read live.
|
|
94
96
|
*
|
|
95
|
-
*
|
|
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.
|
|
96
98
|
*/
|
|
97
99
|
get: operations["get-l4-tunnel-usage"];
|
|
98
100
|
put?: never;
|
|
@@ -111,10 +113,10 @@ export interface paths {
|
|
|
111
113
|
cookie?: never;
|
|
112
114
|
};
|
|
113
115
|
/**
|
|
114
|
-
*
|
|
115
|
-
* @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.
|
|
116
118
|
*
|
|
117
|
-
*
|
|
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.
|
|
118
120
|
*/
|
|
119
121
|
get: operations["list-l4-tunnel-usage-series"];
|
|
120
122
|
put?: never;
|
|
@@ -132,6 +134,10 @@ export interface components {
|
|
|
132
134
|
Error: {
|
|
133
135
|
code?: string;
|
|
134
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
|
+
*/
|
|
135
141
|
meta?: {
|
|
136
142
|
[key: string]: unknown;
|
|
137
143
|
};
|
|
@@ -140,22 +146,22 @@ export interface components {
|
|
|
140
146
|
};
|
|
141
147
|
SubscriptionResource: {
|
|
142
148
|
/**
|
|
143
|
-
* @description ready
|
|
149
|
+
* @description ready means every node has been distributed; preparing means distribution is still under way, and the link works either way
|
|
144
150
|
* @enum {string}
|
|
145
151
|
*/
|
|
146
152
|
status: "preparing" | "ready";
|
|
147
153
|
/** Format: date-time */
|
|
148
154
|
updated_at: string;
|
|
149
|
-
/** @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 */
|
|
150
156
|
url: string;
|
|
151
157
|
/** Format: int64 */
|
|
152
158
|
version: number;
|
|
153
159
|
};
|
|
154
|
-
/** @description
|
|
160
|
+
/** @description The layer 4 tunnel of the current project. It answers a single question — whether the tunnel has been generated */
|
|
155
161
|
TunnelResource: {
|
|
156
162
|
/** Format: date-time */
|
|
157
163
|
created_at: string;
|
|
158
|
-
/** @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 */
|
|
159
165
|
enabled: boolean;
|
|
160
166
|
/** Format: uuid */
|
|
161
167
|
id: string;
|
|
@@ -171,41 +177,41 @@ export interface components {
|
|
|
171
177
|
UsageResource: {
|
|
172
178
|
/**
|
|
173
179
|
* Format: int64
|
|
174
|
-
* @description
|
|
180
|
+
* @description Usage after the multiplier of each route has been applied. Quota is measured against this value
|
|
175
181
|
*/
|
|
176
182
|
billed_bytes: number;
|
|
177
183
|
over_quota: boolean;
|
|
178
|
-
/** @description
|
|
184
|
+
/** @description Last day of the current billing period (YYYY-MM-DD) */
|
|
179
185
|
period_end: string;
|
|
180
|
-
/** @description
|
|
186
|
+
/** @description First day of the current billing period (YYYY-MM-DD) */
|
|
181
187
|
period_start: string;
|
|
182
188
|
/**
|
|
183
189
|
* Format: int64
|
|
184
|
-
* @description
|
|
190
|
+
* @description The quota in force; 0 means unlimited
|
|
185
191
|
*/
|
|
186
192
|
quota_bytes: number;
|
|
187
193
|
/**
|
|
188
194
|
* Format: date-time
|
|
189
|
-
* @description
|
|
195
|
+
* @description When the quota was found to be exceeded; null while it has not been
|
|
190
196
|
*/
|
|
191
197
|
quota_exceeded_at: string | null;
|
|
192
198
|
/**
|
|
193
199
|
* Format: int64
|
|
194
|
-
* @description
|
|
200
|
+
* @description Bytes actually transferred. Quota is not measured against this value
|
|
195
201
|
*/
|
|
196
202
|
raw_bytes: number;
|
|
197
203
|
/** Format: int64 */
|
|
198
204
|
upload_bytes: number;
|
|
199
205
|
/**
|
|
200
206
|
* Format: double
|
|
201
|
-
* @description
|
|
207
|
+
* @description Usage as a percentage of the quota
|
|
202
208
|
*/
|
|
203
209
|
usage_percent: number;
|
|
204
210
|
};
|
|
205
211
|
UsageSeriesResource: {
|
|
206
212
|
/**
|
|
207
213
|
* Format: int64
|
|
208
|
-
* @description
|
|
214
|
+
* @description The number of days actually covered, which may have been clamped to the range 1–365
|
|
209
215
|
*/
|
|
210
216
|
days: number;
|
|
211
217
|
points: components["schemas"]["UsageDayResource"][];
|
|
@@ -367,7 +373,7 @@ export interface operations {
|
|
|
367
373
|
"list-l4-tunnel-usage-series": {
|
|
368
374
|
parameters: {
|
|
369
375
|
query?: {
|
|
370
|
-
/** @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 */
|
|
371
377
|
days?: number;
|
|
372
378
|
};
|
|
373
379
|
header?: never;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@leaflow/sdk",
|
|
3
|
-
"version": "0.0.0-dev.
|
|
3
|
+
"version": "0.0.0-dev.212.gea1bf06",
|
|
4
4
|
"description": "Leaflow 平台 API 的 TypeScript SDK",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -23,6 +23,14 @@
|
|
|
23
23
|
"types": "./dist/assistant/v1/index.d.ts",
|
|
24
24
|
"default": "./dist/assistant/v1/index.js"
|
|
25
25
|
},
|
|
26
|
+
"./billing/v1": {
|
|
27
|
+
"types": "./dist/billing/v1/index.d.ts",
|
|
28
|
+
"default": "./dist/billing/v1/index.js"
|
|
29
|
+
},
|
|
30
|
+
"./billingaccount/v1": {
|
|
31
|
+
"types": "./dist/billingaccount/v1/index.d.ts",
|
|
32
|
+
"default": "./dist/billingaccount/v1/index.js"
|
|
33
|
+
},
|
|
26
34
|
"./canopy/v1": {
|
|
27
35
|
"types": "./dist/canopy/v1/index.d.ts",
|
|
28
36
|
"default": "./dist/canopy/v1/index.js"
|
|
@@ -31,6 +39,10 @@
|
|
|
31
39
|
"types": "./dist/compute/v1/index.d.ts",
|
|
32
40
|
"default": "./dist/compute/v1/index.js"
|
|
33
41
|
},
|
|
42
|
+
"./dns/v1": {
|
|
43
|
+
"types": "./dist/dns/v1/index.d.ts",
|
|
44
|
+
"default": "./dist/dns/v1/index.js"
|
|
45
|
+
},
|
|
34
46
|
"./iam/v1": {
|
|
35
47
|
"types": "./dist/iam/v1/index.d.ts",
|
|
36
48
|
"default": "./dist/iam/v1/index.js"
|
|
@@ -39,6 +51,14 @@
|
|
|
39
51
|
"types": "./dist/monitoring/v1/index.d.ts",
|
|
40
52
|
"default": "./dist/monitoring/v1/index.js"
|
|
41
53
|
},
|
|
54
|
+
"./notification/v1": {
|
|
55
|
+
"types": "./dist/notification/v1/index.d.ts",
|
|
56
|
+
"default": "./dist/notification/v1/index.js"
|
|
57
|
+
},
|
|
58
|
+
"./support/v1": {
|
|
59
|
+
"types": "./dist/support/v1/index.d.ts",
|
|
60
|
+
"default": "./dist/support/v1/index.js"
|
|
61
|
+
},
|
|
42
62
|
"./tunnel/v1": {
|
|
43
63
|
"types": "./dist/tunnel/v1/index.d.ts",
|
|
44
64
|
"default": "./dist/tunnel/v1/index.js"
|
|
@@ -52,23 +72,19 @@
|
|
|
52
72
|
"generate": "node scripts/generate.mjs",
|
|
53
73
|
"build": "tsc -p tsconfig.build.json",
|
|
54
74
|
"typecheck": "tsc -p tsconfig.json --noEmit",
|
|
55
|
-
"prepublishOnly": "npm run build"
|
|
75
|
+
"prepublishOnly": "npm run build",
|
|
76
|
+
"format:check": "prettier --check gen scripts"
|
|
56
77
|
},
|
|
57
78
|
"devDependencies": {
|
|
58
79
|
"openapi-typescript": "7.13.0",
|
|
80
|
+
"prettier": "^3.6.2",
|
|
59
81
|
"typescript": "^5.9.3",
|
|
60
|
-
"openapi-fetch": "^0.17.0",
|
|
61
82
|
"yaml": "^2.8.1"
|
|
62
83
|
},
|
|
63
84
|
"publishConfig": {
|
|
64
85
|
"access": "public"
|
|
65
86
|
},
|
|
66
|
-
"
|
|
67
|
-
"openapi-fetch": "
|
|
68
|
-
},
|
|
69
|
-
"peerDependenciesMeta": {
|
|
70
|
-
"openapi-fetch": {
|
|
71
|
-
"optional": true
|
|
72
|
-
}
|
|
87
|
+
"dependencies": {
|
|
88
|
+
"openapi-fetch": "^0.17.0"
|
|
73
89
|
}
|
|
74
90
|
}
|