apify-client
Version:
Apify API client for JavaScript
58 lines • 2.4 kB
TypeScript
import type { ApiClientOptionsWithOptionalResourcePath } from '../base/api_client';
import { ResourceCollectionClient } from '../base/resource_collection_client';
import type { PaginatedIterator, PaginatedList, PaginationOptions } from '../utils';
import type { Build } from './build';
/**
* Client for managing the collection of Actor builds.
*
* Provides methods to list Actor builds across all Actors or for a specific Actor.
* To access an individual build, use the `build()` method on the main ApifyClient.
*
* @example
* ```javascript
* const client = new ApifyClient({ token: 'my-token' });
*
* // List all builds
* const buildsClient = client.builds();
* const { items } = await buildsClient.list();
*
* // List builds for a specific Actor
* const actorBuildsClient = client.actor('my-actor-id').builds();
* const { items: actorBuilds } = await actorBuildsClient.list();
* ```
*
* @see https://docs.apify.com/platform/actors/running/runs-and-builds#builds
*/
export declare class BuildCollectionClient extends ResourceCollectionClient {
/**
* @hidden
*/
constructor(options: ApiClientOptionsWithOptionalResourcePath);
/**
* Lists all Actor builds.
*
* Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
* items in a single API call is limited.
* ```javascript
* const paginatedList = await client.list(options);
* ```
*
* Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
* retrieved.
*
* ```javascript
* for await (const singleItem of client.list(options)) {...}
* ```
*
* @param options - Pagination and sorting options.
* @returns A paginated iterator of Actor builds.
* @see https://docs.apify.com/api/v2/actor-builds-get
*/
list(options?: BuildCollectionClientListOptions): PaginatedIterator<BuildCollectionClientListItem>;
}
export interface BuildCollectionClientListOptions extends PaginationOptions {
desc?: boolean;
}
export type BuildCollectionClientListItem = Required<Pick<Build, 'id' | 'status' | 'startedAt' | 'finishedAt'>> & Partial<Pick<Build, 'meta' | 'usageTotalUsd'>>;
export type BuildCollectionClientListResult = PaginatedList<BuildCollectionClientListItem>;
//# sourceMappingURL=build_collection.d.ts.map