latitudesh-typescript-sdk 0.2.4 → 0.3.1

package/src/models/virtualmachineupdatepayload.ts

@@ -0,0 +1,174 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { ClosedEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export const VirtualMachineUpdatePayloadType = {
+  VirtualMachines: "virtual_machines",
+} as const;
+export type VirtualMachineUpdatePayloadType = ClosedEnum<
+  typeof VirtualMachineUpdatePayloadType
+>;
+
+export type VirtualMachineUpdatePayloadAttributes = {
+  /**
+   * The new display name (hostname) for the Virtual Machine
+   */
+  name: string;
+};
+
+export type VirtualMachineUpdatePayloadData = {
+  type: VirtualMachineUpdatePayloadType;
+  id?: string | undefined;
+  attributes: VirtualMachineUpdatePayloadAttributes;
+};
+
+export type VirtualMachineUpdatePayload = {
+  data: VirtualMachineUpdatePayloadData;
+};
+
+/** @internal */
+export const VirtualMachineUpdatePayloadType$inboundSchema: z.ZodNativeEnum<
+  typeof VirtualMachineUpdatePayloadType
+> = z.nativeEnum(VirtualMachineUpdatePayloadType);
+/** @internal */
+export const VirtualMachineUpdatePayloadType$outboundSchema: z.ZodNativeEnum<
+  typeof VirtualMachineUpdatePayloadType
+> = VirtualMachineUpdatePayloadType$inboundSchema;
+
+/** @internal */
+export const VirtualMachineUpdatePayloadAttributes$inboundSchema: z.ZodType<
+  VirtualMachineUpdatePayloadAttributes,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+});
+/** @internal */
+export type VirtualMachineUpdatePayloadAttributes$Outbound = {
+  name: string;
+};
+
+/** @internal */
+export const VirtualMachineUpdatePayloadAttributes$outboundSchema: z.ZodType<
+  VirtualMachineUpdatePayloadAttributes$Outbound,
+  z.ZodTypeDef,
+  VirtualMachineUpdatePayloadAttributes
+> = z.object({
+  name: z.string(),
+});
+
+export function virtualMachineUpdatePayloadAttributesToJSON(
+  virtualMachineUpdatePayloadAttributes: VirtualMachineUpdatePayloadAttributes,
+): string {
+  return JSON.stringify(
+    VirtualMachineUpdatePayloadAttributes$outboundSchema.parse(
+      virtualMachineUpdatePayloadAttributes,
+    ),
+  );
+}
+export function virtualMachineUpdatePayloadAttributesFromJSON(
+  jsonString: string,
+): SafeParseResult<VirtualMachineUpdatePayloadAttributes, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      VirtualMachineUpdatePayloadAttributes$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VirtualMachineUpdatePayloadAttributes' from JSON`,
+  );
+}
+
+/** @internal */
+export const VirtualMachineUpdatePayloadData$inboundSchema: z.ZodType<
+  VirtualMachineUpdatePayloadData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: VirtualMachineUpdatePayloadType$inboundSchema,
+  id: z.string().optional(),
+  attributes: z.lazy(() => VirtualMachineUpdatePayloadAttributes$inboundSchema),
+});
+/** @internal */
+export type VirtualMachineUpdatePayloadData$Outbound = {
+  type: string;
+  id?: string | undefined;
+  attributes: VirtualMachineUpdatePayloadAttributes$Outbound;
+};
+
+/** @internal */
+export const VirtualMachineUpdatePayloadData$outboundSchema: z.ZodType<
+  VirtualMachineUpdatePayloadData$Outbound,
+  z.ZodTypeDef,
+  VirtualMachineUpdatePayloadData
+> = z.object({
+  type: VirtualMachineUpdatePayloadType$outboundSchema,
+  id: z.string().optional(),
+  attributes: z.lazy(() =>
+    VirtualMachineUpdatePayloadAttributes$outboundSchema
+  ),
+});
+
+export function virtualMachineUpdatePayloadDataToJSON(
+  virtualMachineUpdatePayloadData: VirtualMachineUpdatePayloadData,
+): string {
+  return JSON.stringify(
+    VirtualMachineUpdatePayloadData$outboundSchema.parse(
+      virtualMachineUpdatePayloadData,
+    ),
+  );
+}
+export function virtualMachineUpdatePayloadDataFromJSON(
+  jsonString: string,
+): SafeParseResult<VirtualMachineUpdatePayloadData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VirtualMachineUpdatePayloadData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VirtualMachineUpdatePayloadData' from JSON`,
+  );
+}
+
+/** @internal */
+export const VirtualMachineUpdatePayload$inboundSchema: z.ZodType<
+  VirtualMachineUpdatePayload,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.lazy(() => VirtualMachineUpdatePayloadData$inboundSchema),
+});
+/** @internal */
+export type VirtualMachineUpdatePayload$Outbound = {
+  data: VirtualMachineUpdatePayloadData$Outbound;
+};
+
+/** @internal */
+export const VirtualMachineUpdatePayload$outboundSchema: z.ZodType<
+  VirtualMachineUpdatePayload$Outbound,
+  z.ZodTypeDef,
+  VirtualMachineUpdatePayload
+> = z.object({
+  data: z.lazy(() => VirtualMachineUpdatePayloadData$outboundSchema),
+});
+
+export function virtualMachineUpdatePayloadToJSON(
+  virtualMachineUpdatePayload: VirtualMachineUpdatePayload,
+): string {
+  return JSON.stringify(
+    VirtualMachineUpdatePayload$outboundSchema.parse(
+      virtualMachineUpdatePayload,
+    ),
+  );
+}
+export function virtualMachineUpdatePayloadFromJSON(
+  jsonString: string,
+): SafeParseResult<VirtualMachineUpdatePayload, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VirtualMachineUpdatePayload$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VirtualMachineUpdatePayload' from JSON`,
+  );
+}

package/src/sdk/apikeys.ts

@@ -14,10 +14,10 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class ApiKeys extends ClientSDK {
   /**
-   * List API Keys
+   * List API keys
    *
    * @remarks
-   * Returns a list of all API keys from the team members
+   * Returns a list of all API keys.
    */
   async list(
     options?: RequestOptions,
@@ -29,7 +29,7 @@ export class ApiKeys extends ClientSDK {
   }
 
   /**
-   * Create API Key
+   * Create API key
    *
    * @remarks
    * Create a new API Key that is tied to the current user account. The created API key is only listed ONCE upon creation. It can however be regenerated or deleted.
@@ -46,7 +46,7 @@ export class ApiKeys extends ClientSDK {
   }
 
   /**
-   * Rotate API Key
+   * Rotate API key
    *
    * @remarks
    * Rotate an existing API Key, generating a new token. This invalidates the previous key.
@@ -64,7 +64,7 @@ export class ApiKeys extends ClientSDK {
   }
 
   /**
-   * Delete API Key
+   * Delete API key
    *
    * @remarks
    * Delete an existing API Key. Once deleted, the API Key can no longer be used to access the API.
@@ -81,7 +81,7 @@ export class ApiKeys extends ClientSDK {
   }
 
   /**
-   * Update API Key Settings
+   * Update API key settings
    *
    * @remarks
    * Update API Key settings (name, read_only, allowed_ips) without rotating the token.

package/src/sdk/assignments.ts

@@ -10,10 +10,10 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class Assignments extends ClientSDK {
   /**
-   * Firewall Assignment
+   * Assign server to firewall
    *
    * @remarks
-   * Assign a server to a firewall
+   * Assigns a server to a firewall by its ID.
    */
   async create(
     request: operations.CreateFirewallAssignmentRequest,

package/src/sdk/billing.ts

@@ -10,7 +10,7 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class Billing extends ClientSDK {
   /**
-   * List Billing Usage
+   * Retrieve billing usage
    *
    * @remarks
    * Returns the billing usage of a project

package/src/sdk/elasticips.ts

@@ -0,0 +1,113 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { elasticIpsCreateElasticIp } from "../funcs/elasticIpsCreateElasticIp.js";
+import { elasticIpsDeleteElasticIp } from "../funcs/elasticIpsDeleteElasticIp.js";
+import { elasticIpsGetElasticIp } from "../funcs/elasticIpsGetElasticIp.js";
+import { elasticIpsListElasticIps } from "../funcs/elasticIpsListElasticIps.js";
+import { elasticIpsUpdateElasticIp } from "../funcs/elasticIpsUpdateElasticIp.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+
+export class ElasticIps extends ClientSDK {
+  /**
+   * List Elastic IPs
+   *
+   * @remarks
+   * List all Elastic IPs for the authenticated team. Elastic IPs are static public IP addresses that can be assigned to servers and moved between servers within the same project.
+   *
+   * **Note:** This feature requires the `elastic_ips` feature flag to be enabled for your team. When the flag is disabled, the endpoint returns an empty list.
+   */
+  async listElasticIps(
+    request?: operations.ListElasticIpsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<operations.ListElasticIpsResponse, { page: number }>
+  > {
+    return unwrapResultIterator(elasticIpsListElasticIps(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create an Elastic IP
+   *
+   * @remarks
+   * Creates a new Elastic IP and assigns it to the specified server. The IP is provisioned asynchronously—the response will show status `configuring` and the `id` will be `null` until provisioning completes.
+   *
+   * **Note:** This feature requires the `elastic_ips` feature flag to be enabled for your team. Currently only IPv4 /32 addresses in routed mode are supported.
+   */
+  async createElasticIp(
+    request: models.CreateElasticIp,
+    options?: RequestOptions,
+  ): Promise<models.ElasticIp> {
+    return unwrapAsync(elasticIpsCreateElasticIp(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve an Elastic IP
+   *
+   * @remarks
+   * Returns a single Elastic IP by its ID.
+   *
+   * **Note:** This feature requires the `elastic_ips` feature flag to be enabled for your team.
+   */
+  async getElasticIp(
+    request: operations.GetElasticIpRequest,
+    options?: RequestOptions,
+  ): Promise<models.ElasticIp> {
+    return unwrapAsync(elasticIpsGetElasticIp(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Release an Elastic IP
+   *
+   * @remarks
+   * Releases an Elastic IP, returning it to the available pool. The IP will transition to `releasing` status before being fully removed.
+   *
+   * **Note:** This feature requires the `elastic_ips` feature flag to be enabled for your team. Only Elastic IPs with status `active` or `error` can be released.
+   */
+  async deleteElasticIp(
+    request: operations.DeleteElasticIpRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(elasticIpsDeleteElasticIp(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Move an Elastic IP
+   *
+   * @remarks
+   * Moves an Elastic IP to a different server within the same project. The reassignment is performed asynchronously.
+   *
+   * **Note:** This feature requires the `elastic_ips` feature flag to be enabled for your team. The Elastic IP must be in `active` status and the target server must belong to the same project.
+   */
+  async updateElasticIp(
+    request: operations.UpdateElasticIpRequest,
+    options?: RequestOptions,
+  ): Promise<models.ElasticIp> {
+    return unwrapAsync(elasticIpsUpdateElasticIp(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/events.ts

@@ -9,10 +9,10 @@ import { PageIterator, unwrapResultIterator } from "../types/operations.js";
 
 export class Events extends ClientSDK {
   /**
-   * List all Events
+   * List events
    *
    * @remarks
-   * Lists all events.
+   * Lists actions performed by users on your account.
    */
   async list(
     request?: operations.GetEventsRequest | undefined,

package/src/sdk/firewalls.ts

@@ -24,10 +24,10 @@ export class Firewalls extends ClientSDK {
   }
 
   /**
-   * List All Firewall Assignments
+   * List firewall assignments
    *
    * @remarks
-   * List all firewall assignments
+   * Returns a list of all servers assigned to one or more firewalls.
    */
   async getAllFirewallAssignments(
     request?: operations.GetAllFirewallAssignmentsRequest | undefined,
@@ -43,16 +43,16 @@ export class Firewalls extends ClientSDK {
   }
 
   /**
-   * List firewalls
+   * Create firewall
    *
    * @remarks
-   * List firewalls
+   * Create a firewall
    */
-  async list(
-    request?: operations.ListFirewallsRequest | undefined,
+  async create(
+    request: operations.CreateFirewallRequest,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.ListFirewallsResponse, { page: number }>> {
-    return unwrapResultIterator(firewallsList(
+  ): Promise<models.Firewall> {
+    return unwrapAsync(firewallsCreate(
       this,
       request,
       options,
@@ -60,16 +60,16 @@ export class Firewalls extends ClientSDK {
   }
 
   /**
-   * Create a firewall
+   * List firewalls
    *
    * @remarks
-   * Create a firewall
+   * List firewalls
    */
-  async create(
-    request: operations.CreateFirewallRequest,
+  async list(
+    request?: operations.ListFirewallsRequest | undefined,
     options?: RequestOptions,
-  ): Promise<models.Firewall> {
-    return unwrapAsync(firewallsCreate(
+  ): Promise<PageIterator<operations.ListFirewallsResponse, { page: number }>> {
+    return unwrapResultIterator(firewallsList(
       this,
       request,
       options,
@@ -77,10 +77,10 @@ export class Firewalls extends ClientSDK {
   }
 
   /**
-   * Retrieve Firewall
+   * Retrieve firewall
    *
    * @remarks
-   * Retrieve a firewall
+   * Returns a single firewall by its ID.
    */
   async get(
     request: operations.GetFirewallRequest,
@@ -94,16 +94,16 @@ export class Firewalls extends ClientSDK {
   }
 
   /**
-   * Delete Firewall
+   * Update firewall
    *
    * @remarks
-   * Delete a firewall
+   * Updates a firewall by its ID.
    */
-  async delete(
-    request: operations.DeleteFirewallRequest,
+  async update(
+    request: operations.UpdateFirewallRequest,
     options?: RequestOptions,
-  ): Promise<void> {
-    return unwrapAsync(firewallsDelete(
+  ): Promise<models.Firewall> {
+    return unwrapAsync(firewallsUpdate(
       this,
       request,
       options,
@@ -111,16 +111,13 @@ export class Firewalls extends ClientSDK {
   }
 
   /**
-   * Update Firewall
-   *
-   * @remarks
-   * Update a firewall
+   * Delete firewall
    */
-  async update(
-    request: operations.UpdateFirewallRequest,
+  async delete(
+    request: operations.DeleteFirewallRequest,
     options?: RequestOptions,
-  ): Promise<models.Firewall> {
-    return unwrapAsync(firewallsUpdate(
+  ): Promise<void> {
+    return unwrapAsync(firewallsDelete(
       this,
       request,
       options,
@@ -128,10 +125,10 @@ export class Firewalls extends ClientSDK {
   }
 
   /**
-   * Firewall Assignments
+   * Firewall assignments
    *
    * @remarks
-   * List servers assigned to a firewall
+   * Returns a list of all servers assigned to a particular firewall.
    */
   async listAssignments(
     request: operations.GetFirewallAssignmentsRequest,
@@ -147,10 +144,10 @@ export class Firewalls extends ClientSDK {
   }
 
   /**
-   * Delete Firewall Assignment
+   * Delete assignment
    *
    * @remarks
-   * Remove a server from a firewall
+   * Removes a server from a firewall by its ID.
    */
   async deleteAssignment(
     request: operations.DeleteFirewallAssignmentRequest,

package/src/sdk/kubernetesclusters.ts

@@ -0,0 +1,104 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { kubernetesClustersCreateKubernetesCluster } from "../funcs/kubernetesClustersCreateKubernetesCluster.js";
+import { kubernetesClustersDeleteKubernetesCluster } from "../funcs/kubernetesClustersDeleteKubernetesCluster.js";
+import { kubernetesClustersGetKubernetesCluster } from "../funcs/kubernetesClustersGetKubernetesCluster.js";
+import { kubernetesClustersGetKubernetesClusterKubeconfig } from "../funcs/kubernetesClustersGetKubernetesClusterKubeconfig.js";
+import { kubernetesClustersListKubernetesClusters } from "../funcs/kubernetesClustersListKubernetesClusters.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class KubernetesClusters extends ClientSDK {
+  /**
+   * List Kubernetes Clusters
+   *
+   * @remarks
+   * Lists all Kubernetes clusters for a project.
+   */
+  async listKubernetesClusters(
+    request: operations.ListKubernetesClustersRequest,
+    options?: RequestOptions,
+  ): Promise<models.KubernetesClusters> {
+    return unwrapAsync(kubernetesClustersListKubernetesClusters(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create a Kubernetes Cluster
+   *
+   * @remarks
+   * Creates a new managed Kubernetes cluster. The cluster will be provisioned using Cluster API (CAPI) on the Management Cluster.
+   *
+   * **Note:** This feature requires the `managed_k8s_clusters_api` feature flag to be enabled for your team. Maximum of 1 cluster per project.
+   *
+   * Cluster names must follow Kubernetes naming rules: lowercase alphanumeric characters or hyphens, must start and end with an alphanumeric character, and be at most 63 characters long.
+   */
+  async createKubernetesCluster(
+    request: models.CreateKubernetesCluster,
+    options?: RequestOptions,
+  ): Promise<models.KubernetesClusterCreateResponse> {
+    return unwrapAsync(kubernetesClustersCreateKubernetesCluster(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get a Kubernetes Cluster
+   *
+   * @remarks
+   * Retrieves detailed information about a Kubernetes cluster including its status, control plane, and worker node details.
+   */
+  async getKubernetesCluster(
+    request: operations.GetKubernetesClusterRequest,
+    options?: RequestOptions,
+  ): Promise<models.KubernetesCluster> {
+    return unwrapAsync(kubernetesClustersGetKubernetesCluster(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a Kubernetes Cluster
+   *
+   * @remarks
+   * Deletes a Kubernetes cluster. This action is irreversible and will destroy all cluster resources.
+   */
+  async deleteKubernetesCluster(
+    request: operations.DeleteKubernetesClusterRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(kubernetesClustersDeleteKubernetesCluster(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get Kubernetes Cluster Kubeconfig
+   *
+   * @remarks
+   * Retrieves the kubeconfig file for a Kubernetes cluster. The kubeconfig is only available once the cluster is fully provisioned.
+   */
+  async getKubernetesClusterKubeconfig(
+    request: operations.GetKubernetesClusterKubeconfigRequest,
+    options?: RequestOptions,
+  ): Promise<models.KubernetesClusterKubeconfig> {
+    return unwrapAsync(kubernetesClustersGetKubernetesClusterKubeconfig(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/members.ts

@@ -9,7 +9,7 @@ import { PageIterator, unwrapResultIterator } from "../types/operations.js";
 
 export class Members extends ClientSDK {
   /**
-   * List all Team Members
+   * List members
    */
   async getTeamMembers(
     request?: operations.GetTeamMembersRequest | undefined,

package/src/sdk/operatingsystems.ts

@@ -9,7 +9,7 @@ import { PageIterator, unwrapResultIterator } from "../types/operations.js";
 
 export class OperatingSystems extends ClientSDK {
   /**
-   * List all operating systems available
+   * List operating systems
    *
    * @remarks
    * Lists all operating systems available to deploy and reinstall.