latitudesh-typescript-sdk 0.2.1 → 0.2.2

package/src/sdk/servers.ts

@@ -28,7 +28,7 @@ import { PageIterator, unwrapResultIterator } from "../types/operations.js";
 
 export class Servers extends ClientSDK {
   /**
-   * List servers
+   * List all Servers
    *
    * @remarks
    * Returns a list of all servers belonging to the team.
@@ -45,7 +45,7 @@ export class Servers extends ClientSDK {
   }
 
   /**
-   * Create server
+   * Deploy Server
    */
   async create(
     request: operations.CreateServerRequest,
@@ -59,7 +59,7 @@ export class Servers extends ClientSDK {
   }
 
   /**
-   * Retrieve server
+   * Retrieve a Server
    *
    * @remarks
    * Returns a server that belongs to the team.
@@ -76,7 +76,7 @@ export class Servers extends ClientSDK {
   }
 
   /**
-   * Remove server
+   * Remove Server
    */
   async delete(
     request: operations.DestroyServerRequest,
@@ -90,7 +90,7 @@ export class Servers extends ClientSDK {
   }
 
   /**
-   * Update server
+   * Update Server
    */
   async update(
     request: operations.UpdateServerRequest,
@@ -104,7 +104,7 @@ export class Servers extends ClientSDK {
   }
 
   /**
-   * Retrieve deploy config
+   * Retrieve Deploy Config
    */
   async getDeployConfig(
     request: operations.GetServerDeployConfigRequest,
@@ -118,7 +118,7 @@ export class Servers extends ClientSDK {
   }
 
   /**
-   * Update deploy config
+   * Update Deploy Config
    */
   async updateDeployConfig(
     request: operations.UpdateServerDeployConfigRequest,
@@ -132,7 +132,7 @@ export class Servers extends ClientSDK {
   }
 
   /**
-   * 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.
@@ -149,7 +149,7 @@ export class Servers extends ClientSDK {
   }
 
   /**
-   * 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.
@@ -166,7 +166,7 @@ export class Servers extends ClientSDK {
   }
 
   /**
-   * List out-of-band connections
+   * List Out of Band Connections
    */
   async getOutOfBand(
     request: operations.GetServerOutOfBandRequest,
@@ -180,7 +180,7 @@ export class Servers extends ClientSDK {
   }
 
   /**
-   * Create out-of-band connection
+   * Start Out of Band Connection
    */
   async startOutOfBandConnection(
     request: operations.CreateServerOutOfBandRequest,
@@ -194,7 +194,7 @@ export class Servers extends ClientSDK {
   }
 
   /**
-   * Run power action
+   * Run Server Action
    *
    * @remarks
    * Performs an action on a given server:
@@ -214,7 +214,7 @@ export class Servers extends ClientSDK {
   }
 
   /**
-   * 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.
@@ -234,7 +234,7 @@ export class Servers extends ClientSDK {
   }
 
   /**
-   * Put server in rescue mode
+   * Puts a Server in rescue mode
    *
    * @remarks
    * Starts rescue mode on a given server.
@@ -251,7 +251,7 @@ export class Servers extends ClientSDK {
   }
 
   /**
-   * Exits rescue mode
+   * Exits rescue mode for a Server
    *
    * @remarks
    * Exits rescue mode on a given server.
@@ -268,7 +268,7 @@ export class Servers extends ClientSDK {
   }
 
   /**
-   * Schedule server deletion
+   * Schedule the server deletion
    *
    * @remarks
    * Schedules the server to be removed at the end of the billing cycle.
@@ -285,7 +285,7 @@ export class Servers extends ClientSDK {
   }
 
   /**
-   * Unschedule server deletion
+   * Unschedule the server deletion
    *
    * @remarks
    * Unschedules the server removal at the end of the billing cycle.
@@ -302,10 +302,7 @@ export class Servers extends ClientSDK {
   }
 
   /**
-   * 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
    */
   async reinstall(
     request: operations.CreateServerReinstallRequest,

package/src/sdk/sshkeys.ts

@@ -18,10 +18,10 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class SSHKeys extends ClientSDK {
   /**
-   * 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.
    */
@@ -94,7 +94,7 @@ export class SSHKeys extends ClientSDK {
   }
 
   /**
-   * 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/sdk/storage.ts

@@ -34,7 +34,7 @@ export class Storage extends ClientSDK {
   }
 
   /**
-   * 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.
@@ -51,7 +51,7 @@ export class Storage extends ClientSDK {
   }
 
   /**
-   * Delete filesystem
+   * Delete a filesystem for a project
    *
    * @remarks
    * Allows you to remove persistent storage from a project.
@@ -68,7 +68,7 @@ export class Storage extends ClientSDK {
   }
 
   /**
-   * Update filesystem
+   * Update a filesystem for a project
    *
    * @remarks
    * Allow you to upgrade the size of a filesystem.
@@ -119,7 +119,7 @@ export class Storage extends ClientSDK {
   }
 
   /**
-   * Retrieve volume
+   * Get volume
    *
    * @remarks
    * Shows details of a specific volume storage.

package/src/sdk/tags.ts

@@ -13,7 +13,7 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class Tags extends ClientSDK {
   /**
-   * List tags
+   * List all Tags
    *
    * @remarks
    * List all Tags in the team.
@@ -28,7 +28,7 @@ export class Tags extends ClientSDK {
   }
 
   /**
-   * Create tag
+   * Create a Tag
    *
    * @remarks
    * Create a Tag in the team.
@@ -45,7 +45,7 @@ export class Tags extends ClientSDK {
   }
 
   /**
-   * Delete tag
+   * Delete Tag
    *
    * @remarks
    * Update a Tag in the team.
@@ -62,7 +62,7 @@ export class Tags extends ClientSDK {
   }
 
   /**
-   * Update tag
+   * Update Tag
    *
    * @remarks
    * Update a Tag in the team.

package/src/sdk/teammembers.ts

@@ -11,7 +11,7 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class TeamMembers extends ClientSDK {
   /**
-   * Create member
+   * Add a Team Member
    */
   async postTeamMembers(
     request: operations.PostTeamMembersRequest,
@@ -25,7 +25,7 @@ export class TeamMembers extends ClientSDK {
   }
 
   /**
-   * Remove a member
+   * Remove a Team Member
    */
   async delete(
     request: operations.DestroyTeamMemberRequest,

package/src/sdk/teams.ts

@@ -18,7 +18,7 @@ export class Teams extends ClientSDK {
   }
 
   /**
-   * Retrieve team
+   * Retrieve the team
    */
   async get(
     options?: RequestOptions,
@@ -30,7 +30,7 @@ export class Teams extends ClientSDK {
   }
 
   /**
-   * Create team
+   * Create a team
    */
   async create(
     request: operations.PostTeamRequest,
@@ -44,7 +44,7 @@ export class Teams extends ClientSDK {
   }
 
   /**
-   * Update team
+   * Update a team
    */
   async update(
     request: operations.PatchCurrentTeamRequest,

package/src/sdk/traffic.ts

@@ -11,7 +11,7 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class Traffic extends ClientSDK {
   /**
-   * Retrieve traffic
+   * Retrieve Traffic consumption
    */
   async get(
     request: operations.GetTrafficConsumptionRequest,
@@ -25,7 +25,7 @@ export class Traffic extends ClientSDK {
   }
 
   /**
-   * Retrieve traffic quota
+   * Retrieve Traffic Quota
    */
   async getQuota(
     request?: operations.GetTrafficQuotaRequest | undefined,

package/src/sdk/userdata.ts

@@ -19,7 +19,7 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class UserData extends ClientSDK {
   /**
-   * List all Project User data
+   * List all Project User Data
    *
    * @remarks
    * List all Users Data in the project. These scripts can be used to configure servers with user data.
@@ -38,10 +38,10 @@ export class UserData extends ClientSDK {
   }
 
   /**
-   * Retrieve a Project User data
+   * Retrieve a Project User Data
    *
    * @remarks
-   * Get User data in the project. These scripts can be used to configure servers with user data.
+   * Get User Data in the project. These scripts can be used to configure servers with user data.
    *
    * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
    */
@@ -57,10 +57,10 @@ export class UserData extends ClientSDK {
   }
 
   /**
-   * Delete a Project User data
+   * Delete a Project User Data
    *
    * @remarks
-   * Allow you remove User data in a project.
+   * Allow you remove User Data in a project.
    *
    * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
    */
@@ -76,10 +76,10 @@ export class UserData extends ClientSDK {
   }
 
   /**
-   * 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.
    */
@@ -95,10 +95,10 @@ export class UserData extends ClientSDK {
   }
 
   /**
-   * Update a Project User data
+   * Update a Project User Data
    *
    * @remarks
-   * Allow you update User data in a project.
+   * Allow you update User Data in a project.
    *
    * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
    */
@@ -114,7 +114,7 @@ export class UserData extends ClientSDK {
   }
 
   /**
-   * List user data
+   * List all User Data
    *
    * @remarks
    * List all Users Data in the project. These scripts can be used to configure servers with user data.
@@ -131,10 +131,10 @@ export class UserData extends ClientSDK {
   }
 
   /**
-   * 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.
    */
   async createNew(
     request: operations.PostUserDataRequest,
@@ -148,10 +148,10 @@ export class UserData extends ClientSDK {
   }
 
   /**
-   * Retrieve user data
+   * Retrieve an User Data
    *
    * @remarks
-   * Get User data in the project. These scripts can be used to configure servers with user data.
+   * Get User Data in the project. These scripts can be used to configure servers with user data.
    */
   async retrieve(
     request: operations.GetUserDataRequest,
@@ -165,7 +165,7 @@ export class UserData extends ClientSDK {
   }
 
   /**
-   * Delete user data
+   * Delete an User Data
    */
   async delete(
     request: operations.DeleteUserDataRequest,
@@ -179,10 +179,10 @@ export class UserData extends ClientSDK {
   }
 
   /**
-   * Update user data
+   * Update an User Data
    *
    * @remarks
-   * Allow you update User data in a team.
+   * Allow you update User Data in a team.
    */
   async update(
     request: operations.PatchUserDataRequest,

package/src/sdk/userprofile.ts

@@ -12,7 +12,7 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class UserProfile extends ClientSDK {
   /**
-   * Retrieve profile
+   * Get user profile
    *
    * @remarks
    * Retrieve the current user profile
@@ -27,7 +27,7 @@ export class UserProfile extends ClientSDK {
   }
 
   /**
-   * Update profile
+   * Update User Profile
    *
    * @remarks
    * Update the current user profile
@@ -44,7 +44,7 @@ export class UserProfile extends ClientSDK {
   }
 
   /**
-   * List user teams
+   * List User Teams
    *
    * @remarks
    * Returns a list of all teams the user belongs to

package/src/sdk/virtualmachines.ts

@@ -14,10 +14,10 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class VirtualMachines extends ClientSDK {
   /**
-   * List VMs
+   * Get Teams Virtual Machines
    *
    * @remarks
-   * Show all Team's Virtual machines.
+   * Show all Team's Virtual Machines.
    */
   async list(
     request?: operations.IndexVirtualMachineRequest | undefined,
@@ -31,7 +31,7 @@ export class VirtualMachines extends ClientSDK {
   }
 
   /**
-   * Create VM
+   * Create a Virtual Machine
    *
    * @remarks
    * Creates a new Virtual Machine.
@@ -48,7 +48,7 @@ export class VirtualMachines extends ClientSDK {
   }
 
   /**
-   * Retrieve VM
+   * Get a Virtual Machine
    *
    * @remarks
    * Show a Virtual Machine.
@@ -65,7 +65,7 @@ export class VirtualMachines extends ClientSDK {
   }
 
   /**
-   * Destroy VM
+   * Destroy a Virtual Machine
    *
    * @remarks
    * Destroys a Virtual Machine.
@@ -82,7 +82,7 @@ export class VirtualMachines extends ClientSDK {
   }
 
   /**
-   * Run VM power action
+   * Run Virtual Machine Action
    *
    * @remarks
    * Performs a power action on a given virtual machine:

package/src/sdk/virtualnetworks.ts

@@ -9,7 +9,7 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class VirtualNetworks extends ClientSDK {
   /**
-   * Delete VLAN
+   * Delete a Virtual Network
    *
    * @remarks
    * Delete virtual network

package/src/sdk/vm.ts

@@ -5,17 +5,20 @@
 import { plansVmList } from "../funcs/plansVmList.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 Vm extends ClientSDK {
   /**
-   * List VM plans
+   * List all Virtual Machines Plans
    */
   async list(
+    request?: operations.GetVmPlansRequest | undefined,
     options?: RequestOptions,
   ): Promise<models.VirtualMachinePlans> {
     return unwrapAsync(plansVmList(
       this,
+      request,
       options,
     ));
   }

package/src/sdk/vpnsessions.ts

@@ -13,10 +13,7 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class VpnSessions extends ClientSDK {
   /**
-   * List VPN sessions
-   *
-   * @remarks
-   * List active VPN sessions.
+   * List all Active VPN Sessions
    */
   async list(
     request?: operations.GetVpnSessionsRequest | undefined,
@@ -30,7 +27,7 @@ export class VpnSessions extends ClientSDK {
   }
 
   /**
-   * Create VPN session
+   * Create a VPN Session
    *
    * @remarks
    * Creates a new VPN Session.
@@ -48,7 +45,7 @@ export class VpnSessions extends ClientSDK {
   }
 
   /**
-   * Refresh VPN session
+   * Refresh a VPN Session
    *
    * @remarks
    * Refreshing an existing VPN Session will create new credentials for that session
@@ -65,7 +62,7 @@ export class VpnSessions extends ClientSDK {
   }
 
   /**
-   * Delete VPN session
+   * Delete a VPN Session
    *
    * @remarks
    * Deletes an existing VPN Session.