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

package/dist/resource_clients/actor_env_var_collection.d.ts

@@ -2,19 +2,45 @@ import type { ApiClientSubResourceOptions } from '../base/api_client';
 import { ResourceCollectionClient } from '../base/resource_collection_client';
 import type { PaginatedList, PaginationOptions } from '../utils';
 import type { ActorEnvironmentVariable } from './actor_version';
+/**
+ * Client for managing the collection of environment variables for an Actor version.
+ *
+ * Environment variables are key-value pairs that are available to the Actor during execution.
+ * This client provides methods to list and create environment variables.
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ * const actorClient = client.actor('my-actor-id');
+ * const versionClient = actorClient.version('0.1');
+ *
+ * // List all environment variables
+ * const envVarsClient = versionClient.envVars();
+ * const { items } = await envVarsClient.list();
+ *
+ * // Create a new environment variable
+ * const newEnvVar = await envVarsClient.create({
+ *   name: 'MY_VAR',
+ *   value: 'my-value',
+ *   isSecret: false
+ * });
+ * ```
+ *
+ * @see https://docs.apify.com/platform/actors/development/actor-definition/environment-variables
+ */
 export declare class ActorEnvVarCollectionClient extends ResourceCollectionClient {
     /**
      * @hidden
      */
     constructor(options: ApiClientSubResourceOptions);
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables
+     * Lists all environment variables of this Actor version.
      *
      * Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
      * items in a single API call is limited.
      * ```javascript
      * const paginatedList = await client.list(options);
-     *```
+     * ```
      *
      * Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
      * retrieved.
@@ -22,10 +48,18 @@ export declare class ActorEnvVarCollectionClient extends ResourceCollectionClien
      * ```javascript
      * for await (const singleItem of client.list(options)) {...}
      * ```
+     *
+     * @param options - Pagination options.
+     * @returns A paginated iterator of environment variables.
+     * @see https://docs.apify.com/api/v2/act-version-env-vars-get
      */
     list(options?: ActorEnvVarCollectionListOptions): Promise<ActorEnvVarListResult> & AsyncIterable<ActorEnvironmentVariable>;
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable
+     * Creates a new environment variable for this Actor version.
+     *
+     * @param actorEnvVar - The environment variable data.
+     * @returns The created environment variable object.
+     * @see https://docs.apify.com/api/v2/act-version-env-vars-post
      */
     create(actorEnvVar: ActorEnvironmentVariable): Promise<ActorEnvironmentVariable>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"actor_env_var_collection.d.ts","sourceRoot":"","sources":["../../src/resource_clients/actor_env_var_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,aAAa,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AACjE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAEhE,qBAAa,2BAA4B,SAAQ,wBAAwB;IACrE;;OAEG;gBACS,OAAO,EAAE,2BAA2B;IAOhD;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACA,OAAO,GAAE,gCAAqC,GAC/C,OAAO,CAAC,qBAAqB,CAAC,GAAG,aAAa,CAAC,wBAAwB,CAAC;IAY3E;;OAEG;IACG,MAAM,CAAC,WAAW,EAAE,wBAAwB,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAIzF;AAED,MAAM,WAAW,gCAAiC,SAAQ,iBAAiB;IACvE,IAAI,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,aAAa,CAAC,wBAAwB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC"}
+{"version":3,"file":"actor_env_var_collection.d.ts","sourceRoot":"","sources":["../../src/resource_clients/actor_env_var_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,aAAa,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AACjE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,2BAA4B,SAAQ,wBAAwB;IACrE;;OAEG;gBACS,OAAO,EAAE,2BAA2B;IAOhD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CACA,OAAO,GAAE,gCAAqC,GAC/C,OAAO,CAAC,qBAAqB,CAAC,GAAG,aAAa,CAAC,wBAAwB,CAAC;IAY3E;;;;;;OAMG;IACG,MAAM,CAAC,WAAW,EAAE,wBAAwB,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAIzF;AAED,MAAM,WAAW,gCAAiC,SAAQ,iBAAiB;IACvE,IAAI,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,aAAa,CAAC,wBAAwB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC"}

package/dist/resource_clients/actor_env_var_collection.js

@@ -4,6 +4,32 @@ exports.ActorEnvVarCollectionClient = 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 environment variables for an Actor version.
+ *
+ * Environment variables are key-value pairs that are available to the Actor during execution.
+ * This client provides methods to list and create environment variables.
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ * const actorClient = client.actor('my-actor-id');
+ * const versionClient = actorClient.version('0.1');
+ *
+ * // List all environment variables
+ * const envVarsClient = versionClient.envVars();
+ * const { items } = await envVarsClient.list();
+ *
+ * // Create a new environment variable
+ * const newEnvVar = await envVarsClient.create({
+ *   name: 'MY_VAR',
+ *   value: 'my-value',
+ *   isSecret: false
+ * });
+ * ```
+ *
+ * @see https://docs.apify.com/platform/actors/development/actor-definition/environment-variables
+ */
 class ActorEnvVarCollectionClient extends resource_collection_client_1.ResourceCollectionClient {
     /**
      * @hidden
@@ -15,13 +41,13 @@ class ActorEnvVarCollectionClient extends resource_collection_client_1.ResourceC
         });
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables
+     * Lists all environment variables of this Actor version.
      *
      * 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 +55,10 @@ class ActorEnvVarCollectionClient extends resource_collection_client_1.ResourceC
      * ```javascript
      * for await (const singleItem of client.list(options)) {...}
      * ```
+     *
+     * @param options - Pagination options.
+     * @returns A paginated iterator of environment variables.
+     * @see https://docs.apify.com/api/v2/act-version-env-vars-get
      */
     list(options = {}) {
         (0, ow_1.default)(options, ow_1.default.object.exactShape({
@@ -39,7 +69,11 @@ class ActorEnvVarCollectionClient extends resource_collection_client_1.ResourceC
         return this._listPaginated(options);
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable
+     * Creates a new environment variable for this Actor version.
+     *
+     * @param actorEnvVar - The environment variable data.
+     * @returns The created environment variable object.
+     * @see https://docs.apify.com/api/v2/act-version-env-vars-post
      */
     async create(actorEnvVar) {
         (0, ow_1.default)(actorEnvVar, ow_1.default.optional.object);

package/dist/resource_clients/actor_env_var_collection.js.map

@@ -1 +1 @@
-{"version":3,"file":"actor_env_var_collection.js","sourceRoot":"","sources":["../../src/resource_clients/actor_env_var_collection.ts"],"names":[],"mappings":";;;;AAAA,oDAAoB;AAGpB,mFAA8E;AAI9E,MAAa,2BAA4B,SAAQ,qDAAwB;IACrE;;OAEG;IACH,YAAY,OAAoC;QAC5C,KAAK,CAAC;YACF,YAAY,EAAE,UAAU;YACxB,GAAG,OAAO;SACb,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACA,UAA4C,EAAE;QAE9C,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;QACF,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,WAAqC;QAC9C,IAAA,YAAE,EAAC,WAAW,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACrC,CAAC;CACJ;AAhDD,kEAgDC"}
+{"version":3,"file":"actor_env_var_collection.js","sourceRoot":"","sources":["../../src/resource_clients/actor_env_var_collection.ts"],"names":[],"mappings":";;;;AAAA,oDAAoB;AAGpB,mFAA8E;AAI9E;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAa,2BAA4B,SAAQ,qDAAwB;IACrE;;OAEG;IACH,YAAY,OAAoC;QAC5C,KAAK,CAAC;YACF,YAAY,EAAE,UAAU;YACxB,GAAG,OAAO;SACb,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CACA,UAA4C,EAAE;QAE9C,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;QACF,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAC,WAAqC;QAC9C,IAAA,YAAE,EAAC,WAAW,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACrC,CAAC;CACJ;AAxDD,kEAwDC"}

package/dist/resource_clients/actor_version.d.ts

@@ -2,30 +2,66 @@ import type { ApiClientSubResourceOptions } from '../base/api_client';
 import { ResourceClient } from '../base/resource_client';
 import { ActorEnvVarClient } from './actor_env_var';
 import { ActorEnvVarCollectionClient } from './actor_env_var_collection';
+/**
+ * Client for managing a specific Actor version.
+ *
+ * Actor versions represent specific builds or snapshots of an Actor's code. This client provides
+ * methods to get, update, and delete versions, as well as manage their environment variables.
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ * const actorClient = client.actor('my-actor-id');
+ *
+ * // Get a specific version
+ * const versionClient = actorClient.version('0.1');
+ * const version = await versionClient.get();
+ *
+ * // Update version
+ * await versionClient.update({ buildTag: 'latest' });
+ * ```
+ *
+ * @see https://docs.apify.com/platform/actors/development/actor-definition/versions
+ */
 export declare class ActorVersionClient extends ResourceClient {
     /**
      * @hidden
      */
     constructor(options: ApiClientSubResourceOptions);
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/version-object/get-version
+     * Retrieves the Actor version.
+     *
+     * @returns The Actor version object, or `undefined` if it does not exist.
+     * @see https://docs.apify.com/api/v2/act-version-get
      */
     get(): Promise<FinalActorVersion | undefined>;
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/version-object/update-version
+     * Updates the Actor version with the specified fields.
+     *
+     * @param newFields - Fields to update.
+     * @returns The updated Actor version object.
+     * @see https://docs.apify.com/api/v2/act-version-put
      */
     update(newFields: ActorVersion): Promise<FinalActorVersion>;
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/version-object/delete-version
+     * Deletes the Actor version.
+     *
+     * @see https://docs.apify.com/api/v2/act-version-delete
      */
     delete(): Promise<void>;
     /**
-     * TODO: https://docs.apify.com/api/v2#/reference/actors/env-var-object
+     * Returns a client for the specified environment variable of this Actor version.
+     *
+     * @param envVarName - Name of the environment variable.
+     * @returns A client for the environment variable.
+     * @see https://docs.apify.com/api/v2/act-version-env-var-get
      */
     envVar(envVarName: string): ActorEnvVarClient;
     /**
-     * TODO: https://docs.apify.com/api/v2#/reference/actors/env-var-collection
-     * @return {ActorVersionCollectionClient}
+     * Returns a client for the environment variables of this Actor version.
+     *
+     * @returns A client for the Actor version's environment variables.
+     * @see https://docs.apify.com/api/v2/act-version-env-vars-get
      */
     envVars(): ActorEnvVarCollectionClient;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"actor_version.d.ts","sourceRoot":"","sources":["../../src/resource_clients/actor_version.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,2BAA2B,EAAE,MAAM,4BAA4B,CAAC;AAEzE,qBAAa,kBAAmB,SAAQ,cAAc;IAClD;;OAEG;gBACS,OAAO,EAAE,2BAA2B;IAOhD;;OAEG;IACG,GAAG,IAAI,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAInD;;OAEG;IACG,MAAM,CAAC,SAAS,EAAE,YAAY,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAMjE;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAI7B;;OAEG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,iBAAiB;IAS7C;;;OAGG;IACH,OAAO,IAAI,2BAA2B;CAGzC;AAED,MAAM,WAAW,gBAAgB,CAAC,UAAU,SAAS,eAAe;IAChE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,UAAU,CAAC;IACvB,OAAO,CAAC,EAAE,wBAAwB,EAAE,CAAC;IACrC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB,CAAC,eAAe,CAAC,WAAW,CAAC;IAC1F,WAAW,EAAE,sBAAsB,EAAE,CAAC;CACzC;AAED,MAAM,WAAW,sBAAsB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,GAAG,QAAQ,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB,CAAC,eAAe,CAAC,OAAO,CAAC;IAClF,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB,CAAC,eAAe,CAAC,OAAO,CAAC;IAClF,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB,CAAC,eAAe,CAAC,UAAU,CAAC;IACxF,aAAa,EAAE,MAAM,CAAC;CACzB;AAED,oBAAY,eAAe;IACvB,WAAW,iBAAiB;IAC5B,OAAO,aAAa;IACpB,OAAO,YAAY;IACnB,UAAU,gBAAgB;CAC7B;AAED,MAAM,WAAW,wBAAwB;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,MAAM,YAAY,GAAG,uBAAuB,GAAG,mBAAmB,GAAG,mBAAmB,GAAG,sBAAsB,CAAC;AAExH,MAAM,MAAM,iBAAiB,GAAG,YAAY,GAAG,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,eAAe,GAAG,UAAU,CAAC,CAAC,CAAC"}
+{"version":3,"file":"actor_version.d.ts","sourceRoot":"","sources":["../../src/resource_clients/actor_version.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,2BAA2B,EAAE,MAAM,4BAA4B,CAAC;AAEzE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,kBAAmB,SAAQ,cAAc;IAClD;;OAEG;gBACS,OAAO,EAAE,2BAA2B;IAOhD;;;;;OAKG;IACG,GAAG,IAAI,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAInD;;;;;;OAMG;IACG,MAAM,CAAC,SAAS,EAAE,YAAY,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAMjE;;;;OAIG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAI7B;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,iBAAiB;IAS7C;;;;;OAKG;IACH,OAAO,IAAI,2BAA2B;CAGzC;AAED,MAAM,WAAW,gBAAgB,CAAC,UAAU,SAAS,eAAe;IAChE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,UAAU,CAAC;IACvB,OAAO,CAAC,EAAE,wBAAwB,EAAE,CAAC;IACrC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB,CAAC,eAAe,CAAC,WAAW,CAAC;IAC1F,WAAW,EAAE,sBAAsB,EAAE,CAAC;CACzC;AAED,MAAM,WAAW,sBAAsB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,GAAG,QAAQ,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB,CAAC,eAAe,CAAC,OAAO,CAAC;IAClF,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB,CAAC,eAAe,CAAC,OAAO,CAAC;IAClF,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB,CAAC,eAAe,CAAC,UAAU,CAAC;IACxF,aAAa,EAAE,MAAM,CAAC;CACzB;AAED,oBAAY,eAAe;IACvB,WAAW,iBAAiB;IAC5B,OAAO,aAAa;IACpB,OAAO,YAAY;IACnB,UAAU,gBAAgB;CAC7B;AAED,MAAM,WAAW,wBAAwB;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,MAAM,YAAY,GAAG,uBAAuB,GAAG,mBAAmB,GAAG,mBAAmB,GAAG,sBAAsB,CAAC;AAExH,MAAM,MAAM,iBAAiB,GAAG,YAAY,GAAG,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,eAAe,GAAG,UAAU,CAAC,CAAC,CAAC"}

package/dist/resource_clients/actor_version.js

@@ -6,6 +6,27 @@ const ow_1 = tslib_1.__importDefault(require("ow"));
 const resource_client_1 = require("../base/resource_client");
 const actor_env_var_1 = require("./actor_env_var");
 const actor_env_var_collection_1 = require("./actor_env_var_collection");
+/**
+ * Client for managing a specific Actor version.
+ *
+ * Actor versions represent specific builds or snapshots of an Actor's code. This client provides
+ * methods to get, update, and delete versions, as well as manage their environment variables.
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ * const actorClient = client.actor('my-actor-id');
+ *
+ * // Get a specific version
+ * const versionClient = actorClient.version('0.1');
+ * const version = await versionClient.get();
+ *
+ * // Update version
+ * await versionClient.update({ buildTag: 'latest' });
+ * ```
+ *
+ * @see https://docs.apify.com/platform/actors/development/actor-definition/versions
+ */
 class ActorVersionClient extends resource_client_1.ResourceClient {
     /**
      * @hidden
@@ -17,26 +38,39 @@ class ActorVersionClient extends resource_client_1.ResourceClient {
         });
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/version-object/get-version
+     * Retrieves the Actor version.
+     *
+     * @returns The Actor version object, or `undefined` if it does not exist.
+     * @see https://docs.apify.com/api/v2/act-version-get
      */
     async get() {
         return this._get();
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/version-object/update-version
+     * Updates the Actor version with the specified fields.
+     *
+     * @param newFields - Fields to update.
+     * @returns The updated Actor version object.
+     * @see https://docs.apify.com/api/v2/act-version-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/version-object/delete-version
+     * Deletes the Actor version.
+     *
+     * @see https://docs.apify.com/api/v2/act-version-delete
      */
     async delete() {
         return this._delete();
     }
     /**
-     * TODO: https://docs.apify.com/api/v2#/reference/actors/env-var-object
+     * Returns a client for the specified environment variable of this Actor version.
+     *
+     * @param envVarName - Name of the environment variable.
+     * @returns A client for the environment variable.
+     * @see https://docs.apify.com/api/v2/act-version-env-var-get
      */
     envVar(envVarName) {
         (0, ow_1.default)(envVarName, ow_1.default.string);
@@ -45,8 +79,10 @@ class ActorVersionClient extends resource_client_1.ResourceClient {
         }));
     }
     /**
-     * TODO: https://docs.apify.com/api/v2#/reference/actors/env-var-collection
-     * @return {ActorVersionCollectionClient}
+     * Returns a client for the environment variables of this Actor version.
+     *
+     * @returns A client for the Actor version's environment variables.
+     * @see https://docs.apify.com/api/v2/act-version-env-vars-get
      */
     envVars() {
         return new actor_env_var_collection_1.ActorEnvVarCollectionClient(this._subResourceOptions());

package/dist/resource_clients/actor_version.js.map

@@ -1 +1 @@
-{"version":3,"file":"actor_version.js","sourceRoot":"","sources":["../../src/resource_clients/actor_version.ts"],"names":[],"mappings":";;;;AAAA,oDAAoB;AAGpB,6DAAyD;AACzD,mDAAoD;AACpD,yEAAyE;AAEzE,MAAa,kBAAmB,SAAQ,gCAAc;IAClD;;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,SAAuB;QAChC,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;;OAEG;IACH,MAAM,CAAC,UAAkB;QACrB,IAAA,YAAE,EAAC,UAAU,EAAE,YAAE,CAAC,MAAM,CAAC,CAAC;QAC1B,OAAO,IAAI,iCAAiB,CACxB,IAAI,CAAC,mBAAmB,CAAC;YACrB,EAAE,EAAE,UAAU;SACjB,CAAC,CACL,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,OAAO;QACH,OAAO,IAAI,sDAA2B,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;IACvE,CAAC;CACJ;AArDD,gDAqDC;AAgCD,IAAY,eAKX;AALD,WAAY,eAAe;IACvB,+CAA4B,CAAA;IAC5B,uCAAoB,CAAA;IACpB,sCAAmB,CAAA;IACnB,6CAA0B,CAAA;AAC9B,CAAC,EALW,eAAe,+BAAf,eAAe,QAK1B"}
+{"version":3,"file":"actor_version.js","sourceRoot":"","sources":["../../src/resource_clients/actor_version.ts"],"names":[],"mappings":";;;;AAAA,oDAAoB;AAGpB,6DAAyD;AACzD,mDAAoD;AACpD,yEAAyE;AAEzE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAa,kBAAmB,SAAQ,gCAAc;IAClD;;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,SAAuB;QAChC,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;;;;;;OAMG;IACH,MAAM,CAAC,UAAkB;QACrB,IAAA,YAAE,EAAC,UAAU,EAAE,YAAE,CAAC,MAAM,CAAC,CAAC;QAC1B,OAAO,IAAI,iCAAiB,CACxB,IAAI,CAAC,mBAAmB,CAAC;YACrB,EAAE,EAAE,UAAU;SACjB,CAAC,CACL,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACH,OAAO;QACH,OAAO,IAAI,sDAA2B,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;IACvE,CAAC;CACJ;AApED,gDAoEC;AAgCD,IAAY,eAKX;AALD,WAAY,eAAe;IACvB,+CAA4B,CAAA;IAC5B,uCAAoB,CAAA;IACpB,sCAAmB,CAAA;IACnB,6CAA0B,CAAA;AAC9B,CAAC,EALW,eAAe,+BAAf,eAAe,QAK1B"}

package/dist/resource_clients/actor_version_collection.d.ts

@@ -2,19 +2,43 @@ import type { ApiClientSubResourceOptions } from '../base/api_client';
 import { ResourceCollectionClient } from '../base/resource_collection_client';
 import type { PaginatedList, PaginationOptions } from '../utils';
 import type { ActorVersion, FinalActorVersion } from './actor_version';
+/**
+ * Client for managing the collection of Actor versions.
+ *
+ * Actor versions represent specific builds or snapshots of an Actor's code. This client provides
+ * methods to list and create versions for a specific Actor.
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ * const actorClient = client.actor('my-actor-id');
+ *
+ * // List all versions
+ * const versionsClient = actorClient.versions();
+ * const { items } = await versionsClient.list();
+ *
+ * // Create a new version
+ * const newVersion = await versionsClient.create({
+ *   versionNumber: '0.2',
+ *   buildTag: 'latest'
+ * });
+ * ```
+ *
+ * @see https://docs.apify.com/platform/actors/development/actor-definition/versions
+ */
 export declare class ActorVersionCollectionClient extends ResourceCollectionClient {
     /**
      * @hidden
      */
     constructor(options: ApiClientSubResourceOptions);
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions
+     * Lists all Actor versions.
      *
      * Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
      * items in a single API call is limited.
      * ```javascript
      * const paginatedList = await client.list(options);
-     *```
+     * ```
      *
      * Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
      * retrieved.
@@ -22,10 +46,18 @@ export declare class ActorVersionCollectionClient extends ResourceCollectionClie
      * ```javascript
      * for await (const singleItem of client.list(options)) {...}
      * ```
+     *
+     * @param options - Pagination options.
+     * @returns A paginated iterator of Actor versions.
+     * @see https://docs.apify.com/api/v2/act-versions-get
      */
     list(options?: ActorVersionCollectionListOptions): Promise<ActorVersionListResult> & AsyncIterable<FinalActorVersion>;
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/version-collection/create-version
+     * Creates a new Actor version.
+     *
+     * @param actorVersion - The Actor version data.
+     * @returns The created Actor version object.
+     * @see https://docs.apify.com/api/v2/act-versions-post
      */
     create(actorVersion: ActorVersion): Promise<FinalActorVersion>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"actor_version_collection.d.ts","sourceRoot":"","sources":["../../src/resource_clients/actor_version_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,aAAa,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AACjE,OAAO,KAAK,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEvE,qBAAa,4BAA6B,SAAQ,wBAAwB;IACtE;;OAEG;gBACS,OAAO,EAAE,2BAA2B;IAOhD;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACA,OAAO,GAAE,iCAAsC,GAChD,OAAO,CAAC,sBAAsB,CAAC,GAAG,aAAa,CAAC,iBAAiB,CAAC;IAarE;;OAEG;IACG,MAAM,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAKvE;AAED,MAAM,WAAW,iCAAkC,SAAQ,iBAAiB;IACxE,IAAI,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,sBAAsB,GAAG,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC"}
+{"version":3,"file":"actor_version_collection.d.ts","sourceRoot":"","sources":["../../src/resource_clients/actor_version_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,aAAa,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AACjE,OAAO,KAAK,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEvE;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,4BAA6B,SAAQ,wBAAwB;IACtE;;OAEG;gBACS,OAAO,EAAE,2BAA2B;IAOhD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CACA,OAAO,GAAE,iCAAsC,GAChD,OAAO,CAAC,sBAAsB,CAAC,GAAG,aAAa,CAAC,iBAAiB,CAAC;IAarE;;;;;;OAMG;IACG,MAAM,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAKvE;AAED,MAAM,WAAW,iCAAkC,SAAQ,iBAAiB;IACxE,IAAI,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,sBAAsB,GAAG,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC"}

package/dist/resource_clients/actor_version_collection.js

@@ -4,6 +4,30 @@ exports.ActorVersionCollectionClient = 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 versions.
+ *
+ * Actor versions represent specific builds or snapshots of an Actor's code. This client provides
+ * methods to list and create versions for a specific Actor.
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ * const actorClient = client.actor('my-actor-id');
+ *
+ * // List all versions
+ * const versionsClient = actorClient.versions();
+ * const { items } = await versionsClient.list();
+ *
+ * // Create a new version
+ * const newVersion = await versionsClient.create({
+ *   versionNumber: '0.2',
+ *   buildTag: 'latest'
+ * });
+ * ```
+ *
+ * @see https://docs.apify.com/platform/actors/development/actor-definition/versions
+ */
 class ActorVersionCollectionClient extends resource_collection_client_1.ResourceCollectionClient {
     /**
      * @hidden
@@ -15,13 +39,13 @@ class ActorVersionCollectionClient extends resource_collection_client_1.Resource
         });
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions
+     * Lists all Actor versions.
      *
      * 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 +53,10 @@ class ActorVersionCollectionClient extends resource_collection_client_1.Resource
      * ```javascript
      * for await (const singleItem of client.list(options)) {...}
      * ```
+     *
+     * @param options - Pagination options.
+     * @returns A paginated iterator of Actor versions.
+     * @see https://docs.apify.com/api/v2/act-versions-get
      */
     list(options = {}) {
         (0, ow_1.default)(options, ow_1.default.object.exactShape({
@@ -39,7 +67,11 @@ class ActorVersionCollectionClient extends resource_collection_client_1.Resource
         return this._listPaginated(options);
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/actors/version-collection/create-version
+     * Creates a new Actor version.
+     *
+     * @param actorVersion - The Actor version data.
+     * @returns The created Actor version object.
+     * @see https://docs.apify.com/api/v2/act-versions-post
      */
     async create(actorVersion) {
         (0, ow_1.default)(actorVersion, ow_1.default.optional.object);

package/dist/resource_clients/actor_version_collection.js.map

@@ -1 +1 @@
-{"version":3,"file":"actor_version_collection.js","sourceRoot":"","sources":["../../src/resource_clients/actor_version_collection.ts"],"names":[],"mappings":";;;;AAAA,oDAAoB;AAGpB,mFAA8E;AAI9E,MAAa,4BAA6B,SAAQ,qDAAwB;IACtE;;OAEG;IACH,YAAY,OAAoC;QAC5C,KAAK,CAAC;YACF,YAAY,EAAE,UAAU;YACxB,GAAG,OAAO;SACb,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACA,UAA6C,EAAE;QAE/C,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACzB,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC1B,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;SAC5B,CAAC,CACL,CAAC;QAEF,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,YAA0B;QACnC,IAAA,YAAE,EAAC,YAAY,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAErC,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IACtC,CAAC;CACJ;AAlDD,oEAkDC"}
+{"version":3,"file":"actor_version_collection.js","sourceRoot":"","sources":["../../src/resource_clients/actor_version_collection.ts"],"names":[],"mappings":";;;;AAAA,oDAAoB;AAGpB,mFAA8E;AAI9E;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAa,4BAA6B,SAAQ,qDAAwB;IACtE;;OAEG;IACH,YAAY,OAAoC;QAC5C,KAAK,CAAC;YACF,YAAY,EAAE,UAAU;YACxB,GAAG,OAAO;SACb,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CACA,UAA6C,EAAE;QAE/C,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACzB,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC1B,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;SAC5B,CAAC,CACL,CAAC;QAEF,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAC,YAA0B;QACnC,IAAA,YAAE,EAAC,YAAY,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAErC,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IACtC,CAAC;CACJ;AA1DD,oEA0DC"}