@phasesdk/api-client-for-economic/lib/modules/rest/DeliveryLocation.d.ts

e-conomic REST API Library for Node.js is a powerful tool designed to simplify integration with the e-conomic platform for developers building Node.js applications. With this library, developers can effortlessly leverage the full functionality of the e-co

import { HttpResponse } from "../../types/Http.type";
import RestApi from "../RestApi";
import { AuthToken } from "../../types/Economic.type";
import { EconomicResponse, Pagination } from "../../types/Economic.type";
import { CustomerInfo } from "./Customers";
export type DeliveryLocation = {
    deliveryLocationNumber: number;
    self: string;
    address: string;
    barred: boolean;
    city: string;
    country: string;
    postalCode: string;
    sortKey: number;
    termsOfDelivery: string;
    customer: CustomerInfo;
};
export type CreateDeliveryLocation = {
    address: string;
    barred: boolean;
    city: string;
    country: string;
    postalCode: string;
    sortKey: number;
    termsOfDelivery: string;
};
export type Delivery = {
    address: string;
    city: string;
    country: string;
    deliveryDate: string;
    deliveryTerms: string;
    zip: string;
};
export type UpdateDeliveryLocation = Partial<CreateDeliveryLocation>;
export default class DeliveryLocations extends RestApi {
    /**
     * @constructor
     */
    constructor(props: AuthToken);
    getUrl(): string;
    /**
     * Get collection of delivery locations for a specific customer.
     * @see https://restdocs.e-conomic.com/#get-customers-customernumber-delivery-locations
     *
     * @param {number} customerNumber
     * @param {number} offset
     * @param {number} limit
     * @returns {Promise<HttpResponse>}
     */
    get(customerNumber: number, offset?: number, limit?: number): Promise<HttpResponse<EconomicResponse<DeliveryLocation[], Pagination>>>;
    /**
     * Get a specific delivery location for a customer.
     * @see https://restdocs.e-conomic.com/#get-customers-customernumber-delivery-locations-deliverylocationnumber
     * @param {number} customerNumber
     * @param {number} deliveryLocationNumber
     * @returns {Promise<HttpResponse>}
     */
    getFor(customerNumber: number, deliveryLocationNumber: number): Promise<HttpResponse<DeliveryLocation>>;
    /**
     * Create a new delivery location for a specific customer.
     * @see https://restdocs.e-conomic.com/#post-customers-customernumber-delivery-locations
     * @param {number} customerNumber
     * @param {CreateDeliveryLocation} deliveryLocation
     * @returns {Promise<HttpResponse<DeliveryLocation>>}
     */
    createDeliveryLocation(customerNumber: number, deliveryLocation: CreateDeliveryLocation): Promise<HttpResponse<DeliveryLocation>>;
    /**
     * Update an existing delivery location for a specific customer.
     * @see https://restdocs.e-conomic.com/#put-customers-customernumber-delivery-locations-deliverylocationnumber
     * @param {number} customerNumber
     * @param {number} deliveryLocationNumber
     * @param {UpdateDeliveryLocation} deliveryLocation
     * @returns {Promise<HttpResponse<DeliveryLocation>>}
     */
    updateDeliveryLocation(customerNumber: number, deliveryLocationNumber: number, deliveryLocation: UpdateDeliveryLocation): Promise<HttpResponse<DeliveryLocation>>;
    /**
     * Delete an existing delivery location for a specific customer.
     * @see https://restdocs.e-conomic.com/#delete-customers-customernumber-delivery-locations-deliverylocationnumber
     * @param {number} customerNumber
     * @param {number} deliveryLocationNumber
     * @returns {Promise<HttpResponse<void>>}
     */
    deleteDeliveryLocation(customerNumber: number, deliveryLocationNumber: number): Promise<HttpResponse<void>>;
}