@datenkraft/bb-organization-structure-api-ts-client
Version:
The organization-structure API TS Client enables you to work with the organization-structure API
228 lines (227 loc) • 12.7 kB
JavaScript
;
/* tslint:disable */
/* eslint-disable */
/**
* Backbone Organization Structure 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://organization-structure-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) [Backbone Organization Structure API PHP client @Packagist](https://packagist.org/packages/datenkraft/bb-organization-structure-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.OrganizationApi = exports.OrganizationApiFactory = exports.OrganizationApiFp = exports.OrganizationApiAxiosParamCreator = 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");
/**
* OrganizationApi - axios parameter creator
* @export
*/
const OrganizationApiAxiosParamCreator = function (configuration) {
return {
/**
* Get an Organization by organizationId
* @summary Get an Organization by organizationId
* @param {string} organizationId Organization Id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getOrganization: (organizationId, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'organizationId' is not null or undefined
(0, common_1.assertParamExists)('getOrganization', 'organizationId', organizationId);
const localVarPath = `/organization/{organizationId}`
.replace(`{${"organizationId"}}`, encodeURIComponent(String(organizationId)));
// 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);
(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 list of organizations
* @summary Get a list of organizations
* @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 {*} [options] Override http request option.
* @throws {RequiredError}
*/
getOrganizationCollection: (page, pageSize, paginationMode, options = {}) => __awaiter(this, void 0, void 0, function* () {
const localVarPath = `/organization`;
// 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;
}
(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.OrganizationApiAxiosParamCreator = OrganizationApiAxiosParamCreator;
/**
* OrganizationApi - functional programming interface
* @export
*/
const OrganizationApiFp = function (configuration) {
const localVarAxiosParamCreator = (0, exports.OrganizationApiAxiosParamCreator)(configuration);
return {
/**
* Get an Organization by organizationId
* @summary Get an Organization by organizationId
* @param {string} organizationId Organization Id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getOrganization(organizationId, options) {
return __awaiter(this, void 0, void 0, function* () {
const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrganization(organizationId, options);
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
});
},
/**
* Get a list of organizations
* @summary Get a list of organizations
* @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 {*} [options] Override http request option.
* @throws {RequiredError}
*/
getOrganizationCollection(page, pageSize, paginationMode, options) {
return __awaiter(this, void 0, void 0, function* () {
const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrganizationCollection(page, pageSize, paginationMode, options);
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
});
},
};
};
exports.OrganizationApiFp = OrganizationApiFp;
/**
* OrganizationApi - factory interface
* @export
*/
const OrganizationApiFactory = function (configuration, basePath, axios) {
const localVarFp = (0, exports.OrganizationApiFp)(configuration);
return {
/**
* Get an Organization by organizationId
* @summary Get an Organization by organizationId
* @param {string} organizationId Organization Id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getOrganization(organizationId, options) {
return localVarFp.getOrganization(organizationId, options).then((request) => request(axios, basePath));
},
/**
* Get a list of organizations
* @summary Get a list of organizations
* @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 {*} [options] Override http request option.
* @throws {RequiredError}
*/
getOrganizationCollection(page, pageSize, paginationMode, options) {
return localVarFp.getOrganizationCollection(page, pageSize, paginationMode, options).then((request) => request(axios, basePath));
},
};
};
exports.OrganizationApiFactory = OrganizationApiFactory;
/**
* OrganizationApi - object-oriented interface
* @export
* @class OrganizationApi
* @extends {BaseAPI}
*/
class OrganizationApi extends base_1.BaseAPI {
/**
* Get an Organization by organizationId
* @summary Get an Organization by organizationId
* @param {string} organizationId Organization Id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof OrganizationApi
*/
getOrganization(organizationId, options) {
return (0, exports.OrganizationApiFp)(this.configuration).getOrganization(organizationId, options).then((request) => request(this.axios, this.basePath));
}
/**
* Get a list of organizations
* @summary Get a list of organizations
* @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 {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof OrganizationApi
*/
getOrganizationCollection(page, pageSize, paginationMode, options) {
return (0, exports.OrganizationApiFp)(this.configuration).getOrganizationCollection(page, pageSize, paginationMode, options).then((request) => request(this.axios, this.basePath));
}
}
exports.OrganizationApi = OrganizationApi;