@datenkraft/bb-fulfillment-api-ts-client
Version:
The fulfillment API TS Client enables you to work with the fulfillment API
430 lines (429 loc) • 31.3 kB
JavaScript
;
/* tslint:disable */
/* eslint-disable */
/**
* Fulfillment API
* - alpha: Currently developed API version. Subject to major changes. - beta: A semi-stable early access version. New features can be added. Breaking changes are possible. - stable: The API is recommended for use in production. [Changelog](https://fulfillment-api.steve.niceshops.com/v2/docs/changelog.html) All data is transferred in UTF-8 encoding.\\ The API uses stateless HTTP. No cookies have to be kept.\\ Authentication via OAuth2 client credentials flow. [Privacy Policy](https://www.niceshops.com/en/dienstleistungen/data-privacy-policy) [Fulfillment API PHP client @Packagist](https://packagist.org/packages/datenkraft/bb-fulfillment-api-php-client)
*
* The version of the OpenAPI document: v2.beta
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.DeliveryApi = exports.DeliveryApiFactory = exports.DeliveryApiFp = exports.DeliveryApiAxiosParamCreator = void 0;
const axios_1 = __importDefault(require("axios"));
// URLSearchParams not necessarily used
// @ts-ignore
const url_1 = require("url");
// Some imports not used depending on template conditions
// @ts-ignore
const common_1 = require("../common");
// @ts-ignore
const base_1 = require("../base");
/**
* DeliveryApi - axios parameter creator
* @export
*/
const DeliveryApiAxiosParamCreator = function (configuration) {
return {
/**
* Get the delivery with the given deliveryNumber.
* @summary Get the delivery with the given deliveryNumber.
* @param {string} deliveryNumber Number of the delivery
* @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDelivery: (deliveryNumber, shopCode, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'deliveryNumber' is not null or undefined
(0, common_1.assertParamExists)('getDelivery', 'deliveryNumber', deliveryNumber);
const localVarPath = `/delivery/{deliveryNumber}`
.replace(`{${"deliveryNumber"}}`, encodeURIComponent(String(deliveryNumber)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication oAuthAuthorization required
// oauth required
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oAuthAuthorization", [], configuration);
// authentication bearerAuth required
// http bearer authentication required
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
if (shopCode !== undefined) {
localVarQueryParameter['shopCode'] = shopCode;
}
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* Get a collection of deliveries.
* @summary Get a collection of deliveries.
* @param {number} [page] The page to read. Default is the first page.
* @param {number} [pageSize] The maximum size per page is 100. Default is 100.
* @param {'default' | 'totalCount'} [paginationMode] The paginationMode to use: - default: The total number of items in the collection will not be calculated. - totalCount: The total number of items in the collection will be calculated. This can mean loss of performance.
* @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
* @param {string} [filterOrderNumber] A filter for a single order number or multiple order numbers separated by a comma. - The filter can contain a maximum of 100 order numbers. - The order numbers in the filter must be unique. - A single order number can have a maximum length of 59 characters.
* @param {boolean} [filterAllShipmentsHaveExternalShipmentIds] A filter to only return deliveries where all shipments have an external shipment ID or not.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDeliveryCollection: (page, pageSize, paginationMode, shopCode, filterOrderNumber, filterAllShipmentsHaveExternalShipmentIds, options = {}) => __awaiter(this, void 0, void 0, function* () {
const localVarPath = `/delivery`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication oAuthAuthorization required
// oauth required
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oAuthAuthorization", [], configuration);
// authentication bearerAuth required
// http bearer authentication required
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
if (page !== undefined) {
localVarQueryParameter['page'] = page;
}
if (pageSize !== undefined) {
localVarQueryParameter['pageSize'] = pageSize;
}
if (paginationMode !== undefined) {
localVarQueryParameter['paginationMode'] = paginationMode;
}
if (shopCode !== undefined) {
localVarQueryParameter['shopCode'] = shopCode;
}
if (filterOrderNumber !== undefined) {
localVarQueryParameter['filter[orderNumber]'] = filterOrderNumber;
}
if (filterAllShipmentsHaveExternalShipmentIds !== undefined) {
localVarQueryParameter['filter[allShipmentsHaveExternalShipmentIds]'] = filterAllShipmentsHaveExternalShipmentIds;
}
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* Allows to download a document associated with the given delivery.
* @summary Download delivery related documents
* @param {string} deliveryNumber The number of the delivery
* @param {'deliverySlipNote'} documentCode The document type to download. The file format is determined by the Accept request header.\\ **Note:** Only a limited amount of document type to file format combinations are available: - deliverySlipNote: The delivery slip note to confirm successful delivery.\\ Accept header: application/pdf
* @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDeliveryDocument: (deliveryNumber, documentCode, shopCode, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'deliveryNumber' is not null or undefined
(0, common_1.assertParamExists)('getDeliveryDocument', 'deliveryNumber', deliveryNumber);
// verify required parameter 'documentCode' is not null or undefined
(0, common_1.assertParamExists)('getDeliveryDocument', 'documentCode', documentCode);
const localVarPath = `/delivery/{deliveryNumber}/document/{documentCode}`
.replace(`{${"deliveryNumber"}}`, encodeURIComponent(String(deliveryNumber)))
.replace(`{${"documentCode"}}`, encodeURIComponent(String(documentCode)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication oAuthAuthorization required
// oauth required
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oAuthAuthorization", [], configuration);
// authentication bearerAuth required
// http bearer authentication required
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
if (shopCode !== undefined) {
localVarQueryParameter['shopCode'] = shopCode;
}
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* Patch data of the shipment of the delivery specified by the given delivery and shipment numbers.
* @summary Patch data of the shipment of the delivery specified by the given delivery and shipment numbers.
* @param {string} deliveryNumber Number of the delivery.
* @param {string} shipmentNumber Number of the shipment.
* @param {UpdateDeliveryShipment} updateDeliveryShipment
* @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchDeliveryShipment: (deliveryNumber, shipmentNumber, updateDeliveryShipment, shopCode, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'deliveryNumber' is not null or undefined
(0, common_1.assertParamExists)('patchDeliveryShipment', 'deliveryNumber', deliveryNumber);
// verify required parameter 'shipmentNumber' is not null or undefined
(0, common_1.assertParamExists)('patchDeliveryShipment', 'shipmentNumber', shipmentNumber);
// verify required parameter 'updateDeliveryShipment' is not null or undefined
(0, common_1.assertParamExists)('patchDeliveryShipment', 'updateDeliveryShipment', updateDeliveryShipment);
const localVarPath = `/delivery/{deliveryNumber}/shipment/{shipmentNumber}`
.replace(`{${"deliveryNumber"}}`, encodeURIComponent(String(deliveryNumber)))
.replace(`{${"shipmentNumber"}}`, encodeURIComponent(String(shipmentNumber)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication oAuthAuthorization required
// oauth required
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oAuthAuthorization", [], configuration);
// authentication bearerAuth required
// http bearer authentication required
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
if (shopCode !== undefined) {
localVarQueryParameter['shopCode'] = shopCode;
}
localVarHeaderParameter['Content-Type'] = 'application/json';
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(updateDeliveryShipment, localVarRequestOptions, configuration);
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
}),
};
};
exports.DeliveryApiAxiosParamCreator = DeliveryApiAxiosParamCreator;
/**
* DeliveryApi - functional programming interface
* @export
*/
const DeliveryApiFp = function (configuration) {
const localVarAxiosParamCreator = (0, exports.DeliveryApiAxiosParamCreator)(configuration);
return {
/**
* Get the delivery with the given deliveryNumber.
* @summary Get the delivery with the given deliveryNumber.
* @param {string} deliveryNumber Number of the delivery
* @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDelivery(deliveryNumber, shopCode, options) {
return __awaiter(this, void 0, void 0, function* () {
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDelivery(deliveryNumber, shopCode, options);
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
});
},
/**
* Get a collection of deliveries.
* @summary Get a collection of deliveries.
* @param {number} [page] The page to read. Default is the first page.
* @param {number} [pageSize] The maximum size per page is 100. Default is 100.
* @param {'default' | 'totalCount'} [paginationMode] The paginationMode to use: - default: The total number of items in the collection will not be calculated. - totalCount: The total number of items in the collection will be calculated. This can mean loss of performance.
* @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
* @param {string} [filterOrderNumber] A filter for a single order number or multiple order numbers separated by a comma. - The filter can contain a maximum of 100 order numbers. - The order numbers in the filter must be unique. - A single order number can have a maximum length of 59 characters.
* @param {boolean} [filterAllShipmentsHaveExternalShipmentIds] A filter to only return deliveries where all shipments have an external shipment ID or not.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDeliveryCollection(page, pageSize, paginationMode, shopCode, filterOrderNumber, filterAllShipmentsHaveExternalShipmentIds, options) {
return __awaiter(this, void 0, void 0, function* () {
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDeliveryCollection(page, pageSize, paginationMode, shopCode, filterOrderNumber, filterAllShipmentsHaveExternalShipmentIds, options);
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
});
},
/**
* Allows to download a document associated with the given delivery.
* @summary Download delivery related documents
* @param {string} deliveryNumber The number of the delivery
* @param {'deliverySlipNote'} documentCode The document type to download. The file format is determined by the Accept request header.\\ **Note:** Only a limited amount of document type to file format combinations are available: - deliverySlipNote: The delivery slip note to confirm successful delivery.\\ Accept header: application/pdf
* @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDeliveryDocument(deliveryNumber, documentCode, shopCode, options) {
return __awaiter(this, void 0, void 0, function* () {
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDeliveryDocument(deliveryNumber, documentCode, shopCode, options);
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
});
},
/**
* Patch data of the shipment of the delivery specified by the given delivery and shipment numbers.
* @summary Patch data of the shipment of the delivery specified by the given delivery and shipment numbers.
* @param {string} deliveryNumber Number of the delivery.
* @param {string} shipmentNumber Number of the shipment.
* @param {UpdateDeliveryShipment} updateDeliveryShipment
* @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchDeliveryShipment(deliveryNumber, shipmentNumber, updateDeliveryShipment, shopCode, options) {
return __awaiter(this, void 0, void 0, function* () {
const localVarAxiosArgs = yield localVarAxiosParamCreator.patchDeliveryShipment(deliveryNumber, shipmentNumber, updateDeliveryShipment, shopCode, options);
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
});
},
};
};
exports.DeliveryApiFp = DeliveryApiFp;
/**
* DeliveryApi - factory interface
* @export
*/
const DeliveryApiFactory = function (configuration, basePath, axios) {
const localVarFp = (0, exports.DeliveryApiFp)(configuration);
return {
/**
* Get the delivery with the given deliveryNumber.
* @summary Get the delivery with the given deliveryNumber.
* @param {string} deliveryNumber Number of the delivery
* @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDelivery(deliveryNumber, shopCode, options) {
return localVarFp.getDelivery(deliveryNumber, shopCode, options).then((request) => request(axios, basePath));
},
/**
* Get a collection of deliveries.
* @summary Get a collection of deliveries.
* @param {number} [page] The page to read. Default is the first page.
* @param {number} [pageSize] The maximum size per page is 100. Default is 100.
* @param {'default' | 'totalCount'} [paginationMode] The paginationMode to use: - default: The total number of items in the collection will not be calculated. - totalCount: The total number of items in the collection will be calculated. This can mean loss of performance.
* @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
* @param {string} [filterOrderNumber] A filter for a single order number or multiple order numbers separated by a comma. - The filter can contain a maximum of 100 order numbers. - The order numbers in the filter must be unique. - A single order number can have a maximum length of 59 characters.
* @param {boolean} [filterAllShipmentsHaveExternalShipmentIds] A filter to only return deliveries where all shipments have an external shipment ID or not.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDeliveryCollection(page, pageSize, paginationMode, shopCode, filterOrderNumber, filterAllShipmentsHaveExternalShipmentIds, options) {
return localVarFp.getDeliveryCollection(page, pageSize, paginationMode, shopCode, filterOrderNumber, filterAllShipmentsHaveExternalShipmentIds, options).then((request) => request(axios, basePath));
},
/**
* Allows to download a document associated with the given delivery.
* @summary Download delivery related documents
* @param {string} deliveryNumber The number of the delivery
* @param {'deliverySlipNote'} documentCode The document type to download. The file format is determined by the Accept request header.\\ **Note:** Only a limited amount of document type to file format combinations are available: - deliverySlipNote: The delivery slip note to confirm successful delivery.\\ Accept header: application/pdf
* @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDeliveryDocument(deliveryNumber, documentCode, shopCode, options) {
return localVarFp.getDeliveryDocument(deliveryNumber, documentCode, shopCode, options).then((request) => request(axios, basePath));
},
/**
* Patch data of the shipment of the delivery specified by the given delivery and shipment numbers.
* @summary Patch data of the shipment of the delivery specified by the given delivery and shipment numbers.
* @param {string} deliveryNumber Number of the delivery.
* @param {string} shipmentNumber Number of the shipment.
* @param {UpdateDeliveryShipment} updateDeliveryShipment
* @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchDeliveryShipment(deliveryNumber, shipmentNumber, updateDeliveryShipment, shopCode, options) {
return localVarFp.patchDeliveryShipment(deliveryNumber, shipmentNumber, updateDeliveryShipment, shopCode, options).then((request) => request(axios, basePath));
},
};
};
exports.DeliveryApiFactory = DeliveryApiFactory;
/**
* DeliveryApi - object-oriented interface
* @export
* @class DeliveryApi
* @extends {BaseAPI}
*/
class DeliveryApi extends base_1.BaseAPI {
/**
* Get the delivery with the given deliveryNumber.
* @summary Get the delivery with the given deliveryNumber.
* @param {string} deliveryNumber Number of the delivery
* @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DeliveryApi
*/
getDelivery(deliveryNumber, shopCode, options) {
return (0, exports.DeliveryApiFp)(this.configuration).getDelivery(deliveryNumber, shopCode, options).then((request) => request(this.axios, this.basePath));
}
/**
* Get a collection of deliveries.
* @summary Get a collection of deliveries.
* @param {number} [page] The page to read. Default is the first page.
* @param {number} [pageSize] The maximum size per page is 100. Default is 100.
* @param {'default' | 'totalCount'} [paginationMode] The paginationMode to use: - default: The total number of items in the collection will not be calculated. - totalCount: The total number of items in the collection will be calculated. This can mean loss of performance.
* @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
* @param {string} [filterOrderNumber] A filter for a single order number or multiple order numbers separated by a comma. - The filter can contain a maximum of 100 order numbers. - The order numbers in the filter must be unique. - A single order number can have a maximum length of 59 characters.
* @param {boolean} [filterAllShipmentsHaveExternalShipmentIds] A filter to only return deliveries where all shipments have an external shipment ID or not.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DeliveryApi
*/
getDeliveryCollection(page, pageSize, paginationMode, shopCode, filterOrderNumber, filterAllShipmentsHaveExternalShipmentIds, options) {
return (0, exports.DeliveryApiFp)(this.configuration).getDeliveryCollection(page, pageSize, paginationMode, shopCode, filterOrderNumber, filterAllShipmentsHaveExternalShipmentIds, options).then((request) => request(this.axios, this.basePath));
}
/**
* Allows to download a document associated with the given delivery.
* @summary Download delivery related documents
* @param {string} deliveryNumber The number of the delivery
* @param {'deliverySlipNote'} documentCode The document type to download. The file format is determined by the Accept request header.\\ **Note:** Only a limited amount of document type to file format combinations are available: - deliverySlipNote: The delivery slip note to confirm successful delivery.\\ Accept header: application/pdf
* @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DeliveryApi
*/
getDeliveryDocument(deliveryNumber, documentCode, shopCode, options) {
return (0, exports.DeliveryApiFp)(this.configuration).getDeliveryDocument(deliveryNumber, documentCode, shopCode, options).then((request) => request(this.axios, this.basePath));
}
/**
* Patch data of the shipment of the delivery specified by the given delivery and shipment numbers.
* @summary Patch data of the shipment of the delivery specified by the given delivery and shipment numbers.
* @param {string} deliveryNumber Number of the delivery.
* @param {string} shipmentNumber Number of the shipment.
* @param {UpdateDeliveryShipment} updateDeliveryShipment
* @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DeliveryApi
*/
patchDeliveryShipment(deliveryNumber, shipmentNumber, updateDeliveryShipment, shopCode, options) {
return (0, exports.DeliveryApiFp)(this.configuration).patchDeliveryShipment(deliveryNumber, shipmentNumber, updateDeliveryShipment, shopCode, options).then((request) => request(this.axios, this.basePath));
}
}
exports.DeliveryApi = DeliveryApi;