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

package/dist/resource_clients/actor.js

@@ -14,6 +14,26 @@ const build_collection_1 = require("./build_collection");
 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.
+ *
+ * Provides methods to start, call, build, update, and delete an Actor, as well as manage its
+ * versions, builds, runs, and webhooks.
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ * const actorClient = client.actor('my-actor-id');
+ *
+ * // Start an Actor
+ * const run = await actorClient.start(input, { memory: 256 });
+ *
+ * // Call an Actor and wait for it to finish
+ * const finishedRun = await actorClient.call({ url: 'https://example.com' });
+ * ```
+ *
+ * @see https://docs.apify.com/platform/actors
+ */
 class ActorClient extends resource_client_1.ResourceClient {
     /**
      * @hidden
@@ -25,27 +45,66 @@ class ActorClient extends resource_client_1.ResourceClient {
         });
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor
+     * Gets the Actor object from the Apify API.
+     *
+     * @returns The Actor object, or `undefined` if it does not exist
+     * @see https://docs.apify.com/api/v2/act-get
      */
     async get() {
         return this._get();
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor
+     * Updates the Actor with specified fields.
+     *
+     * @param newFields - Fields to update in the Actor
+     * @returns The updated Actor object
+     * @see https://docs.apify.com/api/v2/act-put
      */
     async update(newFields) {
         (0, ow_1.default)(newFields, ow_1.default.object);
         return this._update(newFields);
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor
+     * Deletes the Actor.
+     *
+     * @see https://docs.apify.com/api/v2/act-delete
      */
     async delete() {
         return this._delete();
     }
     /**
-     * Starts an actor and immediately returns the Run object.
-     * https://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor
+     * Starts the Actor and immediately returns the Run object.
+     *
+     * The Actor run can be configured with optional input and various options. The run starts
+     * asynchronously and this method returns immediately without waiting for completion.
+     * Use the {@link call} method if you want to wait for the Actor to finish.
+     *
+     * @param input - Input for the Actor. Can be any JSON-serializable value (object, array, string, number).
+     *                If `contentType` is specified in options, input should be a string or Buffer.
+     * @param options - Run configuration options
+     * @param options.build - Tag or number of the build to run (e.g., `'beta'` or `'1.2.345'`). If not provided, uses the default build.
+     * @param options.memory - Memory in megabytes allocated for the run. If not provided, uses the Actor's default memory setting.
+     * @param options.timeout - Timeout for the run in seconds. Zero means no timeout. If not provided, uses the Actor's default timeout.
+     * @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).
+     * @param options.webhooks - Webhooks to trigger when the Actor run reaches a specific state (e.g., `SUCCEEDED`, `FAILED`).
+     * @param options.maxItems - Maximum number of dataset items that will be charged (only for pay-per-result Actors).
+     * @param options.maxTotalChargeUsd - Maximum cost in USD (only for pay-per-event Actors).
+     * @param options.contentType - Content type of the input. If specified, input must be a string or Buffer.
+     * @returns The Actor run object with status, usage, and storage IDs
+     * @see https://docs.apify.com/api/v2/act-runs-post
+     *
+     * @example
+     * ```javascript
+     * // Start Actor with simple input
+     * const run = await client.actor('my-actor').start({ url: 'https://example.com' });
+     * console.log(`Run started with ID: ${run.id}, status: ${run.status}`);
+     *
+     * // Start Actor with specific build and memory
+     * const run = await client.actor('my-actor').start(
+     *   { url: 'https://example.com' },
+     *   { build: '0.1.2', memory: 512, timeout: 300 }
+     * );
+     * ```
      */
     async start(input, options = {}) {
         // input can be anything, so no point in validating it. E.g. if you set content-type to application/pdf
@@ -95,9 +154,41 @@ class ActorClient extends resource_client_1.ResourceClient {
         return (0, utils_1.cast)((0, utils_1.parseDateFields)((0, utils_1.pluckData)(response.data)));
     }
     /**
-     * Starts an actor 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/actors/run-collection/run-actor
+     * Starts the Actor and waits for it to finish before returning the Run object.
+     *
+     * This is a convenience method that starts the Actor run and waits for its completion
+     * by polling the run status. It optionally streams logs to the console or a custom Log instance.
+     * By default, it waits indefinitely unless the `waitSecs` option is provided.
+     *
+     * @param input - Input for the Actor. Can be any JSON-serializable value (object, array, string, number).
+     *                If `contentType` is specified in options, input should be a string or Buffer.
+     * @param options - Run configuration options (extends all options from {@link start})
+     * @param options.waitSecs - Maximum time to wait for the run to finish, in seconds. If omitted, waits indefinitely.
+     * @param options.log - Log instance for streaming run logs. Use `'default'` for console output, `null` to disable logging, or provide a custom Log instance.
+     * @param options.build - Tag or number of the build to run (e.g., `'beta'` or `'1.2.345'`).
+     * @param options.memory - Memory in megabytes allocated for the run.
+     * @param options.timeout - Maximum run duration in seconds.
+     * @returns The finished Actor run object with final status (`SUCCEEDED`, `FAILED`, `ABORTED`, or `TIMED-OUT`)
+     * @see https://docs.apify.com/api/v2/act-runs-post
+     *
+     * @example
+     * ```javascript
+     * // Run an Actor and wait for it to finish
+     * const run = await client.actor('my-actor').call({ url: 'https://example.com' });
+     * console.log(`Run finished with status: ${run.status}`);
+     * console.log(`Dataset ID: ${run.defaultDatasetId}`);
+     *
+     * // Run with a timeout and log streaming to console
+     * const run = await client.actor('my-actor').call(
+     *   { url: 'https://example.com' },
+     *   { waitSecs: 300, log: 'default' }
+     * );
+     *
+     * // Run with custom log instance
+     * import { Log } from '@apify/log';
+     * const log = new Log({ prefix: 'My Actor' });
+     * const run = await client.actor('my-actor').call({ url: 'https://example.com' }, { log });
+     * ```
      */
     async call(input, options = {}) {
         // input can be anything, so no point in validating it. E.g. if you set content-type to application/pdf
@@ -131,8 +222,33 @@ class ActorClient extends resource_client_1.ResourceClient {
         });
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor
-     * @return {Promise<Build>}
+     * Builds the Actor.
+     *
+     * Creates a new build of the specified Actor version. The build compiles the Actor's
+     * source code, installs dependencies, and prepares it for execution.
+     *
+     * @param versionNumber - Version number or tag to build (e.g., `'0.1'`, `'0.2'`, `'latest'`)
+     * @param options - Build configuration options
+     * @param options.betaPackages - If `true`, the build uses beta versions of Apify NPM packages.
+     * @param options.tag - Tag to be applied to the build (e.g., `'latest'`, `'beta'`). Existing tag with the same name will be replaced.
+     * @param options.useCache - If `false`, Docker build cache will be ignored. Default is `true`.
+     * @param options.waitForFinish - Maximum time to wait (in seconds, max 60s) for the build to finish on the API side before returning. Default is 0 (returns immediately).
+     * @returns The Build object with status and build details
+     * @see https://docs.apify.com/api/v2/act-builds-post
+     *
+     * @example
+     * ```javascript
+     * // Start a build and return immediately
+     * const build = await client.actor('my-actor').build('0.1');
+     * console.log(`Build ${build.id} started with status: ${build.status}`);
+     *
+     * // Build and wait up to 120 seconds for it to finish
+     * const build = await client.actor('my-actor').build('0.1', {
+     *   waitForFinish: 120,
+     *   tag: 'latest',
+     *   useCache: true
+     * });
+     * ```
      */
     async build(versionNumber, options = {}) {
         (0, ow_1.default)(versionNumber, ow_1.default.string);
@@ -153,7 +269,11 @@ class ActorClient 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/act-build-default-get
+     * Retrieves the default build of the Actor.
+     *
+     * @param options - Options for getting the build.
+     * @returns A client for the default build.
+     * @see https://docs.apify.com/api/v2/act-build-default-get
      */
     async defaultBuild(options = {}) {
         const response = await this.httpClient.call({
@@ -171,7 +291,21 @@ class ActorClient extends resource_client_1.ResourceClient {
         });
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages
+     * Returns a client for the last run of this Actor.
+     *
+     * Provides access to the most recent Actor run, optionally filtered by status or origin.
+     *
+     * @param options - Options to filter the last run
+     * @param options.status - Filter by run status (e.g., `'SUCCEEDED'`, `'FAILED'`, `'RUNNING'`, `'ABORTED'`, `'TIMED-OUT'`).
+     * @param options.origin - Filter by run origin (e.g., `'DEVELOPMENT'`, `'WEB'`, `'API'`, `'SCHEDULER'`).
+     * @returns A client for the last run
+     * @see https://docs.apify.com/api/v2/act-runs-last-get
+     *
+     * @example
+     * ```javascript
+     * // Get the last successful run
+     * const lastRun = await client.actor('my-actor').lastRun({ status: 'SUCCEEDED' }).get();
+     * ```
      */
     lastRun(options = {}) {
         (0, ow_1.default)(options, ow_1.default.object.exactShape({
@@ -185,7 +319,10 @@ class ActorClient extends resource_client_1.ResourceClient {
         }));
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/build-collection
+     * Returns a client for managing builds of this Actor.
+     *
+     * @returns A client for the Actor's build collection
+     * @see https://docs.apify.com/api/v2/act-builds-get
      */
     builds() {
         return new build_collection_1.BuildCollectionClient(this._subResourceOptions({
@@ -193,7 +330,10 @@ class ActorClient extends resource_client_1.ResourceClient {
         }));
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/run-collection
+     * Returns a client for managing runs of this Actor.
+     *
+     * @returns A client for the Actor's run collection
+     * @see https://docs.apify.com/api/v2/act-runs-get
      */
     runs() {
         return new run_collection_1.RunCollectionClient(this._subResourceOptions({
@@ -201,7 +341,11 @@ class ActorClient extends resource_client_1.ResourceClient {
         }));
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/version-object
+     * Returns a client for a specific version of this Actor.
+     *
+     * @param versionNumber - Version number (e.g., '0.1', '1.2.3')
+     * @returns A client for the specified Actor version
+     * @see https://docs.apify.com/api/v2/act-version-get
      */
     version(versionNumber) {
         (0, ow_1.default)(versionNumber, ow_1.default.string);
@@ -210,15 +354,19 @@ class ActorClient extends resource_client_1.ResourceClient {
         }));
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/version-collection
-     * @return {ActorVersionCollectionClient}
+     * Returns a client for managing versions of this Actor.
+     *
+     * @returns A client for the Actor's version collection
+     * @see https://docs.apify.com/api/v2/act-versions-get
      */
     versions() {
         return new actor_version_collection_1.ActorVersionCollectionClient(this._subResourceOptions());
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/webhook-collection
-     * @return {WebhookCollectionClient}
+     * Returns a client for managing webhooks associated with this Actor.
+     *
+     * @returns A client for the Actor's webhook collection
+     * @see https://docs.apify.com/api/v2/act-webhooks-get
      */
     webhooks() {
         return new webhook_collection_1.WebhookCollectionClient(this._subResourceOptions());

package/dist/resource_clients/actor.js.map

@@ -1 +1 @@
-{"version":3,"file":"actor.js","sourceRoot":"","sources":["../../src/resource_clients/actor.ts"],"names":[],"mappings":";;;;AACA,oDAAoB;AAGpB,0CAAuF;AACvF,oCAAiC;AAGjC,6DAAyD;AACzD,oCAAuF;AAEvF,mDAAqD;AACrD,yEAA0E;AAE1E,mCAAsC;AACtC,yDAA2D;AAC3D,+BAAkC;AAClC,qDAAuD;AAEvD,6DAA+D;AAE/D,MAAa,WAAY,SAAQ,gCAAc;IAC3C;;OAEG;IACH,YAAY,OAAoC;QAC5C,KAAK,CAAC;YACF,YAAY,EAAE,MAAM;YACpB,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,SAA6B;QACtC,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,KAAe,EAAE,UAA6B,EAAE;QACxD,uGAAuG;QACvG,0CAA0C;QAC1C,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACzB,WAAW,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC/B,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;YACnC,oBAAoB,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,+BAAsB,CAAC,CAAC;SACxF,CAAC,CACL,CAAC;QAEF,MAAM,EACF,aAAa,EACb,OAAO,EACP,MAAM,EACN,KAAK,EACL,QAAQ,EACR,iBAAiB,EACjB,cAAc,EACd,oBAAoB,GACvB,GAAG,OAAO,CAAC;QAEZ,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;YACd,oBAAoB;SACvB,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,sFAAsF;YACtF,6BAA6B;YAC7B,mCAAmC;YACnC,kBAAkB,EAAE,IAAI;SAC3B,CAAC;QACF,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;;;;OAIG;IACH,KAAK,CAAC,IAAI,CAAC,KAAe,EAAE,UAA4B,EAAE;QACtD,uGAAuG;QACvG,0CAA0C;QAC1C,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACzB,WAAW,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC/B,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,GAAG,EAAE,YAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAE,CAAC,IAAI,EAAE,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC,SAAG,CAAC,EAAE,YAAE,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YACrF,cAAc,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YACnC,oBAAoB,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,+BAAsB,CAAC,CAAC;SACxF,CAAC,CACL,CAAC;QAEF,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,YAAY,EAAE,GAAG,OAAO,CAAC;QACnD,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;QAErD,+DAA+D;QAC/D,6DAA6D;QAC7D,mDAAmD;QACnD,MAAM,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAE9C,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,cAAc,CAAC,EAAE,KAAK,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,GAAG,EAAE,CAAC,CAAC;QAC/E,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,KAAK,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC,WAAW;aAClB,GAAG,CAAC,EAAE,CAAC;aACP,aAAa,CAAC,EAAE,QAAQ,EAAE,CAAC;aAC3B,OAAO,CAAC,KAAK,IAAI,EAAE;YAChB,MAAM,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,IAAI,EAAE,CAAA,CAAC;QAC9B,CAAC,CAAC,CAAC;IACX,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,KAAK,CAAC,aAAqB,EAAE,UAA6B,EAAE;QAC9D,IAAA,YAAE,EAAC,aAAa,EAAE,YAAE,CAAC,MAAM,CAAC,CAAC;QAC7B,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,YAAY,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YACjC,GAAG,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACvB,QAAQ,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YAC7B,aAAa,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;SACpC,CAAC,CACL,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;YACxB,MAAM,EAAE,MAAM;YACd,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC;gBACjB,OAAO,EAAE,aAAa;gBACtB,GAAG,OAAO;aACb,CAAC;SACL,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,YAAY,CAAC,UAAiC,EAAE;QAClD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC;YAChC,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;SAChC,CAAC,CAAC;QAEH,MAAM,EAAE,EAAE,EAAE,GAAG,IAAA,iBAAS,EAAQ,QAAQ,CAAC,IAAI,CAAC,CAAC;QAE/C,OAAO,IAAI,mBAAW,CAAC;YACnB,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO;YACjC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,aAAa;YAC7C,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,EAAE;SACL,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,UAA+B,EAAE;QACrC,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,MAAM;QACF,OAAO,IAAI,wCAAqB,CAC5B,IAAI,CAAC,mBAAmB,CAAC;YACrB,YAAY,EAAE,QAAQ;SACzB,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,OAAO,CAAC,aAAqB;QACzB,IAAA,YAAE,EAAC,aAAa,EAAE,YAAE,CAAC,MAAM,CAAC,CAAC;QAC7B,OAAO,IAAI,kCAAkB,CACzB,IAAI,CAAC,mBAAmB,CAAC;YACrB,EAAE,EAAE,aAAa;SACpB,CAAC,CACL,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,QAAQ;QACJ,OAAO,IAAI,uDAA4B,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;OAGG;IACH,QAAQ;QACJ,OAAO,IAAI,4CAAuB,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;IACnE,CAAC;CACJ;AAxQD,kCAwQC"}
+{"version":3,"file":"actor.js","sourceRoot":"","sources":["../../src/resource_clients/actor.ts"],"names":[],"mappings":";;;;AACA,oDAAoB;AAGpB,0CAAuF;AACvF,oCAAiC;AAGjC,6DAAyD;AACzD,oCAAuF;AAEvF,mDAAqD;AACrD,yEAA0E;AAE1E,mCAAsC;AACtC,yDAA2D;AAC3D,+BAAkC;AAClC,qDAAuD;AAEvD,6DAA+D;AAE/D;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAa,WAAY,SAAQ,gCAAc;IAC3C;;OAEG;IACH,YAAY,OAAoC;QAC5C,KAAK,CAAC;YACF,YAAY,EAAE,MAAM;YACpB,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,SAA6B;QACtC,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,KAAK,CAAC,KAAK,CAAC,KAAe,EAAE,UAA6B,EAAE;QACxD,uGAAuG;QACvG,0CAA0C;QAC1C,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACzB,WAAW,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC/B,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;YACnC,oBAAoB,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,+BAAsB,CAAC,CAAC;SACxF,CAAC,CACL,CAAC;QAEF,MAAM,EACF,aAAa,EACb,OAAO,EACP,MAAM,EACN,KAAK,EACL,QAAQ,EACR,iBAAiB,EACjB,cAAc,EACd,oBAAoB,GACvB,GAAG,OAAO,CAAC;QAEZ,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;YACd,oBAAoB;SACvB,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,sFAAsF;YACtF,6BAA6B;YAC7B,mCAAmC;YACnC,kBAAkB,EAAE,IAAI;SAC3B,CAAC;QACF,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,KAAK,CAAC,IAAI,CAAC,KAAe,EAAE,UAA4B,EAAE;QACtD,uGAAuG;QACvG,0CAA0C;QAC1C,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACzB,WAAW,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC/B,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,GAAG,EAAE,YAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAE,CAAC,IAAI,EAAE,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC,SAAG,CAAC,EAAE,YAAE,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YACrF,cAAc,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YACnC,oBAAoB,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,+BAAsB,CAAC,CAAC;SACxF,CAAC,CACL,CAAC;QAEF,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,YAAY,EAAE,GAAG,OAAO,CAAC;QACnD,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;QAErD,+DAA+D;QAC/D,6DAA6D;QAC7D,mDAAmD;QACnD,MAAM,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAE9C,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,cAAc,CAAC,EAAE,KAAK,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,GAAG,EAAE,CAAC,CAAC;QAC/E,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,KAAK,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC,WAAW;aAClB,GAAG,CAAC,EAAE,CAAC;aACP,aAAa,CAAC,EAAE,QAAQ,EAAE,CAAC;aAC3B,OAAO,CAAC,KAAK,IAAI,EAAE;YAChB,MAAM,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,IAAI,EAAE,CAAA,CAAC;QAC9B,CAAC,CAAC,CAAC;IACX,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,CAAC,KAAK,CAAC,aAAqB,EAAE,UAA6B,EAAE;QAC9D,IAAA,YAAE,EAAC,aAAa,EAAE,YAAE,CAAC,MAAM,CAAC,CAAC;QAC7B,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,YAAY,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YACjC,GAAG,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACvB,QAAQ,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YAC7B,aAAa,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;SACpC,CAAC,CACL,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;YACxB,MAAM,EAAE,MAAM;YACd,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC;gBACjB,OAAO,EAAE,aAAa;gBACtB,GAAG,OAAO;aACb,CAAC;SACL,CAAC,CAAC;QAEH,OAAO,IAAA,YAAI,EAAC,IAAA,uBAAe,EAAC,IAAA,iBAAS,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,YAAY,CAAC,UAAiC,EAAE;QAClD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC;YAChC,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;SAChC,CAAC,CAAC;QAEH,MAAM,EAAE,EAAE,EAAE,GAAG,IAAA,iBAAS,EAAQ,QAAQ,CAAC,IAAI,CAAC,CAAC;QAE/C,OAAO,IAAI,mBAAW,CAAC;YACnB,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO;YACjC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,aAAa;YAC7C,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,EAAE;SACL,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,UAA+B,EAAE;QACrC,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,MAAM;QACF,OAAO,IAAI,wCAAqB,CAC5B,IAAI,CAAC,mBAAmB,CAAC;YACrB,YAAY,EAAE,QAAQ;SACzB,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;;;;;;OAMG;IACH,OAAO,CAAC,aAAqB;QACzB,IAAA,YAAE,EAAC,aAAa,EAAE,YAAE,CAAC,MAAM,CAAC,CAAC;QAC7B,OAAO,IAAI,kCAAkB,CACzB,IAAI,CAAC,mBAAmB,CAAC;YACrB,EAAE,EAAE,aAAa;SACpB,CAAC,CACL,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACH,QAAQ;QACJ,OAAO,IAAI,uDAA4B,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;OAKG;IACH,QAAQ;QACJ,OAAO,IAAI,4CAAuB,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;IACnE,CAAC;CACJ;AAxYD,kCAwYC"}

package/dist/resource_clients/actor_collection.d.ts

@@ -3,19 +3,42 @@ import { ResourceCollectionClient } from '../base/resource_collection_client';
 import type { PaginatedIterator, PaginatedList, PaginationOptions } from '../utils';
 import type { Actor, ActorDefaultRunOptions, ActorExampleRunInput, ActorStandby } from './actor';
 import type { ActorVersion } from './actor_version';
+/**
+ * Client for managing the collection of Actors in your account.
+ *
+ * Provides methods to list and create Actors. To access an individual Actor,
+ * use the `actor()` method on the main ApifyClient.
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ * const actorsClient = client.actors();
+ *
+ * // List all Actors
+ * const { items } = await actorsClient.list();
+ *
+ * // Create a new Actor
+ * const newActor = await actorsClient.create({
+ *   name: 'my-actor',
+ *   title: 'My Actor'
+ * });
+ * ```
+ *
+ * @see https://docs.apify.com/platform/actors
+ */
 export declare class ActorCollectionClient extends ResourceCollectionClient {
     /**
      * @hidden
      */
     constructor(options: ApiClientSubResourceOptions);
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors
+     * Lists all Actors.
      *
      * 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,10 +46,18 @@ export declare class ActorCollectionClient extends ResourceCollectionClient {
      * ```javascript
      * for await (const singleItem of client.list(options)) {...}
      * ```
+     *
+     * @param options - Pagination options.
+     * @returns A paginated iterator of Actors.
+     * @see https://docs.apify.com/api/v2/acts-get
      */
     list(options?: ActorCollectionListOptions): PaginatedIterator<ActorCollectionListItem>;
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor
+     * Creates a new Actor.
+     *
+     * @param actor - The Actor data.
+     * @returns The created Actor object.
+     * @see https://docs.apify.com/api/v2/acts-post
      */
     create(actor: ActorCollectionCreateOptions): Promise<Actor>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"actor_collection.d.ts","sourceRoot":"","sources":["../../src/resource_clients/actor_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,aAAa,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AACpF,OAAO,KAAK,EAAE,KAAK,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACjG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAEpD,qBAAa,qBAAsB,SAAQ,wBAAwB;IAC/D;;OAEG;gBACS,OAAO,EAAE,2BAA2B;IAOhD;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,OAAO,GAAE,0BAA+B,GAAG,iBAAiB,CAAC,uBAAuB,CAAC;IAe1F;;OAEG;IACG,MAAM,CAAC,KAAK,EAAE,4BAA4B,GAAG,OAAO,CAAC,KAAK,CAAC;CAKpE;AAED,oBAAY,eAAe;IACvB,UAAU,cAAc;IACxB,mBAAmB,2BAA2B;CACjD;AAED,MAAM,WAAW,0BAA2B,SAAQ,iBAAiB;IACjE,EAAE,CAAC,EAAE,OAAO,CAAC;IACb,MAAM,CAAC,EAAE,eAAe,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,IAAI,CAAC;IAChB,UAAU,EAAE,IAAI,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,yBAAyB,GAAG,aAAa,CAAC,uBAAuB,CAAC,CAAC;AAE/E,MAAM,WAAW,4BAA4B;IACzC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,iBAAiB,CAAC,EAAE,sBAAsB,CAAC;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,oBAAoB,CAAC;IACvC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,+DAA+D;IAC/D,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAC;IAC1B,YAAY,CAAC,EAAE,YAAY,GAAG;QAC1B,SAAS,EAAE,OAAO,CAAC;KACtB,CAAC;CACL"}
+{"version":3,"file":"actor_collection.d.ts","sourceRoot":"","sources":["../../src/resource_clients/actor_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,aAAa,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AACpF,OAAO,KAAK,EAAE,KAAK,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACjG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAEpD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,qBAAsB,SAAQ,wBAAwB;IAC/D;;OAEG;gBACS,OAAO,EAAE,2BAA2B;IAOhD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CAAC,OAAO,GAAE,0BAA+B,GAAG,iBAAiB,CAAC,uBAAuB,CAAC;IAe1F;;;;;;OAMG;IACG,MAAM,CAAC,KAAK,EAAE,4BAA4B,GAAG,OAAO,CAAC,KAAK,CAAC;CAKpE;AAED,oBAAY,eAAe;IACvB,UAAU,cAAc;IACxB,mBAAmB,2BAA2B;CACjD;AAED,MAAM,WAAW,0BAA2B,SAAQ,iBAAiB;IACjE,EAAE,CAAC,EAAE,OAAO,CAAC;IACb,MAAM,CAAC,EAAE,eAAe,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,IAAI,CAAC;IAChB,UAAU,EAAE,IAAI,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,yBAAyB,GAAG,aAAa,CAAC,uBAAuB,CAAC,CAAC;AAE/E,MAAM,WAAW,4BAA4B;IACzC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,iBAAiB,CAAC,EAAE,sBAAsB,CAAC;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,oBAAoB,CAAC;IACvC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,+DAA+D;IAC/D,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAC;IAC1B,YAAY,CAAC,EAAE,YAAY,GAAG;QAC1B,SAAS,EAAE,OAAO,CAAC;KACtB,CAAC;CACL"}

package/dist/resource_clients/actor_collection.js

@@ -4,6 +4,29 @@ exports.ActorListSortBy = exports.ActorCollectionClient = 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 Actors in your account.
+ *
+ * Provides methods to list and create Actors. To access an individual Actor,
+ * use the `actor()` method on the main ApifyClient.
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ * const actorsClient = client.actors();
+ *
+ * // List all Actors
+ * const { items } = await actorsClient.list();
+ *
+ * // Create a new Actor
+ * const newActor = await actorsClient.create({
+ *   name: 'my-actor',
+ *   title: 'My Actor'
+ * });
+ * ```
+ *
+ * @see https://docs.apify.com/platform/actors
+ */
 class ActorCollectionClient extends resource_collection_client_1.ResourceCollectionClient {
     /**
      * @hidden
@@ -15,13 +38,13 @@ class ActorCollectionClient extends resource_collection_client_1.ResourceCollect
         });
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors
+     * Lists all Actors.
      *
      * Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
      * items in a single API call is limited.
      * ```javascript
      * const paginatedList = await client.list(options);
-     *```
+     * ```
      *
      * Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
      * retrieved.
@@ -29,6 +52,10 @@ class ActorCollectionClient extends resource_collection_client_1.ResourceCollect
      * ```javascript
      * for await (const singleItem of client.list(options)) {...}
      * ```
+     *
+     * @param options - Pagination options.
+     * @returns A paginated iterator of Actors.
+     * @see https://docs.apify.com/api/v2/acts-get
      */
     list(options = {}) {
         (0, ow_1.default)(options, ow_1.default.object.exactShape({
@@ -41,7 +68,11 @@ class ActorCollectionClient extends resource_collection_client_1.ResourceCollect
         return this._listPaginated(options);
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor
+     * Creates a new Actor.
+     *
+     * @param actor - The Actor data.
+     * @returns The created Actor object.
+     * @see https://docs.apify.com/api/v2/acts-post
      */
     async create(actor) {
         (0, ow_1.default)(actor, ow_1.default.optional.object);

package/dist/resource_clients/actor_collection.js.map

@@ -1 +1 @@
-{"version":3,"file":"actor_collection.js","sourceRoot":"","sources":["../../src/resource_clients/actor_collection.ts"],"names":[],"mappings":";;;;AAAA,oDAAoB;AAGpB,mFAA8E;AAK9E,MAAa,qBAAsB,SAAQ,qDAAwB;IAC/D;;OAEG;IACH,YAAY,OAAoC;QAC5C,KAAK,CAAC;YACF,YAAY,EAAE,MAAM;YACpB,GAAG,OAAO;SACb,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,UAAsC,EAAE;QACzC,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,EAAE,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YACvB,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,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;SACnE,CAAC,CACL,CAAC;QAEF,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,KAAmC;QAC5C,IAAA,YAAE,EAAC,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAE9B,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;CACJ;AAlDD,sDAkDC;AAED,IAAY,eAGX;AAHD,WAAY,eAAe;IACvB,2CAAwB,CAAA;IACxB,iEAA8C,CAAA;AAClD,CAAC,EAHW,eAAe,+BAAf,eAAe,QAG1B"}
+{"version":3,"file":"actor_collection.js","sourceRoot":"","sources":["../../src/resource_clients/actor_collection.ts"],"names":[],"mappings":";;;;AAAA,oDAAoB;AAGpB,mFAA8E;AAK9E;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAa,qBAAsB,SAAQ,qDAAwB;IAC/D;;OAEG;IACH,YAAY,OAAoC;QAC5C,KAAK,CAAC;YACF,YAAY,EAAE,MAAM;YACpB,GAAG,OAAO;SACb,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CAAC,UAAsC,EAAE;QACzC,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,EAAE,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YACvB,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,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;SACnE,CAAC,CACL,CAAC;QAEF,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAC,KAAmC;QAC5C,IAAA,YAAE,EAAC,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAE9B,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;CACJ;AA1DD,sDA0DC;AAED,IAAY,eAGX;AAHD,WAAY,eAAe;IACvB,2CAAwB,CAAA;IACxB,iEAA8C,CAAA;AAClD,CAAC,EAHW,eAAe,+BAAf,eAAe,QAG1B"}

package/dist/resource_clients/actor_env_var.d.ts

@@ -1,21 +1,52 @@
 import type { ApiClientSubResourceOptions } from '../base/api_client';
 import { ResourceClient } from '../base/resource_client';
 import type { ActorEnvironmentVariable } from './actor_version';
+/**
+ * Client for managing a specific Actor environment variable.
+ *
+ * Environment variables are key-value pairs that are available to the Actor during execution.
+ * This client provides methods to get, update, and delete environment variables.
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ * const actorClient = client.actor('my-actor-id');
+ * const versionClient = actorClient.version('0.1');
+ *
+ * // Get an environment variable
+ * const envVarClient = versionClient.envVar('MY_VAR');
+ * const envVar = await envVarClient.get();
+ *
+ * // Update environment variable
+ * await envVarClient.update({ value: 'new-value' });
+ * ```
+ *
+ * @see https://docs.apify.com/platform/actors/development/actor-definition/environment-variables
+ */
 export declare class ActorEnvVarClient extends ResourceClient {
     /**
      * @hidden
      */
     constructor(options: ApiClientSubResourceOptions);
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable
+     * Retrieves the environment variable.
+     *
+     * @returns The environment variable object, or `undefined` if it does not exist.
+     * @see https://docs.apify.com/api/v2/act-version-env-var-get
      */
     get(): Promise<ActorEnvironmentVariable | undefined>;
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable
+     * Updates the environment variable.
+     *
+     * @param actorEnvVar - The updated environment variable data.
+     * @returns The updated environment variable object.
+     * @see https://docs.apify.com/api/v2/act-version-env-var-put
      */
     update(actorEnvVar: ActorEnvironmentVariable): Promise<ActorEnvironmentVariable>;
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable
+     * Deletes the environment variable.
+     *
+     * @see https://docs.apify.com/api/v2/act-version-env-var-delete
      */
     delete(): Promise<void>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"actor_env_var.d.ts","sourceRoot":"","sources":["../../src/resource_clients/actor_env_var.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAEhE,qBAAa,iBAAkB,SAAQ,cAAc;IACjD;;OAEG;gBACS,OAAO,EAAE,2BAA2B;IAOhD;;OAEG;IACG,GAAG,IAAI,OAAO,CAAC,wBAAwB,GAAG,SAAS,CAAC;IAI1D;;OAEG;IACG,MAAM,CAAC,WAAW,EAAE,wBAAwB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAKtF;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAGhC"}
+{"version":3,"file":"actor_env_var.d.ts","sourceRoot":"","sources":["../../src/resource_clients/actor_env_var.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,iBAAkB,SAAQ,cAAc;IACjD;;OAEG;gBACS,OAAO,EAAE,2BAA2B;IAOhD;;;;;OAKG;IACG,GAAG,IAAI,OAAO,CAAC,wBAAwB,GAAG,SAAS,CAAC;IAI1D;;;;;;OAMG;IACG,MAAM,CAAC,WAAW,EAAE,wBAAwB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAKtF;;;;OAIG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAGhC"}

package/dist/resource_clients/actor_env_var.js

@@ -4,6 +4,28 @@ exports.ActorEnvVarClient = void 0;
 const tslib_1 = require("tslib");
 const ow_1 = tslib_1.__importDefault(require("ow"));
 const resource_client_1 = require("../base/resource_client");
+/**
+ * Client for managing a specific Actor environment variable.
+ *
+ * Environment variables are key-value pairs that are available to the Actor during execution.
+ * This client provides methods to get, update, and delete environment variables.
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ * const actorClient = client.actor('my-actor-id');
+ * const versionClient = actorClient.version('0.1');
+ *
+ * // Get an environment variable
+ * const envVarClient = versionClient.envVar('MY_VAR');
+ * const envVar = await envVarClient.get();
+ *
+ * // Update environment variable
+ * await envVarClient.update({ value: 'new-value' });
+ * ```
+ *
+ * @see https://docs.apify.com/platform/actors/development/actor-definition/environment-variables
+ */
 class ActorEnvVarClient extends resource_client_1.ResourceClient {
     /**
      * @hidden
@@ -15,20 +37,29 @@ class ActorEnvVarClient extends resource_client_1.ResourceClient {
         });
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable
+     * Retrieves the environment variable.
+     *
+     * @returns The environment variable object, or `undefined` if it does not exist.
+     * @see https://docs.apify.com/api/v2/act-version-env-var-get
      */
     async get() {
         return this._get();
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable
+     * Updates the environment variable.
+     *
+     * @param actorEnvVar - The updated environment variable data.
+     * @returns The updated environment variable object.
+     * @see https://docs.apify.com/api/v2/act-version-env-var-put
      */
     async update(actorEnvVar) {
         (0, ow_1.default)(actorEnvVar, ow_1.default.object);
         return this._update(actorEnvVar);
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable
+     * Deletes the environment variable.
+     *
+     * @see https://docs.apify.com/api/v2/act-version-env-var-delete
      */
     async delete() {
         return this._delete();

package/dist/resource_clients/actor_env_var.js.map

@@ -1 +1 @@
-{"version":3,"file":"actor_env_var.js","sourceRoot":"","sources":["../../src/resource_clients/actor_env_var.ts"],"names":[],"mappings":";;;;AAAA,oDAAoB;AAGpB,6DAAyD;AAGzD,MAAa,iBAAkB,SAAQ,gCAAc;IACjD;;OAEG;IACH,YAAY,OAAoC;QAC5C,KAAK,CAAC;YACF,YAAY,EAAE,UAAU;YACxB,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,WAAqC;QAC9C,IAAA,YAAE,EAAC,WAAW,EAAE,YAAE,CAAC,MAAM,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACrC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;CACJ;AAhCD,8CAgCC"}
+{"version":3,"file":"actor_env_var.js","sourceRoot":"","sources":["../../src/resource_clients/actor_env_var.ts"],"names":[],"mappings":";;;;AAAA,oDAAoB;AAGpB,6DAAyD;AAGzD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAa,iBAAkB,SAAQ,gCAAc;IACjD;;OAEG;IACH,YAAY,OAAoC;QAC5C,KAAK,CAAC;YACF,YAAY,EAAE,UAAU;YACxB,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,WAAqC;QAC9C,IAAA,YAAE,EAAC,WAAW,EAAE,YAAE,CAAC,MAAM,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;CACJ;AAzCD,8CAyCC"}