@tolt/api 0.6.1 → 1.0.0

package/dist/api/resources/transactions/types/ListTransactionsRequestSort.js

@@ -1,5 +1,5 @@
 // This file was auto-generated by Fern from our API Definition.
-/** Column the list is ordered and paged by. */
+/** Timestamp to order and page by: created_at follows creation order, updated_at follows each item's most recent change. */
 export const ListTransactionsRequestSort = {
     CreatedAt: "created_at",
     UpdatedAt: "updated_at",

package/dist/api/resources/transactions/types/{RefundTransactionsResponse.d.ts → RefundTransactionResponse.d.ts}

@@ -1,5 +1,5 @@
 import type * as ToltApi from "../../../index.js";
-export interface RefundTransactionsResponse {
+export interface RefundTransactionResponse {
     success: boolean;
     message: string;
     data: ToltApi.Transaction;

package/dist/api/resources/transactions/types/{RerunFlowsTransactionsResponse.d.ts → RerunTransactionFlowsResponse.d.ts}

@@ -1,5 +1,5 @@
 import type * as ToltApi from "../../../index.js";
-export interface RerunFlowsTransactionsResponse {
+export interface RerunTransactionFlowsResponse {
     success: boolean;
     message: string;
     data: ToltApi.RerunFlowsResult;

package/dist/api/resources/transactions/types/UpdateTransactionResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as ToltApi from "../../../index.js";
+export interface UpdateTransactionResponse {
+    success: boolean;
+    message: string;
+    data: ToltApi.Transaction;
+}

package/dist/api/resources/transactions/types/index.d.ts

@@ -1,9 +1,9 @@
-export * from "./CreateTransactionsResponse.js";
-export * from "./DeleteTransactionsResponse.js";
-export * from "./GetTransactionsResponse.js";
+export * from "./CreateTransactionResponse.js";
+export * from "./DeleteTransactionResponse.js";
+export * from "./GetTransactionResponse.js";
 export * from "./ListTransactionsRequestOrder.js";
 export * from "./ListTransactionsRequestSort.js";
 export * from "./ListTransactionsResponse.js";
-export * from "./RefundTransactionsResponse.js";
-export * from "./RerunFlowsTransactionsResponse.js";
-export * from "./UpdateTransactionsResponse.js";
+export * from "./RefundTransactionResponse.js";
+export * from "./RerunTransactionFlowsResponse.js";
+export * from "./UpdateTransactionResponse.js";

package/dist/api/resources/transactions/types/index.js

@@ -1,9 +1,9 @@
-export * from "./CreateTransactionsResponse.js";
-export * from "./DeleteTransactionsResponse.js";
-export * from "./GetTransactionsResponse.js";
+export * from "./CreateTransactionResponse.js";
+export * from "./DeleteTransactionResponse.js";
+export * from "./GetTransactionResponse.js";
 export * from "./ListTransactionsRequestOrder.js";
 export * from "./ListTransactionsRequestSort.js";
 export * from "./ListTransactionsResponse.js";
-export * from "./RefundTransactionsResponse.js";
-export * from "./RerunFlowsTransactionsResponse.js";
-export * from "./UpdateTransactionsResponse.js";
+export * from "./RefundTransactionResponse.js";
+export * from "./RerunTransactionFlowsResponse.js";
+export * from "./UpdateTransactionResponse.js";

package/dist/api/types/Commission.d.ts

@@ -18,7 +18,7 @@ export interface Commission {
     is_ad_click: boolean | null;
     is_self_referral: boolean | null;
     approval_type: string | null;
-    scheduled_approval_date: string;
+    scheduled_approval_date: string | null;
     created_at: string;
     updated_at: string;
 }

package/dist/api/types/Customer.d.ts

@@ -12,8 +12,8 @@ export interface Customer {
     link_id: string | null;
     promotion_code_id: string | null;
     click_id: string | null;
-    lead_at: string;
-    active_at: string;
+    lead_at: string | null;
+    active_at: string | null;
     created_at: string;
     updated_at: string;
 }

package/dist/api/types/{Error_.d.ts → ErrorResponse.d.ts}

@@ -1,14 +1,14 @@
-export interface Error_ {
+export interface ErrorResponse {
     success: boolean;
     /** Human-readable explanation. May change; branch on code instead. */
     message: string;
     /** Stable machine-readable error code. */
-    code: Error_.Code;
+    code: ErrorResponse.Code;
     doc_url: string;
     /** One entry per offending field. Present on validation_error and invalid_reference. */
-    errors?: Error_.Errors.Item[] | undefined;
+    errors?: ErrorResponse.Errors.Item[] | undefined;
 }
-export declare namespace Error_ {
+export declare namespace ErrorResponse {
     /** Stable machine-readable error code. */
     const Code: {
         readonly BadRequest: "bad_request";
@@ -25,6 +25,7 @@ export declare namespace Error_ {
         readonly TransactionRefunded: "transaction_refunded";
         readonly CommissionExists: "commission_exists";
         readonly RateLimited: "rate_limited";
+        readonly PayloadTooLarge: "payload_too_large";
         readonly InternalError: "internal_error";
     };
     type Code = (typeof Code)[keyof typeof Code];

package/dist/api/types/{Error_.js → ErrorResponse.js}

@@ -1,8 +1,8 @@
 // This file was auto-generated by Fern from our API Definition.
-export var Error_;
-(function (Error_) {
+export var ErrorResponse;
+(function (ErrorResponse) {
     /** Stable machine-readable error code. */
-    Error_.Code = {
+    ErrorResponse.Code = {
         BadRequest: "bad_request",
         ValidationError: "validation_error",
         InvalidReference: "invalid_reference",
@@ -17,6 +17,7 @@ export var Error_;
         TransactionRefunded: "transaction_refunded",
         CommissionExists: "commission_exists",
         RateLimited: "rate_limited",
+        PayloadTooLarge: "payload_too_large",
         InternalError: "internal_error",
     };
-})(Error_ || (Error_ = {}));
+})(ErrorResponse || (ErrorResponse = {}));

package/dist/api/types/index.d.ts

@@ -4,7 +4,7 @@ export * from "./Commission.js";
 export * from "./CreatedPartner.js";
 export * from "./Customer.js";
 export * from "./EmbedToken.js";
-export * from "./Error_.js";
+export * from "./ErrorResponse.js";
 export * from "./Flow.js";
 export * from "./Group.js";
 export * from "./Link.js";

package/dist/api/types/index.js

@@ -4,7 +4,7 @@ export * from "./Commission.js";
 export * from "./CreatedPartner.js";
 export * from "./Customer.js";
 export * from "./EmbedToken.js";
-export * from "./Error_.js";
+export * from "./ErrorResponse.js";
 export * from "./Flow.js";
 export * from "./Group.js";
 export * from "./Link.js";

package/dist/core/exports.d.ts

@@ -1 +1,2 @@
 export * from "./logging/exports.js";
+export * from "./pagination/exports.js";

package/dist/core/exports.js

@@ -1 +1,2 @@
 export * from "./logging/exports.js";
+export * from "./pagination/exports.js";

package/dist/core/fetcher/Fetcher.js

@@ -5,12 +5,13 @@ import { EndpointSupplier } from "./EndpointSupplier.js";
 import { getErrorResponseBody } from "./getErrorResponseBody.js";
 import { getFetchFn } from "./getFetchFn.js";
 import { getRequestBody } from "./getRequestBody.js";
-import { getResponseBody } from "./getResponseBody.js";
+import { getResponseBody, isResponseBodyError } from "./getResponseBody.js";
 import { Headers } from "./Headers.js";
-import { makeRequest } from "./makeRequest.js";
+import { clearResponseTimeout, makeRequest } from "./makeRequest.js";
 import { abortRawResponse, toRawResponse, unknownRawResponse } from "./RawResponse.js";
 import { redactUrl, SENSITIVE_QUERY_PARAMS } from "./redactUrl.js";
 import { requestWithRetries } from "./requestWithRetries.js";
+import { TIMEOUT } from "./signals.js";
 const SENSITIVE_HEADERS = new Set([
     "authorization",
     "www-authenticate",
@@ -79,6 +80,10 @@ async function getHeaders(args) {
     }
     return newHeaders;
 }
+function isJsonContentType(contentType) {
+    const mediaType = contentType?.split(";")[0]?.trim().toLowerCase() ?? "";
+    return mediaType === "application/json" || mediaType === "text/json" || mediaType.endsWith("+json");
+}
 export async function fetcherImpl(args) {
     let url = args.url;
     if (args.queryString != null && args.queryString.length > 0) {
@@ -104,8 +109,19 @@ export async function fetcherImpl(args) {
         };
         logger.debug("Making HTTP request", metadata);
     }
+    // Bodies that are read in full here stay covered by the timeout; streamed bodies are read by the caller.
+    const keepTimeoutUntilBodyRead = args.responseType !== "streaming" && args.responseType !== "sse" && args.responseType !== "binary-response";
+    const attemptResponses = [];
     try {
-        const response = await requestWithRetries(async () => makeRequest(fetchFn, url, args.method, headers, requestBody, args.timeoutMs, args.abortSignal, args.withCredentials, args.duplex, args.responseType === "streaming" || args.responseType === "sse"), args.maxRetries);
+        const response = await requestWithRetries(async () => {
+            // A retry means the previous attempt is over; stop its timer now rather than at the end.
+            for (const previousResponse of attemptResponses) {
+                clearResponseTimeout(previousResponse);
+            }
+            const attemptResponse = await makeRequest(fetchFn, url, args.method, headers, requestBody, args.timeoutMs, args.abortSignal, args.withCredentials, args.duplex, args.responseType === "streaming" || args.responseType === "sse", keepTimeoutUntilBodyRead);
+            attemptResponses.push(attemptResponse);
+            return attemptResponse;
+        }, args.maxRetries, args.abortSignal);
         if (response.status >= 200 && response.status < 400) {
             if (logger.isDebug()) {
                 const metadata = {
@@ -117,6 +133,16 @@ export async function fetcherImpl(args) {
                 logger.debug("HTTP request succeeded", metadata);
             }
             const body = await getResponseBody(response, args.responseType);
+            // Only a body the server labelled as JSON is an error here; void endpoints may return plain text.
+            if (isResponseBodyError(body) &&
+                body.error.reason === "non-json" &&
+                isJsonContentType(response.headers.get("Content-Type"))) {
+                return {
+                    ok: false,
+                    error: body.error,
+                    rawResponse: toRawResponse(response),
+                };
+            }
             return {
                 ok: true,
                 body: body,
@@ -164,7 +190,7 @@ export async function fetcherImpl(args) {
                 rawResponse: abortRawResponse,
             };
         }
-        else if (error instanceof Error && error.name === "AbortError") {
+        else if (error === TIMEOUT || (error instanceof Error && error.name === "AbortError")) {
             if (logger.isError()) {
                 const metadata = {
                     method: args.method,
@@ -219,5 +245,10 @@ export async function fetcherImpl(args) {
             rawResponse: unknownRawResponse,
         };
     }
+    finally {
+        for (const attemptResponse of attemptResponses) {
+            clearResponseTimeout(attemptResponse);
+        }
+    }
 }
 export const fetcher = fetcherImpl;

package/dist/core/fetcher/getErrorResponseBody.js

@@ -1,9 +1,25 @@
 import { fromJson } from "../json.js";
-import { getResponseBody } from "./getResponseBody.js";
+import { getResponseBody, isResponseBodyError } from "./getResponseBody.js";
+/** Parses a JSON error body, falling back to the raw text so the status and body are never lost. */
+function parseJsonErrorBody(text) {
+    if (text.length === 0) {
+        return undefined;
+    }
+    try {
+        return fromJson(text);
+    }
+    catch {
+        return text;
+    }
+}
 export async function getErrorResponseBody(response) {
     let contentType = response.headers.get("Content-Type")?.toLowerCase();
     if (contentType == null || contentType.length === 0) {
-        return getResponseBody(response);
+        const body = await getResponseBody(response);
+        if (isResponseBodyError(body)) {
+            return body.error.reason === "non-json" ? body.error.rawBody : undefined;
+        }
+        return body;
     }
     if (contentType.indexOf(";") !== -1) {
         contentType = contentType.split(";")[0]?.trim() ?? "";
@@ -14,14 +30,11 @@ export async function getErrorResponseBody(response) {
         case "application/ld+json":
         case "application/problem+json":
         case "application/vnd.api+json":
-        case "text/json": {
-            const text = await response.text();
-            return text.length > 0 ? fromJson(text) : undefined;
-        }
+        case "text/json":
+            return parseJsonErrorBody(await response.text());
         default:
             if (contentType.startsWith("application/vnd.") && contentType.endsWith("+json")) {
-                const text = await response.text();
-                return text.length > 0 ? fromJson(text) : undefined;
+                return parseJsonErrorBody(await response.text());
             }
             // Fallback to plain text if content type is not recognized
             // Even if no body is present, the response will be an empty string

package/dist/core/fetcher/getResponseBody.d.ts

@@ -1 +1,17 @@
+export type ResponseBodyError = {
+    ok: false;
+    error: {
+        reason: "non-json";
+        statusCode: number;
+        rawBody: string;
+    } | {
+        reason: "body-is-null";
+        statusCode: number;
+    };
+};
+/**
+ * Returns true when `value` is a failure record created by `getResponseBody` (for example malformed JSON),
+ * as opposed to a parsed JSON body that happens to have the same shape.
+ */
+export declare function isResponseBodyError(value: unknown): value is ResponseBodyError;
 export declare function getResponseBody(response: Response, responseType?: string): Promise<unknown>;

package/dist/core/fetcher/getResponseBody.js

@@ -9,6 +9,19 @@ function retainResponse(target, response) {
         writable: false,
     });
 }
+const responseBodyErrors = new WeakSet();
+function responseBodyError(error) {
+    const record = { ok: false, error };
+    responseBodyErrors.add(record);
+    return record;
+}
+/**
+ * Returns true when `value` is a failure record created by `getResponseBody` (for example malformed JSON),
+ * as opposed to a parsed JSON body that happens to have the same shape.
+ */
+export function isResponseBodyError(value) {
+    return typeof value === "object" && value != null && responseBodyErrors.has(value);
+}
 export async function getResponseBody(response, responseType) {
     switch (responseType) {
         case "binary-response":
@@ -19,25 +32,19 @@ export async function getResponseBody(response, responseType) {
             return await response.arrayBuffer();
         case "sse":
             if (response.body == null) {
-                return {
-                    ok: false,
-                    error: {
-                        reason: "body-is-null",
-                        statusCode: response.status,
-                    },
-                };
+                return responseBodyError({
+                    reason: "body-is-null",
+                    statusCode: response.status,
+                });
             }
             retainResponse(response.body, response);
             return response.body;
         case "streaming":
             if (response.body == null) {
-                return {
-                    ok: false,
-                    error: {
-                        reason: "body-is-null",
-                        statusCode: response.status,
-                    },
-                };
+                return responseBodyError({
+                    reason: "body-is-null",
+                    statusCode: response.status,
+                });
             }
             retainResponse(response.body, response);
             return response.body;
@@ -52,14 +59,11 @@ export async function getResponseBody(response, responseType) {
             return responseBody;
         }
         catch (_err) {
-            return {
-                ok: false,
-                error: {
-                    reason: "non-json",
-                    statusCode: response.status,
-                    rawBody: text,
-                },
-            };
+            return responseBodyError({
+                reason: "non-json",
+                statusCode: response.status,
+                rawBody: text,
+            });
         }
     }
     return undefined;

package/dist/core/fetcher/makePassthroughRequest.js

@@ -6,6 +6,7 @@ import { makeRequest } from "./makeRequest.js";
 import { redactUrl } from "./redactUrl.js";
 import { requestWithRetries } from "./requestWithRetries.js";
 import { Supplier } from "./Supplier.js";
+import { TIMEOUT } from "./signals.js";
 /**
  * Makes a passthrough HTTP request using the SDK's configuration (auth, retry, logging, etc.)
  * while mimicking the standard `fetch` API.
@@ -109,8 +110,18 @@ export async function makePassthroughRequest(input, init, clientOptions, request
             hasBody: body != null,
         });
     }
-    const response = await requestWithRetries(async () => makeRequest(fetchFn, fullUrl, method, mergedHeaders, body ?? undefined, timeoutMs, abortSignal, effectiveInit?.credentials === "include", undefined, // duplex
-    false), maxRetries);
+    let response;
+    try {
+        response = await requestWithRetries(async () => makeRequest(fetchFn, fullUrl, method, mergedHeaders, body ?? undefined, timeoutMs, abortSignal, effectiveInit?.credentials === "include", undefined, // duplex
+        false), maxRetries, abortSignal);
+    }
+    catch (error) {
+        // Match `fetch`: a timeout rejects with an Error named "TimeoutError", not the bare abort reason.
+        if (error === TIMEOUT) {
+            throw createTimeoutError();
+        }
+        throw error;
+    }
     if (logger.isDebug()) {
         logger.debug("Passthrough HTTP request completed", {
             method,
@@ -120,6 +131,11 @@ export async function makePassthroughRequest(input, init, clientOptions, request
     }
     return response;
 }
+function createTimeoutError() {
+    const error = new Error("The request timed out.");
+    error.name = "TimeoutError";
+    return error;
+}
 /**
  * Returns true when the resolved request URL points at the same origin as the
  * configured base URL. Relative paths are always joined onto the base URL, so

package/dist/core/fetcher/makeRequest.d.ts

@@ -3,4 +3,9 @@ export declare function isCacheNoStoreSupported(): boolean;
  * Reset the cached result of `isCacheNoStoreSupported`. Exposed for testing only.
  */
 export declare function resetCacheNoStoreSupported(): void;
-export declare const makeRequest: (fetchFn: (url: string, init: RequestInit) => Promise<Response>, url: string, method: string, headers: Headers | Record<string, string>, requestBody: BodyInit | undefined, timeoutMs?: number, abortSignal?: AbortSignal, withCredentials?: boolean, duplex?: "half", disableCache?: boolean) => Promise<Response>;
+/**
+ * Clears the timeout that `makeRequest` kept running (with `keepTimeoutUntilBodyRead`) so that it also
+ * covered reading the response body.
+ */
+export declare function clearResponseTimeout(response: Response): void;
+export declare const makeRequest: (fetchFn: (url: string, init: RequestInit) => Promise<Response>, url: string, method: string, headers: Headers | Record<string, string>, requestBody: BodyInit | undefined, timeoutMs?: number, abortSignal?: AbortSignal, withCredentials?: boolean, duplex?: "half", disableCache?: boolean, keepTimeoutUntilBodyRead?: boolean) => Promise<Response>;

package/dist/core/fetcher/makeRequest.js

@@ -1,4 +1,4 @@
-import { anySignal, getTimeoutSignal } from "./signals.js";
+import { anySignal, getTimeoutSignal, TIMEOUT } from "./signals.js";
 /**
  * Cached result of checking whether the current runtime supports
  * the `cache` option in `Request`. Some runtimes (e.g. Cloudflare Workers)
@@ -24,30 +24,62 @@ export function isCacheNoStoreSupported() {
 export function resetCacheNoStoreSupported() {
     _cacheNoStoreSupported = undefined;
 }
-export const makeRequest = async (fetchFn, url, method, headers, requestBody, timeoutMs, abortSignal, withCredentials, duplex, disableCache) => {
+const responseTimeouts = new WeakMap();
+/**
+ * Clears the timeout that `makeRequest` kept running (with `keepTimeoutUntilBodyRead`) so that it also
+ * covered reading the response body.
+ */
+export function clearResponseTimeout(response) {
+    const timeoutId = responseTimeouts.get(response);
+    if (timeoutId != null) {
+        clearTimeout(timeoutId);
+        responseTimeouts.delete(response);
+    }
+}
+export const makeRequest = async (fetchFn, url, method, headers, requestBody, timeoutMs, abortSignal, withCredentials, duplex, disableCache, keepTimeoutUntilBodyRead) => {
     const signals = [];
     let timeoutAbortId;
+    let timeoutSignal;
     if (timeoutMs != null) {
         const { signal, abortId } = getTimeoutSignal(timeoutMs);
         timeoutAbortId = abortId;
+        timeoutSignal = signal;
         signals.push(signal);
     }
     if (abortSignal != null) {
         signals.push(abortSignal);
     }
     const newSignals = anySignal(signals);
-    const response = await fetchFn(url, {
-        method: method,
-        headers,
-        body: requestBody,
-        signal: newSignals,
-        credentials: withCredentials ? "include" : undefined,
-        // @ts-ignore
-        duplex,
-        ...(disableCache && isCacheNoStoreSupported() ? { cache: "no-store" } : {}),
-    });
+    let response;
+    try {
+        response = await fetchFn(url, {
+            method: method,
+            headers,
+            body: requestBody,
+            signal: newSignals,
+            credentials: withCredentials ? "include" : undefined,
+            // @ts-ignore
+            duplex,
+            ...(disableCache && isCacheNoStoreSupported() ? { cache: "no-store" } : {}),
+        });
+    }
+    catch (error) {
+        if (timeoutAbortId != null) {
+            clearTimeout(timeoutAbortId);
+        }
+        // Some runtimes (e.g. Node 18) reject with their own error instead of the abort reason.
+        if (timeoutSignal?.aborted && !abortSignal?.aborted) {
+            throw TIMEOUT;
+        }
+        throw error;
+    }
     if (timeoutAbortId != null) {
-        clearTimeout(timeoutAbortId);
+        if (keepTimeoutUntilBodyRead) {
+            responseTimeouts.set(response, timeoutAbortId);
+        }
+        else {
+            clearTimeout(timeoutAbortId);
+        }
     }
     return response;
 };

package/dist/core/fetcher/requestWithRetries.d.ts

@@ -1 +1 @@
-export declare function requestWithRetries(requestFn: () => Promise<Response>, maxRetries?: number): Promise<Response>;
+export declare function requestWithRetries(requestFn: () => Promise<Response>, maxRetries?: number, abortSignal?: AbortSignal): Promise<Response>;

package/dist/core/fetcher/requestWithRetries.js

@@ -40,12 +40,33 @@ function getRetryDelayFromHeaders(response, retryAttempt) {
     }
     return addSymmetricJitter(Math.min(INITIAL_RETRY_DELAY * 2 ** retryAttempt, MAX_RETRY_DELAY));
 }
-export async function requestWithRetries(requestFn, maxRetries = DEFAULT_MAX_RETRIES) {
+/**
+ * Waits `ms` milliseconds, or rejects as soon as `abortSignal` aborts. The timer and
+ * the abort listener are always removed, so a cancelled wait never keeps the process alive.
+ */
+function sleep(ms, abortSignal) {
+    return new Promise((resolve, reject) => {
+        if (abortSignal?.aborted) {
+            reject(abortSignal.reason);
+            return;
+        }
+        const onAbort = () => {
+            clearTimeout(timeoutId);
+            reject(abortSignal?.reason);
+        };
+        const timeoutId = setTimeout(() => {
+            abortSignal?.removeEventListener("abort", onAbort);
+            resolve();
+        }, ms);
+        abortSignal?.addEventListener("abort", onAbort, { once: true });
+    });
+}
+export async function requestWithRetries(requestFn, maxRetries = DEFAULT_MAX_RETRIES, abortSignal) {
     let response = await requestFn();
     for (let i = 0; i < maxRetries; ++i) {
         if (isRetryableStatusCode(response.status)) {
             const delay = getRetryDelayFromHeaders(response, i);
-            await new Promise((resolve) => setTimeout(resolve, delay));
+            await sleep(delay, abortSignal);
             response = await requestFn();
         }
         else {

package/dist/core/fetcher/signals.d.ts

@@ -1,3 +1,4 @@
+export declare const TIMEOUT = "timeout";
 export declare function getTimeoutSignal(timeoutMs: number): {
     signal: AbortSignal;
     abortId: ReturnType<typeof setTimeout>;

package/dist/core/fetcher/signals.js

@@ -1,4 +1,4 @@
-const TIMEOUT = "timeout";
+export const TIMEOUT = "timeout";
 export function getTimeoutSignal(timeoutMs) {
     const controller = new AbortController();
     const abortId = setTimeout(() => controller.abort(TIMEOUT), timeoutMs);

package/dist/core/index.d.ts

@@ -2,5 +2,7 @@ export * from "./auth/index.js";
 export * from "./base64.js";
 export * from "./fetcher/index.js";
 export * as logging from "./logging/index.js";
+export * from "./pagination/index.js";
 export * from "./runtime/index.js";
 export * as url from "./url/index.js";
+export * from "./utils/index.js";

package/dist/core/index.js

@@ -2,5 +2,7 @@ export * from "./auth/index.js";
 export * from "./base64.js";
 export * from "./fetcher/index.js";
 export * as logging from "./logging/index.js";
+export * from "./pagination/index.js";
 export * from "./runtime/index.js";
 export * as url from "./url/index.js";
+export * from "./utils/index.js";

package/dist/core/pagination/Page.d.ts

@@ -0,0 +1,33 @@
+import type { HttpResponsePromise, RawResponse } from "../fetcher/index.js";
+/**
+ * A page of results from a paginated API.
+ *
+ * @template T The type of the items in the page.
+ * @template R The type of the API response.
+ */
+export declare class Page<T, R = unknown> implements AsyncIterable<T> {
+    data: T[];
+    rawResponse: RawResponse;
+    response: R;
+    private _hasNextPage;
+    private getItems;
+    private loadNextPage;
+    constructor({ response, rawResponse, hasNextPage, getItems, loadPage, }: {
+        response: R;
+        rawResponse: RawResponse;
+        hasNextPage: (response: R) => boolean;
+        getItems: (response: R) => T[];
+        loadPage: (response: R) => HttpResponsePromise<R>;
+    });
+    /**
+     * Retrieves the next page
+     * @returns this
+     */
+    getNextPage(): Promise<this>;
+    /**
+     * @returns whether there is a next page to load
+     */
+    hasNextPage(): boolean;
+    private iterMessages;
+    [Symbol.asyncIterator](): AsyncIterator<T, void, unknown>;
+}