@datenkraft/bb-fulfillment-api-ts-client
Version:
The fulfillment API TS Client enables you to work with the fulfillment API
371 lines (370 loc) • 33.1 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.ReconsignmentAnnouncementApi = exports.ReconsignmentAnnouncementApiFactory = exports.ReconsignmentAnnouncementApiFp = exports.ReconsignmentAnnouncementApiAxiosParamCreator = 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");
/**
* ReconsignmentAnnouncementApi - axios parameter creator
* @export
*/
const ReconsignmentAnnouncementApiAxiosParamCreator = function (configuration) {
return {
/**
* Get the reconsignment announcement with the given reconsignmentAnnouncementNumber.
* @summary Get the reconsignment announcement with the given reconsignmentAnnouncementNumber.
* @param {string} reconsignmentAnnouncementNumber Number of the reconsignment announcement
* @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}
*/
getReconsignmentAnnouncement: (reconsignmentAnnouncementNumber, shopCode, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'reconsignmentAnnouncementNumber' is not null or undefined
(0, common_1.assertParamExists)('getReconsignmentAnnouncement', 'reconsignmentAnnouncementNumber', reconsignmentAnnouncementNumber);
const localVarPath = `/reconsignment-announcement/{reconsignmentAnnouncementNumber}`
.replace(`{${"reconsignmentAnnouncementNumber"}}`, encodeURIComponent(String(reconsignmentAnnouncementNumber)));
// 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 reconsignment announcements.
* @summary Get reconsignment announcements.
* @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} [sortBy] Sort the results by one or more comma-separated sort criteria, with the criterion specified first having priority. Available sort orders: - asc: ascending order - desc: descending order Available fields for sorting: - reconsignmentAnnouncementDate The default sort order is reconsignmentAnnouncementDate:desc.
* @param {string} [filterShopCode] 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] Filter for a single order number.
* @param {boolean} [filterReconsignmentAnnouncementCompleted] Filter for completed or not completed reconsignment announcements.
* @param {string} [filterReconsignmentAnnouncementDateFrom] Filter for reconsignmentAnnouncementDate (from)
* @param {string} [filterReconsignmentAnnouncementDateTo] Filter for reconsignmentAnnouncementDate (to)
* @param {string} [filterSearch] Filter for reconsignment announcement search. Usage: - Provide one or multiple search terms (min. 2 characters) to filter results. - Multiple search terms are separated by spaces. - The search is not case sensitive. - The search is enabled for the fields reconsignmentAnnouncementNumber, orderNumber, externalOrderReference and reconsignmentTrackingCode. - Each search term filters the response for reconsignment announcements where at least one of the fields contains the search term. - For example, filter[search]=\'term1 term2\' will filter the result for reconsignment announcements where \'term1\' is found in any field and \'term2\' is also found in any field.\\ If only \'term1\' or \'term2\' is found in the fields, the reconsignment announcement is not included in the results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getReconsignmentAnnouncementCollection: (page, pageSize, paginationMode, sortBy, filterShopCode, filterOrderNumber, filterReconsignmentAnnouncementCompleted, filterReconsignmentAnnouncementDateFrom, filterReconsignmentAnnouncementDateTo, filterSearch, options = {}) => __awaiter(this, void 0, void 0, function* () {
const localVarPath = `/reconsignment-announcement`;
// 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 (sortBy !== undefined) {
localVarQueryParameter['sortBy'] = sortBy;
}
if (filterShopCode !== undefined) {
localVarQueryParameter['filter[shopCode]'] = filterShopCode;
}
if (filterOrderNumber !== undefined) {
localVarQueryParameter['filter[orderNumber]'] = filterOrderNumber;
}
if (filterReconsignmentAnnouncementCompleted !== undefined) {
localVarQueryParameter['filter[reconsignmentAnnouncementCompleted]'] = filterReconsignmentAnnouncementCompleted;
}
if (filterReconsignmentAnnouncementDateFrom !== undefined) {
localVarQueryParameter['filter[reconsignmentAnnouncementDateFrom]'] = (filterReconsignmentAnnouncementDateFrom instanceof Date) ?
filterReconsignmentAnnouncementDateFrom.toISOString().substr(0, 10) :
filterReconsignmentAnnouncementDateFrom;
}
if (filterReconsignmentAnnouncementDateTo !== undefined) {
localVarQueryParameter['filter[reconsignmentAnnouncementDateTo]'] = (filterReconsignmentAnnouncementDateTo instanceof Date) ?
filterReconsignmentAnnouncementDateTo.toISOString().substr(0, 10) :
filterReconsignmentAnnouncementDateTo;
}
if (filterSearch !== undefined) {
localVarQueryParameter['filter[search]'] = filterSearch;
}
(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 reconsignmentAnnouncement.
* @summary Download reconsignmentAnnouncement related documents.
* @param {string} reconsignmentAnnouncementNumber The number of the reconsignmentAnnouncement.
* @param {'shippingLabel'} 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: - shippingLabel: The shipping label for the end customer to ship goods back to the steve warehouse.\\ 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}
*/
getReconsignmentAnnouncementDocument: (reconsignmentAnnouncementNumber, documentCode, shopCode, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'reconsignmentAnnouncementNumber' is not null or undefined
(0, common_1.assertParamExists)('getReconsignmentAnnouncementDocument', 'reconsignmentAnnouncementNumber', reconsignmentAnnouncementNumber);
// verify required parameter 'documentCode' is not null or undefined
(0, common_1.assertParamExists)('getReconsignmentAnnouncementDocument', 'documentCode', documentCode);
const localVarPath = `/reconsignment-announcement/{reconsignmentAnnouncementNumber}/document/{documentCode}`
.replace(`{${"reconsignmentAnnouncementNumber"}}`, encodeURIComponent(String(reconsignmentAnnouncementNumber)))
.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,
};
}),
};
};
exports.ReconsignmentAnnouncementApiAxiosParamCreator = ReconsignmentAnnouncementApiAxiosParamCreator;
/**
* ReconsignmentAnnouncementApi - functional programming interface
* @export
*/
const ReconsignmentAnnouncementApiFp = function (configuration) {
const localVarAxiosParamCreator = (0, exports.ReconsignmentAnnouncementApiAxiosParamCreator)(configuration);
return {
/**
* Get the reconsignment announcement with the given reconsignmentAnnouncementNumber.
* @summary Get the reconsignment announcement with the given reconsignmentAnnouncementNumber.
* @param {string} reconsignmentAnnouncementNumber Number of the reconsignment announcement
* @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}
*/
getReconsignmentAnnouncement(reconsignmentAnnouncementNumber, shopCode, options) {
return __awaiter(this, void 0, void 0, function* () {
const localVarAxiosArgs = yield localVarAxiosParamCreator.getReconsignmentAnnouncement(reconsignmentAnnouncementNumber, shopCode, options);
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
});
},
/**
* Get reconsignment announcements.
* @summary Get reconsignment announcements.
* @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} [sortBy] Sort the results by one or more comma-separated sort criteria, with the criterion specified first having priority. Available sort orders: - asc: ascending order - desc: descending order Available fields for sorting: - reconsignmentAnnouncementDate The default sort order is reconsignmentAnnouncementDate:desc.
* @param {string} [filterShopCode] 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] Filter for a single order number.
* @param {boolean} [filterReconsignmentAnnouncementCompleted] Filter for completed or not completed reconsignment announcements.
* @param {string} [filterReconsignmentAnnouncementDateFrom] Filter for reconsignmentAnnouncementDate (from)
* @param {string} [filterReconsignmentAnnouncementDateTo] Filter for reconsignmentAnnouncementDate (to)
* @param {string} [filterSearch] Filter for reconsignment announcement search. Usage: - Provide one or multiple search terms (min. 2 characters) to filter results. - Multiple search terms are separated by spaces. - The search is not case sensitive. - The search is enabled for the fields reconsignmentAnnouncementNumber, orderNumber, externalOrderReference and reconsignmentTrackingCode. - Each search term filters the response for reconsignment announcements where at least one of the fields contains the search term. - For example, filter[search]=\'term1 term2\' will filter the result for reconsignment announcements where \'term1\' is found in any field and \'term2\' is also found in any field.\\ If only \'term1\' or \'term2\' is found in the fields, the reconsignment announcement is not included in the results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getReconsignmentAnnouncementCollection(page, pageSize, paginationMode, sortBy, filterShopCode, filterOrderNumber, filterReconsignmentAnnouncementCompleted, filterReconsignmentAnnouncementDateFrom, filterReconsignmentAnnouncementDateTo, filterSearch, options) {
return __awaiter(this, void 0, void 0, function* () {
const localVarAxiosArgs = yield localVarAxiosParamCreator.getReconsignmentAnnouncementCollection(page, pageSize, paginationMode, sortBy, filterShopCode, filterOrderNumber, filterReconsignmentAnnouncementCompleted, filterReconsignmentAnnouncementDateFrom, filterReconsignmentAnnouncementDateTo, filterSearch, options);
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
});
},
/**
* Allows to download a document associated with the given reconsignmentAnnouncement.
* @summary Download reconsignmentAnnouncement related documents.
* @param {string} reconsignmentAnnouncementNumber The number of the reconsignmentAnnouncement.
* @param {'shippingLabel'} 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: - shippingLabel: The shipping label for the end customer to ship goods back to the steve warehouse.\\ 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}
*/
getReconsignmentAnnouncementDocument(reconsignmentAnnouncementNumber, documentCode, shopCode, options) {
return __awaiter(this, void 0, void 0, function* () {
const localVarAxiosArgs = yield localVarAxiosParamCreator.getReconsignmentAnnouncementDocument(reconsignmentAnnouncementNumber, documentCode, shopCode, options);
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
});
},
};
};
exports.ReconsignmentAnnouncementApiFp = ReconsignmentAnnouncementApiFp;
/**
* ReconsignmentAnnouncementApi - factory interface
* @export
*/
const ReconsignmentAnnouncementApiFactory = function (configuration, basePath, axios) {
const localVarFp = (0, exports.ReconsignmentAnnouncementApiFp)(configuration);
return {
/**
* Get the reconsignment announcement with the given reconsignmentAnnouncementNumber.
* @summary Get the reconsignment announcement with the given reconsignmentAnnouncementNumber.
* @param {string} reconsignmentAnnouncementNumber Number of the reconsignment announcement
* @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}
*/
getReconsignmentAnnouncement(reconsignmentAnnouncementNumber, shopCode, options) {
return localVarFp.getReconsignmentAnnouncement(reconsignmentAnnouncementNumber, shopCode, options).then((request) => request(axios, basePath));
},
/**
* Get reconsignment announcements.
* @summary Get reconsignment announcements.
* @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} [sortBy] Sort the results by one or more comma-separated sort criteria, with the criterion specified first having priority. Available sort orders: - asc: ascending order - desc: descending order Available fields for sorting: - reconsignmentAnnouncementDate The default sort order is reconsignmentAnnouncementDate:desc.
* @param {string} [filterShopCode] 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] Filter for a single order number.
* @param {boolean} [filterReconsignmentAnnouncementCompleted] Filter for completed or not completed reconsignment announcements.
* @param {string} [filterReconsignmentAnnouncementDateFrom] Filter for reconsignmentAnnouncementDate (from)
* @param {string} [filterReconsignmentAnnouncementDateTo] Filter for reconsignmentAnnouncementDate (to)
* @param {string} [filterSearch] Filter for reconsignment announcement search. Usage: - Provide one or multiple search terms (min. 2 characters) to filter results. - Multiple search terms are separated by spaces. - The search is not case sensitive. - The search is enabled for the fields reconsignmentAnnouncementNumber, orderNumber, externalOrderReference and reconsignmentTrackingCode. - Each search term filters the response for reconsignment announcements where at least one of the fields contains the search term. - For example, filter[search]=\'term1 term2\' will filter the result for reconsignment announcements where \'term1\' is found in any field and \'term2\' is also found in any field.\\ If only \'term1\' or \'term2\' is found in the fields, the reconsignment announcement is not included in the results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getReconsignmentAnnouncementCollection(page, pageSize, paginationMode, sortBy, filterShopCode, filterOrderNumber, filterReconsignmentAnnouncementCompleted, filterReconsignmentAnnouncementDateFrom, filterReconsignmentAnnouncementDateTo, filterSearch, options) {
return localVarFp.getReconsignmentAnnouncementCollection(page, pageSize, paginationMode, sortBy, filterShopCode, filterOrderNumber, filterReconsignmentAnnouncementCompleted, filterReconsignmentAnnouncementDateFrom, filterReconsignmentAnnouncementDateTo, filterSearch, options).then((request) => request(axios, basePath));
},
/**
* Allows to download a document associated with the given reconsignmentAnnouncement.
* @summary Download reconsignmentAnnouncement related documents.
* @param {string} reconsignmentAnnouncementNumber The number of the reconsignmentAnnouncement.
* @param {'shippingLabel'} 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: - shippingLabel: The shipping label for the end customer to ship goods back to the steve warehouse.\\ 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}
*/
getReconsignmentAnnouncementDocument(reconsignmentAnnouncementNumber, documentCode, shopCode, options) {
return localVarFp.getReconsignmentAnnouncementDocument(reconsignmentAnnouncementNumber, documentCode, shopCode, options).then((request) => request(axios, basePath));
},
};
};
exports.ReconsignmentAnnouncementApiFactory = ReconsignmentAnnouncementApiFactory;
/**
* ReconsignmentAnnouncementApi - object-oriented interface
* @export
* @class ReconsignmentAnnouncementApi
* @extends {BaseAPI}
*/
class ReconsignmentAnnouncementApi extends base_1.BaseAPI {
/**
* Get the reconsignment announcement with the given reconsignmentAnnouncementNumber.
* @summary Get the reconsignment announcement with the given reconsignmentAnnouncementNumber.
* @param {string} reconsignmentAnnouncementNumber Number of the reconsignment announcement
* @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 ReconsignmentAnnouncementApi
*/
getReconsignmentAnnouncement(reconsignmentAnnouncementNumber, shopCode, options) {
return (0, exports.ReconsignmentAnnouncementApiFp)(this.configuration).getReconsignmentAnnouncement(reconsignmentAnnouncementNumber, shopCode, options).then((request) => request(this.axios, this.basePath));
}
/**
* Get reconsignment announcements.
* @summary Get reconsignment announcements.
* @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} [sortBy] Sort the results by one or more comma-separated sort criteria, with the criterion specified first having priority. Available sort orders: - asc: ascending order - desc: descending order Available fields for sorting: - reconsignmentAnnouncementDate The default sort order is reconsignmentAnnouncementDate:desc.
* @param {string} [filterShopCode] 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] Filter for a single order number.
* @param {boolean} [filterReconsignmentAnnouncementCompleted] Filter for completed or not completed reconsignment announcements.
* @param {string} [filterReconsignmentAnnouncementDateFrom] Filter for reconsignmentAnnouncementDate (from)
* @param {string} [filterReconsignmentAnnouncementDateTo] Filter for reconsignmentAnnouncementDate (to)
* @param {string} [filterSearch] Filter for reconsignment announcement search. Usage: - Provide one or multiple search terms (min. 2 characters) to filter results. - Multiple search terms are separated by spaces. - The search is not case sensitive. - The search is enabled for the fields reconsignmentAnnouncementNumber, orderNumber, externalOrderReference and reconsignmentTrackingCode. - Each search term filters the response for reconsignment announcements where at least one of the fields contains the search term. - For example, filter[search]=\'term1 term2\' will filter the result for reconsignment announcements where \'term1\' is found in any field and \'term2\' is also found in any field.\\ If only \'term1\' or \'term2\' is found in the fields, the reconsignment announcement is not included in the results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ReconsignmentAnnouncementApi
*/
getReconsignmentAnnouncementCollection(page, pageSize, paginationMode, sortBy, filterShopCode, filterOrderNumber, filterReconsignmentAnnouncementCompleted, filterReconsignmentAnnouncementDateFrom, filterReconsignmentAnnouncementDateTo, filterSearch, options) {
return (0, exports.ReconsignmentAnnouncementApiFp)(this.configuration).getReconsignmentAnnouncementCollection(page, pageSize, paginationMode, sortBy, filterShopCode, filterOrderNumber, filterReconsignmentAnnouncementCompleted, filterReconsignmentAnnouncementDateFrom, filterReconsignmentAnnouncementDateTo, filterSearch, options).then((request) => request(this.axios, this.basePath));
}
/**
* Allows to download a document associated with the given reconsignmentAnnouncement.
* @summary Download reconsignmentAnnouncement related documents.
* @param {string} reconsignmentAnnouncementNumber The number of the reconsignmentAnnouncement.
* @param {'shippingLabel'} 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: - shippingLabel: The shipping label for the end customer to ship goods back to the steve warehouse.\\ 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 ReconsignmentAnnouncementApi
*/
getReconsignmentAnnouncementDocument(reconsignmentAnnouncementNumber, documentCode, shopCode, options) {
return (0, exports.ReconsignmentAnnouncementApiFp)(this.configuration).getReconsignmentAnnouncementDocument(reconsignmentAnnouncementNumber, documentCode, shopCode, options).then((request) => request(this.axios, this.basePath));
}
}
exports.ReconsignmentAnnouncementApi = ReconsignmentAnnouncementApi;