latitudesh-typescript-sdk 0.2.1 → 0.2.2

package/src/funcs/plansGetContainersPlan.ts

@@ -0,0 +1,169 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { LatitudeshCore } from "../core.js";
+import { encodeSimple } 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";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+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";
+
+/**
+ * Retrieve container plan
+ *
+ * @remarks
+ * Retrieve a container plan.
+ */
+export function plansGetContainersPlan(
+  client: LatitudeshCore,
+  request: operations.GetContainersPlanRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.ContainerPlanData,
+    | LatitudeshError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: LatitudeshCore,
+  request: operations.GetContainersPlanRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.ContainerPlanData,
+      | LatitudeshError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.GetContainersPlanRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    plan_id: encodeSimple("plan_id", payload.plan_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/plans/containers/{plan_id}")(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: "application/vnd.api+json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.bearer);
+  const securityInput = secConfig == null ? {} : { bearer: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "get-containers-plan",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.bearer,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    models.ContainerPlanData,
+    | LatitudeshError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.ContainerPlanData$inboundSchema, {
+      ctype: "application/vnd.api+json",
+    }),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/plansList.ts

@@ -25,7 +25,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * List plans
+ * List all Plans
  *
  * @remarks
  * Lists all plans. Availability by region is included in `attributes.regions.locations.available[*]` node for a given plan.

package/src/funcs/plansListStorage.ts

@@ -23,7 +23,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * List storage plans
+ * List all Storage Plans
  */
 export function plansListStorage(
   client: LatitudeshCore,

package/src/funcs/plansUpdateBandwidth.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Update bandwidth packages
+ * Buy or remove bandwidth packages
  *
  * @remarks
  * Allows to increase or decrease bandwidth packages. Only admins and owners can request.

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.