@nirvana-labs/nirvana 0.10.1 → 1.0.0

package/resources/shared.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"shared.d.mts","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,UAAU,GAClB,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,CAAC;AAEf,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,OAAO,GAAG,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC"}
+{"version":3,"file":"shared.d.mts","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,UAAU,GAClB,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,CAAC;AAEf;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,OAAO,GAAG,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC"}

package/resources/shared.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Region the resource is in.
+ */
 export type RegionName = 'us-sea-1' | 'us-sva-1' | 'us-chi-1' | 'us-wdc-1' | 'eu-lon-1' | 'eu-ams-1' | 'eu-frk-1' | 'ap-sin-1' | 'ap-seo-1' | 'ap-tyo-1';
+/**
+ * Status of the resource.
+ */
 export type ResourceStatus = 'pending' | 'creating' | 'updating' | 'ready' | 'deleting' | 'deleted' | 'error';
 //# sourceMappingURL=shared.d.ts.map

package/resources/shared.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,UAAU,GAClB,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,CAAC;AAEf,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,OAAO,GAAG,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC"}
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,UAAU,GAClB,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,GACV,UAAU,CAAC;AAEf;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,OAAO,GAAG,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC"}

package/resources/user.d.mts

@@ -8,11 +8,23 @@ export declare class UserResource extends APIResource {
     get(options?: RequestOptions): APIPromise<User>;
 }
 export interface User {
+    /**
+     * Unique identifier for the user.
+     */
     id: string;
+    /**
+     * Email address of the user.
+     */
     email: string;
+    /**
+     * Services that the user has access to.
+     */
     services: User.Services;
 }
 export declare namespace User {
+    /**
+     * Services that the user has access to.
+     */
     interface Services {
         cloud?: boolean;
     }

package/resources/user.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"user.d.mts","sourceRoot":"","sources":["../src/resources/user.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,GAAG,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAGhD;AAED,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IAEX,KAAK,EAAE,MAAM,CAAC;IAEd,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC;CACzB;AAED,yBAAiB,IAAI,CAAC;IACpB,UAAiB,QAAQ;QACvB,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EAAE,KAAK,IAAI,IAAI,IAAI,EAAE,CAAC;CAC9B"}
+{"version":3,"file":"user.d.mts","sourceRoot":"","sources":["../src/resources/user.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,GAAG,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAGhD;AAED,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC;CACzB;AAED,yBAAiB,IAAI,CAAC;IACpB;;OAEG;IACH,UAAiB,QAAQ;QACvB,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EAAE,KAAK,IAAI,IAAI,IAAI,EAAE,CAAC;CAC9B"}

package/resources/user.d.ts

@@ -8,11 +8,23 @@ export declare class UserResource extends APIResource {
     get(options?: RequestOptions): APIPromise<User>;
 }
 export interface User {
+    /**
+     * Unique identifier for the user.
+     */
     id: string;
+    /**
+     * Email address of the user.
+     */
     email: string;
+    /**
+     * Services that the user has access to.
+     */
     services: User.Services;
 }
 export declare namespace User {
+    /**
+     * Services that the user has access to.
+     */
     interface Services {
         cloud?: boolean;
     }

package/resources/user.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../src/resources/user.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,GAAG,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAGhD;AAED,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IAEX,KAAK,EAAE,MAAM,CAAC;IAEd,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC;CACzB;AAED,yBAAiB,IAAI,CAAC;IACpB,UAAiB,QAAQ;QACvB,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EAAE,KAAK,IAAI,IAAI,IAAI,EAAE,CAAC;CAC9B"}
+{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../src/resources/user.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,GAAG,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAGhD;AAED,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC;CACzB;AAED,yBAAiB,IAAI,CAAC;IACpB;;OAEG;IACH,UAAiB,QAAQ;QACvB,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EAAE,KAAK,IAAI,IAAI,IAAI,EAAE,CAAC;CAC9B"}

package/src/resources/api-keys.ts

@@ -56,12 +56,12 @@ export interface APIKey {
   id: string;
 
   /**
-   * Time on which the API key was created.
+   * When the API key was created.
    */
   created_at: string;
 
   /**
-   * Time after which the API key is not valid.
+   * When the API key expires and is no longer valid.
    */
   expires_at: string;
 
@@ -76,7 +76,7 @@ export interface APIKey {
   status: 'active' | 'inactive' | 'expired';
 
   /**
-   * Time on which the API key was updated.
+   * When the API key was updated.
    */
   updated_at: string;
 
@@ -91,7 +91,7 @@ export interface APIKey {
   key?: string;
 
   /**
-   * Time before which the API key is not valid.
+   * When the API key starts to be valid.
    */
   starts_at?: string;
 }
@@ -102,7 +102,7 @@ export interface APIKeyList {
 
 export interface APIKeyCreateParams {
   /**
-   * Time after which the API key is not valid.
+   * When the API key expires and is no longer valid.
    */
   expires_at: string;
 
@@ -112,7 +112,7 @@ export interface APIKeyCreateParams {
   name: string;
 
   /**
-   * Time before which the API key is not valid.
+   * When the API key starts to be valid.
    */
   starts_at?: string;
 }

package/src/resources/compute/vms/vms.ts

@@ -52,37 +52,52 @@ export class VMs extends APIResource {
 }
 
 /**
- * CPU configuration details.
+ * CPU configuration for the VM.
  */
 export interface CPUConfig {
   /**
-   * virtual CPUs
+   * Number of virtual CPUs.
    */
   vcpu: number;
 }
 
 /**
- * Memory configuration details.
+ * Memory configuration for the VM.
  */
 export interface MemoryConfig {
   /**
-   * memory size
+   * Size of the memory in GB.
    */
   size: number;
 }
 
+/**
+ * OS Image details.
+ */
 export interface OSImage {
+  /**
+   * When the OS Image was created.
+   */
   created_at: string;
 
+  /**
+   * Display name of the OS Image.
+   */
   display_name: string;
 
+  /**
+   * Name of the OS Image.
+   */
   name: string;
 }
 
 /**
- * SSH key details.
+ * Public SSH key configuration for the VM.
  */
 export interface SSHKey {
+  /**
+   * Public key to and and use to access the VM.
+   */
   public_key: string;
 }
 
@@ -90,40 +105,79 @@ export interface SSHKey {
  * VM details.
  */
 export interface VM {
+  /**
+   * Unique identifier for the VM.
+   */
   id: string;
 
+  /**
+   * ID of the boot volume for the VM.
+   */
   boot_volume_id: string;
 
   /**
-   * CPU configuration details.
+   * CPU configuration for the VM.
    */
   cpu_config: CPUConfig;
 
+  /**
+   * When the VM was created.
+   */
   created_at: string;
 
+  /**
+   * IDs of the data volumes for the VM.
+   */
   data_volume_ids: Array<string>;
 
   /**
-   * Memory configuration details.
+   * Memory configuration for the VM.
    */
   memory_config: MemoryConfig;
 
+  /**
+   * Name of the VM.
+   */
   name: string;
 
+  /**
+   * Private IP of the VM.
+   */
   private_ip: string | null;
 
+  /**
+   * Public IP of the VM.
+   */
   public_ip: string | null;
 
+  /**
+   * Region the resource is in.
+   */
   region: Shared.RegionName;
 
+  /**
+   * Status of the resource.
+   */
   status: Shared.ResourceStatus;
 
+  /**
+   * ID of the subnet for the VM.
+   */
   subnet_id: string;
 
+  /**
+   * When the VM was updated.
+   */
   updated_at: string;
 
+  /**
+   * ID of the VPC for the VM.
+   */
   vpc_id: string;
 
+  /**
+   * Name of the VPC for the VM.
+   */
   vpc_name: string;
 }
 
@@ -133,43 +187,64 @@ export interface VMList {
 
 export interface VMCreateParams {
   /**
-   * Boot volume create request.
+   * Boot volume for the VM.
    */
   boot_volume: VMCreateParams.BootVolume;
 
   /**
-   * CPU configuration details.
+   * CPU configuration for the VM.
    */
   cpu_config: CPUConfig;
 
   /**
-   * Memory configuration details.
+   * Memory configuration for the VM.
    */
   memory_config: MemoryConfig;
 
+  /**
+   * Name of the VM.
+   */
   name: string;
 
+  /**
+   * Name of the OS Image to use for the VM.
+   */
   os_image_name: string;
 
+  /**
+   * Whether to enable public IP for the VM.
+   */
   public_ip_enabled: boolean;
 
+  /**
+   * Region the resource is in.
+   */
   region: Shared.RegionName;
 
   /**
-   * SSH key details.
+   * Public SSH key configuration for the VM.
    */
   ssh_key: SSHKey;
 
+  /**
+   * ID of the subnet to use for the VM.
+   */
   subnet_id: string;
 
+  /**
+   * Data volumes for the VM.
+   */
   data_volumes?: Array<VMCreateParams.DataVolume>;
 }
 
 export namespace VMCreateParams {
   /**
-   * Boot volume create request.
+   * Boot volume for the VM.
    */
   export interface BootVolume {
+    /**
+     * Size of the volume in GB.
+     */
     size: number;
   }
 
@@ -177,25 +252,37 @@ export namespace VMCreateParams {
    * VM data volume create request.
    */
   export interface DataVolume {
+    /**
+     * Name of the volume.
+     */
     name: string;
 
+    /**
+     * Size of the volume in GB.
+     */
     size: number;
   }
 }
 
 export interface VMUpdateParams {
   /**
-   * CPU configuration details.
+   * CPU configuration for the VM.
    */
   cpu_config?: CPUConfig;
 
   /**
-   * Memory configuration details.
+   * Memory configuration for the VM.
    */
   memory_config?: MemoryConfig;
 
+  /**
+   * Name of the VM.
+   */
   name?: string;
 
+  /**
+   * Whether to enable public IP for the VM.
+   */
   public_ip_enabled?: boolean;
 }
 

package/src/resources/compute/volumes.ts

@@ -49,7 +49,7 @@ export class Volumes extends APIResource {
 }
 
 /**
- * Storage type.
+ * Storage type the volume is using.
  */
 export type StorageType = 'nvme';
 
@@ -57,8 +57,14 @@ export type StorageType = 'nvme';
  * Volume details.
  */
 export interface Volume {
+  /**
+   * Unique identifier for the volume.
+   */
   id: string;
 
+  /**
+   * When the volume was created.
+   */
   created_at: string;
 
   /**
@@ -66,21 +72,39 @@ export interface Volume {
    */
   kind: VolumeKind;
 
+  /**
+   * Name of the volume.
+   */
   name: string;
 
+  /**
+   * Size of the volume in GB.
+   */
   size: number;
 
+  /**
+   * Status of the resource.
+   */
   status: Shared.ResourceStatus;
 
   /**
-   * Storage type.
+   * Storage type the volume is using.
    */
   type: StorageType;
 
+  /**
+   * When the volume was updated.
+   */
   updated_at: string;
 
+  /**
+   * ID of the VM the volume is attached to.
+   */
   vm_id: string | null;
 
+  /**
+   * Name of the VM the volume is attached to.
+   */
   vm_name: string | null;
 }
 
@@ -94,16 +118,31 @@ export interface VolumeList {
 }
 
 export interface VolumeCreateParams {
+  /**
+   * Name of the volume.
+   */
   name: string;
 
+  /**
+   * Size of the volume in GB.
+   */
   size: number;
 
+  /**
+   * ID of the VM the volume is attached to.
+   */
   vm_id: string;
 }
 
 export interface VolumeUpdateParams {
+  /**
+   * Name of the volume.
+   */
   name?: string;
 
+  /**
+   * Size of the volume in GB.
+   */
   size?: number;
 }
 

package/src/resources/networking/firewall-rules.ts

@@ -70,27 +70,54 @@ export class FirewallRules extends APIResource {
  * Firewall rule details.
  */
 export interface FirewallRule {
+  /**
+   * Unique identifier for the firewall rule.
+   */
   id: string;
 
+  /**
+   * When the firewall rule was created.
+   */
   created_at: string;
 
+  /**
+   * Destination address of the firewall rule.
+   */
   destination_address: string;
 
+  /**
+   * Destination ports of the firewall rule.
+   */
   destination_ports: Array<string>;
 
+  /**
+   * Name of the firewall rule.
+   */
   name: string;
 
   /**
-   * Supported Firewall Rule protocols.
+   * Protocol of the firewall rule.
    */
   protocol: 'tcp' | 'udp';
 
+  /**
+   * Source address of the firewall rule.
+   */
   source_address: string;
 
+  /**
+   * Status of the resource.
+   */
   status: Shared.ResourceStatus;
 
+  /**
+   * When the firewall rule was updated.
+   */
   updated_at: string;
 
+  /**
+   * ID of the VPC the firewall rule belongs to.
+   */
   vpc_id: string;
 }
 
@@ -99,17 +126,29 @@ export interface FirewallRuleList {
 }
 
 export interface FirewallRuleCreateParams {
+  /**
+   * Destination address of the firewall rule.
+   */
   destination_address: string;
 
+  /**
+   * Destination ports of the firewall rule.
+   */
   destination_ports: Array<string>;
 
+  /**
+   * Name of the firewall rule.
+   */
   name: string;
 
   /**
-   * Supported Firewall Rule protocols.
+   * Protocol of the firewall rule.
    */
   protocol: string;
 
+  /**
+   * Source address of the firewall rule.
+   */
   source_address: string;
 }
 
@@ -120,27 +159,27 @@ export interface FirewallRuleUpdateParams {
   vpc_id: string;
 
   /**
-   * Body param:
+   * Body param: Destination address of the firewall rule.
    */
   destination_address?: string;
 
   /**
-   * Body param:
+   * Body param: Destination ports of the firewall rule.
    */
   destination_ports?: Array<string>;
 
   /**
-   * Body param:
+   * Body param: Name of the firewall rule.
    */
   name?: string;
 
   /**
-   * Body param: Supported Firewall Rule protocols.
+   * Body param: Protocol of the firewall rule.
    */
   protocol?: 'tcp' | 'udp';
 
   /**
-   * Body param:
+   * Body param: Source address of the firewall rule.
    */
   source_address?: string;
 }

package/src/resources/networking/vpcs.ts

@@ -49,17 +49,32 @@ export class VPCs extends APIResource {
 }
 
 /**
- * Subnet details.
+ * Subnet of the VPC.
  */
 export interface Subnet {
+  /**
+   * Unique identifier for the subnet.
+   */
   id: string;
 
+  /**
+   * CIDR block for the subnet.
+   */
   cidr: string;
 
+  /**
+   * When the subnet was created.
+   */
   created_at: string;
 
+  /**
+   * Name of the subnet.
+   */
   name: string;
 
+  /**
+   * When the subnet was updated.
+   */
   updated_at: string;
 }
 
@@ -67,23 +82,44 @@ export interface Subnet {
  * VPC details.
  */
 export interface VPC {
+  /**
+   * Unique identifier for the VPC.
+   */
   id: string;
 
+  /**
+   * When the VPC was created.
+   */
   created_at: string;
 
+  /**
+   * IDs of the firewall rules associated with the VPC.
+   */
   firewall_rule_ids: Array<string>;
 
+  /**
+   * Name of the VPC.
+   */
   name: string;
 
+  /**
+   * Region the resource is in.
+   */
   region: Shared.RegionName;
 
+  /**
+   * Status of the resource.
+   */
   status: Shared.ResourceStatus;
 
   /**
-   * Subnet details.
+   * Subnet of the VPC.
    */
   subnet: Subnet;
 
+  /**
+   * When the VPC was updated.
+   */
   updated_at: string;
 }
 
@@ -92,16 +128,31 @@ export interface VPCList {
 }
 
 export interface VPCCreateParams {
+  /**
+   * Name of the VPC.
+   */
   name: string;
 
+  /**
+   * Region the resource is in.
+   */
   region: Shared.RegionName;
 
+  /**
+   * Name of the subnet to create.
+   */
   subnet_name: string;
 }
 
 export interface VPCUpdateParams {
+  /**
+   * Name of the VPC.
+   */
   name?: string;
 
+  /**
+   * Name of the subnet to create.
+   */
   subnet_name?: string;
 }