sdksio-postnl-ecommerce-apis-sdk
Version:
Collection of PostNL API's for ecommerce processes
42 lines (41 loc) • 2.5 kB
TypeScript
/**
* PostNL Ecommerce APIsLib
*
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/
import { ApiResponse, RequestOptions } from '../core';
import { CountryCode1Enum } from '../models/countryCode1Enum';
import { Options1Enum } from '../models/options1Enum';
import { TimeframeResponse } from '../models/timeframeResponse';
import { BaseController } from './baseController';
export declare class TimeframesController extends BaseController {
/**
* Request example:
* ```
* curl -X GET "https://api-sandbox.postnl.nl/shipment/v2_1/calculate/timeframes?
* AllowSundaySorting=false&StartDate=30-06-2022&EndDate=02-07-
* 2022&CountryCode=NL&PostalCode=2132WT&HouseNumber=42&HouseNrExt=A&City=Hoofddorp&Street=Siriusdreef&
* Options=Daytime%2CEvening" \
* -H "Accept: application/json" \
* -H "apikey: APIKEY-HERE" \
* ```
*
*
* @param allowSundaySorting Whether or not the requesting party allows for Sunday sorting
* (which leads to delivery on Monday).
* @param startDate Date of the beginning of the timeframe. Format: dd-MM-yyyy
* @param endDate Date of the enddate of the timeframe. Format:dd-MM-yyyy. Enddate
* may not be before StartDate.
* @param countryCode The ISO2 country code of the delivery address
* @param postalCode Zipcode of the delivery address
* @param houseNumber The house number of the delivery address
* @param options The delivery options for which expected timeframes should be
* calculated. At least one delivery option must be specified. Multiple
* values should be comma-separated.
* @param houseNrExt House number extension of the delivery address
* @param city City of the delivery address
* @param street The street name of the delivery address
* @return Response from the API call
*/
retrieveExpectedDeliveryTimeframes(allowSundaySorting: boolean, startDate: string, endDate: string, countryCode: CountryCode1Enum, postalCode: string, houseNumber: number, options: Options1Enum[], houseNrExt?: string, city?: string, street?: string, requestOptions?: RequestOptions): Promise<ApiResponse<TimeframeResponse>>;
}