import { ID } from './id';
import { Image } from './image';
import { RestEndpoint } from './restEndpoint';

export interface CourierAction {
    production: RestEndpoint;
    test: RestEndpoint;
}

/**  TODO discuss Min/Max delilvery days. */

export interface Courier {
    /** Auto generated Unique Identifier */
    id?: ID;

    /** Name of Courier */
    name: string;

    /** unique code to identify the code */
    code: string;

    description: string;

    images: {
        logo: Image;
        squareLogo: Image;
    };

    // TODO: If we use webhooks to cater this then we do not these hooks here
    courierActions: {
        'shipment:create'?: CourierAction;
        'shipment:refund'?: CourierAction;
        'shipment:return'?: CourierAction;
        'shipment:cancel'?: CourierAction;
        'shipment:rate'?: CourierAction;
    };

    // Not in MVP
    // PredefinedPackages: Array<{
    // 	Key: string;
    // 	Label: string;
    // }>;

    cities?: object;

    createdAt: Date;

    updatedAt: Date;
}