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

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 { AccountAndUsageLimits, MonthlyUsage, User } from '../models';
+export type { AccountAndUsageLimits, Current, DailyServiceUsage, EffectivePlatformFeature, EffectivePlatformFeatures, Limits, MonthlyUsage, MonthlyUsageCycle, PriceTier, ProxyGroup, ServiceUsage, UsageCycle, UsageItem, User, UserPlan, UserProfile, UserProxy, } from '../models';
+export { PlatformFeature } from '../models';
 /**
  * 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,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PlatformFeature = exports.UserClient = void 0;
+exports.UserClient = exports.PlatformFeature = void 0;
 const resource_client_1 = require("../base/resource_client");
 const utils_1 = require("../utils");
+var models_1 = require("../models");
+Object.defineProperty(exports, "PlatformFeature", { enumerable: true, get: function () { return models_1.PlatformFeature; } });
 /**
  * Client for managing user account information.
  *
@@ -113,13 +115,3 @@ class UserClient extends resource_client_1.ResourceClient {
     }
 }
 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 = {}));

package/dist/resource_clients/webhook.d.ts

@@ -1,8 +1,9 @@
-import type { WEBHOOK_EVENT_TYPES } from '@apify/consts';
 import type { ApiClientSubResourceOptions } from '../base/api_client';
 import { ResourceClient } from '../base/resource_client';
+import type { Webhook, WebhookEventType } from '../models';
 import type { WebhookDispatch } from './webhook_dispatch';
 import { WebhookDispatchCollectionClient } from './webhook_dispatch_collection';
+export type { Webhook, WebhookAnyRunOfActorCondition, WebhookAnyRunOfActorTaskCondition, WebhookCertainRunCondition, WebhookCondition, WebhookEventType, WebhookLastDispatch, WebhookStats, } from '../models';
 /**
  * Client for managing a specific webhook.
  *
@@ -72,43 +73,6 @@ export declare class WebhookClient extends ResourceClient {
      */
     dispatches(): WebhookDispatchCollectionClient;
 }
-/**
- * Represents a webhook for receiving notifications about Actor events.
- *
- * Webhooks send HTTP POST requests to specified URLs when certain events occur
- * (e.g., Actor run succeeds, fails, or times out).
- */
-export interface Webhook {
-    id: string;
-    userId: string;
-    createdAt: Date;
-    modifiedAt: Date;
-    isAdHoc: boolean;
-    eventTypes: WebhookEventType[];
-    condition: WebhookCondition;
-    ignoreSslErrors: boolean;
-    doNotRetry: boolean;
-    requestUrl: string;
-    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 {
     idempotencyKey?: string;
 }
@@ -118,26 +82,3 @@ export interface WebhookIdempotencyKey {
 export type WebhookUpdateData = Partial<Pick<Webhook, 'isAdHoc' | 'condition' | 'ignoreSslErrors' | 'doNotRetry' | 'requestUrl' | 'payloadTemplate' | 'shouldInterpolateStrings' | 'isApifyIntegration' | 'headersTemplate' | 'description'> & {
     eventTypes: readonly WebhookEventType[];
 }> & WebhookIdempotencyKey;
-/**
- * Statistics about webhook usage.
- */
-export interface WebhookStats {
-    totalDispatches: number;
-}
-/**
- * Event types that can trigger webhooks.
- */
-export type WebhookEventType = (typeof WEBHOOK_EVENT_TYPES)[keyof typeof WEBHOOK_EVENT_TYPES];
-/**
- * Condition that determines when a webhook should be triggered.
- */
-export type WebhookCondition = WebhookAnyRunOfActorCondition | WebhookAnyRunOfActorTaskCondition | WebhookCertainRunCondition;
-export interface WebhookAnyRunOfActorCondition {
-    actorId: string;
-}
-export interface WebhookAnyRunOfActorTaskCondition {
-    actorTaskId: string;
-}
-export interface WebhookCertainRunCondition {
-    actorRunId: string;
-}

package/dist/resource_clients/webhook.js

@@ -1,8 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebhookClient = void 0;
-const tslib_1 = require("tslib");
-const ow_1 = tslib_1.__importDefault(require("ow"));
 const resource_client_1 = require("../base/resource_client");
 const utils_1 = require("../utils");
 const webhook_dispatch_collection_1 = require("./webhook_dispatch_collection");
@@ -61,7 +59,7 @@ class WebhookClient extends resource_client_1.ResourceClient {
      * @see https://docs.apify.com/api/v2/webhook-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);
     }
     /**

package/dist/resource_clients/webhook_collection.js

@@ -1,9 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebhookCollectionClient = 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 webhookCreateSchema = utils_1.anyObjectSchema.optional();
 /**
  * Client for managing the collection of Webhooks.
  *
@@ -58,12 +63,8 @@ class WebhookCollectionClient extends resource_collection_client_1.ResourceColle
      * @see https://docs.apify.com/api/v2/webhooks-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, 'WebhookCollectionListOptions');
+        return this._listPaginated(parsed);
     }
     /**
      * Creates a new webhook.
@@ -73,7 +74,7 @@ class WebhookCollectionClient extends resource_collection_client_1.ResourceColle
      * @see https://docs.apify.com/api/v2/webhooks-post
      */
     async create(webhook) {
-        (0, ow_1.default)(webhook, ow_1.default.optional.object);
+        (0, utils_1.parseArgument)(webhook, webhookCreateSchema);
         return this._create(webhook);
     }
 }

package/dist/resource_clients/webhook_dispatch.d.ts

@@ -1,6 +1,8 @@
 import type { ApiClientSubResourceOptions } from '../base/api_client';
 import { ResourceClient } from '../base/resource_client';
-import type { Webhook, WebhookEventType } from './webhook';
+import type { WebhookDispatch } from '../models';
+export type { WebhookDispatch, WebhookDispatchCall, WebhookDispatchEventData, WebhookDispatchWebhookSummary, } from '../models';
+export { WebhookDispatchStatus } from '../models';
 /**
  * Client for managing a specific webhook dispatch.
  *
@@ -32,38 +34,3 @@ export declare class WebhookDispatchClient extends ResourceClient {
      */
     get(): Promise<WebhookDispatch | undefined>;
 }
-export interface WebhookDispatch {
-    id: string;
-    userId: string;
-    webhookId: string;
-    createdAt: Date;
-    status: WebhookDispatchStatus;
-    eventType: WebhookEventType;
-    calls: WebhookDispatchCall[];
-    webhook: Pick<Webhook, 'requestUrl' | 'isAdHoc'>;
-    /**
-     * @since Added in 2.13.0
-     */
-    eventData: WebhookDispatchEventData | null;
-}
-export declare enum WebhookDispatchStatus {
-    Active = "ACTIVE",
-    Succeeded = "SUCCEEDED",
-    Failed = "FAILED"
-}
-export interface WebhookDispatchCall {
-    startedAt: Date;
-    finishedAt: Date;
-    errorMessage: string | null;
-    responseStatus: number | null;
-    responseBody: string | null;
-}
-/**
- * @since Added in 2.13.0
- */
-export interface WebhookDispatchEventData {
-    actorRunId?: string;
-    actorId?: string;
-    actorTaskId?: string;
-    actorBuildId?: string;
-}

package/dist/resource_clients/webhook_dispatch.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WebhookDispatchStatus = exports.WebhookDispatchClient = void 0;
+exports.WebhookDispatchClient = exports.WebhookDispatchStatus = void 0;
 const resource_client_1 = require("../base/resource_client");
+var models_1 = require("../models");
+Object.defineProperty(exports, "WebhookDispatchStatus", { enumerable: true, get: function () { return models_1.WebhookDispatchStatus; } });
 /**
  * Client for managing a specific webhook dispatch.
  *
@@ -41,9 +43,3 @@ class WebhookDispatchClient extends resource_client_1.ResourceClient {
     }
 }
 exports.WebhookDispatchClient = WebhookDispatchClient;
-var WebhookDispatchStatus;
-(function (WebhookDispatchStatus) {
-    WebhookDispatchStatus["Active"] = "ACTIVE";
-    WebhookDispatchStatus["Succeeded"] = "SUCCEEDED";
-    WebhookDispatchStatus["Failed"] = "FAILED";
-})(WebhookDispatchStatus || (exports.WebhookDispatchStatus = WebhookDispatchStatus = {}));

package/dist/resource_clients/webhook_dispatch_collection.js

@@ -1,9 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebhookDispatchCollectionClient = 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 webhook dispatches.
  *
@@ -53,12 +57,8 @@ class WebhookDispatchCollectionClient extends resource_collection_client_1.Resou
      * @see https://docs.apify.com/api/v2/webhook-dispatches-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, 'WebhookDispatchCollectionListOptions');
+        return this._listPaginated(parsed);
     }
 }
 exports.WebhookDispatchCollectionClient = WebhookDispatchCollectionClient;

package/dist/statistics.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Statistics = void 0;
-const tslib_1 = require("tslib");
-const ow_1 = tslib_1.__importDefault(require("ow"));
+const zod_1 = require("zod");
+const utils_1 = require("./utils");
+const attemptSchema = zod_1.z.number().gt(0);
 class Statistics {
     /**
      * Number of Apify client function calls
@@ -18,7 +19,7 @@ class Statistics {
      */
     rateLimitErrors = [];
     addRateLimitError(attempt) {
-        (0, ow_1.default)(attempt, ow_1.default.number.greaterThan(0));
+        (0, utils_1.parseArgument)(attempt, attemptSchema);
         // attempt is never 0,
         // but we don't want index 0 empty
         const index = attempt - 1;

package/dist/utils.d.ts

@@ -1,8 +1,30 @@
 import type { Readable } from 'node:stream';
 import type { JsonValue, TypedArray } from 'type-fest';
+import { z } from 'zod';
 import type { ApifyApiError } from './apify_api_error';
 import type { RequestQueueClientListRequestsOptions, RequestQueueClientListRequestsResult } from './resource_clients/request_queue';
 import type { WebhookUpdateData } from './resource_clients/webhook';
+/**
+ * Parses `value` with `schema`, returning the typed result (with schema defaults applied).
+ * Throws {@link ArgumentValidationError} on failure.
+ *
+ * The optional `label` names the interface being validated and is appended to every error line
+ * (e.g. ``... at `memory` in `ActorStartOptions` ``).
+ * @internal
+ */
+export declare function parseArgument<TValue, TSchema extends z.ZodType>(value: TValue, schema: TSchema, label?: string): TValue & z.output<TSchema>;
+/**
+ * Accepts any non-null, non-array object as a predicate for `z.custom()`.
+ * @internal
+ */
+export declare function isNonArrayObject(value: unknown): value is Record<string, unknown>;
+/**
+ * Matches any plain object, letting unknown keys through - for payloads whose shape the API
+ * validates itself. A `z.custom()` predicate rather than an object schema, so parsing returns
+ * the value itself instead of a copy.
+ * @internal
+ */
+export declare const anyObjectSchema: z.ZodCustom<Record<string, unknown>, Record<string, unknown>>;
 /**
  * Generic interface for objects that may contain a data property.
  *
@@ -40,7 +62,7 @@ export declare function parseDateFields(input: JsonValue, shouldParseField?: ((k
 /**
  * Helper function that converts array of webhooks to base64 string
  */
-export declare function stringifyWebhooksToBase64(webhooks: WebhookUpdateData[]): string | undefined;
+export declare function stringifyWebhooksToBase64(webhooks?: readonly WebhookUpdateData[]): string | undefined;
 export interface CompressedValue {
     data: Buffer;
     encoding: 'br' | 'gzip';
@@ -103,6 +125,16 @@ export interface PaginationOptions {
      * */
     chunkSize?: number;
 }
+/**
+ * Schema shape of {@link PaginationOptions}, to spread into every paginating client's list schema. One
+ * copy stops it drifting from the interface.
+ * @internal
+ */
+export declare const paginationOptionsShape: {
+    limit: z.ZodOptional<z.ZodNumber>;
+    offset: z.ZodOptional<z.ZodNumber>;
+    chunkSize: z.ZodOptional<z.ZodNumber>;
+};
 /**
  * Standard paginated response format.
  *
@@ -160,8 +192,22 @@ export type DistributiveOptional<T, K extends keyof T> = T extends any ? Omit<T,
  * Adds query parameters to a given URL based on the provided options object.
  */
 export declare function applyQueryParamsToUrl(url: URL, options?: Record<string, string | number | boolean | string[] | undefined>): URL;
-export declare const mutuallyExclusive: <T, K extends keyof T>(...keys: K[]) => (value: T) => {
-    validator: boolean;
-    message: string;
-};
+/**
+ * Builds a `[check, message]` pair to spread into `.refine()`, asserting that at most one of `keys`
+ * is present. Pass the options interface as `T`, so that a misspelled key is a type error.
+ * @internal
+ */
+export declare const mutuallyExclusive: <T extends object>(...keys: (keyof T & string)[]) => [(value: T) => boolean, string];
+/**
+ * Percent-encodes a caller-supplied URL path segment so it cannot restructure the request path.
+ *
+ * Empty strings and dot segments are rejected instead of encoded, because URL parsers resolve
+ * dot segments after decoding - `records/%2E%2E` collapses to the parent endpoint just like `records/..`.
+ */
+export declare function toPathSegment(value: string): string;
+/**
+ * Builds a URL path from segments. A plain string is used as-is, so literal paths such as
+ * `requests/batch` keep their separators; an array has each of its segments encoded individually.
+ */
+export declare function toPath(path: string | string[]): string;
 export {};