@myparcel/sdk/lib/endpoints/private/carrier-options/CarrierOption.types.d.ts

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

import { CarrierId, CarrierName } from '@myparcel/constants';
import { IntBoolean } from '../../../types';

export type MyParcelCarrierOption = {
    api_key: string;
    carrier: {
        id: CarrierId;
        name: CarrierName;
    };
    carrier_id: CarrierId;
    enabled: IntBoolean;
    id: number;
    optional: IntBoolean;
    options: {
        customerCode: string;
        customerNumber: string;
        customerCollectionLocation: string;
        serviceLevels: number;
        barcodeOptions: {
            gpType: string;
            gpRange: string;
        };
    };
    password: string;
    primary: IntBoolean;
    type: 'main' | 'custom';
    username: string;
    subscription_id?: number;
    label?: string;
};
export type CarrierOptionPostData = {
    carrier_id: CarrierId;
    username?: string;
    password?: string;
    options?: Record<string, unknown>;
    api_key?: string;
};
export type CarrierOptionPutData = {
    carrier_id: CarrierId;
    enabled: IntBoolean;
};
export type CarrierOptionsParameters = {
    enabled?: IntBoolean;
    carrier_id?: CarrierId | string;
    subscription_id?: number;
    type: 'main' | 'custom';
};