/** * 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 { WebitelContactsAddContactsToGroupRequest } from '../api'; import { WebitelContactsContactList } from '../api'; import { WebitelContactsCreateGroupRequest } from '../api'; import { WebitelContactsGroup } from '../api'; import { WebitelContactsGroupList } from '../api'; import { WebitelContactsInputGroup } from '../api'; import { WebitelContactsLocateGroupResponse } from '../api'; /** * GroupsApi - axios parameter creator * @export */ export declare const GroupsApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Attach contacts to multiple groups * @param {WebitelContactsAddContactsToGroupRequest} body Request message for adding contacts to a group. * @param {*} [options] Override http request option. * @throws {RequiredError} */ addContactsToGroups: (body: WebitelContactsAddContactsToGroupRequest, options?: any) => Promise; /** * * @summary Create a new group * @param {WebitelContactsCreateGroupRequest} body Request message for creating a new group. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createGroup: (body: WebitelContactsCreateGroupRequest, options?: any) => Promise; /** * * @summary Delete a group * @param {string} id The unique ID of the group to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteGroup: (id: string, options?: any) => Promise; /** * * @summary Retrieve a list of groups or search 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 {'GROUP_TYPE_UNSPECIFIED' | 'STATIC' | 'DYNAMIC'} [type] Filter by group type. - GROUP_TYPE_UNSPECIFIED: Default value - STATIC: Static group - DYNAMIC: Dynamic group * @param {boolean} [enabled] Filter by only enabled group * @param {*} [options] Override http request option. * @throws {RequiredError} */ listGroups: (page?: number, size?: number, fields?: Array, sort?: Array, id?: Array, q?: string, name?: string, type?: "GROUP_TYPE_UNSPECIFIED" | "STATIC" | "DYNAMIC", enabled?: boolean, options?: any) => Promise; /** * * @summary Locate a group by ID * @param {string} id The unique ID of the group to locate. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateGroup: (id: string, fields?: Array, options?: any) => Promise; /** * * @summary Remove contacts from a group * @param {string} groupId The unique ID of the group. * @param {Array} [contactIds] List of contact IDs to remove from the group. * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeContactsFromGroup: (groupId: string, contactIds?: Array, options?: any) => Promise; /** * * @summary Update an existing group * @param {string} id The unique ID of the group to update. * @param {WebitelContactsInputGroup} input * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateGroup: (id: string, input: WebitelContactsInputGroup, options?: any) => Promise; /** * * @summary Update an existing group * @param {string} id The unique ID of the group to update. * @param {WebitelContactsInputGroup} input * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateGroup2: (id: string, input: WebitelContactsInputGroup, options?: any) => Promise; }; /** * GroupsApi - functional programming interface * @export */ export declare const GroupsApiFp: (configuration?: Configuration) => { /** * * @summary Attach contacts to multiple groups * @param {WebitelContactsAddContactsToGroupRequest} body Request message for adding contacts to a group. * @param {*} [options] Override http request option. * @throws {RequiredError} */ addContactsToGroups(body: WebitelContactsAddContactsToGroupRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Create a new group * @param {WebitelContactsCreateGroupRequest} body Request message for creating a new group. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createGroup(body: WebitelContactsCreateGroupRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Delete a group * @param {string} id The unique ID of the group to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteGroup(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Retrieve a list of groups or search 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 {'GROUP_TYPE_UNSPECIFIED' | 'STATIC' | 'DYNAMIC'} [type] Filter by group type. - GROUP_TYPE_UNSPECIFIED: Default value - STATIC: Static group - DYNAMIC: Dynamic group * @param {boolean} [enabled] Filter by only enabled group * @param {*} [options] Override http request option. * @throws {RequiredError} */ listGroups(page?: number, size?: number, fields?: Array, sort?: Array, id?: Array, q?: string, name?: string, type?: "GROUP_TYPE_UNSPECIFIED" | "STATIC" | "DYNAMIC", enabled?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Locate a group by ID * @param {string} id The unique ID of the group to locate. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateGroup(id: string, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Remove contacts from a group * @param {string} groupId The unique ID of the group. * @param {Array} [contactIds] List of contact IDs to remove from the group. * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeContactsFromGroup(groupId: string, contactIds?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update an existing group * @param {string} id The unique ID of the group to update. * @param {WebitelContactsInputGroup} input * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateGroup(id: string, input: WebitelContactsInputGroup, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update an existing group * @param {string} id The unique ID of the group to update. * @param {WebitelContactsInputGroup} input * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateGroup2(id: string, input: WebitelContactsInputGroup, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * GroupsApi - factory interface * @export */ export declare const GroupsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Attach contacts to multiple groups * @param {WebitelContactsAddContactsToGroupRequest} body Request message for adding contacts to a group. * @param {*} [options] Override http request option. * @throws {RequiredError} */ addContactsToGroups(body: WebitelContactsAddContactsToGroupRequest, options?: any): AxiosPromise; /** * * @summary Create a new group * @param {WebitelContactsCreateGroupRequest} body Request message for creating a new group. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createGroup(body: WebitelContactsCreateGroupRequest, options?: any): AxiosPromise; /** * * @summary Delete a group * @param {string} id The unique ID of the group to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteGroup(id: string, options?: any): AxiosPromise; /** * * @summary Retrieve a list of groups or search 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 {'GROUP_TYPE_UNSPECIFIED' | 'STATIC' | 'DYNAMIC'} [type] Filter by group type. - GROUP_TYPE_UNSPECIFIED: Default value - STATIC: Static group - DYNAMIC: Dynamic group * @param {boolean} [enabled] Filter by only enabled group * @param {*} [options] Override http request option. * @throws {RequiredError} */ listGroups(page?: number, size?: number, fields?: Array, sort?: Array, id?: Array, q?: string, name?: string, type?: "GROUP_TYPE_UNSPECIFIED" | "STATIC" | "DYNAMIC", enabled?: boolean, options?: any): AxiosPromise; /** * * @summary Locate a group by ID * @param {string} id The unique ID of the group to locate. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateGroup(id: string, fields?: Array, options?: any): AxiosPromise; /** * * @summary Remove contacts from a group * @param {string} groupId The unique ID of the group. * @param {Array} [contactIds] List of contact IDs to remove from the group. * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeContactsFromGroup(groupId: string, contactIds?: Array, options?: any): AxiosPromise; /** * * @summary Update an existing group * @param {string} id The unique ID of the group to update. * @param {WebitelContactsInputGroup} input * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateGroup(id: string, input: WebitelContactsInputGroup, options?: any): AxiosPromise; /** * * @summary Update an existing group * @param {string} id The unique ID of the group to update. * @param {WebitelContactsInputGroup} input * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateGroup2(id: string, input: WebitelContactsInputGroup, options?: any): AxiosPromise; }; /** * GroupsApi - object-oriented interface * @export * @class GroupsApi * @extends {BaseAPI} */ export declare class GroupsApi extends BaseAPI { /** * * @summary Attach contacts to multiple groups * @param {WebitelContactsAddContactsToGroupRequest} body Request message for adding contacts to a group. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupsApi */ addContactsToGroups(body: WebitelContactsAddContactsToGroupRequest, options?: any): Promise>; /** * * @summary Create a new group * @param {WebitelContactsCreateGroupRequest} body Request message for creating a new group. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupsApi */ createGroup(body: WebitelContactsCreateGroupRequest, options?: any): Promise>; /** * * @summary Delete a group * @param {string} id The unique ID of the group to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupsApi */ deleteGroup(id: string, options?: any): Promise>; /** * * @summary Retrieve a list of groups or search 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 {'GROUP_TYPE_UNSPECIFIED' | 'STATIC' | 'DYNAMIC'} [type] Filter by group type. - GROUP_TYPE_UNSPECIFIED: Default value - STATIC: Static group - DYNAMIC: Dynamic group * @param {boolean} [enabled] Filter by only enabled group * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupsApi */ listGroups(page?: number, size?: number, fields?: Array, sort?: Array, id?: Array, q?: string, name?: string, type?: 'GROUP_TYPE_UNSPECIFIED' | 'STATIC' | 'DYNAMIC', enabled?: boolean, options?: any): Promise>; /** * * @summary Locate a group by ID * @param {string} id The unique ID of the group to locate. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupsApi */ locateGroup(id: string, fields?: Array, options?: any): Promise>; /** * * @summary Remove contacts from a group * @param {string} groupId The unique ID of the group. * @param {Array} [contactIds] List of contact IDs to remove from the group. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupsApi */ removeContactsFromGroup(groupId: string, contactIds?: Array, options?: any): Promise>; /** * * @summary Update an existing group * @param {string} id The unique ID of the group to update. * @param {WebitelContactsInputGroup} input * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupsApi */ updateGroup(id: string, input: WebitelContactsInputGroup, options?: any): Promise>; /** * * @summary Update an existing group * @param {string} id The unique ID of the group to update. * @param {WebitelContactsInputGroup} input * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupsApi */ updateGroup2(id: string, input: WebitelContactsInputGroup, options?: any): Promise>; } //# sourceMappingURL=groups-api.d.ts.map