@leaflow/sdk 0.69.0 → 0.71.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.
|
@@ -511,6 +511,12 @@ export interface components {
|
|
|
511
511
|
token: string;
|
|
512
512
|
};
|
|
513
513
|
ProjectResource: {
|
|
514
|
+
/**
|
|
515
|
+
* Format: date-time
|
|
516
|
+
* @description A read-only management lock. Running resources and billing remain unchanged. Only an operator can release it.
|
|
517
|
+
*/
|
|
518
|
+
locked_at: string | null;
|
|
519
|
+
lock_reason: string;
|
|
514
520
|
ban_reason: string;
|
|
515
521
|
/** Format: date-time */
|
|
516
522
|
created_at: string;
|
|
@@ -1,6 +1,18 @@
|
|
|
1
1
|
export type { paths, components, operations, webhooks } from "./schema.js";
|
|
2
2
|
export { client } from "./client.js";
|
|
3
3
|
import type { operations } from "./schema.js";
|
|
4
|
+
/** The success response body of `GET /account/v1/commitments`. */
|
|
5
|
+
export type ListCommitmentsResult = operations["ListCommitments"]["responses"][200]["content"]["application/json"];
|
|
6
|
+
/** The query parameters of `GET /account/v1/commitments`. */
|
|
7
|
+
export type ListCommitmentsQuery = operations["ListCommitments"]["parameters"]["query"];
|
|
8
|
+
/** The success response body of `GET /api/v1/projects/{projectId}/closure-preview`. */
|
|
9
|
+
export type GetProjectClosurePreviewResult = operations["get-project-closure-preview"]["responses"][200]["content"]["application/json"];
|
|
10
|
+
/** The query parameters of `GET /api/v1/projects/{projectId}/closure-preview`. */
|
|
11
|
+
export type GetProjectClosurePreviewQuery = operations["get-project-closure-preview"]["parameters"]["query"];
|
|
12
|
+
/** The success response body of `GET /account/v1/projects/{projectId}/closure-preview`. */
|
|
13
|
+
export type GetAccountProjectClosurePreviewResult = operations["get-account-project-closure-preview"]["responses"][200]["content"]["application/json"];
|
|
14
|
+
/** The query parameters of `GET /account/v1/projects/{projectId}/closure-preview`. */
|
|
15
|
+
export type GetAccountProjectClosurePreviewQuery = operations["get-account-project-closure-preview"]["parameters"]["query"];
|
|
4
16
|
/** The success response body of `GET /catalog/v1/products`. */
|
|
5
17
|
export type ListCatalogProductsResult = operations["list-catalog-products"]["responses"][200]["content"]["application/json"];
|
|
6
18
|
/** The success response body of `GET /catalog/v1/products/{productId}/plans`. */
|
|
@@ -3,6 +3,63 @@
|
|
|
3
3
|
* Do not make direct changes to the file.
|
|
4
4
|
*/
|
|
5
5
|
export interface paths {
|
|
6
|
+
"/account/v1/commitments": {
|
|
7
|
+
parameters: {
|
|
8
|
+
query?: never;
|
|
9
|
+
header?: never;
|
|
10
|
+
path?: never;
|
|
11
|
+
cookie?: never;
|
|
12
|
+
};
|
|
13
|
+
/** List account commercial commitments */
|
|
14
|
+
get: operations["ListCommitments"];
|
|
15
|
+
put?: never;
|
|
16
|
+
post?: never;
|
|
17
|
+
delete?: never;
|
|
18
|
+
options?: never;
|
|
19
|
+
head?: never;
|
|
20
|
+
patch?: never;
|
|
21
|
+
trace?: never;
|
|
22
|
+
};
|
|
23
|
+
"/api/v1/projects/{projectId}/closure-preview": {
|
|
24
|
+
parameters: {
|
|
25
|
+
query?: never;
|
|
26
|
+
header?: never;
|
|
27
|
+
path?: never;
|
|
28
|
+
cookie?: never;
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* Preview project closure
|
|
32
|
+
* @description Lists outstanding orders, subscriptions, metering and unfinished operations. Reports the next action and timing for each item. This read never performs cleanup or creates a closure request. Historical invoices and account-level purchases are retained. Billing approval alone does not prove that technical resources are absent.
|
|
33
|
+
*/
|
|
34
|
+
get: operations["get-project-closure-preview"];
|
|
35
|
+
put?: never;
|
|
36
|
+
post?: never;
|
|
37
|
+
delete?: never;
|
|
38
|
+
options?: never;
|
|
39
|
+
head?: never;
|
|
40
|
+
patch?: never;
|
|
41
|
+
trace?: never;
|
|
42
|
+
};
|
|
43
|
+
"/account/v1/projects/{projectId}/closure-preview": {
|
|
44
|
+
parameters: {
|
|
45
|
+
query?: never;
|
|
46
|
+
header?: never;
|
|
47
|
+
path?: never;
|
|
48
|
+
cookie?: never;
|
|
49
|
+
};
|
|
50
|
+
/**
|
|
51
|
+
* Preview project closure
|
|
52
|
+
* @description Lists outstanding orders, subscriptions, metering and unfinished operations. Reports the next action and timing for each item. This read never performs cleanup or creates a closure request. Historical invoices and account-level purchases are retained. Billing approval alone does not prove that technical resources are absent.
|
|
53
|
+
*/
|
|
54
|
+
get: operations["get-account-project-closure-preview"];
|
|
55
|
+
put?: never;
|
|
56
|
+
post?: never;
|
|
57
|
+
delete?: never;
|
|
58
|
+
options?: never;
|
|
59
|
+
head?: never;
|
|
60
|
+
patch?: never;
|
|
61
|
+
trace?: never;
|
|
62
|
+
};
|
|
6
63
|
"/catalog/v1/products": {
|
|
7
64
|
parameters: {
|
|
8
65
|
query?: never;
|
|
@@ -1305,6 +1362,133 @@ export interface paths {
|
|
|
1305
1362
|
export type webhooks = Record<string, never>;
|
|
1306
1363
|
export interface components {
|
|
1307
1364
|
schemas: {
|
|
1365
|
+
CommitmentPeriod: {
|
|
1366
|
+
/** Format: uuid */
|
|
1367
|
+
id: string;
|
|
1368
|
+
sequence: number;
|
|
1369
|
+
/** Format: date-time */
|
|
1370
|
+
period_start: string;
|
|
1371
|
+
/** Format: date-time */
|
|
1372
|
+
period_end: string;
|
|
1373
|
+
/** Format: date-time */
|
|
1374
|
+
due_at: string;
|
|
1375
|
+
amount: string;
|
|
1376
|
+
/** Format: uuid */
|
|
1377
|
+
invoice_item_id?: string;
|
|
1378
|
+
/** Format: date-time */
|
|
1379
|
+
finalized_at?: string;
|
|
1380
|
+
eligible_amount?: string;
|
|
1381
|
+
amount_due?: string;
|
|
1382
|
+
/** Format: date-time */
|
|
1383
|
+
waived_at?: string;
|
|
1384
|
+
waiver_reason?: string;
|
|
1385
|
+
};
|
|
1386
|
+
/** @description Account-owned commercial obligation. Project removal does not waive payment. Minimum-spend activation requires a defined, reproducible eligibility policy; drafts do not authorize collection. */
|
|
1387
|
+
Commitment: {
|
|
1388
|
+
/** Format: uuid */
|
|
1389
|
+
id: string;
|
|
1390
|
+
billing_account_id: number;
|
|
1391
|
+
currency: string;
|
|
1392
|
+
/** @enum {string} */
|
|
1393
|
+
type: "fixed_amount" | "minimum_spend";
|
|
1394
|
+
/** @enum {string} */
|
|
1395
|
+
status: "draft" | "active" | "completed" | "terminated";
|
|
1396
|
+
description: string;
|
|
1397
|
+
terms_reference: string;
|
|
1398
|
+
/** Format: date-time */
|
|
1399
|
+
effective_from: string;
|
|
1400
|
+
/** Format: date-time */
|
|
1401
|
+
effective_to: string;
|
|
1402
|
+
/** @enum {string} */
|
|
1403
|
+
release_policy: "retain_until_term" | "release_with_obligation";
|
|
1404
|
+
/** Format: uuid */
|
|
1405
|
+
contract_id?: string;
|
|
1406
|
+
/** Format: uuid */
|
|
1407
|
+
origin_order_item_id?: string;
|
|
1408
|
+
/** Format: uuid */
|
|
1409
|
+
origin_project_id?: string;
|
|
1410
|
+
/** Format: date-time */
|
|
1411
|
+
accepted_at?: string;
|
|
1412
|
+
accepted_by?: string;
|
|
1413
|
+
eligibility_policy_version?: string;
|
|
1414
|
+
/** Format: date-time */
|
|
1415
|
+
terminated_at?: string;
|
|
1416
|
+
termination_reason?: string;
|
|
1417
|
+
periods: components["schemas"]["CommitmentPeriod"][];
|
|
1418
|
+
};
|
|
1419
|
+
CommitmentList: {
|
|
1420
|
+
items: components["schemas"]["Commitment"][];
|
|
1421
|
+
/** Format: int64 */
|
|
1422
|
+
total_count: number;
|
|
1423
|
+
};
|
|
1424
|
+
/**
|
|
1425
|
+
* @description Whether a fulfilled purchase may end immediately or only after its paid term. Does not grant a refund. When absent, the terms are not configured and termination requires review.
|
|
1426
|
+
* @enum {string}
|
|
1427
|
+
*/
|
|
1428
|
+
TerminationPolicy: "immediate" | "period_end";
|
|
1429
|
+
/**
|
|
1430
|
+
* @description none preserves paid amounts when fulfilled service ends. standard applies the documented refund window and change proration rules. Releasing unpaid holds or returning funds for failed fulfillment is separate.
|
|
1431
|
+
* @enum {string}
|
|
1432
|
+
*/
|
|
1433
|
+
RefundPolicy: "none" | "standard";
|
|
1434
|
+
/** @description A cancellation request for the original purchase. scheduled_for is the intended time; effective_at is the confirmed end of service. The request alone does not stop metering or issue a refund. */
|
|
1435
|
+
SubscriptionCancellation: {
|
|
1436
|
+
/** Format: uuid */
|
|
1437
|
+
id: string;
|
|
1438
|
+
/** Format: uuid */
|
|
1439
|
+
subscription_item_id: string;
|
|
1440
|
+
/** @enum {string} */
|
|
1441
|
+
status: "requested" | "scheduled" | "releasing" | "failed" | "completed" | "canceled";
|
|
1442
|
+
/** @enum {string} */
|
|
1443
|
+
mode: "immediate" | "period_end";
|
|
1444
|
+
/** Format: date-time */
|
|
1445
|
+
requested_at: string;
|
|
1446
|
+
/** Format: date-time */
|
|
1447
|
+
scheduled_for?: string;
|
|
1448
|
+
/** Format: date-time */
|
|
1449
|
+
effective_at?: string;
|
|
1450
|
+
/** Format: date-time */
|
|
1451
|
+
completed_at?: string;
|
|
1452
|
+
/** Format: date-time */
|
|
1453
|
+
release_started_at?: string;
|
|
1454
|
+
/** Format: date-time */
|
|
1455
|
+
canceled_at?: string;
|
|
1456
|
+
forfeit_remaining_value: boolean;
|
|
1457
|
+
failure_code?: string;
|
|
1458
|
+
failure_reason?: string;
|
|
1459
|
+
};
|
|
1460
|
+
/** @description One outstanding Billing obligation. action_required identifies a supported next step, not authorization to destroy a resource. Items for the same resource must be considered together. */
|
|
1461
|
+
ProjectClosureItem: {
|
|
1462
|
+
/** @enum {string} */
|
|
1463
|
+
type: "order" | "subscription_item" | "active_resource" | "resource_operation" | "subscription_cancellation" | "usage_charge" | "commitment";
|
|
1464
|
+
/** Format: uuid */
|
|
1465
|
+
id: string;
|
|
1466
|
+
/** Format: uuid */
|
|
1467
|
+
product_id?: string;
|
|
1468
|
+
resource_id?: string;
|
|
1469
|
+
/** @enum {string} */
|
|
1470
|
+
disposition: "action_required" | "waiting" | "blocked";
|
|
1471
|
+
reason_code: string;
|
|
1472
|
+
actions: ("cancel_order" | "wait" | "release_resource" | "cancel_subscription" | "disable_auto_renew" | "settle_usage" | "configure_terms" | "resolve_failure")[];
|
|
1473
|
+
/** Format: date-time */
|
|
1474
|
+
earliest_termination_at?: string;
|
|
1475
|
+
/** @description Known refund amount as a decimal string. Absent means a separate quote is required, not zero. */
|
|
1476
|
+
refund_amount?: string;
|
|
1477
|
+
currency?: string;
|
|
1478
|
+
cancellation?: components["schemas"]["SubscriptionCancellation"];
|
|
1479
|
+
};
|
|
1480
|
+
/** @description Read-only, paginated assessment. Does not cancel orders, stop renewals, refund payments or release resources. Concurrent orders or callbacks may change the result; execution must close admission and recheck. */
|
|
1481
|
+
ProjectClosurePreview: {
|
|
1482
|
+
/** Format: uuid */
|
|
1483
|
+
project_id: string;
|
|
1484
|
+
/** Format: date-time */
|
|
1485
|
+
evaluated_at: string;
|
|
1486
|
+
/** @description True only when the full Billing result, across all pages, has no outstanding obligations. Technical services must independently confirm that all resources are gone. */
|
|
1487
|
+
can_close: boolean;
|
|
1488
|
+
items: components["schemas"]["ProjectClosureItem"][];
|
|
1489
|
+
/** Format: int64 */
|
|
1490
|
+
total_count: number;
|
|
1491
|
+
};
|
|
1308
1492
|
Error: {
|
|
1309
1493
|
code?: string;
|
|
1310
1494
|
message: string;
|
|
@@ -1361,6 +1545,8 @@ export interface components {
|
|
|
1361
1545
|
total_count?: number;
|
|
1362
1546
|
};
|
|
1363
1547
|
CatalogPrice: {
|
|
1548
|
+
termination_policy?: components["schemas"]["TerminationPolicy"];
|
|
1549
|
+
refund_policy?: components["schemas"]["RefundPolicy"];
|
|
1364
1550
|
/** @description External lookup alias within the service. Existing references use the price ID. */
|
|
1365
1551
|
lookup_key?: string;
|
|
1366
1552
|
/** Format: uuid */
|
|
@@ -2953,6 +3139,83 @@ export interface components {
|
|
|
2953
3139
|
}
|
|
2954
3140
|
export type $defs = Record<string, never>;
|
|
2955
3141
|
export interface operations {
|
|
3142
|
+
ListCommitments: {
|
|
3143
|
+
parameters: {
|
|
3144
|
+
query: {
|
|
3145
|
+
billing_account_id: number;
|
|
3146
|
+
page?: number;
|
|
3147
|
+
page_size?: number;
|
|
3148
|
+
};
|
|
3149
|
+
header?: never;
|
|
3150
|
+
path?: never;
|
|
3151
|
+
cookie?: never;
|
|
3152
|
+
};
|
|
3153
|
+
requestBody?: never;
|
|
3154
|
+
responses: {
|
|
3155
|
+
/** @description Commitments including original payment schedules. */
|
|
3156
|
+
200: {
|
|
3157
|
+
headers: {
|
|
3158
|
+
[name: string]: unknown;
|
|
3159
|
+
};
|
|
3160
|
+
content: {
|
|
3161
|
+
"application/json": components["schemas"]["CommitmentList"];
|
|
3162
|
+
};
|
|
3163
|
+
};
|
|
3164
|
+
default: components["responses"]["Error"];
|
|
3165
|
+
};
|
|
3166
|
+
};
|
|
3167
|
+
"get-project-closure-preview": {
|
|
3168
|
+
parameters: {
|
|
3169
|
+
query?: {
|
|
3170
|
+
page?: number;
|
|
3171
|
+
page_size?: number;
|
|
3172
|
+
};
|
|
3173
|
+
header?: never;
|
|
3174
|
+
path: {
|
|
3175
|
+
projectId: string;
|
|
3176
|
+
};
|
|
3177
|
+
cookie?: never;
|
|
3178
|
+
};
|
|
3179
|
+
requestBody?: never;
|
|
3180
|
+
responses: {
|
|
3181
|
+
/** @description Closure assessment */
|
|
3182
|
+
200: {
|
|
3183
|
+
headers: {
|
|
3184
|
+
[name: string]: unknown;
|
|
3185
|
+
};
|
|
3186
|
+
content: {
|
|
3187
|
+
"application/json": components["schemas"]["ProjectClosurePreview"];
|
|
3188
|
+
};
|
|
3189
|
+
};
|
|
3190
|
+
default: components["responses"]["Error"];
|
|
3191
|
+
};
|
|
3192
|
+
};
|
|
3193
|
+
"get-account-project-closure-preview": {
|
|
3194
|
+
parameters: {
|
|
3195
|
+
query?: {
|
|
3196
|
+
page?: number;
|
|
3197
|
+
page_size?: number;
|
|
3198
|
+
};
|
|
3199
|
+
header?: never;
|
|
3200
|
+
path: {
|
|
3201
|
+
projectId: string;
|
|
3202
|
+
};
|
|
3203
|
+
cookie?: never;
|
|
3204
|
+
};
|
|
3205
|
+
requestBody?: never;
|
|
3206
|
+
responses: {
|
|
3207
|
+
/** @description Closure assessment */
|
|
3208
|
+
200: {
|
|
3209
|
+
headers: {
|
|
3210
|
+
[name: string]: unknown;
|
|
3211
|
+
};
|
|
3212
|
+
content: {
|
|
3213
|
+
"application/json": components["schemas"]["ProjectClosurePreview"];
|
|
3214
|
+
};
|
|
3215
|
+
};
|
|
3216
|
+
default: components["responses"]["Error"];
|
|
3217
|
+
};
|
|
3218
|
+
};
|
|
2956
3219
|
"list-catalog-products": {
|
|
2957
3220
|
parameters: {
|
|
2958
3221
|
query?: {
|
|
@@ -71,6 +71,8 @@ export type AllocateFloatingIpResult = operations["allocate-floating-ip"]["respo
|
|
|
71
71
|
export type AllocateFloatingIpBody = NonNullable<operations["allocate-floating-ip"]["requestBody"]>["content"]["application/json"];
|
|
72
72
|
/** The success response body of `GET /api/v1/floating-ips/{floatingIpId}`. */
|
|
73
73
|
export type GetFloatingIpResult = operations["get-floating-ip"]["responses"][200]["content"]["application/json"];
|
|
74
|
+
/** The success response body of `DELETE /api/v1/floating-ips/{floatingIpId}`. */
|
|
75
|
+
export type ReleaseFloatingIpResult = operations["release-floating-ip"]["responses"][202]["content"]["application/json"];
|
|
74
76
|
/** The success response body of `PUT /api/v1/floating-ips/{floatingIpId}/bandwidth`. */
|
|
75
77
|
export type SetFloatingIpBandwidthResult = operations["set-floating-ip-bandwidth"]["responses"][200]["content"]["application/json"];
|
|
76
78
|
/** The request body of `PUT /api/v1/floating-ips/{floatingIpId}/bandwidth`. */
|
|
@@ -334,7 +334,7 @@ export interface paths {
|
|
|
334
334
|
post?: never;
|
|
335
335
|
/**
|
|
336
336
|
* Release a floating IP
|
|
337
|
-
* @description
|
|
337
|
+
* @description Releases the floating IP after unbinding it. Completion is reported by the returned task.
|
|
338
338
|
*/
|
|
339
339
|
delete: operations["release-floating-ip"];
|
|
340
340
|
options?: never;
|
|
@@ -1337,11 +1337,6 @@ export interface components {
|
|
|
1337
1337
|
status: number;
|
|
1338
1338
|
};
|
|
1339
1339
|
BackupResource: {
|
|
1340
|
-
/**
|
|
1341
|
-
* Format: uuid
|
|
1342
|
-
* @description Availability zone of the source disk. A restore may target another zone in the same region
|
|
1343
|
-
*/
|
|
1344
|
-
availability_zone_id: string;
|
|
1345
1340
|
/** Format: date-time */
|
|
1346
1341
|
created_at: string;
|
|
1347
1342
|
/** Format: uuid */
|
|
@@ -1362,14 +1357,23 @@ export interface components {
|
|
|
1362
1357
|
/** @enum {string} */
|
|
1363
1358
|
status: "provisioning" | "available" | "restoring" | "deleting" | "error";
|
|
1364
1359
|
/** Format: uuid */
|
|
1365
|
-
order_id
|
|
1360
|
+
order_id: string | null;
|
|
1366
1361
|
/** Format: uuid */
|
|
1367
|
-
price_id
|
|
1362
|
+
price_id: string | null;
|
|
1368
1363
|
/** Format: uuid */
|
|
1369
|
-
subscription_item_id
|
|
1364
|
+
subscription_item_id: string | null;
|
|
1370
1365
|
/** @enum {string|null} */
|
|
1371
|
-
access_state
|
|
1372
|
-
task
|
|
1366
|
+
access_state: "pending" | "enabled" | "suspended" | "reclaimed" | null;
|
|
1367
|
+
task: components["schemas"]["Task"] | null;
|
|
1368
|
+
/** Format: int64 */
|
|
1369
|
+
generation: number;
|
|
1370
|
+
/** Format: date-time */
|
|
1371
|
+
observed_at: string | null;
|
|
1372
|
+
/**
|
|
1373
|
+
* Format: uuid
|
|
1374
|
+
* @description Availability zone of the source disk. A restore may target another zone in the same region
|
|
1375
|
+
*/
|
|
1376
|
+
source_availability_zone_id: string;
|
|
1373
1377
|
};
|
|
1374
1378
|
BackupListResponseBody: {
|
|
1375
1379
|
items: components["schemas"]["BackupResource"][] | null;
|
|
@@ -1432,27 +1436,20 @@ export interface components {
|
|
|
1432
1436
|
throughput_bytes_per_sec: number | null;
|
|
1433
1437
|
/** @enum {string} */
|
|
1434
1438
|
status: "provisioning" | "available" | "attaching" | "in_use" | "detaching" | "resizing" | "reverting" | "restoring" | "releasing" | "deleting" | "error";
|
|
1435
|
-
/**
|
|
1436
|
-
* @description How this disk is paid for. `postpaid` is billed by the hour for as long as it exists;
|
|
1437
|
-
* `prepaid` was bought outright for a term.
|
|
1438
|
-
*
|
|
1439
|
-
* **Not the term.** How long it was bought for belongs to the order, not to the disk:
|
|
1440
|
-
* renewing can change it, and a machine bought for a year and then renewed for a month is
|
|
1441
|
-
* still a prepaid machine. Ask billing for the term and the expiry — they live there, and
|
|
1442
|
-
* they are the only two values a renewal moves.
|
|
1443
|
-
* @enum {string}
|
|
1444
|
-
*/
|
|
1445
|
-
charge_type: "postpaid" | "prepaid";
|
|
1446
1439
|
/** Format: uuid */
|
|
1447
|
-
order_id
|
|
1440
|
+
order_id: string | null;
|
|
1448
1441
|
/** Format: uuid */
|
|
1449
|
-
price_id
|
|
1442
|
+
price_id: string | null;
|
|
1450
1443
|
/** Format: uuid */
|
|
1451
|
-
subscription_item_id
|
|
1444
|
+
subscription_item_id: string | null;
|
|
1452
1445
|
/** @enum {string|null} */
|
|
1453
|
-
access_state
|
|
1454
|
-
task
|
|
1446
|
+
access_state: "pending" | "enabled" | "suspended" | "reclaimed" | null;
|
|
1447
|
+
task: components["schemas"]["Task"] | null;
|
|
1455
1448
|
attachment?: components["schemas"]["DiskAttachment"] | null;
|
|
1449
|
+
/** Format: int64 */
|
|
1450
|
+
generation: number;
|
|
1451
|
+
/** Format: date-time */
|
|
1452
|
+
observed_at: string | null;
|
|
1456
1453
|
};
|
|
1457
1454
|
DiskTypeResource: {
|
|
1458
1455
|
/** Format: uuid */
|
|
@@ -1498,53 +1495,20 @@ export interface components {
|
|
|
1498
1495
|
* @description Throughput a disk of `max_size_gb` gets, in bytes per second. Null when this type is not rate-limited
|
|
1499
1496
|
*/
|
|
1500
1497
|
throughput_at_max_size: number | null;
|
|
1501
|
-
/**
|
|
1502
|
-
* @description Whether any capacity is left in this type's pool.
|
|
1503
|
-
*
|
|
1504
|
-
* The same shape as on an instance type, but it answers less here: a disk is sold by the
|
|
1505
|
-
* GiB, so "not sold out" does not mean the size being asked for fits. `remaining` is the
|
|
1506
|
-
* field that decides that, and this one only says whether the pool is empty outright.
|
|
1507
|
-
*
|
|
1508
|
-
* It reflects a limit set by operations, not what the storage backend physically has —
|
|
1509
|
-
* raising the limit does not create capacity, and a type that is not sold out can still fail
|
|
1510
|
-
* to create if the backend is full.
|
|
1511
|
-
*
|
|
1512
|
-
* Advisory: it is read when the list is built, and capacity can be taken between that read
|
|
1513
|
-
* and the order. The order is what actually refuses.
|
|
1514
|
-
*/
|
|
1515
|
-
sold_out: boolean;
|
|
1516
|
-
/**
|
|
1517
|
-
* Format: int64
|
|
1518
|
-
* @description How much capacity is left, **in GiB**. Absent when this type is not limited at all.
|
|
1519
|
-
*
|
|
1520
|
-
* Unlike an instance type, where this is a count of machines, here it is an amount of
|
|
1521
|
-
* storage — and it is the number that bounds the size a customer may ask for. A picker that
|
|
1522
|
-
* offers sizes above it produces orders that are refused after the customer has chosen
|
|
1523
|
-
* everything else.
|
|
1524
|
-
*
|
|
1525
|
-
* Absent is not zero and not "unknown": a type with no limit simply has no number to show.
|
|
1526
|
-
* Reporting it as a number would need a sentinel, and any sentinel eventually gets compared
|
|
1527
|
-
* against a real size.
|
|
1528
|
-
*/
|
|
1529
|
-
remaining?: number;
|
|
1530
|
-
/**
|
|
1531
|
-
* @description What buying this type outright costs, per term. Empty means this type is only sold by the
|
|
1532
|
-
* hour.
|
|
1533
|
-
*
|
|
1534
|
-
* **The amount is per GiB for the whole term**, not the price of one disk: a disk's size is
|
|
1535
|
-
* chosen by the customer, so the total is this figure times the size. That differs from an
|
|
1536
|
-
* instance type, where the same field is the price of one machine — the unit follows what
|
|
1537
|
-
* the product is sold by, and the order is priced the same way.
|
|
1538
|
-
*
|
|
1539
|
-
* Advisory, like `sold_out`: it is read when the list is built. The order is what fixes the
|
|
1540
|
-
* price, and it refuses rather than falling back to hourly if the term is not sold.
|
|
1541
|
-
*/
|
|
1542
|
-
prepaid_prices?: components["schemas"]["PrepaidPrice"][];
|
|
1543
1498
|
/** Format: uuid */
|
|
1544
|
-
product_id
|
|
1499
|
+
product_id: string | null;
|
|
1545
1500
|
/** Format: uuid */
|
|
1546
|
-
plan_id
|
|
1547
|
-
lookup_key
|
|
1501
|
+
plan_id: string | null;
|
|
1502
|
+
lookup_key: string;
|
|
1503
|
+
name_translations: {
|
|
1504
|
+
[key: string]: string;
|
|
1505
|
+
};
|
|
1506
|
+
/** Format: uuid */
|
|
1507
|
+
snapshot_plan_id: string | null;
|
|
1508
|
+
/** Format: uuid */
|
|
1509
|
+
backup_plan_id: string | null;
|
|
1510
|
+
/** Format: uuid */
|
|
1511
|
+
private_image_plan_id: string | null;
|
|
1548
1512
|
};
|
|
1549
1513
|
DiskTypeListResponseBody: {
|
|
1550
1514
|
items: components["schemas"]["DiskTypeResource"][] | null;
|
|
@@ -1577,19 +1541,6 @@ export interface components {
|
|
|
1577
1541
|
/** Format: int64 */
|
|
1578
1542
|
total_count?: number;
|
|
1579
1543
|
};
|
|
1580
|
-
PrepaidPrice: {
|
|
1581
|
-
/**
|
|
1582
|
-
* @description An ISO 8601 duration (P1M, P1Y). A duration rather than a number of months: months are not
|
|
1583
|
-
* the same length, and storing a number leaves whoever reads it to decide what it means.
|
|
1584
|
-
*/
|
|
1585
|
-
term: string;
|
|
1586
|
-
/**
|
|
1587
|
-
* @description A decimal string, not a float. Money that survives a round trip through binary floating
|
|
1588
|
-
* point is money that stops adding up.
|
|
1589
|
-
*/
|
|
1590
|
-
amount: string;
|
|
1591
|
-
currency: string;
|
|
1592
|
-
};
|
|
1593
1544
|
InstanceTypeResource: {
|
|
1594
1545
|
/** Format: uuid */
|
|
1595
1546
|
availability_zone_id: string;
|
|
@@ -1630,10 +1581,13 @@ export interface components {
|
|
|
1630
1581
|
/** Format: int64 */
|
|
1631
1582
|
vcpus: number;
|
|
1632
1583
|
/** Format: uuid */
|
|
1633
|
-
product_id
|
|
1584
|
+
product_id: string | null;
|
|
1634
1585
|
/** Format: uuid */
|
|
1635
1586
|
plan_id: string | null;
|
|
1636
|
-
lookup_key
|
|
1587
|
+
lookup_key: string;
|
|
1588
|
+
name_translations: {
|
|
1589
|
+
[key: string]: string;
|
|
1590
|
+
};
|
|
1637
1591
|
};
|
|
1638
1592
|
InstanceTypeListResponseBody: {
|
|
1639
1593
|
items: components["schemas"]["InstanceTypeResource"][];
|
|
@@ -1704,14 +1658,10 @@ export interface components {
|
|
|
1704
1658
|
};
|
|
1705
1659
|
FloatingIPResource: {
|
|
1706
1660
|
address: string;
|
|
1707
|
-
attached_fixed_ip: string | null;
|
|
1708
|
-
attached_port_id: string | null;
|
|
1709
1661
|
/** Format: int64 */
|
|
1710
1662
|
bandwidth_mbps: number | null;
|
|
1711
1663
|
/** Format: date-time */
|
|
1712
1664
|
created_at: string;
|
|
1713
|
-
/** Format: date-time */
|
|
1714
|
-
detached_at: string | null;
|
|
1715
1665
|
/** Format: uuid */
|
|
1716
1666
|
id: string;
|
|
1717
1667
|
/** Format: uuid */
|
|
@@ -1719,22 +1669,27 @@ export interface components {
|
|
|
1719
1669
|
/** @enum {string} */
|
|
1720
1670
|
status: "pending" | "available" | "deleting" | "error" | "unknown";
|
|
1721
1671
|
/** Format: uuid */
|
|
1722
|
-
order_id
|
|
1672
|
+
order_id: string | null;
|
|
1723
1673
|
/** Format: uuid */
|
|
1724
|
-
price_id
|
|
1674
|
+
price_id: string | null;
|
|
1725
1675
|
/** Format: uuid */
|
|
1726
|
-
subscription_item_id
|
|
1676
|
+
subscription_item_id: string | null;
|
|
1727
1677
|
/** @enum {string|null} */
|
|
1728
|
-
access_state
|
|
1729
|
-
task
|
|
1678
|
+
access_state: "pending" | "enabled" | "suspended" | "reclaimed" | null;
|
|
1679
|
+
task: components["schemas"]["Task"] | null;
|
|
1730
1680
|
/** Format: uuid */
|
|
1731
|
-
bandwidth_order_id
|
|
1681
|
+
bandwidth_order_id: string | null;
|
|
1732
1682
|
/** Format: uuid */
|
|
1733
|
-
bandwidth_price_id
|
|
1683
|
+
bandwidth_price_id: string | null;
|
|
1734
1684
|
/** Format: uuid */
|
|
1735
|
-
bandwidth_subscription_item_id
|
|
1685
|
+
bandwidth_subscription_item_id: string | null;
|
|
1736
1686
|
/** @enum {string|null} */
|
|
1737
|
-
bandwidth_access_state
|
|
1687
|
+
bandwidth_access_state: "pending" | "enabled" | "suspended" | "reclaimed" | null;
|
|
1688
|
+
/** Format: int64 */
|
|
1689
|
+
generation: number;
|
|
1690
|
+
/** Format: date-time */
|
|
1691
|
+
observed_at: string | null;
|
|
1692
|
+
binding: components["schemas"]["IPv4Binding"] | null;
|
|
1738
1693
|
};
|
|
1739
1694
|
FloatingIPListResponseBody: {
|
|
1740
1695
|
items: components["schemas"]["FloatingIPResource"][] | null;
|
|
@@ -1812,7 +1767,7 @@ export interface components {
|
|
|
1812
1767
|
private_image_id: string | null;
|
|
1813
1768
|
/** @description Private address of the instance */
|
|
1814
1769
|
private_ip: string | null;
|
|
1815
|
-
/**
|
|
1770
|
+
/** Format: uuid */
|
|
1816
1771
|
private_network_id: string | null;
|
|
1817
1772
|
/** @description Floating IPv4 addresses bound to the primary network interface; an empty array when none are bound */
|
|
1818
1773
|
public_ips: string[] | null;
|
|
@@ -1820,7 +1775,7 @@ export interface components {
|
|
|
1820
1775
|
region_id: string;
|
|
1821
1776
|
/** @enum {string} */
|
|
1822
1777
|
status: "pending" | "building" | "active" | "stopped" | "paused" | "suspended" | "shelved" | "shelved_offloaded" | "rescued" | "resized" | "deleting" | "deleted" | "error" | "unknown";
|
|
1823
|
-
/**
|
|
1778
|
+
/** Format: uuid */
|
|
1824
1779
|
subnet_id: string | null;
|
|
1825
1780
|
/** Format: date-time */
|
|
1826
1781
|
updated_at: string;
|
|
@@ -1832,21 +1787,18 @@ export interface components {
|
|
|
1832
1787
|
task_state: string;
|
|
1833
1788
|
/** Format: int64 */
|
|
1834
1789
|
generation: number;
|
|
1835
|
-
/**
|
|
1836
|
-
|
|
1837
|
-
* @description Timestamp of the last successful provider observation. An unreachable provider does not erase the last observation or prove deletion.
|
|
1838
|
-
*/
|
|
1839
|
-
observed_at?: string;
|
|
1790
|
+
/** Format: date-time */
|
|
1791
|
+
observed_at: string | null;
|
|
1840
1792
|
restrictions: components["schemas"]["InstanceRestriction"][];
|
|
1841
|
-
task
|
|
1793
|
+
task: components["schemas"]["Task"] | null;
|
|
1842
1794
|
/** Format: uuid */
|
|
1843
1795
|
order_id: string | null;
|
|
1844
1796
|
/** Format: uuid */
|
|
1845
|
-
price_id
|
|
1797
|
+
price_id: string | null;
|
|
1846
1798
|
/** Format: uuid */
|
|
1847
|
-
subscription_item_id
|
|
1799
|
+
subscription_item_id: string | null;
|
|
1848
1800
|
/** @enum {string|null} */
|
|
1849
|
-
access_state
|
|
1801
|
+
access_state: "pending" | "enabled" | "suspended" | "reclaimed" | null;
|
|
1850
1802
|
/**
|
|
1851
1803
|
* Format: uuid
|
|
1852
1804
|
* @description Non-empty when the instance was created from a disk you already had, instead of from an image
|
|
@@ -2032,6 +1984,12 @@ export interface components {
|
|
|
2032
1984
|
public_ips: string[] | null;
|
|
2033
1985
|
addresses?: components["schemas"]["PortAddress"][];
|
|
2034
1986
|
attachment?: components["schemas"]["PortAttachment"] | null;
|
|
1987
|
+
/** @enum {string} */
|
|
1988
|
+
status: "pending" | "available" | "deleting" | "error" | "unknown";
|
|
1989
|
+
/** Format: int64 */
|
|
1990
|
+
generation: number;
|
|
1991
|
+
/** Format: date-time */
|
|
1992
|
+
observed_at: string | null;
|
|
2035
1993
|
};
|
|
2036
1994
|
PortListResponseBody: {
|
|
2037
1995
|
items: components["schemas"]["PortResource"][] | null;
|
|
@@ -2128,14 +2086,18 @@ export interface components {
|
|
|
2128
2086
|
/** @description False means a new password can only be set by rebuilding an instance created from this image */
|
|
2129
2087
|
supports_password_reset: boolean;
|
|
2130
2088
|
/** Format: uuid */
|
|
2131
|
-
order_id
|
|
2089
|
+
order_id: string | null;
|
|
2132
2090
|
/** Format: uuid */
|
|
2133
|
-
price_id
|
|
2091
|
+
price_id: string | null;
|
|
2134
2092
|
/** Format: uuid */
|
|
2135
|
-
subscription_item_id
|
|
2093
|
+
subscription_item_id: string | null;
|
|
2136
2094
|
/** @enum {string|null} */
|
|
2137
|
-
access_state
|
|
2138
|
-
task
|
|
2095
|
+
access_state: "pending" | "enabled" | "suspended" | "reclaimed" | null;
|
|
2096
|
+
task: components["schemas"]["Task"] | null;
|
|
2097
|
+
/** Format: int64 */
|
|
2098
|
+
generation: number;
|
|
2099
|
+
/** Format: date-time */
|
|
2100
|
+
observed_at: string | null;
|
|
2139
2101
|
};
|
|
2140
2102
|
PrivateImageListResponseBody: {
|
|
2141
2103
|
items: components["schemas"]["PrivateImageResource"][];
|
|
@@ -2333,14 +2295,18 @@ export interface components {
|
|
|
2333
2295
|
/** @enum {string} */
|
|
2334
2296
|
status: "provisioning" | "available" | "restoring" | "deleting" | "error";
|
|
2335
2297
|
/** Format: uuid */
|
|
2336
|
-
order_id
|
|
2298
|
+
order_id: string | null;
|
|
2337
2299
|
/** Format: uuid */
|
|
2338
|
-
price_id
|
|
2300
|
+
price_id: string | null;
|
|
2339
2301
|
/** Format: uuid */
|
|
2340
|
-
subscription_item_id
|
|
2302
|
+
subscription_item_id: string | null;
|
|
2341
2303
|
/** @enum {string|null} */
|
|
2342
|
-
access_state
|
|
2343
|
-
task
|
|
2304
|
+
access_state: "pending" | "enabled" | "suspended" | "reclaimed" | null;
|
|
2305
|
+
task: components["schemas"]["Task"] | null;
|
|
2306
|
+
/** Format: int64 */
|
|
2307
|
+
generation: number;
|
|
2308
|
+
/** Format: date-time */
|
|
2309
|
+
observed_at: string | null;
|
|
2344
2310
|
};
|
|
2345
2311
|
SnapshotListResponseBody: {
|
|
2346
2312
|
items: components["schemas"]["SnapshotResource"][] | null;
|
|
@@ -2473,6 +2439,7 @@ export interface components {
|
|
|
2473
2439
|
detached_at: string | null;
|
|
2474
2440
|
/** Format: date-time */
|
|
2475
2441
|
released_at: string | null;
|
|
2442
|
+
device: string | null;
|
|
2476
2443
|
};
|
|
2477
2444
|
DiskAttachmentList: {
|
|
2478
2445
|
items: components["schemas"]["DiskAttachment"][];
|
|
@@ -2537,6 +2504,24 @@ export interface components {
|
|
|
2537
2504
|
/** Format: int64 */
|
|
2538
2505
|
total_count?: number;
|
|
2539
2506
|
};
|
|
2507
|
+
IPv4Binding: {
|
|
2508
|
+
/** Format: uuid */
|
|
2509
|
+
id: string;
|
|
2510
|
+
/** Format: uuid */
|
|
2511
|
+
ipv4_allocation_id: string;
|
|
2512
|
+
/** Format: uuid */
|
|
2513
|
+
port_address_id: string;
|
|
2514
|
+
address: string;
|
|
2515
|
+
fixed_ip: string;
|
|
2516
|
+
/** @enum {string} */
|
|
2517
|
+
state: "binding" | "bound" | "unbinding" | "released" | "unknown";
|
|
2518
|
+
/** Format: date-time */
|
|
2519
|
+
bound_at: string | null;
|
|
2520
|
+
/** Format: date-time */
|
|
2521
|
+
unbound_at: string | null;
|
|
2522
|
+
/** Format: date-time */
|
|
2523
|
+
released_at: string | null;
|
|
2524
|
+
};
|
|
2540
2525
|
/** @description Requested funding split. This does not select a card or payment provider; complete payment through Billing. */
|
|
2541
2526
|
PaymentPlan: {
|
|
2542
2527
|
balance_amount: string;
|
|
@@ -3318,12 +3303,14 @@ export interface operations {
|
|
|
3318
3303
|
};
|
|
3319
3304
|
requestBody?: never;
|
|
3320
3305
|
responses: {
|
|
3321
|
-
/** @description
|
|
3322
|
-
|
|
3306
|
+
/** @description The release has been accepted. */
|
|
3307
|
+
202: {
|
|
3323
3308
|
headers: {
|
|
3324
3309
|
[name: string]: unknown;
|
|
3325
3310
|
};
|
|
3326
|
-
content
|
|
3311
|
+
content: {
|
|
3312
|
+
"application/json": components["schemas"]["Task"];
|
|
3313
|
+
};
|
|
3327
3314
|
};
|
|
3328
3315
|
/** @description Error */
|
|
3329
3316
|
default: {
|
package/dist/iam/v1/schema.d.ts
CHANGED
|
@@ -435,6 +435,12 @@ export interface components {
|
|
|
435
435
|
rules: components["schemas"]["RuleResource"][] | null;
|
|
436
436
|
};
|
|
437
437
|
ProjectResource: {
|
|
438
|
+
/**
|
|
439
|
+
* Format: date-time
|
|
440
|
+
* @description A read-only management lock. Running resources and billing remain unchanged. Only an operator can release it.
|
|
441
|
+
*/
|
|
442
|
+
locked_at: string | null;
|
|
443
|
+
lock_reason: string;
|
|
438
444
|
ban_reason: string;
|
|
439
445
|
/** Format: date-time */
|
|
440
446
|
created_at: string;
|