/** * Webitel API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 24.04.0 * Contact: support@webitel.com * * 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 { NEWUpdateOfTheEmailAddressLink } from '../api'; import { NEWUpdateOfTheEmailAddressLink1 } from '../api'; import { WebitelContactsEmailAddress } from '../api'; import { WebitelContactsEmailList } from '../api'; import { WebitelContactsInputEmailAddress } from '../api'; /** * EmailsApi - axios parameter creator * @export */ export declare const EmailsApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Remove the contact\'s email address link * @param {string} contactId Contact ID associated with. * @param {string} etag Unique ID to remove. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEmail: (contactId: string, etag: string, fields?: Array, options?: any) => Promise; /** * * @summary Remove email address(es) of the contact. * @param {string} contactId Contact ID associated with. * @param {Array} etag Set of unique ID(s) to remove. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEmails: (contactId: string, etag: Array, fields?: Array, options?: any) => Promise; /** * * @summary Locates email address(es) of the contact. * @param {string} contactId The Contact ID linked with. * @param {number} [page] Page number of result dataset records. offset = (page*size) * @param {number} [size] Size count of records on result page. limit = (size++) * @param {string} [q] Search term: email address. `?` - matches any one character `*` - matches 0 or more characters * @param {Array} [sort] Sort the result according to fields. * @param {Array} [fields] Fields to be retrieved into result. * @param {Array} [id] Link(s) with unique ID only. * @param {boolean} [primary] Primary email address only. * @param {boolean} [verified] Verified email addresses only. * @param {string} [typeId] Reference Object unique ID. * @param {string} [typeType] Reference Object well-known type. * @param {string} [typeName] Reference Object display name. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listEmails: (contactId: string, page?: number, size?: number, q?: string, sort?: Array, fields?: Array, id?: Array, primary?: boolean, verified?: boolean, typeId?: string, typeType?: string, typeName?: string, options?: any) => Promise; /** * * @summary Locate the email address link. * @param {string} contactId Contact source ID. * @param {string} etag Unique mail address link IDentifier. Accept: `etag` (obsolete+) or `id`. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateEmail: (contactId: string, etag: string, fields?: Array, options?: any) => Promise; /** * * @summary Update or append email address(es) of the contact. * @param {string} contactId Link contact ID. * @param {Array} input Fixed set of email address(es) to be linked with the contact. Email address(es) that conflicts(email) with already linked will be updated. * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ mergeEmails: (contactId: string, input: Array, fields?: Array, options?: any) => Promise; /** * * @summary Resets all emails of the contact according to the input dataset. * @param {string} contactId Link contact ID. * @param {Array} input Final set of email address(es) to be linked with the contact. Email address(es) that are already linked with the contact but not given in here will be removed. * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetEmails: (contactId: string, input: Array, fields?: Array, options?: any) => Promise; /** * * @summary Update the contact\'s email address link details * @param {string} contactId Link contact ID. * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWUpdateOfTheEmailAddressLink} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateEmail: (contactId: string, etag: string, input: NEWUpdateOfTheEmailAddressLink, fields?: Array, options?: any) => Promise; /** * * @summary Update the contact\'s email address link details * @param {string} contactId Link contact ID. * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWUpdateOfTheEmailAddressLink1} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateEmail2: (contactId: string, etag: string, input: NEWUpdateOfTheEmailAddressLink1, fields?: Array, options?: any) => Promise; }; /** * EmailsApi - functional programming interface * @export */ export declare const EmailsApiFp: (configuration?: Configuration) => { /** * * @summary Remove the contact\'s email address link * @param {string} contactId Contact ID associated with. * @param {string} etag Unique ID to remove. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEmail(contactId: string, etag: string, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Remove email address(es) of the contact. * @param {string} contactId Contact ID associated with. * @param {Array} etag Set of unique ID(s) to remove. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEmails(contactId: string, etag: Array, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Locates email address(es) of the contact. * @param {string} contactId The Contact ID linked with. * @param {number} [page] Page number of result dataset records. offset = (page*size) * @param {number} [size] Size count of records on result page. limit = (size++) * @param {string} [q] Search term: email address. `?` - matches any one character `*` - matches 0 or more characters * @param {Array} [sort] Sort the result according to fields. * @param {Array} [fields] Fields to be retrieved into result. * @param {Array} [id] Link(s) with unique ID only. * @param {boolean} [primary] Primary email address only. * @param {boolean} [verified] Verified email addresses only. * @param {string} [typeId] Reference Object unique ID. * @param {string} [typeType] Reference Object well-known type. * @param {string} [typeName] Reference Object display name. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listEmails(contactId: string, page?: number, size?: number, q?: string, sort?: Array, fields?: Array, id?: Array, primary?: boolean, verified?: boolean, typeId?: string, typeType?: string, typeName?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Locate the email address link. * @param {string} contactId Contact source ID. * @param {string} etag Unique mail address link IDentifier. Accept: `etag` (obsolete+) or `id`. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateEmail(contactId: string, etag: string, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update or append email address(es) of the contact. * @param {string} contactId Link contact ID. * @param {Array} input Fixed set of email address(es) to be linked with the contact. Email address(es) that conflicts(email) with already linked will be updated. * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ mergeEmails(contactId: string, input: Array, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Resets all emails of the contact according to the input dataset. * @param {string} contactId Link contact ID. * @param {Array} input Final set of email address(es) to be linked with the contact. Email address(es) that are already linked with the contact but not given in here will be removed. * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetEmails(contactId: string, input: Array, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update the contact\'s email address link details * @param {string} contactId Link contact ID. * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWUpdateOfTheEmailAddressLink} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateEmail(contactId: string, etag: string, input: NEWUpdateOfTheEmailAddressLink, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update the contact\'s email address link details * @param {string} contactId Link contact ID. * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWUpdateOfTheEmailAddressLink1} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateEmail2(contactId: string, etag: string, input: NEWUpdateOfTheEmailAddressLink1, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * EmailsApi - factory interface * @export */ export declare const EmailsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Remove the contact\'s email address link * @param {string} contactId Contact ID associated with. * @param {string} etag Unique ID to remove. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEmail(contactId: string, etag: string, fields?: Array, options?: any): AxiosPromise; /** * * @summary Remove email address(es) of the contact. * @param {string} contactId Contact ID associated with. * @param {Array} etag Set of unique ID(s) to remove. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEmails(contactId: string, etag: Array, fields?: Array, options?: any): AxiosPromise; /** * * @summary Locates email address(es) of the contact. * @param {string} contactId The Contact ID linked with. * @param {number} [page] Page number of result dataset records. offset = (page*size) * @param {number} [size] Size count of records on result page. limit = (size++) * @param {string} [q] Search term: email address. `?` - matches any one character `*` - matches 0 or more characters * @param {Array} [sort] Sort the result according to fields. * @param {Array} [fields] Fields to be retrieved into result. * @param {Array} [id] Link(s) with unique ID only. * @param {boolean} [primary] Primary email address only. * @param {boolean} [verified] Verified email addresses only. * @param {string} [typeId] Reference Object unique ID. * @param {string} [typeType] Reference Object well-known type. * @param {string} [typeName] Reference Object display name. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listEmails(contactId: string, page?: number, size?: number, q?: string, sort?: Array, fields?: Array, id?: Array, primary?: boolean, verified?: boolean, typeId?: string, typeType?: string, typeName?: string, options?: any): AxiosPromise; /** * * @summary Locate the email address link. * @param {string} contactId Contact source ID. * @param {string} etag Unique mail address link IDentifier. Accept: `etag` (obsolete+) or `id`. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateEmail(contactId: string, etag: string, fields?: Array, options?: any): AxiosPromise; /** * * @summary Update or append email address(es) of the contact. * @param {string} contactId Link contact ID. * @param {Array} input Fixed set of email address(es) to be linked with the contact. Email address(es) that conflicts(email) with already linked will be updated. * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ mergeEmails(contactId: string, input: Array, fields?: Array, options?: any): AxiosPromise; /** * * @summary Resets all emails of the contact according to the input dataset. * @param {string} contactId Link contact ID. * @param {Array} input Final set of email address(es) to be linked with the contact. Email address(es) that are already linked with the contact but not given in here will be removed. * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resetEmails(contactId: string, input: Array, fields?: Array, options?: any): AxiosPromise; /** * * @summary Update the contact\'s email address link details * @param {string} contactId Link contact ID. * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWUpdateOfTheEmailAddressLink} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateEmail(contactId: string, etag: string, input: NEWUpdateOfTheEmailAddressLink, fields?: Array, options?: any): AxiosPromise; /** * * @summary Update the contact\'s email address link details * @param {string} contactId Link contact ID. * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWUpdateOfTheEmailAddressLink1} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateEmail2(contactId: string, etag: string, input: NEWUpdateOfTheEmailAddressLink1, fields?: Array, options?: any): AxiosPromise; }; /** * EmailsApi - object-oriented interface * @export * @class EmailsApi * @extends {BaseAPI} */ export declare class EmailsApi extends BaseAPI { /** * * @summary Remove the contact\'s email address link * @param {string} contactId Contact ID associated with. * @param {string} etag Unique ID to remove. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EmailsApi */ deleteEmail(contactId: string, etag: string, fields?: Array, options?: any): Promise>; /** * * @summary Remove email address(es) of the contact. * @param {string} contactId Contact ID associated with. * @param {Array} etag Set of unique ID(s) to remove. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EmailsApi */ deleteEmails(contactId: string, etag: Array, fields?: Array, options?: any): Promise>; /** * * @summary Locates email address(es) of the contact. * @param {string} contactId The Contact ID linked with. * @param {number} [page] Page number of result dataset records. offset = (page*size) * @param {number} [size] Size count of records on result page. limit = (size++) * @param {string} [q] Search term: email address. `?` - matches any one character `*` - matches 0 or more characters * @param {Array} [sort] Sort the result according to fields. * @param {Array} [fields] Fields to be retrieved into result. * @param {Array} [id] Link(s) with unique ID only. * @param {boolean} [primary] Primary email address only. * @param {boolean} [verified] Verified email addresses only. * @param {string} [typeId] Reference Object unique ID. * @param {string} [typeType] Reference Object well-known type. * @param {string} [typeName] Reference Object display name. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EmailsApi */ listEmails(contactId: string, page?: number, size?: number, q?: string, sort?: Array, fields?: Array, id?: Array, primary?: boolean, verified?: boolean, typeId?: string, typeType?: string, typeName?: string, options?: any): Promise>; /** * * @summary Locate the email address link. * @param {string} contactId Contact source ID. * @param {string} etag Unique mail address link IDentifier. Accept: `etag` (obsolete+) or `id`. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EmailsApi */ locateEmail(contactId: string, etag: string, fields?: Array, options?: any): Promise>; /** * * @summary Update or append email address(es) of the contact. * @param {string} contactId Link contact ID. * @param {Array} input Fixed set of email address(es) to be linked with the contact. Email address(es) that conflicts(email) with already linked will be updated. * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EmailsApi */ mergeEmails(contactId: string, input: Array, fields?: Array, options?: any): Promise>; /** * * @summary Resets all emails of the contact according to the input dataset. * @param {string} contactId Link contact ID. * @param {Array} input Final set of email address(es) to be linked with the contact. Email address(es) that are already linked with the contact but not given in here will be removed. * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EmailsApi */ resetEmails(contactId: string, input: Array, fields?: Array, options?: any): Promise>; /** * * @summary Update the contact\'s email address link details * @param {string} contactId Link contact ID. * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWUpdateOfTheEmailAddressLink} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EmailsApi */ updateEmail(contactId: string, etag: string, input: NEWUpdateOfTheEmailAddressLink, fields?: Array, options?: any): Promise>; /** * * @summary Update the contact\'s email address link details * @param {string} contactId Link contact ID. * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWUpdateOfTheEmailAddressLink1} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EmailsApi */ updateEmail2(contactId: string, etag: string, input: NEWUpdateOfTheEmailAddressLink1, fields?: Array, options?: any): Promise>; } //# sourceMappingURL=emails-api.d.ts.map