@myparcel/sdk/lib/model/endpoint/AbstractEndpoint.types.d.ts

JavaScript SDK to connect to the MyParcel API via Node.js or browser

import { OneOrMore } from '@myparcel/ts-utils';
import { RequestHeaders } from '../../types/request.types';
import { NoInfer } from '../../types/global.types';

type Pagination = {
    page?: number;
    size?: number;
    results?: number;
};
export type PaginatedResponse<T> = Pagination & Record<string, T>;
export interface EndpointDefinition {
    name: string;
    body?: NoInfer<unknown>;
    headers?: RequestHeaders;
    parameters?: NoInfer<Record<string, string | number | boolean>>;
    path?: Record<string, string | number>;
    response?: NoInfer<OneOrMore<unknown>> | PaginatedResponse<NoInfer<unknown[]>>;
    timeout?: number;
}
export type CreateDefinition<D extends EndpointDefinition> = D;
export {};