@nirvana-labs/nirvana 1.20.3 → 1.22.0

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

@@ -12,10 +12,11 @@ import {
   AvailabilityUpdateResponse,
 } from './availability';
 import * as OSImagesAPI from './os-images';
-import { OSImageListResponse, OSImages } from './os-images';
+import { OSImageListParams, OSImages } from './os-images';
 import * as VolumesAPI from './volumes';
-import { Volumes } from './volumes';
+import { VolumeListParams, Volumes } from './volumes';
 import { APIPromise } from '../../../core/api-promise';
+import { Cursor, type CursorParams, PagePromise } from '../../../core/pagination';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
@@ -66,11 +67,14 @@ export class VMs extends APIResource {
    *
    * @example
    * ```ts
-   * const vmList = await client.compute.vms.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const vm of client.compute.vms.list()) {
+   *   // ...
+   * }
    * ```
    */
-  list(options?: RequestOptions): APIPromise<VMList> {
-    return this._client.get('/v1/compute/vms', options);
+  list(query: VMListParams | null | undefined = {}, options?: RequestOptions): PagePromise<VMsCursor, VM> {
+    return this._client.getAPIList('/v1/compute/vms', Cursor<VM>, { query, ...options });
   }
 
   /**
@@ -110,6 +114,10 @@ export class VMs extends APIResource {
   }
 }
 
+export type VMsCursor = Cursor<VM>;
+
+export type OSImagesCursor = Cursor<OSImage>;
+
 /**
  * CPU configuration for the VM.
  */
@@ -272,6 +280,11 @@ export interface VM {
 
 export interface VMList {
   items: Array<VM>;
+
+  /**
+   * Pagination response details.
+   */
+  pagination: Shared.Pagination;
 }
 
 export interface VMCreateParams {
@@ -395,6 +408,8 @@ export interface VMUpdateParams {
   tags?: Array<string>;
 }
 
+export interface VMListParams extends CursorParams {}
+
 VMs.Availability = Availability;
 VMs.Volumes = Volumes;
 VMs.OSImages = OSImages;
@@ -409,8 +424,10 @@ export declare namespace VMs {
     type SSHKeyRequest as SSHKeyRequest,
     type VM as VM,
     type VMList as VMList,
+    type VMsCursor as VMsCursor,
     type VMCreateParams as VMCreateParams,
     type VMUpdateParams as VMUpdateParams,
+    type VMListParams as VMListParams,
   };
 
   export {
@@ -421,7 +438,7 @@ export declare namespace VMs {
     type AvailabilityUpdateParams as AvailabilityUpdateParams,
   };
 
-  export { Volumes as Volumes };
+  export { Volumes as Volumes, type VolumeListParams as VolumeListParams };
 
-  export { OSImages as OSImages, type OSImageListResponse as OSImageListResponse };
+  export { OSImages as OSImages, type OSImageListParams as OSImageListParams };
 }

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

@@ -1,8 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
-import * as VolumesAPI from '../volumes/volumes';
-import { APIPromise } from '../../../core/api-promise';
+import * as VolumesVolumesAPI from '../volumes/volumes';
+import { VolumesCursor } from '../volumes/volumes';
+import { Cursor, type CursorParams, PagePromise } from '../../../core/pagination';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
@@ -12,12 +13,30 @@ export class Volumes extends APIResource {
    *
    * @example
    * ```ts
-   * const volumeList = await client.compute.vms.volumes.list(
+   * // Automatically fetches more pages as needed.
+   * for await (const volume of client.compute.vms.volumes.list(
    *   'vm_id',
-   * );
+   * )) {
+   *   // ...
+   * }
    * ```
    */
-  list(vmID: string, options?: RequestOptions): APIPromise<VolumesAPI.VolumeList> {
-    return this._client.get(path`/v1/compute/vms/${vmID}/volumes`, options);
+  list(
+    vmID: string,
+    query: VolumeListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<VolumesCursor, VolumesVolumesAPI.Volume> {
+    return this._client.getAPIList(path`/v1/compute/vms/${vmID}/volumes`, Cursor<VolumesVolumesAPI.Volume>, {
+      query,
+      ...options,
+    });
   }
 }
+
+export interface VolumeListParams extends CursorParams {}
+
+export declare namespace Volumes {
+  export { type VolumeListParams as VolumeListParams };
+}
+
+export { type VolumesCursor };

package/src/resources/compute/volumes/index.ts

@@ -15,4 +15,6 @@ export {
   type VolumeList,
   type VolumeCreateParams,
   type VolumeUpdateParams,
+  type VolumeListParams,
+  type VolumesCursor,
 } from './volumes';

package/src/resources/compute/volumes/volumes.ts

@@ -12,6 +12,7 @@ import {
   AvailabilityUpdateResponse,
 } from './availability';
 import { APIPromise } from '../../../core/api-promise';
+import { Cursor, type CursorParams, PagePromise } from '../../../core/pagination';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
@@ -57,11 +58,17 @@ export class Volumes extends APIResource {
    *
    * @example
    * ```ts
-   * const volumeList = await client.compute.volumes.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const volume of client.compute.volumes.list()) {
+   *   // ...
+   * }
    * ```
    */
-  list(options?: RequestOptions): APIPromise<VolumeList> {
-    return this._client.get('/v1/compute/volumes', options);
+  list(
+    query: VolumeListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<VolumesCursor, Volume> {
+    return this._client.getAPIList('/v1/compute/volumes', Cursor<Volume>, { query, ...options });
   }
 
   /**
@@ -93,6 +100,8 @@ export class Volumes extends APIResource {
   }
 }
 
+export type VolumesCursor = Cursor<Volume>;
+
 /**
  * Storage type the Volume is using.
  */
@@ -165,6 +174,11 @@ export type VolumeKind = 'boot' | 'data';
 
 export interface VolumeList {
   items: Array<Volume>;
+
+  /**
+   * Pagination response details.
+   */
+  pagination: Shared.Pagination;
 }
 
 export interface VolumeCreateParams {
@@ -206,6 +220,8 @@ export interface VolumeUpdateParams {
   tags?: Array<string>;
 }
 
+export interface VolumeListParams extends CursorParams {}
+
 Volumes.Availability = Availability;
 
 export declare namespace Volumes {
@@ -214,8 +230,10 @@ export declare namespace Volumes {
     type Volume as Volume,
     type VolumeKind as VolumeKind,
     type VolumeList as VolumeList,
+    type VolumesCursor as VolumesCursor,
     type VolumeCreateParams as VolumeCreateParams,
     type VolumeUpdateParams as VolumeUpdateParams,
+    type VolumeListParams as VolumeListParams,
   };
 
   export {

package/src/resources/networking/connect/connect.ts

@@ -3,15 +3,25 @@
 import { APIResource } from '../../../core/resource';
 import * as Shared from '../../shared';
 import * as ConnectionsAPI from './connections';
-import { ConnectionCreateParams, ConnectionUpdateParams, Connections } from './connections';
+import {
+  ConnectionCreateParams,
+  ConnectionListParams,
+  ConnectionUpdateParams,
+  Connections,
+} from './connections';
 import * as RoutesAPI from './routes';
-import { Routes } from './routes';
+import { RouteListParams, Routes } from './routes';
+import { Cursor } from '../../../core/pagination';
 
 export class Connect extends APIResource {
   connections: ConnectionsAPI.Connections = new ConnectionsAPI.Connections(this._client);
   routes: RoutesAPI.Routes = new RoutesAPI.Routes(this._client);
 }
 
+export type ConnectConnectionsCursor = Cursor<ConnectConnection>;
+
+export type ConnectRoutesCursor = Cursor<ConnectRoute>;
+
 /**
  * Connect Connection speed in Mbps
  */
@@ -124,6 +134,11 @@ export interface ConnectConnectionAWSConfigRequest {
 
 export interface ConnectConnectionList {
   items: Array<ConnectConnection>;
+
+  /**
+   * Pagination response details.
+   */
+  pagination: Shared.Pagination;
 }
 
 /**
@@ -148,6 +163,11 @@ export interface ConnectRoute {
 
 export interface ConnectRouteList {
   items: Array<ConnectRoute>;
+
+  /**
+   * Pagination response details.
+   */
+  pagination: Shared.Pagination;
 }
 
 Connect.Connections = Connections;
@@ -168,7 +188,8 @@ export declare namespace Connect {
     Connections as Connections,
     type ConnectionCreateParams as ConnectionCreateParams,
     type ConnectionUpdateParams as ConnectionUpdateParams,
+    type ConnectionListParams as ConnectionListParams,
   };
 
-  export { Routes as Routes };
+  export { Routes as Routes, type RouteListParams as RouteListParams };
 }

package/src/resources/networking/connect/connections.ts

@@ -4,7 +4,9 @@ import { APIResource } from '../../../core/resource';
 import * as OperationsAPI from '../../operations';
 import * as Shared from '../../shared';
 import * as ConnectAPI from './connect';
+import { ConnectConnectionsCursor } from './connect';
 import { APIPromise } from '../../../core/api-promise';
+import { Cursor, type CursorParams, PagePromise } from '../../../core/pagination';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
@@ -52,12 +54,21 @@ export class Connections extends APIResource {
    *
    * @example
    * ```ts
-   * const connectConnectionList =
-   *   await client.networking.connect.connections.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const connectConnection of client.networking.connect.connections.list()) {
+   *   // ...
+   * }
    * ```
    */
-  list(options?: RequestOptions): APIPromise<ConnectAPI.ConnectConnectionList> {
-    return this._client.get('/v1/networking/connect/connections', options);
+  list(
+    query: ConnectionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ConnectConnectionsCursor, ConnectAPI.ConnectConnection> {
+    return this._client.getAPIList(
+      '/v1/networking/connect/connections',
+      Cursor<ConnectAPI.ConnectConnection>,
+      { query, ...options },
+    );
   }
 
   /**
@@ -140,9 +151,14 @@ export interface ConnectionUpdateParams {
   tags?: Array<string>;
 }
 
+export interface ConnectionListParams extends CursorParams {}
+
 export declare namespace Connections {
   export {
     type ConnectionCreateParams as ConnectionCreateParams,
     type ConnectionUpdateParams as ConnectionUpdateParams,
+    type ConnectionListParams as ConnectionListParams,
   };
 }
+
+export { type ConnectConnectionsCursor };

package/src/resources/networking/connect/index.ts

@@ -9,6 +9,13 @@ export {
   type ConnectConnectionList,
   type ConnectRoute,
   type ConnectRouteList,
+  type ConnectConnectionsCursor,
+  type ConnectRoutesCursor,
 } from './connect';
-export { Connections, type ConnectionCreateParams, type ConnectionUpdateParams } from './connections';
-export { Routes } from './routes';
+export {
+  Connections,
+  type ConnectionCreateParams,
+  type ConnectionUpdateParams,
+  type ConnectionListParams,
+} from './connections';
+export { Routes, type RouteListParams } from './routes';

package/src/resources/networking/connect/routes.ts

@@ -2,7 +2,8 @@
 
 import { APIResource } from '../../../core/resource';
 import * as ConnectAPI from './connect';
-import { APIPromise } from '../../../core/api-promise';
+import { ConnectRoutesCursor } from './connect';
+import { Cursor, type CursorParams, PagePromise } from '../../../core/pagination';
 import { RequestOptions } from '../../../internal/request-options';
 
 export class Routes extends APIResource {
@@ -11,11 +12,27 @@ export class Routes extends APIResource {
    *
    * @example
    * ```ts
-   * const connectRouteList =
-   *   await client.networking.connect.routes.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const connectRoute of client.networking.connect.routes.list()) {
+   *   // ...
+   * }
    * ```
    */
-  list(options?: RequestOptions): APIPromise<ConnectAPI.ConnectRouteList> {
-    return this._client.get('/v1/networking/connect/routes', options);
+  list(
+    query: RouteListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ConnectRoutesCursor, ConnectAPI.ConnectRoute> {
+    return this._client.getAPIList('/v1/networking/connect/routes', Cursor<ConnectAPI.ConnectRoute>, {
+      query,
+      ...options,
+    });
   }
 }
+
+export interface RouteListParams extends CursorParams {}
+
+export declare namespace Routes {
+  export { type RouteListParams as RouteListParams };
+}
+
+export { type ConnectRoutesCursor };

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

@@ -4,6 +4,7 @@ import { APIResource } from '../../core/resource';
 import * as OperationsAPI from '../operations';
 import * as Shared from '../shared';
 import { APIPromise } from '../../core/api-promise';
+import { Cursor, type CursorParams, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
@@ -60,12 +61,23 @@ export class FirewallRules extends APIResource {
    *
    * @example
    * ```ts
-   * const firewallRuleList =
-   *   await client.networking.firewallRules.list('vpc_id');
+   * // Automatically fetches more pages as needed.
+   * for await (const firewallRule of client.networking.firewallRules.list(
+   *   'vpc_id',
+   * )) {
+   *   // ...
+   * }
    * ```
    */
-  list(vpcID: string, options?: RequestOptions): APIPromise<FirewallRuleList> {
-    return this._client.get(path`/v1/networking/vpcs/${vpcID}/firewall_rules`, options);
+  list(
+    vpcID: string,
+    query: FirewallRuleListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<FirewallRulesCursor, FirewallRule> {
+    return this._client.getAPIList(path`/v1/networking/vpcs/${vpcID}/firewall_rules`, Cursor<FirewallRule>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -111,6 +123,8 @@ export class FirewallRules extends APIResource {
   }
 }
 
+export type FirewallRulesCursor = Cursor<FirewallRule>;
+
 /**
  * Firewall rule details.
  */
@@ -174,6 +188,11 @@ export interface FirewallRule {
 
 export interface FirewallRuleList {
   items: Array<FirewallRule>;
+
+  /**
+   * Pagination response details.
+   */
+  pagination: Shared.Pagination;
 }
 
 export interface FirewallRuleCreateParams {
@@ -248,6 +267,8 @@ export interface FirewallRuleUpdateParams {
   tags?: Array<string>;
 }
 
+export interface FirewallRuleListParams extends CursorParams {}
+
 export interface FirewallRuleDeleteParams {
   /**
    * VPC ID
@@ -266,8 +287,10 @@ export declare namespace FirewallRules {
   export {
     type FirewallRule as FirewallRule,
     type FirewallRuleList as FirewallRuleList,
+    type FirewallRulesCursor as FirewallRulesCursor,
     type FirewallRuleCreateParams as FirewallRuleCreateParams,
     type FirewallRuleUpdateParams as FirewallRuleUpdateParams,
+    type FirewallRuleListParams as FirewallRuleListParams,
     type FirewallRuleDeleteParams as FirewallRuleDeleteParams,
     type FirewallRuleGetParams as FirewallRuleGetParams,
   };

package/src/resources/networking/index.ts

@@ -9,6 +9,8 @@ export {
   type ConnectConnectionList,
   type ConnectRoute,
   type ConnectRouteList,
+  type ConnectConnectionsCursor,
+  type ConnectRoutesCursor,
 } from './connect/index';
 export {
   FirewallRules,
@@ -16,8 +18,10 @@ export {
   type FirewallRuleList,
   type FirewallRuleCreateParams,
   type FirewallRuleUpdateParams,
+  type FirewallRuleListParams,
   type FirewallRuleDeleteParams,
   type FirewallRuleGetParams,
+  type FirewallRulesCursor,
 } from './firewall-rules';
 export { Networking } from './networking';
 export {
@@ -27,4 +31,6 @@ export {
   type VPCList,
   type VPCCreateParams,
   type VPCUpdateParams,
+  type VPCListParams,
+  type VPCsCursor,
 } from './vpcs/index';

package/src/resources/networking/networking.ts

@@ -8,8 +8,10 @@ import {
   FirewallRuleDeleteParams,
   FirewallRuleGetParams,
   FirewallRuleList,
+  FirewallRuleListParams,
   FirewallRuleUpdateParams,
   FirewallRules,
+  FirewallRulesCursor,
 } from './firewall-rules';
 import * as ConnectAPI from './connect/connect';
 import {
@@ -23,7 +25,16 @@ import {
   ConnectRouteList,
 } from './connect/connect';
 import * as VPCsAPI from './vpcs/vpcs';
-import { Subnet, VPC, VPCCreateParams, VPCList, VPCUpdateParams, VPCs } from './vpcs/vpcs';
+import {
+  Subnet,
+  VPC,
+  VPCCreateParams,
+  VPCList,
+  VPCListParams,
+  VPCUpdateParams,
+  VPCs,
+  VPCsCursor,
+} from './vpcs/vpcs';
 
 export class Networking extends APIResource {
   vpcs: VPCsAPI.VPCs = new VPCsAPI.VPCs(this._client);
@@ -41,16 +52,20 @@ export declare namespace Networking {
     type Subnet as Subnet,
     type VPC as VPC,
     type VPCList as VPCList,
+    type VPCsCursor as VPCsCursor,
     type VPCCreateParams as VPCCreateParams,
     type VPCUpdateParams as VPCUpdateParams,
+    type VPCListParams as VPCListParams,
   };
 
   export {
     FirewallRules as FirewallRules,
     type FirewallRule as FirewallRule,
     type FirewallRuleList as FirewallRuleList,
+    type FirewallRulesCursor as FirewallRulesCursor,
     type FirewallRuleCreateParams as FirewallRuleCreateParams,
     type FirewallRuleUpdateParams as FirewallRuleUpdateParams,
+    type FirewallRuleListParams as FirewallRuleListParams,
     type FirewallRuleDeleteParams as FirewallRuleDeleteParams,
     type FirewallRuleGetParams as FirewallRuleGetParams,
   };

package/src/resources/networking/vpcs/index.ts

@@ -14,4 +14,6 @@ export {
   type VPCList,
   type VPCCreateParams,
   type VPCUpdateParams,
+  type VPCListParams,
+  type VPCsCursor,
 } from './vpcs';

package/src/resources/networking/vpcs/vpcs.ts

@@ -12,6 +12,7 @@ import {
   AvailabilityUpdateResponse,
 } from './availability';
 import { APIPromise } from '../../../core/api-promise';
+import { Cursor, type CursorParams, PagePromise } from '../../../core/pagination';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
@@ -57,11 +58,14 @@ export class VPCs extends APIResource {
    *
    * @example
    * ```ts
-   * const vpcList = await client.networking.vpcs.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const vpc of client.networking.vpcs.list()) {
+   *   // ...
+   * }
    * ```
    */
-  list(options?: RequestOptions): APIPromise<VPCList> {
-    return this._client.get('/v1/networking/vpcs', options);
+  list(query: VPCListParams | null | undefined = {}, options?: RequestOptions): PagePromise<VPCsCursor, VPC> {
+    return this._client.getAPIList('/v1/networking/vpcs', Cursor<VPC>, { query, ...options });
   }
 
   /**
@@ -91,6 +95,8 @@ export class VPCs extends APIResource {
   }
 }
 
+export type VPCsCursor = Cursor<VPC>;
+
 /**
  * Subnet of the VPC.
  */
@@ -173,6 +179,11 @@ export interface VPC {
 
 export interface VPCList {
   items: Array<VPC>;
+
+  /**
+   * Pagination response details.
+   */
+  pagination: Shared.Pagination;
 }
 
 export interface VPCCreateParams {
@@ -214,6 +225,8 @@ export interface VPCUpdateParams {
   tags?: Array<string>;
 }
 
+export interface VPCListParams extends CursorParams {}
+
 VPCs.Availability = Availability;
 
 export declare namespace VPCs {
@@ -221,8 +234,10 @@ export declare namespace VPCs {
     type Subnet as Subnet,
     type VPC as VPC,
     type VPCList as VPCList,
+    type VPCsCursor as VPCsCursor,
     type VPCCreateParams as VPCCreateParams,
     type VPCUpdateParams as VPCUpdateParams,
+    type VPCListParams as VPCListParams,
   };
 
   export {

package/src/resources/operations.ts

@@ -1,7 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
+import * as Shared from './shared';
 import { APIPromise } from '../core/api-promise';
+import { Cursor, type CursorParams, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
@@ -9,8 +11,11 @@ export class Operations extends APIResource {
   /**
    * List all operations
    */
-  list(options?: RequestOptions): APIPromise<OperationList> {
-    return this._client.get('/v1/operations', options);
+  list(
+    query: OperationListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<OperationsCursor, Operation> {
+    return this._client.getAPIList('/v1/operations', Cursor<Operation>, { query, ...options });
   }
 
   /**
@@ -21,6 +26,8 @@ export class Operations extends APIResource {
   }
 }
 
+export type OperationsCursor = Cursor<Operation>;
+
 /**
  * Operation details.
  */
@@ -68,6 +75,11 @@ export type OperationKind = 'vm' | 'volume' | 'vpc' | 'firewall_rule';
 
 export interface OperationList {
   items: Array<Operation>;
+
+  /**
+   * Pagination response details.
+   */
+  pagination: Shared.Pagination;
 }
 
 /**
@@ -80,6 +92,8 @@ export type OperationStatus = 'pending' | 'running' | 'done' | 'failed' | 'unkno
  */
 export type OperationType = 'create' | 'update' | 'delete' | 'restart';
 
+export interface OperationListParams extends CursorParams {}
+
 export declare namespace Operations {
   export {
     type Operation as Operation,
@@ -87,5 +101,7 @@ export declare namespace Operations {
     type OperationList as OperationList,
     type OperationStatus as OperationStatus,
     type OperationType as OperationType,
+    type OperationsCursor as OperationsCursor,
+    type OperationListParams as OperationListParams,
   };
 }