apify-client 2.25.1-beta.1 → 2.25.1-beta.2

package/dist/apify_client.d.ts

@@ -50,6 +50,9 @@ import { Statistics } from './statistics';
  */
 export declare class ApifyClient {
     baseUrl: string;
+    /**
+     * @since Added in 2.17.0
+     */
     publicBaseUrl: string;
     token?: string;
     stats: Statistics;
@@ -340,6 +343,7 @@ export declare class ApifyClient {
      * @param message - The status message to set
      * @param options - Additional options for the status message
      * @throws {Error} If `ACTOR_RUN_ID` environment variable is not set
+     * @since Added in 2.7.0
      */
     setStatusMessage(message: string, options?: SetStatusMessageOptions): Promise<void>;
 }
@@ -349,7 +353,10 @@ export declare class ApifyClient {
 export interface ApifyClientOptions {
     /** @default https://api.apify.com */
     baseUrl?: string;
-    /** @default https://api.apify.com */
+    /**
+     * @default https://api.apify.com
+     * @since Added in 2.17.0
+     */
     publicBaseUrl?: string;
     /** @default 8 */
     maxRetries?: number;
@@ -360,5 +367,8 @@ export interface ApifyClientOptions {
     /** @default 360 */
     timeoutSecs?: number;
     token?: string;
+    /**
+     * @since Added in 2.10.0
+     */
     userAgentSuffix?: string | string[];
 }

package/dist/apify_client.js

@@ -54,6 +54,9 @@ const DEFAULT_TIMEOUT_SECS = 360;
  */
 class ApifyClient {
     baseUrl;
+    /**
+     * @since Added in 2.17.0
+     */
     publicBaseUrl;
     token;
     stats;
@@ -484,6 +487,7 @@ class ApifyClient {
      * @param message - The status message to set
      * @param options - Additional options for the status message
      * @throws {Error} If `ACTOR_RUN_ID` environment variable is not set
+     * @since Added in 2.7.0
      */
     async setStatusMessage(message, options) {
         const runId = process.env[consts_1.ACTOR_ENV_VARS.RUN_ID];

package/dist/base/api_client.d.ts

@@ -20,6 +20,9 @@ export declare abstract class ApiClient {
     id?: string;
     safeId?: string;
     baseUrl: string;
+    /**
+     * @since Added in 2.17.0
+     */
     publicBaseUrl: string;
     resourcePath: string;
     url: string;

package/dist/base/api_client.js

@@ -6,6 +6,9 @@ class ApiClient {
     id;
     safeId;
     baseUrl;
+    /**
+     * @since Added in 2.17.0
+     */
     publicBaseUrl;
     resourcePath;
     url;

package/dist/bundle.js

@@ -12106,7 +12106,9 @@ const DEFAULT_TIMEOUT_SECS = 360;
  * @see https://docs.apify.com/api/v2
  */ class ApifyClient {
     baseUrl;
-    publicBaseUrl;
+    /**
+     * @since Added in 2.17.0
+     */ publicBaseUrl;
     token;
     stats;
     logger;
@@ -12515,6 +12517,7 @@ const DEFAULT_TIMEOUT_SECS = 360;
      * @param message - The status message to set
      * @param options - Additional options for the status message
      * @throws {Error} If `ACTOR_RUN_ID` environment variable is not set
+     * @since Added in 2.7.0
      */ async setStatusMessage(message, options) {
         const runId = process.env[_apify_consts__rspack_import_0.ACTOR_ENV_VARS.RUN_ID];
         if (!runId) {
@@ -12540,7 +12543,9 @@ __webpack_require__.r(__webpack_exports__);
     id;
     safeId;
     baseUrl;
-    publicBaseUrl;
+    /**
+     * @since Added in 2.17.0
+     */ publicBaseUrl;
     resourcePath;
     url;
     apifyClient;
@@ -13527,6 +13532,7 @@ __webpack_require__.r(__webpack_exports__);
      *   { build: 'beta' },
      * );
      * ```
+     * @since Added in 2.24.0
      */ async validateInput(input) {
         let options = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {};
         // input can be anything, so no point in validating it. E.g. if you set content-type to application/pdf
@@ -13624,6 +13630,7 @@ __webpack_require__.r(__webpack_exports__);
      * const buildClient = await client.actor('my-actor').defaultBuild({ waitForFinish: 60 });
      * const build = await buildClient.get();
      * ```
+     * @since Added in 2.12.2
      */ async defaultBuild() {
         let options = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
         const response = await this.httpClient.call({
@@ -13804,7 +13811,9 @@ __webpack_require__.r(__webpack_exports__);
         return this._create(actor);
     }
 }
-var ActorListSortBy = /*#__PURE__*/ function(ActorListSortBy) {
+/**
+ * @since Added in 2.12.6
+ */ var ActorListSortBy = /*#__PURE__*/ function(ActorListSortBy) {
     ActorListSortBy["CREATED_AT"] = "createdAt";
     ActorListSortBy["LAST_RUN_STARTED_AT"] = "stats.lastRunStartedAt";
     return ActorListSortBy;
@@ -13846,6 +13855,7 @@ __webpack_require__.r(__webpack_exports__);
  * ```
  *
  * @see https://docs.apify.com/platform/actors/development/programming-interface/environment-variables
+ * @since Added in 2.1.0
  */ class ActorEnvVarClient extends _base_resource_client__rspack_import_0.ResourceClient {
     /**
      * @hidden
@@ -13921,6 +13931,7 @@ __webpack_require__.r(__webpack_exports__);
  * ```
  *
  * @see https://docs.apify.com/platform/actors/development/programming-interface/environment-variables
+ * @since Added in 2.1.0
  */ class ActorEnvVarCollectionClient extends _base_resource_collection_client__rspack_import_0.ResourceCollectionClient {
     /**
      * @hidden
@@ -14042,6 +14053,7 @@ __webpack_require__.r(__webpack_exports__);
      * @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
+     * @since Added in 2.1.0
      */ envVar(envVarName) {
         ow__rspack_import_3_default()(envVarName, (ow__rspack_import_3_default().string));
         return new _actor_env_var__rspack_import_1.ActorEnvVarClient(this._subResourceOptions({
@@ -14053,6 +14065,7 @@ __webpack_require__.r(__webpack_exports__);
      *
      * @returns A client for the Actor version's environment variables.
      * @see https://docs.apify.com/api/v2/act-version-env-vars-get
+     * @since Added in 2.1.0
      */ envVars() {
         return new _actor_env_var_collection__rspack_import_2.ActorEnvVarCollectionClient(this._subResourceOptions());
     }
@@ -14243,6 +14256,7 @@ __webpack_require__.r(__webpack_exports__);
      * Deletes the Actor build.
      *
      * @see https://docs.apify.com/api/v2/actor-build-delete
+     * @since Added in 2.8.1
      */ async delete() {
         return this._delete();
     }
@@ -14251,6 +14265,7 @@ __webpack_require__.r(__webpack_exports__);
      *
      * @returns The OpenAPI definition object.
      * @see https://docs.apify.com/api/v2/actor-build-openapi-json-get
+     * @since Added in 2.11.2
      */ async getOpenApiDefinition() {
         const response = await this.httpClient.call({
             url: this._url('openapi.json'),
@@ -14307,6 +14322,7 @@ __webpack_require__.r(__webpack_exports__);
      * const log = await client.build('build-id').log().get();
      * console.log(log);
      * ```
+     * @since Added in 2.9.0
      */ log() {
         return new _log__rspack_import_2.LogClient(this._subResourceOptions({
             resourcePath: 'log'
@@ -14667,6 +14683,7 @@ __webpack_require__.r(__webpack_exports__);
      *
      * @returns Dataset statistics, or `undefined` if not available
      * @see https://docs.apify.com/api/v2/dataset-statistics-get
+     * @since Added in 2.11.2
      */ async getStatistics() {
         const requestOpts = {
             url: this._url('statistics'),
@@ -14712,6 +14729,7 @@ __webpack_require__.r(__webpack_exports__);
      *   skipEmpty: true
      * });
      * ```
+     * @since Added in 2.13.0
      */ async createItemsPublicUrl() {
         let options = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
         ow__rspack_import_3_default()(options, ow__rspack_import_3_default().object.exactShape({
@@ -15038,6 +15056,7 @@ __webpack_require__.r(__webpack_exports__);
      * console.log(`Public URL: ${url}`);
      * // You can now share this URL or use it in a browser
      * ```
+     * @since Added in 2.14.0
      */ async getRecordPublicUrl(key) {
         ow__rspack_import_4_default()(key, (ow__rspack_import_4_default().string.nonEmpty));
         const store = await this.get();
@@ -15069,6 +15088,7 @@ __webpack_require__.r(__webpack_exports__);
      * });
      * console.log(`Share this URL: ${url}`);
      * ```
+     * @since Added in 2.13.0
      */ async createKeysPublicUrl() {
         let options = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
         ow__rspack_import_4_default()(options, ow__rspack_import_4_default().object.exactShape({
@@ -15108,6 +15128,7 @@ __webpack_require__.r(__webpack_exports__);
      *   console.log('OUTPUT record exists');
      * }
      * ```
+     * @since Added in 2.9.0
      */ async recordExists(key) {
         const requestOpts = {
             url: this._url(`records/${key}`),
@@ -15461,6 +15482,7 @@ __webpack_require__.r(__webpack_exports__);
 }
 /**
  * Logger for redirected actor logs.
+ * @since Added in 2.20.0
  */ class LoggerActorRedirect extends _apify_log__rspack_import_1.Logger {
     constructor(options = {}){
         super({
@@ -15492,6 +15514,7 @@ __webpack_require__.r(__webpack_exports__);
 }
 /**
  * Helper class for redirecting streamed Actor logs to another log.
+ * @since Added in 2.20.0
  */ class StreamedLog {
     destinationLog;
     streamBuffer = [];
@@ -15749,6 +15772,7 @@ const SAFETY_BUFFER_PERCENT = 0.01 / 100; // 0.01%
      *   await client.requestQueue('my-queue').deleteRequestLock(request.id);
      * }
      * ```
+     * @since Added in 2.4.1
      */ async listAndLockHead(options) {
         ow__rspack_import_4_default()(options, ow__rspack_import_4_default().object.exactShape({
             lockSecs: (ow__rspack_import_4_default().number),
@@ -15952,6 +15976,7 @@ const SAFETY_BUFFER_PERCENT = 0.01 / 100; // 0.01%
      *   { maxUnprocessedRequestsRetries: 5, maxParallel: 10 }
      * );
      * ```
+     * @since Added in 2.1.0
      */ async batchAddRequests(requests) {
         let options = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {};
         const { forefront, maxUnprocessedRequestsRetries = DEFAULT_UNPROCESSED_RETRIES_BATCH_ADD_REQUESTS, maxParallel = DEFAULT_PARALLEL_BATCH_ADD_REQUESTS, minDelayBetweenUnprocessedRequestsRetriesMillis = DEFAULT_MIN_DELAY_BETWEEN_UNPROCESSED_REQUESTS_RETRIES_MILLIS } = options;
@@ -16003,6 +16028,7 @@ const SAFETY_BUFFER_PERCENT = 0.01 / 100; // 0.01%
      * @param requests - Array of requests to delete (by id or uniqueKey)
      * @returns Result containing processed and unprocessed requests
      * @see https://docs.apify.com/api/v2/request-queue-requests-batch-delete
+     * @since Added in 2.3.0
      */ async batchDeleteRequests(requests) {
         ow__rspack_import_4_default()(requests, ow__rspack_import_4_default().array.ofType(ow__rspack_import_4_default().any(ow__rspack_import_4_default().object.partialShape({
             id: (ow__rspack_import_4_default().string)
@@ -16107,6 +16133,7 @@ const SAFETY_BUFFER_PERCENT = 0.01 / 100; // 0.01%
      * // Processing takes longer than expected, extend the lock
      * await client.requestQueue('my-queue').prolongRequestLock(request.id, { lockSecs: 120 });
      * ```
+     * @since Added in 2.4.1
      */ async prolongRequestLock(id, options) {
         ow__rspack_import_4_default()(id, (ow__rspack_import_4_default().string));
         ow__rspack_import_4_default()(options, ow__rspack_import_4_default().object.exactShape({
@@ -16134,6 +16161,7 @@ const SAFETY_BUFFER_PERCENT = 0.01 / 100; // 0.01%
      * @param id - Request ID
      * @param options - Options such as whether to move to front
      * @see https://docs.apify.com/api/v2/request-queue-request-lock-delete
+     * @since Added in 2.4.1
      */ async deleteRequestLock(id) {
         let options = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {};
         ow__rspack_import_4_default()(id, (ow__rspack_import_4_default().string));
@@ -16159,6 +16187,7 @@ const SAFETY_BUFFER_PERCENT = 0.01 / 100; // 0.01%
      * @param options - Pagination options
      * @returns List of requests with pagination information
      * @see https://docs.apify.com/api/v2/request-queue-requests-get
+     * @since Added in 2.5.1
      */ listRequests() {
         let options = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
         var _this = this;
@@ -16222,6 +16251,7 @@ const SAFETY_BUFFER_PERCENT = 0.01 / 100; // 0.01%
      *
      * @returns Number of requests that were unlocked
      * @see https://docs.apify.com/api/v2/request-queue-requests-unlock-post
+     * @since Added in 2.12.5
      */ async unlockRequests() {
         const response = await this.httpClient.call({
             url: this._url('requests/unlock'),
@@ -16249,6 +16279,7 @@ const SAFETY_BUFFER_PERCENT = 0.01 / 100; // 0.01%
      *   items.forEach((request) => console.log(request.url));
      * }
      * ```
+     * @since Added in 2.5.1
      */ paginateRequests() {
         let options = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
         ow__rspack_import_4_default()(options, ow__rspack_import_4_default().object.exactShape({
@@ -16475,6 +16506,7 @@ const RUN_CHARGE_IDEMPOTENCY_HEADER = 'idempotency-key';
      * Deletes the Actor run.
      *
      * @see https://docs.apify.com/api/v2/actor-run-delete
+     * @since Added in 2.8.1
      */ async delete() {
         return this._delete();
     }
@@ -16548,6 +16580,7 @@ const RUN_CHARGE_IDEMPOTENCY_HEADER = 'idempotency-key';
      * ```javascript
      * const run = await client.run('run-id').reboot();
      * ```
+     * @since Added in 2.8.0
      */ async reboot() {
         const request = {
             url: this._url('reboot'),
@@ -16572,6 +16605,7 @@ const RUN_CHARGE_IDEMPOTENCY_HEADER = 'idempotency-key';
      *   statusMessage: 'Processing items: 50/100'
      * });
      * ```
+     * @since Added in 2.6.0
      */ async update(newFields) {
         ow__rspack_import_7_default()(newFields, (ow__rspack_import_7_default().object));
         return this._update(newFields);
@@ -16624,6 +16658,7 @@ const RUN_CHARGE_IDEMPOTENCY_HEADER = 'idempotency-key';
      * @param options.idempotencyKey - Optional key to ensure the charge is not duplicated. If not provided, one is auto-generated.
      * @returns Empty response object.
      * @see https://docs.apify.com/api/v2/post-charge-run
+     * @since Added in 2.11.0
      */ async charge(options) {
         ow__rspack_import_7_default()(options, ow__rspack_import_7_default().object.exactShape({
             eventName: (ow__rspack_import_7_default().string),
@@ -16748,6 +16783,7 @@ const RUN_CHARGE_IDEMPOTENCY_HEADER = 'idempotency-key';
     }
     /**
      * Get StreamedLog for convenient streaming of the run log and their redirection.
+     * @since Added in 2.20.0
      */ async getStreamedLog() {
         let options = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
         const { fromStart = true } = options;
@@ -17082,6 +17118,7 @@ __webpack_require__.r(__webpack_exports__);
  * ```
  *
  * @see https://docs.apify.com/platform/actors/publishing
+ * @since Added in 2.7.2
  */ class StoreCollectionClient extends _base_resource_collection_client__rspack_import_0.ResourceCollectionClient {
     /**
      * @hidden
@@ -17206,6 +17243,7 @@ __webpack_require__.r(__webpack_exports__);
      *
      * @returns The task object.
      * @see https://docs.apify.com/api/v2/actor-task-put
+     * @since Added in 2.25.0
      */ async publish() {
         return this.update({
             isPublic: true
@@ -17221,6 +17259,7 @@ __webpack_require__.r(__webpack_exports__);
      *
      * @returns The task object.
      * @see https://docs.apify.com/api/v2/actor-task-put
+     * @since Added in 2.25.0
      */ async unpublish() {
         return this.update({
             isPublic: false
@@ -17546,6 +17585,7 @@ __webpack_require__.r(__webpack_exports__);
      *
      * @returns The monthly usage object, or `undefined` if it does not exist.
      * @see https://docs.apify.com/api/v2/users-me-usage-monthly-get
+     * @since Added in 2.9.2
      */ async monthlyUsage() {
         const requestOpts = {
             url: this._url('usage/monthly'),
@@ -17566,6 +17606,7 @@ __webpack_require__.r(__webpack_exports__);
      *
      * @returns The account and usage limits object, or `undefined` if it does not exist.
      * @see https://docs.apify.com/api/v2/users-me-limits-get
+     * @since Added in 2.9.2
      */ async limits() {
         const requestOpts = {
             url: this._url('limits'),
@@ -17585,6 +17626,7 @@ __webpack_require__.r(__webpack_exports__);
      *
      * @param options - The new limits to set.
      * @see https://docs.apify.com/api/v2/users-me-limits-put
+     * @since Added in 2.10.0
      */ async updateLimits(options) {
         const requestOpts = {
             url: this._url('limits'),
@@ -18153,7 +18195,7 @@ function isStream(value) {
 function getVersionData() {
     if (true) {
         return {
-            version: "2.25.1-beta.1"
+            version: "2.25.1-beta.2"
         };
     }
     // eslint-disable-next-line