/** * 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 { NEWUpdateOfThePhoneNumberDetails } from '../api'; import { NEWUpdateOfThePhoneNumberDetails1 } from '../api'; import { WebitelContactsInputPhoneNumber } from '../api'; import { WebitelContactsPhoneList } from '../api'; import { WebitelContactsPhoneNumber } from '../api'; /** * PhonesApi - axios parameter creator * @export */ export declare const PhonesApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Remove the Contact\'s phone number * @param {string} contactId Link contact ID. * @param {string} etag Unique link ID to be removed. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deletePhone: (contactId: string, etag: string, fields?: Array, options?: any) => Promise; /** * * @summary Remove the Contact\'s phone number association(s) * @param {string} contactId The Contact ID associated with. * @param {Array} etag Set of linked ID(s) to be removed. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deletePhones: (contactId: string, etag: Array, fields?: Array, options?: any) => Promise; /** * * @summary Search phone number(s) * @param {string} contactId The Contact ID associated 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: phone number. `?` - 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 phone only. * @param {boolean} [verified] Verified phone 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} */ listPhones: (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 Contact\'s phone number association. * @param {string} contactId Reference Contact unique ID. * @param {string} etag * @param {Array} [fields] Fields [Q]uery to build result record. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locatePhone: (contactId: string, etag: string, fields?: Array, options?: any) => Promise; /** * * @summary Associate phone number(s) with the Contact * @param {string} contactId Link contact ID. * @param {Array} input Fixed set of phone number(s) to be linked with the Contact. Phone number(s) that conflicts 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} */ mergePhones: (contactId: string, input: Array, fields?: Array, options?: any) => Promise; /** * * @summary Reset the Contact\'s phone numbers to fit given data set. * @param {string} contactId Link contact ID. * @param {Array} input Final set of phone number(s) to be linked with the contact. Phone number(s) 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} */ resetPhones: (contactId: string, input: Array, fields?: Array, options?: any) => Promise; /** * * @summary Update the Contact\'s phone number association details * @param {string} contactId The Contact ID to be associated with. * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWUpdateOfThePhoneNumberDetails} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePhone: (contactId: string, etag: string, input: NEWUpdateOfThePhoneNumberDetails, fields?: Array, options?: any) => Promise; /** * * @summary Update the Contact\'s phone number association details * @param {string} contactId The Contact ID to be associated with. * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWUpdateOfThePhoneNumberDetails1} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePhone2: (contactId: string, etag: string, input: NEWUpdateOfThePhoneNumberDetails1, fields?: Array, options?: any) => Promise; }; /** * PhonesApi - functional programming interface * @export */ export declare const PhonesApiFp: (configuration?: Configuration) => { /** * * @summary Remove the Contact\'s phone number * @param {string} contactId Link contact ID. * @param {string} etag Unique link ID to be removed. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deletePhone(contactId: string, etag: string, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Remove the Contact\'s phone number association(s) * @param {string} contactId The Contact ID associated with. * @param {Array} etag Set of linked ID(s) to be removed. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deletePhones(contactId: string, etag: Array, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Search phone number(s) * @param {string} contactId The Contact ID associated 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: phone number. `?` - 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 phone only. * @param {boolean} [verified] Verified phone 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} */ listPhones(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 Contact\'s phone number association. * @param {string} contactId Reference Contact unique ID. * @param {string} etag * @param {Array} [fields] Fields [Q]uery to build result record. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locatePhone(contactId: string, etag: string, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Associate phone number(s) with the Contact * @param {string} contactId Link contact ID. * @param {Array} input Fixed set of phone number(s) to be linked with the Contact. Phone number(s) that conflicts 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} */ mergePhones(contactId: string, input: Array, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Reset the Contact\'s phone numbers to fit given data set. * @param {string} contactId Link contact ID. * @param {Array} input Final set of phone number(s) to be linked with the contact. Phone number(s) 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} */ resetPhones(contactId: string, input: Array, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update the Contact\'s phone number association details * @param {string} contactId The Contact ID to be associated with. * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWUpdateOfThePhoneNumberDetails} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePhone(contactId: string, etag: string, input: NEWUpdateOfThePhoneNumberDetails, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update the Contact\'s phone number association details * @param {string} contactId The Contact ID to be associated with. * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWUpdateOfThePhoneNumberDetails1} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePhone2(contactId: string, etag: string, input: NEWUpdateOfThePhoneNumberDetails1, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * PhonesApi - factory interface * @export */ export declare const PhonesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Remove the Contact\'s phone number * @param {string} contactId Link contact ID. * @param {string} etag Unique link ID to be removed. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deletePhone(contactId: string, etag: string, fields?: Array, options?: any): AxiosPromise; /** * * @summary Remove the Contact\'s phone number association(s) * @param {string} contactId The Contact ID associated with. * @param {Array} etag Set of linked ID(s) to be removed. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deletePhones(contactId: string, etag: Array, fields?: Array, options?: any): AxiosPromise; /** * * @summary Search phone number(s) * @param {string} contactId The Contact ID associated 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: phone number. `?` - 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 phone only. * @param {boolean} [verified] Verified phone 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} */ listPhones(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 Contact\'s phone number association. * @param {string} contactId Reference Contact unique ID. * @param {string} etag * @param {Array} [fields] Fields [Q]uery to build result record. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locatePhone(contactId: string, etag: string, fields?: Array, options?: any): AxiosPromise; /** * * @summary Associate phone number(s) with the Contact * @param {string} contactId Link contact ID. * @param {Array} input Fixed set of phone number(s) to be linked with the Contact. Phone number(s) that conflicts 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} */ mergePhones(contactId: string, input: Array, fields?: Array, options?: any): AxiosPromise; /** * * @summary Reset the Contact\'s phone numbers to fit given data set. * @param {string} contactId Link contact ID. * @param {Array} input Final set of phone number(s) to be linked with the contact. Phone number(s) 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} */ resetPhones(contactId: string, input: Array, fields?: Array, options?: any): AxiosPromise; /** * * @summary Update the Contact\'s phone number association details * @param {string} contactId The Contact ID to be associated with. * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWUpdateOfThePhoneNumberDetails} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePhone(contactId: string, etag: string, input: NEWUpdateOfThePhoneNumberDetails, fields?: Array, options?: any): AxiosPromise; /** * * @summary Update the Contact\'s phone number association details * @param {string} contactId The Contact ID to be associated with. * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWUpdateOfThePhoneNumberDetails1} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePhone2(contactId: string, etag: string, input: NEWUpdateOfThePhoneNumberDetails1, fields?: Array, options?: any): AxiosPromise; }; /** * PhonesApi - object-oriented interface * @export * @class PhonesApi * @extends {BaseAPI} */ export declare class PhonesApi extends BaseAPI { /** * * @summary Remove the Contact\'s phone number * @param {string} contactId Link contact ID. * @param {string} etag Unique link ID to be removed. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PhonesApi */ deletePhone(contactId: string, etag: string, fields?: Array, options?: any): Promise>; /** * * @summary Remove the Contact\'s phone number association(s) * @param {string} contactId The Contact ID associated with. * @param {Array} etag Set of linked ID(s) to be removed. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PhonesApi */ deletePhones(contactId: string, etag: Array, fields?: Array, options?: any): Promise>; /** * * @summary Search phone number(s) * @param {string} contactId The Contact ID associated 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: phone number. `?` - 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 phone only. * @param {boolean} [verified] Verified phone 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 PhonesApi */ listPhones(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 Contact\'s phone number association. * @param {string} contactId Reference Contact unique ID. * @param {string} etag * @param {Array} [fields] Fields [Q]uery to build result record. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PhonesApi */ locatePhone(contactId: string, etag: string, fields?: Array, options?: any): Promise>; /** * * @summary Associate phone number(s) with the Contact * @param {string} contactId Link contact ID. * @param {Array} input Fixed set of phone number(s) to be linked with the Contact. Phone number(s) that conflicts 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 PhonesApi */ mergePhones(contactId: string, input: Array, fields?: Array, options?: any): Promise>; /** * * @summary Reset the Contact\'s phone numbers to fit given data set. * @param {string} contactId Link contact ID. * @param {Array} input Final set of phone number(s) to be linked with the contact. Phone number(s) 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 PhonesApi */ resetPhones(contactId: string, input: Array, fields?: Array, options?: any): Promise>; /** * * @summary Update the Contact\'s phone number association details * @param {string} contactId The Contact ID to be associated with. * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWUpdateOfThePhoneNumberDetails} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PhonesApi */ updatePhone(contactId: string, etag: string, input: NEWUpdateOfThePhoneNumberDetails, fields?: Array, options?: any): Promise>; /** * * @summary Update the Contact\'s phone number association details * @param {string} contactId The Contact ID to be associated with. * @param {string} etag Unique ID of the latest version of an existing resorce. * @param {NEWUpdateOfThePhoneNumberDetails1} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PhonesApi */ updatePhone2(contactId: string, etag: string, input: NEWUpdateOfThePhoneNumberDetails1, fields?: Array, options?: any): Promise>; } //# sourceMappingURL=phones-api.d.ts.map