@myorb/dhl-express/dist/models/supermodel-io-logistics-express-pickup-request.d.ts

DHL Express api client

/**
 * DHL Express APIs (MyDHL API)
 * Welcome to the official DHL Express APIs (MyDHL API) below are the published API Documentation to fulfill your shipping needs with DHL Express.       Please follow the process described [here](https://developer.dhl.com/api-reference/dhl-express-mydhl-api#get-started-section/user-guide--get-access) to request access to the DHL Express - MyDHL API services    In case you already have DHL Express - MyDHL API Service credentials please ensure to use the endpoints/environments listed  [here](https://developer.dhl.com/api-reference/dhl-express-mydhl-api#get-started-section/user-guide--environments)
 *
 * OpenAPI spec version: 2.4.0
 *
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 * Do not edit the class manually.
 */
import { SupermodelIoLogisticsExpressAccount } from './supermodel-io-logistics-express-account';
import { SupermodelIoLogisticsExpressPickupRequestCustomerDetails } from './supermodel-io-logistics-express-pickup-request-customer-details';
import { SupermodelIoLogisticsExpressPickupRequestShipmentDetails } from './supermodel-io-logistics-express-pickup-request-shipment-details';
import { SupermodelIoLogisticsExpressPickupRequestSpecialInstructions } from './supermodel-io-logistics-express-pickup-request-special-instructions';
/**
 * RequestPickup schema definition
 * @export
 * @interface SupermodelIoLogisticsExpressPickupRequest
 */
export interface SupermodelIoLogisticsExpressPickupRequest {
    /**
     * Identifies the date and time the package is ready for pickup Both the date and time portions of the string are expected to be used. The date should not be a past date or a date more than 10 days in the future. The time is the local time of the shipment based on the shipper's time zone. The date component must be in the format: YYYY-MM-DD; the time component must be in the format: HH:MM:SS using a 24 hour clock. The date and time parts are separated by the letter T (e.g. 2006-06-26T17:00:00 GMT+01:00).<br>
     * @type {string}
     * @memberof SupermodelIoLogisticsExpressPickupRequest
     */
    plannedPickupDateAndTime: string;
    /**
     * The latest time the location premises is available to dispatch the DHL Express shipment. (HH:MM)
     * @type {string}
     * @memberof SupermodelIoLogisticsExpressPickupRequest
     */
    closeTime?: string;
    /**
     * Provides information on where the package should be picked up by DHL courier. <br>
     * @type {string}
     * @memberof SupermodelIoLogisticsExpressPickupRequest
     */
    location?: string;
    /**
     * Provides information on where the package should be picked up by DHL courier. <br>
     * @type {string}
     * @memberof SupermodelIoLogisticsExpressPickupRequest
     */
    locationType?: SupermodelIoLogisticsExpressPickupRequestLocationTypeEnum;
    /**
     *
     * @type {Array<SupermodelIoLogisticsExpressAccount>}
     * @memberof SupermodelIoLogisticsExpressPickupRequest
     */
    accounts: Array<SupermodelIoLogisticsExpressAccount>;
    /**
     * Details special pickup instructions you may wish to send to the DHL Courier.
     * @type {Array<SupermodelIoLogisticsExpressPickupRequestSpecialInstructions>}
     * @memberof SupermodelIoLogisticsExpressPickupRequest
     */
    specialInstructions?: Array<SupermodelIoLogisticsExpressPickupRequestSpecialInstructions>;
    /**
     * Please provide additional pickup remark
     * @type {string}
     * @memberof SupermodelIoLogisticsExpressPickupRequest
     */
    remark?: string;
    /**
     *
     * @type {SupermodelIoLogisticsExpressPickupRequestCustomerDetails}
     * @memberof SupermodelIoLogisticsExpressPickupRequest
     */
    customerDetails: SupermodelIoLogisticsExpressPickupRequestCustomerDetails;
    /**
     * Please provide details related to shipment you want to do the pickup for
     * @type {Array<SupermodelIoLogisticsExpressPickupRequestShipmentDetails>}
     * @memberof SupermodelIoLogisticsExpressPickupRequest
     */
    shipmentDetails: Array<SupermodelIoLogisticsExpressPickupRequestShipmentDetails>;
}
/**
    * @export
    * @enum {string}
    */
export declare enum SupermodelIoLogisticsExpressPickupRequestLocationTypeEnum {
    Business = "business",
    Residence = "residence"
}