/* tslint:disable */ /* eslint-disable */ /** * The Association for Cube Commons * The CubeCommons API caters to each and every whim of the Frontend, i.e. it receives, bundles, packages and formats data exactly as the Frontend needs it. * * The version of the OpenAPI document: 0.9.95 * Contact: tech@cubecommons.ca * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; import globalAxios from 'axios'; // Some imports not used depending on template conditions // @ts-ignore import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base'; // @ts-ignore import { DeactivateProfileRequest } from '../models'; // @ts-ignore import { ErrorResponse } from '../models'; // @ts-ignore import { GetCollaboratorsByIdListResponseInner } from '../models'; // @ts-ignore import { GetProfileByTag } from '../models'; // @ts-ignore import { SearchFilters } from '../models'; // @ts-ignore import { SearchResponse } from '../models'; /** * CommonApi - axios parameter creator * @export */ export const CommonApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * get a list of collaborators * @summary get a list of collaborators * @param {*} [options] Override http request option. * @throws {RequiredError} */ collaborators: async (options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/collaborators`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication jwt_logged_in required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Deactivate a profile * @summary Deactivate a profile * @param {DeactivateProfileRequest} [deactivateProfileRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deactivateProfile: async (deactivateProfileRequest?: DeactivateProfileRequest, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/deactivateProfile`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication jwt_logged_in required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; localVarRequestOptions.data = serializeDataIfNeeded(deactivateProfileRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Get profile details by tag. * @summary Get profile details by tag * @param {string} tag Profile tag * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProfileByTag: async (tag: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'tag' is not null or undefined assertParamExists('getProfileByTag', 'tag', tag) const localVarPath = `/profiles/tag/{tag}` .replace(`{${"tag"}}`, encodeURIComponent(String(tag))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication jwt_logged_in required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Returns search results based on the provided query parameters. * @summary Search based on query parameters * @param {string} searchTerm term to look for in data * @param {number} [offset] Offset into the result set * @param {number} [limit] Max number of items to return * @param {SearchFilters} [filters] Filters for which content is returned * @param {string} [scope] whether to scope by profiles, content or both. * @param {*} [options] Override http request option. * @throws {RequiredError} */ search: async (searchTerm: string, offset?: number, limit?: number, filters?: SearchFilters, scope?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'searchTerm' is not null or undefined assertParamExists('search', 'searchTerm', searchTerm) const localVarPath = `/search`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication jwt_logged_in required // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (searchTerm !== undefined) { localVarQueryParameter['searchTerm'] = searchTerm; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } if (scope !== undefined) { localVarQueryParameter['scope'] = scope; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, } }; /** * CommonApi - functional programming interface * @export */ export const CommonApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = CommonApiAxiosParamCreator(configuration) return { /** * get a list of collaborators * @summary get a list of collaborators * @param {*} [options] Override http request option. * @throws {RequiredError} */ async collaborators(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.collaborators(options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Deactivate a profile * @summary Deactivate a profile * @param {DeactivateProfileRequest} [deactivateProfileRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ async deactivateProfile(deactivateProfileRequest?: DeactivateProfileRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deactivateProfile(deactivateProfileRequest, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Get profile details by tag. * @summary Get profile details by tag * @param {string} tag Profile tag * @param {*} [options] Override http request option. * @throws {RequiredError} */ async getProfileByTag(tag: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getProfileByTag(tag, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Returns search results based on the provided query parameters. * @summary Search based on query parameters * @param {string} searchTerm term to look for in data * @param {number} [offset] Offset into the result set * @param {number} [limit] Max number of items to return * @param {SearchFilters} [filters] Filters for which content is returned * @param {string} [scope] whether to scope by profiles, content or both. * @param {*} [options] Override http request option. * @throws {RequiredError} */ async search(searchTerm: string, offset?: number, limit?: number, filters?: SearchFilters, scope?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.search(searchTerm, offset, limit, filters, scope, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, } }; /** * CommonApi - factory interface * @export */ export const CommonApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = CommonApiFp(configuration) return { /** * get a list of collaborators * @summary get a list of collaborators * @param {*} [options] Override http request option. * @throws {RequiredError} */ collaborators(options?: any): AxiosPromise> { return localVarFp.collaborators(options).then((request) => request(axios, basePath)); }, /** * Deactivate a profile * @summary Deactivate a profile * @param {DeactivateProfileRequest} [deactivateProfileRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deactivateProfile(deactivateProfileRequest?: DeactivateProfileRequest, options?: any): AxiosPromise { return localVarFp.deactivateProfile(deactivateProfileRequest, options).then((request) => request(axios, basePath)); }, /** * Get profile details by tag. * @summary Get profile details by tag * @param {string} tag Profile tag * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProfileByTag(tag: string, options?: any): AxiosPromise { return localVarFp.getProfileByTag(tag, options).then((request) => request(axios, basePath)); }, /** * Returns search results based on the provided query parameters. * @summary Search based on query parameters * @param {string} searchTerm term to look for in data * @param {number} [offset] Offset into the result set * @param {number} [limit] Max number of items to return * @param {SearchFilters} [filters] Filters for which content is returned * @param {string} [scope] whether to scope by profiles, content or both. * @param {*} [options] Override http request option. * @throws {RequiredError} */ search(searchTerm: string, offset?: number, limit?: number, filters?: SearchFilters, scope?: string, options?: any): AxiosPromise { return localVarFp.search(searchTerm, offset, limit, filters, scope, options).then((request) => request(axios, basePath)); }, }; }; /** * CommonApi - interface * @export * @interface CommonApi */ export interface CommonApiInterface { /** * get a list of collaborators * @summary get a list of collaborators * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommonApiInterface */ collaborators(options?: AxiosRequestConfig): AxiosPromise>; /** * Deactivate a profile * @summary Deactivate a profile * @param {DeactivateProfileRequest} [deactivateProfileRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommonApiInterface */ deactivateProfile(deactivateProfileRequest?: DeactivateProfileRequest, options?: AxiosRequestConfig): AxiosPromise; /** * Get profile details by tag. * @summary Get profile details by tag * @param {string} tag Profile tag * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommonApiInterface */ getProfileByTag(tag: string, options?: AxiosRequestConfig): AxiosPromise; /** * Returns search results based on the provided query parameters. * @summary Search based on query parameters * @param {string} searchTerm term to look for in data * @param {number} [offset] Offset into the result set * @param {number} [limit] Max number of items to return * @param {SearchFilters} [filters] Filters for which content is returned * @param {string} [scope] whether to scope by profiles, content or both. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommonApiInterface */ search(searchTerm: string, offset?: number, limit?: number, filters?: SearchFilters, scope?: string, options?: AxiosRequestConfig): AxiosPromise; } /** * CommonApi - object-oriented interface * @export * @class CommonApi * @extends {BaseAPI} */ export class CommonApi extends BaseAPI implements CommonApiInterface { /** * get a list of collaborators * @summary get a list of collaborators * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommonApi */ public collaborators(options?: AxiosRequestConfig) { return CommonApiFp(this.configuration).collaborators(options).then((request) => request(this.axios, this.basePath)); } /** * Deactivate a profile * @summary Deactivate a profile * @param {DeactivateProfileRequest} [deactivateProfileRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommonApi */ public deactivateProfile(deactivateProfileRequest?: DeactivateProfileRequest, options?: AxiosRequestConfig) { return CommonApiFp(this.configuration).deactivateProfile(deactivateProfileRequest, options).then((request) => request(this.axios, this.basePath)); } /** * Get profile details by tag. * @summary Get profile details by tag * @param {string} tag Profile tag * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommonApi */ public getProfileByTag(tag: string, options?: AxiosRequestConfig) { return CommonApiFp(this.configuration).getProfileByTag(tag, options).then((request) => request(this.axios, this.basePath)); } /** * Returns search results based on the provided query parameters. * @summary Search based on query parameters * @param {string} searchTerm term to look for in data * @param {number} [offset] Offset into the result set * @param {number} [limit] Max number of items to return * @param {SearchFilters} [filters] Filters for which content is returned * @param {string} [scope] whether to scope by profiles, content or both. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommonApi */ public search(searchTerm: string, offset?: number, limit?: number, filters?: SearchFilters, scope?: string, options?: AxiosRequestConfig) { return CommonApiFp(this.configuration).search(searchTerm, offset, limit, filters, scope, options).then((request) => request(this.axios, this.basePath)); } }