@datenkraft/bb-fulfillment-api-ts-client
Version:
The fulfillment API TS Client enables you to work with the fulfillment API
288 lines (287 loc) • 23 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.ReconsignmentApi = exports.ReconsignmentApiFactory = exports.ReconsignmentApiFp = exports.ReconsignmentApiAxiosParamCreator = 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");
/**
* ReconsignmentApi - axios parameter creator
* @export
*/
const ReconsignmentApiAxiosParamCreator = function (configuration) {
return {
/**
* Read the reconsignment specified by the given reconsignment number (set in param reconsignmentNumber).
* @summary Read the reconsignment specified by the given reconsignment number (set in param reconsignmentNumber).
* @param {string} reconsignmentNumber
* @param {string} [shopCode]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getReconsignment: (reconsignmentNumber, shopCode, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'reconsignmentNumber' is not null or undefined
(0, common_1.assertParamExists)('getReconsignment', 'reconsignmentNumber', reconsignmentNumber);
const localVarPath = `/reconsignment/{reconsignmentNumber}`
.replace(`{${"reconsignmentNumber"}}`, encodeURIComponent(String(reconsignmentNumber)));
// 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,
};
}),
/**
* Read the reconsignments in the given dateRange.
* @summary Read the reconsignments in the given dateRange.
* @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: - reconsignmentDate The default sort order is reconsignmentDate:desc.
* @param {string} [filterShopCode] The shop to which the reconsignments belongs to.
* @param {string} [filterOrderNumber] The order number which the reconsignments belong to.
* @param {boolean} [filterReconsignmentWasPreAnnounced] Filter for reconsignments that were pre-announced (true) or not (false).
* @param {string} [filterSearch] Filter for reconsignment 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 \'reconsignmentNumber\' and \'orderNumber\'. - 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 {string} [filterReconsignmentDateFrom] filter for reconsignmentDate format in ISO 8601 with UTC offsets
* @param {string} [filterReconsignmentDateTo] filter for reconsignmentDate format in ISO 8601 with UTC offsets
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getReconsignmentCollection: (page, pageSize, paginationMode, sortBy, filterShopCode, filterOrderNumber, filterReconsignmentWasPreAnnounced, filterSearch, filterReconsignmentDateFrom, filterReconsignmentDateTo, options = {}) => __awaiter(this, void 0, void 0, function* () {
const localVarPath = `/reconsignment`;
// 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 (filterReconsignmentWasPreAnnounced !== undefined) {
localVarQueryParameter['filter[reconsignmentWasPreAnnounced]'] = filterReconsignmentWasPreAnnounced;
}
if (filterSearch !== undefined) {
localVarQueryParameter['filter[search]'] = filterSearch;
}
if (filterReconsignmentDateFrom !== undefined) {
localVarQueryParameter['filter[reconsignmentDateFrom]'] = (filterReconsignmentDateFrom instanceof Date) ?
filterReconsignmentDateFrom.toISOString() :
filterReconsignmentDateFrom;
}
if (filterReconsignmentDateTo !== undefined) {
localVarQueryParameter['filter[reconsignmentDateTo]'] = (filterReconsignmentDateTo instanceof Date) ?
filterReconsignmentDateTo.toISOString() :
filterReconsignmentDateTo;
}
(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.ReconsignmentApiAxiosParamCreator = ReconsignmentApiAxiosParamCreator;
/**
* ReconsignmentApi - functional programming interface
* @export
*/
const ReconsignmentApiFp = function (configuration) {
const localVarAxiosParamCreator = (0, exports.ReconsignmentApiAxiosParamCreator)(configuration);
return {
/**
* Read the reconsignment specified by the given reconsignment number (set in param reconsignmentNumber).
* @summary Read the reconsignment specified by the given reconsignment number (set in param reconsignmentNumber).
* @param {string} reconsignmentNumber
* @param {string} [shopCode]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getReconsignment(reconsignmentNumber, shopCode, options) {
return __awaiter(this, void 0, void 0, function* () {
const localVarAxiosArgs = yield localVarAxiosParamCreator.getReconsignment(reconsignmentNumber, shopCode, options);
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
});
},
/**
* Read the reconsignments in the given dateRange.
* @summary Read the reconsignments in the given dateRange.
* @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: - reconsignmentDate The default sort order is reconsignmentDate:desc.
* @param {string} [filterShopCode] The shop to which the reconsignments belongs to.
* @param {string} [filterOrderNumber] The order number which the reconsignments belong to.
* @param {boolean} [filterReconsignmentWasPreAnnounced] Filter for reconsignments that were pre-announced (true) or not (false).
* @param {string} [filterSearch] Filter for reconsignment 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 \'reconsignmentNumber\' and \'orderNumber\'. - 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 {string} [filterReconsignmentDateFrom] filter for reconsignmentDate format in ISO 8601 with UTC offsets
* @param {string} [filterReconsignmentDateTo] filter for reconsignmentDate format in ISO 8601 with UTC offsets
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getReconsignmentCollection(page, pageSize, paginationMode, sortBy, filterShopCode, filterOrderNumber, filterReconsignmentWasPreAnnounced, filterSearch, filterReconsignmentDateFrom, filterReconsignmentDateTo, options) {
return __awaiter(this, void 0, void 0, function* () {
const localVarAxiosArgs = yield localVarAxiosParamCreator.getReconsignmentCollection(page, pageSize, paginationMode, sortBy, filterShopCode, filterOrderNumber, filterReconsignmentWasPreAnnounced, filterSearch, filterReconsignmentDateFrom, filterReconsignmentDateTo, options);
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
});
},
};
};
exports.ReconsignmentApiFp = ReconsignmentApiFp;
/**
* ReconsignmentApi - factory interface
* @export
*/
const ReconsignmentApiFactory = function (configuration, basePath, axios) {
const localVarFp = (0, exports.ReconsignmentApiFp)(configuration);
return {
/**
* Read the reconsignment specified by the given reconsignment number (set in param reconsignmentNumber).
* @summary Read the reconsignment specified by the given reconsignment number (set in param reconsignmentNumber).
* @param {string} reconsignmentNumber
* @param {string} [shopCode]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getReconsignment(reconsignmentNumber, shopCode, options) {
return localVarFp.getReconsignment(reconsignmentNumber, shopCode, options).then((request) => request(axios, basePath));
},
/**
* Read the reconsignments in the given dateRange.
* @summary Read the reconsignments in the given dateRange.
* @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: - reconsignmentDate The default sort order is reconsignmentDate:desc.
* @param {string} [filterShopCode] The shop to which the reconsignments belongs to.
* @param {string} [filterOrderNumber] The order number which the reconsignments belong to.
* @param {boolean} [filterReconsignmentWasPreAnnounced] Filter for reconsignments that were pre-announced (true) or not (false).
* @param {string} [filterSearch] Filter for reconsignment 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 \'reconsignmentNumber\' and \'orderNumber\'. - 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 {string} [filterReconsignmentDateFrom] filter for reconsignmentDate format in ISO 8601 with UTC offsets
* @param {string} [filterReconsignmentDateTo] filter for reconsignmentDate format in ISO 8601 with UTC offsets
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getReconsignmentCollection(page, pageSize, paginationMode, sortBy, filterShopCode, filterOrderNumber, filterReconsignmentWasPreAnnounced, filterSearch, filterReconsignmentDateFrom, filterReconsignmentDateTo, options) {
return localVarFp.getReconsignmentCollection(page, pageSize, paginationMode, sortBy, filterShopCode, filterOrderNumber, filterReconsignmentWasPreAnnounced, filterSearch, filterReconsignmentDateFrom, filterReconsignmentDateTo, options).then((request) => request(axios, basePath));
},
};
};
exports.ReconsignmentApiFactory = ReconsignmentApiFactory;
/**
* ReconsignmentApi - object-oriented interface
* @export
* @class ReconsignmentApi
* @extends {BaseAPI}
*/
class ReconsignmentApi extends base_1.BaseAPI {
/**
* Read the reconsignment specified by the given reconsignment number (set in param reconsignmentNumber).
* @summary Read the reconsignment specified by the given reconsignment number (set in param reconsignmentNumber).
* @param {string} reconsignmentNumber
* @param {string} [shopCode]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ReconsignmentApi
*/
getReconsignment(reconsignmentNumber, shopCode, options) {
return (0, exports.ReconsignmentApiFp)(this.configuration).getReconsignment(reconsignmentNumber, shopCode, options).then((request) => request(this.axios, this.basePath));
}
/**
* Read the reconsignments in the given dateRange.
* @summary Read the reconsignments in the given dateRange.
* @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: - reconsignmentDate The default sort order is reconsignmentDate:desc.
* @param {string} [filterShopCode] The shop to which the reconsignments belongs to.
* @param {string} [filterOrderNumber] The order number which the reconsignments belong to.
* @param {boolean} [filterReconsignmentWasPreAnnounced] Filter for reconsignments that were pre-announced (true) or not (false).
* @param {string} [filterSearch] Filter for reconsignment 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 \'reconsignmentNumber\' and \'orderNumber\'. - 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 {string} [filterReconsignmentDateFrom] filter for reconsignmentDate format in ISO 8601 with UTC offsets
* @param {string} [filterReconsignmentDateTo] filter for reconsignmentDate format in ISO 8601 with UTC offsets
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ReconsignmentApi
*/
getReconsignmentCollection(page, pageSize, paginationMode, sortBy, filterShopCode, filterOrderNumber, filterReconsignmentWasPreAnnounced, filterSearch, filterReconsignmentDateFrom, filterReconsignmentDateTo, options) {
return (0, exports.ReconsignmentApiFp)(this.configuration).getReconsignmentCollection(page, pageSize, paginationMode, sortBy, filterShopCode, filterOrderNumber, filterReconsignmentWasPreAnnounced, filterSearch, filterReconsignmentDateFrom, filterReconsignmentDateTo, options).then((request) => request(this.axios, this.basePath));
}
}
exports.ReconsignmentApi = ReconsignmentApi;