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

package/dist/resource_clients/run.js

@@ -11,6 +11,29 @@ const key_value_store_1 = require("./key_value_store");
 const log_2 = require("./log");
 const request_queue_1 = require("./request_queue");
 const RUN_CHARGE_IDEMPOTENCY_HEADER = 'idempotency-key';
+/**
+ * Client for managing a specific Actor run.
+ *
+ * Provides methods to get run details, abort, metamorph, resurrect, wait for completion,
+ * and access the run's dataset, key-value store, request queue, and logs.
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ * const runClient = client.run('my-run-id');
+ *
+ * // Get run details
+ * const run = await runClient.get();
+ *
+ * // Wait for the run to finish
+ * const finishedRun = await runClient.waitForFinish();
+ *
+ * // Access the run's dataset
+ * const { items } = await runClient.dataset().listItems();
+ * ```
+ *
+ * @see https://docs.apify.com/platform/actors/running/runs-and-builds
+ */
 class RunClient extends resource_client_1.ResourceClient {
     /**
      * @hidden
@@ -22,7 +45,22 @@ class RunClient extends resource_client_1.ResourceClient {
         });
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run
+     * Gets the Actor run object from the Apify API.
+     *
+     * @param options - Get options
+     * @param options.waitForFinish - Maximum time to wait (in seconds, max 60s) for the run to finish on the API side before returning. Default is 0 (returns immediately).
+     * @returns The ActorRun object, or `undefined` if it does not exist
+     * @see https://docs.apify.com/api/v2/actor-run-get
+     *
+     * @example
+     * ```javascript
+     * // Get run status immediately
+     * const run = await client.run('run-id').get();
+     * console.log(`Status: ${run.status}`);
+     *
+     * // Wait up to 60 seconds for run to finish
+     * const run = await client.run('run-id').get({ waitForFinish: 60 });
+     * ```
      */
     async get(options = {}) {
         (0, ow_1.default)(options, ow_1.default.object.exactShape({
@@ -31,7 +69,21 @@ class RunClient extends resource_client_1.ResourceClient {
         return this._get(options);
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run
+     * Aborts the Actor run.
+     *
+     * @param options - Abort options
+     * @param options.gracefully - If `true`, the Actor run will abort gracefully - it can send status messages and perform cleanup. Default is `false` (immediate abort).
+     * @returns The updated ActorRun object with `ABORTING` or `ABORTED` status
+     * @see https://docs.apify.com/api/v2/actor-run-abort-post
+     *
+     * @example
+     * ```javascript
+     * // Abort immediately
+     * await client.run('run-id').abort();
+     *
+     * // Abort gracefully (allows cleanup)
+     * await client.run('run-id').abort({ gracefully: true });
+     * ```
      */
     async abort(options = {}) {
         (0, ow_1.default)(options, ow_1.default.object.exactShape({
@@ -45,13 +97,37 @@ class RunClient 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-runs/delete-run/delete-run
+     * Deletes the Actor run.
+     *
+     * @see https://docs.apify.com/api/v2/actor-run-delete
      */
     async delete() {
         return this._delete();
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run
+     * Transforms the Actor run into a run of another Actor (metamorph).
+     *
+     * This operation preserves the run ID, storages (dataset, key-value store, request queue),
+     * and resource allocation. The run effectively becomes a run of the target Actor with new input.
+     * This is useful for chaining Actor executions or implementing complex workflows.
+     *
+     * @param targetActorId - ID or username/name of the target Actor
+     * @param input - Input for the target Actor. Can be any JSON-serializable value.
+     * @param options - Metamorph options
+     * @param options.build - Tag or number of the target Actor's build to run. Default is the target Actor's default build.
+     * @param options.contentType - Content type of the input. If specified, input must be a string or Buffer.
+     * @returns The metamorphed ActorRun object (same ID, but now running the target Actor)
+     * @see https://docs.apify.com/api/v2/actor-run-metamorph-post
+     *
+     * @example
+     * ```javascript
+     * // Transform current run into another Actor
+     * const metamorphedRun = await client.run('original-run-id').metamorph(
+     *   'target-actor-id',
+     *   { url: 'https://example.com' }
+     * );
+     * console.log(`Run ${metamorphedRun.id} is now running ${metamorphedRun.actId}`);
+     * ```
      */
     async metamorph(targetActorId, input, options = {}) {
         (0, ow_1.default)(targetActorId, ow_1.default.string);
@@ -85,7 +161,19 @@ class RunClient 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-runs/reboot-run/reboot-run
+     * Reboots the Actor run.
+     *
+     * Rebooting restarts the Actor's Docker container while preserving the run ID and storages.
+     * This can be useful to recover from certain errors or to force the Actor to restart
+     * with a fresh environment.
+     *
+     * @returns The updated ActorRun object
+     * @see https://docs.apify.com/api/v2/actor-run-reboot-post
+     *
+     * @example
+     * ```javascript
+     * const run = await client.run('run-id').reboot();
+     * ```
      */
     async reboot() {
         const request = {
@@ -95,12 +183,49 @@ class RunClient extends resource_client_1.ResourceClient {
         const response = await this.httpClient.call(request);
         return (0, utils_1.cast)((0, utils_1.parseDateFields)((0, utils_1.pluckData)(response.data)));
     }
+    /**
+     * Updates the Actor run with specified fields.
+     *
+     * @param newFields - Fields to update
+     * @param newFields.statusMessage - Custom status message to display (e.g., "Processing page 10/100")
+     * @param newFields.isStatusMessageTerminal - If `true`, the status message is final and won't be overwritten. Default is `false`.
+     * @param newFields.generalAccess - General resource access level ('FOLLOW_USER_SETTING', 'ANYONE_WITH_ID_CAN_READ' or 'RESTRICTED')
+     * @returns The updated ActorRun object
+     *
+     * @example
+     * ```javascript
+     * // Set a status message
+     * await client.run('run-id').update({
+     *   statusMessage: 'Processing items: 50/100'
+     * });
+     * ```
+     */
     async update(newFields) {
         (0, ow_1.default)(newFields, ow_1.default.object);
         return this._update(newFields);
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run
+     * Resurrects a finished Actor run, starting it again with the same settings.
+     *
+     * This creates a new run with the same configuration as the original run. The original
+     * run's storages (dataset, key-value store, request queue) are preserved and reused.
+     *
+     * @param options - Resurrection options (override original run settings)
+     * @param options.build - Tag or number of the build to use. If not provided, uses the original run's build.
+     * @param options.memory - Memory in megabytes. If not provided, uses the original run's memory.
+     * @param options.timeout - Timeout in seconds. If not provided, uses the original run's timeout.
+     * @param options.maxItems - Maximum number of dataset items (pay-per-result Actors).
+     * @param options.maxTotalChargeUsd - Maximum cost in USD (pay-per-event Actors).
+     * @param options.restartOnError - Whether to restart on error.
+     * @returns The new (resurrected) ActorRun object
+     * @see https://docs.apify.com/api/v2/post-resurrect-run
+     *
+     * @example
+     * ```javascript
+     * // Resurrect a failed run with more memory
+     * const newRun = await client.run('failed-run-id').resurrect({ memory: 2048 });
+     * console.log(`New run started: ${newRun.id}`);
+     * ```
      */
     async resurrect(options = {}) {
         (0, ow_1.default)(options, ow_1.default.object.exactShape({
@@ -119,7 +244,14 @@ class RunClient 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-runs/charge-events-in-run
+     * Charges the Actor run for a specific event.
+     *
+     * @param options - Charge options including event name and count.
+     * @param options.eventName - **Required.** Name of the event to charge for.
+     * @param options.count - Number of times to charge the event. Default is 1.
+     * @param options.idempotencyKey - Optional key to ensure the charge is not duplicated. If not provided, one is auto-generated.
+     * @returns Empty response object.
+     * @see https://docs.apify.com/api/v2/post-charge-run
      */
     async charge(options) {
         var _a, _b;
@@ -147,16 +279,32 @@ class RunClient extends resource_client_1.ResourceClient {
         return response;
     }
     /**
-     * Returns a promise that resolves with the finished Run object when the provided actor run finishes
-     * or with the unfinished Run object when the `waitSecs` timeout lapses. The promise is NOT rejected
-     * based on run status. You can inspect the `status` property of the Run object to find out its status.
+     * Waits for the Actor run to finish and returns the finished Run object.
      *
-     * 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.
+     * The promise resolves when the run 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
+     * Run object (status will be `RUNNING` or `READY`). The promise is NOT rejected based on run status.
      *
-     * This is useful when you need to chain actor executions. Similar effect can be achieved
-     * by using webhooks, so be sure to review which technique fits your use-case better.
+     * Unlike the `waitForFinish` parameter in {@link get}, this method can wait indefinitely
+     * by polling the run status. It uses the `waitForFinish` parameter internally (max 60s per call)
+     * and continuously polls until the run finishes or the timeout is reached.
+     *
+     * @param options - Wait options
+     * @param options.waitSecs - Maximum time to wait for the run to finish, in seconds. If the limit is reached, the returned promise resolves to a run object that will have status `READY` or `RUNNING`. If omitted, waits indefinitely.
+     * @returns The ActorRun object (finished or still running if timeout was reached)
+     *
+     * @example
+     * ```javascript
+     * // Wait indefinitely for run to finish
+     * const run = await client.run('run-id').waitForFinish();
+     * console.log(`Run finished with status: ${run.status}`);
+     *
+     * // Wait up to 5 minutes
+     * const run = await client.run('run-id').waitForFinish({ waitSecs: 300 });
+     * if (run.status === 'SUCCEEDED') {
+     *   console.log('Run succeeded!');
+     * }
+     * ```
      */
     async waitForFinish(options = {}) {
         (0, ow_1.default)(options, ow_1.default.object.exactShape({
@@ -165,10 +313,16 @@ class RunClient extends resource_client_1.ResourceClient {
         return this._waitForFinish(options);
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-runs/run-object-and-its-storages
+     * Returns a client for the default dataset of this Actor run.
+     *
+     * @returns A client for accessing the run's default dataset
+     * @see https://docs.apify.com/api/v2/actor-run-get
      *
-     * This also works through `actorClient.lastRun().dataset()`.
-     * https://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages
+     * @example
+     * ```javascript
+     * // Access run's dataset
+     * const { items } = await client.run('run-id').dataset().listItems();
+     * ```
      */
     dataset() {
         return new dataset_1.DatasetClient(this._subResourceOptions({
@@ -176,10 +330,16 @@ class RunClient extends resource_client_1.ResourceClient {
         }));
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-runs/run-object-and-its-storages
+     * Returns a client for the default key-value store of this Actor run.
      *
-     * This also works through `actorClient.lastRun().keyValueStore()`.
-     * https://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages
+     * @returns A client for accessing the run's default key-value store
+     * @see https://docs.apify.com/api/v2/actor-run-get
+     *
+     * @example
+     * ```javascript
+     * // Access run's key-value store
+     * const output = await client.run('run-id').keyValueStore().getRecord('OUTPUT');
+     * ```
      */
     keyValueStore() {
         return new key_value_store_1.KeyValueStoreClient(this._subResourceOptions({
@@ -187,10 +347,16 @@ class RunClient extends resource_client_1.ResourceClient {
         }));
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-runs/run-object-and-its-storages
+     * Returns a client for the default Request queue of this Actor run.
+     *
+     * @returns A client for accessing the run's default Request queue
+     * @see https://docs.apify.com/api/v2/actor-run-get
      *
-     * This also works through `actorClient.lastRun().requestQueue()`.
-     * https://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages
+     * @example
+     * ```javascript
+     * // Access run's Request queue
+     * const { items } = await client.run('run-id').requestQueue().listHead();
+     * ```
      */
     requestQueue() {
         return new request_queue_1.RequestQueueClient(this._subResourceOptions({
@@ -198,10 +364,17 @@ class RunClient extends resource_client_1.ResourceClient {
         }));
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-runs/run-object-and-its-storages
+     * Returns a client for accessing the log of this Actor run.
+     *
+     * @returns A client for accessing the run's log
+     * @see https://docs.apify.com/api/v2/actor-run-get
      *
-     * This also works through `actorClient.lastRun().log()`.
-     * https://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages
+     * @example
+     * ```javascript
+     * // Get run log
+     * const log = await client.run('run-id').log().get();
+     * console.log(log);
+     * ```
      */
     log() {
         return new log_2.LogClient(this._subResourceOptions({

package/dist/resource_clients/run.js.map

@@ -1 +1 @@
-{"version":3,"file":"run.js","sourceRoot":"","sources":["../../src/resource_clients/run.ts"],"names":[],"mappings":";;;;AACA,oDAAoB;AAGpB,oCAAyC;AAGzC,6DAAyD;AAEzD,oCAAoE;AAEpE,uCAA0C;AAC1C,uDAAwD;AACxD,+BAAoE;AACpE,mDAAqD;AAErD,MAAM,6BAA6B,GAAG,iBAAiB,CAAC;AAExD,MAAa,SAAU,SAAQ,gCAAc;IACzC;;OAEG;IACH,YAAY,OAAiD;QACzD,KAAK,CAAC;YACF,GAAG,OAAO;YACV,YAAY,EAAE,OAAO,CAAC,YAAY,IAAI,YAAY;SACrD,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,CAAC,UAAyB,EAAE;QACjC,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,CAAC,UAA2B,EAAE;QACrC,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,UAAU,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;SAClC,CAAC,CACL,CAAC;QAEF,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,CAAC,OAAO,CAAC;SAChC,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,SAAS,CAAC,aAAqB,EAAE,KAAc,EAAE,UAA+B,EAAE;QACpF,IAAA,YAAE,EAAC,aAAa,EAAE,YAAE,CAAC,MAAM,CAAC,CAAC;QAC7B,+CAA+C;QAC/C,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,WAAW,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC/B,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;SAC5B,CAAC,CACL,CAAC;QAEF,MAAM,iBAAiB,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAExD,MAAM,MAAM,GAAG;YACX,aAAa,EAAE,iBAAiB;YAChC,KAAK,EAAE,OAAO,CAAC,KAAK;SACvB,CAAC;QAEF,MAAM,OAAO,GAAuB;YAChC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC;YAC3B,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,KAAK;YACX,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;YAC5B,uEAAuE;YACvE,4DAA4D;YAC5D,oFAAoF;YACpF,yCAAyC;YACzC,kBAAkB,EAAE,IAAI;SAC3B,CAAC;QAEF,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YACtB,OAAO,CAAC,OAAO,GAAG;gBACd,cAAc,EAAE,OAAO,CAAC,WAAW;aACtC,CAAC;QACN,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACrD,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,MAAM,OAAO,GAAuB;YAChC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;YACxB,MAAM,EAAE,MAAM;SACjB,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACrD,OAAO,IAAA,YAAI,EAAC,IAAA,uBAAe,EAAC,IAAA,iBAAS,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,SAA2B;QACpC,IAAA,YAAE,EAAC,SAAS,EAAE,YAAE,CAAC,MAAM,CAAC,CAAC;QAEzB,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,UAA+B,EAAE;QAC7C,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,OAAO,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC3B,QAAQ,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC5B,iBAAiB,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACrC,cAAc,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;SACtC,CAAC,CACL,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC;YAC3B,MAAM,EAAE,MAAM;YACd,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;SAChC,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,CAAC,OAAyB;;QAClC,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,SAAS,EAAE,YAAE,CAAC,MAAM;YACpB,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACzB,cAAc,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;SACrC,CAAC,CACL,CAAC;QAEF,MAAM,KAAK,GAAG,MAAA,OAAO,CAAC,KAAK,mCAAI,CAAC,CAAC;QACjC,wFAAwF;QACxF,MAAM,YAAY,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAClE,MAAM,cAAc,GAChB,MAAA,OAAO,CAAC,cAAc,mCAAI,GAAG,IAAI,CAAC,EAAE,IAAI,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,GAAG,EAAE,IAAI,YAAY,EAAE,CAAC;QAE9F,MAAM,OAAO,GAAuB;YAChC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;YACxB,MAAM,EAAE,MAAM;YACd,IAAI,EAAE;gBACF,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,KAAK;aACR;YACD,OAAO,EAAE;gBACL,CAAC,6BAA6B,CAAC,EAAE,cAAc;aAClD;SACJ,CAAC;QACF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACrD,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,aAAa,CAAC,UAAmC,EAAE;QACrD,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;;;;;OAKG;IACH,OAAO;QACH,OAAO,IAAI,uBAAa,CACpB,IAAI,CAAC,mBAAmB,CAAC;YACrB,YAAY,EAAE,SAAS;SAC1B,CAAC,CACL,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACH,aAAa;QACT,OAAO,IAAI,qCAAmB,CAC1B,IAAI,CAAC,mBAAmB,CAAC;YACrB,YAAY,EAAE,iBAAiB;SAClC,CAAC,CACL,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACH,YAAY;QACR,OAAO,IAAI,kCAAkB,CACzB,IAAI,CAAC,mBAAmB,CAAC;YACrB,YAAY,EAAE,eAAe;SAChC,CAAC,CACL,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACH,GAAG;QACC,OAAO,IAAI,eAAS,CAChB,IAAI,CAAC,mBAAmB,CAAC;YACrB,YAAY,EAAE,KAAK;SACtB,CAAC,CACL,CAAC;IACN,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAAC,UAAiC,EAAE;;QACpD,MAAM,EAAE,SAAS,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;QACrC,IAAI,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;QACxB,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,IAAA,cAAM,GAAE,EAAE,CAAC;YAC9B,0CAA0C;YAC1C,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YAC7C,6BAA6B;YAC7B,4BAA4B;YAC5B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;YACjC,MAAM,KAAK,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,EAAE,mCAAI,EAAE,CAAC;YAEhC,MAAM,OAAO,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,mCAAI,EAAE,CAAC;YACrC,MAAM,SAAS,GAAG,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;YAEhF,MAAM,SAAS,GAAG,MAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,IAAI,mCAAI,EAAE,CAAC;YACxC,MAAM,IAAI,GAAG,CAAC,SAAS,EAAE,SAAS,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAErE,KAAK,GAAG,IAAI,SAAG,CAAC,EAAE,KAAK,EAAE,YAAM,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,MAAM,EAAE,MAAM,EAAE,IAAI,yBAAmB,EAAE,EAAE,CAAC,CAAC;QACvG,CAAC;QAED,OAAO,IAAI,iBAAW,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IACxE,CAAC;CACJ;AAvRD,8BAuRC"}
+{"version":3,"file":"run.js","sourceRoot":"","sources":["../../src/resource_clients/run.ts"],"names":[],"mappings":";;;;AACA,oDAAoB;AAGpB,oCAAyC;AAGzC,6DAAyD;AAEzD,oCAAoE;AAEpE,uCAA0C;AAC1C,uDAAwD;AACxD,+BAAoE;AACpE,mDAAqD;AAErD,MAAM,6BAA6B,GAAG,iBAAiB,CAAC;AAExD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAa,SAAU,SAAQ,gCAAc;IACzC;;OAEG;IACH,YAAY,OAAiD;QACzD,KAAK,CAAC;YACF,GAAG,OAAO;YACV,YAAY,EAAE,OAAO,CAAC,YAAY,IAAI,YAAY;SACrD,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,GAAG,CAAC,UAAyB,EAAE;QACjC,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;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,KAAK,CAAC,UAA2B,EAAE;QACrC,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,UAAU,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;SAClC,CAAC,CACL,CAAC;QAEF,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,CAAC,OAAO,CAAC;SAChC,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;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAK,CAAC,SAAS,CAAC,aAAqB,EAAE,KAAc,EAAE,UAA+B,EAAE;QACpF,IAAA,YAAE,EAAC,aAAa,EAAE,YAAE,CAAC,MAAM,CAAC,CAAC;QAC7B,+CAA+C;QAC/C,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,WAAW,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC/B,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;SAC5B,CAAC,CACL,CAAC;QAEF,MAAM,iBAAiB,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAExD,MAAM,MAAM,GAAG;YACX,aAAa,EAAE,iBAAiB;YAChC,KAAK,EAAE,OAAO,CAAC,KAAK;SACvB,CAAC;QAEF,MAAM,OAAO,GAAuB;YAChC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC;YAC3B,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,KAAK;YACX,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;YAC5B,uEAAuE;YACvE,4DAA4D;YAC5D,oFAAoF;YACpF,yCAAyC;YACzC,kBAAkB,EAAE,IAAI;SAC3B,CAAC;QAEF,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YACtB,OAAO,CAAC,OAAO,GAAG;gBACd,cAAc,EAAE,OAAO,CAAC,WAAW;aACtC,CAAC;QACN,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACrD,OAAO,IAAA,YAAI,EAAC,IAAA,uBAAe,EAAC,IAAA,iBAAS,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM;QACR,MAAM,OAAO,GAAuB;YAChC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;YACxB,MAAM,EAAE,MAAM;SACjB,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACrD,OAAO,IAAA,YAAI,EAAC,IAAA,uBAAe,EAAC,IAAA,iBAAS,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,MAAM,CAAC,SAA2B;QACpC,IAAA,YAAE,EAAC,SAAS,EAAE,YAAE,CAAC,MAAM,CAAC,CAAC;QAEzB,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,SAAS,CAAC,UAA+B,EAAE;QAC7C,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,OAAO,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC3B,QAAQ,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC5B,iBAAiB,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACrC,cAAc,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;SACtC,CAAC,CACL,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC;YAC3B,MAAM,EAAE,MAAM;YACd,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;SAChC,CAAC,CAAC;QAEH,OAAO,IAAA,YAAI,EAAC,IAAA,uBAAe,EAAC,IAAA,iBAAS,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,MAAM,CAAC,OAAyB;;QAClC,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,SAAS,EAAE,YAAE,CAAC,MAAM;YACpB,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACzB,cAAc,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;SACrC,CAAC,CACL,CAAC;QAEF,MAAM,KAAK,GAAG,MAAA,OAAO,CAAC,KAAK,mCAAI,CAAC,CAAC;QACjC,wFAAwF;QACxF,MAAM,YAAY,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAClE,MAAM,cAAc,GAChB,MAAA,OAAO,CAAC,cAAc,mCAAI,GAAG,IAAI,CAAC,EAAE,IAAI,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,GAAG,EAAE,IAAI,YAAY,EAAE,CAAC;QAE9F,MAAM,OAAO,GAAuB;YAChC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;YACxB,MAAM,EAAE,MAAM;YACd,IAAI,EAAE;gBACF,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,KAAK;aACR;YACD,OAAO,EAAE;gBACL,CAAC,6BAA6B,CAAC,EAAE,cAAc;aAClD;SACJ,CAAC;QACF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACrD,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,KAAK,CAAC,aAAa,CAAC,UAAmC,EAAE;QACrD,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;;;;;;;;;;;OAWG;IACH,OAAO;QACH,OAAO,IAAI,uBAAa,CACpB,IAAI,CAAC,mBAAmB,CAAC;YACrB,YAAY,EAAE,SAAS;SAC1B,CAAC,CACL,CAAC;IACN,CAAC;IAED;;;;;;;;;;;OAWG;IACH,aAAa;QACT,OAAO,IAAI,qCAAmB,CAC1B,IAAI,CAAC,mBAAmB,CAAC;YACrB,YAAY,EAAE,iBAAiB;SAClC,CAAC,CACL,CAAC;IACN,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY;QACR,OAAO,IAAI,kCAAkB,CACzB,IAAI,CAAC,mBAAmB,CAAC;YACrB,YAAY,EAAE,eAAe;SAChC,CAAC,CACL,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,GAAG;QACC,OAAO,IAAI,eAAS,CAChB,IAAI,CAAC,mBAAmB,CAAC;YACrB,YAAY,EAAE,KAAK;SACtB,CAAC,CACL,CAAC;IACN,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAAC,UAAiC,EAAE;;QACpD,MAAM,EAAE,SAAS,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;QACrC,IAAI,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;QACxB,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,IAAA,cAAM,GAAE,EAAE,CAAC;YAC9B,0CAA0C;YAC1C,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YAC7C,6BAA6B;YAC7B,4BAA4B;YAC5B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;YACjC,MAAM,KAAK,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,EAAE,mCAAI,EAAE,CAAC;YAEhC,MAAM,OAAO,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,mCAAI,EAAE,CAAC;YACrC,MAAM,SAAS,GAAG,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;YAEhF,MAAM,SAAS,GAAG,MAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,IAAI,mCAAI,EAAE,CAAC;YACxC,MAAM,IAAI,GAAG,CAAC,SAAS,EAAE,SAAS,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAErE,KAAK,GAAG,IAAI,SAAG,CAAC,EAAE,KAAK,EAAE,YAAM,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,MAAM,EAAE,MAAM,EAAE,IAAI,yBAAmB,EAAE,EAAE,CAAC,CAAC;QACvG,CAAC;QAED,OAAO,IAAI,iBAAW,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IACxE,CAAC;CACJ;AA7aD,8BA6aC"}

package/dist/resource_clients/run_collection.d.ts

@@ -3,19 +3,40 @@ import type { ApiClientOptionsWithOptionalResourcePath } from '../base/api_clien
 import { ResourceCollectionClient } from '../base/resource_collection_client';
 import type { PaginatedIterator, PaginationOptions } from '../utils';
 import type { ActorRunListItem } from './actor';
+/**
+ * Client for managing the collection of Actor runs.
+ *
+ * Provides methods to list Actor runs across all Actors or for a specific Actor.
+ * To access an individual run, use the `run()` method on the main ApifyClient.
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ *
+ * // List all runs
+ * const runsClient = client.runs();
+ * const { items } = await runsClient.list();
+ *
+ * // List runs for a specific Actor
+ * const actorRunsClient = client.actor('my-actor-id').runs();
+ * const { items: actorRuns } = await actorRunsClient.list();
+ * ```
+ *
+ * @see https://docs.apify.com/platform/actors/running/runs-and-builds
+ */
 export declare class RunCollectionClient extends ResourceCollectionClient {
     /**
      * @hidden
      */
     constructor(options: ApiClientOptionsWithOptionalResourcePath);
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs
+     * Lists all Actor runs.
      *
      * 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.
@@ -23,6 +44,10 @@ export declare class RunCollectionClient extends ResourceCollectionClient {
      * ```javascript
      * for await (const singleItem of client.list(options)) {...}
      * ```
+     *
+     * @param options - Pagination and filtering options.
+     * @returns A paginated iterator of Actor runs.
+     * @see https://docs.apify.com/api/v2/actor-runs-get
      */
     list(options?: RunCollectionListOptions): PaginatedIterator<ActorRunListItem>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"run_collection.d.ts","sourceRoot":"","sources":["../../src/resource_clients/run_collection.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAEnD,OAAO,KAAK,EAAE,wCAAwC,EAAE,MAAM,oBAAoB,CAAC;AACnF,OAAO,EAAE,wBAAwB,EAAE,MAAM,oCAAoC,CAAC;AAC9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEhD,qBAAa,mBAAoB,SAAQ,wBAAwB;IAC7D;;OAEG;gBACS,OAAO,EAAE,wCAAwC;IAO7D;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,OAAO,GAAE,wBAA6B,GAAG,iBAAiB,CAAC,gBAAgB,CAAC;CAkBpF;AAED,MAAM,WAAW,wBAAyB,SAAQ,iBAAiB;IAC/D,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EACD,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,OAAO,kBAAkB,CAAC,GAC5D,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,OAAO,kBAAkB,CAAC,EAAE,CAAC;IACrE,aAAa,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;IAC9B,YAAY,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;CAChC"}
+{"version":3,"file":"run_collection.d.ts","sourceRoot":"","sources":["../../src/resource_clients/run_collection.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAEnD,OAAO,KAAK,EAAE,wCAAwC,EAAE,MAAM,oBAAoB,CAAC;AACnF,OAAO,EAAE,wBAAwB,EAAE,MAAM,oCAAoC,CAAC;AAC9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEhD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,mBAAoB,SAAQ,wBAAwB;IAC7D;;OAEG;gBACS,OAAO,EAAE,wCAAwC;IAO7D;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CAAC,OAAO,GAAE,wBAA6B,GAAG,iBAAiB,CAAC,gBAAgB,CAAC;CAkBpF;AAED,MAAM,WAAW,wBAAyB,SAAQ,iBAAiB;IAC/D,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EACD,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,OAAO,kBAAkB,CAAC,GAC5D,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,OAAO,kBAAkB,CAAC,EAAE,CAAC;IACrE,aAAa,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;IAC9B,YAAY,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;CAChC"}

package/dist/resource_clients/run_collection.js

@@ -5,6 +5,27 @@ const tslib_1 = require("tslib");
 const ow_1 = tslib_1.__importDefault(require("ow"));
 const consts_1 = require("@apify/consts");
 const resource_collection_client_1 = require("../base/resource_collection_client");
+/**
+ * Client for managing the collection of Actor runs.
+ *
+ * Provides methods to list Actor runs across all Actors or for a specific Actor.
+ * To access an individual run, use the `run()` method on the main ApifyClient.
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ *
+ * // List all runs
+ * const runsClient = client.runs();
+ * const { items } = await runsClient.list();
+ *
+ * // List runs for a specific Actor
+ * const actorRunsClient = client.actor('my-actor-id').runs();
+ * const { items: actorRuns } = await actorRunsClient.list();
+ * ```
+ *
+ * @see https://docs.apify.com/platform/actors/running/runs-and-builds
+ */
 class RunCollectionClient extends resource_collection_client_1.ResourceCollectionClient {
     /**
      * @hidden
@@ -16,13 +37,13 @@ class RunCollectionClient extends resource_collection_client_1.ResourceCollectio
         });
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs
+     * Lists all Actor runs.
      *
      * 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.
@@ -30,6 +51,10 @@ class RunCollectionClient extends resource_collection_client_1.ResourceCollectio
      * ```javascript
      * for await (const singleItem of client.list(options)) {...}
      * ```
+     *
+     * @param options - Pagination and filtering options.
+     * @returns A paginated iterator of Actor runs.
+     * @see https://docs.apify.com/api/v2/actor-runs-get
      */
     list(options = {}) {
         (0, ow_1.default)(options, ow_1.default.object.exactShape({

package/dist/resource_clients/run_collection.js.map

@@ -1 +1 @@
-{"version":3,"file":"run_collection.js","sourceRoot":"","sources":["../../src/resource_clients/run_collection.ts"],"names":[],"mappings":";;;;AAAA,oDAAoB;AAEpB,0CAAmD;AAGnD,mFAA8E;AAI9E,MAAa,mBAAoB,SAAQ,qDAAwB;IAC7D;;OAEG;IACH,YAAY,OAAiD;QACzD,KAAK,CAAC;YACF,YAAY,EAAE,MAAM;YACpB,GAAG,OAAO;SACb,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,UAAoC,EAAE;QACvC,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;YACzB,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,GAAG,CACnB,YAAE,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,2BAAkB,CAAC,CAAC,EAClD,YAAE,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,2BAAkB,CAAC,CAAC,CAAC,CACtE;YACD,aAAa,EAAE,YAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC;YACpE,YAAY,EAAE,YAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC;SACtE,CAAC,CACL,CAAC;QAEF,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;CACJ;AA7CD,kDA6CC"}
+{"version":3,"file":"run_collection.js","sourceRoot":"","sources":["../../src/resource_clients/run_collection.ts"],"names":[],"mappings":";;;;AAAA,oDAAoB;AAEpB,0CAAmD;AAGnD,mFAA8E;AAI9E;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAa,mBAAoB,SAAQ,qDAAwB;IAC7D;;OAEG;IACH,YAAY,OAAiD;QACzD,KAAK,CAAC;YACF,YAAY,EAAE,MAAM;YACpB,GAAG,OAAO;SACb,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CAAC,UAAoC,EAAE;QACvC,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;YACzB,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,GAAG,CACnB,YAAE,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,2BAAkB,CAAC,CAAC,EAClD,YAAE,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,2BAAkB,CAAC,CAAC,CAAC,CACtE;YACD,aAAa,EAAE,YAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC;YACpE,YAAY,EAAE,YAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC;SACtE,CAAC,CACL,CAAC;QAEF,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;CACJ;AAjDD,kDAiDC"}

package/dist/resource_clients/schedule.d.ts

@@ -2,28 +2,68 @@ import type { ApiClientSubResourceOptions } from '../base/api_client';
 import { ResourceClient } from '../base/resource_client';
 import type { Timezone } from '../timezones';
 import type { DistributiveOptional } from '../utils';
+/**
+ * Client for managing a specific Schedule.
+ *
+ * Schedules are used to automatically start Actors or tasks at specified times. This client provides
+ * methods to get, update, and delete schedules, as well as retrieve schedule logs.
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ * const scheduleClient = client.schedule('my-schedule-id');
+ *
+ * // Get schedule details
+ * const schedule = await scheduleClient.get();
+ *
+ * // Update schedule
+ * await scheduleClient.update({
+ *   cronExpression: '0 12 * * *',
+ *   isEnabled: true
+ * });
+ * ```
+ *
+ * @see https://docs.apify.com/platform/schedules
+ */
 export declare class ScheduleClient extends ResourceClient {
     /**
      * @hidden
      */
     constructor(options: ApiClientSubResourceOptions);
     /**
-     * https://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule
+     * Retrieves the schedule.
+     *
+     * @returns The schedule object, or `undefined` if it does not exist.
+     * @see https://docs.apify.com/api/v2/schedule-get
      */
     get(): Promise<Schedule | undefined>;
     /**
-     * https://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule
+     * Updates the schedule with the specified fields.
+     *
+     * @param newFields - Fields to update.
+     * @returns The updated schedule object.
+     * @see https://docs.apify.com/api/v2/schedule-put
      */
     update(newFields: ScheduleCreateOrUpdateData): Promise<Schedule>;
     /**
-     * https://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule
+     * Deletes the schedule.
+     *
+     * @see https://docs.apify.com/api/v2/schedule-delete
      */
     delete(): Promise<void>;
     /**
-     * https://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log
+     * Retrieves the schedule's log.
+     *
+     * @returns The schedule log as a string, or `undefined` if it does not exist.
+     * @see https://docs.apify.com/api/v2/schedule-log-get
      */
     getLog(): Promise<string | undefined>;
 }
+/**
+ * Represents a schedule for automated Actor or Task runs.
+ *
+ * Schedules use cron expressions to define when Actors or Tasks should run automatically.
+ */
 export interface Schedule {
     id: string;
     userId: string;
@@ -43,9 +83,15 @@ export interface Schedule {
         email: boolean;
     };
 }
+/**
+ * Data for creating or updating a Schedule.
+ */
 export type ScheduleCreateOrUpdateData = Partial<Pick<Schedule, 'name' | 'title' | 'cronExpression' | 'timezone' | 'isEnabled' | 'isExclusive' | 'description' | 'notifications'> & {
     actions: DistributiveOptional<ScheduleAction, 'id'>[];
 }>;
+/**
+ * Types of actions that can be scheduled.
+ */
 export declare enum ScheduleActions {
     RunActor = "RUN_ACTOR",
     RunActorTask = "RUN_ACTOR_TASK"
@@ -54,22 +100,37 @@ interface BaseScheduleAction<Type extends ScheduleActions> {
     id: string;
     type: Type;
 }
+/**
+ * Union type representing all possible scheduled actions.
+ */
 export type ScheduleAction = ScheduleActionRunActor | ScheduleActionRunActorTask;
+/**
+ * Scheduled action to run an Actor.
+ */
 export interface ScheduleActionRunActor extends BaseScheduleAction<ScheduleActions.RunActor> {
     actorId: string;
     runInput?: ScheduledActorRunInput;
     runOptions?: ScheduledActorRunOptions;
 }
+/**
+ * Input configuration for a scheduled Actor run.
+ */
 export interface ScheduledActorRunInput {
     body: string;
     contentType: string;
 }
+/**
+ * Run options for a scheduled Actor run.
+ */
 export interface ScheduledActorRunOptions {
     build: string;
     timeoutSecs: number;
     memoryMbytes: number;
     restartOnError?: boolean;
 }
+/**
+ * Scheduled action to run an Actor task.
+ */
 export interface ScheduleActionRunActorTask extends BaseScheduleAction<ScheduleActions.RunActorTask> {
     actorTaskId: string;
     input?: string;

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

@@ -1 +1 @@
-{"version":3,"file":"schedule.d.ts","sourceRoot":"","sources":["../../src/resource_clients/schedule.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAGrD,qBAAa,cAAe,SAAQ,cAAc;IAC9C;;OAEG;gBACS,OAAO,EAAE,2BAA2B;IAOhD;;OAEG;IACG,GAAG,IAAI,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;IAI1C;;OAEG;IACG,MAAM,CAAC,SAAS,EAAE,0BAA0B,GAAG,OAAO,CAAC,QAAQ,CAAC;IAKtE;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAI7B;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;CAe9C;AAED,MAAM,WAAW,QAAQ;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,QAAQ,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,IAAI,CAAC;IAChB,UAAU,EAAE,IAAI,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,cAAc,EAAE,CAAC;IAC1B,aAAa,EAAE;QACX,KAAK,EAAE,OAAO,CAAC;KAClB,CAAC;CACL;AAED,MAAM,MAAM,0BAA0B,GAAG,OAAO,CAC5C,IAAI,CACA,QAAQ,EACR,MAAM,GAAG,OAAO,GAAG,gBAAgB,GAAG,UAAU,GAAG,WAAW,GAAG,aAAa,GAAG,aAAa,GAAG,eAAe,CACnH,GAAG;IACA,OAAO,EAAE,oBAAoB,CAAC,cAAc,EAAE,IAAI,CAAC,EAAE,CAAC;CACzD,CACJ,CAAC;AAEF,oBAAY,eAAe;IACvB,QAAQ,cAAc;IACtB,YAAY,mBAAmB;CAClC;AAED,UAAU,kBAAkB,CAAC,IAAI,SAAS,eAAe;IACrD,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,IAAI,CAAC;CACd;AAED,MAAM,MAAM,cAAc,GAAG,sBAAsB,GAAG,0BAA0B,CAAC;AAEjF,MAAM,WAAW,sBAAuB,SAAQ,kBAAkB,CAAC,eAAe,CAAC,QAAQ,CAAC;IACxF,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IAClC,UAAU,CAAC,EAAE,wBAAwB,CAAC;CACzC;AAED,MAAM,WAAW,sBAAsB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,wBAAwB;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB,CAAC,eAAe,CAAC,YAAY,CAAC;IAChG,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB"}
+{"version":3,"file":"schedule.d.ts","sourceRoot":"","sources":["../../src/resource_clients/schedule.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAGrD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,cAAe,SAAQ,cAAc;IAC9C;;OAEG;gBACS,OAAO,EAAE,2BAA2B;IAOhD;;;;;OAKG;IACG,GAAG,IAAI,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;IAI1C;;;;;;OAMG;IACG,MAAM,CAAC,SAAS,EAAE,0BAA0B,GAAG,OAAO,CAAC,QAAQ,CAAC;IAKtE;;;;OAIG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAI7B;;;;;OAKG;IACG,MAAM,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;CAe9C;AAED;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,QAAQ,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,IAAI,CAAC;IAChB,UAAU,EAAE,IAAI,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,cAAc,EAAE,CAAC;IAC1B,aAAa,EAAE;QACX,KAAK,EAAE,OAAO,CAAC;KAClB,CAAC;CACL;AAED;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,OAAO,CAC5C,IAAI,CACA,QAAQ,EACR,MAAM,GAAG,OAAO,GAAG,gBAAgB,GAAG,UAAU,GAAG,WAAW,GAAG,aAAa,GAAG,aAAa,GAAG,eAAe,CACnH,GAAG;IACA,OAAO,EAAE,oBAAoB,CAAC,cAAc,EAAE,IAAI,CAAC,EAAE,CAAC;CACzD,CACJ,CAAC;AAEF;;GAEG;AACH,oBAAY,eAAe;IACvB,QAAQ,cAAc;IACtB,YAAY,mBAAmB;CAClC;AAED,UAAU,kBAAkB,CAAC,IAAI,SAAS,eAAe;IACrD,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,IAAI,CAAC;CACd;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,sBAAsB,GAAG,0BAA0B,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,kBAAkB,CAAC,eAAe,CAAC,QAAQ,CAAC;IACxF,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IAClC,UAAU,CAAC,EAAE,wBAAwB,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB,CAAC,eAAe,CAAC,YAAY,CAAC;IAChG,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB"}