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

package/dist/resource_clients/task.js

@@ -9,6 +9,26 @@ const utils_1 = require("../utils");
 const run_1 = require("./run");
 const run_collection_1 = require("./run_collection");
 const webhook_collection_1 = require("./webhook_collection");
+/**
+ * Client for managing a specific Actor task.
+ *
+ * Tasks are pre-configured Actor runs with saved input and options. This client provides methods
+ * to start, call, update, and delete tasks, as well as manage their runs and webhooks.
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ * const taskClient = client.task('my-task-id');
+ *
+ * // Start a task
+ * const run = await taskClient.start();
+ *
+ * // Call a task and wait for it to finish
+ * const finishedRun = await taskClient.call();
+ * ```
+ *
+ * @see https://docs.apify.com/platform/actors/running/tasks
+ */
 class TaskClient extends resource_client_1.ResourceClient {
     /**
      * @hidden
@@ -20,27 +40,48 @@ class TaskClient extends resource_client_1.ResourceClient {
         });
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task
+     * Retrieves the Actor task.
+     *
+     * @returns The task object, or `undefined` if it does not exist.
+     * @see https://docs.apify.com/api/v2/actor-task-get
      */
     async get() {
         return this._get();
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task
+     * Updates the task with the specified fields.
+     *
+     * @param newFields - Fields to update.
+     * @returns The updated task object.
+     * @see https://docs.apify.com/api/v2/actor-task-put
      */
     async update(newFields) {
         (0, ow_1.default)(newFields, ow_1.default.object);
         return this._update(newFields);
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task
+     * Deletes the Task.
+     *
+     * @see https://docs.apify.com/api/v2/actor-task-delete
      */
     async delete() {
         return this._delete();
     }
     /**
-     * Starts a task and immediately returns the Run object.
-     * https://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task
+     * Starts an Actor task and immediately returns the Run object.
+     *
+     * @param input - Input overrides for the task. If not provided, the task's saved input is used.
+     * @param options - Run options.
+     * @param options.build - Tag or number of the Actor build to run (e.g., `'beta'` or `'1.2.345'`).
+     * @param options.memory - Memory in megabytes allocated for the run.
+     * @param options.timeout - Timeout for the run in seconds. Zero means no timeout.
+     * @param options.waitForFinish - Maximum time to wait (in seconds, max 60s) for the run to finish before returning.
+     * @param options.webhooks - Webhooks to trigger for specific Actor run events.
+     * @param options.maxItems - Maximum number of dataset items (for pay-per-result Actors).
+     * @param options.maxTotalChargeUsd - Maximum cost in USD (for pay-per-event Actors).
+     * @param options.restartOnError - Whether to restart the run on error.
+     * @returns The Actor Run object.
+     * @see https://docs.apify.com/api/v2/actor-task-runs-post
      */
     async start(input, options = {}) {
         (0, ow_1.default)(input, ow_1.default.optional.object);
@@ -83,7 +124,19 @@ class TaskClient extends resource_client_1.ResourceClient {
     /**
      * Starts a task and waits for it to finish before returning the Run object.
      * It waits indefinitely, unless the `waitSecs` option is provided.
-     * https://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task
+     *
+     * @param input - Input overrides for the task. If not provided, the task's saved input is used.
+     * @param options - Run and wait options.
+     * @param options.build - Tag or number of the Actor build to run.
+     * @param options.memory - Memory in megabytes allocated for the run.
+     * @param options.timeout - Timeout for the run in seconds.
+     * @param options.waitSecs - Maximum time to wait for the run to finish, in seconds. If omitted, waits indefinitely.
+     * @param options.webhooks - Webhooks to trigger for specific Actor run events.
+     * @param options.maxItems - Maximum number of dataset items (for pay-per-result Actors).
+     * @param options.maxTotalChargeUsd - Maximum cost in USD (for pay-per-event Actors).
+     * @param options.restartOnError - Whether to restart the run on error.
+     * @returns The Actor run object.
+     * @see https://docs.apify.com/api/v2/actor-task-runs-post
      */
     async call(input, options = {}) {
         (0, ow_1.default)(input, ow_1.default.optional.object);
@@ -105,7 +158,10 @@ class TaskClient extends resource_client_1.ResourceClient {
         return this.apifyClient.run(id).waitForFinish({ waitSecs });
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input
+     * Retrieves the Actor task's input object.
+     *
+     * @returns The Task's input, or `undefined` if it does not exist.
+     * @see https://docs.apify.com/api/v2/actor-task-input-get
      */
     async getInput() {
         const requestOpts = {
@@ -123,7 +179,11 @@ class TaskClient extends resource_client_1.ResourceClient {
         return undefined;
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input
+     * Updates the Actor task's input object.
+     *
+     * @param newFields - New input data for the task.
+     * @returns The updated task input.
+     * @see https://docs.apify.com/api/v2/actor-task-input-put
      */
     async updateInput(newFields) {
         const response = await this.httpClient.call({
@@ -135,7 +195,13 @@ class TaskClient extends resource_client_1.ResourceClient {
         return (0, utils_1.cast)(response.data);
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-tasks/last-run-object-and-its-storages
+     * Returns a client for the last run of this task.
+     *
+     * @param options - Filter options for the last run.
+     * @param options.status - Filter by run status (e.g., `'SUCCEEDED'`, `'FAILED'`, `'RUNNING'`).
+     * @param options.origin - Filter by run origin (e.g., `'WEB'`, `'API'`, `'SCHEDULE'`).
+     * @returns A client for the last run.
+     * @see https://docs.apify.com/api/v2/actor-task-runs-last-get
      */
     lastRun(options = {}) {
         (0, ow_1.default)(options, ow_1.default.object.exactShape({
@@ -149,7 +215,10 @@ class TaskClient extends resource_client_1.ResourceClient {
         }));
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-tasks/run-collection
+     * Returns a client for the Runs of this Task.
+     *
+     * @returns A client for the task's runs.
+     * @see https://docs.apify.com/api/v2/actor-task-runs-get
      */
     runs() {
         return new run_collection_1.RunCollectionClient(this._subResourceOptions({
@@ -157,7 +226,10 @@ class TaskClient extends resource_client_1.ResourceClient {
         }));
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-tasks/webhook-collection
+     * Returns a client for the Webhooks of this Task.
+     *
+     * @returns A client for the task's webhooks.
+     * @see https://docs.apify.com/api/v2/actor-task-webhooks-get
      */
     webhooks() {
         return new webhook_collection_1.WebhookCollectionClient(this._subResourceOptions());

package/dist/resource_clients/task.js.map

@@ -1 +1 @@
-{"version":3,"file":"task.js","sourceRoot":"","sources":["../../src/resource_clients/task.ts"],"names":[],"mappings":";;;;AAAA,oDAAoB;AAEpB,0CAA+D;AAI/D,6DAAyD;AAGzD,oCAA6G;AAE7G,+BAAkC;AAClC,qDAAuD;AACvD,6DAA+D;AAE/D,MAAa,UAAW,SAAQ,gCAAc;IAC1C;;OAEG;IACH,YAAY,OAAoC;QAC5C,KAAK,CAAC;YACF,YAAY,EAAE,aAAa;YAC3B,GAAG,OAAO;SACb,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG;QACL,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,SAAyB;QAClC,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,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,KAAK,CAAC,KAAkB,EAAE,UAA4B,EAAE;QAC1D,IAAA,YAAE,EAAC,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC9B,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,aAAa,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACjC,QAAQ,EAAE,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC;YAC7C,QAAQ,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ;YACzC,iBAAiB,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ;YAClD,cAAc,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;SACtC,CAAC,CACL,CAAC;QAEF,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;QAEvG,MAAM,MAAM,GAAG;YACX,aAAa;YACb,OAAO;YACP,MAAM;YACN,KAAK;YACL,QAAQ,EAAE,IAAA,iCAAyB,EAAC,OAAO,CAAC,QAAQ,CAAC;YACrD,QAAQ;YACR,iBAAiB;YACjB,cAAc;SACjB,CAAC;QAEF,MAAM,OAAO,GAAuB;YAChC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;YACtB,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,KAAK;YACX,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;YAC5B,uEAAuE;YACvE,4DAA4D;YAC5D,kBAAkB,EAAE,IAAI;YACxB,OAAO,EAAE;gBACL,cAAc,EAAE,kBAAkB;aACrC;SACJ,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;;;;OAIG;IACH,KAAK,CAAC,IAAI,CAAC,KAAkB,EAAE,UAA2B,EAAE;QACxD,IAAA,YAAE,EAAC,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC9B,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,CAAC,GAAG,CAAC,QAAQ;YACxC,QAAQ,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ;YACzC,QAAQ,EAAE,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC;YAC7C,QAAQ,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ;YACzC,iBAAiB,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ;YAClD,cAAc,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;SACtC,CAAC,CACL,CAAC;QAEF,MAAM,EAAE,QAAQ,EAAE,GAAG,YAAY,EAAE,GAAG,OAAO,CAAC;QAE9C,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;QAErD,+DAA+D;QAC/D,6DAA6D;QAC7D,kDAAkD;QAClD,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ;QACV,MAAM,WAAW,GAAuB;YACpC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE;SACzB,CAAC;QACF,IAAI,CAAC;YACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACzD,OAAO,IAAA,YAAI,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAA,4BAAoB,EAAC,GAAoB,CAAC,CAAC;QAC/C,CAAC;QAED,OAAO,SAAS,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CAAC,SAAoC;QAClD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE;YACtB,IAAI,EAAE,SAAS;SAClB,CAAC,CAAC;QAEH,OAAO,IAAA,YAAI,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,UAA8B,EAAE;QACpC,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,yBAAgB,CAAC,CAAC;YACjE,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,qBAAY,CAAC,CAAC;SAChE,CAAC,CACL,CAAC;QAEF,OAAO,IAAI,eAAS,CAChB,IAAI,CAAC,mBAAmB,CAAC;YACrB,EAAE,EAAE,MAAM;YACV,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;YAC7B,YAAY,EAAE,MAAM;SACvB,CAAC,CACL,CAAC;IACN,CAAC;IAED;;OAEG;IACH,IAAI;QACA,OAAO,IAAI,oCAAmB,CAC1B,IAAI,CAAC,mBAAmB,CAAC;YACrB,YAAY,EAAE,MAAM;SACvB,CAAC,CACL,CAAC;IACN,CAAC;IAED;;OAEG;IACH,QAAQ;QACJ,OAAO,IAAI,4CAAuB,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;IACnE,CAAC;CACJ;AA1LD,gCA0LC"}
+{"version":3,"file":"task.js","sourceRoot":"","sources":["../../src/resource_clients/task.ts"],"names":[],"mappings":";;;;AAAA,oDAAoB;AAEpB,0CAA+D;AAI/D,6DAAyD;AAGzD,oCAA6G;AAE7G,+BAAkC;AAClC,qDAAuD;AACvD,6DAA+D;AAE/D;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAa,UAAW,SAAQ,gCAAc;IAC1C;;OAEG;IACH,YAAY,OAAoC;QAC5C,KAAK,CAAC;YACF,YAAY,EAAE,aAAa;YAC3B,GAAG,OAAO;SACb,CAAC,CAAC;IACP,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,GAAG;QACL,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;IACvB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAC,SAAyB;QAClC,IAAA,YAAE,EAAC,SAAS,EAAE,YAAE,CAAC,MAAM,CAAC,CAAC;QAEzB,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,KAAK,CAAC,KAAkB,EAAE,UAA4B,EAAE;QAC1D,IAAA,YAAE,EAAC,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC9B,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,aAAa,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACjC,QAAQ,EAAE,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC;YAC7C,QAAQ,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ;YACzC,iBAAiB,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ;YAClD,cAAc,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;SACtC,CAAC,CACL,CAAC;QAEF,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;QAEvG,MAAM,MAAM,GAAG;YACX,aAAa;YACb,OAAO;YACP,MAAM;YACN,KAAK;YACL,QAAQ,EAAE,IAAA,iCAAyB,EAAC,OAAO,CAAC,QAAQ,CAAC;YACrD,QAAQ;YACR,iBAAiB;YACjB,cAAc;SACjB,CAAC;QAEF,MAAM,OAAO,GAAuB;YAChC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;YACtB,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,KAAK;YACX,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;YAC5B,uEAAuE;YACvE,4DAA4D;YAC5D,kBAAkB,EAAE,IAAI;YACxB,OAAO,EAAE;gBACL,cAAc,EAAE,kBAAkB;aACrC;SACJ,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,IAAI,CAAC,KAAkB,EAAE,UAA2B,EAAE;QACxD,IAAA,YAAE,EAAC,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC9B,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,CAAC,GAAG,CAAC,QAAQ;YACxC,QAAQ,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ;YACzC,QAAQ,EAAE,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC;YAC7C,QAAQ,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ;YACzC,iBAAiB,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ;YAClD,cAAc,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;SACtC,CAAC,CACL,CAAC;QAEF,MAAM,EAAE,QAAQ,EAAE,GAAG,YAAY,EAAE,GAAG,OAAO,CAAC;QAE9C,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;QAErD,+DAA+D;QAC/D,6DAA6D;QAC7D,kDAAkD;QAClD,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ;QACV,MAAM,WAAW,GAAuB;YACpC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE;SACzB,CAAC;QACF,IAAI,CAAC;YACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACzD,OAAO,IAAA,YAAI,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAA,4BAAoB,EAAC,GAAoB,CAAC,CAAC;QAC/C,CAAC;QAED,OAAO,SAAS,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAC,SAAoC;QAClD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE;YACtB,IAAI,EAAE,SAAS;SAClB,CAAC,CAAC;QAEH,OAAO,IAAA,YAAI,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,UAA8B,EAAE;QACpC,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,yBAAgB,CAAC,CAAC;YACjE,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,qBAAY,CAAC,CAAC;SAChE,CAAC,CACL,CAAC;QAEF,OAAO,IAAI,eAAS,CAChB,IAAI,CAAC,mBAAmB,CAAC;YACrB,EAAE,EAAE,MAAM;YACV,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;YAC7B,YAAY,EAAE,MAAM;SACvB,CAAC,CACL,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACH,IAAI;QACA,OAAO,IAAI,oCAAmB,CAC1B,IAAI,CAAC,mBAAmB,CAAC;YACrB,YAAY,EAAE,MAAM;SACvB,CAAC,CACL,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACH,QAAQ;QACJ,OAAO,IAAI,4CAAuB,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;IACnE,CAAC;CACJ;AA9OD,gCA8OC"}

package/dist/resource_clients/task_collection.d.ts

@@ -2,24 +2,43 @@ import type { ApiClientSubResourceOptions } from '../base/api_client';
 import { ResourceCollectionClient } from '../base/resource_collection_client';
 import type { PaginatedIterator, PaginationOptions } from '../utils';
 import type { Task, TaskUpdateData } from './task';
+/**
+ * Client for managing the collection of Actor tasks in your account.
+ *
+ * Tasks are pre-configured Actor runs with saved input and options. This client provides
+ * methods to list and create tasks.
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ * const tasksClient = client.tasks();
+ *
+ * // List all tasks
+ * const { items } = await tasksClient.list();
+ *
+ * // Create a new task
+ * const newTask = await tasksClient.create({
+ *   actId: 'my-actor-id',
+ *   name: 'my-task',
+ *   input: { url: 'https://example.com' }
+ * });
+ * ```
+ *
+ * @see https://docs.apify.com/platform/actors/running/tasks
+ */
 export declare class TaskCollectionClient extends ResourceCollectionClient {
     /**
      * @hidden
      */
     constructor(options: ApiClientSubResourceOptions);
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks
-     * @param {object} [options]
-     * @param {number} [options.limit]
-     * @param {number} [options.offset]
-     * @param {boolean} [options.desc]
-     * @return {PaginatedIterator<TaskList>}
+     * Lists all Tasks.
      *
      * 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.
@@ -27,10 +46,18 @@ export declare class TaskCollectionClient extends ResourceCollectionClient {
      * ```javascript
      * for await (const singleItem of client.list(options)) {...}
      * ```
+     *
+     * @param options - Pagination and sorting options.
+     * @returns A paginated iterator of tasks.
+     * @see https://docs.apify.com/api/v2/actor-tasks-get
      */
     list(options?: TaskCollectionListOptions): PaginatedIterator<TaskList>;
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task
+     * Creates a new task.
+     *
+     * @param task - The task data.
+     * @returns The created task object.
+     * @see https://docs.apify.com/api/v2/actor-tasks-post
      */
     create(task: TaskCreateData): Promise<Task>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"task_collection.d.ts","sourceRoot":"","sources":["../../src/resource_clients/task_collection.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EAAE,wBAAwB,EAAE,MAAM,oCAAoC,CAAC;AAC9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AACrE,OAAO,KAAK,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAEnD,qBAAa,oBAAqB,SAAQ,wBAAwB;IAC9D;;OAEG;gBACS,OAAO,EAAE,2BAA2B;IAOhD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,IAAI,CAAC,OAAO,GAAE,yBAA8B,GAAG,iBAAiB,CAAC,QAAQ,CAAC;IAa1E;;OAEG;IACG,MAAM,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAKpD;AAED,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB;IAChE,IAAI,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,CAAC;AAEvD,MAAM,WAAW,cAAe,SAAQ,cAAc;IAClD,KAAK,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"task_collection.d.ts","sourceRoot":"","sources":["../../src/resource_clients/task_collection.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EAAE,wBAAwB,EAAE,MAAM,oCAAoC,CAAC;AAC9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AACrE,OAAO,KAAK,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,oBAAqB,SAAQ,wBAAwB;IAC9D;;OAEG;gBACS,OAAO,EAAE,2BAA2B;IAOhD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CAAC,OAAO,GAAE,yBAA8B,GAAG,iBAAiB,CAAC,QAAQ,CAAC;IAa1E;;;;;;OAMG;IACG,MAAM,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAKpD;AAED,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB;IAChE,IAAI,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,CAAC;AAEvD,MAAM,WAAW,cAAe,SAAQ,cAAc;IAClD,KAAK,EAAE,MAAM,CAAC;CACjB"}

package/dist/resource_clients/task_collection.js

@@ -4,6 +4,30 @@ exports.TaskCollectionClient = 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 tasks in your account.
+ *
+ * Tasks are pre-configured Actor runs with saved input and options. This client provides
+ * methods to list and create tasks.
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ * const tasksClient = client.tasks();
+ *
+ * // List all tasks
+ * const { items } = await tasksClient.list();
+ *
+ * // Create a new task
+ * const newTask = await tasksClient.create({
+ *   actId: 'my-actor-id',
+ *   name: 'my-task',
+ *   input: { url: 'https://example.com' }
+ * });
+ * ```
+ *
+ * @see https://docs.apify.com/platform/actors/running/tasks
+ */
 class TaskCollectionClient extends resource_collection_client_1.ResourceCollectionClient {
     /**
      * @hidden
@@ -15,18 +39,13 @@ class TaskCollectionClient extends resource_collection_client_1.ResourceCollecti
         });
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks
-     * @param {object} [options]
-     * @param {number} [options.limit]
-     * @param {number} [options.offset]
-     * @param {boolean} [options.desc]
-     * @return {PaginatedIterator<TaskList>}
+     * Lists all Tasks.
      *
      * 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.
@@ -34,6 +53,10 @@ class TaskCollectionClient extends resource_collection_client_1.ResourceCollecti
      * ```javascript
      * for await (const singleItem of client.list(options)) {...}
      * ```
+     *
+     * @param options - Pagination and sorting options.
+     * @returns A paginated iterator of tasks.
+     * @see https://docs.apify.com/api/v2/actor-tasks-get
      */
     list(options = {}) {
         (0, ow_1.default)(options, ow_1.default.object.exactShape({
@@ -44,7 +67,11 @@ class TaskCollectionClient extends resource_collection_client_1.ResourceCollecti
         return this._listPaginated(options);
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task
+     * Creates a new task.
+     *
+     * @param task - The task data.
+     * @returns The created task object.
+     * @see https://docs.apify.com/api/v2/actor-tasks-post
      */
     async create(task) {
         (0, ow_1.default)(task, ow_1.default.object);

package/dist/resource_clients/task_collection.js.map

@@ -1 +1 @@
-{"version":3,"file":"task_collection.js","sourceRoot":"","sources":["../../src/resource_clients/task_collection.ts"],"names":[],"mappings":";;;;AAAA,oDAAoB;AAGpB,mFAA8E;AAI9E,MAAa,oBAAqB,SAAQ,qDAAwB;IAC9D;;OAEG;IACH,YAAY,OAAoC;QAC5C,KAAK,CAAC;YACF,YAAY,EAAE,aAAa;YAC3B,GAAG,OAAO;SACb,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,IAAI,CAAC,UAAqC,EAAE;QACxC,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;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,IAAoB;QAC7B,IAAA,YAAE,EAAC,IAAI,EAAE,YAAE,CAAC,MAAM,CAAC,CAAC;QAEpB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;CACJ;AArDD,oDAqDC"}
+{"version":3,"file":"task_collection.js","sourceRoot":"","sources":["../../src/resource_clients/task_collection.ts"],"names":[],"mappings":";;;;AAAA,oDAAoB;AAGpB,mFAA8E;AAI9E;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAa,oBAAqB,SAAQ,qDAAwB;IAC9D;;OAEG;IACH,YAAY,OAAoC;QAC5C,KAAK,CAAC;YACF,YAAY,EAAE,aAAa;YAC3B,GAAG,OAAO;SACb,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CAAC,UAAqC,EAAE;QACxC,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;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAC,IAAoB;QAC7B,IAAA,YAAE,EAAC,IAAI,EAAE,YAAE,CAAC,MAAM,CAAC,CAAC;QAEpB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;CACJ;AAxDD,oDAwDC"}

package/dist/resource_clients/user.d.ts

@@ -1,26 +1,63 @@
 import type { ApiClientSubResourceOptions } from '../base/api_client';
 import { ResourceClient } from '../base/resource_client';
+/**
+ * Client for managing user account information.
+ *
+ * Provides methods to retrieve user details, monthly usage statistics, and account limits.
+ * When using an API token, you can access your own user information or public information
+ * about other users.
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ * const userClient = client.user('my-user-id');
+ *
+ * // Get user information
+ * const user = await userClient.get();
+ *
+ * // Get monthly usage
+ * const usage = await userClient.monthlyUsage();
+ *
+ * // Get account limits
+ * const limits = await userClient.limits();
+ * ```
+ *
+ * @see https://docs.apify.com/platform/actors/running
+ */
 export declare class UserClient extends ResourceClient {
     /**
      * @hidden
      */
     constructor(options: ApiClientSubResourceOptions);
     /**
+     * Retrieves the user data.
+     *
      * Depending on whether ApifyClient was created with a token,
      * the method will either return public or private user data.
-     * https://docs.apify.com/api/v2#/reference/users
+     *
+     * @returns The user object.
+     * @see https://docs.apify.com/api/v2/user-get
      */
     get(): Promise<User>;
     /**
-     * https://docs.apify.com/api/v2/#/reference/users/monthly-usage
+     * Retrieves the user's monthly usage data.
+     *
+     * @returns The monthly usage object, or `undefined` if it does not exist.
+     * @see https://docs.apify.com/api/v2/user-usage-monthly-get
      */
     monthlyUsage(): Promise<MonthlyUsage | undefined>;
     /**
-     * https://docs.apify.com/api/v2/#/reference/users/account-and-usage-limits
+     * Retrieves the user's account and usage limits.
+     *
+     * @returns The account and usage limits object, or `undefined` if it does not exist.
+     * @see https://docs.apify.com/api/v2/user-limits-get
      */
     limits(): Promise<AccountAndUsageLimits | undefined>;
     /**
-     * https://docs.apify.com/api/v2/#/reference/users/account-and-usage-limits
+     * Updates the user's account and usage limits.
+     *
+     * @param options - The new limits to set.
+     * @see https://docs.apify.com/api/v2/user-limits-put
      */
     updateLimits(options: LimitsUpdateOptions): Promise<void>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../src/resource_clients/user.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAIzD,qBAAa,UAAW,SAAQ,cAAc;IAC1C;;OAEG;gBACS,OAAO,EAAE,2BAA2B;IAOhD;;;;OAIG;IACG,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;IAI1B;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IAsBvD;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,qBAAqB,GAAG,SAAS,CAAC;IAgB1D;;OAEG;IACG,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;CASlE;AAOD,MAAM,WAAW,IAAI;IAEjB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE;QACL,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,eAAe,CAAC,EAAE,MAAM,CAAC;KAC5B,CAAC;IAEF,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,yBAAyB,CAAC,EAAE,yBAAyB,CAAC;IACtD,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,SAAS;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,UAAU,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,UAAU;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,QAAQ;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,OAAO,CAAC;IACnB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,sBAAsB,EAAE,MAAM,CAAC;IAC/B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,uBAAuB,EAAE,eAAe,EAAE,CAAC;IAC3C,kBAAkB,EAAE,MAAM,CAAC;IAC3B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,2BAA2B,EAAE,MAAM,CAAC;IACpC,gCAAgC,EAAE,MAAM,CAAC;IACzC,oBAAoB,EAAE,MAAM,CAAC;IAC7B,oCAAoC,EAAE,MAAM,CAAC;IAC7C,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7C,oBAAoB,EAAE,MAAM,CAAC;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,OAAO,EAAE,CAAC;CAC9B;AAED,oBAAY,eAAe;IACvB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,UAAU,gBAAgB;IAC1B,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,mBAAmB,0BAA0B;CAChD;AAED,UAAU,wBAAwB;IAC9B,SAAS,EAAE,OAAO,CAAC;IACnB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,OAAO,EAAE,OAAO,CAAC;IACjB,iBAAiB,EAAE,IAAI,GAAG,IAAI,CAAC;CAClC;AAED,UAAU,yBAAyB;IAC/B,MAAM,EAAE,wBAAwB,CAAC;IACjC,OAAO,EAAE,wBAAwB,CAAC;IAClC,SAAS,EAAE,wBAAwB,CAAC;IACpC,KAAK,EAAE,wBAAwB,CAAC;IAChC,qBAAqB,EAAE,wBAAwB,CAAC;IAChD,iBAAiB,EAAE,wBAAwB,CAAC;IAC5C,WAAW,EAAE,wBAAwB,CAAC;IACtC,QAAQ,EAAE,wBAAwB,CAAC;IACnC,iBAAiB,EAAE,wBAAwB,CAAC;IAC5C,uBAAuB,EAAE,wBAAwB,CAAC;CACrD;AAMD,MAAM,WAAW,YAAY;IACzB,UAAU,EAAE,UAAU,CAAC;IACvB,mBAAmB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,uBAAuB,CAAA;KAAE,CAAC;IAChE,kBAAkB,EAAE,iBAAiB,EAAE,CAAC;IACxC,wCAAwC,EAAE,MAAM,CAAC;IACjD,uCAAuC,EAAE,MAAM,CAAC;CACnD;AAED,MAAM,WAAW,UAAU;IACvB,OAAO,EAAE,IAAI,CAAC;IACd,KAAK,EAAE,IAAI,CAAC;CACf;AAED,wCAAwC;AACxC,UAAU,uBAAuB;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;IACzB,4BAA4B,EAAE,MAAM,CAAC;IACrC,UAAU,EAAE,SAAS,EAAE,CAAC;CAC3B;AAED,UAAU,SAAS;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,UAAU,iBAAiB;IACvB,IAAI,EAAE,IAAI,CAAC;IACX,YAAY,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,qBAAqB,CAAA;KAAE,CAAC;IACvD,oBAAoB,EAAE,MAAM,CAAC;CAChC;AAED,sCAAsC;AACtC,UAAU,qBAAqB;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;CACzB;AAMD,MAAM,WAAW,qBAAqB;IAClC,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAC9B,OAAO,EAAE,IAAI,CAAC;IACd,KAAK,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,MAAM;IACnB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,2BAA2B,EAAE,MAAM,CAAC;IACpC,oCAAoC,EAAE,MAAM,CAAC;IAC7C,oBAAoB,EAAE,MAAM,CAAC;IAC7B,gCAAgC,EAAE,MAAM,CAAC;IACzC,oBAAoB,EAAE,MAAM,CAAC;IAC7B,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,sBAAsB,EAAE,MAAM,CAAC;IAC/B,uBAAuB,EAAE,MAAM,CAAC;IAChC,iBAAiB,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,MAAM,EAAE,oBAAoB,GAAG,mBAAmB,CAAC,CAAC;AAE3F,MAAM,WAAW,OAAO;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,wBAAwB,EAAE,MAAM,CAAC;IACjC,iCAAiC,EAAE,MAAM,CAAC;IAC1C,iBAAiB,EAAE,MAAM,CAAC;IAC1B,6BAA6B,EAAE,MAAM,CAAC;IACtC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,oBAAoB,EAAE,MAAM,CAAC;CAChC"}
+{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../src/resource_clients/user.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAIzD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,UAAW,SAAQ,cAAc;IAC1C;;OAEG;gBACS,OAAO,EAAE,2BAA2B;IAOhD;;;;;;;;OAQG;IACG,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;IAI1B;;;;;OAKG;IACG,YAAY,IAAI,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IAsBvD;;;;;OAKG;IACG,MAAM,IAAI,OAAO,CAAC,qBAAqB,GAAG,SAAS,CAAC;IAgB1D;;;;;OAKG;IACG,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;CASlE;AAOD,MAAM,WAAW,IAAI;IAEjB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE;QACL,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,eAAe,CAAC,EAAE,MAAM,CAAC;KAC5B,CAAC;IAEF,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,yBAAyB,CAAC,EAAE,yBAAyB,CAAC;IACtD,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,SAAS;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,UAAU,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,UAAU;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,QAAQ;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,OAAO,CAAC;IACnB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,sBAAsB,EAAE,MAAM,CAAC;IAC/B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,uBAAuB,EAAE,eAAe,EAAE,CAAC;IAC3C,kBAAkB,EAAE,MAAM,CAAC;IAC3B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,2BAA2B,EAAE,MAAM,CAAC;IACpC,gCAAgC,EAAE,MAAM,CAAC;IACzC,oBAAoB,EAAE,MAAM,CAAC;IAC7B,oCAAoC,EAAE,MAAM,CAAC;IAC7C,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7C,oBAAoB,EAAE,MAAM,CAAC;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,OAAO,EAAE,CAAC;CAC9B;AAED,oBAAY,eAAe;IACvB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,UAAU,gBAAgB;IAC1B,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,mBAAmB,0BAA0B;CAChD;AAED,UAAU,wBAAwB;IAC9B,SAAS,EAAE,OAAO,CAAC;IACnB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,OAAO,EAAE,OAAO,CAAC;IACjB,iBAAiB,EAAE,IAAI,GAAG,IAAI,CAAC;CAClC;AAED,UAAU,yBAAyB;IAC/B,MAAM,EAAE,wBAAwB,CAAC;IACjC,OAAO,EAAE,wBAAwB,CAAC;IAClC,SAAS,EAAE,wBAAwB,CAAC;IACpC,KAAK,EAAE,wBAAwB,CAAC;IAChC,qBAAqB,EAAE,wBAAwB,CAAC;IAChD,iBAAiB,EAAE,wBAAwB,CAAC;IAC5C,WAAW,EAAE,wBAAwB,CAAC;IACtC,QAAQ,EAAE,wBAAwB,CAAC;IACnC,iBAAiB,EAAE,wBAAwB,CAAC;IAC5C,uBAAuB,EAAE,wBAAwB,CAAC;CACrD;AAMD,MAAM,WAAW,YAAY;IACzB,UAAU,EAAE,UAAU,CAAC;IACvB,mBAAmB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,uBAAuB,CAAA;KAAE,CAAC;IAChE,kBAAkB,EAAE,iBAAiB,EAAE,CAAC;IACxC,wCAAwC,EAAE,MAAM,CAAC;IACjD,uCAAuC,EAAE,MAAM,CAAC;CACnD;AAED,MAAM,WAAW,UAAU;IACvB,OAAO,EAAE,IAAI,CAAC;IACd,KAAK,EAAE,IAAI,CAAC;CACf;AAED,wCAAwC;AACxC,UAAU,uBAAuB;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;IACzB,4BAA4B,EAAE,MAAM,CAAC;IACrC,UAAU,EAAE,SAAS,EAAE,CAAC;CAC3B;AAED,UAAU,SAAS;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,UAAU,iBAAiB;IACvB,IAAI,EAAE,IAAI,CAAC;IACX,YAAY,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,qBAAqB,CAAA;KAAE,CAAC;IACvD,oBAAoB,EAAE,MAAM,CAAC;CAChC;AAED,sCAAsC;AACtC,UAAU,qBAAqB;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;CACzB;AAMD,MAAM,WAAW,qBAAqB;IAClC,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAC9B,OAAO,EAAE,IAAI,CAAC;IACd,KAAK,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,MAAM;IACnB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,2BAA2B,EAAE,MAAM,CAAC;IACpC,oCAAoC,EAAE,MAAM,CAAC;IAC7C,oBAAoB,EAAE,MAAM,CAAC;IAC7B,gCAAgC,EAAE,MAAM,CAAC;IACzC,oBAAoB,EAAE,MAAM,CAAC;IAC7B,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,sBAAsB,EAAE,MAAM,CAAC;IAC/B,uBAAuB,EAAE,MAAM,CAAC;IAChC,iBAAiB,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,MAAM,EAAE,oBAAoB,GAAG,mBAAmB,CAAC,CAAC;AAE3F,MAAM,WAAW,OAAO;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,wBAAwB,EAAE,MAAM,CAAC;IACjC,iCAAiC,EAAE,MAAM,CAAC;IAC1C,iBAAiB,EAAE,MAAM,CAAC;IAC1B,6BAA6B,EAAE,MAAM,CAAC;IACtC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,oBAAoB,EAAE,MAAM,CAAC;CAChC"}

package/dist/resource_clients/user.js

@@ -3,6 +3,30 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PlatformFeature = exports.UserClient = void 0;
 const resource_client_1 = require("../base/resource_client");
 const utils_1 = require("../utils");
+/**
+ * Client for managing user account information.
+ *
+ * Provides methods to retrieve user details, monthly usage statistics, and account limits.
+ * When using an API token, you can access your own user information or public information
+ * about other users.
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ * const userClient = client.user('my-user-id');
+ *
+ * // Get user information
+ * const user = await userClient.get();
+ *
+ * // Get monthly usage
+ * const usage = await userClient.monthlyUsage();
+ *
+ * // Get account limits
+ * const limits = await userClient.limits();
+ * ```
+ *
+ * @see https://docs.apify.com/platform/actors/running
+ */
 class UserClient extends resource_client_1.ResourceClient {
     /**
      * @hidden
@@ -14,15 +38,22 @@ class UserClient extends resource_client_1.ResourceClient {
         });
     }
     /**
+     * Retrieves the user data.
+     *
      * Depending on whether ApifyClient was created with a token,
      * the method will either return public or private user data.
-     * https://docs.apify.com/api/v2#/reference/users
+     *
+     * @returns The user object.
+     * @see https://docs.apify.com/api/v2/user-get
      */
     async get() {
         return this._get();
     }
     /**
-     * https://docs.apify.com/api/v2/#/reference/users/monthly-usage
+     * Retrieves the user's monthly usage data.
+     *
+     * @returns The monthly usage object, or `undefined` if it does not exist.
+     * @see https://docs.apify.com/api/v2/user-usage-monthly-get
      */
     async monthlyUsage() {
         const requestOpts = {
@@ -42,7 +73,10 @@ class UserClient extends resource_client_1.ResourceClient {
         return undefined;
     }
     /**
-     * https://docs.apify.com/api/v2/#/reference/users/account-and-usage-limits
+     * Retrieves the user's account and usage limits.
+     *
+     * @returns The account and usage limits object, or `undefined` if it does not exist.
+     * @see https://docs.apify.com/api/v2/user-limits-get
      */
     async limits() {
         const requestOpts = {
@@ -60,7 +94,10 @@ class UserClient extends resource_client_1.ResourceClient {
         return undefined;
     }
     /**
-     * https://docs.apify.com/api/v2/#/reference/users/account-and-usage-limits
+     * Updates the user's account and usage limits.
+     *
+     * @param options - The new limits to set.
+     * @see https://docs.apify.com/api/v2/user-limits-put
      */
     async updateLimits(options) {
         const requestOpts = {

package/dist/resource_clients/user.js.map

@@ -1 +1 @@
-{"version":3,"file":"user.js","sourceRoot":"","sources":["../../src/resource_clients/user.ts"],"names":[],"mappings":";;;AAEA,6DAAyD;AAEzD,oCAAkF;AAElF,MAAa,UAAW,SAAQ,gCAAc;IAC1C;;OAEG;IACH,YAAY,OAAoC;QAC5C,KAAK,CAAC;YACF,YAAY,EAAE,OAAO;YACrB,GAAG,OAAO;SACb,CAAC,CAAC;IACP,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAG;QACL,OAAO,IAAI,CAAC,IAAI,EAAmB,CAAC;IACxC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY;QACd,MAAM,WAAW,GAAuB;YACpC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC;YAC/B,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE;SACzB,CAAC;QACF,IAAI,CAAC;YACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACzD,OAAO,IAAA,YAAI,EACP,IAAA,uBAAe,EACX,IAAA,iBAAS,EAAC,QAAQ,CAAC,IAAI,CAAC;YACxB,uGAAuG;YACvG,wBAAwB,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,MAAM,CACnD,CACJ,CAAC;QACN,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAA,4BAAoB,EAAC,GAAoB,CAAC,CAAC;QAC/C,CAAC;QAED,OAAO,SAAS,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM;QACR,MAAM,WAAW,GAAuB;YACpC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;YACxB,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE;SACzB,CAAC;QACF,IAAI,CAAC;YACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACzD,OAAO,IAAA,YAAI,EAAC,IAAA,uBAAe,EAAC,IAAA,iBAAS,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3D,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAA,4BAAoB,EAAC,GAAoB,CAAC,CAAC;QAC/C,CAAC;QAED,OAAO,SAAS,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY,CAAC,OAA4B;QAC3C,MAAM,WAAW,GAAuB;YACpC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;YACxB,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE;YACtB,IAAI,EAAE,OAAO;SAChB,CAAC;QACF,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC5C,CAAC;CACJ;AA5ED,gCA4EC;AA8DD,IAAY,eAQX;AARD,WAAY,eAAe;IACvB,oCAAiB,CAAA;IACjB,sCAAmB,CAAA;IACnB,6CAA0B,CAAA;IAC1B,0CAAuB,CAAA;IACvB,wCAAqB,CAAA;IACrB,kCAAe,CAAA;IACf,gEAA6C,CAAA;AACjD,CAAC,EARW,eAAe,+BAAf,eAAe,QAQ1B"}
+{"version":3,"file":"user.js","sourceRoot":"","sources":["../../src/resource_clients/user.ts"],"names":[],"mappings":";;;AAEA,6DAAyD;AAEzD,oCAAkF;AAElF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAa,UAAW,SAAQ,gCAAc;IAC1C;;OAEG;IACH,YAAY,OAAoC;QAC5C,KAAK,CAAC;YACF,YAAY,EAAE,OAAO;YACrB,GAAG,OAAO;SACb,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,GAAG;QACL,OAAO,IAAI,CAAC,IAAI,EAAmB,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY;QACd,MAAM,WAAW,GAAuB;YACpC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC;YAC/B,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE;SACzB,CAAC;QACF,IAAI,CAAC;YACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACzD,OAAO,IAAA,YAAI,EACP,IAAA,uBAAe,EACX,IAAA,iBAAS,EAAC,QAAQ,CAAC,IAAI,CAAC;YACxB,uGAAuG;YACvG,wBAAwB,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,MAAM,CACnD,CACJ,CAAC;QACN,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAA,4BAAoB,EAAC,GAAoB,CAAC,CAAC;QAC/C,CAAC;QAED,OAAO,SAAS,CAAC;IACrB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM;QACR,MAAM,WAAW,GAAuB;YACpC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;YACxB,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE;SACzB,CAAC;QACF,IAAI,CAAC;YACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACzD,OAAO,IAAA,YAAI,EAAC,IAAA,uBAAe,EAAC,IAAA,iBAAS,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3D,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAA,4BAAoB,EAAC,GAAoB,CAAC,CAAC;QAC/C,CAAC;QAED,OAAO,SAAS,CAAC;IACrB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CAAC,OAA4B;QAC3C,MAAM,WAAW,GAAuB;YACpC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;YACxB,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE;YACtB,IAAI,EAAE,OAAO;SAChB,CAAC;QACF,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC5C,CAAC;CACJ;AAzFD,gCAyFC;AA8DD,IAAY,eAQX;AARD,WAAY,eAAe;IACvB,oCAAiB,CAAA;IACjB,sCAAmB,CAAA;IACnB,6CAA0B,CAAA;IAC1B,0CAAuB,CAAA;IACvB,wCAAqB,CAAA;IACrB,kCAAe,CAAA;IACf,gEAA6C,CAAA;AACjD,CAAC,EARW,eAAe,+BAAf,eAAe,QAQ1B"}

package/dist/resource_clients/webhook.d.ts

@@ -3,32 +3,81 @@ import type { ApiClientSubResourceOptions } from '../base/api_client';
 import { ResourceClient } from '../base/resource_client';
 import type { WebhookDispatch } from './webhook_dispatch';
 import { WebhookDispatchCollectionClient } from './webhook_dispatch_collection';
+/**
+ * Client for managing a specific webhook.
+ *
+ * Webhooks allow you to receive notifications when specific events occur in your Actors or tasks.
+ * This client provides methods to get, update, delete, and test webhooks, as well as retrieve
+ * webhook dispatches.
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ * const webhookClient = client.webhook('my-webhook-id');
+ *
+ * // Get webhook details
+ * const webhook = await webhookClient.get();
+ *
+ * // Update webhook
+ * await webhookClient.update({
+ *   isEnabled: true,
+ *   eventTypes: ['ACTOR.RUN.SUCCEEDED'],
+ *   requestUrl: 'https://example.com/webhook'
+ * });
+ *
+ * // Test webhook
+ * await webhookClient.test();
+ * ```
+ *
+ * @see https://docs.apify.com/platform/integrations/webhooks
+ */
 export declare class WebhookClient extends ResourceClient {
     /**
      * @hidden
      */
     constructor(options: ApiClientSubResourceOptions);
     /**
-     * https://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook
+     * Retrieves the webhook.
+     *
+     * @returns The webhook object, or `undefined` if it does not exist.
+     * @see https://docs.apify.com/api/v2/webhook-get
      */
     get(): Promise<Webhook | undefined>;
     /**
-     * https://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook
+     * Updates the webhook with the specified fields.
+     *
+     * @param newFields - Fields to update.
+     * @returns The updated webhook object.
+     * @see https://docs.apify.com/api/v2/webhook-put
      */
     update(newFields: WebhookUpdateData): Promise<Webhook>;
     /**
-     * https://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook
+     * Deletes the webhook.
+     *
+     * @see https://docs.apify.com/api/v2/webhook-delete
      */
     delete(): Promise<void>;
     /**
-     * https://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook
+     * Tests the webhook by dispatching a test event.
+     *
+     * @returns The webhook dispatch object, or `undefined` if the test fails.
+     * @see https://docs.apify.com/api/v2/webhook-test-post
      */
     test(): Promise<WebhookDispatch | undefined>;
     /**
-     * https://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection
+     * Returns a client for the dispatches of this webhook.
+     *
+     * @returns A client for the webhook's dispatches.
+     * @see https://docs.apify.com/api/v2/webhook-webhook-dispatches-get
      */
     dispatches(): WebhookDispatchCollectionClient;
 }
+/**
+ * Represents a webhook for receiving notifications about Actor events.
+ *
+ * Webhooks send HTTP POST requests to specified URLs when certain events occur
+ * (e.g., Actor run succeeds, fails, or times out).
+ */
 export interface Webhook {
     id: string;
     userId: string;
@@ -51,11 +100,23 @@ export interface Webhook {
 export interface WebhookIdempotencyKey {
     idempotencyKey?: string;
 }
+/**
+ * Data for updating a webhook.
+ */
 export type WebhookUpdateData = Partial<Pick<Webhook, 'isAdHoc' | 'eventTypes' | 'condition' | 'ignoreSslErrors' | 'doNotRetry' | 'requestUrl' | 'payloadTemplate' | 'shouldInterpolateStrings' | 'isApifyIntegration' | 'headersTemplate' | 'description'>> & WebhookIdempotencyKey;
+/**
+ * Statistics about webhook usage.
+ */
 export interface WebhookStats {
     totalDispatches: number;
 }
+/**
+ * Event types that can trigger webhooks.
+ */
 export type WebhookEventType = (typeof WEBHOOK_EVENT_TYPES)[keyof typeof WEBHOOK_EVENT_TYPES];
+/**
+ * Condition that determines when a webhook should be triggered.
+ */
 export type WebhookCondition = WebhookAnyRunOfActorCondition | WebhookAnyRunOfActorTaskCondition | WebhookCertainRunCondition;
 export interface WebhookAnyRunOfActorCondition {
     actorId: string;

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

@@ -1 +1 @@
-{"version":3,"file":"webhook.d.ts","sourceRoot":"","sources":["../../src/resource_clients/webhook.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAGzD,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAGzD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAE,+BAA+B,EAAE,MAAM,+BAA+B,CAAC;AAEhF,qBAAa,aAAc,SAAQ,cAAc;IAC7C;;OAEG;gBACS,OAAO,EAAE,2BAA2B;IAOhD;;OAEG;IACG,GAAG,IAAI,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC;IAIzC;;OAEG;IACG,MAAM,CAAC,SAAS,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC;IAM5D;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAI7B;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAiBlD;;OAEG;IACH,UAAU,IAAI,+BAA+B;CAOhD;AAED,MAAM,WAAW,OAAO;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,IAAI,CAAC;IAChB,UAAU,EAAE,IAAI,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,gBAAgB,EAAE,CAAC;IAC/B,SAAS,EAAE,gBAAgB,CAAC;IAC5B,eAAe,EAAE,OAAO,CAAC;IACzB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,YAAY,CAAC;IACpB,wBAAwB,EAAE,OAAO,CAAC;IAClC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,qBAAqB;IAClC,cAAc,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,MAAM,iBAAiB,GAAG,OAAO,CACnC,IAAI,CACA,OAAO,EACL,SAAS,GACT,YAAY,GACZ,WAAW,GACX,iBAAiB,GACjB,YAAY,GACZ,YAAY,GACZ,iBAAiB,GACjB,0BAA0B,GAC1B,oBAAoB,GACpB,iBAAiB,GACjB,aAAa,CAClB,CACJ,GACG,qBAAqB,CAAC;AAE1B,MAAM,WAAW,YAAY;IACzB,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,OAAO,mBAAmB,CAAC,CAAC;AAE9F,MAAM,MAAM,gBAAgB,GACtB,6BAA6B,GAC7B,iCAAiC,GACjC,0BAA0B,CAAC;AAEjC,MAAM,WAAW,6BAA6B;IAC1C,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,iCAAiC;IAC9C,WAAW,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,0BAA0B;IACvC,UAAU,EAAE,MAAM,CAAC;CACtB"}
+{"version":3,"file":"webhook.d.ts","sourceRoot":"","sources":["../../src/resource_clients/webhook.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAGzD,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAGzD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAE,+BAA+B,EAAE,MAAM,+BAA+B,CAAC;AAEhF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,aAAc,SAAQ,cAAc;IAC7C;;OAEG;gBACS,OAAO,EAAE,2BAA2B;IAOhD;;;;;OAKG;IACG,GAAG,IAAI,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC;IAIzC;;;;;;OAMG;IACG,MAAM,CAAC,SAAS,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC;IAM5D;;;;OAIG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAI7B;;;;;OAKG;IACG,IAAI,IAAI,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAiBlD;;;;;OAKG;IACH,UAAU,IAAI,+BAA+B;CAOhD;AAED;;;;;GAKG;AACH,MAAM,WAAW,OAAO;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,IAAI,CAAC;IAChB,UAAU,EAAE,IAAI,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,gBAAgB,EAAE,CAAC;IAC/B,SAAS,EAAE,gBAAgB,CAAC;IAC5B,eAAe,EAAE,OAAO,CAAC;IACzB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,YAAY,CAAC;IACpB,wBAAwB,EAAE,OAAO,CAAC;IAClC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,qBAAqB;IAClC,cAAc,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,CACnC,IAAI,CACA,OAAO,EACL,SAAS,GACT,YAAY,GACZ,WAAW,GACX,iBAAiB,GACjB,YAAY,GACZ,YAAY,GACZ,iBAAiB,GACjB,0BAA0B,GAC1B,oBAAoB,GACpB,iBAAiB,GACjB,aAAa,CAClB,CACJ,GACG,qBAAqB,CAAC;AAE1B;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,OAAO,mBAAmB,CAAC,CAAC;AAE9F;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACtB,6BAA6B,GAC7B,iCAAiC,GACjC,0BAA0B,CAAC;AAEjC,MAAM,WAAW,6BAA6B;IAC1C,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,iCAAiC;IAC9C,WAAW,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,0BAA0B;IACvC,UAAU,EAAE,MAAM,CAAC;CACtB"}