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

package/dist/resource_clients/run.js

@@ -100,6 +100,7 @@ class RunClient extends resource_client_1.ResourceClient {
      * 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();
@@ -174,6 +175,7 @@ class RunClient extends resource_client_1.ResourceClient {
      * ```javascript
      * const run = await client.run('run-id').reboot();
      * ```
+     * @since Added in 2.8.0
      */
     async reboot() {
         const request = {
@@ -199,6 +201,7 @@ class RunClient extends resource_client_1.ResourceClient {
      *   statusMessage: 'Processing items: 50/100'
      * });
      * ```
+     * @since Added in 2.6.0
      */
     async update(newFields) {
         (0, ow_1.default)(newFields, ow_1.default.object);
@@ -252,6 +255,7 @@ class RunClient extends resource_client_1.ResourceClient {
      * @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) {
         (0, ow_1.default)(options, ow_1.default.object.exactShape({
@@ -382,6 +386,7 @@ class RunClient extends resource_client_1.ResourceClient {
     }
     /**
      * Get StreamedLog for convenient streaming of the run log and their redirection.
+     * @since Added in 2.20.0
      */
     async getStreamedLog(options = {}) {
         const { fromStart = true } = options;

package/dist/resource_clients/run_collection.d.ts

@@ -54,6 +54,12 @@ export declare class RunCollectionClient extends ResourceCollectionClient {
 export interface RunCollectionListOptions extends PaginationOptions {
     desc?: boolean;
     status?: (typeof ACTOR_JOB_STATUSES)[keyof typeof ACTOR_JOB_STATUSES] | (typeof ACTOR_JOB_STATUSES)[keyof typeof ACTOR_JOB_STATUSES][];
+    /**
+     * @since Added in 2.18.0
+     */
     startedBefore?: Date | string;
+    /**
+     * @since Added in 2.18.0
+     */
     startedAfter?: Date | string;
 }

package/dist/resource_clients/schedule.d.ts

@@ -68,6 +68,9 @@ export interface Schedule {
     id: string;
     userId: string;
     name: string;
+    /**
+     * @since Added in 2.6.1
+     */
     title?: string;
     cronExpression: string;
     timezone: Timezone;
@@ -79,12 +82,16 @@ export interface Schedule {
     nextRunAt: string;
     lastRunAt: string;
     actions: ScheduleAction[];
+    /**
+     * @since Added in 2.9.4
+     */
     notifications: {
         email: boolean;
     };
 }
 /**
  * Data for creating or updating a Schedule.
+ * @since Added in 2.6.2
  */
 export type ScheduleCreateOrUpdateData = Partial<Pick<Schedule, 'name' | 'title' | 'cronExpression' | 'timezone' | 'isEnabled' | 'isExclusive' | 'description' | 'notifications'> & {
     actions: DistributiveOptional<ScheduleAction, 'id'>[];
@@ -126,6 +133,9 @@ export interface ScheduledActorRunOptions {
     build: string;
     timeoutSecs: number;
     memoryMbytes: number;
+    /**
+     * @since Added in 2.19.0
+     */
     restartOnError?: boolean;
 }
 /**

package/dist/resource_clients/store_collection.d.ts

@@ -21,6 +21,7 @@ import type { ActorStats } from './actor';
  * ```
  *
  * @see https://docs.apify.com/platform/actors/publishing
+ * @since Added in 2.7.2
  */
 export declare class StoreCollectionClient extends ResourceCollectionClient {
     /**
@@ -49,9 +50,15 @@ export declare class StoreCollectionClient extends ResourceCollectionClient {
      */
     list(options?: StoreCollectionListOptions): PaginatedIterator<ActorStoreList>;
 }
+/**
+ * @since Added in 2.7.2
+ */
 export interface PricingInfo {
     pricingModel: string;
 }
+/**
+ * @since Added in 2.7.2
+ */
 export interface ActorStoreList {
     id: string;
     name: string;
@@ -62,10 +69,19 @@ export interface ActorStoreList {
     currentPricingInfo: PricingInfo;
     pictureUrl?: string;
     userPictureUrl?: string;
+    /**
+     * @since Added in 2.8.6
+     */
     url: string;
-    /** A brief, LLM-generated readme summary */
+    /**
+     * A brief, LLM-generated readme summary
+     * @since Added in 2.22.1
+     */
     readmeSummary?: string;
 }
+/**
+ * @since Added in 2.7.2
+ */
 export interface StoreCollectionListOptions extends PaginationOptions {
     search?: string;
     sortBy?: string;
@@ -75,6 +91,7 @@ export interface StoreCollectionListOptions extends PaginationOptions {
     /**
      * If true, the response will include Actors that cannot be run (e.g., Actors
      * that require a linked integration account that the current user does not have).
+     * @since Added in 2.23.0
      */
     includeUnrunnableActors?: boolean;
 }

package/dist/resource_clients/store_collection.js

@@ -23,6 +23,7 @@ const resource_collection_client_1 = require("../base/resource_collection_client
  * ```
  *
  * @see https://docs.apify.com/platform/actors/publishing
+ * @since Added in 2.7.2
  */
 class StoreCollectionClient extends resource_collection_client_1.ResourceCollectionClient {
     /**

package/dist/resource_clients/task.d.ts

@@ -55,6 +55,7 @@ export declare class TaskClient extends ResourceClient {
      *
      * @returns The task object.
      * @see https://docs.apify.com/api/v2/actor-task-put
+     * @since Added in 2.25.0
      */
     publish(): Promise<Task>;
     /**
@@ -67,6 +68,7 @@ export declare class TaskClient extends ResourceClient {
      *
      * @returns The task object.
      * @see https://docs.apify.com/api/v2/actor-task-put
+     * @since Added in 2.25.0
      */
     unpublish(): Promise<Task>;
     /**
@@ -161,6 +163,9 @@ export interface Task {
     userId: string;
     actId: string;
     name: string;
+    /**
+     * @since Added in 2.6.1
+     */
     title?: string;
     description?: string;
     username?: string;
@@ -169,12 +174,19 @@ export interface Task {
     stats: TaskStats;
     options?: TaskOptions;
     input?: Dictionary | Dictionary[];
+    /**
+     * @since Added in 2.9.5
+     */
     actorStandby?: Partial<ActorStandby>;
     /**
      * Whether the task is published on its public landing page. Derived from
      * `publicConfig.publishedAt` — set it on update to publish or unpublish the task.
+     * @since Added in 2.25.0
      */
     isPublic?: boolean;
+    /**
+     * @since Added in 2.25.0
+     */
     publicConfig?: TaskPublicConfig | null;
 }
 /**
@@ -183,6 +195,7 @@ export interface Task {
  * The task is published when `publishedAt` is set and unpublished when it is `null`. The
  * `publishedAt` field is read-only - use {@apilink TaskClient.publish} and
  * {@apilink TaskClient.unpublish} to change the publication state.
+ * @since Added in 2.25.0
  */
 export interface TaskPublicConfig {
     publishedAt: Date | null;
@@ -206,6 +219,9 @@ export interface TaskOptions {
     build?: string;
     timeoutSecs?: number;
     memoryMbytes?: number;
+    /**
+     * @since Added in 2.19.0
+     */
     restartOnError?: boolean;
 }
 /**
@@ -224,10 +240,12 @@ export interface TaskLastRunOptions extends ActorLastRunOptions {
  *
  * Similar to {@link ActorStartOptions} but without contentType (Task input is predefined)
  * and forcePermissionLevel.
+ * @since Added in 2.0.4
  */
 export type TaskStartOptions = Omit<ActorStartOptions, 'contentType' | 'forcePermissionLevel'>;
 /**
  * Options for calling a Task and waiting for it to finish.
+ * @since Added in 2.6.2
  */
 export interface TaskCallOptions extends Omit<TaskStartOptions, 'waitForFinish'> {
     waitSecs?: number;

package/dist/resource_clients/task.js

@@ -69,6 +69,7 @@ class TaskClient extends resource_client_1.ResourceClient {
      *
      * @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 });
@@ -83,6 +84,7 @@ class TaskClient extends resource_client_1.ResourceClient {
      *
      * @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 });

package/dist/resource_clients/task_collection.d.ts

@@ -65,6 +65,9 @@ export interface TaskCollectionListOptions extends PaginationOptions {
     desc?: boolean;
 }
 export type TaskList = Omit<Task, 'options' | 'input'>;
+/**
+ * @since Added in 2.3.0
+ */
 export interface TaskCreateData extends TaskUpdateData {
     actId: string;
 }

package/dist/resource_clients/user.d.ts

@@ -44,6 +44,7 @@ export declare class UserClient extends ResourceClient {
      *
      * @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
      */
     monthlyUsage(): Promise<MonthlyUsage | undefined>;
     /**
@@ -51,6 +52,7 @@ export declare class UserClient extends ResourceClient {
      *
      * @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
      */
     limits(): Promise<AccountAndUsageLimits | undefined>;
     /**
@@ -58,6 +60,7 @@ export declare class UserClient extends ResourceClient {
      *
      * @param options - The new limits to set.
      * @see https://docs.apify.com/api/v2/users-me-limits-put
+     * @since Added in 2.10.0
      */
     updateLimits(options: LimitsUpdateOptions): Promise<void>;
 }
@@ -75,8 +78,17 @@ export interface User {
     email?: string;
     proxy?: UserProxy;
     plan?: UserPlan;
+    /**
+     * @since Added in 2.12.5
+     */
     effectivePlatformFeatures?: EffectivePlatformFeatures;
+    /**
+     * @since Added in 2.12.5
+     */
     createdAt?: Date;
+    /**
+     * @since Added in 2.12.5
+     */
     isPaying?: boolean;
 }
 export interface UserProxy {
@@ -138,6 +150,9 @@ interface EffectivePlatformFeatures {
     ACTORS_PUBLIC_ALL: EffectivePlatformFeature;
     ACTORS_PUBLIC_DEVELOPER: EffectivePlatformFeature;
 }
+/**
+ * @since Added in 2.9.2
+ */
 export interface MonthlyUsage {
     usageCycle: UsageCycle;
     monthlyServiceUsage: {
@@ -147,6 +162,9 @@ export interface MonthlyUsage {
     totalUsageCreditsUsdBeforeVolumeDiscount: number;
     totalUsageCreditsUsdAfterVolumeDiscount: number;
 }
+/**
+ * @since Added in 2.9.2
+ */
 export interface UsageCycle {
     startAt: Date;
     endAt: Date;
@@ -178,15 +196,24 @@ interface DailyServiceUsageData {
     quantity: number;
     baseAmountUsd: number;
 }
+/**
+ * @since Added in 2.9.2
+ */
 export interface AccountAndUsageLimits {
     monthlyUsageCycle: MonthlyUsageCycle;
     limits: Limits;
     current: Current;
 }
+/**
+ * @since Added in 2.9.2
+ */
 export interface MonthlyUsageCycle {
     startAt: Date;
     endAt: Date;
 }
+/**
+ * @since Added in 2.9.2
+ */
 export interface Limits {
     maxMonthlyUsageUsd: number;
     maxMonthlyActorComputeUnits: number;
@@ -200,11 +227,17 @@ export interface Limits {
     maxTeamAccountSeatCount: number;
     dataRetentionDays: number;
 }
+/**
+ * @since Added in 2.10.0
+ */
 export type LimitsUpdateOptions = {
     maxMonthlyUsageUsd: number;
 } | {
     dataRetentionDays: number;
 };
+/**
+ * @since Added in 2.9.2
+ */
 export interface Current {
     monthlyUsageUsd: number;
     monthlyActorComputeUnits: number;

package/dist/resource_clients/user.js

@@ -54,6 +54,7 @@ class UserClient extends resource_client_1.ResourceClient {
      *
      * @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 = {
@@ -77,6 +78,7 @@ class UserClient extends resource_client_1.ResourceClient {
      *
      * @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 = {
@@ -98,6 +100,7 @@ class UserClient extends resource_client_1.ResourceClient {
      *
      * @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 = {

package/dist/resource_clients/webhook.d.ts

@@ -92,9 +92,21 @@ export interface Webhook {
     payloadTemplate: string;
     lastDispatch: string;
     stats: WebhookStats;
+    /**
+     * @since Added in 2.7.2
+     */
     shouldInterpolateStrings: boolean;
+    /**
+     * @since Added in 2.9.4
+     */
     isApifyIntegration?: boolean;
+    /**
+     * @since Added in 2.8.1
+     */
     headersTemplate?: string;
+    /**
+     * @since Added in 2.8.1
+     */
     description?: string;
 }
 export interface WebhookIdempotencyKey {

package/dist/resource_clients/webhook_dispatch.d.ts

@@ -41,6 +41,9 @@ export interface WebhookDispatch {
     eventType: WebhookEventType;
     calls: WebhookDispatchCall[];
     webhook: Pick<Webhook, 'requestUrl' | 'isAdHoc'>;
+    /**
+     * @since Added in 2.13.0
+     */
     eventData: WebhookDispatchEventData | null;
 }
 export declare enum WebhookDispatchStatus {
@@ -55,6 +58,9 @@ export interface WebhookDispatchCall {
     responseStatus: number | null;
     responseBody: string | null;
 }
+/**
+ * @since Added in 2.13.0
+ */
 export interface WebhookDispatchEventData {
     actorRunId?: string;
     actorId?: string;

package/dist/utils.d.ts

@@ -99,6 +99,7 @@ export interface PaginationOptions {
      * limit is reached or once all items from API have been fetched.
      *
      * Chunk size is usually limited by API. Minimum of those two limits will be used.
+     * @since Added in 2.21.0
      * */
     chunkSize?: number;
 }
@@ -145,6 +146,7 @@ export declare function asArray<T>(value: T | T[]): T[];
  * Generic dictionary type (key-value map).
  *
  * @template T - The type of values in the dictionary
+ * @since Added in 2.0.4
  */
 export type Dictionary<T = unknown> = Record<PropertyKey, T>;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apify-client",
-  "version": "2.25.1-beta.0",
+  "version": "2.25.1-beta.2",
   "description": "Apify API client for JavaScript",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -81,8 +81,8 @@
     "esbuild": "0.28.2",
     "express": "^5.0.0",
     "gen-esm-wrapper": "^1.1.2",
-    "oxfmt": "0.63.0",
-    "oxlint": "1.77.0",
+    "oxfmt": "0.64.0",
+    "oxlint": "1.78.0",
     "oxlint-tsgolint": "7.0.2001",
     "puppeteer": "^25.0.0",
     "rimraf": "^6.0.0",