latitudesh-typescript-sdk 0.2.0 → 0.2.1

package/src/models/teammembers.ts

@@ -15,14 +15,23 @@ export type TeamMembersRole = {
   updatedAt?: string | undefined;
 };
 
-export type TeamMembersData = {
+export type TeamMembersAttributes = {
   firstName?: string | undefined;
   lastName?: string | undefined;
   email?: string | undefined;
   mfaEnabled?: boolean | undefined;
+  createdAt?: Date | undefined;
+  updatedAt?: Date | undefined;
+  lastLoginAt?: Date | null | undefined;
   role?: TeamMembersRole | undefined;
 };
 
+export type TeamMembersData = {
+  id?: string | undefined;
+  type?: string | undefined;
+  attributes?: TeamMembersAttributes | undefined;
+};
+
 export type TeamMembers = {
   data?: Array<TeamMembersData> | undefined;
 };
@@ -84,8 +93,8 @@ export function teamMembersRoleFromJSON(
 }
 
 /** @internal */
-export const TeamMembersData$inboundSchema: z.ZodType<
-  TeamMembersData,
+export const TeamMembersAttributes$inboundSchema: z.ZodType<
+  TeamMembersAttributes,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -93,42 +102,106 @@ export const TeamMembersData$inboundSchema: z.ZodType<
   last_name: z.string().optional(),
   email: z.string().optional(),
   mfa_enabled: z.boolean().optional(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  last_login_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
   role: z.lazy(() => TeamMembersRole$inboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     "first_name": "firstName",
     "last_name": "lastName",
     "mfa_enabled": "mfaEnabled",
+    "created_at": "createdAt",
+    "updated_at": "updatedAt",
+    "last_login_at": "lastLoginAt",
   });
 });
 /** @internal */
-export type TeamMembersData$Outbound = {
+export type TeamMembersAttributes$Outbound = {
   first_name?: string | undefined;
   last_name?: string | undefined;
   email?: string | undefined;
   mfa_enabled?: boolean | undefined;
+  created_at?: string | undefined;
+  updated_at?: string | undefined;
+  last_login_at?: string | null | undefined;
   role?: TeamMembersRole$Outbound | undefined;
 };
 
 /** @internal */
-export const TeamMembersData$outboundSchema: z.ZodType<
-  TeamMembersData$Outbound,
+export const TeamMembersAttributes$outboundSchema: z.ZodType<
+  TeamMembersAttributes$Outbound,
   z.ZodTypeDef,
-  TeamMembersData
+  TeamMembersAttributes
 > = z.object({
   firstName: z.string().optional(),
   lastName: z.string().optional(),
   email: z.string().optional(),
   mfaEnabled: z.boolean().optional(),
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  updatedAt: z.date().transform(v => v.toISOString()).optional(),
+  lastLoginAt: z.nullable(z.date().transform(v => v.toISOString())).optional(),
   role: z.lazy(() => TeamMembersRole$outboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     firstName: "first_name",
     lastName: "last_name",
     mfaEnabled: "mfa_enabled",
+    createdAt: "created_at",
+    updatedAt: "updated_at",
+    lastLoginAt: "last_login_at",
   });
 });
 
+export function teamMembersAttributesToJSON(
+  teamMembersAttributes: TeamMembersAttributes,
+): string {
+  return JSON.stringify(
+    TeamMembersAttributes$outboundSchema.parse(teamMembersAttributes),
+  );
+}
+export function teamMembersAttributesFromJSON(
+  jsonString: string,
+): SafeParseResult<TeamMembersAttributes, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TeamMembersAttributes$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TeamMembersAttributes' from JSON`,
+  );
+}
+
+/** @internal */
+export const TeamMembersData$inboundSchema: z.ZodType<
+  TeamMembersData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  type: z.string().optional(),
+  attributes: z.lazy(() => TeamMembersAttributes$inboundSchema).optional(),
+});
+/** @internal */
+export type TeamMembersData$Outbound = {
+  id?: string | undefined;
+  type?: string | undefined;
+  attributes?: TeamMembersAttributes$Outbound | undefined;
+};
+
+/** @internal */
+export const TeamMembersData$outboundSchema: z.ZodType<
+  TeamMembersData$Outbound,
+  z.ZodTypeDef,
+  TeamMembersData
+> = z.object({
+  id: z.string().optional(),
+  type: z.string().optional(),
+  attributes: z.lazy(() => TeamMembersAttributes$outboundSchema).optional(),
+});
+
 export function teamMembersDataToJSON(
   teamMembersData: TeamMembersData,
 ): string {

package/src/models/userdataobject.ts

@@ -0,0 +1,92 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  UserDataProperties,
+  UserDataProperties$inboundSchema,
+  UserDataProperties$Outbound,
+  UserDataProperties$outboundSchema,
+} from "./userdataproperties.js";
+
+export type UserDataObjectMeta = {};
+
+export type UserDataObject = {
+  data?: UserDataProperties | undefined;
+  meta?: UserDataObjectMeta | undefined;
+};
+
+/** @internal */
+export const UserDataObjectMeta$inboundSchema: z.ZodType<
+  UserDataObjectMeta,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+/** @internal */
+export type UserDataObjectMeta$Outbound = {};
+
+/** @internal */
+export const UserDataObjectMeta$outboundSchema: z.ZodType<
+  UserDataObjectMeta$Outbound,
+  z.ZodTypeDef,
+  UserDataObjectMeta
+> = z.object({});
+
+export function userDataObjectMetaToJSON(
+  userDataObjectMeta: UserDataObjectMeta,
+): string {
+  return JSON.stringify(
+    UserDataObjectMeta$outboundSchema.parse(userDataObjectMeta),
+  );
+}
+export function userDataObjectMetaFromJSON(
+  jsonString: string,
+): SafeParseResult<UserDataObjectMeta, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UserDataObjectMeta$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UserDataObjectMeta' from JSON`,
+  );
+}
+
+/** @internal */
+export const UserDataObject$inboundSchema: z.ZodType<
+  UserDataObject,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: UserDataProperties$inboundSchema.optional(),
+  meta: z.lazy(() => UserDataObjectMeta$inboundSchema).optional(),
+});
+/** @internal */
+export type UserDataObject$Outbound = {
+  data?: UserDataProperties$Outbound | undefined;
+  meta?: UserDataObjectMeta$Outbound | undefined;
+};
+
+/** @internal */
+export const UserDataObject$outboundSchema: z.ZodType<
+  UserDataObject$Outbound,
+  z.ZodTypeDef,
+  UserDataObject
+> = z.object({
+  data: UserDataProperties$outboundSchema.optional(),
+  meta: z.lazy(() => UserDataObjectMeta$outboundSchema).optional(),
+});
+
+export function userDataObjectToJSON(userDataObject: UserDataObject): string {
+  return JSON.stringify(UserDataObject$outboundSchema.parse(userDataObject));
+}
+export function userDataObjectFromJSON(
+  jsonString: string,
+): SafeParseResult<UserDataObject, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UserDataObject$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UserDataObject' from JSON`,
+  );
+}

package/src/models/userdataproperties.ts

@@ -8,6 +8,12 @@ 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";
+import {
+  ProjectInclude,
+  ProjectInclude$inboundSchema,
+  ProjectInclude$Outbound,
+  ProjectInclude$outboundSchema,
+} from "./projectinclude.js";
 
 export const UserDataPropertiesType = {
   UserData: "user_data",
@@ -16,15 +22,16 @@ export type UserDataPropertiesType = ClosedEnum<typeof UserDataPropertiesType>;
 
 export type UserDataPropertiesAttributes = {
   /**
-   * description of the User Data
+   * description of the User data
    */
   description?: string | undefined;
   /**
-   * content of the User Data
+   * content of the User data
    */
   content?: string | undefined;
   createdAt?: string | undefined;
   updatedAt?: string | undefined;
+  project?: ProjectInclude | undefined;
 };
 
 export type UserDataProperties = {
@@ -52,6 +59,7 @@ export const UserDataPropertiesAttributes$inboundSchema: z.ZodType<
   content: z.string().optional(),
   created_at: z.string().optional(),
   updated_at: z.string().optional(),
+  project: ProjectInclude$inboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     "created_at": "createdAt",
@@ -64,6 +72,7 @@ export type UserDataPropertiesAttributes$Outbound = {
   content?: string | undefined;
   created_at?: string | undefined;
   updated_at?: string | undefined;
+  project?: ProjectInclude$Outbound | undefined;
 };
 
 /** @internal */
@@ -76,6 +85,7 @@ export const UserDataPropertiesAttributes$outboundSchema: z.ZodType<
   content: z.string().optional(),
   createdAt: z.string().optional(),
   updatedAt: z.string().optional(),
+  project: ProjectInclude$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     createdAt: "created_at",

package/src/models/virtualmachineattributes.ts

@@ -59,6 +59,21 @@ export type VirtualMachineAttributesSpecs = {
   gpu?: string | undefined;
 };
 
+/**
+ * The billing type for the virtual machine.
+ */
+export const VirtualMachineAttributesBilling = {
+  Hourly: "hourly",
+  Monthly: "monthly",
+  Yearly: "yearly",
+} as const;
+/**
+ * The billing type for the virtual machine.
+ */
+export type VirtualMachineAttributesBilling = ClosedEnum<
+  typeof VirtualMachineAttributesBilling
+>;
+
 export type VirtualMachineAttributesAttributes = {
   name?: string | undefined;
   createdAt?: string | undefined;
@@ -69,6 +84,10 @@ export type VirtualMachineAttributesAttributes = {
   specs?: VirtualMachineAttributesSpecs | undefined;
   team?: TeamInclude | undefined;
   project?: ProjectInclude | undefined;
+  /**
+   * The billing type for the virtual machine.
+   */
+  billing?: VirtualMachineAttributesBilling | undefined;
 };
 
 export type VirtualMachineAttributes = {
@@ -251,6 +270,15 @@ export function virtualMachineAttributesSpecsFromJSON(
   );
 }
 
+/** @internal */
+export const VirtualMachineAttributesBilling$inboundSchema: z.ZodNativeEnum<
+  typeof VirtualMachineAttributesBilling
+> = z.nativeEnum(VirtualMachineAttributesBilling);
+/** @internal */
+export const VirtualMachineAttributesBilling$outboundSchema: z.ZodNativeEnum<
+  typeof VirtualMachineAttributesBilling
+> = VirtualMachineAttributesBilling$inboundSchema;
+
 /** @internal */
 export const VirtualMachineAttributesAttributes$inboundSchema: z.ZodType<
   VirtualMachineAttributesAttributes,
@@ -267,6 +295,7 @@ export const VirtualMachineAttributesAttributes$inboundSchema: z.ZodType<
   specs: z.lazy(() => VirtualMachineAttributesSpecs$inboundSchema).optional(),
   team: TeamInclude$inboundSchema.optional(),
   project: ProjectInclude$inboundSchema.optional(),
+  billing: VirtualMachineAttributesBilling$inboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     "created_at": "createdAt",
@@ -284,6 +313,7 @@ export type VirtualMachineAttributesAttributes$Outbound = {
   specs?: VirtualMachineAttributesSpecs$Outbound | undefined;
   team?: TeamInclude$Outbound | undefined;
   project?: ProjectInclude$Outbound | undefined;
+  billing?: string | undefined;
 };
 
 /** @internal */
@@ -302,6 +332,7 @@ export const VirtualMachineAttributesAttributes$outboundSchema: z.ZodType<
   specs: z.lazy(() => VirtualMachineAttributesSpecs$outboundSchema).optional(),
   team: TeamInclude$outboundSchema.optional(),
   project: ProjectInclude$outboundSchema.optional(),
+  billing: VirtualMachineAttributesBilling$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     createdAt: "created_at",

package/src/models/virtualmachinepayload.ts

@@ -16,11 +16,34 @@ export type VirtualMachinePayloadType = ClosedEnum<
   typeof VirtualMachinePayloadType
 >;
 
+/**
+ * The billing type for the virtual machine. Accepts `hourly` and `monthly` for on demand projects and `yearly` for reserved projects. Defaults to `monthly` for on demand projects and `yearly` for reserved projects.
+ */
+export const VirtualMachinePayloadBilling = {
+  Hourly: "hourly",
+  Monthly: "monthly",
+  Yearly: "yearly",
+} as const;
+/**
+ * The billing type for the virtual machine. Accepts `hourly` and `monthly` for on demand projects and `yearly` for reserved projects. Defaults to `monthly` for on demand projects and `yearly` for reserved projects.
+ */
+export type VirtualMachinePayloadBilling = ClosedEnum<
+  typeof VirtualMachinePayloadBilling
+>;
+
 export type VirtualMachinePayloadAttributes = {
   name?: string | undefined;
   plan?: string | undefined;
+  /**
+   * The site slug where the virtual machine will be deployed. Defaults to 'DAL' if not specified. To see which sites are available for a given plan, check the 'available' array in the plan's regions.
+   */
+  site?: string | undefined;
   sshKeys?: Array<string> | undefined;
   project?: string | undefined;
+  /**
+   * The billing type for the virtual machine. Accepts `hourly` and `monthly` for on demand projects and `yearly` for reserved projects. Defaults to `monthly` for on demand projects and `yearly` for reserved projects.
+   */
+  billing?: VirtualMachinePayloadBilling | undefined;
 };
 
 export type VirtualMachinePayloadData = {
@@ -41,6 +64,15 @@ export const VirtualMachinePayloadType$outboundSchema: z.ZodNativeEnum<
   typeof VirtualMachinePayloadType
 > = VirtualMachinePayloadType$inboundSchema;
 
+/** @internal */
+export const VirtualMachinePayloadBilling$inboundSchema: z.ZodNativeEnum<
+  typeof VirtualMachinePayloadBilling
+> = z.nativeEnum(VirtualMachinePayloadBilling);
+/** @internal */
+export const VirtualMachinePayloadBilling$outboundSchema: z.ZodNativeEnum<
+  typeof VirtualMachinePayloadBilling
+> = VirtualMachinePayloadBilling$inboundSchema;
+
 /** @internal */
 export const VirtualMachinePayloadAttributes$inboundSchema: z.ZodType<
   VirtualMachinePayloadAttributes,
@@ -49,8 +81,10 @@ export const VirtualMachinePayloadAttributes$inboundSchema: z.ZodType<
 > = z.object({
   name: z.string().default("my-vm"),
   plan: z.string().optional(),
+  site: z.string().optional(),
   ssh_keys: z.array(z.string()).optional(),
   project: z.string().default("my-project"),
+  billing: VirtualMachinePayloadBilling$inboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     "ssh_keys": "sshKeys",
@@ -60,8 +94,10 @@ export const VirtualMachinePayloadAttributes$inboundSchema: z.ZodType<
 export type VirtualMachinePayloadAttributes$Outbound = {
   name: string;
   plan?: string | undefined;
+  site?: string | undefined;
   ssh_keys?: Array<string> | undefined;
   project: string;
+  billing?: string | undefined;
 };
 
 /** @internal */
@@ -72,8 +108,10 @@ export const VirtualMachinePayloadAttributes$outboundSchema: z.ZodType<
 > = z.object({
   name: z.string().default("my-vm"),
   plan: z.string().optional(),
+  site: z.string().optional(),
   sshKeys: z.array(z.string()).optional(),
   project: z.string().default("my-project"),
+  billing: VirtualMachinePayloadBilling$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     sshKeys: "ssh_keys",

package/src/models/virtualmachineplans.ts

@@ -89,14 +89,26 @@ export type VirtualMachinePlansBRL = {
   year?: number | undefined;
 };
 
+/**
+ * Pricing information for this plan in the region
+ */
 export type VirtualMachinePlansPricing = {
   usd?: VirtualMachinePlansUSD | undefined;
   brl?: VirtualMachinePlansBRL | undefined;
 };
 
 export type VirtualMachinePlansRegion = {
+  /**
+   * The name of the region
+   */
   name?: string | undefined;
+  /**
+   * List of site codes where this virtual machine plan can be deployed
+   */
   available?: Array<string> | undefined;
+  /**
+   * Pricing information for this plan in the region
+   */
   pricing?: VirtualMachinePlansPricing | undefined;
 };
 
@@ -122,6 +134,9 @@ export type VirtualMachinePlansAttributes = {
    */
   name?: string | undefined;
   specs?: VirtualMachinePlansSpecs | undefined;
+  /**
+   * List of regions where infrastructure with available stock exists for this virtual machine plan
+   */
   regions?: Array<VirtualMachinePlansRegion> | undefined;
   /**
    * The stock level of the plan

package/src/sdk/apikeys.ts

@@ -13,10 +13,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,
@@ -28,7 +28,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.
@@ -45,7 +45,7 @@ export class ApiKeys extends ClientSDK {
   }
 
   /**
-   * Regenerate API Key
+   * Rotate API key
    *
    * @remarks
    * Regenerate an existing API Key that is tied to the current user. This overrides the previous key.
@@ -62,7 +62,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.

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/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
+   * Firewalls 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,9 +43,6 @@ export class Firewalls extends ClientSDK {
   }
 
   /**
-   * List firewalls
-   *
-   * @remarks
    * List firewalls
    */
   async list(
@@ -60,9 +57,6 @@ export class Firewalls extends ClientSDK {
   }
 
   /**
-   * Create a firewall
-   *
-   * @remarks
    * Create a firewall
    */
   async create(
@@ -77,10 +71,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,10 +88,7 @@ export class Firewalls extends ClientSDK {
   }
 
   /**
-   * Delete Firewall
-   *
-   * @remarks
-   * Delete a firewall
+   * Delete firewall
    */
   async delete(
     request: operations.DeleteFirewallRequest,
@@ -111,10 +102,10 @@ export class Firewalls extends ClientSDK {
   }
 
   /**
-   * Update Firewall
+   * Update firewall
    *
    * @remarks
-   * Update a firewall
+   * Updates a firewall by its ID.
    */
   async update(
     request: operations.UpdateFirewallRequest,
@@ -128,10 +119,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 +138,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/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.