/** * Cloud API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { AxiosPromise, AxiosInstance } from 'axios'; import { Configuration } from '../configuration'; import { RequestArgs, BaseAPI } from '../base'; import { ContactDto } from '../models'; import { ContactPageDto } from '../models'; import { ContactSearchResultPageDto } from '../models'; import { CreateNoteDto } from '../models'; import { NoteDto } from '../models'; import { NotePageDto } from '../models'; import { SearchRequestDto } from '../models'; /** * ContactsApi - axios parameter creator * @export */ export declare const ContactsApiAxiosParamCreator: (axiosClientConfiguration?: Configuration) => { /** * This is a very performant method for checking if a Contact exists. * @summary Check if Contact exists * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ contactExists: (id: string, options?: any) => Promise; /** * * @param {ContactDto} contact * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createContact: (contact: ContactDto, translate?: string, options?: any) => Promise; /** * Creates a note with the target set to the id of the contact. * @param {string} id * @param {CreateNoteDto} createNote * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createContactNote: (id: string, createNote: CreateNoteDto, translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteContact: (id: string, translate?: string, options?: any) => Promise; /** * * @param {Array} ids * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteManyContacts: (ids: Array, translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContact: (id: string, translate?: string, options?: any) => Promise; /** * Gets all personal and public notes for a contact * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContactNotes: (id: string, translate?: string, options?: any) => Promise; /** * * @param {number} [page] * @param {number} [size] * @param {string} [translate] * @param {boolean} [withReplacements] * @param {string} [sort] * @param {string} [search] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContacts: (page?: number, size?: number, translate?: string, withReplacements?: boolean, sort?: string, search?: string, options?: any) => Promise; /** * * @param {number} [page] * @param {number} [size] * @param {string} [sort] * @param {string} [search] * @param {boolean} [withReplacements] * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContactsCount: (page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any) => Promise; /** * Returns all contacts that have publicAccess set to true * @summary Public Contacts * @param {number} [page] * @param {number} [size] * @param {string} [sort] * @param {string} [search] * @param {boolean} [withReplacements] * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicContacts: (page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {any} contact * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchContact: (id: string, contact: any, translate?: string, options?: any) => Promise; /** * * @param {SearchRequestDto} searchRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ performContactSearch: (searchRequest: SearchRequestDto, translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {ContactDto} contact * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putContact: (id: string, contact: ContactDto, translate?: string, options?: any) => Promise; /** * * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ syncMicrosoftContacts: (translate?: string, options?: any) => Promise; }; /** * ContactsApi - functional programming interface * @export */ export declare const ContactsApiFp: (axiosClientConfiguration?: Configuration) => { /** * This is a very performant method for checking if a Contact exists. * @summary Check if Contact exists * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ contactExists(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {ContactDto} contact * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createContact(contact: ContactDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a note with the target set to the id of the contact. * @param {string} id * @param {CreateNoteDto} createNote * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createContactNote(id: string, createNote: CreateNoteDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteContact(id: string, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {Array} ids * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteManyContacts(ids: Array, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContact(id: string, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets all personal and public notes for a contact * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContactNotes(id: string, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {number} [page] * @param {number} [size] * @param {string} [translate] * @param {boolean} [withReplacements] * @param {string} [sort] * @param {string} [search] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContacts(page?: number, size?: number, translate?: string, withReplacements?: boolean, sort?: string, search?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {number} [page] * @param {number} [size] * @param {string} [sort] * @param {string} [search] * @param {boolean} [withReplacements] * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContactsCount(page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns all contacts that have publicAccess set to true * @summary Public Contacts * @param {number} [page] * @param {number} [size] * @param {string} [sort] * @param {string} [search] * @param {boolean} [withReplacements] * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicContacts(page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {any} contact * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchContact(id: string, contact: any, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {SearchRequestDto} searchRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ performContactSearch(searchRequest: SearchRequestDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {ContactDto} contact * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putContact(id: string, contact: ContactDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ syncMicrosoftContacts(translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ContactsApi - factory interface * @export */ export declare const ContactsApiFactory: (axiosClientConfiguration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This is a very performant method for checking if a Contact exists. * @summary Check if Contact exists * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ contactExists(id: string, options?: any): AxiosPromise; /** * * @param {ContactDto} contact * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createContact(contact: ContactDto, translate?: string, options?: any): AxiosPromise; /** * Creates a note with the target set to the id of the contact. * @param {string} id * @param {CreateNoteDto} createNote * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createContactNote(id: string, createNote: CreateNoteDto, translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteContact(id: string, translate?: string, options?: any): AxiosPromise; /** * * @param {Array} ids * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteManyContacts(ids: Array, translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContact(id: string, translate?: string, options?: any): AxiosPromise; /** * Gets all personal and public notes for a contact * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContactNotes(id: string, translate?: string, options?: any): AxiosPromise; /** * * @param {number} [page] * @param {number} [size] * @param {string} [translate] * @param {boolean} [withReplacements] * @param {string} [sort] * @param {string} [search] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContacts(page?: number, size?: number, translate?: string, withReplacements?: boolean, sort?: string, search?: string, options?: any): AxiosPromise; /** * * @param {number} [page] * @param {number} [size] * @param {string} [sort] * @param {string} [search] * @param {boolean} [withReplacements] * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContactsCount(page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any): AxiosPromise; /** * Returns all contacts that have publicAccess set to true * @summary Public Contacts * @param {number} [page] * @param {number} [size] * @param {string} [sort] * @param {string} [search] * @param {boolean} [withReplacements] * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicContacts(page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {any} contact * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchContact(id: string, contact: any, translate?: string, options?: any): AxiosPromise; /** * * @param {SearchRequestDto} searchRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ performContactSearch(searchRequest: SearchRequestDto, translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {ContactDto} contact * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putContact(id: string, contact: ContactDto, translate?: string, options?: any): AxiosPromise; /** * * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ syncMicrosoftContacts(translate?: string, options?: any): AxiosPromise; }; /** * Request parameters for contactExists operation in ContactsApi. * @export * @interface ContactsApiContactExistsRequest */ export interface ContactsApiContactExistsRequest { /** * * @type {string} * @memberof ContactsApiContactExists */ readonly id: string; } /** * Request parameters for createContact operation in ContactsApi. * @export * @interface ContactsApiCreateContactRequest */ export interface ContactsApiCreateContactRequest { /** * * @type {ContactDto} * @memberof ContactsApiCreateContact */ readonly contact: ContactDto; /** * * @type {string} * @memberof ContactsApiCreateContact */ readonly translate?: string; } /** * Request parameters for createContactNote operation in ContactsApi. * @export * @interface ContactsApiCreateContactNoteRequest */ export interface ContactsApiCreateContactNoteRequest { /** * * @type {string} * @memberof ContactsApiCreateContactNote */ readonly id: string; /** * * @type {CreateNoteDto} * @memberof ContactsApiCreateContactNote */ readonly createNote: CreateNoteDto; /** * * @type {string} * @memberof ContactsApiCreateContactNote */ readonly translate?: string; } /** * Request parameters for deleteContact operation in ContactsApi. * @export * @interface ContactsApiDeleteContactRequest */ export interface ContactsApiDeleteContactRequest { /** * * @type {string} * @memberof ContactsApiDeleteContact */ readonly id: string; /** * * @type {string} * @memberof ContactsApiDeleteContact */ readonly translate?: string; } /** * Request parameters for deleteManyContacts operation in ContactsApi. * @export * @interface ContactsApiDeleteManyContactsRequest */ export interface ContactsApiDeleteManyContactsRequest { /** * * @type {Array} * @memberof ContactsApiDeleteManyContacts */ readonly ids: Array; /** * * @type {string} * @memberof ContactsApiDeleteManyContacts */ readonly translate?: string; } /** * Request parameters for getContact operation in ContactsApi. * @export * @interface ContactsApiGetContactRequest */ export interface ContactsApiGetContactRequest { /** * * @type {string} * @memberof ContactsApiGetContact */ readonly id: string; /** * * @type {string} * @memberof ContactsApiGetContact */ readonly translate?: string; } /** * Request parameters for getContactNotes operation in ContactsApi. * @export * @interface ContactsApiGetContactNotesRequest */ export interface ContactsApiGetContactNotesRequest { /** * * @type {string} * @memberof ContactsApiGetContactNotes */ readonly id: string; /** * * @type {string} * @memberof ContactsApiGetContactNotes */ readonly translate?: string; } /** * Request parameters for getContacts operation in ContactsApi. * @export * @interface ContactsApiGetContactsRequest */ export interface ContactsApiGetContactsRequest { /** * * @type {number} * @memberof ContactsApiGetContacts */ readonly page?: number; /** * * @type {number} * @memberof ContactsApiGetContacts */ readonly size?: number; /** * * @type {string} * @memberof ContactsApiGetContacts */ readonly translate?: string; /** * * @type {boolean} * @memberof ContactsApiGetContacts */ readonly withReplacements?: boolean; /** * * @type {string} * @memberof ContactsApiGetContacts */ readonly sort?: string; /** * * @type {string} * @memberof ContactsApiGetContacts */ readonly search?: string; } /** * Request parameters for getContactsCount operation in ContactsApi. * @export * @interface ContactsApiGetContactsCountRequest */ export interface ContactsApiGetContactsCountRequest { /** * * @type {number} * @memberof ContactsApiGetContactsCount */ readonly page?: number; /** * * @type {number} * @memberof ContactsApiGetContactsCount */ readonly size?: number; /** * * @type {string} * @memberof ContactsApiGetContactsCount */ readonly sort?: string; /** * * @type {string} * @memberof ContactsApiGetContactsCount */ readonly search?: string; /** * * @type {boolean} * @memberof ContactsApiGetContactsCount */ readonly withReplacements?: boolean; /** * * @type {string} * @memberof ContactsApiGetContactsCount */ readonly translate?: string; } /** * Request parameters for getPublicContacts operation in ContactsApi. * @export * @interface ContactsApiGetPublicContactsRequest */ export interface ContactsApiGetPublicContactsRequest { /** * * @type {number} * @memberof ContactsApiGetPublicContacts */ readonly page?: number; /** * * @type {number} * @memberof ContactsApiGetPublicContacts */ readonly size?: number; /** * * @type {string} * @memberof ContactsApiGetPublicContacts */ readonly sort?: string; /** * * @type {string} * @memberof ContactsApiGetPublicContacts */ readonly search?: string; /** * * @type {boolean} * @memberof ContactsApiGetPublicContacts */ readonly withReplacements?: boolean; /** * * @type {string} * @memberof ContactsApiGetPublicContacts */ readonly translate?: string; } /** * Request parameters for patchContact operation in ContactsApi. * @export * @interface ContactsApiPatchContactRequest */ export interface ContactsApiPatchContactRequest { /** * * @type {string} * @memberof ContactsApiPatchContact */ readonly id: string; /** * * @type {any} * @memberof ContactsApiPatchContact */ readonly contact: any; /** * * @type {string} * @memberof ContactsApiPatchContact */ readonly translate?: string; } /** * Request parameters for performContactSearch operation in ContactsApi. * @export * @interface ContactsApiPerformContactSearchRequest */ export interface ContactsApiPerformContactSearchRequest { /** * * @type {SearchRequestDto} * @memberof ContactsApiPerformContactSearch */ readonly searchRequest: SearchRequestDto; /** * * @type {string} * @memberof ContactsApiPerformContactSearch */ readonly translate?: string; } /** * Request parameters for putContact operation in ContactsApi. * @export * @interface ContactsApiPutContactRequest */ export interface ContactsApiPutContactRequest { /** * * @type {string} * @memberof ContactsApiPutContact */ readonly id: string; /** * * @type {ContactDto} * @memberof ContactsApiPutContact */ readonly contact: ContactDto; /** * * @type {string} * @memberof ContactsApiPutContact */ readonly translate?: string; } /** * Request parameters for syncMicrosoftContacts operation in ContactsApi. * @export * @interface ContactsApiSyncMicrosoftContactsRequest */ export interface ContactsApiSyncMicrosoftContactsRequest { /** * * @type {string} * @memberof ContactsApiSyncMicrosoftContacts */ readonly translate?: string; } /** * ContactsApi - object-oriented interface * @export * @class ContactsApi * @extends {BaseAPI} */ export declare class ContactsApi extends BaseAPI { /** * This is a very performant method for checking if a Contact exists. * @summary Check if Contact exists * @param {ContactsApiContactExistsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactsApi */ contactExists(requestParameters: ContactsApiContactExistsRequest, options?: any): Promise>; /** * * @param {ContactsApiCreateContactRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactsApi */ createContact(requestParameters: ContactsApiCreateContactRequest, options?: any): Promise>; /** * Creates a note with the target set to the id of the contact. * @param {ContactsApiCreateContactNoteRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactsApi */ createContactNote(requestParameters: ContactsApiCreateContactNoteRequest, options?: any): Promise>; /** * * @param {ContactsApiDeleteContactRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactsApi */ deleteContact(requestParameters: ContactsApiDeleteContactRequest, options?: any): Promise>; /** * * @param {ContactsApiDeleteManyContactsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactsApi */ deleteManyContacts(requestParameters: ContactsApiDeleteManyContactsRequest, options?: any): Promise>; /** * * @param {ContactsApiGetContactRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactsApi */ getContact(requestParameters: ContactsApiGetContactRequest, options?: any): Promise>; /** * Gets all personal and public notes for a contact * @param {ContactsApiGetContactNotesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactsApi */ getContactNotes(requestParameters: ContactsApiGetContactNotesRequest, options?: any): Promise>; /** * * @param {ContactsApiGetContactsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactsApi */ getContacts(requestParameters?: ContactsApiGetContactsRequest, options?: any): Promise>; /** * * @param {ContactsApiGetContactsCountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactsApi */ getContactsCount(requestParameters?: ContactsApiGetContactsCountRequest, options?: any): Promise>; /** * Returns all contacts that have publicAccess set to true * @summary Public Contacts * @param {ContactsApiGetPublicContactsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactsApi */ getPublicContacts(requestParameters?: ContactsApiGetPublicContactsRequest, options?: any): Promise>; /** * * @param {ContactsApiPatchContactRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactsApi */ patchContact(requestParameters: ContactsApiPatchContactRequest, options?: any): Promise>; /** * * @param {ContactsApiPerformContactSearchRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactsApi */ performContactSearch(requestParameters: ContactsApiPerformContactSearchRequest, options?: any): Promise>; /** * * @param {ContactsApiPutContactRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactsApi */ putContact(requestParameters: ContactsApiPutContactRequest, options?: any): Promise>; /** * * @param {ContactsApiSyncMicrosoftContactsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactsApi */ syncMicrosoftContacts(requestParameters?: ContactsApiSyncMicrosoftContactsRequest, options?: any): Promise>; }