@coscine/api-client 2.11.0 → 3.0.0

package/dist/types/Coscine.Api.User/api.d.ts

@@ -1,745 +0,0 @@
-/**
- * Coscine.Api.User
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 3.2.1
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import { Configuration } from './configuration';
-import { AxiosPromise, AxiosInstance } from 'axios';
-import { RequestArgs, BaseAPI } from './base';
-/**
- *
- * @export
- * @interface ContactChangeObject
- */
-export interface ContactChangeObject {
-    /**
-     *
-     * @type {string}
-     * @memberof ContactChangeObject
-     */
-    relationId?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof ContactChangeObject
-     */
-    userId?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof ContactChangeObject
-     */
-    newEmail?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof ContactChangeObject
-     */
-    editDate?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof ContactChangeObject
-     */
-    confirmationToken?: string;
-}
-/**
- *
- * @export
- * @interface DisciplineObject
- */
-export interface DisciplineObject {
-    /**
-     *
-     * @type {string}
-     * @memberof DisciplineObject
-     */
-    id?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof DisciplineObject
-     */
-    url?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof DisciplineObject
-     */
-    displayNameDe?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof DisciplineObject
-     */
-    displayNameEn?: string | null;
-}
-/**
- *
- * @export
- * @interface ExternalAuthenticatorsObject
- */
-export interface ExternalAuthenticatorsObject {
-    /**
-     *
-     * @type {string}
-     * @memberof ExternalAuthenticatorsObject
-     */
-    id?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof ExternalAuthenticatorsObject
-     */
-    displayName?: string | null;
-}
-/**
- *
- * @export
- * @interface LanguageObject
- */
-export interface LanguageObject {
-    /**
-     *
-     * @type {string}
-     * @memberof LanguageObject
-     */
-    id?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof LanguageObject
-     */
-    displayName?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof LanguageObject
-     */
-    abbreviation?: string | null;
-}
-/**
- *
- * @export
- * @interface TitleObject
- */
-export interface TitleObject {
-    /**
-     *
-     * @type {string}
-     * @memberof TitleObject
-     */
-    id?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof TitleObject
-     */
-    displayName?: string | null;
-}
-/**
- * Class representing the TOS version
- * @export
- * @interface Tos
- */
-export interface Tos {
-    /**
-     * The TOS version
-     * @type {Array<string>}
-     * @memberof Tos
-     */
-    version?: Array<string> | null;
-}
-/**
- *
- * @export
- * @interface UserObject
- */
-export interface UserObject {
-    /**
-     *
-     * @type {string}
-     * @memberof UserObject
-     */
-    id?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof UserObject
-     */
-    displayName?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof UserObject
-     */
-    givenname?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof UserObject
-     */
-    surname?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof UserObject
-     */
-    emailAddress?: string | null;
-    /**
-     *
-     * @type {boolean}
-     * @memberof UserObject
-     */
-    hasProjectRole?: boolean;
-    /**
-     *
-     * @type {TitleObject}
-     * @memberof UserObject
-     */
-    title?: TitleObject | null;
-    /**
-     *
-     * @type {LanguageObject}
-     * @memberof UserObject
-     */
-    language?: LanguageObject | null;
-    /**
-     *
-     * @type {string}
-     * @memberof UserObject
-     */
-    organization?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof UserObject
-     */
-    institute?: string | null;
-    /**
-     *
-     * @type {Array<DisciplineObject>}
-     * @memberof UserObject
-     */
-    disciplines?: Array<DisciplineObject> | null;
-    /**
-     *
-     * @type {boolean}
-     * @memberof UserObject
-     */
-    isRegistered?: boolean;
-    /**
-     *
-     * @type {Array<ExternalAuthenticatorsObject>}
-     * @memberof UserObject
-     */
-    externalAuthenticators?: Array<ExternalAuthenticatorsObject> | null;
-}
-/**
- * ContactChangeApi - axios parameter creator
- * @export
- */
-export declare const ContactChangeApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary This method enables the user to request a change of his or her contact email. After entering a valid email, a confirmation email will be sent to the new address and a notification email will be sent to the present address.
-     * @param {string} body A new email as string set by the user.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    contactChangeChangeContactEmail: (body: string, options?: any) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Calling this method checks whether or not the entered confirmation token (verification) exists inside the database for the current user. If yes, it updates the EmailAddress field for that user with the New Email that has been requested with the ChangeContactEmail method.
-     * @param {string} verification The Confirmation Token as String for a New Email.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    contactChangeConfirmContactEmail: (verification: string, options?: any) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Calling this method will check if there are pending emails for confirmation for the current user.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    contactChangeConfirmationStatus: (options?: any) => Promise<RequestArgs>;
-};
-/**
- * ContactChangeApi - functional programming interface
- * @export
- */
-export declare const ContactChangeApiFp: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary This method enables the user to request a change of his or her contact email. After entering a valid email, a confirmation email will be sent to the new address and a notification email will be sent to the present address.
-     * @param {string} body A new email as string set by the user.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    contactChangeChangeContactEmail(body: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContactChangeObject>>;
-    /**
-     *
-     * @summary Calling this method checks whether or not the entered confirmation token (verification) exists inside the database for the current user. If yes, it updates the EmailAddress field for that user with the New Email that has been requested with the ChangeContactEmail method.
-     * @param {string} verification The Confirmation Token as String for a New Email.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    contactChangeConfirmContactEmail(verification: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserObject>>;
-    /**
-     *
-     * @summary Calling this method will check if there are pending emails for confirmation for the current user.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    contactChangeConfirmationStatus(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ContactChangeObject>>>;
-};
-/**
- * ContactChangeApi - factory interface
- * @export
- */
-export declare const ContactChangeApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     *
-     * @summary This method enables the user to request a change of his or her contact email. After entering a valid email, a confirmation email will be sent to the new address and a notification email will be sent to the present address.
-     * @param {string} body A new email as string set by the user.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    contactChangeChangeContactEmail(body: string, options?: any): AxiosPromise<ContactChangeObject>;
-    /**
-     *
-     * @summary Calling this method checks whether or not the entered confirmation token (verification) exists inside the database for the current user. If yes, it updates the EmailAddress field for that user with the New Email that has been requested with the ChangeContactEmail method.
-     * @param {string} verification The Confirmation Token as String for a New Email.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    contactChangeConfirmContactEmail(verification: string, options?: any): AxiosPromise<UserObject>;
-    /**
-     *
-     * @summary Calling this method will check if there are pending emails for confirmation for the current user.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    contactChangeConfirmationStatus(options?: any): AxiosPromise<Array<ContactChangeObject>>;
-};
-/**
- * ContactChangeApi - object-oriented interface
- * @export
- * @class ContactChangeApi
- * @extends {BaseAPI}
- */
-export declare class ContactChangeApi extends BaseAPI {
-    /**
-     *
-     * @summary This method enables the user to request a change of his or her contact email. After entering a valid email, a confirmation email will be sent to the new address and a notification email will be sent to the present address.
-     * @param {string} body A new email as string set by the user.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof ContactChangeApi
-     */
-    contactChangeChangeContactEmail(body: string, options?: any): Promise<import("axios").AxiosResponse<ContactChangeObject>>;
-    /**
-     *
-     * @summary Calling this method checks whether or not the entered confirmation token (verification) exists inside the database for the current user. If yes, it updates the EmailAddress field for that user with the New Email that has been requested with the ChangeContactEmail method.
-     * @param {string} verification The Confirmation Token as String for a New Email.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof ContactChangeApi
-     */
-    contactChangeConfirmContactEmail(verification: string, options?: any): Promise<import("axios").AxiosResponse<UserObject>>;
-    /**
-     *
-     * @summary Calling this method will check if there are pending emails for confirmation for the current user.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof ContactChangeApi
-     */
-    contactChangeConfirmationStatus(options?: any): Promise<import("axios").AxiosResponse<ContactChangeObject[]>>;
-}
-/**
- * LanguageApi - axios parameter creator
- * @export
- */
-export declare const LanguageApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Returns all available languages.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    languageIndex: (options?: any) => Promise<RequestArgs>;
-};
-/**
- * LanguageApi - functional programming interface
- * @export
- */
-export declare const LanguageApiFp: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Returns all available languages.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    languageIndex(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<LanguageObject>>>;
-};
-/**
- * LanguageApi - factory interface
- * @export
- */
-export declare const LanguageApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     *
-     * @summary Returns all available languages.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    languageIndex(options?: any): AxiosPromise<Array<LanguageObject>>;
-};
-/**
- * LanguageApi - object-oriented interface
- * @export
- * @class LanguageApi
- * @extends {BaseAPI}
- */
-export declare class LanguageApi extends BaseAPI {
-    /**
-     *
-     * @summary Returns all available languages.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof LanguageApi
-     */
-    languageIndex(options?: any): Promise<import("axios").AxiosResponse<LanguageObject[]>>;
-}
-/**
- * TOSApi - axios parameter creator
- * @export
- */
-export declare const TOSApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Calling this method accepts the TOS for the current user.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    tOSAcceptCurrentTOSVersion: (options?: any) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Returns the TOS Versions accepted by the current user.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    tOSAcceptedTOSVersion: (options?: any) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Returns the current TOS Version.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    tOSGetCurrentTOSVersion: (options?: any) => Promise<RequestArgs>;
-};
-/**
- * TOSApi - functional programming interface
- * @export
- */
-export declare const TOSApiFp: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Calling this method accepts the TOS for the current user.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    tOSAcceptCurrentTOSVersion(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
-    /**
-     *
-     * @summary Returns the TOS Versions accepted by the current user.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    tOSAcceptedTOSVersion(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tos>>;
-    /**
-     *
-     * @summary Returns the current TOS Version.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    tOSGetCurrentTOSVersion(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
-};
-/**
- * TOSApi - factory interface
- * @export
- */
-export declare const TOSApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     *
-     * @summary Calling this method accepts the TOS for the current user.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    tOSAcceptCurrentTOSVersion(options?: any): AxiosPromise<string>;
-    /**
-     *
-     * @summary Returns the TOS Versions accepted by the current user.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    tOSAcceptedTOSVersion(options?: any): AxiosPromise<Tos>;
-    /**
-     *
-     * @summary Returns the current TOS Version.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    tOSGetCurrentTOSVersion(options?: any): AxiosPromise<string>;
-};
-/**
- * TOSApi - object-oriented interface
- * @export
- * @class TOSApi
- * @extends {BaseAPI}
- */
-export declare class TOSApi extends BaseAPI {
-    /**
-     *
-     * @summary Calling this method accepts the TOS for the current user.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof TOSApi
-     */
-    tOSAcceptCurrentTOSVersion(options?: any): Promise<import("axios").AxiosResponse<string>>;
-    /**
-     *
-     * @summary Returns the TOS Versions accepted by the current user.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof TOSApi
-     */
-    tOSAcceptedTOSVersion(options?: any): Promise<import("axios").AxiosResponse<Tos>>;
-    /**
-     *
-     * @summary Returns the current TOS Version.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof TOSApi
-     */
-    tOSGetCurrentTOSVersion(options?: any): Promise<import("axios").AxiosResponse<string>>;
-}
-/**
- * TitleApi - axios parameter creator
- * @export
- */
-export declare const TitleApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Returns all available titles.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    titleIndex: (options?: any) => Promise<RequestArgs>;
-};
-/**
- * TitleApi - functional programming interface
- * @export
- */
-export declare const TitleApiFp: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Returns all available titles.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    titleIndex(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TitleObject>>>;
-};
-/**
- * TitleApi - factory interface
- * @export
- */
-export declare const TitleApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     *
-     * @summary Returns all available titles.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    titleIndex(options?: any): AxiosPromise<Array<TitleObject>>;
-};
-/**
- * TitleApi - object-oriented interface
- * @export
- * @class TitleApi
- * @extends {BaseAPI}
- */
-export declare class TitleApi extends BaseAPI {
-    /**
-     *
-     * @summary Returns all available titles.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof TitleApi
-     */
-    titleIndex(options?: any): Promise<import("axios").AxiosResponse<TitleObject[]>>;
-}
-/**
- * UserApi - axios parameter creator
- * @export
- */
-export declare const UserApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Retrieves the UserObject.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    userGetUser: (options?: any) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary This method lets someone query the user database using a query string.
-     * @param {string} queryString Search String
-     * @param {string} projectId Project from which the search is triggered
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    userQuery: (queryString: string, projectId: string, options?: any) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Sets and returns a merge token.
-     * @param {string} provider Specifies the provider from which a user should be merged from
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    userSetAndReturnMergeToken: (provider: string, options?: any) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Updates the User.
-     * @param {UserObject} userObject Entry representing the user
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    userUpdateUser: (userObject: UserObject, options?: any) => Promise<RequestArgs>;
-};
-/**
- * UserApi - functional programming interface
- * @export
- */
-export declare const UserApiFp: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Retrieves the UserObject.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    userGetUser(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserObject>>;
-    /**
-     *
-     * @summary This method lets someone query the user database using a query string.
-     * @param {string} queryString Search String
-     * @param {string} projectId Project from which the search is triggered
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    userQuery(queryString: string, projectId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UserObject>>>;
-    /**
-     *
-     * @summary Sets and returns a merge token.
-     * @param {string} provider Specifies the provider from which a user should be merged from
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    userSetAndReturnMergeToken(provider: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
-    /**
-     *
-     * @summary Updates the User.
-     * @param {UserObject} userObject Entry representing the user
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    userUpdateUser(userObject: UserObject, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<number>>;
-};
-/**
- * UserApi - factory interface
- * @export
- */
-export declare const UserApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     *
-     * @summary Retrieves the UserObject.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    userGetUser(options?: any): AxiosPromise<UserObject>;
-    /**
-     *
-     * @summary This method lets someone query the user database using a query string.
-     * @param {string} queryString Search String
-     * @param {string} projectId Project from which the search is triggered
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    userQuery(queryString: string, projectId: string, options?: any): AxiosPromise<Array<UserObject>>;
-    /**
-     *
-     * @summary Sets and returns a merge token.
-     * @param {string} provider Specifies the provider from which a user should be merged from
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    userSetAndReturnMergeToken(provider: string, options?: any): AxiosPromise<string>;
-    /**
-     *
-     * @summary Updates the User.
-     * @param {UserObject} userObject Entry representing the user
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    userUpdateUser(userObject: UserObject, options?: any): AxiosPromise<number>;
-};
-/**
- * UserApi - object-oriented interface
- * @export
- * @class UserApi
- * @extends {BaseAPI}
- */
-export declare class UserApi extends BaseAPI {
-    /**
-     *
-     * @summary Retrieves the UserObject.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof UserApi
-     */
-    userGetUser(options?: any): Promise<import("axios").AxiosResponse<UserObject>>;
-    /**
-     *
-     * @summary This method lets someone query the user database using a query string.
-     * @param {string} queryString Search String
-     * @param {string} projectId Project from which the search is triggered
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof UserApi
-     */
-    userQuery(queryString: string, projectId: string, options?: any): Promise<import("axios").AxiosResponse<UserObject[]>>;
-    /**
-     *
-     * @summary Sets and returns a merge token.
-     * @param {string} provider Specifies the provider from which a user should be merged from
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof UserApi
-     */
-    userSetAndReturnMergeToken(provider: string, options?: any): Promise<import("axios").AxiosResponse<string>>;
-    /**
-     *
-     * @summary Updates the User.
-     * @param {UserObject} userObject Entry representing the user
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof UserApi
-     */
-    userUpdateUser(userObject: UserObject, options?: any): Promise<import("axios").AxiosResponse<number>>;
-}