apify-client 2.20.1-beta.6 → 2.20.1-beta.8

package/dist/resource_clients/build.d.ts

@@ -3,47 +3,135 @@ import type { ApiClientSubResourceOptions } from '../base/api_client';
 import { ResourceClient } from '../base/resource_client';
 import type { ActorDefinition } from './actor';
 import { LogClient } from './log';
+/**
+ * Client for managing a specific Actor build.
+ *
+ * Builds are created when an Actor is built from source code. This client provides methods
+ * to get build details, wait for the build to finish, abort it, and access its logs.
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ * const buildClient = client.build('my-build-id');
+ *
+ * // Get build details
+ * const build = await buildClient.get();
+ *
+ * // Wait for the build to finish
+ * const finishedBuild = await buildClient.waitForFinish();
+ *
+ * // Access build logs
+ * const log = await buildClient.log().get();
+ * ```
+ *
+ * @see https://docs.apify.com/platform/actors/running/runs-and-builds#builds
+ */
 export declare class BuildClient extends ResourceClient {
     /**
      * @hidden
      */
     constructor(options: ApiClientSubResourceOptions);
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build
+     * Gets the Actor build object from the Apify API.
+     *
+     * @param options - Get options
+     * @param options.waitForFinish - Maximum time to wait (in seconds, max 60s) for the build to finish on the API side before returning. Default is 0 (returns immediately).
+     * @returns The Build object, or `undefined` if it does not exist
+     * @see https://docs.apify.com/api/v2/actor-build-get
+     *
+     * @example
+     * ```javascript
+     * // Get build status immediately
+     * const build = await client.build('build-id').get();
+     * console.log(`Status: ${build.status}`);
+     *
+     * // Wait up to 60 seconds for build to finish
+     * const build = await client.build('build-id').get({ waitForFinish: 60 });
+     * ```
      */
     get(options?: BuildClientGetOptions): Promise<Build | undefined>;
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build
+     * Aborts the Actor build.
+     *
+     * Stops the build process immediately. The build will have an `ABORTED` status.
+     *
+     * @returns The updated Build object with `ABORTED` status
+     * @see https://docs.apify.com/api/v2/actor-build-abort-post
+     *
+     * @example
+     * ```javascript
+     * await client.build('build-id').abort();
+     * ```
      */
     abort(): Promise<Build>;
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build
+     * Deletes the Actor build.
+     *
+     * @see https://docs.apify.com/api/v2/actor-build-delete
      */
     delete(): Promise<void>;
     /**
-     * https://docs.apify.com/api/v2/actor-build-openapi-json-get
+     * Retrieves the OpenAPI definition for the Actor build.
+     *
+     * @returns The OpenAPI definition object.
+     * @see https://docs.apify.com/api/v2/actor-build-openapi-json-get
      */
     getOpenApiDefinition(): Promise<OpenApiDefinition>;
     /**
-     * Returns a promise that resolves with the finished Build object when the provided actor build finishes
-     * or with the unfinished Build object when the `waitSecs` timeout lapses. The promise is NOT rejected
-     * based on run status. You can inspect the `status` property of the Build object to find out its status.
+     * Waits for the Actor build to finish and returns the finished Build object.
+     *
+     * The promise resolves when the build reaches a terminal state (`SUCCEEDED`, `FAILED`, `ABORTED`, or `TIMED-OUT`).
+     * If `waitSecs` is provided and the timeout is reached, the promise resolves with the unfinished
+     * Build object (status will be `RUNNING` or `READY`). The promise is NOT rejected based on build status.
      *
-     * The difference between this function and the `waitForFinish` parameter of the `get` method
-     * is the fact that this function can wait indefinitely. Its use is preferable to the
-     * `waitForFinish` parameter alone, which it uses internally.
+     * Unlike the `waitForFinish` parameter in {@link get}, this method can wait indefinitely
+     * by polling the build status. It uses the `waitForFinish` parameter internally (max 60s per call)
+     * and continuously polls until the build finishes or the timeout is reached.
      *
      * This is useful when you need to immediately start a run after a build finishes.
+     *
+     * @param options - Wait options
+     * @param options.waitSecs - Maximum time to wait for the build to finish, in seconds. If omitted, waits indefinitely.
+     * @returns The Build object (finished or still building if timeout was reached)
+     *
+     * @example
+     * ```javascript
+     * // Wait indefinitely for build to finish
+     * const build = await client.build('build-id').waitForFinish();
+     * console.log(`Build finished with status: ${build.status}`);
+     *
+     * // Start a run immediately after build succeeds
+     * const build = await client.build('build-id').waitForFinish();
+     * if (build.status === 'SUCCEEDED') {
+     *   const run = await client.actor('my-actor').start();
+     * }
+     * ```
      */
     waitForFinish(options?: BuildClientWaitForFinishOptions): Promise<Build>;
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-builds/build-log
+     * Returns a client for accessing the log of this Actor build.
+     *
+     * @returns A client for accessing the build's log
+     * @see https://docs.apify.com/api/v2/actor-build-log-get
+     *
+     * @example
+     * ```javascript
+     * // Get build log
+     * const log = await client.build('build-id').log().get();
+     * console.log(log);
+     * ```
      */
     log(): LogClient;
 }
+/**
+ * Options for getting a Build.
+ */
 export interface BuildClientGetOptions {
     waitForFinish?: number;
 }
+/**
+ * Options for waiting for a Build to finish.
+ */
 export interface BuildClientWaitForFinishOptions {
     /**
      * Maximum time to wait for the build to finish, in seconds.
@@ -52,11 +140,20 @@ export interface BuildClientWaitForFinishOptions {
      */
     waitSecs?: number;
 }
+/**
+ * Metadata about how a Build was initiated.
+ */
 export interface BuildMeta {
     origin: string;
     clientIp: string;
     userAgent: string;
 }
+/**
+ * Represents an Actor build.
+ *
+ * Builds compile Actor source code and prepare it for execution. Each build has a unique ID
+ * and can be tagged (e.g., 'latest', 'beta') for easy reference.
+ */
 export interface Build {
     id: string;
     actId: string;
@@ -81,20 +178,35 @@ export interface Build {
     usageUsd?: BuildUsage;
     actorDefinition?: ActorDefinition;
 }
+/**
+ * Resource usage for an Actor build.
+ */
 export interface BuildUsage {
     ACTOR_COMPUTE_UNITS?: number;
 }
+/**
+ * Runtime statistics for an Actor build.
+ */
 export interface BuildStats {
     durationMillis: number;
     runTimeSecs: number;
     computeUnits: number;
 }
+/**
+ * Configuration options used for an Actor build.
+ */
 export interface BuildOptions {
     useCache?: boolean;
     betaPackages?: boolean;
     memoryMbytes?: number;
     diskMbytes?: number;
 }
+/**
+ * OpenAPI specification for an Actor.
+ *
+ * Defines the Actor's API interface in OpenAPI 3.0 format, useful for integration
+ * with tools like ChatGPT plugins and other API consumers.
+ */
 export interface OpenApiDefinition {
     openapi: string;
     info: {

package/dist/resource_clients/build.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../src/resource_clients/build.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAE/D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC,qBAAa,WAAY,SAAQ,cAAc;IAC3C;;OAEG;gBACS,OAAO,EAAE,2BAA2B;IAOhD;;OAEG;IACG,GAAG,CAAC,OAAO,GAAE,qBAA0B,GAAG,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC;IAW1E;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC;IAU7B;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAI7B;;OAEG;IACG,oBAAoB,IAAI,OAAO,CAAC,iBAAiB,CAAC;IAUxD;;;;;;;;;;OAUG;IACG,aAAa,CAAC,OAAO,GAAE,+BAAoC,GAAG,OAAO,CAAC,KAAK,CAAC;IAWlF;;OAEG;IACH,GAAG,IAAI,SAAS;CAOnB;AAED,MAAM,WAAW,qBAAqB;IAClC,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,+BAA+B;IAC5C;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,SAAS;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,KAAK;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,IAAI,CAAC;IAChB,UAAU,CAAC,EAAE,IAAI,CAAC;IAClB,MAAM,EAAE,CAAC,OAAO,yBAAyB,CAAC,CAAC,MAAM,CAAC,CAAC;IACnD,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,UAAU,CAAC;IACtB,eAAe,CAAC,EAAE,eAAe,CAAC;CACrC;AAED,MAAM,WAAW,UAAU;IACvB,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,UAAU;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,YAAY;IACzB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,iBAAiB;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE;QACF,KAAK,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,YAAY,EAAE,MAAM,CAAC;KACxB,CAAC;IACF,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC3B,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG;YAAE,IAAI,EAAE,gBAAgB,CAAA;SAAE,CAAA;KAAE,CAAC;IACrD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;SACzB,CAAC;KACL,CAAC;CACL;AAED,UAAU,gBAAgB;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,0BAA0B,EAAE,OAAO,CAAC;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,WAAW,EAAE;QACT,QAAQ,EAAE,OAAO,CAAC;QAClB,OAAO,EAAE;YACL,kBAAkB,EAAE;gBAChB,MAAM,EAAE;oBACJ,IAAI,EAAE,MAAM,CAAC;iBAChB,CAAC;aACL,CAAC;SACL,CAAC;KACL,CAAC;IACF,UAAU,EAAE;QACR,IAAI,EAAE,MAAM,CAAC;QACb,EAAE,EAAE,MAAM,CAAC;QACX,QAAQ,EAAE,OAAO,CAAC;QAClB,MAAM,EAAE;YACJ,IAAI,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,WAAW,EAAE,MAAM,CAAC;KACvB,EAAE,CAAC;IACJ,SAAS,EAAE;QACP,KAAK,EAAE;YACH,WAAW,EAAE,MAAM,CAAC;YACpB,OAAO,CAAC,EAAE;gBACN,kBAAkB,EAAE;oBAChB,MAAM,EAAE;wBACJ,IAAI,EAAE,MAAM,CAAC;qBAChB,CAAC;iBACL,CAAC;aACL,CAAC;SACL,CAAC;KACL,CAAC;CACL"}
+{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../src/resource_clients/build.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAE/D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,WAAY,SAAQ,cAAc;IAC3C;;OAEG;gBACS,OAAO,EAAE,2BAA2B;IAOhD;;;;;;;;;;;;;;;;;OAiBG;IACG,GAAG,CAAC,OAAO,GAAE,qBAA0B,GAAG,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC;IAW1E;;;;;;;;;;;;OAYG;IACG,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC;IAU7B;;;;OAIG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAI7B;;;;;OAKG;IACG,oBAAoB,IAAI,OAAO,CAAC,iBAAiB,CAAC;IAUxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,aAAa,CAAC,OAAO,GAAE,+BAAoC,GAAG,OAAO,CAAC,KAAK,CAAC;IAWlF;;;;;;;;;;;;OAYG;IACH,GAAG,IAAI,SAAS;CAOnB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC5C;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,KAAK;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,IAAI,CAAC;IAChB,UAAU,CAAC,EAAE,IAAI,CAAC;IAClB,MAAM,EAAE,CAAC,OAAO,yBAAyB,CAAC,CAAC,MAAM,CAAC,CAAC;IACnD,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,UAAU,CAAC;IACtB,eAAe,CAAC,EAAE,eAAe,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACvB,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE;QACF,KAAK,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,YAAY,EAAE,MAAM,CAAC;KACxB,CAAC;IACF,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC3B,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG;YAAE,IAAI,EAAE,gBAAgB,CAAA;SAAE,CAAA;KAAE,CAAC;IACrD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;SACzB,CAAC;KACL,CAAC;CACL;AAED,UAAU,gBAAgB;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,0BAA0B,EAAE,OAAO,CAAC;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,WAAW,EAAE;QACT,QAAQ,EAAE,OAAO,CAAC;QAClB,OAAO,EAAE;YACL,kBAAkB,EAAE;gBAChB,MAAM,EAAE;oBACJ,IAAI,EAAE,MAAM,CAAC;iBAChB,CAAC;aACL,CAAC;SACL,CAAC;KACL,CAAC;IACF,UAAU,EAAE;QACR,IAAI,EAAE,MAAM,CAAC;QACb,EAAE,EAAE,MAAM,CAAC;QACX,QAAQ,EAAE,OAAO,CAAC;QAClB,MAAM,EAAE;YACJ,IAAI,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,WAAW,EAAE,MAAM,CAAC;KACvB,EAAE,CAAC;IACJ,SAAS,EAAE;QACP,KAAK,EAAE;YACH,WAAW,EAAE,MAAM,CAAC;YACpB,OAAO,CAAC,EAAE;gBACN,kBAAkB,EAAE;oBAChB,MAAM,EAAE;wBACJ,IAAI,EAAE,MAAM,CAAC;qBAChB,CAAC;iBACL,CAAC;aACL,CAAC;SACL,CAAC;KACL,CAAC;CACL"}

package/dist/resource_clients/build.js

@@ -6,6 +6,29 @@ const ow_1 = tslib_1.__importDefault(require("ow"));
 const resource_client_1 = require("../base/resource_client");
 const utils_1 = require("../utils");
 const log_1 = require("./log");
+/**
+ * Client for managing a specific Actor build.
+ *
+ * Builds are created when an Actor is built from source code. This client provides methods
+ * to get build details, wait for the build to finish, abort it, and access its logs.
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ * const buildClient = client.build('my-build-id');
+ *
+ * // Get build details
+ * const build = await buildClient.get();
+ *
+ * // Wait for the build to finish
+ * const finishedBuild = await buildClient.waitForFinish();
+ *
+ * // Access build logs
+ * const log = await buildClient.log().get();
+ * ```
+ *
+ * @see https://docs.apify.com/platform/actors/running/runs-and-builds#builds
+ */
 class BuildClient extends resource_client_1.ResourceClient {
     /**
      * @hidden
@@ -17,7 +40,22 @@ class BuildClient extends resource_client_1.ResourceClient {
         });
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build
+     * Gets the Actor build object from the Apify API.
+     *
+     * @param options - Get options
+     * @param options.waitForFinish - Maximum time to wait (in seconds, max 60s) for the build to finish on the API side before returning. Default is 0 (returns immediately).
+     * @returns The Build object, or `undefined` if it does not exist
+     * @see https://docs.apify.com/api/v2/actor-build-get
+     *
+     * @example
+     * ```javascript
+     * // Get build status immediately
+     * const build = await client.build('build-id').get();
+     * console.log(`Status: ${build.status}`);
+     *
+     * // Wait up to 60 seconds for build to finish
+     * const build = await client.build('build-id').get({ waitForFinish: 60 });
+     * ```
      */
     async get(options = {}) {
         (0, ow_1.default)(options, ow_1.default.object.exactShape({
@@ -26,7 +64,17 @@ class BuildClient extends resource_client_1.ResourceClient {
         return this._get(options);
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build
+     * Aborts the Actor build.
+     *
+     * Stops the build process immediately. The build will have an `ABORTED` status.
+     *
+     * @returns The updated Build object with `ABORTED` status
+     * @see https://docs.apify.com/api/v2/actor-build-abort-post
+     *
+     * @example
+     * ```javascript
+     * await client.build('build-id').abort();
+     * ```
      */
     async abort() {
         const response = await this.httpClient.call({
@@ -37,13 +85,18 @@ class BuildClient extends resource_client_1.ResourceClient {
         return (0, utils_1.cast)((0, utils_1.parseDateFields)((0, utils_1.pluckData)(response.data)));
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build
+     * Deletes the Actor build.
+     *
+     * @see https://docs.apify.com/api/v2/actor-build-delete
      */
     async delete() {
         return this._delete();
     }
     /**
-     * https://docs.apify.com/api/v2/actor-build-openapi-json-get
+     * Retrieves the OpenAPI definition for the Actor build.
+     *
+     * @returns The OpenAPI definition object.
+     * @see https://docs.apify.com/api/v2/actor-build-openapi-json-get
      */
     async getOpenApiDefinition() {
         const response = await this.httpClient.call({
@@ -54,15 +107,34 @@ class BuildClient extends resource_client_1.ResourceClient {
         return response.data;
     }
     /**
-     * Returns a promise that resolves with the finished Build object when the provided actor build finishes
-     * or with the unfinished Build object when the `waitSecs` timeout lapses. The promise is NOT rejected
-     * based on run status. You can inspect the `status` property of the Build object to find out its status.
+     * Waits for the Actor build to finish and returns the finished Build object.
+     *
+     * The promise resolves when the build reaches a terminal state (`SUCCEEDED`, `FAILED`, `ABORTED`, or `TIMED-OUT`).
+     * If `waitSecs` is provided and the timeout is reached, the promise resolves with the unfinished
+     * Build object (status will be `RUNNING` or `READY`). The promise is NOT rejected based on build status.
      *
-     * The difference between this function and the `waitForFinish` parameter of the `get` method
-     * is the fact that this function can wait indefinitely. Its use is preferable to the
-     * `waitForFinish` parameter alone, which it uses internally.
+     * Unlike the `waitForFinish` parameter in {@link get}, this method can wait indefinitely
+     * by polling the build status. It uses the `waitForFinish` parameter internally (max 60s per call)
+     * and continuously polls until the build finishes or the timeout is reached.
      *
      * This is useful when you need to immediately start a run after a build finishes.
+     *
+     * @param options - Wait options
+     * @param options.waitSecs - Maximum time to wait for the build to finish, in seconds. If omitted, waits indefinitely.
+     * @returns The Build object (finished or still building if timeout was reached)
+     *
+     * @example
+     * ```javascript
+     * // Wait indefinitely for build to finish
+     * const build = await client.build('build-id').waitForFinish();
+     * console.log(`Build finished with status: ${build.status}`);
+     *
+     * // Start a run immediately after build succeeds
+     * const build = await client.build('build-id').waitForFinish();
+     * if (build.status === 'SUCCEEDED') {
+     *   const run = await client.actor('my-actor').start();
+     * }
+     * ```
      */
     async waitForFinish(options = {}) {
         (0, ow_1.default)(options, ow_1.default.object.exactShape({
@@ -71,7 +143,17 @@ class BuildClient extends resource_client_1.ResourceClient {
         return this._waitForFinish(options);
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-builds/build-log
+     * Returns a client for accessing the log of this Actor build.
+     *
+     * @returns A client for accessing the build's log
+     * @see https://docs.apify.com/api/v2/actor-build-log-get
+     *
+     * @example
+     * ```javascript
+     * // Get build log
+     * const log = await client.build('build-id').log().get();
+     * console.log(log);
+     * ```
      */
     log() {
         return new log_1.LogClient(this._subResourceOptions({

package/dist/resource_clients/build.js.map

@@ -1 +1 @@
-{"version":3,"file":"build.js","sourceRoot":"","sources":["../../src/resource_clients/build.ts"],"names":[],"mappings":";;;;AAAA,oDAAoB;AAKpB,6DAAyD;AACzD,oCAA4D;AAE5D,+BAAkC;AAElC,MAAa,WAAY,SAAQ,gCAAc;IAC3C;;OAEG;IACH,YAAY,OAAoC;QAC5C,KAAK,CAAC;YACF,YAAY,EAAE,cAAc;YAC5B,GAAG,OAAO;SACb,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,CAAC,UAAiC,EAAE;QACzC,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,aAAa,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;SACpC,CAAC,CACL,CAAC;QAEF,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK;QACP,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,MAAM;YACd,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE;SACzB,CAAC,CAAC;QAEH,OAAO,IAAA,YAAI,EAAC,IAAA,uBAAe,EAAC,IAAA,iBAAS,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,oBAAoB;QACtB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC;YAC9B,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE;SACzB,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACzB,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,aAAa,CAAC,UAA2C,EAAE;QAC7D,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,QAAQ,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;SAC/B,CAAC,CACL,CAAC;QAEF,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;OAEG;IACH,GAAG;QACC,OAAO,IAAI,eAAS,CAChB,IAAI,CAAC,mBAAmB,CAAC;YACrB,YAAY,EAAE,KAAK;SACtB,CAAC,CACL,CAAC;IACN,CAAC;CACJ;AA1FD,kCA0FC"}
+{"version":3,"file":"build.js","sourceRoot":"","sources":["../../src/resource_clients/build.ts"],"names":[],"mappings":";;;;AAAA,oDAAoB;AAKpB,6DAAyD;AACzD,oCAA4D;AAE5D,+BAAkC;AAElC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAa,WAAY,SAAQ,gCAAc;IAC3C;;OAEG;IACH,YAAY,OAAoC;QAC5C,KAAK,CAAC;YACF,YAAY,EAAE,cAAc;YAC5B,GAAG,OAAO;SACb,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,GAAG,CAAC,UAAiC,EAAE;QACzC,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,aAAa,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;SACpC,CAAC,CACL,CAAC;QAEF,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,KAAK;QACP,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,MAAM;YACd,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE;SACzB,CAAC,CAAC;QAEH,OAAO,IAAA,YAAI,EAAC,IAAA,uBAAe,EAAC,IAAA,iBAAS,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,oBAAoB;QACtB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC;YAC9B,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE;SACzB,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACzB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,KAAK,CAAC,aAAa,CAAC,UAA2C,EAAE;QAC7D,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,QAAQ,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;SAC/B,CAAC,CACL,CAAC;QAEF,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,GAAG;QACC,OAAO,IAAI,eAAS,CAChB,IAAI,CAAC,mBAAmB,CAAC;YACrB,YAAY,EAAE,KAAK;SACtB,CAAC,CACL,CAAC;IACN,CAAC;CACJ;AArJD,kCAqJC"}

package/dist/resource_clients/build_collection.d.ts

@@ -2,19 +2,40 @@ import type { ApiClientOptionsWithOptionalResourcePath } from '../base/api_clien
 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);
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds
+     * 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.
@@ -22,6 +43,10 @@ export declare class BuildCollectionClient extends ResourceCollectionClient {
      * ```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>;
 }

package/dist/resource_clients/build_collection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"build_collection.d.ts","sourceRoot":"","sources":["../../src/resource_clients/build_collection.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,wCAAwC,EAAE,MAAM,oBAAoB,CAAC;AACnF,OAAO,EAAE,wBAAwB,EAAE,MAAM,oCAAoC,CAAC;AAC9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AACpF,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC,qBAAa,qBAAsB,SAAQ,wBAAwB;IAC/D;;OAEG;gBACS,OAAO,EAAE,wCAAwC;IAO7D;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,OAAO,GAAE,gCAAqC,GAAG,iBAAiB,CAAC,6BAA6B,CAAC;CAYzG;AAED,MAAM,WAAW,gCAAiC,SAAQ,iBAAiB;IACvE,IAAI,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,6BAA6B,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,GAAG,QAAQ,GAAG,WAAW,GAAG,YAAY,CAAC,CAAC,GAC3G,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,eAAe,CAAC,CAAC,CAAC;AAEnD,MAAM,MAAM,+BAA+B,GAAG,aAAa,CAAC,6BAA6B,CAAC,CAAC"}
+{"version":3,"file":"build_collection.d.ts","sourceRoot":"","sources":["../../src/resource_clients/build_collection.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,wCAAwC,EAAE,MAAM,oBAAoB,CAAC;AACnF,OAAO,EAAE,wBAAwB,EAAE,MAAM,oCAAoC,CAAC;AAC9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AACpF,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,qBAAsB,SAAQ,wBAAwB;IAC/D;;OAEG;gBACS,OAAO,EAAE,wCAAwC;IAO7D;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CAAC,OAAO,GAAE,gCAAqC,GAAG,iBAAiB,CAAC,6BAA6B,CAAC;CAYzG;AAED,MAAM,WAAW,gCAAiC,SAAQ,iBAAiB;IACvE,IAAI,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,6BAA6B,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,GAAG,QAAQ,GAAG,WAAW,GAAG,YAAY,CAAC,CAAC,GAC3G,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,eAAe,CAAC,CAAC,CAAC;AAEnD,MAAM,MAAM,+BAA+B,GAAG,aAAa,CAAC,6BAA6B,CAAC,CAAC"}

package/dist/resource_clients/build_collection.js

@@ -4,6 +4,27 @@ exports.BuildCollectionClient = void 0;
 const tslib_1 = require("tslib");
 const ow_1 = tslib_1.__importDefault(require("ow"));
 const resource_collection_client_1 = require("../base/resource_collection_client");
+/**
+ * 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
+ */
 class BuildCollectionClient extends resource_collection_client_1.ResourceCollectionClient {
     /**
      * @hidden
@@ -15,13 +36,13 @@ class BuildCollectionClient extends resource_collection_client_1.ResourceCollect
         });
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds
+     * 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.
@@ -29,6 +50,10 @@ class BuildCollectionClient extends resource_collection_client_1.ResourceCollect
      * ```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 = {}) {
         (0, ow_1.default)(options, ow_1.default.object.exactShape({

package/dist/resource_clients/build_collection.js.map

@@ -1 +1 @@
-{"version":3,"file":"build_collection.js","sourceRoot":"","sources":["../../src/resource_clients/build_collection.ts"],"names":[],"mappings":";;;;AAAA,oDAAoB;AAGpB,mFAA8E;AAI9E,MAAa,qBAAsB,SAAQ,qDAAwB;IAC/D;;OAEG;IACH,YAAY,OAAiD;QACzD,KAAK,CAAC;YACF,GAAG,OAAO;YACV,YAAY,EAAE,OAAO,CAAC,YAAY,IAAI,cAAc;SACvD,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,UAA4C,EAAE;QAC/C,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACzB,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC1B,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;SAC5B,CAAC,CACL,CAAC;QAEF,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;CACJ;AAvCD,sDAuCC"}
+{"version":3,"file":"build_collection.js","sourceRoot":"","sources":["../../src/resource_clients/build_collection.ts"],"names":[],"mappings":";;;;AAAA,oDAAoB;AAGpB,mFAA8E;AAI9E;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAa,qBAAsB,SAAQ,qDAAwB;IAC/D;;OAEG;IACH,YAAY,OAAiD;QACzD,KAAK,CAAC;YACF,GAAG,OAAO;YACV,YAAY,EAAE,OAAO,CAAC,YAAY,IAAI,cAAc;SACvD,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CAAC,UAA4C,EAAE;QAC/C,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACzB,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC1B,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;SAC5B,CAAC,CACL,CAAC;QAEF,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;CACJ;AA3CD,sDA2CC"}