/** * 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 { NEWUpdateOfTheTimezoneLink } from '../api'; import { NEWUpdateOfTheTimezoneLink1 } from '../api'; import { WebitelContactsInputTimezone } from '../api'; import { WebitelContactsTimezone } from '../api'; import { WebitelContactsTimezoneList } from '../api'; /** * TimezonesApi - axios parameter creator * @export */ export declare const TimezonesApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Remove the Contact\'s timezone association. * @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} */ deleteTimezone: (contactId: string, etag: string, fields?: Array, options?: any) => Promise; /** * * @summary Remove the Contact\'s timezone(s). * @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} */ deleteTimezones: (contactId: string, etag: Array, fields?: Array, options?: any) => Promise; /** * * @summary List of the Contact\'s timezone(s). * @param {string} contactId 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: location name; `?` - 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 as a result. * @param {Array} [id] Record(s) with unique ID only. * @param {boolean} [primary] Primary timezone only. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTimezones: (contactId: string, page?: number, size?: number, q?: string, sort?: Array, fields?: Array, id?: Array, primary?: boolean, options?: any) => Promise; /** * * @summary Locate the Contact\'s timezone association. * @param {string} contactId Contact source ID. * @param {string} etag Unique timezone link IDentifier. Accept: `etag` (obsolete+) or `id`. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateTimezone: (contactId: string, etag: string, fields?: Array, options?: any) => Promise; /** * * @summary Associate more timezone(s) with the Contact. * @param {string} contactId Link contact ID. * @param {Array} input Array of the unique User(s) to associate with the Contact. Any duplicate of an already linked user{id} will result in an error. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ mergeTimezones: (contactId: string, input: Array, fields?: Array, options?: any) => Promise; /** * * @summary Resets all timezones of the contact according to the input dataset. * @param {string} contactId Link contact ID. * @param {Array} input Final set of timezone(s) to be linked with the contact. Timezone(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} */ resetTimezones: (contactId: string, input: Array, fields?: Array, options?: any) => Promise; /** * * @summary Update the Contact\'s timezone details. * @param {string} contactId Link contact ID. * @param {string} etag Unique ID of the latest version of an existing resource. * @param {NEWUpdateOfTheTimezoneLink} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateTimezone: (contactId: string, etag: string, input: NEWUpdateOfTheTimezoneLink, fields?: Array, options?: any) => Promise; /** * * @summary Update the Contact\'s timezone details. * @param {string} contactId Link contact ID. * @param {string} etag Unique ID of the latest version of an existing resource. * @param {NEWUpdateOfTheTimezoneLink1} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateTimezone2: (contactId: string, etag: string, input: NEWUpdateOfTheTimezoneLink1, fields?: Array, options?: any) => Promise; }; /** * TimezonesApi - functional programming interface * @export */ export declare const TimezonesApiFp: (configuration?: Configuration) => { /** * * @summary Remove the Contact\'s timezone association. * @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} */ deleteTimezone(contactId: string, etag: string, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Remove the Contact\'s timezone(s). * @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} */ deleteTimezones(contactId: string, etag: Array, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary List of the Contact\'s timezone(s). * @param {string} contactId 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: location name; `?` - 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 as a result. * @param {Array} [id] Record(s) with unique ID only. * @param {boolean} [primary] Primary timezone only. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTimezones(contactId: string, page?: number, size?: number, q?: string, sort?: Array, fields?: Array, id?: Array, primary?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Locate the Contact\'s timezone association. * @param {string} contactId Contact source ID. * @param {string} etag Unique timezone link IDentifier. Accept: `etag` (obsolete+) or `id`. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateTimezone(contactId: string, etag: string, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Associate more timezone(s) with the Contact. * @param {string} contactId Link contact ID. * @param {Array} input Array of the unique User(s) to associate with the Contact. Any duplicate of an already linked user{id} will result in an error. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ mergeTimezones(contactId: string, input: Array, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Resets all timezones of the contact according to the input dataset. * @param {string} contactId Link contact ID. * @param {Array} input Final set of timezone(s) to be linked with the contact. Timezone(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} */ resetTimezones(contactId: string, input: Array, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update the Contact\'s timezone details. * @param {string} contactId Link contact ID. * @param {string} etag Unique ID of the latest version of an existing resource. * @param {NEWUpdateOfTheTimezoneLink} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateTimezone(contactId: string, etag: string, input: NEWUpdateOfTheTimezoneLink, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update the Contact\'s timezone details. * @param {string} contactId Link contact ID. * @param {string} etag Unique ID of the latest version of an existing resource. * @param {NEWUpdateOfTheTimezoneLink1} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateTimezone2(contactId: string, etag: string, input: NEWUpdateOfTheTimezoneLink1, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * TimezonesApi - factory interface * @export */ export declare const TimezonesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Remove the Contact\'s timezone association. * @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} */ deleteTimezone(contactId: string, etag: string, fields?: Array, options?: any): AxiosPromise; /** * * @summary Remove the Contact\'s timezone(s). * @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} */ deleteTimezones(contactId: string, etag: Array, fields?: Array, options?: any): AxiosPromise; /** * * @summary List of the Contact\'s timezone(s). * @param {string} contactId 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: location name; `?` - 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 as a result. * @param {Array} [id] Record(s) with unique ID only. * @param {boolean} [primary] Primary timezone only. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTimezones(contactId: string, page?: number, size?: number, q?: string, sort?: Array, fields?: Array, id?: Array, primary?: boolean, options?: any): AxiosPromise; /** * * @summary Locate the Contact\'s timezone association. * @param {string} contactId Contact source ID. * @param {string} etag Unique timezone link IDentifier. Accept: `etag` (obsolete+) or `id`. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateTimezone(contactId: string, etag: string, fields?: Array, options?: any): AxiosPromise; /** * * @summary Associate more timezone(s) with the Contact. * @param {string} contactId Link contact ID. * @param {Array} input Array of the unique User(s) to associate with the Contact. Any duplicate of an already linked user{id} will result in an error. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ mergeTimezones(contactId: string, input: Array, fields?: Array, options?: any): AxiosPromise; /** * * @summary Resets all timezones of the contact according to the input dataset. * @param {string} contactId Link contact ID. * @param {Array} input Final set of timezone(s) to be linked with the contact. Timezone(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} */ resetTimezones(contactId: string, input: Array, fields?: Array, options?: any): AxiosPromise; /** * * @summary Update the Contact\'s timezone details. * @param {string} contactId Link contact ID. * @param {string} etag Unique ID of the latest version of an existing resource. * @param {NEWUpdateOfTheTimezoneLink} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateTimezone(contactId: string, etag: string, input: NEWUpdateOfTheTimezoneLink, fields?: Array, options?: any): AxiosPromise; /** * * @summary Update the Contact\'s timezone details. * @param {string} contactId Link contact ID. * @param {string} etag Unique ID of the latest version of an existing resource. * @param {NEWUpdateOfTheTimezoneLink1} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateTimezone2(contactId: string, etag: string, input: NEWUpdateOfTheTimezoneLink1, fields?: Array, options?: any): AxiosPromise; }; /** * TimezonesApi - object-oriented interface * @export * @class TimezonesApi * @extends {BaseAPI} */ export declare class TimezonesApi extends BaseAPI { /** * * @summary Remove the Contact\'s timezone association. * @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 TimezonesApi */ deleteTimezone(contactId: string, etag: string, fields?: Array, options?: any): Promise>; /** * * @summary Remove the Contact\'s timezone(s). * @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 TimezonesApi */ deleteTimezones(contactId: string, etag: Array, fields?: Array, options?: any): Promise>; /** * * @summary List of the Contact\'s timezone(s). * @param {string} contactId 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: location name; `?` - 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 as a result. * @param {Array} [id] Record(s) with unique ID only. * @param {boolean} [primary] Primary timezone only. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TimezonesApi */ listTimezones(contactId: string, page?: number, size?: number, q?: string, sort?: Array, fields?: Array, id?: Array, primary?: boolean, options?: any): Promise>; /** * * @summary Locate the Contact\'s timezone association. * @param {string} contactId Contact source ID. * @param {string} etag Unique timezone 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 TimezonesApi */ locateTimezone(contactId: string, etag: string, fields?: Array, options?: any): Promise>; /** * * @summary Associate more timezone(s) with the Contact. * @param {string} contactId Link contact ID. * @param {Array} input Array of the unique User(s) to associate with the Contact. Any duplicate of an already linked user{id} will result in an error. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TimezonesApi */ mergeTimezones(contactId: string, input: Array, fields?: Array, options?: any): Promise>; /** * * @summary Resets all timezones of the contact according to the input dataset. * @param {string} contactId Link contact ID. * @param {Array} input Final set of timezone(s) to be linked with the contact. Timezone(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 TimezonesApi */ resetTimezones(contactId: string, input: Array, fields?: Array, options?: any): Promise>; /** * * @summary Update the Contact\'s timezone details. * @param {string} contactId Link contact ID. * @param {string} etag Unique ID of the latest version of an existing resource. * @param {NEWUpdateOfTheTimezoneLink} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TimezonesApi */ updateTimezone(contactId: string, etag: string, input: NEWUpdateOfTheTimezoneLink, fields?: Array, options?: any): Promise>; /** * * @summary Update the Contact\'s timezone details. * @param {string} contactId Link contact ID. * @param {string} etag Unique ID of the latest version of an existing resource. * @param {NEWUpdateOfTheTimezoneLink1} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TimezonesApi */ updateTimezone2(contactId: string, etag: string, input: NEWUpdateOfTheTimezoneLink1, fields?: Array, options?: any): Promise>; } //# sourceMappingURL=timezones-api.d.ts.map