apify-client 3.0.0-beta.4 → 3.0.0-beta.5

package/dist/resource_clients/request_queue.js

@@ -2,7 +2,9 @@ import { z } from 'zod';
 import { MAX_PAYLOAD_SIZE_BYTES, REQUEST_QUEUE_MAX_REQUESTS_PER_BATCH_OPERATION } from '@apify/consts';
 import log from '@apify/log';
 import { MEDIUM_TIMEOUT_MILLIS, ResourceClient, SMALL_TIMEOUT_MILLIS } from '../base/resource_client.js';
-import { anyObjectSchema, cast, catchNotFoundOrThrow, isNonArrayObject, mutuallyExclusive, parseArgument, parseDateFields, pluckData, RequestQueuePaginationIterator, sliceArrayByByteLength, } from '../utils.js';
+import { ResponseValidationError } from '../response_validation_error.js';
+import * as schemas from '../schemas.js';
+import { anyObjectSchema, cast, catchNotFoundOrThrow, isNonArrayObject, mutuallyExclusive, parseArgument, parseDateFields, parseResponse, RequestQueuePaginationIterator, sliceArrayByByteLength, } from '../utils.js';
 const DEFAULT_PARALLEL_BATCH_ADD_REQUESTS = 5;
 const DEFAULT_UNPROCESSED_RETRIES_BATCH_ADD_REQUESTS = 3;
 const DEFAULT_MIN_DELAY_BETWEEN_UNPROCESSED_REQUESTS_RETRIES_MILLIS = 500;
@@ -101,7 +103,7 @@ export class RequestQueueClient extends ResourceClient {
      * @see https://docs.apify.com/api/v2/request-queue-get
      */
     async get() {
-        return this._get({}, SMALL_TIMEOUT_MILLIS);
+        return this._get(schemas.RequestQueue(), {}, SMALL_TIMEOUT_MILLIS);
     }
     /**
      * Updates the Request queue with specified fields.
@@ -112,7 +114,7 @@ export class RequestQueueClient extends ResourceClient {
      */
     async update(newFields) {
         parseArgument(newFields, anyObjectSchema);
-        return this._update(newFields, SMALL_TIMEOUT_MILLIS);
+        return this._update(schemas.RequestQueue(), newFields, SMALL_TIMEOUT_MILLIS);
     }
     /**
      * Deletes the Request queue.
@@ -143,7 +145,7 @@ export class RequestQueueClient extends ResourceClient {
                 clientKey: this.clientKey,
             }),
         });
-        return cast(parseDateFields(pluckData(response.data)));
+        return parseResponse(response, schemas.RequestQueueHead());
     }
     /**
      * Gets and locks the next requests from the queue head for processing.
@@ -190,7 +192,7 @@ export class RequestQueueClient extends ResourceClient {
                 clientKey: this.clientKey,
             }),
         });
-        return cast(parseDateFields(pluckData(response.data)));
+        return parseResponse(response, schemas.LockedRequestQueueHead());
     }
     /**
      * Adds a single request to the queue.
@@ -243,7 +245,7 @@ export class RequestQueueClient extends ResourceClient {
                 clientKey: this.clientKey,
             }),
         });
-        return cast(parseDateFields(pluckData(response.data)));
+        return parseResponse(response, schemas.RequestRegistration());
     }
     /**
      * Writes requests to Request queue in batch.
@@ -253,7 +255,7 @@ export class RequestQueueClient extends ResourceClient {
     async _batchAddRequests(requests, options = {}) {
         parseArgument(requests, batchAddRequestsSchema);
         const parsed = parseArgument(options, forefrontOptionsSchema, 'RequestQueueClientAddRequestOptions');
-        const { data } = await this.httpClient.call({
+        const response = await this.httpClient.call({
             url: this._url('requests/batch'),
             method: 'POST',
             timeout: Math.min(MEDIUM_TIMEOUT_MILLIS, this.timeoutMillis ?? Infinity),
@@ -263,7 +265,7 @@ export class RequestQueueClient extends ResourceClient {
                 clientKey: this.clientKey,
             }),
         });
-        return cast(parseDateFields(pluckData(data)));
+        return parseResponse(response, schemas.BatchAddResult());
     }
     async _batchAddRequestsWithRetries(requests, options = {}) {
         const { forefront, maxUnprocessedRequestsRetries = DEFAULT_UNPROCESSED_RETRIES_BATCH_ADD_REQUESTS, minDelayBetweenUnprocessedRequestsRetriesMillis = DEFAULT_MIN_DELAY_BETWEEN_UNPROCESSED_REQUESTS_RETRIES_MILLIS, } = options;
@@ -296,6 +298,10 @@ export class RequestQueueClient extends ResourceClient {
                 }
             }
             catch (err) {
+                // A response the specification does not describe is reported, as everywhere else: the server may well
+                // have added the batch, so calling it unprocessed would hide the mismatch behind a wrong answer.
+                if (err instanceof ResponseValidationError)
+                    throw err;
                 log.exception(err, 'Request batch insert failed');
                 // When something fails and http client does not retry, the remaining requests are treated as unprocessed.
                 // This ensures that this method does not throw and keeps the signature.
@@ -369,10 +375,12 @@ export class RequestQueueClient extends ResourceClient {
             const requestsInBatch = sliceArrayByByteLength(slicedRequests, payloadSizeLimitBytes, i);
             const requestPromise = this._batchAddRequestsWithRetries(requestsInBatch, options);
             executingRequests.add(requestPromise);
+            // A rejection reaches the caller through the awaits below; this bookkeeping chain only has to avoid
+            // turning it into an unhandled one of its own.
             void requestPromise.then((batchAddResult) => {
                 executingRequests.delete(requestPromise);
                 individualResults.push(batchAddResult);
-            });
+            }, () => undefined);
             if (executingRequests.size >= maxParallel) {
                 await Promise.race(executingRequests);
             }
@@ -403,7 +411,7 @@ export class RequestQueueClient extends ResourceClient {
      */
     async batchDeleteRequests(requests) {
         parseArgument(requests, batchDeleteRequestsSchema);
-        const { data } = await this.httpClient.call({
+        const response = await this.httpClient.call({
             url: this._url('requests/batch'),
             method: 'DELETE',
             timeout: Math.min(SMALL_TIMEOUT_MILLIS, this.timeoutMillis ?? Infinity),
@@ -412,7 +420,7 @@ export class RequestQueueClient extends ResourceClient {
                 clientKey: this.clientKey,
             }),
         });
-        return cast(parseDateFields(pluckData(data)));
+        return parseResponse(response, schemas.BatchDeleteResult());
     }
     /**
      * Gets a specific request from the queue by its ID.
@@ -431,7 +439,7 @@ export class RequestQueueClient extends ResourceClient {
         };
         try {
             const response = await this.httpClient.call(requestOpts);
-            return cast(parseDateFields(pluckData(response.data)));
+            return parseResponse(response, schemas.Request());
         }
         catch (err) {
             catchNotFoundOrThrow(err);
@@ -459,7 +467,7 @@ export class RequestQueueClient extends ResourceClient {
                 clientKey: this.clientKey,
             }),
         });
-        return cast(parseDateFields(pluckData(response.data)));
+        return parseResponse(response, schemas.RequestRegistration());
     }
     /**
      * Deletes a specific request from the queue.
@@ -515,7 +523,7 @@ export class RequestQueueClient extends ResourceClient {
                 clientKey: this.clientKey,
             }),
         });
-        return cast(parseDateFields(pluckData(response.data)));
+        return parseResponse(response, schemas.RequestLockInfo());
     }
     /**
      * Releases the lock on a request, allowing other clients to process it.
@@ -565,7 +573,7 @@ export class RequestQueueClient extends ResourceClient {
                     clientKey: this.clientKey,
                 }),
             });
-            return cast(parseDateFields(pluckData(response.data)));
+            return parseResponse(response, schemas.ListOfRequests());
         };
         const paginatedListPromise = getPaginatedList(parsed);
         async function* asyncGenerator() {
@@ -615,7 +623,7 @@ export class RequestQueueClient extends ResourceClient {
                 clientKey: this.clientKey,
             }),
         });
-        return cast(parseDateFields(pluckData(response.data)));
+        return parseResponse(response, schemas.UnlockRequestsResult());
     }
     /**
      * Returns an async iterable for paginating through all requests in the queue.

package/dist/resource_clients/request_queue_collection.js

@@ -1,6 +1,7 @@
 import { z } from 'zod';
 import { STORAGE_OWNERSHIP_FILTER } from '@apify/consts';
 import { ResourceCollectionClient } from '../base/resource_collection_client.js';
+import * as schemas from '../schemas.js';
 import { paginationOptionsShape, parseArgument } from '../utils.js';
 const listOptionsSchema = z.strictObject({
     unnamed: z.boolean().optional(),
@@ -61,7 +62,7 @@ export class RequestQueueCollectionClient extends ResourceCollectionClient {
      */
     list(options = {}) {
         const parsed = parseArgument(options, listOptionsSchema, 'RequestQueueCollectionListOptions');
-        return this._listPaginated(parsed);
+        return this._listPaginated(schemas.ListOfRequestQueues(), parsed);
     }
     /**
      * Gets or creates a Request queue with the specified name.
@@ -72,6 +73,6 @@ export class RequestQueueCollectionClient extends ResourceCollectionClient {
      */
     async getOrCreate(name) {
         parseArgument(name, nameSchema);
-        return this._getOrCreate(name);
+        return this._getOrCreate(schemas.RequestQueue(), name);
     }
 }

package/dist/resource_clients/run.js

@@ -1,7 +1,8 @@
 import { z } from 'zod';
 import { LEVELS, Log } from '@apify/log';
 import { ResourceClient } from '../base/resource_client.js';
-import { anyObjectSchema, cast, isNode, parseArgument, parseDateFields, pluckData } from '../utils.js';
+import * as schemas from '../schemas.js';
+import { anyObjectSchema, isNode, parseArgument, parseResponse } from '../utils.js';
 import { DatasetClient } from './dataset.js';
 import { KeyValueStoreClient } from './key_value_store.js';
 import { LogClient, LoggerActorRedirect, StreamedLog } from './log.js';
@@ -81,7 +82,7 @@ export class RunClient extends ResourceClient {
      */
     async get(options = {}) {
         const parsed = parseArgument(options, getOptionsSchema, 'RunGetOptions');
-        return this._get(parsed);
+        return this._get(schemas.Run(), parsed);
     }
     /**
      * Aborts the Actor run.
@@ -107,7 +108,7 @@ export class RunClient extends ResourceClient {
             method: 'POST',
             params: this._params(parsed),
         });
-        return cast(parseDateFields(pluckData(response.data)));
+        return parseResponse(response, schemas.Run());
     }
     /**
      * Deletes the Actor run.
@@ -169,7 +170,7 @@ export class RunClient extends ResourceClient {
             };
         }
         const response = await this.httpClient.call(request);
-        return cast(parseDateFields(pluckData(response.data)));
+        return parseResponse(response, schemas.Run());
     }
     /**
      * Reboots the Actor run.
@@ -193,7 +194,7 @@ export class RunClient extends ResourceClient {
             method: 'POST',
         };
         const response = await this.httpClient.call(request);
-        return cast(parseDateFields(pluckData(response.data)));
+        return parseResponse(response, schemas.Run());
     }
     /**
      * Updates the Actor run with specified fields.
@@ -215,7 +216,7 @@ export class RunClient extends ResourceClient {
      */
     async update(newFields) {
         parseArgument(newFields, anyObjectSchema);
-        return this._update(newFields);
+        return this._update(schemas.Run(), newFields);
     }
     /**
      * Resurrects a finished Actor run, starting it again with the same settings.
@@ -247,7 +248,7 @@ export class RunClient extends ResourceClient {
             method: 'POST',
             params: this._params(parsed),
         });
-        return cast(parseDateFields(pluckData(response.data)));
+        return parseResponse(response, schemas.Run());
     }
     /**
      * Charges the Actor run for a specific event.
@@ -309,7 +310,7 @@ export class RunClient extends ResourceClient {
      */
     async waitForFinish(options = {}) {
         const parsed = parseArgument(options, waitForFinishOptionsSchema, 'RunWaitForFinishOptions');
-        return this._waitForFinish(parsed);
+        return this._waitForFinish(schemas.Run(), parsed);
     }
     /**
      * Returns a client for the default dataset of this Actor run.

package/dist/resource_clients/run_collection.js

@@ -1,6 +1,7 @@
 import { z } from 'zod';
 import { ACTOR_JOB_STATUSES } from '@apify/consts';
 import { ResourceCollectionClient } from '../base/resource_collection_client.js';
+import * as schemas from '../schemas.js';
 import { paginationOptionsShape, parseArgument } from '../utils.js';
 const jobStatusSchema = z.enum(ACTOR_JOB_STATUSES);
 const listOptionsSchema = z.strictObject({
@@ -63,6 +64,6 @@ export class RunCollectionClient extends ResourceCollectionClient {
      */
     list(options = {}) {
         const parsed = parseArgument(options, listOptionsSchema, 'RunCollectionListOptions');
-        return this._listPaginated(parsed);
+        return this._listPaginated(schemas.ListOfRuns(), parsed);
     }
 }

package/dist/resource_clients/schedule.d.ts

@@ -1,8 +1,8 @@
 import type { ApiClientSubResourceOptions } from '../base/api_client.js';
 import { ResourceClient } from '../base/resource_client.js';
-import type { Schedule, ScheduleAction } from '../models.js';
+import type { Schedule, ScheduleAction, ScheduleInvoked } from '../models.js';
 import type { DistributiveOptional } from '../utils.js';
-export type { Schedule, ScheduleAction, ScheduleActionRunActor, ScheduleActionRunActorTask, ScheduledActorRunInput, ScheduledActorRunOptions, } from '../models.js';
+export type { Schedule, ScheduleAction, ScheduleActionRunActor, ScheduleActionRunActorTask, ScheduledActorRunInput, ScheduledActorRunOptions, ScheduleInvoked, } from '../models.js';
 export { ScheduleActions } from '../models.js';
 /**
  * Client for managing a specific Schedule.
@@ -56,10 +56,10 @@ export declare class ScheduleClient extends ResourceClient {
     /**
      * Retrieves the schedule's log.
      *
-     * @returns The schedule log as a string, or `undefined` if it does not exist.
+     * @returns The schedule log, one entry per invocation, or `undefined` if the schedule does not exist.
      * @see https://docs.apify.com/api/v2/schedule-log-get
      */
-    getLog(): Promise<string | undefined>;
+    getLog(): Promise<ScheduleInvoked[] | undefined>;
 }
 /**
  * Data for creating or updating a Schedule.

package/dist/resource_clients/schedule.js

@@ -1,6 +1,9 @@
+import { z } from 'zod';
 import { ResourceClient } from '../base/resource_client.js';
-import { anyObjectSchema, cast, catchNotFoundOrThrow, parseArgument, parseDateFields, pluckData } from '../utils.js';
+import * as schemas from '../schemas.js';
+import { anyObjectSchema, catchNotFoundOrThrow, parseArgument, parseResponse } from '../utils.js';
 export { ScheduleActions } from '../models.js';
+const scheduleLogSchema = z.array(schemas.ScheduleInvoked());
 /**
  * Client for managing a specific Schedule.
  *
@@ -41,7 +44,7 @@ export class ScheduleClient extends ResourceClient {
      * @see https://docs.apify.com/api/v2/schedule-get
      */
     async get() {
-        return this._get();
+        return this._get(schemas.Schedule());
     }
     /**
      * Updates the schedule with the specified fields.
@@ -52,7 +55,7 @@ export class ScheduleClient extends ResourceClient {
      */
     async update(newFields) {
         parseArgument(newFields, anyObjectSchema);
-        return this._update(newFields);
+        return this._update(schemas.Schedule(), newFields);
     }
     /**
      * Deletes the schedule.
@@ -65,7 +68,7 @@ export class ScheduleClient extends ResourceClient {
     /**
      * Retrieves the schedule's log.
      *
-     * @returns The schedule log as a string, or `undefined` if it does not exist.
+     * @returns The schedule log, one entry per invocation, or `undefined` if the schedule does not exist.
      * @see https://docs.apify.com/api/v2/schedule-log-get
      */
     async getLog() {
@@ -76,7 +79,7 @@ export class ScheduleClient extends ResourceClient {
         };
         try {
             const response = await this.httpClient.call(requestOpts);
-            return cast(parseDateFields(pluckData(response.data)));
+            return parseResponse(response, scheduleLogSchema);
         }
         catch (err) {
             catchNotFoundOrThrow(err);

package/dist/resource_clients/schedule_collection.js

@@ -1,5 +1,6 @@
 import { z } from 'zod';
 import { ResourceCollectionClient } from '../base/resource_collection_client.js';
+import * as schemas from '../schemas.js';
 import { anyObjectSchema, paginationOptionsShape, parseArgument } from '../utils.js';
 const listOptionsSchema = z.strictObject({
     ...paginationOptionsShape,
@@ -62,7 +63,7 @@ export class ScheduleCollectionClient extends ResourceCollectionClient {
      */
     list(options = {}) {
         const parsed = parseArgument(options, listOptionsSchema, 'ScheduleCollectionListOptions');
-        return this._listPaginated(parsed);
+        return this._listPaginated(schemas.ListOfSchedules(), parsed);
     }
     /**
      * Creates a new schedule.
@@ -73,6 +74,6 @@ export class ScheduleCollectionClient extends ResourceCollectionClient {
      */
     async create(schedule) {
         parseArgument(schedule, scheduleCreateSchema);
-        return this._create(schedule);
+        return this._create(schemas.Schedule(), schedule);
     }
 }

package/dist/resource_clients/store_collection.js

@@ -1,5 +1,6 @@
 import { z } from 'zod';
 import { ResourceCollectionClient } from '../base/resource_collection_client.js';
+import * as schemas from '../schemas.js';
 import { paginationOptionsShape, parseArgument } from '../utils.js';
 const listOptionsSchema = z.strictObject({
     ...paginationOptionsShape,
@@ -63,6 +64,6 @@ export class StoreCollectionClient extends ResourceCollectionClient {
      */
     list(options = {}) {
         const parsed = parseArgument(options, listOptionsSchema, 'StoreCollectionListOptions');
-        return this._listPaginated(parsed);
+        return this._listPaginated(schemas.ListOfStoreActors(), parsed);
     }
 }

package/dist/resource_clients/task.js

@@ -1,7 +1,8 @@
 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 * as schemas from '../schemas.js';
+import { anyObjectSchema, cast, catchNotFoundOrThrow, parseArgument, parseResponse, stringifyWebhooksToBase64, } from '../utils.js';
 import { RunClient } from './run.js';
 import { RunCollectionClient } from './run_collection.js';
 import { WebhookCollectionClient } from './webhook_collection.js';
@@ -67,7 +68,7 @@ export class TaskClient extends ResourceClient {
      * @see https://docs.apify.com/api/v2/actor-task-get
      */
     async get() {
-        return this._get();
+        return this._get(schemas.Task());
     }
     /**
      * Updates the task with the specified fields.
@@ -78,7 +79,7 @@ export class TaskClient extends ResourceClient {
      */
     async update(newFields) {
         parseArgument(newFields, anyObjectSchema);
-        return this._update(newFields);
+        return this._update(schemas.Task(), newFields);
     }
     /**
      * Publishes the task on its public landing page, by setting `isPublic` through
@@ -161,7 +162,7 @@ export class TaskClient extends ResourceClient {
             },
         };
         const response = await this.httpClient.call(request);
-        return cast(parseDateFields(pluckData(response.data)));
+        return parseResponse(response, schemas.Run());
     }
     /**
      * Starts a task and waits for it to finish before returning the Run object.

package/dist/resource_clients/task_collection.js

@@ -1,5 +1,6 @@
 import { z } from 'zod';
 import { ResourceCollectionClient } from '../base/resource_collection_client.js';
+import * as schemas from '../schemas.js';
 import { anyObjectSchema, paginationOptionsShape, parseArgument } from '../utils.js';
 const listOptionsSchema = z.strictObject({
     ...paginationOptionsShape,
@@ -61,7 +62,7 @@ export class TaskCollectionClient extends ResourceCollectionClient {
      */
     list(options = {}) {
         const parsed = parseArgument(options, listOptionsSchema, 'TaskCollectionListOptions');
-        return this._listPaginated(parsed);
+        return this._listPaginated(schemas.ListOfTasks(), parsed);
     }
     /**
      * Creates a new task.
@@ -72,6 +73,6 @@ export class TaskCollectionClient extends ResourceCollectionClient {
      */
     async create(task) {
         parseArgument(task, anyObjectSchema);
-        return this._create(task);
+        return this._create(schemas.Task(), task);
     }
 }

package/dist/resource_clients/user.js

@@ -1,5 +1,6 @@
 import { ResourceClient } from '../base/resource_client.js';
-import { cast, catchNotFoundOrThrow, parseDateFields, pluckData } from '../utils.js';
+import * as schemas from '../schemas.js';
+import { catchNotFoundOrThrow, parseResponse } from '../utils.js';
 export { PlatformFeature } from '../models.js';
 /**
  * Client for managing user account information.
@@ -45,7 +46,7 @@ export class UserClient extends ResourceClient {
      * @see https://docs.apify.com/api/v2/user-get
      */
     async get() {
-        return this._get();
+        return this._get(schemas.UserPrivateInfo());
     }
     /**
      * Retrieves the user's monthly usage data.
@@ -62,9 +63,8 @@ export class UserClient extends ResourceClient {
         };
         try {
             const response = await this.httpClient.call(requestOpts);
-            return cast(parseDateFields(pluckData(response.data), 
-            // Convert  monthlyUsage.dailyServiceUsages[].date to Date (by default it's ignored by parseDateFields)
-            /* shouldParseField = */ (key) => key === 'date'));
+            // `dailyServiceUsages[].date` does not end in `At`, so it has to be named for `parseDateFields`.
+            return parseResponse(response, schemas.MonthlyUsage(), (key) => key === 'date');
         }
         catch (err) {
             catchNotFoundOrThrow(err);
@@ -86,7 +86,7 @@ export class UserClient extends ResourceClient {
         };
         try {
             const response = await this.httpClient.call(requestOpts);
-            return cast(parseDateFields(pluckData(response.data)));
+            return parseResponse(response, schemas.AccountLimits());
         }
         catch (err) {
             catchNotFoundOrThrow(err);

package/dist/resource_clients/webhook.js

@@ -1,5 +1,6 @@
 import { ResourceClient } from '../base/resource_client.js';
-import { anyObjectSchema, cast, catchNotFoundOrThrow, parseArgument, parseDateFields, pluckData } from '../utils.js';
+import * as schemas from '../schemas.js';
+import { anyObjectSchema, catchNotFoundOrThrow, parseArgument, parseResponse } from '../utils.js';
 import { WebhookDispatchCollectionClient } from './webhook_dispatch_collection.js';
 /**
  * Client for managing a specific webhook.
@@ -46,7 +47,7 @@ export class WebhookClient extends ResourceClient {
      * @see https://docs.apify.com/api/v2/webhook-get
      */
     async get() {
-        return this._get();
+        return this._get(schemas.Webhook());
     }
     /**
      * Updates the webhook with the specified fields.
@@ -57,7 +58,7 @@ export class WebhookClient extends ResourceClient {
      */
     async update(newFields) {
         parseArgument(newFields, anyObjectSchema);
-        return this._update(newFields);
+        return this._update(schemas.Webhook(), newFields);
     }
     /**
      * Deletes the webhook.
@@ -81,7 +82,7 @@ export class WebhookClient extends ResourceClient {
         };
         try {
             const response = await this.httpClient.call(request);
-            return cast(parseDateFields(pluckData(response.data)));
+            return parseResponse(response, schemas.WebhookDispatch());
         }
         catch (err) {
             catchNotFoundOrThrow(err);

package/dist/resource_clients/webhook_collection.js

@@ -1,5 +1,6 @@
 import { z } from 'zod';
 import { ResourceCollectionClient } from '../base/resource_collection_client.js';
+import * as schemas from '../schemas.js';
 import { anyObjectSchema, paginationOptionsShape, parseArgument } from '../utils.js';
 const listOptionsSchema = z.strictObject({
     ...paginationOptionsShape,
@@ -61,7 +62,7 @@ export class WebhookCollectionClient extends ResourceCollectionClient {
      */
     list(options = {}) {
         const parsed = parseArgument(options, listOptionsSchema, 'WebhookCollectionListOptions');
-        return this._listPaginated(parsed);
+        return this._listPaginated(schemas.ListOfWebhooks(), parsed);
     }
     /**
      * Creates a new webhook.
@@ -72,6 +73,6 @@ export class WebhookCollectionClient extends ResourceCollectionClient {
      */
     async create(webhook) {
         parseArgument(webhook, webhookCreateSchema);
-        return this._create(webhook);
+        return this._create(schemas.Webhook(), webhook);
     }
 }

package/dist/resource_clients/webhook_dispatch.js

@@ -1,4 +1,5 @@
 import { ResourceClient } from '../base/resource_client.js';
+import * as schemas from '../schemas.js';
 export { WebhookDispatchStatus } from '../models.js';
 /**
  * Client for managing a specific webhook dispatch.
@@ -35,6 +36,6 @@ export class WebhookDispatchClient extends ResourceClient {
      * @see https://docs.apify.com/api/v2/webhook-dispatch-get
      */
     async get() {
-        return this._get();
+        return this._get(schemas.WebhookDispatch());
     }
 }

package/dist/resource_clients/webhook_dispatch_collection.js

@@ -1,5 +1,6 @@
 import { z } from 'zod';
 import { ResourceCollectionClient } from '../base/resource_collection_client.js';
+import * as schemas from '../schemas.js';
 import { paginationOptionsShape, parseArgument } from '../utils.js';
 const listOptionsSchema = z.strictObject({
     ...paginationOptionsShape,
@@ -55,6 +56,6 @@ export class WebhookDispatchCollectionClient extends ResourceCollectionClient {
      */
     list(options = {}) {
         const parsed = parseArgument(options, listOptionsSchema, 'WebhookDispatchCollectionListOptions');
-        return this._listPaginated(parsed);
+        return this._listPaginated(schemas.ListOfWebhookDispatches(), parsed);
     }
 }

package/dist/response_validation_error.d.ts

@@ -0,0 +1,26 @@
+import type { z } from 'zod';
+/**
+ * Thrown when an API response does not match the schema the client expects for it.
+ *
+ * The schemas are generated from the Apify OpenAPI specification, so this error means the API returned
+ * something the specification does not describe -- a missing required field, a different type, a value
+ * outside the documented range. Unknown fields and unknown enum values are not errors: the schemas let
+ * both through, so the client keeps working when the API grows.
+ *
+ * The `message` names the request and every offending field with the value it received, and ends by asking for
+ * a bug report: the mismatch is in the API or its specification, not in the caller's code. The structured
+ * {@link https://zod.dev | zod} issues are available on `issues`, and the original `ZodError` on `cause`,
+ * for programmatic inspection.
+ */
+export declare class ResponseValidationError extends Error {
+    /** Structured issues from the underlying schema check. */
+    readonly issues: z.ZodError['issues'];
+    /** HTTP method of the request whose response failed validation, upper-cased. */
+    readonly method: string;
+    /** URL of the request whose response failed validation, without its query string. */
+    readonly url: string;
+    constructor(error: z.ZodError, value: unknown, request: {
+        method: string;
+        url: string;
+    });
+}

package/dist/response_validation_error.js

@@ -0,0 +1,37 @@
+import { ArgumentValidationError } from '@apify/validations';
+const REPORT_HINT = 'The API returned something its OpenAPI specification does not describe. ' +
+    'Please report this at https://github.com/apify/apify-client-js/issues.';
+/**
+ * Thrown when an API response does not match the schema the client expects for it.
+ *
+ * The schemas are generated from the Apify OpenAPI specification, so this error means the API returned
+ * something the specification does not describe -- a missing required field, a different type, a value
+ * outside the documented range. Unknown fields and unknown enum values are not errors: the schemas let
+ * both through, so the client keeps working when the API grows.
+ *
+ * The `message` names the request and every offending field with the value it received, and ends by asking for
+ * a bug report: the mismatch is in the API or its specification, not in the caller's code. The structured
+ * {@link https://zod.dev | zod} issues are available on `issues`, and the original `ZodError` on `cause`,
+ * for programmatic inspection.
+ */
+export class ResponseValidationError extends Error {
+    /** Structured issues from the underlying schema check. */
+    issues;
+    /** HTTP method of the request whose response failed validation, upper-cased. */
+    method;
+    /** URL of the request whose response failed validation, without its query string. */
+    url;
+    constructor(error, value, request) {
+        const method = request.method.toUpperCase();
+        // `@apify/validations` keeps its zod error formatter private, so the issue lines come from the
+        // message of the error class it does export.
+        const details = new ArgumentValidationError(error, value).message;
+        super(`Response from ${method} ${request.url} does not match the API schema:\n${details}\n${REPORT_HINT}`, {
+            cause: error,
+        });
+        this.name = 'ResponseValidationError';
+        this.issues = error.issues;
+        this.method = method;
+        this.url = request.url;
+    }
+}

package/dist/schemas.d.ts

@@ -0,0 +1,15 @@
+/**
+ * The schemas the resource clients validate API responses with.
+ *
+ * Today these are exactly the generated ones. The module still exists as the one place where a generated
+ * schema is widened when the API is known to return something the specification does not describe, so a
+ * documented deviation never sends a resource client reaching into `./generated` directly. An override
+ * declared here shadows the generated export of the same name and takes the same form, a `lazySchema()` thunk
+ * built on the generated schema it replaces. Every schema that embeds an overridden one has to be rebuilt on
+ * top of it, and `spec_guards.ts` checks that each override still accepts what the specification describes,
+ * so one cannot narrow by accident.
+ *
+ * Spec gaps need no override: the generated objects are loose, so a field the specification omits passes
+ * through. Neither do client narrowings: a schema only ever accepts more than the published type.
+ */
+export * from './generated/schemas.js';