@myparcel/sdk/lib/endpoints/private/shipments/GetShipments.d.ts

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

import { PaginationParameters } from '../../../types';
import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
import { CreateDefinition, PaginatedResponse } from '../../../model/endpoint/AbstractEndpoint.types';
import { MyParcelShipment } from '../..';

type Parameters = PaginationParameters & {
    carrier?: number;
    hidden?: boolean;
};
type GetShipmentsDefinition = CreateDefinition<{
    name: typeof GetShipments.name;
    parameters: Parameters;
    response: PaginatedResponse<MyParcelShipment[]>;
}>;
/**
 * Retrieve all shipments, or a paginated subset.
 */
export declare class GetShipments extends AbstractPrivateEndpoint<GetShipmentsDefinition> {
    readonly name = "getShipments";
    readonly path = "shipments";
    readonly property = "shipments";
}
export {};