/** * 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 { WebitelContactsCreateDynamicGroupRequest } from '../api'; import { WebitelContactsDynamicGroup } from '../api'; import { WebitelContactsDynamicGroupInput } from '../api'; import { WebitelContactsDynamicGroupList } from '../api'; import { WebitelContactsLocateDynamicGroupResponse } from '../api'; /** * DynamicGroupsApi - axios parameter creator * @export */ export declare const DynamicGroupsApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Create a new dynamic group * @param {WebitelContactsCreateDynamicGroupRequest} body Request message for creating a new dynamic group. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDynamicGroup: (body: WebitelContactsCreateDynamicGroupRequest, options?: any) => Promise; /** * * @summary Delete a dynamic group * @param {string} id The unique ID of the dynamic group to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDynamicGroup: (id: string, options?: any) => Promise; /** * * @summary Retrieve a list of dynamic groups or search dynamic groups * @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 {Array} [fields] Fields to be retrieved as a result. * @param {Array} [sort] Sort the result according to fields. * @param {Array} [id] Filter by unique IDs. * @param {string} [q] Search term: group name; `?` - matches any one character `*` - matches 0 or more characters * @param {string} [name] Filter by group name. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDynamicGroups: (page?: number, size?: number, fields?: Array, sort?: Array, id?: Array, q?: string, name?: string, options?: any) => Promise; /** * * @summary Locate a dynamic group by ID * @param {string} id * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateDynamicGroup: (id: string, fields?: Array, options?: any) => Promise; /** * * @summary Update an existing dynamic group * @param {string} id The unique ID of the dynamic group to update. * @param {WebitelContactsDynamicGroupInput} input Input details for the dynamic group. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDynamicGroup: (id: string, input: WebitelContactsDynamicGroupInput, options?: any) => Promise; /** * * @summary Update an existing dynamic group * @param {string} id The unique ID of the dynamic group to update. * @param {WebitelContactsDynamicGroupInput} input Input details for the dynamic group. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDynamicGroup2: (id: string, input: WebitelContactsDynamicGroupInput, options?: any) => Promise; }; /** * DynamicGroupsApi - functional programming interface * @export */ export declare const DynamicGroupsApiFp: (configuration?: Configuration) => { /** * * @summary Create a new dynamic group * @param {WebitelContactsCreateDynamicGroupRequest} body Request message for creating a new dynamic group. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDynamicGroup(body: WebitelContactsCreateDynamicGroupRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Delete a dynamic group * @param {string} id The unique ID of the dynamic group to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDynamicGroup(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Retrieve a list of dynamic groups or search dynamic groups * @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 {Array} [fields] Fields to be retrieved as a result. * @param {Array} [sort] Sort the result according to fields. * @param {Array} [id] Filter by unique IDs. * @param {string} [q] Search term: group name; `?` - matches any one character `*` - matches 0 or more characters * @param {string} [name] Filter by group name. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDynamicGroups(page?: number, size?: number, fields?: Array, sort?: Array, id?: Array, q?: string, name?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Locate a dynamic group by ID * @param {string} id * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateDynamicGroup(id: string, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update an existing dynamic group * @param {string} id The unique ID of the dynamic group to update. * @param {WebitelContactsDynamicGroupInput} input Input details for the dynamic group. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDynamicGroup(id: string, input: WebitelContactsDynamicGroupInput, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update an existing dynamic group * @param {string} id The unique ID of the dynamic group to update. * @param {WebitelContactsDynamicGroupInput} input Input details for the dynamic group. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDynamicGroup2(id: string, input: WebitelContactsDynamicGroupInput, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * DynamicGroupsApi - factory interface * @export */ export declare const DynamicGroupsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Create a new dynamic group * @param {WebitelContactsCreateDynamicGroupRequest} body Request message for creating a new dynamic group. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDynamicGroup(body: WebitelContactsCreateDynamicGroupRequest, options?: any): AxiosPromise; /** * * @summary Delete a dynamic group * @param {string} id The unique ID of the dynamic group to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDynamicGroup(id: string, options?: any): AxiosPromise; /** * * @summary Retrieve a list of dynamic groups or search dynamic groups * @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 {Array} [fields] Fields to be retrieved as a result. * @param {Array} [sort] Sort the result according to fields. * @param {Array} [id] Filter by unique IDs. * @param {string} [q] Search term: group name; `?` - matches any one character `*` - matches 0 or more characters * @param {string} [name] Filter by group name. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDynamicGroups(page?: number, size?: number, fields?: Array, sort?: Array, id?: Array, q?: string, name?: string, options?: any): AxiosPromise; /** * * @summary Locate a dynamic group by ID * @param {string} id * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateDynamicGroup(id: string, fields?: Array, options?: any): AxiosPromise; /** * * @summary Update an existing dynamic group * @param {string} id The unique ID of the dynamic group to update. * @param {WebitelContactsDynamicGroupInput} input Input details for the dynamic group. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDynamicGroup(id: string, input: WebitelContactsDynamicGroupInput, options?: any): AxiosPromise; /** * * @summary Update an existing dynamic group * @param {string} id The unique ID of the dynamic group to update. * @param {WebitelContactsDynamicGroupInput} input Input details for the dynamic group. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDynamicGroup2(id: string, input: WebitelContactsDynamicGroupInput, options?: any): AxiosPromise; }; /** * DynamicGroupsApi - object-oriented interface * @export * @class DynamicGroupsApi * @extends {BaseAPI} */ export declare class DynamicGroupsApi extends BaseAPI { /** * * @summary Create a new dynamic group * @param {WebitelContactsCreateDynamicGroupRequest} body Request message for creating a new dynamic group. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DynamicGroupsApi */ createDynamicGroup(body: WebitelContactsCreateDynamicGroupRequest, options?: any): Promise>; /** * * @summary Delete a dynamic group * @param {string} id The unique ID of the dynamic group to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DynamicGroupsApi */ deleteDynamicGroup(id: string, options?: any): Promise>; /** * * @summary Retrieve a list of dynamic groups or search dynamic groups * @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 {Array} [fields] Fields to be retrieved as a result. * @param {Array} [sort] Sort the result according to fields. * @param {Array} [id] Filter by unique IDs. * @param {string} [q] Search term: group name; `?` - matches any one character `*` - matches 0 or more characters * @param {string} [name] Filter by group name. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DynamicGroupsApi */ listDynamicGroups(page?: number, size?: number, fields?: Array, sort?: Array, id?: Array, q?: string, name?: string, options?: any): Promise>; /** * * @summary Locate a dynamic group by ID * @param {string} id * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DynamicGroupsApi */ locateDynamicGroup(id: string, fields?: Array, options?: any): Promise>; /** * * @summary Update an existing dynamic group * @param {string} id The unique ID of the dynamic group to update. * @param {WebitelContactsDynamicGroupInput} input Input details for the dynamic group. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DynamicGroupsApi */ updateDynamicGroup(id: string, input: WebitelContactsDynamicGroupInput, options?: any): Promise>; /** * * @summary Update an existing dynamic group * @param {string} id The unique ID of the dynamic group to update. * @param {WebitelContactsDynamicGroupInput} input Input details for the dynamic group. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DynamicGroupsApi */ updateDynamicGroup2(id: string, input: WebitelContactsDynamicGroupInput, options?: any): Promise>; } //# sourceMappingURL=dynamic-groups-api.d.ts.map