latitudesh-typescript-sdk 0.2.1 → 0.2.3

package/src/funcs/plansVmList.ts

@@ -3,8 +3,10 @@
  */
 
 import { LatitudeshCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
 import { RequestOptions } from "../lib/sdks.js";
 import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
 import { pathToFunc } from "../lib/url.js";
@@ -19,14 +21,16 @@ import { LatitudeshError } from "../models/errors/latitudesherror.js";
 import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * List VM plans
+ * List all Virtual Machines Plans
  */
 export function plansVmList(
   client: LatitudeshCore,
+  request?: operations.GetVmPlansRequest | undefined,
   options?: RequestOptions,
 ): APIPromise<
   Result<
@@ -43,12 +47,14 @@ export function plansVmList(
 > {
   return new APIPromise($do(
     client,
+    request,
     options,
   ));
 }
 
 async function $do(
   client: LatitudeshCore,
+  request?: operations.GetVmPlansRequest | undefined,
   options?: RequestOptions,
 ): Promise<
   [
@@ -66,8 +72,24 @@ async function $do(
     APICall,
   ]
 > {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.GetVmPlansRequest$outboundSchema.optional().parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
   const path = pathToFunc("/plans/virtual_machines")();
 
+  const query = encodeFormQuery({
+    "filter[gpu]": payload?.["filter[gpu]"],
+  });
+
   const headers = new Headers(compactMap({
     Accept: "application/vnd.api+json",
   }));
@@ -97,6 +119,8 @@ async function $do(
     baseURL: options?.serverURL,
     path: path,
     headers: headers,
+    query: query,
+    body: body,
     userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);

package/src/funcs/privateNetworksAssign.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Assign VLAN
+ * Assign Virtual network
  */
 export function privateNetworksAssign(
   client: LatitudeshCore,

package/src/funcs/privateNetworksCreate.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create VLAN
+ * Create a Virtual Network
  *
  * @remarks
  * Creates a new Virtual Network.

package/src/funcs/privateNetworksDeleteAssignment.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Delete assignment
+ * Delete Virtual Network Assignment
  *
  * @remarks
  * Allow you to remove a Virtual Network assignment.

package/src/funcs/privateNetworksGet.ts

@@ -25,7 +25,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Retrieve VLAN
+ * Retrieve a Virtual Network
  *
  * @remarks
  * Retrieve a Virtual Network.

package/src/funcs/privateNetworksList.ts

@@ -32,7 +32,7 @@ import {
 } from "../types/operations.js";
 
 /**
- * List VLANs
+ * List all Virtual Networks
  *
  * @remarks
  * Lists virtual networks assigned to a project

package/src/funcs/privateNetworksListAssignments.ts

@@ -32,7 +32,7 @@ import {
 } from "../types/operations.js";
 
 /**
- * List VLAN assignments
+ * List all servers assigned to virtual networks
  *
  * @remarks
  * Returns a list of all servers assigned to virtual networks.

package/src/funcs/privateNetworksUpdate.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Update VLAN
+ * Update a Virtual Network
  *
  * @remarks
  * Update a Virtual Network.

package/src/funcs/projectsCreate.ts

@@ -25,7 +25,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create a project
+ * Create a Project
  */
 export function projectsCreate(
   client: LatitudeshCore,

package/src/funcs/projectsDelete.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Delete a project
+ * Delete a Project
  */
 export function projectsDelete(
   client: LatitudeshCore,

package/src/funcs/projectsList.ts

@@ -32,7 +32,7 @@ import {
 } from "../types/operations.js";
 
 /**
- * List projects
+ * List all Projects
  *
  * @remarks
  * Returns a list of all projects for the current team

package/src/funcs/projectsSshKeysPostProjectSshKey.ts

@@ -25,10 +25,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create a SSH key
+ * Create a Project SSH Key
  *
  * @remarks
- * Allow you create SSH keys in a project. These keys can be used to access servers after deploy and reinstall actions.
+ * Allow you create SSH Keys in a project. These keys can be used to access servers after deploy and reinstall actions.
  *
  * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */

package/src/funcs/projectsUpdate.ts

@@ -25,7 +25,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Update a project
+ * Update a Project
  */
 export function projectsUpdate(
   client: LatitudeshCore,

package/src/funcs/regionsFetch.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Retrieve region
+ * Retrieve a Region
  */
 export function regionsFetch(
   client: LatitudeshCore,

package/src/funcs/regionsGet.ts

@@ -32,7 +32,7 @@ import {
 } from "../types/operations.js";
 
 /**
- * List regions
+ * List all Regions
  *
  * @remarks
  * Lists all [available locations](https://latitude.sh/locations). For server availability by location, please see the [Plans API](/reference/get-plans).

package/src/funcs/rolesGet.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Retrieve role
+ * Retrieve Role
  */
 export function rolesGet(
   client: LatitudeshCore,

package/src/funcs/rolesList.ts

@@ -32,7 +32,7 @@ import {
 } from "../types/operations.js";
 
 /**
- * List roles
+ * List all Roles
  *
  * @remarks
  * Returns a list of all roles that can be assigned to users

package/src/funcs/serversCreate.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create server
+ * Deploy Server
  */
 export function serversCreate(
   client: LatitudeshCore,

package/src/funcs/serversCreateIpmiSession.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create IPMI credentials
+ * Generate IPMI credentials
  *
  * @remarks
  * Generates IPMI credentials for a given server. Remote access creates a VPN connection to the internal network of your server so you can connect to its IPMI.

package/src/funcs/serversDelete.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Remove server
+ * Remove Server
  */
 export function serversDelete(
   client: LatitudeshCore,

package/src/funcs/serversExitRescueMode.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Exits rescue mode
+ * Exits rescue mode for a Server
  *
  * @remarks
  * Exits rescue mode on a given server.

package/src/funcs/serversGet.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Retrieve server
+ * Retrieve a Server
  *
  * @remarks
  * Returns a server that belongs to the team.

package/src/funcs/serversGetDeployConfig.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Retrieve deploy config
+ * Retrieve Deploy Config
  */
 export function serversGetDeployConfig(
   client: LatitudeshCore,

package/src/funcs/serversGetOutOfBand.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * List out-of-band connections
+ * List Out of Band Connections
  */
 export function serversGetOutOfBand(
   client: LatitudeshCore,

package/src/funcs/serversList.ts

@@ -32,7 +32,7 @@ import {
 } from "../types/operations.js";
 
 /**
- * List servers
+ * List all Servers
  *
  * @remarks
  * Returns a list of all servers belonging to the team.

package/src/funcs/serversLock.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Lock server
+ * Lock the server
  *
  * @remarks
  * Locks the server. A locked server cannot be deleted or modified and no actions can be performed on it.

package/src/funcs/serversReinstall.ts

@@ -26,10 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Reinstall server
- *
- * @remarks
- * Reinstalls the server with a new operating system. All data on the server will be wiped during this process.
+ * Run Server Reinstall
  */
 export function serversReinstall(
   client: LatitudeshCore,

package/src/funcs/serversRunAction.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Run power action
+ * Run Server Action
  *
  * @remarks
  * Performs an action on a given server:

package/src/funcs/serversScheduleDeletion.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Schedule server deletion
+ * Schedule the server deletion
  *
  * @remarks
  * Schedules the server to be removed at the end of the billing cycle.

package/src/funcs/serversStartOutOfBandConnection.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create out-of-band connection
+ * Start Out of Band Connection
  */
 export function serversStartOutOfBandConnection(
   client: LatitudeshCore,

package/src/funcs/serversStartRescueMode.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Put server in rescue mode
+ * Puts a Server in rescue mode
  *
  * @remarks
  * Starts rescue mode on a given server.

package/src/funcs/serversUnlock.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Unlock server
+ * Unlock the server
  *
  * @remarks
  * Unlocks the server. A locked server cannot be deleted or modified and no actions can be performed on it.

package/src/funcs/serversUnscheduleDeletion.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Unschedule server deletion
+ * Unschedule the server deletion
  *
  * @remarks
  * Unschedules the server removal at the end of the billing cycle.

package/src/funcs/serversUpdate.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Update server
+ * Update Server
  */
 export function serversUpdate(
   client: LatitudeshCore,

package/src/funcs/serversUpdateDeployConfig.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Update deploy config
+ * Update Deploy Config
  */
 export function serversUpdateDeployConfig(
   client: LatitudeshCore,

package/src/funcs/sshKeysList.ts

@@ -26,10 +26,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * List SSH keys
+ * List all Project SSH Keys
  *
  * @remarks
- * List SSH keys in the project. These keys can be used to access servers after deploy and reinstall actions.
+ * List all SSH Keys in the project. These keys can be used to access servers after deploy and reinstall actions.
  *
  * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */

package/src/funcs/sshKeysListAll.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * List SSH Keys
+ * List all SSH Keys
  *
  * @remarks
  * List all SSH Keys in the project. These keys can be used to access servers after deploy and reinstall actions.

package/src/funcs/storageCreateFilesystem.ts

@@ -25,7 +25,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create filesystem
+ * Create a filesystem for a project
  *
  * @remarks
  * Allows you to add persistent storage to a project. These filesystems can be used to store data across your servers.

package/src/funcs/storageDeleteFilesystem.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Delete filesystem
+ * Delete a filesystem for a project
  *
  * @remarks
  * Allows you to remove persistent storage from a project.

package/src/funcs/storageGetStorageVolume.ts

@@ -25,7 +25,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Retrieve volume
+ * Get volume
  *
  * @remarks
  * Shows details of a specific volume storage.

package/src/funcs/storageUpdateFilesystem.ts

@@ -25,7 +25,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Update filesystem
+ * Update a filesystem for a project
  *
  * @remarks
  * Allow you to upgrade the size of a filesystem.

package/src/funcs/tagsCreate.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create tag
+ * Create a Tag
  *
  * @remarks
  * Create a Tag in the team.

package/src/funcs/tagsDelete.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Delete tag
+ * Delete Tag
  *
  * @remarks
  * Update a Tag in the team.

package/src/funcs/tagsList.ts

@@ -23,7 +23,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * List tags
+ * List all Tags
  *
  * @remarks
  * List all Tags in the team.

package/src/funcs/tagsUpdate.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Update tag
+ * Update Tag
  *
  * @remarks
  * Update a Tag in the team.

package/src/funcs/teamMembersDelete.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Remove a member
+ * Remove a Team Member
  */
 export function teamMembersDelete(
   client: LatitudeshCore,

package/src/funcs/teamMembersPostTeamMembers.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create member
+ * Add a Team Member
  */
 export function teamMembersPostTeamMembers(
   client: LatitudeshCore,

package/src/funcs/teamsCreate.ts

@@ -25,7 +25,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create team
+ * Create a team
  */
 export function teamsCreate(
   client: LatitudeshCore,

package/src/funcs/teamsGet.ts

@@ -23,7 +23,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Retrieve team
+ * Retrieve the team
  */
 export function teamsGet(
   client: LatitudeshCore,

package/src/funcs/teamsMembersGetTeamMembers.ts

@@ -32,7 +32,7 @@ import {
 } from "../types/operations.js";
 
 /**
- * List members
+ * List all Team Members
  */
 export function teamsMembersGetTeamMembers(
   client: LatitudeshCore,

package/src/funcs/teamsUpdate.ts

@@ -25,7 +25,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Update team
+ * Update a team
  */
 export function teamsUpdate(
   client: LatitudeshCore,

package/src/funcs/trafficGet.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Retrieve traffic
+ * Retrieve Traffic consumption
  */
 export function trafficGet(
   client: LatitudeshCore,

package/src/funcs/trafficGetQuota.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Retrieve traffic quota
+ * Retrieve Traffic Quota
  */
 export function trafficGetQuota(
   client: LatitudeshCore,

package/src/funcs/userDataCreate.ts

@@ -26,10 +26,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create a Project User data
+ * Create a Project User Data
  *
  * @remarks
- * Allows you to create User data in a project, which can be used to perform custom setup on your servers after deploy and reinstall.
+ * Allows you to create User Data in a project, which can be used to perform custom setup on your servers after deploy and reinstall.
  *
  * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */

package/src/funcs/userDataCreateNew.ts

@@ -26,10 +26,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create user data
+ * Create an User Data
  *
  * @remarks
- * Allows you to create User data in a team, which can be used to perform custom setup on your servers after deploy and reinstall.
+ * Allows you to create User Data in a team, which can be used to perform custom setup on your servers after deploy and reinstall.
  */
 export function userDataCreateNew(
   client: LatitudeshCore,