@leaflow/sdk 0.0.0-dev.42.g9fdf74a → 0.0.0-dev.422.gef294af

package/dist/compute/v2/generated/models.d.ts

@@ -0,0 +1,3446 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Compute API
+ * Leaflow Compute user API for managing instances, volumes, snapshots, volume backups, public and private images, virtual private clouds, subnets, routes, security groups, network interfaces and elastic IPs.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `scopedTokenAuth` security scheme. The catalog reads, which list and retrieve regions, availability zones, instance types, volume types, public images and elastic IP lines, also answer without a token, so a visitor can configure a purchase and price it with Billing before signing in. A token given to them is still verified, and an invalid one is refused.
+ *
+ * ## Conventions
+ *
+ * - **Purchases.** A purchase that creates resources returns them together with the `checkout_session_id` of its Billing Checkout Session and, once checkout completes, its `order_id`. They are readable at once and start as `pending`: checkout may not be complete, the order has not been accepted, nothing exists in the cloud, no inventory such as an address is held, and fields known only after allocation, such as addresses, are null. Once Billing accepts the order, the resource is created: it stays `pending`, then reaches its usual status, such as `running` or `available`. When the Checkout Session expires, the order is declined, canceled or expires, or creation fails, the resource ends `failed` and `failure_reason` states why; the charge for a resource that failed after acceptance is refunded. A purchased change, such as a resize requested with `instance_type_id`, `size_gib` or `bandwidth_mbps` on the resource, returns the resource unchanged with the Checkout Session for the change, and applies once its order is accepted.
+ * - **Commercial terms.** Compute catalogs describe technical specifications and, for each order line a purchase makes, how it is sold in Billing (a `BillingComponent`: its Plan, dimensions, what its quantity counts and what its meters read); prices, amounts and currency belong to Billing. A purchase chooses its terms with `billing`, and Billing selects the matching price. Read prices and their rates with Billing's `search-prices` from those components, quote a proposed purchase with `get-quote`, and a change of a resource by its `subscription_id`; Compute has no quote or price proxy endpoint and returns no amounts.
+ * - **Checkout.** `checkout` is passed to Billing unchanged. Omit it for automatic checkout, which completes checkout within the request and pays from eligible credit grants and balance; insufficient funds refuse the request with HTTP 422 `BILLING_INSUFFICIENT_FUNDS`, and nothing is created. With `checkout.mode` set to `deferred`, the resources are returned `pending` with an open Checkout Session and no order, even for a zero total; nothing is created until the customer completes checkout in Billing, where a promotion code can be applied, and the order is paid. Do not submit the purchase again after paying; after an uncertain response, look the Checkout Session up in Billing first.
+ * - **Quotas.** A creation, purchase or resize that adds to what a project holds in a region is checked against the project's quota there before anything is ordered or created, and is refused with HTTP 409 `COMPUTE_PROJECT_QUOTA_EXCEEDED`, whose `meta` names the `resource`, its `limit`, the amount `used` and the amount `requested`. An instance purchase counts the volumes, the new primary network interface and the new elastic IP bought with each instance. Read the limits with `list-quotas`; a limit no operator set is the platform default.
+ * - **Projects.** Resource ownership and project identifiers refer to IAM platform projects, not OpenStack tenants. Instances, images and networks share one infrastructure OpenStack project; the platform project remains the authorization and ownership boundary.
+ * - **Custom methods.** An action that is not one of the standard methods (list, get, create, update, delete) is a custom method, `POST` on the resource's path followed by `:` and the verb, as in `POST /api/v2/instances/{id}:reboot` (AIP-136). A state is changed by its custom method, never by writing the state: `:start` and `:stop`, `:rescue` and `:unrescue`, `:associate` and `:disassociate`.
+ * - **Operations.** Requests such as `:start`, attaching or deleting return HTTP 202 with the resource as it is when the request is accepted. While an operation runs, the resource's `status` names it, as in `starting` or `deleting`; once it has finished the resource shows its new status and the result. A resource with an operation in progress refuses another operation with HTTP 409 `COMPUTE_RESOURCE_BUSY`; an operation involving two resources, such as attaching a volume, is refused when either has one. A purchased change, such as a resize, is an operation from the moment its Checkout Session is created until the change is applied, the session expires or its order is canceled. Renaming and replacing labels or notes are not operations and are accepted at any time. **Updating.** A `PATCH` carries only mutable fields, all optional and at least one given, and answers 200 when only descriptive fields changed and 202 when an operation started. An operational field (`instance_type_id`, `size_gib`, `bandwidth_mbps`) cannot be combined with any other field in the same request: it is refused with 422 `UPDATE_FIELDS_COMBINED`, because a rename that committed beside a change that was then refused would leave the request half applied.
+ * - **Billing relationships.** A purchased resource records its `checkout_session_id` and, once checkout completes, its `order_id`, `order_item_id` and `subscription_id`. Its `access_state` is `pending` until the order is accepted and delivery settles it, then `enabled`; a subscription that lapses suspends or reclaims the resource it pays for. Deleting a resource that subscriptions pay for cancels the subscriptions of its `release_set` in Billing, and the deletion answers with that cancellation.
+ * - **Availability zones.** A volume and an instance must reside in the same availability zone to be attached. An instance type and a volume type each belong to one availability zone, as on GCP, so a purchase names the type and the type names the zone; the volumes bought with an instance have to be of types of the instance type's zone.
+ * - **IPv6 is routed, not translated.** A virtual private cloud with IPv6 holds a /56 and each of its subnets a /64 of it, as on Alibaba Cloud, Tencent Cloud and Azure; IPv6 and its security groups require no EIP or NAT gateway. EIP and NATGateway are IPv4 products; IPv6 EIP, NAT66 and IPv6 port forwarding are not supported.
+ * - **Elastic IP release.** A released address returns to available inventory as soon as its cleanup is confirmed, with no cooldown period. Removing or replacing an elastic IP's association keeps the address held by the project and does not release it.
+ * - **Passwords are returned once.** A password generated by the platform during creation or rebuild appears only in that response. Store it immediately.
+ *
+ * ## Resource identifiers
+ *
+ * Compute resource IDs use the fixed TypeID prefix declared in their schema. UUID text is not accepted for these resource IDs. Project, order, subscription and Billing Plan identifiers remain UUIDs. Historical operation-log subject IDs are audit facts and are not rewritten.
+ *
+ * ## Error meta
+ *
+ * Resource identifiers in an error's `meta` (`resource_id`, `volume_id`, `network_interface_id` and the like) are TypeIDs, in the same form as the identifiers in resources. `meta.resource_type` is the resource's name as written in paths, with underscores: `instance`, `volume`, `elastic_ip`, `network_interface`, `virtual_private_cloud`, `private_image`, `volume_backup`, and so on.
+ * OpenAPI spec version: 2.0.0
+ */
+/**
+ * Compute AvailabilityZone TypeID. UUID text is not accepted.
+ * @minLength 31
+ * @maxLength 31
+ * @pattern ^zone_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25}$
+ */
+export type AvailabilityZoneID = string;
+/**
+ * Compute Region TypeID. UUID text is not accepted.
+ * @minLength 33
+ * @maxLength 33
+ * @pattern ^region_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25}$
+ */
+export type RegionID = string;
+export interface AvailabilityZoneResource {
+    /** Display name for this zone, shown to tenants (Hong Kong A). The stable handle is code. */
+    name: string;
+    /** The zone's code within its region (hk-1-a). Stable and human-written; addressing is by id. */
+    code: string;
+    id: AvailabilityZoneID;
+    region_id: RegionID;
+}
+/**
+ * Pagination metadata for stable numbered pages. total_count is returned only when the operation can determine it without an unbounded scan.
+ */
+export interface OffsetPagination {
+    /** @minimum 1 */
+    page: number;
+    /** @minimum 1 */
+    page_size: number;
+    /** @minimum 0 */
+    total_count?: number;
+}
+export interface AvailabilityZoneListResponseBody {
+    /** @nullable */
+    items: AvailabilityZoneResource[] | null;
+    pagination: OffsetPagination;
+}
+export type BillingPeriodUnit = (typeof BillingPeriodUnit)[keyof typeof BillingPeriodUnit];
+export declare const BillingPeriodUnit: {
+    readonly month: "month";
+    readonly year: "year";
+};
+export interface BillingPeriod {
+    unit: BillingPeriodUnit;
+    /**
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    count: number;
+}
+/**
+ * `licensed` pays for a period in advance; `metered` bills usage until canceled.
+ */
+export type BillingChoiceUsageType = (typeof BillingChoiceUsageType)[keyof typeof BillingChoiceUsageType];
+export declare const BillingChoiceUsageType: {
+    readonly licensed: "licensed";
+    readonly metered: "metered";
+};
+/**
+ * Immediate ends service when cancellation takes effect, with refunds governed by the purchased terms. Period-end keeps service until the paid period ends.
+ */
+export type TerminationPolicy = (typeof TerminationPolicy)[keyof typeof TerminationPolicy];
+export declare const TerminationPolicy: {
+    readonly immediate: "immediate";
+    readonly period_end: "period_end";
+};
+/**
+ * The commercial terms for one newly purchased component. Licensed requires period and termination_policy; metered refuses both. Components in one instance purchase must use the same usage type and period, while their termination policies may differ.
+ */
+export interface BillingChoice {
+    /** `licensed` pays for a period in advance; `metered` bills usage until canceled. */
+    usage_type: BillingChoiceUsageType;
+    period?: BillingPeriod;
+    termination_policy?: TerminationPolicy;
+}
+/**
+ * automatic completes checkout with the purchase: the best applicable account discount is applied, and the
+ * order is created with its invoice issued and paid from eligible credit grants and available balance.
+ * Insufficient funds fail the purchase with HTTP 422 BILLING_INSUFFICIENT_FUNDS; no Billing order, charge or
+ * discount redemption is committed.
+ * deferred creates an open Billing Checkout Session and charges nothing, even for a zero total. The customer
+ * completes it through Billing, where a promotion code can be applied, and then pays the issued invoice; a
+ * session not completed by its deadline expires.
+ */
+export type CheckoutMode = (typeof CheckoutMode)[keyof typeof CheckoutMode];
+export declare const CheckoutMode: {
+    readonly automatic: "automatic";
+    readonly deferred: "deferred";
+};
+/**
+ * A decimal string, in the currency stated alongside it.
+ *
+ * **The currency is not part of this type.** It is carried by a `currency` field next to the
+ * amount, or by the account the amount belongs to. Reading an amount without that field is
+ * reading a number with no unit.
+ *
+ * It is a string rather than a JSON number because a JSON number is a float in most parsers,
+ * and a float loses precision on the first arithmetic. Nothing on this platform puts an amount
+ * through a float.
+ */
+export type Money = string;
+/**
+ * Shared checkout choices for a product purchase. The service may set them or forward its client's
+ * choices unchanged; it does not need to read them, and Billing validates them. Omitting this object or
+ * mode selects automatic checkout. Each purchase creates its own Checkout Session. Promotion codes are supplied
+ * only to Billing. A service may retain a failed creation record when Billing refuses a purchase; no
+ * infrastructure is created for that refusal.
+ */
+export interface CheckoutOptions {
+    mode?: CheckoutMode;
+    /**
+     * Expected invoice total after discounts and tax, before applying credit grants or balance.
+     * A different total fails with BILLING_AMOUNT_CHANGED without charging or reserving a discount.
+     * Accepted only in automatic mode; with deferred it is refused with HTTP 400. For deferred
+     * checkout, give the expected amount when completing it through Billing.
+     */
+    expected_amount?: Money & string;
+    /**
+     * Where the client goes after the customer finishes a deferred checkout. Any absolute URI with a
+     * scheme, including mobile and desktop application schemes. Billing stores it without checking the
+     * target; each client validates its own.
+     * @maxLength 2048
+     */
+    return_url?: string;
+}
+/**
+ * The line's dimensions, the coordinates Billing prices it at; every meter of the line reads under the same ones, and under its own `resource_dimensions` as well. Pass them to Billing unchanged; they name nothing a client needs to read.
+ */
+export type BillingComponentDimensions = {
+    [key: string]: string;
+};
+/**
+ * `one` is 1 for each item bought; `size_gib` is the volume's size in GiB; `bandwidth_mbps` is the elastic IP's bandwidth in Mbps.
+ */
+export type BillingLineQuantity = (typeof BillingLineQuantity)[keyof typeof BillingLineQuantity];
+export declare const BillingLineQuantity: {
+    readonly one: "one";
+    readonly size_gib: "size_gib";
+    readonly bandwidth_mbps: "bandwidth_mbps";
+};
+/**
+ * What the line's quantity counts under each usage type it is sold on; a usage type it is not sold on is absent.
+ */
+export interface BillingQuantity {
+    licensed?: BillingLineQuantity;
+    metered?: BillingLineQuantity;
+}
+/**
+ * What the meter measures. `one` counts each second the item is metered; `size_gib` the volume's size in GiB each second; `stored_gib` the GiB stored each second; `bandwidth_mbps` the bandwidth in Mbps each second; `egress_bytes` the bytes sent.
+ */
+export type BillingMeterQuantity = (typeof BillingMeterQuantity)[keyof typeof BillingMeterQuantity];
+export declare const BillingMeterQuantity: {
+    readonly one: "one";
+    readonly size_gib: "size_gib";
+    readonly stored_gib: "stored_gib";
+    readonly bandwidth_mbps: "bandwidth_mbps";
+    readonly egress_bytes: "egress_bytes";
+};
+/**
+ * One meter a metered line reads.
+ */
+export interface BillingMeter {
+    meter_lookup_key: string;
+    /** What the meter measures. `one` counts each second the item is metered; `size_gib` the volume's size in GiB each second; `stored_gib` the GiB stored each second; `bandwidth_mbps` the bandwidth in Mbps each second; `egress_bytes` the bytes sent. */
+    quantity: BillingMeterQuantity;
+    /** Dimensions each reading carries beside the line's own, whose values the resource itself states and which can change while it is held. A private image's meter carries `position`, its `billing_position`; for a capture not made yet, the position it will take is one more than the number of the project's private images in the region whose `billing_position` is set and not `legacy`. Give them together with the line's dimensions when estimating usage. Empty for every other meter. */
+    resource_dimensions: string[];
+}
+/**
+ * How one order line of a catalog item is sold in Billing. Read its prices with Billing's `search-prices` by `plan_id`, giving `dimensions` to narrow each price's `rates` to this line. Quote a purchase with Billing's `get-quote`, giving the line `plan_id`, `dimensions` unchanged, and the quantity `quantity` names for the usage type chosen; estimate a metered line with `estimate-usage`, giving each of `meters` the same dimensions and the quantity it names. Prices and amounts are Billing's alone.
+ */
+export interface BillingComponent {
+    /** The Billing Plan the line is sold under. */
+    plan_id: string;
+    /** The line's dimensions, the coordinates Billing prices it at; every meter of the line reads under the same ones, and under its own `resource_dimensions` as well. Pass them to Billing unchanged; they name nothing a client needs to read. */
+    dimensions: BillingComponentDimensions;
+    quantity: BillingQuantity;
+    /** What a metered price of the line reads; empty when the line is never metered. */
+    meters: BillingMeter[];
+}
+/**
+ * When subscriptions end. immediate ends them now and refunds the unused value under their refund terms; period_end
+ * ends them at the end of their paid period. The cancellation terms fixed when a subscription was bought decide which
+ * modes it allows: a pay-as-you-go subscription ends only immediately, and a prepaid one whose terms allow only the
+ * end of its paid period ends only then. Billing refuses a mode the terms do not allow with HTTP 422
+ * BILLING_CANCELLATION_MODE_FIXED.
+ */
+export type CancellationMode = (typeof CancellationMode)[keyof typeof CancellationMode];
+export declare const CancellationMode: {
+    readonly immediate: "immediate";
+    readonly period_end: "period_end";
+};
+/**
+ * A Billing cancellation that Compute created to release a resource and the subscriptions in its release set. Billing owns it; read its progress and any refund there by `id`.
+ */
+export interface BillingCancellation {
+    id: string;
+    mode: CancellationMode;
+    /**
+     * When the subscriptions end and the resources are released; null while Billing has not fixed it.
+     * @nullable
+     */
+    scheduled_at: string | null;
+}
+/**
+ * `on_sale` is offered for new elastic IPs; `off_sale` takes none, while the elastic IPs already on it keep working.
+ */
+export type ElasticIPLineSaleStatus = (typeof ElasticIPLineSaleStatus)[keyof typeof ElasticIPLineSaleStatus];
+export declare const ElasticIPLineSaleStatus: {
+    readonly on_sale: "on_sale";
+    readonly off_sale: "off_sale";
+};
+/**
+ * Whether an elastic IP of this line can be bought with `internet_charge_type` `traffic`, billed by the bytes it sends. `off_sale` refuses that with `ELASTIC_IP_TRAFFIC_UNAVAILABLE`.
+ */
+export type ElasticIPLineTrafficSaleStatus = (typeof ElasticIPLineTrafficSaleStatus)[keyof typeof ElasticIPLineTrafficSaleStatus];
+export declare const ElasticIPLineTrafficSaleStatus: {
+    readonly on_sale: "on_sale";
+    readonly off_sale: "off_sale";
+};
+/**
+ * Compute ElasticIPLine TypeID. UUID text is not accepted.
+ * @minLength 34
+ * @maxLength 34
+ * @pattern ^eipline_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25}$
+ */
+export type ElasticIPLineID = string;
+/**
+ * The network an elastic IP is bought on: the bandwidth that can be chosen, and the two Billing Plans every elastic IP of the line is paid under in one order. The address subscription is always used and meters the address while it is held idle, associated with nothing; the network subscription pays the bandwidth, prepaid or used while associated, or the traffic sent. Contains no supply ranges, gateways or backend execution state.
+ */
+export interface ElasticIPLine {
+    id: ElasticIPLineID;
+    region_id: RegionID;
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name: string;
+    /**
+     * @minLength 0
+     * @maxLength 255
+     */
+    description: string;
+    /** The address line every elastic IP of this line has. It is always metered, and meters the address while no network interface holds it. */
+    address_billing: BillingComponent;
+    /** The network line every elastic IP of this line has, which pays its bandwidth, prepaid or used while associated, or its traffic. Metered, the line's quantity is 1 and the bandwidth or the traffic is what its meters read, by the elastic IP's `internet_charge_type`. */
+    internet_billing: BillingComponent;
+    /** The least bandwidth an elastic IP of this line can be bought with, in Mbps. */
+    min_bandwidth_mbps: number;
+    /** The most bandwidth an elastic IP of this line can be bought with, in Mbps, at most 1000. An elastic IP associated with an instance is also held to the instance type's `max_bandwidth_mbps`. */
+    max_bandwidth_mbps: number;
+    /** `on_sale` is offered for new elastic IPs; `off_sale` takes none, while the elastic IPs already on it keep working. */
+    sale_status: ElasticIPLineSaleStatus;
+    /** Whether an elastic IP of this line can be bought with `internet_charge_type` `traffic`, billed by the bytes it sends. `off_sale` refuses that with `ELASTIC_IP_TRAFFIC_UNAVAILABLE`. */
+    traffic_sale_status: ElasticIPLineTrafficSaleStatus;
+    created_at: string;
+    updated_at: string;
+}
+export interface ElasticIPLineListResponseBody {
+    items: ElasticIPLine[];
+    pagination: OffsetPagination;
+}
+/**
+ * What the network subscription of an elastic IP charges for. `bandwidth` charges for the bandwidth ceiling, prepaid for a period or by the Mbit/s-second while the address is associated. `traffic` charges for the bytes the address sends upstream, pay-as-you-go only, while the bandwidth is only a ceiling; it is refused with `ELASTIC_IP_TRAFFIC_UNAVAILABLE` on a line whose `traffic_sale_status` is `off_sale`. Inbound traffic is never charged. Prices are set per currency, so a pay-as-you-go purchase whose account currency has no rate on the line for the chosen type is refused before any order with HTTP 403 `ELASTIC_IP_CHARGE_TYPE_NOT_OFFERED`, whether the elastic IP is bought alone or with an instance. A pay-as-you-go elastic IP can move between the two with `update-elastic-ip`.
+ */
+export type InternetChargeType = (typeof InternetChargeType)[keyof typeof InternetChargeType];
+export declare const InternetChargeType: {
+    readonly bandwidth: "bandwidth";
+    readonly traffic: "traffic";
+};
+/**
+ * @minLength 7
+ * @maxLength 15
+ * @pattern ^(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])(?:\.(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])){3}$
+ */
+export type IPv4HostAddress = string;
+/**
+ * The public eip resource identifier. Only this fixed TypeID prefix is accepted; UUID text is not an alternative representation.
+ * @minLength 30
+ * @maxLength 34
+ * @pattern ^eip_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25}$
+ */
+export type ElasticIPID = string;
+/**
+ * `pending` until the address is created, with no address allocated before the order is accepted; then `available`. `failed` means no address was allocated; `failure_reason` states why. A value naming an operation in progress (`associating`, `disassociating`, `updating_bandwidth`, `updating_internet_charge_type`, `suspending`, `resuming`, `deleting`) is shown while that operation runs; the elastic IP refuses another operation until it ends.
+ */
+export type ElasticIPStatus = (typeof ElasticIPStatus)[keyof typeof ElasticIPStatus];
+export declare const ElasticIPStatus: {
+    readonly pending: "pending";
+    readonly available: "available";
+    readonly deleted: "deleted";
+    readonly failed: "failed";
+    readonly error: "error";
+    readonly associating: "associating";
+    readonly disassociating: "disassociating";
+    readonly updating_bandwidth: "updating_bandwidth";
+    readonly updating_internet_charge_type: "updating_internet_charge_type";
+    readonly suspending: "suspending";
+    readonly resuming: "resuming";
+    readonly deleting: "deleting";
+};
+export type InstanceReleaseResourceType = (typeof InstanceReleaseResourceType)[keyof typeof InstanceReleaseResourceType];
+export declare const InstanceReleaseResourceType: {
+    readonly instance: "instance";
+};
+/**
+ * The public ins resource identifier. Only this fixed TypeID prefix is accepted; UUID text is not an alternative representation.
+ * @minLength 30
+ * @maxLength 30
+ * @pattern ^ins_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25}$
+ */
+export type InstanceID = string;
+/**
+ * A resource a release set releases.
+ */
+export interface InstanceReleaseResource {
+    type: InstanceReleaseResourceType;
+    id: InstanceID;
+    /** The current display name of the selected resource. */
+    name: string;
+}
+export type VolumeReleaseResourceType = (typeof VolumeReleaseResourceType)[keyof typeof VolumeReleaseResourceType];
+export declare const VolumeReleaseResourceType: {
+    readonly volume: "volume";
+};
+/**
+ * Compute Volume TypeID. UUID text is not accepted.
+ * @minLength 30
+ * @maxLength 30
+ * @pattern ^vol_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25}$
+ */
+export type VolumeID = string;
+/**
+ * A resource a release set releases.
+ */
+export interface VolumeReleaseResource {
+    type: VolumeReleaseResourceType;
+    id: VolumeID;
+    /** The current display name of the selected resource. */
+    name: string;
+}
+export type ElasticIPReleaseResourceType = (typeof ElasticIPReleaseResourceType)[keyof typeof ElasticIPReleaseResourceType];
+export declare const ElasticIPReleaseResourceType: {
+    readonly elastic_ip: "elastic_ip";
+};
+/**
+ * A resource a release set releases.
+ */
+export interface ElasticIPReleaseResource {
+    type: ElasticIPReleaseResourceType;
+    id: ElasticIPID;
+    /** The current display name of the selected resource. */
+    name: string;
+}
+export type VolumeSnapshotReleaseResourceType = (typeof VolumeSnapshotReleaseResourceType)[keyof typeof VolumeSnapshotReleaseResourceType];
+export declare const VolumeSnapshotReleaseResourceType: {
+    readonly volume_snapshot: "volume_snapshot";
+    readonly snapshot: "snapshot";
+};
+/**
+ * Compute VolumeSnapshot TypeID. UUID text is not accepted.
+ * @minLength 38
+ * @maxLength 38
+ * @pattern ^volsnapshot_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25}$
+ */
+export type VolumeSnapshotID = string;
+/**
+ * A resource a release set releases.
+ */
+export interface VolumeSnapshotReleaseResource {
+    type: VolumeSnapshotReleaseResourceType;
+    id: VolumeSnapshotID;
+    /** The current display name of the selected resource. */
+    name: string;
+}
+export type VolumeBackupReleaseResourceType = (typeof VolumeBackupReleaseResourceType)[keyof typeof VolumeBackupReleaseResourceType];
+export declare const VolumeBackupReleaseResourceType: {
+    readonly volume_backup: "volume_backup";
+};
+/**
+ * Compute VolumeBackup TypeID. UUID text is not accepted.
+ * @minLength 36
+ * @maxLength 36
+ * @pattern ^volbackup_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25}$
+ */
+export type VolumeBackupID = string;
+/**
+ * A resource a release set releases.
+ */
+export interface VolumeBackupReleaseResource {
+    type: VolumeBackupReleaseResourceType;
+    id: VolumeBackupID;
+    /** The current display name of the selected resource. */
+    name: string;
+}
+export type PrivateImageReleaseResourceType = (typeof PrivateImageReleaseResourceType)[keyof typeof PrivateImageReleaseResourceType];
+export declare const PrivateImageReleaseResourceType: {
+    readonly private_image: "private_image";
+};
+/**
+ * Compute Image TypeID. UUID text is not accepted.
+ * @minLength 32
+ * @maxLength 32
+ * @pattern ^image_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25}$
+ */
+export type ImageID = string;
+/**
+ * A resource a release set releases.
+ */
+export interface PrivateImageReleaseResource {
+    type: PrivateImageReleaseResourceType;
+    id: ImageID;
+    /** The current display name of the selected resource. */
+    name: string;
+}
+/**
+ * A resource a release set releases.
+ */
+export type ReleaseResource = InstanceReleaseResource | VolumeReleaseResource | ElasticIPReleaseResource | VolumeSnapshotReleaseResource | VolumeBackupReleaseResource | PrivateImageReleaseResource;
+/**
+ * One subscription of a release set and the resource it pays for.
+ */
+export interface ReleaseSetItem {
+    subscription_id: string;
+    resource: ReleaseResource;
+}
+/**
+ * @nullable
+ */
+export type ElasticIPAccessState = (typeof ElasticIPAccessState)[keyof typeof ElasticIPAccessState] | null;
+export declare const ElasticIPAccessState: {
+    readonly pending: "pending";
+    readonly enabled: "enabled";
+    readonly suspended: "suspended";
+    readonly reclaimed: "reclaimed";
+};
+/**
+ * Why creation failed; null unless `status` is `failed`. `checkout_expired` means checkout was not completed before its Checkout Session expired. `provisioning_failed` means creation failed after the order was accepted, and the charge for this elastic IP is refunded.
+ * @nullable
+ */
+export type ElasticIPFailureReason = (typeof ElasticIPFailureReason)[keyof typeof ElasticIPFailureReason] | null;
+export declare const ElasticIPFailureReason: {
+    readonly order_declined: "order_declined";
+    readonly order_canceled: "order_canceled";
+    readonly order_expired: "order_expired";
+    readonly checkout_expired: "checkout_expired";
+    readonly provisioning_failed: "provisioning_failed";
+};
+/**
+ * Compute ElasticIPAssociation TypeID. UUID text is not accepted.
+ * @minLength 41
+ * @maxLength 41
+ * @pattern ^eipassociation_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25}$
+ */
+export type ElasticIPAssociationID = string;
+/**
+ * Compute NetworkInterfaceAddress TypeID. UUID text is not accepted.
+ * @minLength 37
+ * @maxLength 37
+ * @pattern ^eniaddress_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25}$
+ */
+export type NetworkInterfaceAddressID = string;
+export type ElasticIPAssociationState = (typeof ElasticIPAssociationState)[keyof typeof ElasticIPAssociationState];
+export declare const ElasticIPAssociationState: {
+    readonly associated: "associated";
+    readonly released: "released";
+};
+export interface ElasticIPAssociation {
+    id: ElasticIPAssociationID;
+    elastic_ip_id: ElasticIPID;
+    network_interface_address_id: NetworkInterfaceAddressID;
+    public_address: IPv4HostAddress;
+    private_address: IPv4HostAddress;
+    state: ElasticIPAssociationState;
+    /** @nullable */
+    associated_at: string | null;
+    /** @nullable */
+    disassociated_at: string | null;
+    /** @nullable */
+    released_at: string | null;
+}
+/**
+ * One public IP resource, including its bandwidth configuration. Bandwidth has no separate Compute resource ID.
+ * Two subscriptions of one order pay for it: the address subscription, always pay-as-you-go, charges for the
+ * address while it is not associated with anything, and the network subscription, on the terms chosen at
+ * purchase, charges for the bandwidth or the traffic. Changing bandwidth updates this same resource, not another
+ * allocation.
+ */
+export interface ElasticIP {
+    internet_charge_type: InternetChargeType;
+    /** The held IPv4 address; null before actual claim. Holding identity is not exposed. */
+    address: IPv4HostAddress | null;
+    /**
+     * The actual address holding start time; null before actual claim.
+     * @nullable
+     */
+    allocated_at: string | null;
+    /**
+     * The confirmed holding release time; null while held or before actual claim.
+     * @nullable
+     */
+    released_at: string | null;
+    /** @nullable */
+    bandwidth_mbps: number | null;
+    created_at: string;
+    id: ElasticIPID;
+    line_id: ElasticIPLineID;
+    region_id: RegionID;
+    /** `pending` until the address is created, with no address allocated before the order is accepted; then `available`. `failed` means no address was allocated; `failure_reason` states why. A value naming an operation in progress (`associating`, `disassociating`, `updating_bandwidth`, `updating_internet_charge_type`, `suspending`, `resuming`, `deleting`) is shown while that operation runs; the elastic IP refuses another operation until it ends. */
+    status: ElasticIPStatus;
+    /**
+     * The Billing Checkout Session that bought this resource; `order_id` and the order items stay null until its checkout completes. Null when the resource was not bought through one.
+     * @nullable
+     */
+    readonly checkout_session_id: string | null;
+    /** @nullable */
+    order_id: string | null;
+    /**
+     * The Billing order item of the address, always pay-as-you-go.
+     * @nullable
+     */
+    address_order_item_id: string | null;
+    /**
+     * The Billing subscription of the address. It may still be pending; its presence does not imply delivery or metering.
+     * @nullable
+     */
+    address_subscription_id: string | null;
+    /**
+     * The Billing order item of the bandwidth or traffic.
+     * @nullable
+     */
+    internet_order_item_id: string | null;
+    /**
+     * The Billing subscription of the bandwidth or traffic. It may still be pending; its presence does not imply delivery or metering.
+     * @nullable
+     */
+    internet_subscription_id: string | null;
+    /** The subscriptions a cancellation through Billing has to cover to release this elastic IP, both the address's and the network's, each with the resource it pays for, so that each line of a cancellation can name what it releases. A subscription that has ended is not listed, and the set is empty when no subscription pays for the elastic IP. */
+    release_set: ReleaseSetItem[];
+    /** @nullable */
+    access_state: ElasticIPAccessState;
+    /**
+     * Why creation failed; null unless `status` is `failed`. `checkout_expired` means checkout was not completed before its Checkout Session expired. `provisioning_failed` means creation failed after the order was accepted, and the charge for this elastic IP is refunded.
+     * @nullable
+     */
+    failure_reason: ElasticIPFailureReason;
+    association: ElasticIPAssociation | null;
+}
+/**
+ * The elastic IP as it is when the deletion is accepted, and the Billing cancellation that releases it when subscriptions pay for it.
+ */
+export interface DeleteElasticIPResponseBody {
+    elastic_ip: ElasticIP;
+    /** The cancellation Compute created for the elastic IP's subscriptions; null when none pays for it. */
+    cancellation: null | BillingCancellation;
+}
+/**
+ * The traffic an elastic IP sent in one interval.
+ */
+export interface TrafficUsage {
+    /** The start of the interval, in UTC. */
+    start_time: string;
+    /** @minimum 0 */
+    egress_bytes: number;
+    /** @minimum 0 */
+    egress_packets: number;
+}
+export interface TrafficUsageListResponseBody {
+    items: TrafficUsage[];
+    pagination: OffsetPagination;
+}
+export interface ElasticIPListResponseBody {
+    /** @nullable */
+    items: ElasticIP[] | null;
+    pagination: OffsetPagination;
+}
+export interface CreateElasticIPRequestBody {
+    internet_charge_type?: InternetChargeType;
+    address?: IPv4HostAddress;
+    /**
+     * The bandwidth ceiling of this address, in Mbit/s, applied to both directions.
+     *
+     * Required, and there is no "unlimited": an address with no ceiling runs at line rate and is
+     * charged nothing for the traffic, while the address itself bills normally — so the invoice
+     * looks correct and nothing anywhere reports it.
+     *
+     * Any whole number of Mbps within the line's `min_bandwidth_mbps` and `max_bandwidth_mbps`, otherwise the
+     * request is refused with `ELASTIC_IP_BANDWIDTH_RANGE`. Changing it
+     * later updates the same elastic IP through `update-elastic-ip`, not an independent bandwidth resource.
+     * @minimum 1
+     * @maximum 1000
+     */
+    bandwidth_mbps: number;
+    line_id: ElasticIPLineID;
+    billing: BillingChoice;
+    checkout?: CheckoutOptions;
+}
+/**
+ * The mutable fields of the elastic IP identified by the path, all optional, at least one required. `bandwidth_mbps`
+ * and `internet_charge_type` are operational fields and cannot be combined with any other field; such a request is
+ * refused with 422 `UPDATE_FIELDS_COMBINED`. This is a configuration change of that resource, not an independent
+ * bandwidth resource. Checkout is handled by Billing.
+ */
+export interface UpdateElasticIPRequestBody {
+    /**
+     * Moves a pay-as-you-go elastic IP between charging for its bandwidth and charging for its traffic, within the same network subscription and without checkout. A prepaid network subscription has paid for its bandwidth and is refused with `ELASTIC_IP_CHARGE_TYPE_PREPAID`; `traffic` on a line whose `traffic_sale_status` is `off_sale` is refused with `ELASTIC_IP_TRAFFIC_UNAVAILABLE`, the type already in effect with `ELASTIC_IP_CHARGE_TYPE_UNCHANGED`, and a type the currency of the network subscription does not offer on the line with HTTP 403 `ELASTIC_IP_CHARGE_TYPE_NOT_OFFERED`: prices are set per currency, and a currency without one there does not sell that type.
+     *
+     * The change takes effect at the instant it is applied: bandwidth stops being metered then and traffic starts being, or the other way round. Traffic is counted in windows, and a window is charged the way the elastic IP was charged for most of it, so a report that arrives late is still charged as it was at the time and a window the change falls in is never charged both ways. `bandwidth_mbps` stays the ceiling either way.
+     */
+    internet_charge_type?: InternetChargeType;
+    /**
+     * Applied to both directions
+     * @minimum 1
+     */
+    bandwidth_mbps?: number;
+    /** The `proration_date` of the Billing quote for this change, so that the order is priced from the same instant. Only with `bandwidth_mbps` on a prepaid network subscription, and only for automatic checkout; deferred checkout is priced when the customer completes it. Defaults to the time of the request; it must be a whole second, not in the future and at most 10 minutes old, otherwise the request is refused with `BILLING_CHANGE_INVALID`. */
+    proration_date?: string;
+    checkout?: CheckoutOptions;
+}
+/**
+ * An instance; the elastic IP points at the primary private IPv4 address of its primary network interface.
+ */
+export interface InstanceAssociationTarget {
+    instance_id: InstanceID;
+}
+/**
+ * One private address of a network interface. One interface may hold several private addresses, each with its own elastic IP.
+ */
+export interface NetworkInterfaceAddressAssociationTarget {
+    network_interface_address_id: NetworkInterfaceAddressID;
+}
+/**
+ * The target an elastic IP points at. Exactly one of the two forms.
+ */
+export type AssociateElasticIPRequestBody = InstanceAssociationTarget | NetworkInterfaceAddressAssociationTarget;
+/**
+ * The new elastic IP, `pending` until its order is accepted, and its Checkout Session. `address` is null until
+ * the address is allocated.
+ */
+export interface CreateElasticIPResponseBody {
+    elastic_ip: ElasticIP;
+    /** The Billing Checkout Session of this purchase. With deferred checkout, the customer completes it in Billing. */
+    checkout_session_id: string;
+    /**
+     * The order created when checkout completes, at once for automatic checkout; null until then.
+     * @nullable
+     */
+    order_id: string | null;
+}
+/**
+ * The elastic IP and, when the update placed a Billing order, the Checkout Session for it. After a bandwidth change the elastic IP is still at its current bandwidth until the change is applied. Returned with 200 when only descriptive fields changed and with 202 when an operation started.
+ */
+export interface UpdateElasticIPResponseBody {
+    elastic_ip: ElasticIP;
+    /**
+     * The Billing Checkout Session of the purchase; null when the update placed no order. With deferred checkout, the customer completes it in Billing.
+     * @nullable
+     */
+    checkout_session_id: string | null;
+    /**
+     * The order created when checkout completes, at once for automatic checkout; null until then and when the update placed no order.
+     * @nullable
+     */
+    order_id: string | null;
+}
+/**
+ * The public eni resource identifier. Only this fixed TypeID prefix is accepted; UUID text is not an alternative representation.
+ * @minLength 30
+ * @maxLength 30
+ * @pattern ^eni_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25}$
+ */
+export type NetworkInterfaceID = string;
+/**
+ * The public lt resource identifier. Only this fixed TypeID prefix is accepted; UUID text is not an alternative representation.
+ * @minLength 29
+ * @maxLength 29
+ * @pattern ^lt_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25}$
+ */
+export type LaunchTemplateID = string;
+/**
+ * The public vpc resource identifier. Only this fixed TypeID prefix is accepted; UUID text is not an alternative representation.
+ * @minLength 30
+ * @maxLength 30
+ * @pattern ^vpc_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25}$
+ */
+export type VirtualPrivateCloudID = string;
+/**
+ * A virtual private cloud identifier, or `-` to read across every virtual private cloud of the project (AIP-159).
+ * @pattern ^(?:-|vpc_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25})$
+ */
+export type VirtualPrivateCloudIDOrWildcard = string;
+/**
+ * Compute InstanceType TypeID. UUID text is not accepted.
+ * @minLength 34
+ * @maxLength 34
+ * @pattern ^instype_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25}$
+ */
+export type InstanceTypeID = string;
+/**
+ * Compute InstanceFamily TypeID. UUID text is not accepted.
+ * @minLength 36
+ * @maxLength 36
+ * @pattern ^insfamily_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25}$
+ */
+export type InstanceFamilyID = string;
+/**
+ * Compute VolumeType TypeID. UUID text is not accepted.
+ * @minLength 34
+ * @maxLength 34
+ * @pattern ^voltype_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25}$
+ */
+export type VolumeTypeID = string;
+/**
+ * Compute InstanceVolume TypeID. UUID text is not accepted.
+ * @minLength 33
+ * @maxLength 33
+ * @pattern ^insvol_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25}$
+ */
+export type InstanceVolumeID = string;
+/**
+ * Compute SecurityGroup TypeID. UUID text is not accepted.
+ * @minLength 29
+ * @maxLength 29
+ * @pattern ^sg_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25}$
+ */
+export type SecurityGroupID = string;
+/**
+ * A security group identifier, or `-` to read across every security group of the project (AIP-159).
+ * @pattern ^(?:-|sg_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25})$
+ */
+export type SecurityGroupIDOrWildcard = string;
+/**
+ * Compute Subnet TypeID. UUID text is not accepted.
+ * @minLength 33
+ * @maxLength 33
+ * @pattern ^subnet_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25}$
+ */
+export type SubnetID = string;
+/**
+ * Compute InstanceNetworkInterface TypeID. UUID text is not accepted.
+ * @minLength 33
+ * @maxLength 33
+ * @pattern ^inseni_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25}$
+ */
+export type InstanceNetworkInterfaceID = string;
+/**
+ * Compute OperationLog TypeID. UUID text is not accepted.
+ * @minLength 39
+ * @maxLength 39
+ * @pattern ^operationlog_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25}$
+ */
+export type OperationLogID = string;
+/**
+ * Compute VirtualPrivateCloudPeering TypeID. UUID text is not accepted.
+ * @minLength 37
+ * @maxLength 37
+ * @pattern ^vpcpeering_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25}$
+ */
+export type VirtualPrivateCloudPeeringID = string;
+/**
+ * Compute VirtualPrivateCloudRoute TypeID. UUID text is not accepted.
+ * @minLength 35
+ * @maxLength 35
+ * @pattern ^vpcroute_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25}$
+ */
+export type VirtualPrivateCloudRouteID = string;
+/**
+ * Compute SecurityGroupRule TypeID. UUID text is not accepted.
+ * @minLength 33
+ * @maxLength 33
+ * @pattern ^sgrule_[0-7][0123456789abcdefghjkmnpqrstvwxyz]{25}$
+ */
+export type SecurityGroupRuleID = string;
+/**
+ * Who makes the CPU the family runs on.
+ */
+export type InstanceFamilyCpuVendor = (typeof InstanceFamilyCpuVendor)[keyof typeof InstanceFamilyCpuVendor];
+export declare const InstanceFamilyCpuVendor: {
+    readonly intel: "intel";
+    readonly amd: "amd";
+};
+/**
+ * `dedicated` gives each vCPU a host thread of its own; `shared` lets the vCPUs of several instances share host threads.
+ */
+export type InstanceFamilyCpuTier = (typeof InstanceFamilyCpuTier)[keyof typeof InstanceFamilyCpuTier];
+export declare const InstanceFamilyCpuTier: {
+    readonly dedicated: "dedicated";
+    readonly shared: "shared";
+};
+/**
+ * What the family is sized for. `general_purpose` balances vCPU and memory, `compute_optimized` gives less memory per vCPU, and `memory_optimized` more.
+ */
+export type InstanceFamilyCategory = (typeof InstanceFamilyCategory)[keyof typeof InstanceFamilyCategory];
+export declare const InstanceFamilyCategory: {
+    readonly general_purpose: "general_purpose";
+    readonly compute_optimized: "compute_optimized";
+    readonly memory_optimized: "memory_optimized";
+};
+export interface InstanceFamily {
+    id: InstanceFamilyID;
+    region_id: RegionID;
+    /** The family's name, such as `g7`. */
+    name: string;
+    category: InstanceFamilyCategory;
+    /** The hardware generation of the family; a higher one is newer hardware. */
+    generation: number;
+    /** Who makes the CPU the family runs on. */
+    cpu_vendor: InstanceFamilyCpuVendor;
+    /** The CPU model, such as `EPYC 9654`; empty when none is stated. */
+    cpu_model: string;
+    /** `dedicated` gives each vCPU a host thread of its own; `shared` lets the vCPUs of several instances share host threads. */
+    cpu_tier: InstanceFamilyCpuTier;
+}
+export interface InstanceFamilyListResponseBody {
+    items: InstanceFamily[];
+    pagination: OffsetPagination;
+}
+/**
+ * `sold_out` takes no new orders for now while the type stays listed; the instances already of it keep working.
+ */
+export type InstanceTypeSaleStatus = (typeof InstanceTypeSaleStatus)[keyof typeof InstanceTypeSaleStatus];
+export declare const InstanceTypeSaleStatus: {
+    readonly on_sale: "on_sale";
+    readonly sold_out: "sold_out";
+};
+export interface InstanceType {
+    availability_zone_id: AvailabilityZoneID;
+    /** `sold_out` takes no new orders for now while the type stays listed; the instances already of it keep working. */
+    sale_status: InstanceTypeSaleStatus;
+    id: InstanceTypeID;
+    instance_family_id: InstanceFamilyID;
+    /**
+     * The machine's network rate, in Mbps. **Each** network interface of the machine is limited to it in both directions — per interface rather than shared, so a machine with two interfaces has this rate on each of them; `max_network_interfaces` says how many it may have. Zero is no limit.
+     *
+     * An elastic IP associated with the machine cannot be bought faster than this rate; asking for more is refused with `INSTANCE_BANDWIDTH_CEILING`.
+     */
+    max_bandwidth_mbps: number;
+    max_elastic_ips: number;
+    max_network_interfaces: number;
+    name: string;
+    memory_mib: number;
+    region_id: RegionID;
+    vcpus: number;
+    /** The line an instance of this type is. The boot volume and data volumes bought with it are lines of their volume types, and a new elastic IP the two lines of its elastic IP line. */
+    billing: BillingComponent;
+}
+export interface InstanceTypeListResponseBody {
+    items: InstanceType[];
+    pagination: OffsetPagination;
+}
+/**
+ * Which collection `image_id` belongs to. `public` means `/public-images`, `private` means `/private-images`. Null when the instance boots from a volume and therefore has no image
+ * @nullable
+ */
+export type InstanceImageType = (typeof InstanceImageType)[keyof typeof InstanceImageType] | null;
+export declare const InstanceImageType: {
+    readonly public: "public";
+    readonly private: "private";
+};
+/**
+ * `pending` until the instance is created: before the order is accepted no instance exists and addresses are null. Then `running`. `failed` means the instance was not created; `failure_reason` states why. The other values are the state of the instance in the cloud. A value naming an operation in progress (`starting`, `stopping`, `rebooting`, `rebuilding`, `rescuing`, `unrescuing`, `resizing`, `resetting_password`, `attaching_volume`, `detaching_volume`, `attaching_network_interface`, `detaching_network_interface`, `associating_elastic_ip`, `disassociating_elastic_ip`, `capturing_image`, `suspending`, `resuming`, `deleting`) is shown while that operation runs; the instance refuses another operation until it ends.
+ */
+export type InstanceStatus = (typeof InstanceStatus)[keyof typeof InstanceStatus];
+export declare const InstanceStatus: {
+    readonly pending: "pending";
+    readonly running: "running";
+    readonly stopped: "stopped";
+    readonly paused: "paused";
+    readonly suspended: "suspended";
+    readonly rescued: "rescued";
+    readonly deleted: "deleted";
+    readonly failed: "failed";
+    readonly error: "error";
+    readonly starting: "starting";
+    readonly stopping: "stopping";
+    readonly rebooting: "rebooting";
+    readonly rebuilding: "rebuilding";
+    readonly rescuing: "rescuing";
+    readonly unrescuing: "unrescuing";
+    readonly resizing: "resizing";
+    readonly resetting_password: "resetting_password";
+    readonly attaching_volume: "attaching_volume";
+    readonly detaching_volume: "detaching_volume";
+    readonly attaching_network_interface: "attaching_network_interface";
+    readonly detaching_network_interface: "detaching_network_interface";
+    readonly associating_elastic_ip: "associating_elastic_ip";
+    readonly disassociating_elastic_ip: "disassociating_elastic_ip";
+    readonly capturing_image: "capturing_image";
+    readonly suspending: "suspending";
+    readonly resuming: "resuming";
+    readonly deleting: "deleting";
+};
+/**
+ * Why it is held. `operator_suspended` is a suspension by the platform. `billing_suspended` is the instance's
+ * own subscription suspended for non-payment, and `billing_reclaimed` that subscription ending,
+ * after which the instance is released. `boot_volume_suspended` and `boot_volume_reclaimed` are the same
+ * for the subscription of the volume the instance boots from: that volume is billed apart, and the
+ * instance cannot run without it, so renewing the volume's subscription lifts the hold, and a reclaimed
+ * boot volume is released together with its instance.
+ */
+export type InstanceRestrictionReason = (typeof InstanceRestrictionReason)[keyof typeof InstanceRestrictionReason];
+export declare const InstanceRestrictionReason: {
+    readonly operator_suspended: "operator_suspended";
+    readonly billing_suspended: "billing_suspended";
+    readonly billing_reclaimed: "billing_reclaimed";
+    readonly boot_volume_suspended: "boot_volume_suspended";
+    readonly boot_volume_reclaimed: "boot_volume_reclaimed";
+};
+/**
+ * One hold on the instance. While any holds it, the instance is stopped and refuses being started,
+ * rebooted, rebuilt, resized, rescued, having its password reset and running commands, with 409
+ * `INSTANCE_SUSPENDED`. Holds are independent: lifting one never lifts another, and once none remains
+ * the instance is started again only if a hold stopped it, never one its user stopped.
+ */
+export interface InstanceRestriction {
+    /**
+     * Why it is held. `operator_suspended` is a suspension by the platform. `billing_suspended` is the instance's
+     * own subscription suspended for non-payment, and `billing_reclaimed` that subscription ending,
+     * after which the instance is released. `boot_volume_suspended` and `boot_volume_reclaimed` are the same
+     * for the subscription of the volume the instance boots from: that volume is billed apart, and the
+     * instance cannot run without it, so renewing the volume's subscription lifts the hold, and a reclaimed
+     * boot volume is released together with its instance.
+     */
+    reason: InstanceRestrictionReason;
+    /**
+     * The Billing subscription whose state holds the instance; null for `operator_suspended`.
+     * @nullable
+     */
+    subscription_id: string | null;
+    /** The volume the instance boots from, for `boot_volume_suspended` and `boot_volume_reclaimed`; null otherwise. */
+    volume_id: VolumeID | null;
+    /**
+     * When the hold began; null when that instant was not recorded.
+     * @nullable
+     */
+    started_at: string | null;
+}
+/**
+ * Why creation failed; null unless `status` is `failed`. `checkout_expired` means checkout was not completed before its Checkout Session expired. `provisioning_failed` means creation failed after the order was accepted, and the charge for this instance is refunded.
+ * @nullable
+ */
+export type InstanceFailureReason = (typeof InstanceFailureReason)[keyof typeof InstanceFailureReason] | null;
+export declare const InstanceFailureReason: {
+    readonly order_declined: "order_declined";
+    readonly order_canceled: "order_canceled";
+    readonly order_expired: "order_expired";
+    readonly checkout_expired: "checkout_expired";
+    readonly provisioning_failed: "provisioning_failed";
+};
+/**
+ * @nullable
+ */
+export type InstanceAccessState = (typeof InstanceAccessState)[keyof typeof InstanceAccessState] | null;
+export declare const InstanceAccessState: {
+    readonly pending: "pending";
+    readonly enabled: "enabled";
+    readonly suspended: "suspended";
+    readonly reclaimed: "reclaimed";
+};
+/**
+ * Your own classification of this instance, as key-value pairs. Empty when never set
+ */
+export type InstanceLabels = {
+    [key: string]: string;
+};
+export interface Instance {
+    availability_zone_id: AvailabilityZoneID;
+    created_at: string;
+    /** Hostname inside the instance; equals the instance id */
+    hostname: string;
+    id: InstanceID;
+    /** Non-empty when the instance was created from an image, public or private. `image_type` says which collection holds it */
+    image_id: ImageID | null;
+    /**
+     * Which collection `image_id` belongs to. `public` means `/public-images`, `private` means `/private-images`. Null when the instance boots from a volume and therefore has no image
+     * @nullable
+     */
+    image_type: InstanceImageType;
+    instance_type_id: InstanceTypeID;
+    /**
+     * IPv6 address of the primary network interface. Assigned automatically once IPv6 is enabled on the virtual private cloud
+     * @nullable
+     */
+    ipv6_address: string | null;
+    /** Your own classification of this instance, as key-value pairs. Empty when never set */
+    labels: InstanceLabels;
+    /**
+     * The account to log in as over SSH. The password set at creation belongs to this account
+     * @maxLength 32
+     */
+    login_username: string;
+    name: string;
+    /**
+     * A free-text note about this instance. Empty when never set
+     * @maxLength 4096
+     */
+    description: string;
+    /**
+     * Private address of the instance
+     * @nullable
+     */
+    private_ip: string | null;
+    virtual_private_cloud_id: VirtualPrivateCloudID | null;
+    /**
+     * Elastic IPv4 addresses associated with the primary network interface; an empty array when none are associated
+     * @nullable
+     */
+    elastic_ip_addresses: string[] | null;
+    region_id: RegionID;
+    /** `pending` until the instance is created: before the order is accepted no instance exists and addresses are null. Then `running`. `failed` means the instance was not created; `failure_reason` states why. The other values are the state of the instance in the cloud. A value naming an operation in progress (`starting`, `stopping`, `rebooting`, `rebuilding`, `rescuing`, `unrescuing`, `resizing`, `resetting_password`, `attaching_volume`, `detaching_volume`, `attaching_network_interface`, `detaching_network_interface`, `associating_elastic_ip`, `disassociating_elastic_ip`, `capturing_image`, `suspending`, `resuming`, `deleting`) is shown while that operation runs; the instance refuses another operation until it ends. */
+    status: InstanceStatus;
+    subnet_id: SubnetID | null;
+    updated_at: string;
+    restrictions: InstanceRestriction[];
+    /**
+     * Why creation failed; null unless `status` is `failed`. `checkout_expired` means checkout was not completed before its Checkout Session expired. `provisioning_failed` means creation failed after the order was accepted, and the charge for this instance is refunded.
+     * @nullable
+     */
+    failure_reason: InstanceFailureReason;
+    /**
+     * The Billing Checkout Session that bought this resource; `order_id` and `order_item_id` stay null until its checkout completes. Null when the resource was not bought through one.
+     * @nullable
+     */
+    readonly checkout_session_id: string | null;
+    /** @nullable */
+    order_id: string | null;
+    /**
+     * The Billing order item for this resource.
+     * @nullable
+     */
+    order_item_id: string | null;
+    /**
+     * The Billing subscription associated with this resource. It may still be pending; its
+     * presence does not imply delivery or metering. Null when no subscription is associated.
+     * @nullable
+     */
+    subscription_id: string | null;
+    /** Subscriptions required to release this instance and volumes deleted with it, each with the resource it pays for, so that each line of a cancellation can name what it releases. Billing determines cancellation terms. An empty set does not establish refund eligibility. */
+    release_set: ReleaseSetItem[];
+    /** @nullable */
+    access_state: InstanceAccessState;
+    /** Non-empty when the instance was created from a volume you already had, instead of from an image */
+    source_volume_id: VolumeID | null;
+    /** The launch template the instance was created from; null when none was named. Changing or deleting the template afterwards changes nothing about the instance. */
+    launch_template_id: LaunchTemplateID | null;
+    /**
+     * The version of that launch template it was created from; null when none was named.
+     * @nullable
+     */
+    launch_template_version_number: number | null;
+}
+/**
+ * The instance as it is when the deletion is accepted, and the Billing cancellation that releases it when subscriptions pay for it.
+ */
+export interface DeleteInstanceResponseBody {
+    instance: Instance;
+    /** The cancellation Compute created for the instance's subscriptions; null when none pays for it. */
+    cancellation: null | BillingCancellation;
+}
+export interface InstanceListResponseBody {
+    items: Instance[];
+    pagination: OffsetPagination;
+}
+/**
+ * Your own classification of each instance, as key-value pairs. A key may not contain a colon, whitespace or control characters
+ */
+export type CreateInstanceRequestBodyLabels = {
+    [key: string]: string;
+};
+/**
+ * The launch template a creation starts from.
+ */
+export interface LaunchTemplateReference {
+    launch_template_id: LaunchTemplateID;
+    /**
+     * A live version of it; the template's `default_version` when omitted.
+     * @minimum 1
+     */
+    version_number?: number;
+}
+/**
+ * The compute capacity requested for each instance in this order.
+ */
+export interface NewCompute {
+    instance_type_id?: InstanceTypeID;
+    billing: BillingChoice;
+}
+export type NewBootVolumeType = (typeof NewBootVolumeType)[keyof typeof NewBootVolumeType];
+export declare const NewBootVolumeType: {
+    readonly image: "image";
+};
+/**
+ * What releasing the instance does to this volume. `delete` deletes it with the instance; `detach` keeps it, still billed on its own terms, for you to attach elsewhere or delete.
+ */
+export type NewBootVolumeOnInstanceRelease = (typeof NewBootVolumeOnInstanceRelease)[keyof typeof NewBootVolumeOnInstanceRelease];
+export declare const NewBootVolumeOnInstanceRelease: {
+    readonly delete: "delete";
+    readonly detach: "detach";
+};
+/**
+ * A boot volume created from an image and recorded in the instance order. Its commercial terms are explicit and its release policy does not override them.
+ */
+export interface NewBootVolume {
+    type: NewBootVolumeType;
+    image_id: ImageID;
+    volume_type_id: VolumeTypeID;
+    /** @minimum 1 */
+    size_gib: number;
+    /** What releasing the instance does to this volume. `delete` deletes it with the instance; `detach` keeps it, still billed on its own terms, for you to attach elsewhere or delete. */
+    on_instance_release?: NewBootVolumeOnInstanceRelease;
+    billing?: BillingChoice;
+}
+export type ExistingBootVolumeType = (typeof ExistingBootVolumeType)[keyof typeof ExistingBootVolumeType];
+export declare const ExistingBootVolumeType: {
+    readonly volume: "volume";
+};
+export interface ExistingBootVolume {
+    type: ExistingBootVolumeType;
+    volume_id: VolumeID;
+    /**
+     * The existing account used to log in to this volume's operating system.
+     * @minLength 1
+     * @maxLength 32
+     */
+    login_username: string;
+}
+/**
+ * Create a boot volume from an image, or use a prepared volume already held by this project. Using an existing volume does not buy it again and always keeps it when the instance is released.
+ */
+export type BootVolume = NewBootVolume | ExistingBootVolume;
+/**
+ * What releasing the instance does to this volume. `delete` deletes it with the instance; `detach` keeps it, still billed on its own terms, for you to attach elsewhere or delete.
+ */
+export type NewDataVolumeOnInstanceRelease = (typeof NewDataVolumeOnInstanceRelease)[keyof typeof NewDataVolumeOnInstanceRelease];
+export declare const NewDataVolumeOnInstanceRelease: {
+    readonly delete: "delete";
+    readonly detach: "detach";
+};
+/**
+ * An empty data volume created in the instance's availability zone. Its terms follow the rule shared by every component of the purchase, so a pay-as-you-go instance gets pay-as-you-go data volumes, which stay pay-as-you-go once detached.
+ */
+export interface NewDataVolume {
+    volume_type_id: VolumeTypeID;
+    /**
+     * Within the volume type's `min_size_gib` and `max_size_gib` and a multiple of its `size_step_gib`.
+     * @minimum 1
+     */
+    size_gib: number;
+    /** What releasing the instance does to this volume. `delete` deletes it with the instance; `detach` keeps it, still billed on its own terms, for you to attach elsewhere or delete. */
+    on_instance_release?: NewDataVolumeOnInstanceRelease;
+    billing?: BillingChoice;
+}
+export type NewPrimaryNetworkInterfaceType = (typeof NewPrimaryNetworkInterfaceType)[keyof typeof NewPrimaryNetworkInterfaceType];
+export declare const NewPrimaryNetworkInterfaceType: {
+    readonly new: "new";
+};
+export interface NewPrimaryNetworkInterface {
+    type: NewPrimaryNetworkInterfaceType;
+    subnet_id: SubnetID;
+    /**
+     * The security groups of the interface, of the subnet's virtual private cloud. The default security group is not applied automatically.
+     * @minItems 1
+     * @maxItems 5
+     */
+    security_group_ids: SecurityGroupID[];
+}
+export type ExistingPrimaryNetworkInterfaceType = (typeof ExistingPrimaryNetworkInterfaceType)[keyof typeof ExistingPrimaryNetworkInterfaceType];
+export declare const ExistingPrimaryNetworkInterfaceType: {
+    readonly existing: "existing";
+};
+export interface ExistingPrimaryNetworkInterface {
+    type: ExistingPrimaryNetworkInterfaceType;
+    network_interface_id: NetworkInterfaceID;
+}
+/**
+ * The instance's primary network interface, its network location. `new` creates one in a subnet, deleted with the instance; `existing` uses one you already hold, detached and kept when the instance is released.
+ */
+export type PrimaryNetworkInterface = NewPrimaryNetworkInterface | ExistingPrimaryNetworkInterface;
+export type NewElasticIPType = (typeof NewElasticIPType)[keyof typeof NewElasticIPType];
+export declare const NewElasticIPType: {
+    readonly new: "new";
+};
+/**
+ * One IPv4 elastic IP created with this bandwidth configuration in the instance's order.
+ */
+export interface NewElasticIP {
+    type: NewElasticIPType;
+    line_id: ElasticIPLineID;
+    /**
+     * Any whole number of Mbps within the line's `min_bandwidth_mbps` and `max_bandwidth_mbps`, otherwise refused with `ELASTIC_IP_BANDWIDTH_RANGE`.
+     * @minimum 1
+     * @maximum 1000
+     */
+    bandwidth_mbps: number;
+    internet_charge_type?: InternetChargeType;
+    billing?: BillingChoice;
+}
+export type ExistingElasticIPType = (typeof ExistingElasticIPType)[keyof typeof ExistingElasticIPType];
+export declare const ExistingElasticIPType: {
+    readonly existing: "existing";
+};
+export interface ExistingElasticIP {
+    type: ExistingElasticIPType;
+    elastic_ip_id: ElasticIPID;
+}
+/**
+ * `new` buys an elastic IP in the instance's order; `existing` associates one you already hold. One address is associated with one interface, so either creates only one instance.
+ */
+export type InstanceElasticIP = NewElasticIP | ExistingElasticIP;
+export type GeneratedPasswordType = (typeof GeneratedPasswordType)[keyof typeof GeneratedPasswordType];
+export declare const GeneratedPasswordType: {
+    readonly generated: "generated";
+};
+export interface GeneratedPassword {
+    type: GeneratedPasswordType;
+}
+export type SuppliedPasswordType = (typeof SuppliedPasswordType)[keyof typeof SuppliedPasswordType];
+export declare const SuppliedPasswordType: {
+    readonly supplied: "supplied";
+};
+export interface SuppliedPassword {
+    type: SuppliedPasswordType;
+    /**
+     * 12 to 128 characters with at least three of lowercase letters, uppercase letters, digits and symbols, otherwise refused with `INSTANCE_PASSWORD_TOO_WEAK`.
+     * @minLength 12
+     * @maxLength 128
+     */
+    value: string;
+}
+/**
+ * The password of the login account (`login_username`). `generated` has the platform generate a strong random
+ * password, returned once in the response and stored nowhere; `supplied` sets the one given. Password login
+ * over SSH is enabled with it, so it answers on port 22 once a security group admits it. Root never gets a
+ * password: where the login account is not root, root logs in by key only.
+ */
+export type PasswordChoice = GeneratedPassword | SuppliedPassword;
+/**
+ * Every part a launch template can describe may come from `launch_template` instead: a part given here overrides the template's, and `data_volumes`, when given, replaces the template's list. After that the instance type, the boot volume and the network interface are required, each refused with 422 `INSTANCE_CREATE_INVALID` naming the field when neither gives it.
+ *
+ * Every component bought with the instance (its boot volume, data volumes and elastic IP) shares the usage type and period of `compute.billing`; a component's own `billing` exists to choose a different termination policy, and when omitted it is `compute.billing`.
+ */
+export interface CreateInstanceRequestBody {
+    launch_template?: LaunchTemplateReference;
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name: string;
+    /**
+     * Number of instances to create; 1 when omitted. Names are numbered automatically for several
+     * @minimum 1
+     * @maximum 20
+     */
+    count?: number;
+    compute: NewCompute;
+    boot_volume?: BootVolume;
+    /**
+     * Data volumes created with each instance in its order and attached to it at boot, after the boot volume in the order given. An instance and its volumes are delivered together or not at all.
+     * @maxItems 16
+     */
+    data_volumes?: NewDataVolume[];
+    network_interface?: PrimaryNetworkInterface;
+    elastic_ip?: InstanceElasticIP;
+    password?: PasswordChoice;
+    /** Your own classification of each instance, as key-value pairs. A key may not contain a colon, whitespace or control characters */
+    labels?: CreateInstanceRequestBodyLabels;
+    /**
+     * A free-text note about each instance. Do not put credentials here
+     * @maxLength 4096
+     */
+    description?: string;
+    checkout?: CheckoutOptions;
+}
+/**
+ * The complete set of labels. Whatever is absent here is removed; send an empty object to clear them all. A key may not contain a colon, whitespace or control characters
+ */
+export type UpdateInstanceRequestBodyLabels = {
+    [key: string]: string;
+};
+/**
+ * The mutable fields of an instance, all optional, at least one required. `instance_type_id` is an operational
+ * field: it starts a workflow and cannot be combined with any other field; such a request is refused with 422
+ * `UPDATE_FIELDS_COMBINED`.
+ */
+export interface UpdateInstanceRequestBody {
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name?: string;
+    /** The complete set of labels. Whatever is absent here is removed; send an empty object to clear them all. A key may not contain a colon, whitespace or control characters */
+    labels?: UpdateInstanceRequestBodyLabels;
+    /**
+     * The complete note. Send an empty string to clear it
+     * @maxLength 4096
+     */
+    description?: string;
+    instance_type_id?: InstanceTypeID;
+    /** The `proration_date` of the Billing quote for this change, so that the order is priced from the same instant. Only with `instance_type_id`, and only for automatic checkout; deferred checkout is priced when the customer completes it. Defaults to the time of the request; it must be a whole second, not in the future and at most 10 minutes old, otherwise the request is refused with `BILLING_CHANGE_INVALID`. */
+    proration_date?: string;
+    checkout?: CheckoutOptions;
+}
+export interface RebootInstanceRequestBody {
+    /** A forced reboot does not wait for the operating system to shut down and unwritten data is lost; use it when the system is unresponsive. False when omitted */
+    force?: boolean;
+}
+export interface RunInstanceCommandRequestBody {
+    /**
+     * Run by the login shell, so pipes, redirection and `&&` work. It cannot read standard input
+     * @minLength 1
+     * @maxLength 65536
+     */
+    command: string;
+    /**
+     * Kill the command after this long. 60 when omitted
+     * @minimum 1
+     * @maximum 300
+     */
+    timeout_seconds?: number;
+}
+export interface RunInstanceCommandResponseBody {
+    /**
+     * What the command exited with, 0 being success. Any other value is the command's own verdict and still arrives as a 200. Null when it was killed rather than exiting on its own, which includes the timeout — null is the absence of a verdict, not a successful one
+     * @nullable
+     */
+    exit_code: number | null;
+    stderr: string;
+    stdout: string;
+    /** True when the command was still running at the timeout and was killed */
+    timed_out: boolean;
+    /** True when either stream hit the 1 MiB cap and the rest was discarded */
+    truncated: boolean;
+}
+export interface ConsoleResponseBody {
+    /** The WebSocket address a noVNC client connects to; single-use and expires within minutes */
+    console_url: string;
+}
+export interface ResetInstancePasswordResponseBody {
+    /**
+     * The password the platform generated, returned only in this response; null when the password was supplied.
+     * @nullable
+     */
+    password: string | null;
+}
+export interface RebuildInstanceRequestBody {
+    image_id: ImageID;
+    password?: PasswordChoice;
+}
+export interface RebuildInstanceResponseBody {
+    instance: Instance;
+    /**
+     * The password the platform generated, returned only in this response; store it immediately. Null when the password was supplied or none was asked for.
+     * @nullable
+     */
+    password: string | null;
+}
+/**
+ * The instance and, when the update placed a Billing order, the Checkout Session for it. After a resize the
+ * instance is still on its current type, keeps its ID, and its current subscription remains in force until
+ * the resize is applied. Returned with 200 when only descriptive fields changed and with 202 when an operation started.
+ */
+export interface UpdateInstanceResponseBody {
+    instance: Instance;
+    /**
+     * The Billing Checkout Session of the purchase; null when the update placed no order. With deferred checkout, the customer completes it in Billing.
+     * @nullable
+     */
+    checkout_session_id: string | null;
+    /**
+     * The order created when checkout completes, at once for automatic checkout; null until then and when the update placed no order.
+     * @nullable
+     */
+    order_id: string | null;
+}
+/**
+ * The new instances, `pending` until their order is accepted, and the Checkout Session they share.
+ */
+export interface CreateInstanceResponseBody {
+    /**
+     * One instance per requested instance, in request order. Their IDs stay the same through checkout and
+     * creation.
+     * @minItems 1
+     * @maxItems 20
+     */
+    instances: Instance[];
+    /** The Billing Checkout Session of this purchase. With deferred checkout, the customer completes it in Billing. */
+    checkout_session_id: string;
+    /**
+     * The order created when checkout completes, at once for automatic checkout; null until then.
+     * @nullable
+     */
+    order_id: string | null;
+    /**
+     * Generated login password, returned only by this response. Null when no password was generated.
+     * @nullable
+     */
+    password: string | null;
+}
+export interface RescueInstanceRequestBody {
+    /**
+     * Password for the rescue environment. Generate and retain a strong password before calling.
+     * @minLength 12
+     * @maxLength 128
+     */
+    password: string;
+}
+export interface RescueInstanceResponseBody {
+    /** Login account in the temporary rescue environment. */
+    login_username: string;
+    instance: Instance;
+}
+export interface LaunchTemplate {
+    id: LaunchTemplateID;
+    region_id: RegionID;
+    name: string;
+    description: string;
+    /** The version a creation naming no version uses. */
+    default_version_number: number;
+    /** The highest version number the template ever had. */
+    latest_version_number: number;
+    created_at: string;
+    updated_at: string;
+}
+export interface LaunchTemplateListResponseBody {
+    items: LaunchTemplate[];
+    pagination: OffsetPagination;
+}
+export type LaunchTemplateBootVolumeOnInstanceRelease = (typeof LaunchTemplateBootVolumeOnInstanceRelease)[keyof typeof LaunchTemplateBootVolumeOnInstanceRelease];
+export declare const LaunchTemplateBootVolumeOnInstanceRelease: {
+    readonly delete: "delete";
+    readonly detach: "detach";
+};
+/**
+ * A boot volume created from an image for each instance.
+ */
+export interface LaunchTemplateBootVolume {
+    image_id: ImageID;
+    volume_type_id: VolumeTypeID;
+    /** @minimum 1 */
+    size_gib: number;
+    on_instance_release?: LaunchTemplateBootVolumeOnInstanceRelease;
+}
+export type LaunchTemplateDataVolumeOnInstanceRelease = (typeof LaunchTemplateDataVolumeOnInstanceRelease)[keyof typeof LaunchTemplateDataVolumeOnInstanceRelease];
+export declare const LaunchTemplateDataVolumeOnInstanceRelease: {
+    readonly delete: "delete";
+    readonly detach: "detach";
+};
+/**
+ * An empty data volume created with each instance.
+ */
+export interface LaunchTemplateDataVolume {
+    volume_type_id: VolumeTypeID;
+    /** @minimum 1 */
+    size_gib: number;
+    on_instance_release?: LaunchTemplateDataVolumeOnInstanceRelease;
+}
+/**
+ * A new primary network interface for each instance. An interface you already hold serves one instance, so a template cannot name one.
+ */
+export interface LaunchTemplateNetworkInterface {
+    subnet_id: SubnetID;
+    /**
+     * @minItems 1
+     * @maxItems 5
+     */
+    security_group_ids: SecurityGroupID[];
+}
+/**
+ * A new elastic IP bought with each instance. An address you already hold serves one instance, so a template cannot name one.
+ */
+export interface LaunchTemplateElasticIP {
+    line_id: ElasticIPLineID;
+    /**
+     * @minimum 1
+     * @maximum 1000
+     */
+    bandwidth_mbps: number;
+    internet_charge_type?: InternetChargeType;
+}
+/**
+ * A key may not contain a colon, whitespace or control characters.
+ */
+export type NewLaunchTemplateVersionLabels = {
+    [key: string]: string;
+};
+/**
+ * What a version describes. Every part is optional; an instance created from the version supplies what is left out and may override what is given.
+ */
+export interface NewLaunchTemplateVersion {
+    /** @maxLength 1024 */
+    version_description?: string;
+    instance_type_id?: InstanceTypeID;
+    boot_volume?: LaunchTemplateBootVolume;
+    /** @maxItems 16 */
+    data_volumes?: LaunchTemplateDataVolume[];
+    network_interface?: LaunchTemplateNetworkInterface;
+    elastic_ip?: LaunchTemplateElasticIP;
+    /** A key may not contain a colon, whitespace or control characters. */
+    labels?: NewLaunchTemplateVersionLabels;
+    /** @maxLength 4096 */
+    description?: string;
+}
+export interface CreateLaunchTemplateRequestBody {
+    region_id: RegionID;
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name: string;
+    /** @maxLength 1024 */
+    description?: string;
+    version: NewLaunchTemplateVersion;
+}
+/**
+ * Null when the version describes no labels.
+ * @nullable
+ */
+export type LaunchTemplateVersionLabels = {
+    [key: string]: string;
+} | null;
+export interface LaunchTemplateVersion {
+    launch_template_id: LaunchTemplateID;
+    version_number: number;
+    version_description: string;
+    instance_type_id: InstanceTypeID | null;
+    boot_volume: LaunchTemplateBootVolume | null;
+    data_volumes: LaunchTemplateDataVolume[];
+    network_interface: LaunchTemplateNetworkInterface | null;
+    elastic_ip: LaunchTemplateElasticIP | null;
+    /**
+     * Null when the version describes no labels.
+     * @nullable
+     */
+    labels: LaunchTemplateVersionLabels;
+    /**
+     * Null when the version describes no note.
+     * @nullable
+     */
+    description: string | null;
+    created_at: string;
+}
+export interface CreateLaunchTemplateResponseBody {
+    launch_template: LaunchTemplate;
+    version: LaunchTemplateVersion;
+}
+/**
+ * The fields to change, at least one.
+ */
+export interface UpdateLaunchTemplateRequestBody {
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name?: string;
+    /** @maxLength 1024 */
+    description?: string;
+    /**
+     * A live version of this template.
+     * @minimum 1
+     */
+    default_version_number?: number;
+}
+export interface LaunchTemplateVersionListResponseBody {
+    items: LaunchTemplateVersion[];
+    pagination: OffsetPagination;
+}
+/**
+ * `pending` until the interface is created, then `available`. `error` means its creation failed or the cloud reports it broken; delete it and create another. A value naming an operation in progress (`attaching`, `detaching`, `associating_elastic_ip`, `updating_security_groups`, `adding_address`, `removing_address`, `deleting`) is shown while that operation runs; the interface refuses another operation until it ends.
+ */
+export type NetworkInterfaceStatus = (typeof NetworkInterfaceStatus)[keyof typeof NetworkInterfaceStatus];
+export declare const NetworkInterfaceStatus: {
+    readonly pending: "pending";
+    readonly available: "available";
+    readonly error: "error";
+    readonly attaching: "attaching";
+    readonly detaching: "detaching";
+    readonly associating_elastic_ip: "associating_elastic_ip";
+    readonly updating_security_groups: "updating_security_groups";
+    readonly adding_address: "adding_address";
+    readonly removing_address: "removing_address";
+    readonly deleting: "deleting";
+};
+/**
+ * `primary` is the interface's primary private address, which is the instance's network location; every other address of the interface is `secondary`.
+ */
+export type NetworkInterfaceAddressRole = (typeof NetworkInterfaceAddressRole)[keyof typeof NetworkInterfaceAddressRole];
+export declare const NetworkInterfaceAddressRole: {
+    readonly primary: "primary";
+    readonly secondary: "secondary";
+};
+export type NetworkInterfaceAddressState = (typeof NetworkInterfaceAddressState)[keyof typeof NetworkInterfaceAddressState];
+export declare const NetworkInterfaceAddressState: {
+    readonly reserved: "reserved";
+    readonly assigned: "assigned";
+    readonly released: "released";
+};
+export interface NetworkInterfaceAddress {
+    id: NetworkInterfaceAddressID;
+    subnet_id: SubnetID;
+    /**
+     * @minLength 1
+     * @maxLength 64
+     */
+    address: string;
+    /** `primary` is the interface's primary private address, which is the instance's network location; every other address of the interface is `secondary`. */
+    role: NetworkInterfaceAddressRole;
+    state: NetworkInterfaceAddressState;
+    /** @nullable */
+    assigned_at: string | null;
+    /** @nullable */
+    released_at: string | null;
+}
+export type NetworkInterfaceAttachmentRole = (typeof NetworkInterfaceAttachmentRole)[keyof typeof NetworkInterfaceAttachmentRole];
+export declare const NetworkInterfaceAttachmentRole: {
+    readonly primary: "primary";
+    readonly secondary: "secondary";
+};
+/**
+ * What releasing the instance does to this interface. `delete` deletes it together with the instance; `detach` detaches it and leaves it to you. The primary interface created with the instance is `delete`; an interface you created yourself is `detach`.
+ */
+export type NetworkInterfaceAttachmentOnInstanceRelease = (typeof NetworkInterfaceAttachmentOnInstanceRelease)[keyof typeof NetworkInterfaceAttachmentOnInstanceRelease];
+export declare const NetworkInterfaceAttachmentOnInstanceRelease: {
+    readonly delete: "delete";
+    readonly detach: "detach";
+};
+export type NetworkInterfaceAttachmentState = (typeof NetworkInterfaceAttachmentState)[keyof typeof NetworkInterfaceAttachmentState];
+export declare const NetworkInterfaceAttachmentState: {
+    readonly reserved: "reserved";
+    readonly attached: "attached";
+    readonly released: "released";
+};
+export interface NetworkInterfaceAttachment {
+    id: InstanceNetworkInterfaceID;
+    instance_id: InstanceID;
+    network_interface_id: NetworkInterfaceID;
+    role: NetworkInterfaceAttachmentRole;
+    /** What releasing the instance does to this interface. `delete` deletes it together with the instance; `detach` detaches it and leaves it to you. The primary interface created with the instance is `delete`; an interface you created yourself is `detach`. */
+    on_instance_release: NetworkInterfaceAttachmentOnInstanceRelease;
+    state: NetworkInterfaceAttachmentState;
+    /** @nullable */
+    attached_at: string | null;
+    /** @nullable */
+    detached_at: string | null;
+    /** @nullable */
+    released_at: string | null;
+}
+export interface NetworkInterface {
+    id: NetworkInterfaceID;
+    /** @nullable */
+    mac_address: string | null;
+    name: string;
+    virtual_private_cloud_id: VirtualPrivateCloudID;
+    /**
+     * Elastic IPv4 addresses associated with this network interface; an empty array when none are associated
+     * @nullable
+     */
+    elastic_ip_addresses: string[] | null;
+    /** The security groups the network interface holds. */
+    security_group_ids: SecurityGroupID[];
+    addresses?: NetworkInterfaceAddress[];
+    attachment: NetworkInterfaceAttachment | null;
+    /** `pending` until the interface is created, then `available`. `error` means its creation failed or the cloud reports it broken; delete it and create another. A value naming an operation in progress (`attaching`, `detaching`, `associating_elastic_ip`, `updating_security_groups`, `adding_address`, `removing_address`, `deleting`) is shown while that operation runs; the interface refuses another operation until it ends. */
+    status: NetworkInterfaceStatus;
+}
+export interface NetworkInterfaceListResponseBody {
+    /** @nullable */
+    items: NetworkInterface[] | null;
+    pagination: OffsetPagination;
+}
+export interface AttachNetworkInterfaceRequestBody {
+    network_interface_id: NetworkInterfaceID;
+}
+export interface CreateNetworkInterfaceRequestBody {
+    /** @maxLength 128 */
+    name?: string;
+    /**
+     * At least one, and all must belong to the same virtual private cloud
+     * @minItems 1
+     * @nullable
+     */
+    security_group_ids: SecurityGroupID[] | null;
+    subnet_id: SubnetID;
+    /**
+     * The private address to assign. Allocated automatically when omitted
+     * @maxLength 64
+     */
+    address?: string;
+}
+/**
+ * The mutable fields of a network interface, all optional, at least one required.
+ */
+export interface UpdateNetworkInterfaceRequestBody {
+    /** @maxLength 128 */
+    name?: string;
+    /**
+     * The complete new set of security groups, of the network interface's virtual private cloud.
+     * @minItems 1
+     * @maxItems 5
+     */
+    security_group_ids?: SecurityGroupID[];
+}
+export interface CreateNetworkInterfaceAddressRequestBody {
+    /**
+     * The IPv4 address to add, in the network interface's subnet. Chosen by the network when omitted.
+     * @maxLength 15
+     */
+    address?: string;
+}
+export interface NetworkInterfaceAttachmentList {
+    items: NetworkInterfaceAttachment[];
+    pagination: OffsetPagination;
+}
+/**
+ * `user` when a user of the project initiated the operation, `platform` when the platform performed it.
+ */
+export type OperationLogResourceActorType = (typeof OperationLogResourceActorType)[keyof typeof OperationLogResourceActorType];
+export declare const OperationLogResourceActorType: {
+    readonly user: "user";
+    readonly platform: "platform";
+};
+/**
+ * Path and query parameters of the request. Fields such as passwords are redacted
+ */
+export type OperationLogResourcePayload = {
+    [key: string]: unknown;
+};
+/**
+ * `succeeded` means the operation took effect. `rejected` means it was refused with a 4xx the caller can act on, such as a validation failure, a conflict or an exhausted quota. `failed` means the platform failed to carry it out (5xx).
+ */
+export type OperationLogResourceOutcome = (typeof OperationLogResourceOutcome)[keyof typeof OperationLogResourceOutcome];
+export declare const OperationLogResourceOutcome: {
+    readonly succeeded: "succeeded";
+    readonly rejected: "rejected";
+    readonly failed: "failed";
+};
+export interface OperationLogResource {
+    /** Name of the operation; matches the operation id of the endpoint */
+    action: string;
+    /**
+     * The user who initiated the operation. Null when `actor_type` is `platform`
+     * @nullable
+     */
+    user_id: string | null;
+    /**
+     * The name this user went by at the time of the operation, recorded alongside the operation itself. It is not refreshed afterwards: the record states who acted then, and a name read today is a statement about a different moment.
+     *
+     * Null on entries recorded before this field existed, and when `actor_type` is `platform`. An empty string means the account had no name recorded.
+     * @nullable
+     */
+    user_name: string | null;
+    /** `user` when a user of the project initiated the operation, `platform` when the platform performed it. */
+    actor_type: OperationLogResourceActorType;
+    created_at: string;
+    /**
+     * Brief reason for the failure; null when `outcome` is `succeeded`
+     * @nullable
+     */
+    failure: string | null;
+    id: OperationLogID;
+    /** Path and query parameters of the request. Fields such as passwords are redacted */
+    payload: OperationLogResourcePayload;
+    region_id: RegionID | null;
+    /** Empty for create operations: the id of the new resource is in the response, not in the request path */
+    subject_id: string;
+    subject_type: string;
+    /** `succeeded` means the operation took effect. `rejected` means it was refused with a 4xx the caller can act on, such as a validation failure, a conflict or an exhausted quota. `failed` means the platform failed to carry it out (5xx). */
+    outcome: OperationLogResourceOutcome;
+}
+export interface OperationLogListResponseBody {
+    items: OperationLogResource[];
+    pagination: OffsetPagination;
+}
+/**
+ * Only available images can install instances. A capture is pending until it finishes, then becomes available. Failed means no usable image was produced; failure describes the outcome. Error means the image service broke the image or no longer holds it, and nothing can be installed from it. A value naming an operation in progress (`suspending`, `resuming`, `deleting`) is shown while that operation runs.
+ */
+export type PrivateImageResourceStatus = (typeof PrivateImageResourceStatus)[keyof typeof PrivateImageResourceStatus];
+export declare const PrivateImageResourceStatus: {
+    readonly pending: "pending";
+    readonly available: "available";
+    readonly deleted: "deleted";
+    readonly failed: "failed";
+    readonly error: "error";
+    readonly suspending: "suspending";
+    readonly resuming: "resuming";
+    readonly deleting: "deleting";
+};
+/**
+ * Why creation failed; null unless `status` is `failed`. `checkout_expired` means checkout was not completed before its Checkout Session expired. `provisioning_failed` means creation failed after the order was accepted, and the charge for this image is refunded.
+ * @nullable
+ */
+export type PrivateImageResourceFailureReason = (typeof PrivateImageResourceFailureReason)[keyof typeof PrivateImageResourceFailureReason] | null;
+export declare const PrivateImageResourceFailureReason: {
+    readonly order_declined: "order_declined";
+    readonly order_canceled: "order_canceled";
+    readonly order_expired: "order_expired";
+    readonly checkout_expired: "checkout_expired";
+    readonly provisioning_failed: "provisioning_failed";
+};
+/**
+ * An image this project captured from one of its instances, used to install instances of this project. Its storage is billed only to this project. Reclaimed for non-payment while instances installed from it remain, it is kept, unusable and no longer charged, and deleted once the last of them is released.
+ */
+export interface PrivateImageResource {
+    id: ImageID;
+    region_id: RegionID;
+    name: string;
+    os_family: string;
+    os_version: string;
+    architecture: string;
+    /**
+     * The account this image lets you log in as. The password set at creation belongs to this account
+     * @maxLength 32
+     */
+    login_username: string;
+    /** The boot volume of an instance created from this image cannot be smaller than this */
+    min_volume_size_gib: number;
+    /** The instance type of an instance created from this image must have at least this much memory */
+    min_memory_mib: number;
+    /** False means a new password can only be set by rebuilding an instance created from this image */
+    supports_password_reset: boolean;
+    /** Only available images can install instances. A capture is pending until it finishes, then becomes available. Failed means no usable image was produced; failure describes the outcome. Error means the image service broke the image or no longer holds it, and nothing can be installed from it. A value naming an operation in progress (`suspending`, `resuming`, `deleting`) is shown while that operation runs. */
+    status: PrivateImageResourceStatus;
+    /**
+     * Details of why the capture failed; non-empty only when `status` is `failed`
+     * @nullable
+     */
+    failure: string | null;
+    /** Storage occupied by the project image, in bytes. Zero until the capture reports its size. It does not change what the image costs. */
+    size_bytes: number;
+    /**
+     * The `position` the image's storage is reported under now, the price Billing gives that position in the region's `private_image_billing` being what it costs. A number from `1`, its place among this project's stored private images in the region counted from the oldest, which moves up whenever an older one is deleted; `legacy` for an image carried over from the previous version, which takes no position and whose storage is never charged. Null while the image is not stored, before its capture finishes and once it is deleted or failed.
+     * @nullable
+     */
+    billing_position: string | null;
+    source_instance_id: InstanceID;
+    created_at: string;
+    /**
+     * Why creation failed; null unless `status` is `failed`. `checkout_expired` means checkout was not completed before its Checkout Session expired. `provisioning_failed` means creation failed after the order was accepted, and the charge for this image is refunded.
+     * @nullable
+     */
+    failure_reason: PrivateImageResourceFailureReason;
+    /**
+     * The Billing Checkout Session that bought this resource; `order_id` and `order_item_id` stay null until its checkout completes. Null when the resource was not bought through one.
+     * @nullable
+     */
+    readonly checkout_session_id: string | null;
+    /**
+     * The Billing order that bought this resource; null until checkout completes.
+     * @nullable
+     */
+    readonly order_id: string | null;
+    /**
+     * The Billing order item for this resource.
+     * @nullable
+     */
+    readonly order_item_id: string | null;
+    /**
+     * The subscription for this resource; its presence alone does not imply delivery.
+     * @nullable
+     */
+    readonly subscription_id: string | null;
+    /** The subscription that pays for this private image, with the resource it pays for, so that a cancellation through Billing can name what it releases. Empty when no subscription pays for it, and once it is released. */
+    release_set: ReleaseSetItem[];
+}
+/**
+ * The private image as it is when the deletion is accepted, and the Billing cancellation that releases it when subscriptions pay for it.
+ */
+export interface DeletePrivateImageResponseBody {
+    private_image: PrivateImageResource;
+    /** The cancellation Compute created for the private image's subscriptions; null when none pays for it. */
+    cancellation: null | BillingCancellation;
+}
+export interface PrivateImageListResponseBody {
+    items: PrivateImageResource[];
+    pagination: OffsetPagination;
+}
+/**
+ * Creation configuration for this resource. Compute project quotas and Billing authorization are checked independently.
+ */
+export interface CreatePrivateImageRequestBody {
+    instance_id: InstanceID;
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name: string;
+    checkout?: CheckoutOptions;
+}
+export interface UpdatePrivateImageRequestBody {
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name: string;
+}
+/**
+ * The new private image, `pending` until its order is accepted, and its Checkout Session.
+ */
+export interface CreatePrivateImageResponseBody {
+    private_image: PrivateImageResource;
+    /** The Billing Checkout Session of this purchase. With deferred checkout, the customer completes it in Billing. */
+    checkout_session_id: string;
+    /**
+     * The order created when checkout completes, at once for automatic checkout; null until then.
+     * @nullable
+     */
+    order_id: string | null;
+}
+/**
+ * `on_sale` images can install new instances. `off_sale` means the platform withdrew the image: it stops new purchases only, and instances already running it keep running and can still be rebuilt onto it.
+ */
+export type PublicImageResourceSaleStatus = (typeof PublicImageResourceSaleStatus)[keyof typeof PublicImageResourceSaleStatus];
+export declare const PublicImageResourceSaleStatus: {
+    readonly on_sale: "on_sale";
+    readonly off_sale: "off_sale";
+};
+/**
+ * A platform image offered to every project to install an instance. It carries no ownership and no billing; its storage is the platform's.
+ */
+export interface PublicImageResource {
+    id: ImageID;
+    region_id: RegionID;
+    name: string;
+    os_family: string;
+    os_version: string;
+    architecture: string;
+    /**
+     * The account this image lets you log in as. The password set at creation belongs to this account
+     * @maxLength 32
+     */
+    login_username: string;
+    /** The boot volume of an instance created from this image cannot be smaller than this */
+    min_volume_size_gib: number;
+    /** The instance type of an instance created from this image must have at least this much memory */
+    min_memory_mib: number;
+    /** False means a new password can only be set by rebuilding an instance created from this image */
+    supports_password_reset: boolean;
+    /** `on_sale` images can install new instances. `off_sale` means the platform withdrew the image: it stops new purchases only, and instances already running it keep running and can still be rebuilt onto it. */
+    sale_status: PublicImageResourceSaleStatus;
+    created_at: string;
+}
+export interface PublicImageListResponseBody {
+    items: PublicImageResource[];
+    pagination: OffsetPagination;
+}
+/**
+ * The resource or capacity constrained by a project quota in a region. Platform defaults: instances=5; vcpus=16; memory_mib=32768; volumes=20; volume_gib=500; virtual_private_clouds=3; virtual_private_cloud_subnets=20; network_interfaces=20; elastic_ips=3; security_groups=10; security_group_rules=100; volume_snapshots=20; volume_backups=20; private_images=20. memory_mib is measured in MiB and volume_gib in GiB. A zero limit permits no additional capacity; it is not unlimited.
+ */
+export type QuotaResourceType = (typeof QuotaResourceType)[keyof typeof QuotaResourceType];
+export declare const QuotaResourceType: {
+    readonly instances: "instances";
+    readonly vcpus: "vcpus";
+    readonly memory_mib: "memory_mib";
+    readonly volumes: "volumes";
+    readonly volume_gib: "volume_gib";
+    readonly virtual_private_clouds: "virtual_private_clouds";
+    readonly virtual_private_cloud_subnets: "virtual_private_cloud_subnets";
+    readonly network_interfaces: "network_interfaces";
+    readonly elastic_ips: "elastic_ips";
+    readonly security_groups: "security_groups";
+    readonly security_group_rules: "security_group_rules";
+    readonly volume_snapshots: "volume_snapshots";
+    readonly volume_backups: "volume_backups";
+    readonly private_images: "private_images";
+};
+/**
+ * Where a limit comes from. `default` is the platform default, which follows a change of the default; `override` is a limit the platform set for this project in this region.
+ */
+export type QuotaSource = (typeof QuotaSource)[keyof typeof QuotaSource];
+export declare const QuotaSource: {
+    readonly default: "default";
+    readonly override: "override";
+};
+/**
+ * The limit in force for one IAM platform project on one resource in one region. This representation contains no usage.
+ */
+export interface ProjectQuota {
+    readonly project_id: string;
+    region_id: RegionID;
+    resource: QuotaResourceType;
+    /** @minimum 0 */
+    readonly limit: number;
+    source: QuotaSource;
+}
+export interface ProjectQuotaListResponseBody {
+    items: ProjectQuota[];
+    pagination: OffsetPagination;
+}
+export interface RegionResource {
+    /** ISO 3166-1 alpha-2 country this region sits in. Two letters, uppercase. */
+    country_code: string;
+    /** Display name for this place, shown to tenants (Hong Kong). The stable handle is code. */
+    name: string;
+    /** The region's code, the way the outside world names this place (hk-1). Stable and human-written; addressing is by id. */
+    code: string;
+    id: RegionID;
+    /** The line every snapshot in this region is, metered on the size it stores. */
+    volume_snapshot_billing: BillingComponent;
+    /** The line every volume backup in this region is, metered on the size it stores. */
+    volume_backup_billing: BillingComponent;
+    /** The line every private image in this region is, metered each second it is stored under its `billing_position`. */
+    private_image_billing: BillingComponent;
+}
+export interface RegionListResponseBody {
+    /** @nullable */
+    items: RegionResource[] | null;
+    pagination: OffsetPagination;
+}
+export type SecurityGroupRuleDirection = (typeof SecurityGroupRuleDirection)[keyof typeof SecurityGroupRuleDirection];
+export declare const SecurityGroupRuleDirection: {
+    readonly ingress: "ingress";
+    readonly egress: "egress";
+};
+export type SecurityGroupRuleIpVersion = (typeof SecurityGroupRuleIpVersion)[keyof typeof SecurityGroupRuleIpVersion];
+export declare const SecurityGroupRuleIpVersion: {
+    readonly NUMBER_4: 4;
+    readonly NUMBER_6: 6;
+};
+export interface SecurityGroupRule {
+    id: SecurityGroupRuleID;
+    security_group_id: SecurityGroupID;
+    direction: SecurityGroupRuleDirection;
+    ip_version: SecurityGroupRuleIpVersion;
+    /**
+     * Null for every protocol.
+     * @nullable
+     */
+    protocol: string | null;
+    /**
+     * The first port, or the ICMP type when the protocol is ICMP. Null for every port.
+     * @nullable
+     */
+    port_range_min: number | null;
+    /**
+     * The last port, or the ICMP code when the protocol is ICMP. Null for every port.
+     * @nullable
+     */
+    port_range_max: number | null;
+    /**
+     * Null for every address.
+     * @nullable
+     */
+    remote_cidr: string | null;
+    description: string;
+    created_at: string;
+}
+export interface SecurityGroupRuleListResponseBody {
+    items: SecurityGroupRule[];
+    pagination: OffsetPagination;
+}
+export type CreateSecurityGroupRuleRequestBodyIpVersion = (typeof CreateSecurityGroupRuleRequestBodyIpVersion)[keyof typeof CreateSecurityGroupRuleRequestBodyIpVersion];
+export declare const CreateSecurityGroupRuleRequestBodyIpVersion: {
+    readonly NUMBER_4: 4;
+    readonly NUMBER_6: 6;
+};
+export interface CreateSecurityGroupRuleRequestBody {
+    direction: SecurityGroupRuleDirection;
+    ip_version: CreateSecurityGroupRuleRequestBodyIpVersion;
+    /**
+     * For example `tcp`, `udp`, `icmp` or `ipv6-icmp`. Every protocol when omitted.
+     * @maxLength 16
+     */
+    protocol?: string;
+    /** The first port, or the ICMP type (0–255) when the protocol is ICMP. Ports need a protocol, and a port range needs both ends; give the same port twice for one port. */
+    port_range_min?: number;
+    /** The last port, or the ICMP code (0–255) when the protocol is ICMP. */
+    port_range_max?: number;
+    /**
+     * A CIDR of the rule's IP version. Every address when omitted.
+     * @maxLength 64
+     */
+    remote_cidr?: string;
+    /** @maxLength 255 */
+    description?: string;
+}
+export interface SecurityGroup {
+    id: SecurityGroupID;
+    virtual_private_cloud_id: VirtualPrivateCloudID;
+    name: string;
+    description: string;
+    /** The default security group goes with its virtual private cloud and cannot be deleted on its own. */
+    is_default: boolean;
+    created_at: string;
+    updated_at: string;
+}
+export interface SecurityGroupListResponseBody {
+    items: SecurityGroup[];
+    pagination: OffsetPagination;
+}
+export interface CreateSecurityGroupRequestBody {
+    virtual_private_cloud_id: VirtualPrivateCloudID;
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name: string;
+    /** @maxLength 500 */
+    description?: string;
+}
+export interface UpdateSecurityGroupRequestBody {
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name?: string;
+    /** @maxLength 500 */
+    description?: string;
+}
+/**
+ * The accepter project's decision. `pending` until it decides; `accept-virtual-private-cloud-peering` and `reject-virtual-private-cloud-peering` make it `accepted` or `rejected`. A rejected peering is `deleted`.
+ */
+export type VirtualPrivateCloudPeeringResourceAcceptance = (typeof VirtualPrivateCloudPeeringResourceAcceptance)[keyof typeof VirtualPrivateCloudPeeringResourceAcceptance];
+export declare const VirtualPrivateCloudPeeringResourceAcceptance: {
+    readonly pending: "pending";
+    readonly accepted: "accepted";
+    readonly rejected: "rejected";
+};
+/**
+ * `pending` until the connectivity exists: while acceptance is pending, and after it is accepted while the link is built (`provisioning`). Then `active`. `failed` means the link could not be built; `failure_reason` states why. `deleted` once deleted or rejected. `deleting` runs until the link and its peer routes are gone.
+ */
+export type VirtualPrivateCloudPeeringResourceStatus = (typeof VirtualPrivateCloudPeeringResourceStatus)[keyof typeof VirtualPrivateCloudPeeringResourceStatus];
+export declare const VirtualPrivateCloudPeeringResourceStatus: {
+    readonly pending: "pending";
+    readonly active: "active";
+    readonly deleted: "deleted";
+    readonly failed: "failed";
+    readonly provisioning: "provisioning";
+    readonly deleting: "deleting";
+};
+export interface VirtualPrivateCloudPeeringResource {
+    id: VirtualPrivateCloudPeeringID;
+    name: string;
+    region_id: RegionID;
+    requester_project_id: string;
+    accepter_project_id: string;
+    requester_virtual_private_cloud_id: VirtualPrivateCloudID;
+    accepter_virtual_private_cloud_id: VirtualPrivateCloudID;
+    /** The accepter project's decision. `pending` until it decides; `accept-virtual-private-cloud-peering` and `reject-virtual-private-cloud-peering` make it `accepted` or `rejected`. A rejected peering is `deleted`. */
+    acceptance: VirtualPrivateCloudPeeringResourceAcceptance;
+    /** `pending` until the connectivity exists: while acceptance is pending, and after it is accepted while the link is built (`provisioning`). Then `active`. `failed` means the link could not be built; `failure_reason` states why. `deleted` once deleted or rejected. `deleting` runs until the link and its peer routes are gone. */
+    status: VirtualPrivateCloudPeeringResourceStatus;
+    created_at: string;
+    /**
+     * Why provisioning failed; null unless `status` is `failed`.
+     * @nullable
+     */
+    failure_reason: string | null;
+}
+export interface VirtualPrivateCloudPeeringListResponseBody {
+    items: VirtualPrivateCloudPeeringResource[];
+    pagination: OffsetPagination;
+}
+export interface CreateVirtualPrivateCloudPeeringRequestBody {
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name: string;
+    requester_virtual_private_cloud_id: VirtualPrivateCloudID;
+    accepter_project_id: string;
+    accepter_virtual_private_cloud_id: VirtualPrivateCloudID;
+}
+/**
+ * Who put the route there. A `tenant` route is created and deleted by the project; a `peering` route is installed by an active peering and removed with it.
+ */
+export type VirtualPrivateCloudRouteType = (typeof VirtualPrivateCloudRouteType)[keyof typeof VirtualPrivateCloudRouteType];
+export declare const VirtualPrivateCloudRouteType: {
+    readonly tenant: "tenant";
+    readonly peering: "peering";
+};
+export interface VirtualPrivateCloudRouteResource {
+    id: VirtualPrivateCloudRouteID;
+    virtual_private_cloud_id: VirtualPrivateCloudID;
+    type: VirtualPrivateCloudRouteType;
+    destination_cidr: string;
+    /**
+     * The private address traffic is sent to. Null for a peering route, whose next hop is the platform's side of the peering link.
+     * @nullable
+     */
+    next_hop_address: string | null;
+    /** The peering that wrote the route, null for a tenant route. */
+    virtual_private_cloud_peering_id: VirtualPrivateCloudPeeringID | null;
+    description: string;
+    created_at: string;
+}
+export interface VirtualPrivateCloudRouteListResponseBody {
+    items: VirtualPrivateCloudRouteResource[];
+    pagination: OffsetPagination;
+}
+export interface CreateVirtualPrivateCloudRouteRequestBody {
+    /**
+     * Destination CIDR. It cannot be `0.0.0.0/0`, nor the CIDR of a subnet of the virtual private cloud.
+     * @minLength 1
+     * @maxLength 32
+     */
+    destination_cidr: string;
+    /**
+     * Private address of an instance, inside a subnet of the virtual private cloud.
+     * @minLength 1
+     * @maxLength 64
+     */
+    next_hop_address: string;
+    /** @maxLength 255 */
+    description?: string;
+}
+export interface VirtualPrivateCloudSubnet {
+    id: SubnetID;
+    virtual_private_cloud_id: VirtualPrivateCloudID;
+    name: string;
+    /** The subnet's IPv4 range. */
+    ipv4_cidr: string;
+    /**
+     * The IPv4 gateway address of the subnet.
+     * @nullable
+     */
+    ipv4_gateway_address: string | null;
+    /**
+     * The subnet's /64, from the virtual private cloud's /56; null while IPv6 is not enabled on the virtual private cloud. A network interface created in the subnet takes an address of it that is never handed out again within the subnet.
+     * @nullable
+     */
+    ipv6_cidr: string | null;
+    /**
+     * The IPv6 gateway address of the subnet, the first address of its /64; null without IPv6.
+     * @nullable
+     */
+    ipv6_gateway_address: string | null;
+    created_at: string;
+    updated_at: string;
+}
+export interface VirtualPrivateCloudSubnetListResponseBody {
+    items: VirtualPrivateCloudSubnet[];
+    pagination: OffsetPagination;
+}
+export interface CreateVirtualPrivateCloudSubnetRequestBody {
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name: string;
+    /**
+     * An IPv4 CIDR inside the virtual private cloud's CIDR, overlapping no other subnet of it.
+     * @minLength 1
+     * @maxLength 32
+     */
+    ipv4_cidr: string;
+}
+export interface UpdateVirtualPrivateCloudSubnetRequestBody {
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name?: string;
+}
+/**
+ * `available` from creation: the network and router are created in the backend by the first member that needs them, so a virtual private cloud nothing uses holds no capacity there. `failed` means the cloud reports the network broken; instances cannot be created in it then and are refused with `VIRTUAL_PRIVATE_CLOUD_UNAVAILABLE`. `deleting` from the moment its deletion began until it is gone: subnets, security groups and routes in it can no longer be created, changed or deleted, and are refused with `VIRTUAL_PRIVATE_CLOUD_DELETING`. A deletion that stopped before the end leaves it `deleting`, and deleting it again resumes from where it stopped. `creating`, `enabling_ipv6` and `disabling_ipv6` name operations in progress; the network refuses another operation until they end.
+ */
+export type VirtualPrivateCloudStatus = (typeof VirtualPrivateCloudStatus)[keyof typeof VirtualPrivateCloudStatus];
+export declare const VirtualPrivateCloudStatus: {
+    readonly available: "available";
+    readonly deleting: "deleting";
+    readonly failed: "failed";
+    readonly creating: "creating";
+    readonly enabling_ipv6: "enabling_ipv6";
+    readonly disabling_ipv6: "disabling_ipv6";
+};
+export interface VirtualPrivateCloud {
+    id: VirtualPrivateCloudID;
+    region_id: RegionID;
+    name: string;
+    ipv4_cidr: string;
+    /**
+     * The /56 routed to the virtual private cloud, from which each of its subnets takes a /64; null while IPv6 is not enabled.
+     * @nullable
+     */
+    ipv6_cidr: string | null;
+    /** `available` from creation: the network and router are created in the backend by the first member that needs them, so a virtual private cloud nothing uses holds no capacity there. `failed` means the cloud reports the network broken; instances cannot be created in it then and are refused with `VIRTUAL_PRIVATE_CLOUD_UNAVAILABLE`. `deleting` from the moment its deletion began until it is gone: subnets, security groups and routes in it can no longer be created, changed or deleted, and are refused with `VIRTUAL_PRIVATE_CLOUD_DELETING`. A deletion that stopped before the end leaves it `deleting`, and deleting it again resumes from where it stopped. `creating`, `enabling_ipv6` and `disabling_ipv6` name operations in progress; the network refuses another operation until they end. */
+    status: VirtualPrivateCloudStatus;
+    created_at: string;
+    updated_at: string;
+}
+export interface VirtualPrivateCloudListResponseBody {
+    items: VirtualPrivateCloud[];
+    pagination: OffsetPagination;
+}
+export interface CreateVirtualPrivateCloudRequestBody {
+    region_id: RegionID;
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name: string;
+    /**
+     * An RFC 1918 private CIDR with a prefix length between /8 and /24, for example `10.0.0.0/16`.
+     * @minLength 1
+     * @maxLength 32
+     */
+    ipv4_cidr: string;
+}
+export interface UpdateVirtualPrivateCloudRequestBody {
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name?: string;
+}
+export interface FreeSubnetCidr {
+    prefix_length: number;
+    /**
+     * Null when no CIDR of that prefix length is free.
+     * @nullable
+     */
+    ipv4_cidr: string | null;
+}
+/**
+ * `pending` from the purchase until the backup is taken, then `available`. `failed` means the backup was not created. A value naming an operation in progress (`restoring`, `deleting`) is shown while that operation runs; the backup refuses another operation until it ends.
+ */
+export type VolumeBackupResourceStatus = (typeof VolumeBackupResourceStatus)[keyof typeof VolumeBackupResourceStatus];
+export declare const VolumeBackupResourceStatus: {
+    readonly pending: "pending";
+    readonly available: "available";
+    readonly deleted: "deleted";
+    readonly failed: "failed";
+    readonly error: "error";
+    readonly restoring: "restoring";
+    readonly deleting: "deleting";
+};
+/**
+ * Why creation failed; null unless `status` is `failed`. `checkout_expired` means checkout was not completed before its Checkout Session expired. `provisioning_failed` means creation failed after the order was accepted, and the charge for this backup is refunded.
+ * @nullable
+ */
+export type VolumeBackupResourceFailureReason = (typeof VolumeBackupResourceFailureReason)[keyof typeof VolumeBackupResourceFailureReason] | null;
+export declare const VolumeBackupResourceFailureReason: {
+    readonly order_declined: "order_declined";
+    readonly order_canceled: "order_canceled";
+    readonly order_expired: "order_expired";
+    readonly checkout_expired: "checkout_expired";
+    readonly provisioning_failed: "provisioning_failed";
+};
+/**
+ * A retained copy of a volume, restorable after its source volume is deleted. Compute project quotas constrain its count; retained storage is metered independently.
+ */
+export interface VolumeBackupResource {
+    created_at: string;
+    id: VolumeBackupID;
+    name: string;
+    region_id: RegionID;
+    /** Capacity of the source volume when the backup was created. A restored volume cannot be smaller than this */
+    size_gib: number;
+    /** The capacity metered for this backup, in GiB: the size of the source volume when the backup was taken. Usage is this capacity multiplied by the time the backup is retained. */
+    capacity_gib: number;
+    source_volume_id: VolumeID;
+    /** `pending` from the purchase until the backup is taken, then `available`. `failed` means the backup was not created. A value naming an operation in progress (`restoring`, `deleting`) is shown while that operation runs; the backup refuses another operation until it ends. */
+    status: VolumeBackupResourceStatus;
+    source_availability_zone_id: AvailabilityZoneID;
+    /**
+     * Why creation failed; null unless `status` is `failed`. `checkout_expired` means checkout was not completed before its Checkout Session expired. `provisioning_failed` means creation failed after the order was accepted, and the charge for this backup is refunded.
+     * @nullable
+     */
+    failure_reason: VolumeBackupResourceFailureReason;
+    /**
+     * The Billing Checkout Session that bought this resource; `order_id` and `order_item_id` stay null until its checkout completes. Null when the resource was not bought through one.
+     * @nullable
+     */
+    readonly checkout_session_id: string | null;
+    /**
+     * The Billing order that bought this resource; null until checkout completes.
+     * @nullable
+     */
+    readonly order_id: string | null;
+    /**
+     * The Billing order item for this resource.
+     * @nullable
+     */
+    readonly order_item_id: string | null;
+    /**
+     * The subscription for this resource; its presence alone does not imply delivery.
+     * @nullable
+     */
+    readonly subscription_id: string | null;
+    /** The subscription that pays for this volume backup, with the resource it pays for, so that a cancellation through Billing can name what it releases. Empty when no subscription pays for it, and once it is released. */
+    release_set: ReleaseSetItem[];
+}
+/**
+ * The volume backup as it is when the deletion is accepted, and the Billing cancellation that releases it when subscriptions pay for it.
+ */
+export interface DeleteVolumeBackupResponseBody {
+    volume_backup: VolumeBackupResource;
+    /** The cancellation Compute created for the volume backup's subscriptions; null when none pays for it. */
+    cancellation: null | BillingCancellation;
+}
+export interface VolumeBackupListResponseBody {
+    /** @nullable */
+    items: VolumeBackupResource[] | null;
+    pagination: OffsetPagination;
+}
+export interface CreateVolumeBackupRequestBody {
+    volume_id: VolumeID;
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name: string;
+    checkout?: CheckoutOptions;
+}
+/**
+ * The mutable fields of a volume backup. At least one must be given.
+ */
+export interface UpdateVolumeBackupRequestBody {
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name?: string;
+}
+/**
+ * The new backup, `pending` until its order is accepted, and its Checkout Session.
+ */
+export interface CreateVolumeBackupResponseBody {
+    volume_backup: VolumeBackupResource;
+    /** The Billing Checkout Session of this purchase. With deferred checkout, the customer completes it in Billing. */
+    checkout_session_id: string;
+    /**
+     * The order created when checkout completes, at once for automatic checkout; null until then.
+     * @nullable
+     */
+    order_id: string | null;
+}
+/**
+ * `pending` once a quota slot is reserved and until the snapshot is taken; then `available`. `failed` means the snapshot was not created; its slot is released once no snapshot data remains. `error` means the cloud reports the snapshot broken. A value naming an operation in progress (`restoring`, `deleting`) is shown while that operation runs; the snapshot refuses another operation until it ends.
+ */
+export type VolumeSnapshotResourceStatus = (typeof VolumeSnapshotResourceStatus)[keyof typeof VolumeSnapshotResourceStatus];
+export declare const VolumeSnapshotResourceStatus: {
+    readonly pending: "pending";
+    readonly available: "available";
+    readonly deleted: "deleted";
+    readonly failed: "failed";
+    readonly error: "error";
+    readonly restoring: "restoring";
+    readonly deleting: "deleting";
+};
+/**
+ * Why creation failed; null unless `status` is `failed`. `checkout_expired` means checkout was not completed before its Checkout Session expired. `provisioning_failed` means creation failed after the order was accepted, and the charge for this snapshot is refunded.
+ * @nullable
+ */
+export type VolumeSnapshotResourceFailureReason = (typeof VolumeSnapshotResourceFailureReason)[keyof typeof VolumeSnapshotResourceFailureReason] | null;
+export declare const VolumeSnapshotResourceFailureReason: {
+    readonly order_declined: "order_declined";
+    readonly order_canceled: "order_canceled";
+    readonly order_expired: "order_expired";
+    readonly checkout_expired: "checkout_expired";
+    readonly provisioning_failed: "provisioning_failed";
+};
+/**
+ * A snapshot of a volume. Compute project quotas constrain its count; retained storage is metered independently of that quota.
+ */
+export interface VolumeSnapshotResource {
+    availability_zone_id: AvailabilityZoneID;
+    created_at: string;
+    volume_id: VolumeID;
+    id: VolumeSnapshotID;
+    name: string;
+    region_id: RegionID;
+    /** Capacity of the source volume when the snapshot was created. A volume restored from it cannot be smaller */
+    size_gib: number;
+    /** `pending` once a quota slot is reserved and until the snapshot is taken; then `available`. `failed` means the snapshot was not created; its slot is released once no snapshot data remains. `error` means the cloud reports the snapshot broken. A value naming an operation in progress (`restoring`, `deleting`) is shown while that operation runs; the snapshot refuses another operation until it ends. */
+    status: VolumeSnapshotResourceStatus;
+    /**
+     * Why creation failed; null unless `status` is `failed`. `checkout_expired` means checkout was not completed before its Checkout Session expired. `provisioning_failed` means creation failed after the order was accepted, and the charge for this snapshot is refunded.
+     * @nullable
+     */
+    failure_reason: VolumeSnapshotResourceFailureReason;
+    /**
+     * The Billing Checkout Session that bought this resource; `order_id` and `order_item_id` stay null until its checkout completes. Null when the resource was not bought through one.
+     * @nullable
+     */
+    readonly checkout_session_id: string | null;
+    /**
+     * The Billing order that bought this resource; null until checkout completes.
+     * @nullable
+     */
+    readonly order_id: string | null;
+    /**
+     * The Billing order item for this resource.
+     * @nullable
+     */
+    readonly order_item_id: string | null;
+    /**
+     * The subscription for this resource; its presence alone does not imply delivery.
+     * @nullable
+     */
+    readonly subscription_id: string | null;
+    /** The subscription that pays for this snapshot, with the resource it pays for, so that a cancellation through Billing can name what it releases. Empty when no subscription pays for it, and once it is released. */
+    release_set: ReleaseSetItem[];
+}
+/**
+ * The snapshot as it is when the deletion is accepted, and the Billing cancellation that releases it when subscriptions pay for it.
+ */
+export interface DeleteVolumeSnapshotResponseBody {
+    volume_snapshot: VolumeSnapshotResource;
+    /** The cancellation Compute created for the snapshot's subscriptions; null when none pays for it. */
+    cancellation: null | BillingCancellation;
+}
+export interface VolumeSnapshotListResponseBody {
+    /** @nullable */
+    items: VolumeSnapshotResource[] | null;
+    pagination: OffsetPagination;
+}
+/**
+ * Creation configuration for this resource. Compute project quotas and Billing authorization are checked independently.
+ */
+export interface CreateVolumeSnapshotRequestBody {
+    volume_id: VolumeID;
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name: string;
+    checkout?: CheckoutOptions;
+}
+/**
+ * The mutable fields of a snapshot. At least one must be given.
+ */
+export interface UpdateVolumeSnapshotRequestBody {
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name?: string;
+}
+/**
+ * The new snapshot, `pending` until its order is accepted, and its Checkout Session.
+ */
+export interface CreateVolumeSnapshotResponseBody {
+    volume_snapshot: VolumeSnapshotResource;
+    /** The Billing Checkout Session of this purchase. With deferred checkout, the customer completes it in Billing. */
+    checkout_session_id: string;
+    /**
+     * The order created when checkout completes, at once for automatic checkout; null until then.
+     * @nullable
+     */
+    order_id: string | null;
+}
+/**
+ * `sold_out` takes no new orders for now while the type stays listed; the volumes already of it keep working.
+ */
+export type VolumeTypeResourceSaleStatus = (typeof VolumeTypeResourceSaleStatus)[keyof typeof VolumeTypeResourceSaleStatus];
+export declare const VolumeTypeResourceSaleStatus: {
+    readonly on_sale: "on_sale";
+    readonly sold_out: "sold_out";
+};
+export type VolumeTypeResourceMedium = (typeof VolumeTypeResourceMedium)[keyof typeof VolumeTypeResourceMedium];
+export declare const VolumeTypeResourceMedium: {
+    readonly ssd: "ssd";
+    readonly hdd: "hdd";
+    readonly nvme: "nvme";
+};
+/**
+ * One performance metric of a volume type for a volume of `size_gib`, `max(min, min(max, base + size_gib × per_gib))`. A `per_gib` of zero is a fixed performance, and a `min` of zero is no floor.
+ */
+export interface PerformanceFormula {
+    min: number;
+    base: number;
+    per_gib: number;
+    max: number;
+}
+/**
+ * How fast a volume of this type runs for its size. Alibaba Cloud's ESSD volumes have this shape: PL1 is IOPS `min(50000, 1800 + 50 × size_gib)`, and AutoPL's baseline adds a floor, `max(3000, min(50000, 1800 + 50 × size_gib))`.
+ *
+ * A volume's own performance, computed from these for its size, is on the volume. Growing a volume raises it, and the new performance applies from the volume's next attachment or the next start of its stopped instance.
+ */
+export interface VolumeTypePerformance {
+    iops: PerformanceFormula;
+    throughput_bytes_per_second: PerformanceFormula;
+}
+export interface VolumeTypeResource {
+    availability_zone_id: AvailabilityZoneID;
+    /** `sold_out` takes no new orders for now while the type stays listed; the volumes already of it keep working. */
+    sale_status: VolumeTypeResourceSaleStatus;
+    id: VolumeTypeID;
+    max_size_gib: number;
+    medium: VolumeTypeResourceMedium;
+    min_size_gib: number;
+    name: string;
+    region_id: RegionID;
+    size_step_gib: number;
+    performance: VolumeTypePerformance;
+    /** The line a volume of this type is, whether bought on its own or as the boot volume or a data volume of an instance. A volume bought on its own is licensed only. */
+    billing: BillingComponent;
+}
+export interface VolumeTypeListResponseBody {
+    items: VolumeTypeResource[];
+    pagination: OffsetPagination;
+}
+/**
+ * A volume's limits.
+ */
+export interface VolumePerformance {
+    iops: number;
+    throughput_bytes_per_second: number;
+}
+/**
+ * `pending` until the volume is created, with no storage allocated before the order is accepted; then `available`, or `in_use` once attached. `failed` means the volume was not created; `failure_reason` states why. `error` means the cloud reports the volume broken. A value naming an operation in progress (`resizing`, `retyping`, `reverting`, `attaching`, `detaching`, `suspending`, `resuming`, `deleting`) is shown while that operation runs; the volume refuses another operation until it ends.
+ */
+export type VolumeResourceStatus = (typeof VolumeResourceStatus)[keyof typeof VolumeResourceStatus];
+export declare const VolumeResourceStatus: {
+    readonly pending: "pending";
+    readonly available: "available";
+    readonly in_use: "in_use";
+    readonly deleted: "deleted";
+    readonly failed: "failed";
+    readonly error: "error";
+    readonly resizing: "resizing";
+    readonly retyping: "retyping";
+    readonly reverting: "reverting";
+    readonly attaching: "attaching";
+    readonly detaching: "detaching";
+    readonly suspending: "suspending";
+    readonly resuming: "resuming";
+    readonly deleting: "deleting";
+};
+/**
+ * @nullable
+ */
+export type VolumeResourceAccessState = (typeof VolumeResourceAccessState)[keyof typeof VolumeResourceAccessState] | null;
+export declare const VolumeResourceAccessState: {
+    readonly pending: "pending";
+    readonly enabled: "enabled";
+    readonly suspended: "suspended";
+    readonly reclaimed: "reclaimed";
+};
+/**
+ * Why creation failed; null unless `status` is `failed`. `checkout_expired` means checkout was not completed before its Checkout Session expired. `provisioning_failed` means creation failed after the order was accepted, and the charge for this volume is refunded.
+ * @nullable
+ */
+export type VolumeResourceFailureReason = (typeof VolumeResourceFailureReason)[keyof typeof VolumeResourceFailureReason] | null;
+export declare const VolumeResourceFailureReason: {
+    readonly order_declined: "order_declined";
+    readonly order_canceled: "order_canceled";
+    readonly order_expired: "order_expired";
+    readonly checkout_expired: "checkout_expired";
+    readonly provisioning_failed: "provisioning_failed";
+};
+export type VolumeAttachmentRole = (typeof VolumeAttachmentRole)[keyof typeof VolumeAttachmentRole];
+export declare const VolumeAttachmentRole: {
+    readonly boot: "boot";
+    readonly data: "data";
+};
+/**
+ * What releasing the instance does to this volume. `delete` deletes it together with the instance; `detach` detaches it and leaves it to you. A volume you attached, or booted the instance from, is `detach`; a volume bought with the instance follows the choice made when it was bought.
+ */
+export type VolumeAttachmentOnInstanceRelease = (typeof VolumeAttachmentOnInstanceRelease)[keyof typeof VolumeAttachmentOnInstanceRelease];
+export declare const VolumeAttachmentOnInstanceRelease: {
+    readonly delete: "delete";
+    readonly detach: "detach";
+};
+export type VolumeAttachmentState = (typeof VolumeAttachmentState)[keyof typeof VolumeAttachmentState];
+export declare const VolumeAttachmentState: {
+    readonly reserved: "reserved";
+    readonly attached: "attached";
+    readonly released: "released";
+};
+export interface VolumeAttachment {
+    id: InstanceVolumeID;
+    instance_id: InstanceID;
+    volume_id: VolumeID;
+    role: VolumeAttachmentRole;
+    /** What releasing the instance does to this volume. `delete` deletes it together with the instance; `detach` detaches it and leaves it to you. A volume you attached, or booted the instance from, is `detach`; a volume bought with the instance follows the choice made when it was bought. */
+    on_instance_release: VolumeAttachmentOnInstanceRelease;
+    state: VolumeAttachmentState;
+    /** @nullable */
+    attached_at: string | null;
+    /** @nullable */
+    detached_at: string | null;
+    /** @nullable */
+    released_at: string | null;
+    /** @nullable */
+    device: string | null;
+    /** The volume's performance in effect on this attachment, as it was when the attachment was made. Null until the attachment is made. */
+    performance: VolumePerformance | null;
+}
+export interface VolumeResource {
+    availability_zone_id: AvailabilityZoneID;
+    created_at: string;
+    volume_type_id: VolumeTypeID;
+    id: VolumeID;
+    name: string;
+    region_id: RegionID;
+    size_gib: number;
+    performance: VolumePerformance;
+    /** `pending` until the volume is created, with no storage allocated before the order is accepted; then `available`, or `in_use` once attached. `failed` means the volume was not created; `failure_reason` states why. `error` means the cloud reports the volume broken. A value naming an operation in progress (`resizing`, `retyping`, `reverting`, `attaching`, `detaching`, `suspending`, `resuming`, `deleting`) is shown while that operation runs; the volume refuses another operation until it ends. */
+    status: VolumeResourceStatus;
+    /**
+     * The Billing Checkout Session that bought this resource; `order_id` and `order_item_id` stay null until its checkout completes. Null when the resource was not bought through one.
+     * @nullable
+     */
+    readonly checkout_session_id: string | null;
+    /** @nullable */
+    order_id: string | null;
+    /**
+     * The Billing order item for this resource.
+     * @nullable
+     */
+    order_item_id: string | null;
+    /**
+     * The Billing subscription associated with this resource. It may still be pending; its
+     * presence does not imply delivery or metering. Null when no subscription is associated.
+     * @nullable
+     */
+    subscription_id: string | null;
+    /** The subscriptions a cancellation through Billing has to cover to release this volume: its own, each with the resource it pays for, so that each line of a cancellation can name what it releases. Snapshots have no individual subscriptions. A boot volume is released only with its instance, so for a boot volume the set is that of the instance. Subscriptions that have ended are not listed, and the set is empty when no subscription pays for any of them. */
+    release_set: ReleaseSetItem[];
+    /** @nullable */
+    access_state: VolumeResourceAccessState;
+    /**
+     * Why creation failed; null unless `status` is `failed`. `checkout_expired` means checkout was not completed before its Checkout Session expired. `provisioning_failed` means creation failed after the order was accepted, and the charge for this volume is refunded.
+     * @nullable
+     */
+    failure_reason: VolumeResourceFailureReason;
+    attachment: VolumeAttachment | null;
+}
+/**
+ * The volume as it is when the deletion is accepted, and the Billing cancellation that releases it when subscriptions pay for it.
+ */
+export interface DeleteVolumeResponseBody {
+    volume: VolumeResource;
+    /** The cancellation Compute created for the volume's subscriptions; null when none pays for it. */
+    cancellation: null | BillingCancellation;
+}
+export interface VolumeListResponseBody {
+    /** @nullable */
+    items: VolumeResource[] | null;
+    pagination: OffsetPagination;
+}
+export interface CreateVolumeRequestBody {
+    volume_type_id: VolumeTypeID;
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name: string;
+    /**
+     * Required unless `volume_backup_id` is given. With `volume_snapshot_id` it need only be no smaller than the snapshot; with `volume_backup_id` it defaults to the size of the backup and must not be smaller than it
+     * @minimum 1
+     */
+    size_gib?: number;
+    volume_snapshot_id?: VolumeSnapshotID;
+    volume_backup_id?: VolumeBackupID;
+    billing: BillingChoice;
+    checkout?: CheckoutOptions;
+}
+/**
+ * The mutable fields of a volume, all optional, at least one required. `size_gib` and `volume_type_id` are operational fields and cannot be combined with each other or with `name`; such a request is refused with 422 `UPDATE_FIELDS_COMBINED`.
+ */
+export interface UpdateVolumeRequestBody {
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name?: string;
+    /**
+     * The new capacity. Must be larger than the current capacity
+     * @minimum 1
+     */
+    size_gib?: number;
+    volume_type_id?: VolumeTypeID;
+    /** The `proration_date` of the Billing quote for this change, so that the order is priced from the same instant. Only with `size_gib` or `volume_type_id`, and only for automatic checkout; deferred checkout is priced when the customer completes it. Defaults to the time of the request; it must be a whole second, not in the future and at most 10 minutes old, otherwise the request is refused with `BILLING_CHANGE_INVALID`. */
+    proration_date?: string;
+    checkout?: CheckoutOptions;
+}
+export interface RevertVolumeRequestBody {
+    volume_snapshot_id: VolumeSnapshotID;
+}
+export interface AttachVolumeRequestBody {
+    volume_id: VolumeID;
+}
+/**
+ * The new volume, `pending` until its order is accepted, and its Checkout Session. Also returned for a volume restored
+ * from a snapshot or a volume backup.
+ */
+export interface CreateVolumeResponseBody {
+    volume: VolumeResource;
+    /** The Billing Checkout Session of this purchase. With deferred checkout, the customer completes it in Billing. */
+    checkout_session_id: string;
+    /**
+     * The order created when checkout completes, at once for automatic checkout; null until then.
+     * @nullable
+     */
+    order_id: string | null;
+}
+/**
+ * The volume and, when the update placed a Billing order, the Checkout Session for it. After a resize the volume is still at its current size until the change is applied. Returned with 200 when only descriptive fields changed and with 202 when an operation started.
+ */
+export interface UpdateVolumeResponseBody {
+    volume: VolumeResource;
+    /**
+     * The Billing Checkout Session of the purchase; null when the update placed no order. With deferred checkout, the customer completes it in Billing.
+     * @nullable
+     */
+    checkout_session_id: string | null;
+    /**
+     * The order created when checkout completes, at once for automatic checkout; null until then and when the update placed no order.
+     * @nullable
+     */
+    order_id: string | null;
+}
+export interface VolumeAttachmentList {
+    items: VolumeAttachment[];
+    pagination: OffsetPagination;
+}
+/**
+ * Pagination metadata for keyset traversal. Pass next_cursor as cursor to read the following page; null means there is no following page.
+ */
+export interface CursorPagination {
+    /** @minimum 1 */
+    page_size: number;
+    /** @nullable */
+    next_cursor?: string | null;
+}
+export interface FieldViolation {
+    /** The path to the rejected field in the request body, such as `items[2].price_id`. */
+    field: string;
+    /** Why the field was rejected, such as `REQUIRED` or `OUT_OF_RANGE`. */
+    reason?: string;
+}
+/**
+ * Values that belong to `reason`, one set per reason. Clients use them to fill in
+ * localized text and never parse `message` to obtain them. Keys are documented per
+ * reason; a key that has appeared once keeps appearing.
+ */
+export type ErrorStatusMetadata = {
+    [key: string]: string;
+};
+export interface ErrorStatus {
+    /** The HTTP status code of the response. */
+    code: number;
+    /** The canonical name of the status, such as `INVALID_ARGUMENT` or `UNAVAILABLE`. */
+    status: string;
+    /**
+     * A description of the failure for developers. It is always English and is not meant
+     * to be shown to end users as is.
+     */
+    message: string;
+    /**
+     * A stable machine-readable code identifying the failure. Clients branch on this value
+     * and render their own text; it does not change once published.
+     */
+    reason?: string;
+    /**
+     * Values that belong to `reason`, one set per reason. Clients use them to fill in
+     * localized text and never parse `message` to obtain them. Keys are documented per
+     * reason; a key that has appeared once keeps appearing.
+     */
+    metadata?: ErrorStatusMetadata;
+    /**
+     * Request fields rejected by the request's constraints. Present on validation
+     * failures; one request may violate several fields.
+     */
+    field_violations?: FieldViolation[];
+    /**
+     * How long the client should wait before retrying, as a duration string such as
+     * `30s`. Present only when waiting can succeed.
+     */
+    retry_delay?: string;
+    /**
+     * The identifier of the request in the service's logs. Quote it when reporting a
+     * failure.
+     */
+    request_id?: string;
+}
+/**
+ * A failed request. The envelope follows the Google REST error format: `code` is the HTTP
+ * status, `status` is its canonical name, and `reason` is the stable machine-readable code
+ * that identifies the failure.
+ */
+export interface Error {
+    error: ErrorStatus;
+}
+/**
+ * The request conflicts with the current state of a resource or offering it involves. `COMPUTE_RESOURCE_BUSY`
+ * means a resource has an operation in progress: `meta.resource_type`, such as `instance` or `elastic_ip`, and
+ * `meta.resource_id` name it, and `meta.operation` is the type of that operation, which the resource's `status` also names while it runs.
+ * Retry once it has finished. Other codes, such as `BILLING_OPTION_UNAVAILABLE`, are described where they
+ * apply.
+ */
+export type ConflictResponse = Error;
+export type CancellationModeParameter = CancellationMode;
+export type ListAvailabilityZonesParams = {
+    /**
+     * Return only the zones of this region
+     */
+    region_id?: RegionID;
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type ListElasticIpLinesParams = {
+    region_id?: RegionID;
+    /**
+     * Search text matched against line names and descriptions; combined with the other filters using AND.
+     * @minLength 1
+     * @maxLength 255
+     */
+    q?: string;
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type ListElasticIpsParams = {
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type DeleteElasticIpParams = {
+    /**
+     * When subscriptions end. immediate ends them now and refunds the unused value under their refund terms; period_end
+     * ends them at the end of their paid period. The cancellation terms fixed when a subscription was bought decide which
+     * modes it allows: a pay-as-you-go subscription ends only immediately, and a prepaid one whose terms allow only the
+     * end of its paid period ends only then. Billing refuses a mode the terms do not allow with HTTP 422
+     * BILLING_CANCELLATION_MODE_FIXED.
+     */
+    cancellation_mode?: CancellationModeParameter;
+};
+export type ListElasticIpTrafficUsageParams = {
+    interval?: ListElasticIpTrafficUsageInterval;
+    start_time: string;
+    end_time: string;
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type ListElasticIpTrafficUsageInterval = (typeof ListElasticIpTrafficUsageInterval)[keyof typeof ListElasticIpTrafficUsageInterval];
+export declare const ListElasticIpTrafficUsageInterval: {
+    readonly hour: "hour";
+    readonly day: "day";
+};
+export type ListInstanceFamiliesParams = {
+    region_id?: RegionID;
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type ListInstanceTypesParams = {
+    region_id?: RegionID;
+    /**
+     * Return only the types of this instance family.
+     */
+    instance_family_id?: InstanceFamilyID;
+    /**
+     * Return only the types of this availability zone, sold out or not.
+     */
+    availability_zone_id?: AvailabilityZoneID;
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type ListInstancesParams = {
+    /**
+     * A label to filter by, written as `key:value`
+     * @maxLength 128
+     */
+    label?: string;
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type DeleteInstanceParams = {
+    /**
+     * When subscriptions end. immediate ends them now and refunds the unused value under their refund terms; period_end
+     * ends them at the end of their paid period. The cancellation terms fixed when a subscription was bought decide which
+     * modes it allows: a pay-as-you-go subscription ends only immediately, and a prepaid one whose terms allow only the
+     * end of its paid period ends only then. Billing refuses a mode the terms do not allow with HTTP 422
+     * BILLING_CANCELLATION_MODE_FIXED.
+     */
+    cancellation_mode?: CancellationModeParameter;
+};
+export type ListInstanceVolumesParams = {
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type ListInstanceNetworkInterfacesParams = {
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type ListLaunchTemplatesParams = {
+    /**
+     * Only launch templates of this region.
+     */
+    region_id?: RegionID;
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type ListLaunchTemplateVersionsParams = {
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type ListNetworkInterfacesParams = {
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type ListOperationLogsParams = {
+    /**
+     * Return a single kind of operation; the value matches the operation id of the endpoint
+     * @maxLength 64
+     */
+    action?: string;
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type ListPrivateImagesParams = {
+    /**
+     * Return only the images of this region
+     */
+    region_id?: RegionID;
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type DeletePrivateImageParams = {
+    /**
+     * When subscriptions end. immediate ends them now and refunds the unused value under their refund terms; period_end
+     * ends them at the end of their paid period. The cancellation terms fixed when a subscription was bought decide which
+     * modes it allows: a pay-as-you-go subscription ends only immediately, and a prepaid one whose terms allow only the
+     * end of its paid period ends only then. Billing refuses a mode the terms do not allow with HTTP 422
+     * BILLING_CANCELLATION_MODE_FIXED.
+     */
+    cancellation_mode?: CancellationModeParameter;
+};
+export type ListPublicImagesParams = {
+    /**
+     * Return only the images of this region
+     */
+    region_id?: RegionID;
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type ListQuotasParams = {
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type ListRegionsParams = {
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type ListSecurityGroupRulesParams = {
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type ListSecurityGroupsParams = {
+    /**
+     * Only security groups in this region.
+     */
+    region_id?: RegionID;
+    /**
+     * Only security groups of this virtual private cloud.
+     */
+    virtual_private_cloud_id?: VirtualPrivateCloudID;
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type ListVirtualPrivateCloudPeeringsParams = {
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type ListVirtualPrivateCloudRoutesParams = {
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type ListVirtualPrivateCloudSubnetsParams = {
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type ListVirtualPrivateCloudsParams = {
+    /**
+     * Returns every region when omitted
+     */
+    region_id?: RegionID;
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type GetVirtualPrivateCloudFreeSubnetCidrParams = {
+    /**
+     * @minimum 16
+     * @maximum 30
+     */
+    prefix_length?: number;
+};
+export type ListVolumeBackupsParams = {
+    /**
+     * Return only the backups of this volume
+     */
+    volume_id?: VolumeID;
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type DeleteVolumeBackupParams = {
+    /**
+     * When subscriptions end. immediate ends them now and refunds the unused value under their refund terms; period_end
+     * ends them at the end of their paid period. The cancellation terms fixed when a subscription was bought decide which
+     * modes it allows: a pay-as-you-go subscription ends only immediately, and a prepaid one whose terms allow only the
+     * end of its paid period ends only then. Billing refuses a mode the terms do not allow with HTTP 422
+     * BILLING_CANCELLATION_MODE_FIXED.
+     */
+    cancellation_mode?: CancellationModeParameter;
+};
+export type ListVolumeSnapshotsParams = {
+    /**
+     * Return only the snapshots of this volume
+     */
+    volume_id?: VolumeID;
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type DeleteVolumeSnapshotParams = {
+    /**
+     * When subscriptions end. immediate ends them now and refunds the unused value under their refund terms; period_end
+     * ends them at the end of their paid period. The cancellation terms fixed when a subscription was bought decide which
+     * modes it allows: a pay-as-you-go subscription ends only immediately, and a prepaid one whose terms allow only the
+     * end of its paid period ends only then. Billing refuses a mode the terms do not allow with HTTP 422
+     * BILLING_CANCELLATION_MODE_FIXED.
+     */
+    cancellation_mode?: CancellationModeParameter;
+};
+export type ListVolumeTypesParams = {
+    region_id?: RegionID;
+    /**
+     * Return only the types of this availability zone, sold out or not.
+     */
+    availability_zone_id?: AvailabilityZoneID;
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type ListVolumesParams = {
+    region_id?: RegionID;
+    /**
+     * Supplied together with `region_id` to filter attachable volumes
+     */
+    availability_zone_id?: AvailabilityZoneID;
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type DeleteVolumeParams = {
+    /**
+     * When subscriptions end. immediate ends them now and refunds the unused value under their refund terms; period_end
+     * ends them at the end of their paid period. The cancellation terms fixed when a subscription was bought decide which
+     * modes it allows: a pay-as-you-go subscription ends only immediately, and a prepaid one whose terms allow only the
+     * end of its paid period ends only then. Billing refuses a mode the terms do not allow with HTTP 422
+     * BILLING_CANCELLATION_MODE_FIXED.
+     */
+    cancellation_mode?: CancellationModeParameter;
+};