apify-client 3.0.0-beta.8 → 3.0.0-rc.0

package/dist/resource_clients/schedule.js

@@ -1,9 +1,10 @@
 import { z } from 'zod';
 import { ResourceClient } from '../base/resource_client.js';
 import * as schemas from '../schemas.js';
-import { anyObjectSchema, catchNotFoundOrThrow, parseArgument, parseResponse } from '../utils.js';
+import { timeoutOptionsSchema } from '../timeouts.js';
+import { anyObjectSchema, parseArgument, parseResponse } from '../utils.js';
 export { ScheduleActions } from '../models.js';
-const scheduleLogSchema = z.array(schemas.ScheduleInvoked());
+const scheduleLogSchema = z.array(schemas.ScheduleLogEntry());
 /**
  * Client for managing a specific Schedule.
  *
@@ -40,50 +41,57 @@ export class ScheduleClient extends ResourceClient {
     /**
      * Retrieves the schedule.
      *
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The schedule object, or `undefined` if it does not exist.
      * @see https://docs.apify.com/api/v2/schedule-get
      */
-    async get() {
-        return this._get(schemas.Schedule());
+    async get(options = {}) {
+        const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.getResource(schemas.Schedule(), {}, timeoutSecs, signal);
     }
     /**
      * Updates the schedule with the specified fields.
      *
      * @param newFields - Fields to update.
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The updated schedule object.
      * @see https://docs.apify.com/api/v2/schedule-put
      */
-    async update(newFields) {
+    async update(newFields, options = {}) {
         parseArgument(newFields, anyObjectSchema);
-        return this._update(schemas.Schedule(), newFields);
+        const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.updateResource(schemas.Schedule(), newFields, timeoutSecs, signal);
     }
     /**
      * Deletes the schedule.
      *
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @see https://docs.apify.com/api/v2/schedule-delete
      */
-    async delete() {
-        return this._delete();
+    async delete(options = {}) {
+        const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.deleteResource(timeoutSecs, signal);
     }
     /**
      * Retrieves the schedule's log.
      *
-     * @returns The schedule log, one entry per invocation, or `undefined` if the schedule does not exist.
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'medium'`.
+     * @returns The schedule log, one entry per invocation.
      * @see https://docs.apify.com/api/v2/schedule-log-get
      */
-    async getLog() {
-        const requestOpts = {
-            url: this._url('log'),
+    async getLog(options = {}) {
+        const { timeoutSecs = 'medium', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        const response = await this.httpClient.call({
+            url: this.buildUrl('log'),
             method: 'GET',
-            params: this._params(),
-        };
-        try {
-            const response = await this.httpClient.call(requestOpts);
-            return parseResponse(response, scheduleLogSchema);
-        }
-        catch (err) {
-            catchNotFoundOrThrow(err);
-        }
-        return undefined;
+            params: this.buildParams(),
+            timeoutSecs,
+            signal,
+        });
+        return parseResponse(response, scheduleLogSchema);
     }
 }

package/dist/resource_clients/schedule_collection.d.ts

@@ -1,5 +1,6 @@
 import type { ApiClientSubResourceOptions } from '../base/api_client.js';
 import { ResourceCollectionClient } from '../base/resource_collection_client.js';
+import type { TimeoutOptions } from '../timeouts.js';
 import type { PaginatedIterator, PaginationOptions } from '../utils.js';
 import type { Schedule, ScheduleCreateOrUpdateData } from './schedule.js';
 /**
@@ -48,6 +49,7 @@ export declare class ScheduleCollectionClient extends ResourceCollectionClient {
      * ```
      *
      * @param options - Pagination and sorting options.
+     * @param options.timeoutSecs - Timeout for each API request. Default is `'medium'`.
      * @returns A paginated iterator of schedules.
      * @see https://docs.apify.com/api/v2/schedules-get
      */
@@ -56,11 +58,13 @@ export declare class ScheduleCollectionClient extends ResourceCollectionClient {
      * Creates a new schedule.
      *
      * @param schedule - The schedule data.
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The created schedule object.
      * @see https://docs.apify.com/api/v2/schedules-post
      */
-    create(schedule?: ScheduleCreateOrUpdateData): Promise<Schedule>;
+    create(schedule?: ScheduleCreateOrUpdateData, options?: TimeoutOptions): Promise<Schedule>;
 }
-export interface ScheduleCollectionListOptions extends PaginationOptions {
+export interface ScheduleCollectionListOptions extends PaginationOptions, TimeoutOptions {
     desc?: boolean;
 }

package/dist/resource_clients/schedule_collection.js

@@ -1,10 +1,12 @@
 import { z } from 'zod';
 import { ResourceCollectionClient } from '../base/resource_collection_client.js';
 import * as schemas from '../schemas.js';
+import { timeoutOptionsSchema, timeoutOptionsShape } from '../timeouts.js';
 import { anyObjectSchema, paginationOptionsShape, parseArgument } from '../utils.js';
 const listOptionsSchema = z.strictObject({
     ...paginationOptionsShape,
     desc: z.boolean().optional(),
+    ...timeoutOptionsShape,
 });
 const scheduleCreateSchema = anyObjectSchema.optional();
 /**
@@ -58,22 +60,26 @@ export class ScheduleCollectionClient extends ResourceCollectionClient {
      * ```
      *
      * @param options - Pagination and sorting options.
+     * @param options.timeoutSecs - Timeout for each API request. Default is `'medium'`.
      * @returns A paginated iterator of schedules.
      * @see https://docs.apify.com/api/v2/schedules-get
      */
     list(options = {}) {
         const parsed = parseArgument(options, listOptionsSchema, 'ScheduleCollectionListOptions');
-        return this._listPaginated(schemas.ListOfSchedules(), parsed);
+        return this.listResourcesPaginated(schemas.ListOfSchedules(), parsed, 'medium');
     }
     /**
      * Creates a new schedule.
      *
      * @param schedule - The schedule data.
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The created schedule object.
      * @see https://docs.apify.com/api/v2/schedules-post
      */
-    async create(schedule) {
+    async create(schedule, options = {}) {
         parseArgument(schedule, scheduleCreateSchema);
-        return this._create(schemas.Schedule(), schedule);
+        const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.createResource(schemas.Schedule(), schedule, timeoutSecs, signal);
     }
 }

package/dist/resource_clients/store_collection.d.ts

@@ -1,8 +1,9 @@
 import type { ApiClientSubResourceOptions } from '../base/api_client.js';
 import { ResourceCollectionClient } from '../base/resource_collection_client.js';
-import type { ActorStoreList } from '../models.js';
+import type { StoreActor } from '../models.js';
+import type { TimeoutOptions } from '../timeouts.js';
 import type { PaginatedIterator, PaginationOptions } from '../utils.js';
-export type { ActorStoreList, PricingInfo } from '../models.js';
+export type { CurrentPricingInfo, StoreActor } from '../models.js';
 /**
  * Client for browsing Actors in the Apify Store.
  *
@@ -46,15 +47,16 @@ export declare class StoreCollectionClient extends ResourceCollectionClient {
      * ```
      *
      * @param options - Search and pagination options.
+     * @param options.timeoutSecs - Timeout for each API request. Default is `'medium'`.
      * @returns A paginated iterator of store Actors.
      * @see https://docs.apify.com/api/v2/store-get
      */
-    list(options?: StoreCollectionListOptions): PaginatedIterator<ActorStoreList>;
+    list(options?: StoreCollectionListOptions): PaginatedIterator<StoreActor>;
 }
 /**
  * @since Added in 2.7.2
  */
-export interface StoreCollectionListOptions extends PaginationOptions {
+export interface StoreCollectionListOptions extends PaginationOptions, TimeoutOptions {
     search?: string;
     sortBy?: string;
     category?: string;

package/dist/resource_clients/store_collection.js

@@ -1,6 +1,7 @@
 import { z } from 'zod';
 import { ResourceCollectionClient } from '../base/resource_collection_client.js';
 import * as schemas from '../schemas.js';
+import { timeoutOptionsShape } from '../timeouts.js';
 import { paginationOptionsShape, parseArgument } from '../utils.js';
 const listOptionsSchema = z.strictObject({
     ...paginationOptionsShape,
@@ -10,6 +11,7 @@ const listOptionsSchema = z.strictObject({
     username: z.string().optional(),
     pricingModel: z.string().optional(),
     includeUnrunnableActors: z.boolean().optional(),
+    ...timeoutOptionsShape,
 });
 /**
  * Client for browsing Actors in the Apify Store.
@@ -59,11 +61,12 @@ export class StoreCollectionClient extends ResourceCollectionClient {
      * ```
      *
      * @param options - Search and pagination options.
+     * @param options.timeoutSecs - Timeout for each API request. Default is `'medium'`.
      * @returns A paginated iterator of store Actors.
      * @see https://docs.apify.com/api/v2/store-get
      */
     list(options = {}) {
         const parsed = parseArgument(options, listOptionsSchema, 'StoreCollectionListOptions');
-        return this._listPaginated(schemas.ListOfStoreActors(), parsed);
+        return this.listResourcesPaginated(schemas.ListOfStoreActors(), parsed, 'medium');
     }
 }

package/dist/resource_clients/task.d.ts

@@ -1,8 +1,9 @@
 import type { ApiClientSubResourceOptions } from '../base/api_client.js';
 import { ResourceClient } from '../base/resource_client.js';
 import type { Task, TaskPublicConfig } from '../models.js';
+import type { TimeoutOptions } from '../timeouts.js';
 import type { Dictionary } from '../utils.js';
-import type { ActorLastRunOptions, ActorRun, ActorStartOptions } from './actor.js';
+import type { ActorLastRunOptions, ActorStartOptions, Run } from './actor.js';
 import { RunClient } from './run.js';
 import { RunCollectionClient } from './run_collection.js';
 import { WebhookCollectionClient } from './webhook_collection.js';
@@ -35,18 +36,22 @@ export declare class TaskClient extends ResourceClient {
     /**
      * Retrieves the Actor task.
      *
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The task object, or `undefined` if it does not exist.
      * @see https://docs.apify.com/api/v2/actor-task-get
      */
-    get(): Promise<Task | undefined>;
+    get(options?: TimeoutOptions): Promise<Task | undefined>;
     /**
      * Updates the task with the specified fields.
      *
      * @param newFields - Fields to update.
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The updated task object.
      * @see https://docs.apify.com/api/v2/actor-task-put
      */
-    update(newFields: TaskUpdateData): Promise<Task>;
+    update(newFields: TaskUpdateData, options?: TimeoutOptions): Promise<Task>;
     /**
      * Publishes the task on its public landing page, by setting `isPublic` through
      * {@apilink TaskClient.update}.
@@ -55,11 +60,13 @@ export declare class TaskClient extends ResourceClient {
      * (`publicConfig`) set up first. Requires write permission to both the task and its Actor.
      * Publishing an already published task does nothing.
      *
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The task object.
      * @see https://docs.apify.com/api/v2/actor-task-put
      * @since Added in 2.25.0
      */
-    publish(): Promise<Task>;
+    publish(options?: TimeoutOptions): Promise<Task>;
     /**
      * Unpublishes the task from its public landing page, by setting `isPublic` through
      * {@apilink TaskClient.update}.
@@ -68,17 +75,21 @@ export declare class TaskClient extends ResourceClient {
      * published again without re-entering it. Requires write permission to both the task and its
      * Actor. Unpublishing a task that is not published does nothing.
      *
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The task object.
      * @see https://docs.apify.com/api/v2/actor-task-put
      * @since Added in 2.25.0
      */
-    unpublish(): Promise<Task>;
+    unpublish(options?: TimeoutOptions): Promise<Task>;
     /**
      * Deletes the Task.
      *
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @see https://docs.apify.com/api/v2/actor-task-delete
      */
-    delete(): Promise<void>;
+    delete(options?: TimeoutOptions): Promise<void>;
     /**
      * Starts an Actor task and immediately returns the Run object.
      *
@@ -86,16 +97,20 @@ export declare class TaskClient extends ResourceClient {
      * @param options - Run options.
      * @param options.build - Tag or number of the Actor build to run (e.g., `'beta'` or `'1.2.345'`).
      * @param options.memory - Memory in megabytes allocated for the run.
-     * @param options.timeout - Timeout for the run in seconds. Zero means no timeout.
+     * @param options.runTimeoutSecs - Timeout for the run in seconds. Zero means no timeout.
      * @param options.waitForFinish - Maximum time to wait (in seconds, max 60s) for the run to finish before returning.
      * @param options.webhooks - Webhooks to trigger for specific Actor run events.
      * @param options.maxItems - Maximum number of dataset items (for pay-per-result Actors).
      * @param options.maxTotalChargeUsd - Maximum cost in USD (for pay-per-event Actors).
      * @param options.restartOnError - Whether to restart the run on error.
+     * @param options.waitForResources - Retry the start while the account lacks the memory or a concurrent-run slot for
+     * the run. `true` retries until the run starts, a number stops retrying after that many seconds.
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'medium'`, extended to cover `waitForFinish`
+     * when the API is asked to hold the response.
      * @returns The Actor Run object.
      * @see https://docs.apify.com/api/v2/actor-task-runs-post
      */
-    start(input?: Dictionary, options?: TaskStartOptions): Promise<ActorRun>;
+    start(input?: Dictionary, options?: TaskStartOptions): Promise<Run>;
     /**
      * Starts a task and waits for it to finish before returning the Run object.
      * It waits indefinitely, unless the `waitSecs` option is provided.
@@ -104,31 +119,39 @@ export declare class TaskClient extends ResourceClient {
      * @param options - Run and wait options.
      * @param options.build - Tag or number of the Actor build to run.
      * @param options.memory - Memory in megabytes allocated for the run.
-     * @param options.timeout - Timeout for the run in seconds.
+     * @param options.runTimeoutSecs - Timeout for the run in seconds.
      * @param options.waitSecs - Maximum time to wait for the run to finish, in seconds. If omitted, waits indefinitely.
      * @param options.webhooks - Webhooks to trigger for specific Actor run events.
      * @param options.maxItems - Maximum number of dataset items (for pay-per-result Actors).
      * @param options.maxTotalChargeUsd - Maximum cost in USD (for pay-per-event Actors).
      * @param options.restartOnError - Whether to restart the run on error.
+     * @param options.waitForResources - Retry the start while the account lacks the memory or a concurrent-run slot for
+     * the run. `true` retries until the run starts, a number stops retrying after that many seconds. The time spent
+     * retrying doesn't count toward `waitSecs`.
+     * @param options.timeoutSecs - Timeout for each API request, the start and every poll alike. Default is `'noTimeout'`.
      * @returns The Actor run object.
      * @see https://docs.apify.com/api/v2/actor-task-runs-post
      */
-    call(input?: Dictionary, options?: TaskCallOptions): Promise<ActorRun>;
+    call(input?: Dictionary, options?: TaskCallOptions): Promise<Run>;
     /**
      * Retrieves the Actor task's input object.
      *
-     * @returns The Task's input, or `undefined` if it does not exist.
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
+     * @returns The Task's input.
      * @see https://docs.apify.com/api/v2/actor-task-input-get
      */
-    getInput(): Promise<Dictionary | Dictionary[] | undefined>;
+    getInput(options?: TimeoutOptions): Promise<Dictionary | Dictionary[]>;
     /**
      * Updates the Actor task's input object.
      *
      * @param newFields - New input data for the task.
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The updated task input.
      * @see https://docs.apify.com/api/v2/actor-task-input-put
      */
-    updateInput(newFields: Dictionary | Dictionary[]): Promise<Dictionary | Dictionary[]>;
+    updateInput(newFields: Dictionary | Dictionary[], options?: TimeoutOptions): Promise<Dictionary | Dictionary[]>;
     /**
      * Returns a client for the last run of this task.
      *