intercom-client/api/types/CursorPages.d.ts

Official Node bindings to the Intercom API

/**
 * This file was auto-generated by Fern from our API Definition.
 */
import * as Intercom from "../index";
/**
 * Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data.
 * A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.
 */
export interface CursorPages {
    /** the type of object `pages`. */
    type: "pages";
    /** The current page */
    page?: number;
    next?: Intercom.StartingAfterPaging;
    /** Number of results per page */
    per_page?: number;
    /** Total number of pages */
    total_pages?: number;
}