latitudesh-typescript-sdk 0.6.3 → 0.7.1

package/src/models/operations/getvirtualmachinebackup.ts

@@ -0,0 +1,53 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetVirtualMachineBackupRequest = {
+  id: string;
+};
+
+/** @internal */
+export const GetVirtualMachineBackupRequest$inboundSchema: z.ZodType<
+  GetVirtualMachineBackupRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+});
+/** @internal */
+export type GetVirtualMachineBackupRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const GetVirtualMachineBackupRequest$outboundSchema: z.ZodType<
+  GetVirtualMachineBackupRequest$Outbound,
+  z.ZodTypeDef,
+  GetVirtualMachineBackupRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function getVirtualMachineBackupRequestToJSON(
+  getVirtualMachineBackupRequest: GetVirtualMachineBackupRequest,
+): string {
+  return JSON.stringify(
+    GetVirtualMachineBackupRequest$outboundSchema.parse(
+      getVirtualMachineBackupRequest,
+    ),
+  );
+}
+export function getVirtualMachineBackupRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetVirtualMachineBackupRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetVirtualMachineBackupRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetVirtualMachineBackupRequest' from JSON`,
+  );
+}

package/src/models/operations/getvirtualmachinerestore.ts

@@ -0,0 +1,53 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetVirtualMachineRestoreRequest = {
+  id: string;
+};
+
+/** @internal */
+export const GetVirtualMachineRestoreRequest$inboundSchema: z.ZodType<
+  GetVirtualMachineRestoreRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+});
+/** @internal */
+export type GetVirtualMachineRestoreRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const GetVirtualMachineRestoreRequest$outboundSchema: z.ZodType<
+  GetVirtualMachineRestoreRequest$Outbound,
+  z.ZodTypeDef,
+  GetVirtualMachineRestoreRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function getVirtualMachineRestoreRequestToJSON(
+  getVirtualMachineRestoreRequest: GetVirtualMachineRestoreRequest,
+): string {
+  return JSON.stringify(
+    GetVirtualMachineRestoreRequest$outboundSchema.parse(
+      getVirtualMachineRestoreRequest,
+    ),
+  );
+}
+export function getVirtualMachineRestoreRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetVirtualMachineRestoreRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetVirtualMachineRestoreRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetVirtualMachineRestoreRequest' from JSON`,
+  );
+}

package/src/models/operations/getvirtualnetworks.ts

@@ -22,6 +22,10 @@ export type GetVirtualNetworksRequest = {
    * The tags ids to filter by, separated by comma, e.g. `filter[tags]=tag_1,tag_2`will return ssh keys with `tag_1` AND `tag_2`
    */
   filterTags?: string | undefined;
+  /**
+   * Request aggregate stats in the response `meta`. Use `count` to get the total number of records, returned as `meta.stats.total.count`.
+   */
+  statsTotal?: string | undefined;
   /**
    * Number of items to return per page
    */
@@ -45,6 +49,7 @@ export const GetVirtualNetworksRequest$inboundSchema: z.ZodType<
   "filter[location]": z.string().optional(),
   "filter[project]": z.string().optional(),
   "filter[tags]": z.string().optional(),
+  "stats[total]": z.string().optional(),
   "page[size]": z.number().int().default(20),
   "page[number]": z.number().int().default(1),
 }).transform((v) => {
@@ -52,6 +57,7 @@ export const GetVirtualNetworksRequest$inboundSchema: z.ZodType<
     "filter[location]": "filterLocation",
     "filter[project]": "filterProject",
     "filter[tags]": "filterTags",
+    "stats[total]": "statsTotal",
     "page[size]": "pageSize",
     "page[number]": "pageNumber",
   });
@@ -61,6 +67,7 @@ export type GetVirtualNetworksRequest$Outbound = {
   "filter[location]"?: string | undefined;
   "filter[project]"?: string | undefined;
   "filter[tags]"?: string | undefined;
+  "stats[total]"?: string | undefined;
   "page[size]": number;
   "page[number]": number;
 };
@@ -74,6 +81,7 @@ export const GetVirtualNetworksRequest$outboundSchema: z.ZodType<
   filterLocation: z.string().optional(),
   filterProject: z.string().optional(),
   filterTags: z.string().optional(),
+  statsTotal: z.string().optional(),
   pageSize: z.number().int().default(20),
   pageNumber: z.number().int().default(1),
 }).transform((v) => {
@@ -81,6 +89,7 @@ export const GetVirtualNetworksRequest$outboundSchema: z.ZodType<
     filterLocation: "filter[location]",
     filterProject: "filter[project]",
     filterTags: "filter[tags]",
+    statsTotal: "stats[total]",
     pageSize: "page[size]",
     pageNumber: "page[number]",
   });

package/src/models/operations/getvirtualnetworksassignments.ts

@@ -22,6 +22,10 @@ export type GetVirtualNetworksAssignmentsRequest = {
    * The virtual network ID to filter by
    */
   filterVirtualNetworkId?: string | undefined;
+  /**
+   * Request aggregate stats in the response `meta`. Use `count` to get the total number of records, returned as `meta.stats.total.count`.
+   */
+  statsTotal?: string | undefined;
   /**
    * Number of items to return per page
    */
@@ -45,6 +49,7 @@ export const GetVirtualNetworksAssignmentsRequest$inboundSchema: z.ZodType<
   "filter[server]": z.string().optional(),
   "filter[vid]": z.string().optional(),
   "filter[virtual_network_id]": z.string().optional(),
+  "stats[total]": z.string().optional(),
   "page[size]": z.number().int().default(20),
   "page[number]": z.number().int().default(1),
 }).transform((v) => {
@@ -52,6 +57,7 @@ export const GetVirtualNetworksAssignmentsRequest$inboundSchema: z.ZodType<
     "filter[server]": "filterServer",
     "filter[vid]": "filterVid",
     "filter[virtual_network_id]": "filterVirtualNetworkId",
+    "stats[total]": "statsTotal",
     "page[size]": "pageSize",
     "page[number]": "pageNumber",
   });
@@ -61,6 +67,7 @@ export type GetVirtualNetworksAssignmentsRequest$Outbound = {
   "filter[server]"?: string | undefined;
   "filter[vid]"?: string | undefined;
   "filter[virtual_network_id]"?: string | undefined;
+  "stats[total]"?: string | undefined;
   "page[size]": number;
   "page[number]": number;
 };
@@ -74,6 +81,7 @@ export const GetVirtualNetworksAssignmentsRequest$outboundSchema: z.ZodType<
   filterServer: z.string().optional(),
   filterVid: z.string().optional(),
   filterVirtualNetworkId: z.string().optional(),
+  statsTotal: z.string().optional(),
   pageSize: z.number().int().default(20),
   pageNumber: z.number().int().default(1),
 }).transform((v) => {
@@ -81,6 +89,7 @@ export const GetVirtualNetworksAssignmentsRequest$outboundSchema: z.ZodType<
     filterServer: "filter[server]",
     filterVid: "filter[vid]",
     filterVirtualNetworkId: "filter[virtual_network_id]",
+    statsTotal: "stats[total]",
     pageSize: "page[size]",
     pageNumber: "page[number]",
   });

package/src/models/operations/index.ts

@@ -13,7 +13,9 @@ export * from "./createserveroutofband.js";
 export * from "./createserverreinstall.js";
 export * from "./createtag.js";
 export * from "./createvirtualmachineaction.js";
+export * from "./createvirtualmachinebackup.js";
 export * from "./createvirtualmachinenetworkattachment.js";
+export * from "./createvirtualmachinerestore.js";
 export * from "./createvirtualnetwork.js";
 export * from "./deleteapikey.js";
 export * from "./deleteelasticip.js";
@@ -28,6 +30,7 @@ export * from "./deletestoragebuckets.js";
 export * from "./deletestoragefilesystems.js";
 export * from "./deletestoragevolumes.js";
 export * from "./deleteuserdata.js";
+export * from "./deletevirtualmachinebackup.js";
 export * from "./deletevirtualnetworksassignments.js";
 export * from "./deletevpnsession.js";
 export * from "./destroyserver.js";
@@ -76,16 +79,21 @@ export * from "./gettrafficquota.js";
 export * from "./getuserdata.js";
 export * from "./getuserprofile.js";
 export * from "./getusersdata.js";
+export * from "./getvirtualmachinebackup.js";
+export * from "./getvirtualmachinerestore.js";
 export * from "./getvirtualnetwork.js";
 export * from "./getvirtualnetworks.js";
 export * from "./getvirtualnetworksassignments.js";
 export * from "./getvmplans.js";
 export * from "./getvpnsessions.js";
 export * from "./indexvirtualmachine.js";
+export * from "./listbackuprestores.js";
 export * from "./listelasticips.js";
 export * from "./listfirewalls.js";
 export * from "./listkubernetesclusters.js";
 export * from "./listvirtualmachinenetworkattachments.js";
+export * from "./listvirtualmachinescopedbackups.js";
+export * from "./listvirtualmachinescopedrestores.js";
 export * from "./patchcurrentteam.js";
 export * from "./patchstoragefilesystems.js";
 export * from "./patchuserdata.js";

package/src/models/operations/indexvirtualmachine.ts

@@ -21,6 +21,10 @@ export type IndexVirtualMachineRequest = {
    * Comma-separated extra attributes that are lazy-loaded. Supported values: `credentials`, `pending_restart`. Example: `extra_fields[virtual_machines]=credentials,pending_restart`.
    */
   extraFieldsVirtualMachines?: string | undefined;
+  /**
+   * Comma-separated sort fields. Prefix a field with `-` for descending order. Supported fields: created_at, name, hostname, status. Example: `sort=status,-created_at` sorts by status ascending, then by creation date descending.
+   */
+  sort?: string | undefined;
 };
 
 /** @internal */
@@ -32,6 +36,7 @@ export const IndexVirtualMachineRequest$inboundSchema: z.ZodType<
   "filter[project]": z.string().optional(),
   "filter[tags]": z.string().optional(),
   "extra_fields[virtual_machines]": z.string().optional(),
+  sort: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     "filter[project]": "filterProject",
@@ -44,6 +49,7 @@ export type IndexVirtualMachineRequest$Outbound = {
   "filter[project]"?: string | undefined;
   "filter[tags]"?: string | undefined;
   "extra_fields[virtual_machines]"?: string | undefined;
+  sort?: string | undefined;
 };
 
 /** @internal */
@@ -55,6 +61,7 @@ export const IndexVirtualMachineRequest$outboundSchema: z.ZodType<
   filterProject: z.string().optional(),
   filterTags: z.string().optional(),
   extraFieldsVirtualMachines: z.string().optional(),
+  sort: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     filterProject: "filter[project]",

package/src/models/operations/listbackuprestores.ts

@@ -0,0 +1,60 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ListBackupRestoresRequest = {
+  backupId: string;
+};
+
+/** @internal */
+export const ListBackupRestoresRequest$inboundSchema: z.ZodType<
+  ListBackupRestoresRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  backup_id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "backup_id": "backupId",
+  });
+});
+/** @internal */
+export type ListBackupRestoresRequest$Outbound = {
+  backup_id: string;
+};
+
+/** @internal */
+export const ListBackupRestoresRequest$outboundSchema: z.ZodType<
+  ListBackupRestoresRequest$Outbound,
+  z.ZodTypeDef,
+  ListBackupRestoresRequest
+> = z.object({
+  backupId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    backupId: "backup_id",
+  });
+});
+
+export function listBackupRestoresRequestToJSON(
+  listBackupRestoresRequest: ListBackupRestoresRequest,
+): string {
+  return JSON.stringify(
+    ListBackupRestoresRequest$outboundSchema.parse(listBackupRestoresRequest),
+  );
+}
+export function listBackupRestoresRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListBackupRestoresRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListBackupRestoresRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListBackupRestoresRequest' from JSON`,
+  );
+}

package/src/models/operations/listvirtualmachinescopedbackups.ts

@@ -0,0 +1,64 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ListVirtualMachineScopedBackupsRequest = {
+  virtualMachineId: string;
+};
+
+/** @internal */
+export const ListVirtualMachineScopedBackupsRequest$inboundSchema: z.ZodType<
+  ListVirtualMachineScopedBackupsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  virtual_machine_id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "virtual_machine_id": "virtualMachineId",
+  });
+});
+/** @internal */
+export type ListVirtualMachineScopedBackupsRequest$Outbound = {
+  virtual_machine_id: string;
+};
+
+/** @internal */
+export const ListVirtualMachineScopedBackupsRequest$outboundSchema: z.ZodType<
+  ListVirtualMachineScopedBackupsRequest$Outbound,
+  z.ZodTypeDef,
+  ListVirtualMachineScopedBackupsRequest
+> = z.object({
+  virtualMachineId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    virtualMachineId: "virtual_machine_id",
+  });
+});
+
+export function listVirtualMachineScopedBackupsRequestToJSON(
+  listVirtualMachineScopedBackupsRequest:
+    ListVirtualMachineScopedBackupsRequest,
+): string {
+  return JSON.stringify(
+    ListVirtualMachineScopedBackupsRequest$outboundSchema.parse(
+      listVirtualMachineScopedBackupsRequest,
+    ),
+  );
+}
+export function listVirtualMachineScopedBackupsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListVirtualMachineScopedBackupsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListVirtualMachineScopedBackupsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListVirtualMachineScopedBackupsRequest' from JSON`,
+  );
+}

package/src/models/operations/listvirtualmachinescopedrestores.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ListVirtualMachineScopedRestoresRequest = {
+  virtualMachineId: string;
+  backupId: string;
+};
+
+/** @internal */
+export const ListVirtualMachineScopedRestoresRequest$inboundSchema: z.ZodType<
+  ListVirtualMachineScopedRestoresRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  virtual_machine_id: z.string(),
+  backup_id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "virtual_machine_id": "virtualMachineId",
+    "backup_id": "backupId",
+  });
+});
+/** @internal */
+export type ListVirtualMachineScopedRestoresRequest$Outbound = {
+  virtual_machine_id: string;
+  backup_id: string;
+};
+
+/** @internal */
+export const ListVirtualMachineScopedRestoresRequest$outboundSchema: z.ZodType<
+  ListVirtualMachineScopedRestoresRequest$Outbound,
+  z.ZodTypeDef,
+  ListVirtualMachineScopedRestoresRequest
+> = z.object({
+  virtualMachineId: z.string(),
+  backupId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    virtualMachineId: "virtual_machine_id",
+    backupId: "backup_id",
+  });
+});
+
+export function listVirtualMachineScopedRestoresRequestToJSON(
+  listVirtualMachineScopedRestoresRequest:
+    ListVirtualMachineScopedRestoresRequest,
+): string {
+  return JSON.stringify(
+    ListVirtualMachineScopedRestoresRequest$outboundSchema.parse(
+      listVirtualMachineScopedRestoresRequest,
+    ),
+  );
+}
+export function listVirtualMachineScopedRestoresRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListVirtualMachineScopedRestoresRequest,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListVirtualMachineScopedRestoresRequest$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListVirtualMachineScopedRestoresRequest' from JSON`,
+  );
+}

package/src/models/operations/showvirtualmachine.ts

@@ -10,6 +10,10 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ShowVirtualMachineRequest = {
   virtualMachineId: string;
+  /**
+   * Comma-separated extra attributes that are lazy-loaded. Supported values: `credentials`, `pending_restart`. Example: `extra_fields[virtual_machines]=credentials,pending_restart`.
+   */
+  extraFieldsVirtualMachines?: string | undefined;
 };
 
 /** @internal */
@@ -19,14 +23,17 @@ export const ShowVirtualMachineRequest$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   virtual_machine_id: z.string(),
+  "extra_fields[virtual_machines]": z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     "virtual_machine_id": "virtualMachineId",
+    "extra_fields[virtual_machines]": "extraFieldsVirtualMachines",
   });
 });
 /** @internal */
 export type ShowVirtualMachineRequest$Outbound = {
   virtual_machine_id: string;
+  "extra_fields[virtual_machines]"?: string | undefined;
 };
 
 /** @internal */
@@ -36,9 +43,11 @@ export const ShowVirtualMachineRequest$outboundSchema: z.ZodType<
   ShowVirtualMachineRequest
 > = z.object({
   virtualMachineId: z.string(),
+  extraFieldsVirtualMachines: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     virtualMachineId: "virtual_machine_id",
+    extraFieldsVirtualMachines: "extra_fields[virtual_machines]",
   });
 });
 

package/src/models/operations/updatevirtualnetwork.ts

@@ -55,12 +55,12 @@ export const UpdateVirtualNetworkAttributes2$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   tags: z.array(z.string()).optional(),
-  description: z.string().default("Test virtual network update"),
+  description: z.string().optional(),
 });
 /** @internal */
 export type UpdateVirtualNetworkAttributes2$Outbound = {
   tags?: Array<string> | undefined;
-  description: string;
+  description?: string | undefined;
 };
 
 /** @internal */
@@ -70,7 +70,7 @@ export const UpdateVirtualNetworkAttributes2$outboundSchema: z.ZodType<
   UpdateVirtualNetworkAttributes2
 > = z.object({
   tags: z.array(z.string()).optional(),
-  description: z.string().default("Test virtual network update"),
+  description: z.string().optional(),
 });
 
 export function updateVirtualNetworkAttributes2ToJSON(

package/src/models/servers.ts

@@ -6,6 +6,12 @@ import * as z from "zod/v3";
 import { safeParse } from "../lib/schemas.js";
 import { Result as SafeParseResult } from "../types/fp.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  PaginationMeta,
+  PaginationMeta$inboundSchema,
+  PaginationMeta$Outbound,
+  PaginationMeta$outboundSchema,
+} from "./paginationmeta.js";
 import {
   ServerData,
   ServerData$inboundSchema,
@@ -13,52 +19,21 @@ import {
   ServerData$outboundSchema,
 } from "./serverdata.js";
 
-export type ServersMeta = {};
-
 export type Servers = {
   data?: Array<ServerData> | undefined;
-  meta?: ServersMeta | undefined;
+  meta?: PaginationMeta | undefined;
 };
 
-/** @internal */
-export const ServersMeta$inboundSchema: z.ZodType<
-  ServersMeta,
-  z.ZodTypeDef,
-  unknown
-> = z.object({});
-/** @internal */
-export type ServersMeta$Outbound = {};
-
-/** @internal */
-export const ServersMeta$outboundSchema: z.ZodType<
-  ServersMeta$Outbound,
-  z.ZodTypeDef,
-  ServersMeta
-> = z.object({});
-
-export function serversMetaToJSON(serversMeta: ServersMeta): string {
-  return JSON.stringify(ServersMeta$outboundSchema.parse(serversMeta));
-}
-export function serversMetaFromJSON(
-  jsonString: string,
-): SafeParseResult<ServersMeta, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => ServersMeta$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'ServersMeta' from JSON`,
-  );
-}
-
 /** @internal */
 export const Servers$inboundSchema: z.ZodType<Servers, z.ZodTypeDef, unknown> =
   z.object({
     data: z.array(ServerData$inboundSchema).optional(),
-    meta: z.lazy(() => ServersMeta$inboundSchema).optional(),
+    meta: PaginationMeta$inboundSchema.optional(),
   });
 /** @internal */
 export type Servers$Outbound = {
   data?: Array<ServerData$Outbound> | undefined;
-  meta?: ServersMeta$Outbound | undefined;
+  meta?: PaginationMeta$Outbound | undefined;
 };
 
 /** @internal */
@@ -68,7 +43,7 @@ export const Servers$outboundSchema: z.ZodType<
   Servers
 > = z.object({
   data: z.array(ServerData$outboundSchema).optional(),
-  meta: z.lazy(() => ServersMeta$outboundSchema).optional(),
+  meta: PaginationMeta$outboundSchema.optional(),
 });
 
 export function serversToJSON(servers: Servers): string {

package/src/models/virtualmachineattributes.ts

@@ -103,7 +103,7 @@ export type VirtualMachineAttributesOperatingSystem = {
 };
 
 /**
- * SSH credentials for connecting to the virtual machine. Only available when the VM is running.
+ * SSH credentials for connecting to the virtual machine. Only available when the VM is running. Opt-in extra field: request via `extra_fields[virtual_machines]=credentials`.
  */
 export type VirtualMachineAttributesCredentials = {
   /**
@@ -145,7 +145,7 @@ export type VirtualMachineAttributesAttributes = {
    */
   operatingSystem?: VirtualMachineAttributesOperatingSystem | null | undefined;
   /**
-   * SSH credentials for connecting to the virtual machine. Only available when the VM is running.
+   * SSH credentials for connecting to the virtual machine. Only available when the VM is running. Opt-in extra field: request via `extra_fields[virtual_machines]=credentials`.
    */
   credentials?: VirtualMachineAttributesCredentials | null | undefined;
   site?: string | null | undefined;