apify-client 2.25.1-beta.8 → 3.0.0-beta.1

package/dist/resource_clients/schedule.d.ts

@@ -1,7 +1,9 @@
 import type { ApiClientSubResourceOptions } from '../base/api_client';
 import { ResourceClient } from '../base/resource_client';
-import type { Timezone } from '../timezones';
+import type { Schedule, ScheduleAction } from '../models';
 import type { DistributiveOptional } from '../utils';
+export type { Schedule, ScheduleAction, ScheduleActionRunActor, ScheduleActionRunActorTask, ScheduledActorRunInput, ScheduledActorRunOptions, } from '../models';
+export { ScheduleActions } from '../models';
 /**
  * Client for managing a specific Schedule.
  *
@@ -59,36 +61,6 @@ export declare class ScheduleClient extends ResourceClient {
      */
     getLog(): Promise<string | undefined>;
 }
-/**
- * Represents a schedule for automated Actor or Task runs.
- *
- * Schedules use cron expressions to define when Actors or Tasks should run automatically.
- */
-export interface Schedule {
-    id: string;
-    userId: string;
-    name: string;
-    /**
-     * @since Added in 2.6.1
-     */
-    title?: string;
-    cronExpression: string;
-    timezone: Timezone;
-    isEnabled: boolean;
-    isExclusive: boolean;
-    description?: string;
-    createdAt: Date;
-    modifiedAt: Date;
-    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
@@ -96,53 +68,3 @@ export interface Schedule {
 export type ScheduleCreateOrUpdateData = Partial<Pick<Schedule, 'name' | 'title' | 'cronExpression' | 'timezone' | 'isEnabled' | 'isExclusive' | 'description' | 'notifications'> & {
     actions: DistributiveOptional<ScheduleAction, 'id'>[];
 }>;
-/**
- * Types of actions that can be scheduled.
- */
-export declare enum ScheduleActions {
-    RunActor = "RUN_ACTOR",
-    RunActorTask = "RUN_ACTOR_TASK"
-}
-interface BaseScheduleAction<Type extends ScheduleActions> {
-    id: string;
-    type: Type;
-}
-/**
- * Union type representing all possible scheduled actions.
- */
-export type ScheduleAction = ScheduleActionRunActor | ScheduleActionRunActorTask;
-/**
- * Scheduled action to run an Actor.
- */
-export interface ScheduleActionRunActor extends BaseScheduleAction<ScheduleActions.RunActor> {
-    actorId: string;
-    runInput?: ScheduledActorRunInput;
-    runOptions?: ScheduledActorRunOptions;
-}
-/**
- * Input configuration for a scheduled Actor run.
- */
-export interface ScheduledActorRunInput {
-    body: string;
-    contentType: string;
-}
-/**
- * Run options for a scheduled Actor run.
- */
-export interface ScheduledActorRunOptions {
-    build: string;
-    timeoutSecs: number;
-    memoryMbytes: number;
-    /**
-     * @since Added in 2.19.0
-     */
-    restartOnError?: boolean;
-}
-/**
- * Scheduled action to run an Actor task.
- */
-export interface ScheduleActionRunActorTask extends BaseScheduleAction<ScheduleActions.RunActorTask> {
-    actorTaskId: string;
-    input?: string;
-}
-export {};

package/dist/resource_clients/schedule.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ScheduleActions = exports.ScheduleClient = void 0;
-const tslib_1 = require("tslib");
-const ow_1 = tslib_1.__importDefault(require("ow"));
+exports.ScheduleClient = exports.ScheduleActions = void 0;
 const resource_client_1 = require("../base/resource_client");
 const utils_1 = require("../utils");
+var models_1 = require("../models");
+Object.defineProperty(exports, "ScheduleActions", { enumerable: true, get: function () { return models_1.ScheduleActions; } });
 /**
  * Client for managing a specific Schedule.
  *
@@ -55,7 +55,7 @@ class ScheduleClient extends resource_client_1.ResourceClient {
      * @see https://docs.apify.com/api/v2/schedule-put
      */
     async update(newFields) {
-        (0, ow_1.default)(newFields, ow_1.default.object);
+        (0, utils_1.parseArgument)(newFields, utils_1.anyObjectSchema);
         return this._update(newFields);
     }
     /**
@@ -89,11 +89,3 @@ class ScheduleClient extends resource_client_1.ResourceClient {
     }
 }
 exports.ScheduleClient = ScheduleClient;
-/**
- * Types of actions that can be scheduled.
- */
-var ScheduleActions;
-(function (ScheduleActions) {
-    ScheduleActions["RunActor"] = "RUN_ACTOR";
-    ScheduleActions["RunActorTask"] = "RUN_ACTOR_TASK";
-})(ScheduleActions || (exports.ScheduleActions = ScheduleActions = {}));

package/dist/resource_clients/schedule_collection.js

@@ -1,9 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ScheduleCollectionClient = void 0;
-const tslib_1 = require("tslib");
-const ow_1 = tslib_1.__importDefault(require("ow"));
+const zod_1 = require("zod");
 const resource_collection_client_1 = require("../base/resource_collection_client");
+const utils_1 = require("../utils");
+const listOptionsSchema = zod_1.z.strictObject({
+    ...utils_1.paginationOptionsShape,
+    desc: zod_1.z.boolean().optional(),
+});
+const scheduleCreateSchema = utils_1.anyObjectSchema.optional();
 /**
  * Client for managing the collection of Schedules in your account.
  *
@@ -59,12 +64,8 @@ class ScheduleCollectionClient extends resource_collection_client_1.ResourceColl
      * @see https://docs.apify.com/api/v2/schedules-get
      */
     list(options = {}) {
-        (0, ow_1.default)(options, ow_1.default.object.exactShape({
-            limit: ow_1.default.optional.number.not.negative,
-            offset: ow_1.default.optional.number.not.negative,
-            desc: ow_1.default.optional.boolean,
-        }));
-        return this._listPaginated(options);
+        const parsed = (0, utils_1.parseArgument)(options, listOptionsSchema, 'ScheduleCollectionListOptions');
+        return this._listPaginated(parsed);
     }
     /**
      * Creates a new schedule.
@@ -74,7 +75,7 @@ class ScheduleCollectionClient extends resource_collection_client_1.ResourceColl
      * @see https://docs.apify.com/api/v2/schedules-post
      */
     async create(schedule) {
-        (0, ow_1.default)(schedule, ow_1.default.optional.object);
+        (0, utils_1.parseArgument)(schedule, scheduleCreateSchema);
         return this._create(schedule);
     }
 }

package/dist/resource_clients/store_collection.d.ts

@@ -1,7 +1,8 @@
 import type { ApiClientSubResourceOptions } from '../base/api_client';
 import { ResourceCollectionClient } from '../base/resource_collection_client';
+import type { ActorStoreList } from '../models';
 import type { PaginatedIterator, PaginationOptions } from '../utils';
-import type { ActorStats } from './actor';
+export type { ActorStoreList, PricingInfo } from '../models';
 /**
  * Client for browsing Actors in the Apify Store.
  *
@@ -50,35 +51,6 @@ 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;
-    username: string;
-    title?: string;
-    description?: string;
-    stats: ActorStats;
-    currentPricingInfo: PricingInfo;
-    pictureUrl?: string;
-    userPictureUrl?: string;
-    /**
-     * @since Added in 2.8.6
-     */
-    url: string;
-    /**
-     * A brief, LLM-generated readme summary
-     * @since Added in 2.22.1
-     */
-    readmeSummary?: string;
-}
 /**
  * @since Added in 2.7.2
  */

package/dist/resource_clients/store_collection.js

@@ -1,9 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StoreCollectionClient = void 0;
-const tslib_1 = require("tslib");
-const ow_1 = tslib_1.__importDefault(require("ow"));
+const zod_1 = require("zod");
 const resource_collection_client_1 = require("../base/resource_collection_client");
+const utils_1 = require("../utils");
+const listOptionsSchema = zod_1.z.strictObject({
+    ...utils_1.paginationOptionsShape,
+    search: zod_1.z.string().optional(),
+    sortBy: zod_1.z.string().optional(),
+    category: zod_1.z.string().optional(),
+    username: zod_1.z.string().optional(),
+    pricingModel: zod_1.z.string().optional(),
+    includeUnrunnableActors: zod_1.z.boolean().optional(),
+});
 /**
  * Client for browsing Actors in the Apify Store.
  *
@@ -56,17 +65,8 @@ class StoreCollectionClient extends resource_collection_client_1.ResourceCollect
      * @see https://docs.apify.com/api/v2/store-get
      */
     list(options = {}) {
-        (0, ow_1.default)(options, ow_1.default.object.exactShape({
-            limit: ow_1.default.optional.number.not.negative,
-            offset: ow_1.default.optional.number.not.negative,
-            search: ow_1.default.optional.string,
-            sortBy: ow_1.default.optional.string,
-            category: ow_1.default.optional.string,
-            username: ow_1.default.optional.string,
-            pricingModel: ow_1.default.optional.string,
-            includeUnrunnableActors: ow_1.default.optional.boolean,
-        }));
-        return this._listPaginated(options);
+        const parsed = (0, utils_1.parseArgument)(options, listOptionsSchema, 'StoreCollectionListOptions');
+        return this._listPaginated(parsed);
     }
 }
 exports.StoreCollectionClient = StoreCollectionClient;

package/dist/resource_clients/task.d.ts

@@ -1,10 +1,12 @@
 import type { ApiClientSubResourceOptions } from '../base/api_client';
 import { ResourceClient } from '../base/resource_client';
+import type { Task, TaskPublicConfig } from '../models';
 import type { Dictionary } from '../utils';
-import type { ActorLastRunOptions, ActorRun, ActorStandby, ActorStartOptions } from './actor';
+import type { ActorLastRunOptions, ActorRun, ActorStartOptions } from './actor';
 import { RunClient } from './run';
 import { RunCollectionClient } from './run_collection';
 import { WebhookCollectionClient } from './webhook_collection';
+export type { Task, TaskOptions, TaskPublicConfig, TaskStats } from '../models';
 /**
  * Client for managing a specific Actor task.
  *
@@ -152,78 +154,6 @@ export declare class TaskClient extends ResourceClient {
      */
     webhooks(): WebhookCollectionClient;
 }
-/**
- * Represents an Actor task.
- *
- * Tasks are saved Actor configurations with input and settings that can be executed
- * repeatedly without having to specify the full input each time.
- */
-export interface Task {
-    id: string;
-    userId: string;
-    actId: string;
-    name: string;
-    /**
-     * @since Added in 2.6.1
-     */
-    title?: string;
-    description?: string;
-    username?: string;
-    createdAt: Date;
-    modifiedAt: Date;
-    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;
-}
-/**
- * Public-facing display configuration of a task's public landing page.
- *
- * 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;
-    seoTitle?: string | null;
-    seoDescription?: string | null;
-    categorization?: string | null;
-    inputSchemaFields?: string[] | null;
-    datasetName?: string | null;
-    datasetView?: string | null;
-}
-/**
- * Statistics about Actor task usage.
- */
-export interface TaskStats {
-    totalRuns: number;
-}
-/**
- * Configuration options for an Actor task.
- */
-export interface TaskOptions {
-    build?: string;
-    timeoutSecs?: number;
-    memoryMbytes?: number;
-    /**
-     * @since Added in 2.19.0
-     */
-    restartOnError?: boolean;
-}
 /**
  * Fields that can be updated when modifying a Task.
  */

package/dist/resource_clients/task.js

@@ -1,14 +1,38 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TaskClient = void 0;
-const tslib_1 = require("tslib");
-const ow_1 = tslib_1.__importDefault(require("ow"));
+const zod_1 = require("zod");
 const consts_1 = require("@apify/consts");
 const resource_client_1 = require("../base/resource_client");
 const utils_1 = require("../utils");
 const run_1 = require("./run");
 const run_collection_1 = require("./run_collection");
 const webhook_collection_1 = require("./webhook_collection");
+const inputSchema = utils_1.anyObjectSchema.optional();
+const startOptionsSchema = zod_1.z.strictObject({
+    build: zod_1.z.string().optional(),
+    memory: zod_1.z.number().optional(),
+    timeout: zod_1.z.number().optional(),
+    waitForFinish: zod_1.z.number().optional(),
+    webhooks: zod_1.z.array(utils_1.anyObjectSchema).optional(),
+    maxItems: zod_1.z.number().min(0).optional(),
+    maxTotalChargeUsd: zod_1.z.number().min(0).optional(),
+    restartOnError: zod_1.z.boolean().optional(),
+});
+const callOptionsSchema = zod_1.z.strictObject({
+    build: zod_1.z.string().optional(),
+    memory: zod_1.z.number().optional(),
+    timeout: zod_1.z.number().min(0).optional(),
+    waitSecs: zod_1.z.number().min(0).optional(),
+    webhooks: zod_1.z.array(utils_1.anyObjectSchema).optional(),
+    maxItems: zod_1.z.number().min(0).optional(),
+    maxTotalChargeUsd: zod_1.z.number().min(0).optional(),
+    restartOnError: zod_1.z.boolean().optional(),
+});
+const lastRunOptionsSchema = zod_1.z.strictObject({
+    status: zod_1.z.enum(consts_1.ACT_JOB_STATUSES).optional(),
+    origin: zod_1.z.enum(consts_1.META_ORIGINS).optional(),
+});
 /**
  * Client for managing a specific Actor task.
  *
@@ -56,7 +80,7 @@ class TaskClient extends resource_client_1.ResourceClient {
      * @see https://docs.apify.com/api/v2/actor-task-put
      */
     async update(newFields) {
-        (0, ow_1.default)(newFields, ow_1.default.object);
+        (0, utils_1.parseArgument)(newFields, utils_1.anyObjectSchema);
         return this._update(newFields);
     }
     /**
@@ -114,24 +138,15 @@ class TaskClient extends resource_client_1.ResourceClient {
      * @see https://docs.apify.com/api/v2/actor-task-runs-post
      */
     async start(input, options = {}) {
-        (0, ow_1.default)(input, ow_1.default.optional.object);
-        (0, ow_1.default)(options, ow_1.default.object.exactShape({
-            build: ow_1.default.optional.string,
-            memory: ow_1.default.optional.number,
-            timeout: ow_1.default.optional.number,
-            waitForFinish: ow_1.default.optional.number,
-            webhooks: ow_1.default.optional.array.ofType(ow_1.default.object),
-            maxItems: ow_1.default.optional.number.not.negative,
-            maxTotalChargeUsd: ow_1.default.optional.number.not.negative,
-            restartOnError: ow_1.default.optional.boolean,
-        }));
-        const { waitForFinish, timeout, memory, build, maxItems, maxTotalChargeUsd, restartOnError } = options;
+        (0, utils_1.parseArgument)(input, inputSchema);
+        const parsed = (0, utils_1.parseArgument)(options, startOptionsSchema, 'TaskStartOptions');
+        const { waitForFinish, timeout, memory, build, maxItems, maxTotalChargeUsd, restartOnError } = parsed;
         const params = {
             waitForFinish,
             timeout,
             memory,
             build,
-            webhooks: (0, utils_1.stringifyWebhooksToBase64)(options.webhooks),
+            webhooks: (0, utils_1.stringifyWebhooksToBase64)(parsed.webhooks),
             maxItems,
             maxTotalChargeUsd,
             restartOnError,
@@ -169,18 +184,9 @@ class TaskClient extends resource_client_1.ResourceClient {
      * @see https://docs.apify.com/api/v2/actor-task-runs-post
      */
     async call(input, options = {}) {
-        (0, ow_1.default)(input, ow_1.default.optional.object);
-        (0, ow_1.default)(options, ow_1.default.object.exactShape({
-            build: ow_1.default.optional.string,
-            memory: ow_1.default.optional.number,
-            timeout: ow_1.default.optional.number.not.negative,
-            waitSecs: ow_1.default.optional.number.not.negative,
-            webhooks: ow_1.default.optional.array.ofType(ow_1.default.object),
-            maxItems: ow_1.default.optional.number.not.negative,
-            maxTotalChargeUsd: ow_1.default.optional.number.not.negative,
-            restartOnError: ow_1.default.optional.boolean,
-        }));
-        const { waitSecs, ...startOptions } = options;
+        (0, utils_1.parseArgument)(input, inputSchema);
+        const parsed = (0, utils_1.parseArgument)(options, callOptionsSchema, 'TaskCallOptions');
+        const { waitSecs, ...startOptions } = parsed;
         const { id } = await this.start(input, startOptions);
         // Calling root client because we need access to top level API.
         // Creating a new instance of RunClient here would only allow
@@ -234,13 +240,10 @@ class TaskClient extends resource_client_1.ResourceClient {
      * @see https://docs.apify.com/api/v2/actor-task-runs-last-get
      */
     lastRun(options = {}) {
-        (0, ow_1.default)(options, ow_1.default.object.exactShape({
-            status: ow_1.default.optional.string.oneOf(Object.values(consts_1.ACT_JOB_STATUSES)),
-            origin: ow_1.default.optional.string.oneOf(Object.values(consts_1.META_ORIGINS)),
-        }));
+        const parsed = (0, utils_1.parseArgument)(options, lastRunOptionsSchema, 'TaskLastRunOptions');
         return new run_1.RunClient(this._subResourceOptions({
             id: 'last',
-            params: this._params(options),
+            params: this._params(parsed),
             resourcePath: 'runs',
         }));
     }

package/dist/resource_clients/task_collection.d.ts

@@ -1,7 +1,9 @@
 import type { ApiClientSubResourceOptions } from '../base/api_client';
 import { ResourceCollectionClient } from '../base/resource_collection_client';
+import type { TaskList } from '../models';
 import type { PaginatedIterator, PaginationOptions } from '../utils';
 import type { Task, TaskUpdateData } from './task';
+export type { TaskList } from '../models';
 /**
  * Client for managing the collection of Actor tasks in your account.
  *
@@ -64,7 +66,6 @@ export declare class TaskCollectionClient extends ResourceCollectionClient {
 export interface TaskCollectionListOptions extends PaginationOptions {
     desc?: boolean;
 }
-export type TaskList = Omit<Task, 'options' | 'input'>;
 /**
  * @since Added in 2.3.0
  */

package/dist/resource_clients/task_collection.js

@@ -1,9 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TaskCollectionClient = void 0;
-const tslib_1 = require("tslib");
-const ow_1 = tslib_1.__importDefault(require("ow"));
+const zod_1 = require("zod");
 const resource_collection_client_1 = require("../base/resource_collection_client");
+const utils_1 = require("../utils");
+const listOptionsSchema = zod_1.z.strictObject({
+    ...utils_1.paginationOptionsShape,
+    desc: zod_1.z.boolean().optional(),
+});
 /**
  * Client for managing the collection of Actor tasks in your account.
  *
@@ -59,12 +63,8 @@ class TaskCollectionClient extends resource_collection_client_1.ResourceCollecti
      * @see https://docs.apify.com/api/v2/actor-tasks-get
      */
     list(options = {}) {
-        (0, ow_1.default)(options, ow_1.default.object.exactShape({
-            limit: ow_1.default.optional.number.not.negative,
-            offset: ow_1.default.optional.number.not.negative,
-            desc: ow_1.default.optional.boolean,
-        }));
-        return this._listPaginated(options);
+        const parsed = (0, utils_1.parseArgument)(options, listOptionsSchema, 'TaskCollectionListOptions');
+        return this._listPaginated(parsed);
     }
     /**
      * Creates a new task.
@@ -74,7 +74,7 @@ class TaskCollectionClient extends resource_collection_client_1.ResourceCollecti
      * @see https://docs.apify.com/api/v2/actor-tasks-post
      */
     async create(task) {
-        (0, ow_1.default)(task, ow_1.default.object);
+        (0, utils_1.parseArgument)(task, utils_1.anyObjectSchema);
         return this._create(task);
     }
 }