latitudesh-typescript-sdk 0.8.30 → 0.8.31

package/src/models/volumedata.ts

@@ -33,7 +33,7 @@ export type Initiator = {
 /**
  * Storage network the mapped server joins to reach the volume over NVMe-TCP. Null until the network has been provisioned for the volume.
  */
-export type StorageNetwork = {
+export type VolumeDataStorageNetwork = {
   /**
    * VLAN ID of the storage VLAN to tag on the server bond.
    */
@@ -83,7 +83,7 @@ export type Block = {
   /**
    * Storage network the mapped server joins to reach the volume over NVMe-TCP. Null until the network has been provisioned for the volume.
    */
-  storageNetwork?: StorageNetwork | null | undefined;
+  storageNetwork?: VolumeDataStorageNetwork | null | undefined;
 };
 
 export type VolumeDataSite = {
@@ -182,8 +182,8 @@ export function initiatorFromJSON(
 }
 
 /** @internal */
-export const StorageNetwork$inboundSchema: z.ZodType<
-  StorageNetwork,
+export const VolumeDataStorageNetwork$inboundSchema: z.ZodType<
+  VolumeDataStorageNetwork,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -201,7 +201,7 @@ export const StorageNetwork$inboundSchema: z.ZodType<
   });
 });
 /** @internal */
-export type StorageNetwork$Outbound = {
+export type VolumeDataStorageNetwork$Outbound = {
   vid?: number | null | undefined;
   host_cidr?: string | null | undefined;
   gateway?: string | null | undefined;
@@ -211,10 +211,10 @@ export type StorageNetwork$Outbound = {
 };
 
 /** @internal */
-export const StorageNetwork$outboundSchema: z.ZodType<
-  StorageNetwork$Outbound,
+export const VolumeDataStorageNetwork$outboundSchema: z.ZodType<
+  VolumeDataStorageNetwork$Outbound,
   z.ZodTypeDef,
-  StorageNetwork
+  VolumeDataStorageNetwork
 > = z.object({
   vid: z.nullable(z.number().int()).optional(),
   hostCidr: z.nullable(z.string()).optional(),
@@ -230,16 +230,20 @@ export const StorageNetwork$outboundSchema: z.ZodType<
   });
 });
 
-export function storageNetworkToJSON(storageNetwork: StorageNetwork): string {
-  return JSON.stringify(StorageNetwork$outboundSchema.parse(storageNetwork));
+export function volumeDataStorageNetworkToJSON(
+  volumeDataStorageNetwork: VolumeDataStorageNetwork,
+): string {
+  return JSON.stringify(
+    VolumeDataStorageNetwork$outboundSchema.parse(volumeDataStorageNetwork),
+  );
 }
-export function storageNetworkFromJSON(
+export function volumeDataStorageNetworkFromJSON(
   jsonString: string,
-): SafeParseResult<StorageNetwork, SDKValidationError> {
+): SafeParseResult<VolumeDataStorageNetwork, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => StorageNetwork$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'StorageNetwork' from JSON`,
+    (x) => VolumeDataStorageNetwork$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VolumeDataStorageNetwork' from JSON`,
   );
 }
 
@@ -250,8 +254,9 @@ export const Block$inboundSchema: z.ZodType<Block, z.ZodTypeDef, unknown> = z
     nqn: z.nullable(z.string()).optional(),
     nsid: z.nullable(z.number().int()).optional(),
     server_id: z.nullable(z.string()).optional(),
-    storage_network: z.nullable(z.lazy(() => StorageNetwork$inboundSchema))
-      .optional(),
+    storage_network: z.nullable(
+      z.lazy(() => VolumeDataStorageNetwork$inboundSchema),
+    ).optional(),
   }).transform((v) => {
     return remap$(v, {
       "server_id": "serverId",
@@ -264,7 +269,7 @@ export type Block$Outbound = {
   nqn?: string | null | undefined;
   nsid?: number | null | undefined;
   server_id?: string | null | undefined;
-  storage_network?: StorageNetwork$Outbound | null | undefined;
+  storage_network?: VolumeDataStorageNetwork$Outbound | null | undefined;
 };
 
 /** @internal */
@@ -277,8 +282,9 @@ export const Block$outboundSchema: z.ZodType<
   nqn: z.nullable(z.string()).optional(),
   nsid: z.nullable(z.number().int()).optional(),
   serverId: z.nullable(z.string()).optional(),
-  storageNetwork: z.nullable(z.lazy(() => StorageNetwork$outboundSchema))
-    .optional(),
+  storageNetwork: z.nullable(
+    z.lazy(() => VolumeDataStorageNetwork$outboundSchema),
+  ).optional(),
 }).transform((v) => {
   return remap$(v, {
     serverId: "server_id",

package/src/sdk/filesystemstorage.ts

@@ -2,8 +2,11 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { filesystemStorageAttachFilesystem } from "../funcs/filesystemStorageAttachFilesystem.js";
 import { filesystemStorageCreateFilesystem } from "../funcs/filesystemStorageCreateFilesystem.js";
 import { filesystemStorageDeleteFilesystem } from "../funcs/filesystemStorageDeleteFilesystem.js";
+import { filesystemStorageDetachFilesystem } from "../funcs/filesystemStorageDetachFilesystem.js";
+import { filesystemStorageGetFilesystemAttachment } from "../funcs/filesystemStorageGetFilesystemAttachment.js";
 import { filesystemStorageListFilesystems } from "../funcs/filesystemStorageListFilesystems.js";
 import { filesystemStorageUpdateFilesystem } from "../funcs/filesystemStorageUpdateFilesystem.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
@@ -79,4 +82,55 @@ export class FilesystemStorage extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Get filesystem attachment
+   *
+   * @remarks
+   * Returns whether a server is attached to the storage network the filesystem is served on. Poll it after attaching: once the status is "attached", configure the returned storage network on the server and mount the filesystem.
+   */
+  async getFilesystemAttachment(
+    request: operations.GetFilesystemAttachmentRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetFilesystemAttachmentResponse> {
+    return unwrapAsync(filesystemStorageGetFilesystemAttachment(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Attach filesystem to server
+   *
+   * @remarks
+   * Attaches a running server to the private storage network the filesystem is served on, so it can mount the filesystem. The attach runs asynchronously and is idempotent.
+   */
+  async attachFilesystem(
+    request: operations.AttachFilesystemRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(filesystemStorageAttachFilesystem(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Detach filesystem from server
+   *
+   * @remarks
+   * Detaches a server from the storage network the filesystem is served on, removing its storage IP and VLAN. The network stays while a volume is still mapped to the server, since volumes use the same network. The detach runs asynchronously: poll GET .../attach for its status.
+   */
+  async detachFilesystem(
+    request: operations.DetachFilesystemRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(filesystemStorageDetachFilesystem(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/sdk/lks.ts

@@ -9,9 +9,11 @@ import { lksDeleteLKSNodePool } from "../funcs/lksDeleteLKSNodePool.js";
 import { lksGetLKSCluster } from "../funcs/lksGetLKSCluster.js";
 import { lksGetLKSClusterKubeconfig } from "../funcs/lksGetLKSClusterKubeconfig.js";
 import { lksGetLKSNodePool } from "../funcs/lksGetLKSNodePool.js";
+import { lksListLKSAllocatableServers } from "../funcs/lksListLKSAllocatableServers.js";
 import { lksListLKSAvailableVersions } from "../funcs/lksListLKSAvailableVersions.js";
 import { lksListLKSClusters } from "../funcs/lksListLKSClusters.js";
 import { lksListLKSNodePools } from "../funcs/lksListLKSNodePools.js";
+import { lksListLKSNodes } from "../funcs/lksListLKSNodes.js";
 import { lksListLKSSites } from "../funcs/lksListLKSSites.js";
 import { lksUpdateLKSCluster } from "../funcs/lksUpdateLKSCluster.js";
 import { lksUpdateLKSNodePool } from "../funcs/lksUpdateLKSNodePool.js";
@@ -154,9 +156,12 @@ export class Lks extends ClientSDK {
    * Create a node pool
    *
    * @remarks
-   * Adds a node pool to an LKS cluster. The platform provisions `count` servers of `plan` from stock, so both fields are required.
+   * Adds a node pool to an LKS cluster. `mode` decides where the pool's nodes come from:
    *
-   * `kubernetes_version` defaults to the control-plane patch and may never be newer than it. `max_pods_per_node` is set once, here — it cannot be changed later.
+   * - `on_demand` (default): the platform provisions `count` servers of `plan` from stock, so both fields are required.
+   * - `allocated`: the pool is built from `server_ids`, bare metal servers already in the cluster project. Each server is reinstalled with the LKS node image, which erases its disks. `plan` and `count` are rejected: the pool uses the plan the servers share, and `count` is the number of servers. Each server that fails an eligibility check is reported as its own 422 error, pointing at its index in `server_ids` and listing every reason in `meta.reasons`. `GET /lks/allocatable_servers` shows which servers can join. Allocated node pools are available only in on-demand projects: a reserved project is refused with 422 `RESERVED_PROJECT_NOT_SUPPORTED`.
+   *
+   * `kubernetes_version` defaults to the control-plane patch and may never be newer than it. `max_pods_per_node` and `mode` are set once, here — they cannot be changed later.
    */
   async createLksNodePool(
     request: operations.CreateLksNodePoolRequest,
@@ -207,11 +212,13 @@ export class Lks extends ClientSDK {
    * Update a node pool
    *
    * @remarks
-   * Scales, renames, upgrades or re-labels a node pool. At least one attribute must be provided.
+   * Scales, renames, upgrades, re-labels or changes the servers of a node pool. At least one attribute must be provided.
    *
    * `labels` and `taints` are declarative replacements, not merges: omit the field to leave it untouched, send the whole map/list to replace it, or send `{}` / `[]` to clear it.
    *
-   * A newer `kubernetes_version` rolls a node-recreating upgrade; it must not be lower than the pool's current patch nor newer than the control-plane patch. `max_pods_per_node` is immutable — a PATCH that carries it is rejected with 422 even if the value is unchanged.
+   * A newer `kubernetes_version` rolls a node-recreating upgrade; it must not be lower than the pool's current patch nor newer than the control-plane patch. `max_pods_per_node` and `mode` are immutable — a PATCH that carries either is rejected with 422 even if the value is unchanged.
+   *
+   * For an allocated node pool, `server_ids` replaces `count`: send the whole set of servers the pool should have. Added servers are checked as on create and reinstalled to join; removed servers are drained and reinstalled with a clean OS, with no data, keys or user data restored. A server set change cannot be combined with a `kubernetes_version` change.
    *
    * The node pool must be idle: one that is provisioning, updating, scaling, upgrading, paused or deleting rejects the request with 409.
    */
@@ -226,6 +233,23 @@ export class Lks extends ClientSDK {
     ));
   }
 
+  /**
+   * List nodes
+   *
+   * @remarks
+   * Lists the nodes of a node pool, with the status of each node and of the server it runs on. Each node's `id` is a stable node ID (format: `lksno_<hash>`); `name` is its Kubernetes node name, as shown by `kubectl get nodes`. The response is not paginated; `meta.total` is the number of nodes returned.
+   */
+  async listLksNodes(
+    request: operations.ListLksNodesRequest,
+    options?: RequestOptions,
+  ): Promise<models.LksNodes> {
+    return unwrapAsync(lksListLKSNodes(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * List available Kubernetes versions
    *
@@ -255,4 +279,23 @@ export class Lks extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * List servers that can join an allocated node pool
+   *
+   * @remarks
+   * Lists a project's servers at a site, with whether each one can join an allocated node pool right now. Pass the `id` of an allocatable server in `server_ids` when creating or updating an allocated node pool.
+   *
+   * When `allocatable` is false, `reasons` lists why, using the same codes that node pool create and update return per server. `node_pool_id` and `cluster_id` identify the pool a server already belongs to.
+   */
+  async listLksAllocatableServers(
+    request: operations.ListLksAllocatableServersRequest,
+    options?: RequestOptions,
+  ): Promise<models.LksAllocatableServers> {
+    return unwrapAsync(lksListLKSAllocatableServers(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/sdk/publicnetworks.ts

@@ -6,6 +6,7 @@ import { publicNetworksCreatePublicNetwork } from "../funcs/publicNetworksCreate
 import { publicNetworksDestroyPublicNetwork } from "../funcs/publicNetworksDestroyPublicNetwork.js";
 import { publicNetworksGetPublicNetwork } from "../funcs/publicNetworksGetPublicNetwork.js";
 import { publicNetworksGetPublicNetworks } from "../funcs/publicNetworksGetPublicNetworks.js";
+import { publicNetworksUpdatePublicNetworkIp } from "../funcs/publicNetworksUpdatePublicNetworkIp.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as models from "../models/index.js";
 import * as operations from "../models/operations/index.js";
@@ -85,4 +86,23 @@ export class PublicNetworks extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Update a network IP
+   *
+   * @remarks
+   * **Preview.** Available at locations where the `public_network` feature is enabled.
+   *
+   * Reserve an available address of a network for your own use, so servers are never attached to the network with it, or release an address you reserved.
+   */
+  async updatePublicNetworkIp(
+    request: operations.UpdatePublicNetworkIpRequest,
+    options?: RequestOptions,
+  ): Promise<models.PublicNetwork> {
+    return unwrapAsync(publicNetworksUpdatePublicNetworkIp(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/sdk/virtualmachines.ts

@@ -166,7 +166,16 @@ export class VirtualMachines extends ClientSDK {
    * Attach a network to a VM
    *
    * @remarks
-   * Attaches a virtual network (VLAN) to a Virtual Machine. Work runs asynchronously and returns 202 Accepted.
+   * Attaches a virtual network (VLAN) to a Virtual Machine. Work runs asynchronously and returns 202 Accepted. A running VM restarts so the new NIC reaches the guest; a VM that is not running picks it up when it next starts.
+   *
+   * After the restart, check the interface inside the guest (`ip -br addr`):
+   *
+   * - VMs created with `apply_network_on_boot` enabled (the default) configure the NIC on boot, with the attachment's `address` when one was given. Nothing else to do.
+   * - VMs created before that option existed, or with it disabled, leave the NIC without an address. Once the VM has restarted, read the attachment's `mac_address` and `address` from `GET /virtual_machines/{virtual_machine_id}/network_attachments` and configure the interface with that MAC address yourself, as described in [Private networks: configure the OS](https://www.latitude.sh/docs/networking/private-networks#step-3-configure-the-os). The NIC gets a new MAC address each time a network is attached, so update your configuration after detaching and attaching a network again.
+   *
+   * Keep network configuration of your own in a separate file. With `apply_network_on_boot`, every boot, including a restart started inside the guest, rewrites cloud-init's own network file (for example `/etc/netplan/50-cloud-init.yaml`), so changes made there are lost. To stop that on a VM, create `/etc/cloud/cloud.cfg.d/99-disable-network-config.cfg` containing `network: {config: disabled}`; cloud-init then leaves the network configuration alone on every boot, and networks attached afterwards must be configured by hand.
+   *
+   * Some virtual machines run on older infrastructure that doesn't support network attachments. On those VMs, attaching or detaching a network returns 422 `VIRTUAL_NETWORK_ATTACHMENT_UNSUPPORTED` and leaves the VM unchanged.
    */
   async createVirtualMachineNetworkAttachment(
     request: operations.CreateVirtualMachineNetworkAttachmentRequest,
@@ -183,7 +192,11 @@ export class VirtualMachines extends ClientSDK {
    * Detach a network from a VM
    *
    * @remarks
-   * Detaches a virtual network (VLAN) from a Virtual Machine. Work runs asynchronously and returns 202 Accepted.
+   * Detaches a virtual network (VLAN) from a Virtual Machine. Work runs asynchronously and returns 202 Accepted. A running VM restarts so the NIC is removed from the guest; a VM that is not running loses it when it next starts.
+   *
+   * On VMs created with `apply_network_on_boot` enabled, that boot also removes the NIC's configuration. If you configured the NIC yourself, remove that configuration before detaching, as described in [Private networks: configure the OS](https://www.latitude.sh/docs/networking/private-networks#step-3-configure-the-os).
+   *
+   * Some virtual machines run on older infrastructure that doesn't support network attachments. On those VMs, attaching or detaching a network returns 422 `VIRTUAL_NETWORK_ATTACHMENT_UNSUPPORTED` and leaves the VM unchanged.
    */
   async destroyVirtualMachineNetworkAttachment(
     request: operations.DestroyVirtualMachineNetworkAttachmentRequest,