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

package/README.md

@@ -47,7 +47,9 @@ Besides greatly simplifying the process of querying the Apify API, the client pr
 Based on the endpoint, the client automatically extracts the relevant data and returns it in the
 expected format. Date strings are automatically converted to `Date` objects. For exceptions,
 we throw an `ApifyApiError`, which wraps the plain JSON errors returned by API and enriches
-them with other context for easier debugging.
+them with other context for easier debugging. The error is an instance of the subclass matching the
+HTTP status code, such as `NotFoundError` or `RateLimitError`, so a `catch` block can tell them apart
+with `instanceof`.
 
 ### Retries with exponential backoff
 

package/dist/apify_api_error.d.ts

@@ -1,16 +1,28 @@
 import type { AxiosResponse } from 'axios';
+import type { LiteralUnion } from 'type-fest';
+import type { ApifyApiErrorType } from './models.js';
+export type { ApifyApiErrorType } from './models.js';
 /**
  * An `ApifyApiError` is thrown for successful HTTP requests that reach the API,
  * but the API responds with an error response. Typically, those are rate limit
  * errors and internal errors, which are automatically retried, or validation
  * errors, which are thrown immediately, because a correction by the user is
  * needed.
+ *
+ * The thrown error is an instance of the subclass matching the HTTP status code of the response:
+ * {@link InvalidRequestError} (400), {@link UnauthorizedError} (401), {@link ForbiddenError} (403),
+ * {@link NotFoundError} (404), {@link ConflictError} (409), {@link RateLimitError} (429) or
+ * {@link ServerError} (5xx). Any other status code is thrown as a plain `ApifyApiError`. Every
+ * subclass extends `ApifyApiError`, so `instanceof ApifyApiError` matches all of them. Errors that
+ * share a status code are told apart by their `type`.
  */
 export declare class ApifyApiError extends Error {
+    #private;
     name: string;
     /**
-     * The invoked resource client and the method. Known issue: Sometimes it displays
-     * as `unknown` because it can't be parsed from a stack trace.
+     * The resource client and the method parsed from the stack trace, such as `ActorClient.getResource`. A public
+     * method that delegates to a shared helper of its class is reported under the helper. The value is `unknown`
+     * when the stack trace cannot be parsed.
      */
     clientMethod: string;
     /**
@@ -18,9 +30,10 @@ export declare class ApifyApiError extends Error {
      */
     statusCode: number;
     /**
-     * The type of the error, as returned by the API.
+     * The type of the error, as returned by the API. Typed as the known {@link ApifyApiErrorType}
+     * values for autocompletion, while still accepting any string the API may return.
      */
-    type?: string;
+    type?: LiteralUnion<ApifyApiErrorType, string>;
     /**
      * Number of the API call attempt.
      */
@@ -46,21 +59,49 @@ export declare class ApifyApiError extends Error {
      * @hidden
      */
     constructor(response: AxiosResponse, attempt: number);
-    private _safelyParsePathFromResponse;
-    private _extractClientAndMethodFromStack;
     /**
-     * Creates a better looking and more informative stack that will be printed
-     * out when API errors are thrown.
-     *
-     * Example:
-     *
-     * ApifyApiError: Actor task was not found
-     *   clientMethod: TaskClient.start
-     *   statusCode: 404
-     *   type: record-not-found
-     *   attempt: 1
-     *   httpMethod: post
-     *   path: /v2/actor-tasks/user~my-task/runs
+     * Creates the error for a failed response as an instance of the subclass matching its HTTP status code.
+     * @hidden
      */
-    private _createApiStack;
+    static fromResponse(response: AxiosResponse, attempt: number): ApifyApiError;
+}
+/**
+ * Thrown when the Apify API responds with HTTP 400 Bad Request, typically because the request
+ * failed validation.
+ */
+export declare class InvalidRequestError extends ApifyApiError {
+}
+/**
+ * Thrown when the Apify API responds with HTTP 401 Unauthorized, because the token is missing
+ * or invalid.
+ */
+export declare class UnauthorizedError extends ApifyApiError {
+}
+/**
+ * Thrown when the Apify API responds with HTTP 403 Forbidden, because the token lacks the
+ * permission for the operation.
+ */
+export declare class ForbiddenError extends ApifyApiError {
+}
+/**
+ * Thrown when the Apify API responds with HTTP 404 Not Found.
+ */
+export declare class NotFoundError extends ApifyApiError {
+}
+/**
+ * Thrown when the Apify API responds with HTTP 409 Conflict.
+ */
+export declare class ConflictError extends ApifyApiError {
+}
+/**
+ * Thrown when the Apify API responds with HTTP 429 Too Many Requests. The client retries such
+ * requests, so the error surfaces once the retries are exhausted.
+ */
+export declare class RateLimitError extends ApifyApiError {
+}
+/**
+ * Thrown when the Apify API responds with an HTTP 5xx status. The client retries such requests,
+ * so the error surfaces once the retries are exhausted.
+ */
+export declare class ServerError extends ApifyApiError {
 }

package/dist/apify_api_error.js

@@ -1,27 +1,35 @@
 import { isomorphicBufferToString } from './body_parser.js';
 import { isBuffer } from './utils.js';
 /**
- * Examples of capturing groups for "...at ActorCollectionClient._list (/Users/..."
- * 0: "at ActorCollectionClient._list ("
+ * Examples of capturing groups for "...at ActorCollectionClient.listResources (/Users/..."
+ * 0: "at ActorCollectionClient.listResources ("
  * 1: undefined
  * 2: "ActorCollectionClient"
  * 3: undefined
- * 4: "list"
+ * 4: "listResources"
  * @private
  */
-const CLIENT_METHOD_REGEX = /at( async)? ([A-Za-z]+(Collection)?Client)\._?([A-Za-z]+) \(/;
+const CLIENT_METHOD_REGEX = /at( async)? ([A-Za-z]+(Collection)?Client)\.([A-Za-z]+) \(/;
 /**
  * An `ApifyApiError` is thrown for successful HTTP requests that reach the API,
  * but the API responds with an error response. Typically, those are rate limit
  * errors and internal errors, which are automatically retried, or validation
  * errors, which are thrown immediately, because a correction by the user is
  * needed.
+ *
+ * The thrown error is an instance of the subclass matching the HTTP status code of the response:
+ * {@link InvalidRequestError} (400), {@link UnauthorizedError} (401), {@link ForbiddenError} (403),
+ * {@link NotFoundError} (404), {@link ConflictError} (409), {@link RateLimitError} (429) or
+ * {@link ServerError} (5xx). Any other status code is thrown as a plain `ApifyApiError`. Every
+ * subclass extends `ApifyApiError`, so `instanceof ApifyApiError` matches all of them. Errors that
+ * share a status code are told apart by their `type`.
  */
 export class ApifyApiError extends Error {
     name;
     /**
-     * The invoked resource client and the method. Known issue: Sometimes it displays
-     * as `unknown` because it can't be parsed from a stack trace.
+     * The resource client and the method parsed from the stack trace, such as `ActorClient.getResource`. A public
+     * method that delegates to a shared helper of its class is reported under the helper. The value is `unknown`
+     * when the stack trace cannot be parsed.
      */
     clientMethod;
     /**
@@ -29,7 +37,8 @@ export class ApifyApiError extends Error {
      */
     statusCode;
     /**
-     * The type of the error, as returned by the API.
+     * The type of the error, as returned by the API. Typed as the known {@link ApifyApiErrorType}
+     * values for autocompletion, while still accepting any string the API may return.
      */
     type;
     /**
@@ -61,14 +70,16 @@ export class ApifyApiError extends Error {
         let type;
         let responseData = response.data;
         let errorData;
-        // Some methods (e.g. downloadItems) set up forceBuffer on request response. If this request failed
-        // the body buffer needs to parse to get the correct error.
+        // A `forceBuffer` request (e.g. `downloadItems()`) and a failed streaming request, whose body `HttpClient`
+        // has read into a buffer, both arrive unparsed. Parse the body here to get at the error.
         if (isBuffer(responseData)) {
+            const body = isomorphicBufferToString(response.data, 'utf-8');
             try {
-                responseData = JSON.parse(isomorphicBufferToString(response.data, 'utf-8'));
+                responseData = JSON.parse(body);
             }
             catch {
-                // This can happen. The data in the response body are malformed.
+                // A body that is not JSON at all, such as an HTML error page from a proxy, is kept as text.
+                responseData = body;
             }
         }
         if (responseData && responseData.error) {
@@ -89,18 +100,26 @@ export class ApifyApiError extends Error {
         }
         super(message);
         this.name = this.constructor.name;
-        this.clientMethod = this._extractClientAndMethodFromStack();
+        this.clientMethod = this.#extractClientAndMethodFromStack();
         this.statusCode = response.status;
         this.type = type;
         this.attempt = attempt;
         this.httpMethod = response.config?.method;
-        this.path = this._safelyParsePathFromResponse(response);
+        this.path = this.#safelyParsePathFromResponse(response);
         const stack = this.stack;
         this.originalStack = stack.slice(stack.indexOf('\n'));
-        this.stack = this._createApiStack();
+        this.stack = this.#createApiStack();
         this.data = errorData;
     }
-    _safelyParsePathFromResponse(response) {
+    /**
+     * Creates the error for a failed response as an instance of the subclass matching its HTTP status code.
+     * @hidden
+     */
+    static fromResponse(response, attempt) {
+        const ErrorClass = ERROR_CLASS_BY_STATUS[response.status] ?? (response.status >= 500 ? ServerError : ApifyApiError);
+        return new ErrorClass(response, attempt);
+    }
+    #safelyParsePathFromResponse(response) {
         const urlString = response.config?.url;
         let url;
         try {
@@ -111,11 +130,11 @@ export class ApifyApiError extends Error {
         }
         return url.pathname + url.search;
     }
-    _extractClientAndMethodFromStack() {
+    #extractClientAndMethodFromStack() {
         const match = this.stack.match(CLIENT_METHOD_REGEX);
-        if (match)
-            return `${match[2]}.${match[4]}`;
-        return 'unknown';
+        if (!match)
+            return 'unknown';
+        return `${match[2]}.${match[4]}`;
     }
     /**
      * Creates a better looking and more informative stack that will be printed
@@ -123,7 +142,7 @@ export class ApifyApiError extends Error {
      *
      * Example:
      *
-     * ApifyApiError: Actor task was not found
+     * NotFoundError: Actor task was not found
      *   clientMethod: TaskClient.start
      *   statusCode: 404
      *   type: record-not-found
@@ -131,7 +150,7 @@ export class ApifyApiError extends Error {
      *   httpMethod: post
      *   path: /v2/actor-tasks/user~my-task/runs
      */
-    _createApiStack() {
+    #createApiStack() {
         const { name, ...props } = this;
         const stack = Object.entries(props)
             .map(([k, v]) => {
@@ -145,3 +164,51 @@ export class ApifyApiError extends Error {
         return `${name}: ${this.message}\n${stack}`;
     }
 }
+/**
+ * Thrown when the Apify API responds with HTTP 400 Bad Request, typically because the request
+ * failed validation.
+ */
+export class InvalidRequestError extends ApifyApiError {
+}
+/**
+ * Thrown when the Apify API responds with HTTP 401 Unauthorized, because the token is missing
+ * or invalid.
+ */
+export class UnauthorizedError extends ApifyApiError {
+}
+/**
+ * Thrown when the Apify API responds with HTTP 403 Forbidden, because the token lacks the
+ * permission for the operation.
+ */
+export class ForbiddenError extends ApifyApiError {
+}
+/**
+ * Thrown when the Apify API responds with HTTP 404 Not Found.
+ */
+export class NotFoundError extends ApifyApiError {
+}
+/**
+ * Thrown when the Apify API responds with HTTP 409 Conflict.
+ */
+export class ConflictError extends ApifyApiError {
+}
+/**
+ * Thrown when the Apify API responds with HTTP 429 Too Many Requests. The client retries such
+ * requests, so the error surfaces once the retries are exhausted.
+ */
+export class RateLimitError extends ApifyApiError {
+}
+/**
+ * Thrown when the Apify API responds with an HTTP 5xx status. The client retries such requests,
+ * so the error surfaces once the retries are exhausted.
+ */
+export class ServerError extends ApifyApiError {
+}
+const ERROR_CLASS_BY_STATUS = {
+    400: InvalidRequestError,
+    401: UnauthorizedError,
+    403: ForbiddenError,
+    404: NotFoundError,
+    409: ConflictError,
+    429: RateLimitError,
+};

package/dist/apify_client.d.ts

@@ -49,6 +49,7 @@ import { Statistics } from './statistics.js';
  * @see https://docs.apify.com/api/v2
  */
 export declare class ApifyClient {
+    #private;
     baseUrl: string;
     /**
      * @since Added in 2.17.0
@@ -59,7 +60,6 @@ export declare class ApifyClient {
     logger: Log;
     httpClient: HttpClient;
     constructor(options?: ApifyClientOptions);
-    private _options;
     /**
      * Returns a client for managing Actors in your account.
      *
@@ -364,8 +364,27 @@ export interface ApifyClientOptions {
     minDelayBetweenRetriesMillis?: number;
     /** @default [] */
     requestInterceptors?: RequestInterceptorFunction[];
-    /** @default 360 */
-    timeoutSecs?: number;
+    /**
+     * Duration of the `short` timeout tier, in seconds: simple metadata reads and writes.
+     * @default 5
+     */
+    timeoutShortSecs?: number;
+    /**
+     * Duration of the `medium` timeout tier, in seconds: listing, batch and trigger operations.
+     * @default 30
+     */
+    timeoutMediumSecs?: number;
+    /**
+     * Duration of the `long` timeout tier, in seconds: downloads, uploads and streaming.
+     * @default 360
+     */
+    timeoutLongSecs?: number;
+    /**
+     * Cap on the timeout of a single request attempt, in seconds. It bounds the doubling of the timeout across
+     * retries, and caps tier and per-call timeouts alike, so raise it to allow a request timeout above 360 s.
+     * @default 360
+     */
+    timeoutMaxSecs?: number;
     token?: string;
     /**
      * @since Added in 2.10.0

package/dist/apify_client.js

@@ -26,22 +26,25 @@ import { WebhookCollectionClient } from './resource_clients/webhook_collection.j
 import { WebhookDispatchClient } from './resource_clients/webhook_dispatch.js';
 import { WebhookDispatchCollectionClient } from './resource_clients/webhook_dispatch_collection.js';
 import { Statistics } from './statistics.js';
+import { DEFAULT_TIMEOUT_LONG_SECS, DEFAULT_TIMEOUT_MAX_SECS, DEFAULT_TIMEOUT_MEDIUM_SECS, DEFAULT_TIMEOUT_SHORT_SECS, } from './timeouts.js';
 import { parseArgument } from './utils.js';
-const DEFAULT_TIMEOUT_SECS = 360;
 const clientOptionsSchema = z.strictObject({
     baseUrl: z.string().default('https://api.apify.com'),
     publicBaseUrl: z.string().default('https://api.apify.com'),
     maxRetries: z.number().default(8),
     minDelayBetweenRetriesMillis: z.number().default(500),
     requestInterceptors: z.array(z.unknown()).default([]),
-    timeoutSecs: z.number().default(DEFAULT_TIMEOUT_SECS),
+    timeoutShortSecs: z.number().positive().default(DEFAULT_TIMEOUT_SHORT_SECS),
+    timeoutMediumSecs: z.number().positive().default(DEFAULT_TIMEOUT_MEDIUM_SECS),
+    timeoutLongSecs: z.number().positive().default(DEFAULT_TIMEOUT_LONG_SECS),
+    timeoutMaxSecs: z.number().positive().default(DEFAULT_TIMEOUT_MAX_SECS),
     token: z.string().optional(),
     userAgentSuffix: z.union([z.string(), z.array(z.string())]).optional(),
 });
 const resourceIdSchema = z.string().min(1);
 const requestQueueOptionsSchema = z.strictObject({
     clientKey: z.string().min(1).optional(),
-    timeoutSecs: z.number().optional(),
+    timeoutSecs: z.number().positive().optional(),
 });
 /**
  * The official JavaScript client for the Apify API.
@@ -76,7 +79,7 @@ export class ApifyClient {
     httpClient;
     constructor(options = {}) {
         const parsed = parseArgument(options, clientOptionsSchema, 'ApifyClientOptions');
-        const { baseUrl, publicBaseUrl, maxRetries, minDelayBetweenRetriesMillis, requestInterceptors, timeoutSecs, token, } = parsed;
+        const { baseUrl, publicBaseUrl, maxRetries, minDelayBetweenRetriesMillis, requestInterceptors, timeoutShortSecs, timeoutMediumSecs, timeoutLongSecs, timeoutMaxSecs, token, } = parsed;
         const tempBaseUrl = baseUrl.endsWith('/') ? baseUrl.slice(0, baseUrl.length - 1) : baseUrl;
         this.baseUrl = `${tempBaseUrl}/v2`;
         const tempPublicBaseUrl = publicBaseUrl.endsWith('/')
@@ -91,13 +94,16 @@ export class ApifyClient {
             maxRetries,
             minDelayBetweenRetriesMillis,
             requestInterceptors,
-            timeoutSecs,
+            timeoutShortSecs,
+            timeoutMediumSecs,
+            timeoutLongSecs,
+            timeoutMaxSecs,
             logger: this.logger,
             token: this.token,
             userAgentSuffix: parsed.userAgentSuffix,
         });
     }
-    _options() {
+    #subClientOptions() {
         return {
             baseUrl: this.baseUrl,
             publicBaseUrl: this.publicBaseUrl,
@@ -114,7 +120,7 @@ export class ApifyClient {
      * @see https://docs.apify.com/api/v2/acts-get
      */
     actors() {
-        return new ActorCollectionClient(this._options());
+        return new ActorCollectionClient(this.#subClientOptions());
     }
     /**
      * Returns a client for a specific Actor.
@@ -136,7 +142,7 @@ export class ApifyClient {
         parseArgument(id, resourceIdSchema);
         return new ActorClient({
             id,
-            ...this._options(),
+            ...this.#subClientOptions(),
         });
     }
     /**
@@ -148,7 +154,7 @@ export class ApifyClient {
      * @see https://docs.apify.com/api/v2/actor-builds-get
      */
     builds() {
-        return new BuildCollectionClient(this._options());
+        return new BuildCollectionClient(this.#subClientOptions());
     }
     /**
      * Returns a client for a specific Actor build.
@@ -163,7 +169,7 @@ export class ApifyClient {
         parseArgument(id, resourceIdSchema);
         return new BuildClient({
             id,
-            ...this._options(),
+            ...this.#subClientOptions(),
         });
     }
     /**
@@ -175,7 +181,7 @@ export class ApifyClient {
      * @see https://docs.apify.com/api/v2/datasets-get
      */
     datasets() {
-        return new DatasetCollectionClient(this._options());
+        return new DatasetCollectionClient(this.#subClientOptions());
     }
     /**
      * Returns a client for a specific dataset.
@@ -204,7 +210,7 @@ export class ApifyClient {
         parseArgument(id, resourceIdSchema);
         return new DatasetClient({
             id,
-            ...this._options(),
+            ...this.#subClientOptions(),
         });
     }
     /**
@@ -216,7 +222,7 @@ export class ApifyClient {
      * @see https://docs.apify.com/api/v2/key-value-stores-get
      */
     keyValueStores() {
-        return new KeyValueStoreCollectionClient(this._options());
+        return new KeyValueStoreCollectionClient(this.#subClientOptions());
     }
     /**
      * Returns a client for a specific key-value store.
@@ -241,7 +247,7 @@ export class ApifyClient {
         parseArgument(id, resourceIdSchema);
         return new KeyValueStoreClient({
             id,
-            ...this._options(),
+            ...this.#subClientOptions(),
         });
     }
     /**
@@ -255,7 +261,7 @@ export class ApifyClient {
         parseArgument(buildOrRunId, resourceIdSchema);
         return new LogClient({
             id: buildOrRunId,
-            ...this._options(),
+            ...this.#subClientOptions(),
         });
     }
     /**
@@ -267,7 +273,7 @@ export class ApifyClient {
      * @see https://docs.apify.com/api/v2/request-queues-get
      */
     requestQueues() {
-        return new RequestQueueCollectionClient(this._options());
+        return new RequestQueueCollectionClient(this.#subClientOptions());
     }
     /**
      * Returns a client for a specific request queue.
@@ -295,7 +301,7 @@ export class ApifyClient {
         const parsed = parseArgument(options, requestQueueOptionsSchema, 'RequestQueueUserOptions');
         const apiClientOptions = {
             id,
-            ...this._options(),
+            ...this.#subClientOptions(),
         };
         return new RequestQueueClient(apiClientOptions, parsed);
     }
@@ -309,7 +315,7 @@ export class ApifyClient {
      */
     runs() {
         return new RunCollectionClient({
-            ...this._options(),
+            ...this.#subClientOptions(),
             resourcePath: 'actor-runs',
         });
     }
@@ -336,7 +342,7 @@ export class ApifyClient {
         parseArgument(id, resourceIdSchema);
         return new RunClient({
             id,
-            ...this._options(),
+            ...this.#subClientOptions(),
         });
     }
     /**
@@ -348,7 +354,7 @@ export class ApifyClient {
      * @see https://docs.apify.com/api/v2/actor-tasks-get
      */
     tasks() {
-        return new TaskCollectionClient(this._options());
+        return new TaskCollectionClient(this.#subClientOptions());
     }
     /**
      * Returns a client for a specific Actor task.
@@ -369,7 +375,7 @@ export class ApifyClient {
         parseArgument(id, resourceIdSchema);
         return new TaskClient({
             id,
-            ...this._options(),
+            ...this.#subClientOptions(),
         });
     }
     /**
@@ -381,7 +387,7 @@ export class ApifyClient {
      * @see https://docs.apify.com/api/v2/schedules-get
      */
     schedules() {
-        return new ScheduleCollectionClient(this._options());
+        return new ScheduleCollectionClient(this.#subClientOptions());
     }
     /**
      * Returns a client for a specific schedule.
@@ -396,7 +402,7 @@ export class ApifyClient {
         parseArgument(id, resourceIdSchema);
         return new ScheduleClient({
             id,
-            ...this._options(),
+            ...this.#subClientOptions(),
         });
     }
     /**
@@ -412,7 +418,7 @@ export class ApifyClient {
         parseArgument(id, resourceIdSchema);
         return new UserClient({
             id,
-            ...this._options(),
+            ...this.#subClientOptions(),
         });
     }
     /**
@@ -424,7 +430,7 @@ export class ApifyClient {
      * @see https://docs.apify.com/api/v2/webhooks-get
      */
     webhooks() {
-        return new WebhookCollectionClient(this._options());
+        return new WebhookCollectionClient(this.#subClientOptions());
     }
     /**
      * Returns a client for a specific webhook.
@@ -439,7 +445,7 @@ export class ApifyClient {
         parseArgument(id, resourceIdSchema);
         return new WebhookClient({
             id,
-            ...this._options(),
+            ...this.#subClientOptions(),
         });
     }
     /**
@@ -451,7 +457,7 @@ export class ApifyClient {
      * @see https://docs.apify.com/api/v2/webhook-dispatches-get
      */
     webhookDispatches() {
-        return new WebhookDispatchCollectionClient(this._options());
+        return new WebhookDispatchCollectionClient(this.#subClientOptions());
     }
     /**
      * Returns a client for a specific webhook dispatch.
@@ -464,7 +470,7 @@ export class ApifyClient {
         parseArgument(id, resourceIdSchema);
         return new WebhookDispatchClient({
             id,
-            ...this._options(),
+            ...this.#subClientOptions(),
         });
     }
     /**
@@ -476,7 +482,7 @@ export class ApifyClient {
      * @see https://docs.apify.com/api/v2/store-get
      */
     store() {
-        return new StoreCollectionClient(this._options());
+        return new StoreCollectionClient(this.#subClientOptions());
     }
     /**
      * Sets a status message for the current Actor run.

package/dist/base/api_client.d.ts

@@ -30,15 +30,15 @@ export declare abstract class ApiClient {
     httpClient: HttpClient;
     params?: Record<string, unknown>;
     constructor(options: ApiClientOptions);
-    protected _subResourceOptions<T>(moreOptions?: T): BaseOptions & T;
-    protected _url(path?: string | string[]): string;
-    protected _publicUrl(path?: string | string[]): string;
-    protected _params<T>(endpointParams?: T): Record<string, unknown>;
-    protected _toSafeId(id: string): string;
+    protected subResourceOptions<T>(moreOptions?: T): BaseOptions & T;
+    protected buildUrl(path?: string | string[]): string;
+    protected buildPublicUrl(path?: string | string[]): string;
+    protected buildParams<T>(endpointParams?: T): Record<string, unknown>;
+    protected toSafeId(id: string): string;
     /**
      * Returns async iterator to iterate through all items and Promise that can be awaited to get first page of results.
      */
-    protected _listPaginatedFromCallback<T extends PaginationOptions, Data, R extends PaginatedResponse<Data>>(getPaginatedList: (options?: T) => Promise<R>, options?: T): AsyncIterable<Data> & Promise<R>;
+    protected listPaginatedFromCallback<T extends PaginationOptions, Data, R extends PaginatedResponse<Data>>(getPaginatedList: (options?: T) => Promise<R>, options?: T): AsyncIterable<Data> & Promise<R>;
 }
 export interface BaseOptions {
     baseUrl: string;