latitudesh-typescript-sdk 0.2.0 → 0.2.1

package/src/sdk/plans.ts

@@ -4,7 +4,6 @@
 
 import { plansGet } from "../funcs/plansGet.js";
 import { plansGetBandwidth } from "../funcs/plansGetBandwidth.js";
-import { plansGetContainersPlan } from "../funcs/plansGetContainersPlan.js";
 import { plansList } from "../funcs/plansList.js";
 import { plansListStorage } from "../funcs/plansListStorage.js";
 import { plansUpdateBandwidth } from "../funcs/plansUpdateBandwidth.js";
@@ -22,7 +21,7 @@ export class Plans extends ClientSDK {
   }
 
   /**
-   * List all Plans
+   * List plans
    *
    * @remarks
    * Lists all plans. Availability by region is included in `attributes.regions.locations.available[*]` node for a given plan.
@@ -39,7 +38,7 @@ export class Plans extends ClientSDK {
   }
 
   /**
-   * Retrieve a Plan
+   * Retrieve a plan
    */
   async get(
     request: operations.GetPlanRequest,
@@ -53,7 +52,7 @@ export class Plans extends ClientSDK {
   }
 
   /**
-   * List all bandwidth plans
+   * List bandwidth plans
    *
    * @remarks
    * Lists all bandwidth plans.
@@ -72,7 +71,7 @@ export class Plans extends ClientSDK {
   }
 
   /**
-   * Buy or remove bandwidth packages
+   * Update bandwidth packages
    *
    * @remarks
    * Allows to increase or decrease bandwidth packages. Only admins and owners can request.
@@ -89,24 +88,7 @@ export class Plans extends ClientSDK {
   }
 
   /**
-   * Retrieve container plan
-   *
-   * @remarks
-   * Retrieve a container plan.
-   */
-  async getContainersPlan(
-    request: operations.GetContainersPlanRequest,
-    options?: RequestOptions,
-  ): Promise<models.ContainerPlanData> {
-    return unwrapAsync(plansGetContainersPlan(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * List all Storage Plans
+   * List storage plans
    */
   async listStorage(
     options?: RequestOptions,

package/src/sdk/privatenetworks.ts

@@ -17,7 +17,7 @@ import { PageIterator, unwrapResultIterator } from "../types/operations.js";
 
 export class PrivateNetworks extends ClientSDK {
   /**
-   * List all Virtual Networks
+   * List VLANs
    *
    * @remarks
    * Lists virtual networks assigned to a project
@@ -36,7 +36,7 @@ export class PrivateNetworks extends ClientSDK {
   }
 
   /**
-   * Create a Virtual Network
+   * Create VLAN
    *
    * @remarks
    * Creates a new Virtual Network.
@@ -53,7 +53,7 @@ export class PrivateNetworks extends ClientSDK {
   }
 
   /**
-   * Retrieve a Virtual Network
+   * Retrieve VLAN
    *
    * @remarks
    * Retrieve a Virtual Network.
@@ -70,7 +70,7 @@ export class PrivateNetworks extends ClientSDK {
   }
 
   /**
-   * Update a Virtual Network
+   * Update VLAN
    *
    * @remarks
    * Update a Virtual Network.
@@ -87,7 +87,7 @@ export class PrivateNetworks extends ClientSDK {
   }
 
   /**
-   * List all servers assigned to virtual networks
+   * List VLAN assignments
    *
    * @remarks
    * Returns a list of all servers assigned to virtual networks.
@@ -109,7 +109,7 @@ export class PrivateNetworks extends ClientSDK {
   }
 
   /**
-   * Assign Virtual network
+   * Assign VLAN
    */
   async assign(
     request: operations.AssignServerVirtualNetworkRequest,
@@ -123,7 +123,7 @@ export class PrivateNetworks extends ClientSDK {
   }
 
   /**
-   * Delete Virtual Network Assignment
+   * Delete assignment
    *
    * @remarks
    * Allow you to remove a Virtual Network assignment.

package/src/sdk/projects.ts

@@ -19,7 +19,7 @@ export class Projects extends ClientSDK {
   }
 
   /**
-   * List all Projects
+   * List projects
    *
    * @remarks
    * Returns a list of all projects for the current team
@@ -36,7 +36,7 @@ export class Projects extends ClientSDK {
   }
 
   /**
-   * Create a Project
+   * Create a project
    */
   async create(
     request: operations.CreateProjectRequest,
@@ -50,7 +50,7 @@ export class Projects extends ClientSDK {
   }
 
   /**
-   * Delete a Project
+   * Delete a project
    */
   async delete(
     request: operations.DeleteProjectRequest,
@@ -64,7 +64,7 @@ export class Projects extends ClientSDK {
   }
 
   /**
-   * Update a Project
+   * Update a project
    */
   async update(
     request: operations.UpdateProjectRequest,

package/src/sdk/projectssshkeys.ts

@@ -9,10 +9,10 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class ProjectsSshKeys extends ClientSDK {
   /**
-   * Create a Project SSH Key
+   * Create a 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/sdk/regions.ts

@@ -12,7 +12,7 @@ import { PageIterator, unwrapResultIterator } from "../types/operations.js";
 
 export class Regions extends ClientSDK {
   /**
-   * List all Regions
+   * List regions
    *
    * @remarks
    * Lists all [available locations](https://latitude.sh/locations). For server availability by location, please see the [Plans API](/reference/get-plans).
@@ -29,7 +29,7 @@ export class Regions extends ClientSDK {
   }
 
   /**
-   * Retrieve a Region
+   * Retrieve region
    */
   async fetch(
     request: operations.GetRegionRequest,

package/src/sdk/roles.ts

@@ -12,7 +12,7 @@ import { PageIterator, unwrapResultIterator } from "../types/operations.js";
 
 export class Roles extends ClientSDK {
   /**
-   * List all Roles
+   * List roles
    *
    * @remarks
    * Returns a list of all roles that can be assigned to users
@@ -29,7 +29,7 @@ export class Roles extends ClientSDK {
   }
 
   /**
-   * Retrieve Role
+   * Retrieve role
    */
   async get(
     request: operations.GetRoleIdRequest,

package/src/sdk/servers.ts

@@ -28,7 +28,7 @@ import { PageIterator, unwrapResultIterator } from "../types/operations.js";
 
 export class Servers extends ClientSDK {
   /**
-   * List all Servers
+   * List servers
    *
    * @remarks
    * Returns a list of all servers belonging to the team.
@@ -45,7 +45,7 @@ export class Servers extends ClientSDK {
   }
 
   /**
-   * Deploy Server
+   * Create server
    */
   async create(
     request: operations.CreateServerRequest,
@@ -59,7 +59,7 @@ export class Servers extends ClientSDK {
   }
 
   /**
-   * Retrieve a Server
+   * Retrieve 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 the server
+   * Lock 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 the server
+   * Unlock 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 {
   }
 
   /**
-   * Start Out of Band Connection
+   * Create out-of-band connection
    */
   async startOutOfBandConnection(
     request: operations.CreateServerOutOfBandRequest,
@@ -194,7 +194,7 @@ export class Servers extends ClientSDK {
   }
 
   /**
-   * Run Server Action
+   * Run power action
    *
    * @remarks
    * Performs an action on a given server:
@@ -214,7 +214,7 @@ export class Servers extends ClientSDK {
   }
 
   /**
-   * Generate IPMI credentials
+   * Create 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 {
   }
 
   /**
-   * Puts a Server in rescue mode
+   * Put server in rescue mode
    *
    * @remarks
    * Starts rescue mode on a given server.
@@ -251,7 +251,7 @@ export class Servers extends ClientSDK {
   }
 
   /**
-   * Exits rescue mode for a Server
+   * Exits rescue mode
    *
    * @remarks
    * Exits rescue mode on a given server.
@@ -268,7 +268,7 @@ export class Servers extends ClientSDK {
   }
 
   /**
-   * Schedule the server deletion
+   * Schedule 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 the server deletion
+   * Unschedule server deletion
    *
    * @remarks
    * Unschedules the server removal at the end of the billing cycle.
@@ -302,7 +302,10 @@ export class Servers extends ClientSDK {
   }
 
   /**
-   * Run Server Reinstall
+   * Reinstall server
+   *
+   * @remarks
+   * Reinstalls the server with a new operating system. All data on the server will be wiped during this process.
    */
   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 all Project SSH Keys
+   * List SSH keys
    *
    * @remarks
-   * List all SSH Keys in the project. These keys can be used to access servers after deploy and reinstall actions.
+   * List 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 all SSH Keys
+   * List 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 a filesystem for a project
+   * Create filesystem
    *
    * @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 a filesystem for a project
+   * Delete filesystem
    *
    * @remarks
    * Allows you to remove persistent storage from a project.
@@ -68,7 +68,7 @@ export class Storage extends ClientSDK {
   }
 
   /**
-   * Update a filesystem for a project
+   * Update filesystem
    *
    * @remarks
    * Allow you to upgrade the size of a filesystem.
@@ -119,7 +119,7 @@ export class Storage extends ClientSDK {
   }
 
   /**
-   * Get volume
+   * Retrieve 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 all Tags
+   * List tags
    *
    * @remarks
    * List all Tags in the team.
@@ -28,7 +28,7 @@ export class Tags extends ClientSDK {
   }
 
   /**
-   * Create a Tag
+   * Create 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 {
   /**
-   * Add a Team Member
+   * Create member
    */
   async postTeamMembers(
     request: operations.PostTeamMembersRequest,
@@ -25,7 +25,7 @@ export class TeamMembers extends ClientSDK {
   }
 
   /**
-   * Remove a Team Member
+   * Remove a member
    */
   async delete(
     request: operations.DestroyTeamMemberRequest,

package/src/sdk/teams.ts

@@ -18,7 +18,7 @@ export class Teams extends ClientSDK {
   }
 
   /**
-   * Retrieve the team
+   * Retrieve team
    */
   async get(
     options?: RequestOptions,
@@ -30,7 +30,7 @@ export class Teams extends ClientSDK {
   }
 
   /**
-   * Create a team
+   * Create team
    */
   async create(
     request: operations.PostTeamRequest,
@@ -44,7 +44,7 @@ export class Teams extends ClientSDK {
   }
 
   /**
-   * Update a team
+   * Update 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 consumption
+   * Retrieve traffic
    */
   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,