/** * 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 { RequestArgs, BaseAPI } from '../base'; import { DeactivateProfileRequest } from '../models'; import { GetCollaboratorsByIdListResponseInner } from '../models'; import { GetProfileByTag } from '../models'; import { SearchFilters } from '../models'; import { SearchResponse } from '../models'; /** * CommonApi - axios parameter creator * @export */ export declare const CommonApiAxiosParamCreator: (configuration?: Configuration) => { /** * get a list of collaborators * @summary get a list of collaborators * @param {*} [options] Override http request option. * @throws {RequiredError} */ collaborators: (options?: AxiosRequestConfig) => Promise; /** * Deactivate a profile * @summary Deactivate a profile * @param {DeactivateProfileRequest} [deactivateProfileRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deactivateProfile: (deactivateProfileRequest?: DeactivateProfileRequest, options?: AxiosRequestConfig) => Promise; /** * 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?: AxiosRequestConfig) => Promise; /** * 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?: AxiosRequestConfig) => Promise; }; /** * CommonApi - functional programming interface * @export */ export declare const CommonApiFp: (configuration?: Configuration) => { /** * get a list of collaborators * @summary get a list of collaborators * @param {*} [options] Override http request option. * @throws {RequiredError} */ collaborators(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Deactivate a profile * @summary Deactivate a profile * @param {DeactivateProfileRequest} [deactivateProfileRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deactivateProfile(deactivateProfileRequest?: DeactivateProfileRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => 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} */ getProfileByTag(tag: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => 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} */ search(searchTerm: string, offset?: number, limit?: number, filters?: SearchFilters, scope?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CommonApi - factory interface * @export */ export declare const CommonApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * get a list of collaborators * @summary get a list of collaborators * @param {*} [options] Override http request option. * @throws {RequiredError} */ collaborators(options?: any): AxiosPromise>; /** * Deactivate a profile * @summary Deactivate a profile * @param {DeactivateProfileRequest} [deactivateProfileRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deactivateProfile(deactivateProfileRequest?: DeactivateProfileRequest, options?: any): 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} */ getProfileByTag(tag: string, options?: any): 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} */ search(searchTerm: string, offset?: number, limit?: number, filters?: SearchFilters, scope?: string, options?: any): AxiosPromise; }; /** * 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 declare 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 */ collaborators(options?: AxiosRequestConfig): Promise>; /** * Deactivate a profile * @summary Deactivate a profile * @param {DeactivateProfileRequest} [deactivateProfileRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CommonApi */ deactivateProfile(deactivateProfileRequest?: DeactivateProfileRequest, options?: AxiosRequestConfig): Promise>; /** * 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 */ getProfileByTag(tag: string, options?: AxiosRequestConfig): Promise>; /** * 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 */ search(searchTerm: string, offset?: number, limit?: number, filters?: SearchFilters, scope?: string, options?: AxiosRequestConfig): Promise>; }