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

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 { Dictionary } from '../utils';
-import type { ActorLastRunOptions, ActorRun, ActorStandby, ActorStartOptions } from './actor';
-import { RunClient } from './run';
-import { RunCollectionClient } from './run_collection';
-import { WebhookCollectionClient } from './webhook_collection';
+import type { ApiClientSubResourceOptions } from '../base/api_client.js';
+import { ResourceClient } from '../base/resource_client.js';
+import type { Task, TaskPublicConfig } from '../models.js';
+import type { Dictionary } from '../utils.js';
+import type { ActorLastRunOptions, ActorRun, ActorStartOptions } from './actor.js';
+import { RunClient } from './run.js';
+import { RunCollectionClient } from './run_collection.js';
+import { WebhookCollectionClient } from './webhook_collection.js';
+export type { Task, TaskOptions, TaskPublicConfig, TaskStats } from '../models.js';
 /**
  * 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,37 +1,34 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TaskClient = void 0;
-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(),
+import { z } from 'zod';
+import { ACT_JOB_STATUSES, META_ORIGINS } from '@apify/consts';
+import { ResourceClient } from '../base/resource_client.js';
+import { anyObjectSchema, cast, catchNotFoundOrThrow, parseArgument, parseDateFields, pluckData, stringifyWebhooksToBase64, } from '../utils.js';
+import { RunClient } from './run.js';
+import { RunCollectionClient } from './run_collection.js';
+import { WebhookCollectionClient } from './webhook_collection.js';
+const inputSchema = anyObjectSchema.optional();
+const startOptionsSchema = z.strictObject({
+    build: z.string().optional(),
+    memory: z.number().optional(),
+    timeout: z.number().optional(),
+    waitForFinish: z.number().optional(),
+    webhooks: z.array(anyObjectSchema).optional(),
+    maxItems: z.number().min(0).optional(),
+    maxTotalChargeUsd: z.number().min(0).optional(),
+    restartOnError: 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 callOptionsSchema = z.strictObject({
+    build: z.string().optional(),
+    memory: z.number().optional(),
+    timeout: z.number().min(0).optional(),
+    waitSecs: z.number().min(0).optional(),
+    webhooks: z.array(anyObjectSchema).optional(),
+    maxItems: z.number().min(0).optional(),
+    maxTotalChargeUsd: z.number().min(0).optional(),
+    restartOnError: 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(),
+const lastRunOptionsSchema = z.strictObject({
+    status: z.enum(ACT_JOB_STATUSES).optional(),
+    origin: z.enum(META_ORIGINS).optional(),
 });
 /**
  * Client for managing a specific Actor task.
@@ -53,7 +50,7 @@ const lastRunOptionsSchema = zod_1.z.strictObject({
  *
  * @see https://docs.apify.com/platform/actors/running/tasks
  */
-class TaskClient extends resource_client_1.ResourceClient {
+export class TaskClient extends ResourceClient {
     /**
      * @hidden
      */
@@ -80,7 +77,7 @@ class TaskClient extends resource_client_1.ResourceClient {
      * @see https://docs.apify.com/api/v2/actor-task-put
      */
     async update(newFields) {
-        (0, utils_1.parseArgument)(newFields, utils_1.anyObjectSchema);
+        parseArgument(newFields, anyObjectSchema);
         return this._update(newFields);
     }
     /**
@@ -138,15 +135,15 @@ class TaskClient extends resource_client_1.ResourceClient {
      * @see https://docs.apify.com/api/v2/actor-task-runs-post
      */
     async start(input, options = {}) {
-        (0, utils_1.parseArgument)(input, inputSchema);
-        const parsed = (0, utils_1.parseArgument)(options, startOptionsSchema, 'TaskStartOptions');
+        parseArgument(input, inputSchema);
+        const parsed = parseArgument(options, startOptionsSchema, 'TaskStartOptions');
         const { waitForFinish, timeout, memory, build, maxItems, maxTotalChargeUsd, restartOnError } = parsed;
         const params = {
             waitForFinish,
             timeout,
             memory,
             build,
-            webhooks: (0, utils_1.stringifyWebhooksToBase64)(parsed.webhooks),
+            webhooks: stringifyWebhooksToBase64(parsed.webhooks),
             maxItems,
             maxTotalChargeUsd,
             restartOnError,
@@ -164,7 +161,7 @@ class TaskClient extends resource_client_1.ResourceClient {
             },
         };
         const response = await this.httpClient.call(request);
-        return (0, utils_1.cast)((0, utils_1.parseDateFields)((0, utils_1.pluckData)(response.data)));
+        return cast(parseDateFields(pluckData(response.data)));
     }
     /**
      * Starts a task and waits for it to finish before returning the Run object.
@@ -184,8 +181,8 @@ class TaskClient extends resource_client_1.ResourceClient {
      * @see https://docs.apify.com/api/v2/actor-task-runs-post
      */
     async call(input, options = {}) {
-        (0, utils_1.parseArgument)(input, inputSchema);
-        const parsed = (0, utils_1.parseArgument)(options, callOptionsSchema, 'TaskCallOptions');
+        parseArgument(input, inputSchema);
+        const parsed = 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.
@@ -207,10 +204,10 @@ class TaskClient extends resource_client_1.ResourceClient {
         };
         try {
             const response = await this.httpClient.call(requestOpts);
-            return (0, utils_1.cast)(response.data);
+            return cast(response.data);
         }
         catch (err) {
-            (0, utils_1.catchNotFoundOrThrow)(err);
+            catchNotFoundOrThrow(err);
         }
         return undefined;
     }
@@ -228,7 +225,7 @@ class TaskClient extends resource_client_1.ResourceClient {
             params: this._params(),
             data: newFields,
         });
-        return (0, utils_1.cast)(response.data);
+        return cast(response.data);
     }
     /**
      * Returns a client for the last run of this task.
@@ -240,8 +237,8 @@ class TaskClient extends resource_client_1.ResourceClient {
      * @see https://docs.apify.com/api/v2/actor-task-runs-last-get
      */
     lastRun(options = {}) {
-        const parsed = (0, utils_1.parseArgument)(options, lastRunOptionsSchema, 'TaskLastRunOptions');
-        return new run_1.RunClient(this._subResourceOptions({
+        const parsed = parseArgument(options, lastRunOptionsSchema, 'TaskLastRunOptions');
+        return new RunClient(this._subResourceOptions({
             id: 'last',
             params: this._params(parsed),
             resourcePath: 'runs',
@@ -254,7 +251,7 @@ class TaskClient extends resource_client_1.ResourceClient {
      * @see https://docs.apify.com/api/v2/actor-task-runs-get
      */
     runs() {
-        return new run_collection_1.RunCollectionClient(this._subResourceOptions({
+        return new RunCollectionClient(this._subResourceOptions({
             resourcePath: 'runs',
         }));
     }
@@ -265,7 +262,6 @@ class TaskClient extends resource_client_1.ResourceClient {
      * @see https://docs.apify.com/api/v2/actor-task-webhooks-get
      */
     webhooks() {
-        return new webhook_collection_1.WebhookCollectionClient(this._subResourceOptions());
+        return new WebhookCollectionClient(this._subResourceOptions());
     }
 }
-exports.TaskClient = TaskClient;

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 { PaginatedIterator, PaginationOptions } from '../utils';
-import type { Task, TaskUpdateData } from './task';
+import type { ApiClientSubResourceOptions } from '../base/api_client.js';
+import { ResourceCollectionClient } from '../base/resource_collection_client.js';
+import type { TaskList } from '../models.js';
+import type { PaginatedIterator, PaginationOptions } from '../utils.js';
+import type { Task, TaskUpdateData } from './task.js';
+export type { TaskList } from '../models.js';
 /**
  * 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,12 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TaskCollectionClient = void 0;
-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(),
+import { z } from 'zod';
+import { ResourceCollectionClient } from '../base/resource_collection_client.js';
+import { anyObjectSchema, paginationOptionsShape, parseArgument } from '../utils.js';
+const listOptionsSchema = z.strictObject({
+    ...paginationOptionsShape,
+    desc: z.boolean().optional(),
 });
 /**
  * Client for managing the collection of Actor tasks in your account.
@@ -32,7 +29,7 @@ const listOptionsSchema = zod_1.z.strictObject({
  *
  * @see https://docs.apify.com/platform/actors/running/tasks
  */
-class TaskCollectionClient extends resource_collection_client_1.ResourceCollectionClient {
+export class TaskCollectionClient extends ResourceCollectionClient {
     /**
      * @hidden
      */
@@ -63,7 +60,7 @@ class TaskCollectionClient extends resource_collection_client_1.ResourceCollecti
      * @see https://docs.apify.com/api/v2/actor-tasks-get
      */
     list(options = {}) {
-        const parsed = (0, utils_1.parseArgument)(options, listOptionsSchema, 'TaskCollectionListOptions');
+        const parsed = parseArgument(options, listOptionsSchema, 'TaskCollectionListOptions');
         return this._listPaginated(parsed);
     }
     /**
@@ -74,8 +71,7 @@ class TaskCollectionClient extends resource_collection_client_1.ResourceCollecti
      * @see https://docs.apify.com/api/v2/actor-tasks-post
      */
     async create(task) {
-        (0, utils_1.parseArgument)(task, utils_1.anyObjectSchema);
+        parseArgument(task, anyObjectSchema);
         return this._create(task);
     }
 }
-exports.TaskCollectionClient = TaskCollectionClient;

package/dist/resource_clients/user.d.ts

@@ -1,5 +1,8 @@
-import type { ApiClientSubResourceOptions } from '../base/api_client';
-import { ResourceClient } from '../base/resource_client';
+import type { ApiClientSubResourceOptions } from '../base/api_client.js';
+import { ResourceClient } from '../base/resource_client.js';
+import type { AccountAndUsageLimits, MonthlyUsage, User } from '../models.js';
+export type { AccountAndUsageLimits, Current, DailyServiceUsage, EffectivePlatformFeature, EffectivePlatformFeatures, Limits, MonthlyUsage, MonthlyUsageCycle, PriceTier, ProxyGroup, ServiceUsage, UsageCycle, UsageItem, User, UserPlan, UserProfile, UserProxy, } from '../models.js';
+export { PlatformFeature } from '../models.js';
 /**
  * Client for managing user account information.
  *
@@ -64,169 +67,6 @@ export declare class UserClient extends ResourceClient {
      */
     updateLimits(options: LimitsUpdateOptions): Promise<void>;
 }
-export interface User {
-    username: string;
-    profile: {
-        bio?: string;
-        name?: string;
-        pictureUrl?: string;
-        githubUsername?: string;
-        websiteUrl?: string;
-        twitterUsername?: string;
-    };
-    id?: string;
-    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 {
-    password: string;
-    groups: ProxyGroup[];
-}
-export interface ProxyGroup {
-    name: string;
-    description: string;
-    availableCount: number;
-}
-export interface UserPlan {
-    id: string;
-    description: string;
-    isEnabled: boolean;
-    monthlyBasePriceUsd: number;
-    monthlyUsageCreditsUsd: number;
-    usageDiscountPercent: number;
-    enabledPlatformFeatures: PlatformFeature[];
-    maxMonthlyUsageUsd: number;
-    maxActorMemoryGbytes: number;
-    maxMonthlyActorComputeUnits: number;
-    maxMonthlyResidentialProxyGbytes: number;
-    maxMonthlyProxySerps: number;
-    maxMonthlyExternalDataTransferGbytes: number;
-    maxActorCount: number;
-    maxActorTaskCount: number;
-    dataRetentionDays: number;
-    availableProxyGroups: Record<string, number>;
-    teamAccountSeatCount: number;
-    supportLevel: string;
-    availableAddOns: unknown[];
-}
-export declare enum PlatformFeature {
-    Actors = "ACTORS",
-    Storage = "STORAGE",
-    ProxySERPS = "PROXY_SERPS",
-    Scheduler = "SCHEDULER",
-    Webhooks = "WEBHOOKS",
-    Proxy = "PROXY",
-    ProxyExternalAccess = "PROXY_EXTERNAL_ACCESS"
-}
-interface EffectivePlatformFeature {
-    isEnabled: boolean;
-    disabledReason: string | null;
-    disabledReasonType: string | null;
-    isTrial: boolean;
-    trialExpirationAt: Date | null;
-}
-interface EffectivePlatformFeatures {
-    ACTORS: EffectivePlatformFeature;
-    STORAGE: EffectivePlatformFeature;
-    SCHEDULER: EffectivePlatformFeature;
-    PROXY: EffectivePlatformFeature;
-    PROXY_EXTERNAL_ACCESS: EffectivePlatformFeature;
-    PROXY_RESIDENTIAL: EffectivePlatformFeature;
-    PROXY_SERPS: EffectivePlatformFeature;
-    WEBHOOKS: EffectivePlatformFeature;
-    ACTORS_PUBLIC_ALL: EffectivePlatformFeature;
-    ACTORS_PUBLIC_DEVELOPER: EffectivePlatformFeature;
-}
-/**
- * @since Added in 2.9.2
- */
-export interface MonthlyUsage {
-    usageCycle: UsageCycle;
-    monthlyServiceUsage: {
-        [key: string]: MonthlyServiceUsageData;
-    };
-    dailyServiceUsages: DailyServiceUsage[];
-    totalUsageCreditsUsdBeforeVolumeDiscount: number;
-    totalUsageCreditsUsdAfterVolumeDiscount: number;
-}
-/**
- * @since Added in 2.9.2
- */
-export interface UsageCycle {
-    startAt: Date;
-    endAt: Date;
-}
-/** Monthly usage of a single service */
-interface MonthlyServiceUsageData {
-    quantity: number;
-    baseAmountUsd: number;
-    baseUnitPriceUsd: number;
-    amountAfterVolumeDiscountUsd: number;
-    priceTiers: PriceTier[];
-}
-interface PriceTier {
-    quantityAbove: number;
-    discountPercent: number;
-    tierQuantity: number;
-    unitPriceUsd: number;
-    priceUsd: number;
-}
-interface DailyServiceUsage {
-    date: Date;
-    serviceUsage: {
-        [key: string]: DailyServiceUsageData;
-    };
-    totalUsageCreditsUsd: number;
-}
-/** Daily usage of a single service */
-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;
-    maxMonthlyExternalDataTransferGbytes: number;
-    maxMonthlyProxySerps: number;
-    maxMonthlyResidentialProxyGbytes: number;
-    maxActorMemoryGbytes: number;
-    maxActorCount: number;
-    maxActorTaskCount: number;
-    maxConcurrentActorJobs: number;
-    maxTeamAccountSeatCount: number;
-    dataRetentionDays: number;
-}
 /**
  * @since Added in 2.10.0
  */
@@ -235,19 +75,3 @@ export type LimitsUpdateOptions = {
 } | {
     dataRetentionDays: number;
 };
-/**
- * @since Added in 2.9.2
- */
-export interface Current {
-    monthlyUsageUsd: number;
-    monthlyActorComputeUnits: number;
-    monthlyExternalDataTransferGbytes: number;
-    monthlyProxySerps: number;
-    monthlyResidentialProxyGbytes: number;
-    actorMemoryGbytes: number;
-    actorCount: number;
-    actorTaskCount: number;
-    activeActorJobCount: number;
-    teamAccountSeatCount: number;
-}
-export {};

package/dist/resource_clients/user.js

@@ -1,8 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PlatformFeature = exports.UserClient = void 0;
-const resource_client_1 = require("../base/resource_client");
-const utils_1 = require("../utils");
+import { ResourceClient } from '../base/resource_client.js';
+import { cast, catchNotFoundOrThrow, parseDateFields, pluckData } from '../utils.js';
+export { PlatformFeature } from '../models.js';
 /**
  * Client for managing user account information.
  *
@@ -27,7 +25,7 @@ const utils_1 = require("../utils");
  *
  * @see https://docs.apify.com/platform/actors/running
  */
-class UserClient extends resource_client_1.ResourceClient {
+export class UserClient extends ResourceClient {
     /**
      * @hidden
      */
@@ -64,12 +62,12 @@ class UserClient extends resource_client_1.ResourceClient {
         };
         try {
             const response = await this.httpClient.call(requestOpts);
-            return (0, utils_1.cast)((0, utils_1.parseDateFields)((0, utils_1.pluckData)(response.data), 
+            return cast(parseDateFields(pluckData(response.data), 
             // Convert  monthlyUsage.dailyServiceUsages[].date to Date (by default it's ignored by parseDateFields)
             /* shouldParseField = */ (key) => key === 'date'));
         }
         catch (err) {
-            (0, utils_1.catchNotFoundOrThrow)(err);
+            catchNotFoundOrThrow(err);
         }
         return undefined;
     }
@@ -88,10 +86,10 @@ class UserClient extends resource_client_1.ResourceClient {
         };
         try {
             const response = await this.httpClient.call(requestOpts);
-            return (0, utils_1.cast)((0, utils_1.parseDateFields)((0, utils_1.pluckData)(response.data)));
+            return cast(parseDateFields(pluckData(response.data)));
         }
         catch (err) {
-            (0, utils_1.catchNotFoundOrThrow)(err);
+            catchNotFoundOrThrow(err);
         }
         return undefined;
     }
@@ -112,14 +110,3 @@ class UserClient extends resource_client_1.ResourceClient {
         await this.httpClient.call(requestOpts);
     }
 }
-exports.UserClient = UserClient;
-var PlatformFeature;
-(function (PlatformFeature) {
-    PlatformFeature["Actors"] = "ACTORS";
-    PlatformFeature["Storage"] = "STORAGE";
-    PlatformFeature["ProxySERPS"] = "PROXY_SERPS";
-    PlatformFeature["Scheduler"] = "SCHEDULER";
-    PlatformFeature["Webhooks"] = "WEBHOOKS";
-    PlatformFeature["Proxy"] = "PROXY";
-    PlatformFeature["ProxyExternalAccess"] = "PROXY_EXTERNAL_ACCESS";
-})(PlatformFeature || (exports.PlatformFeature = PlatformFeature = {}));