tsonik/dist/types/common.d.ts

A TypeScript client library for the Iconik API based on Swagger documentation

import type { RawAxiosResponseHeaders } from 'axios';
/**
 * Common API response types
 */
export type FilterValue = string | number | boolean | object | null;
export type FilterRecord = Record<string, FilterValue>;
export type HttpHeaders = RawAxiosResponseHeaders;
export interface ApiResponse<T = unknown> {
    data: T;
    status: number;
    headers: HttpHeaders;
}
export interface PaginatedResponse<T = unknown> {
    objects: T[];
    total?: number;
    total_count?: number;
    page?: number;
    pages?: number;
    per_page?: number;
    first_url?: string;
    last_url?: string;
    next_url?: string;
    prev_url?: string;
    scroll_id?: string;
    next_page_token?: string;
    previous_page_token?: string;
}
export interface ListParams {
    limit?: number;
    offset?: number;
    page?: number;
    per_page?: number;
    sort?: string;
    filter?: FilterRecord;
    page_token?: string;
    scroll?: string;
}
//# sourceMappingURL=common.d.ts.map