/** * 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 { WebitelCasesInputSource } from '../api'; import { WebitelCasesLocateSourceResponse } from '../api'; import { WebitelCasesSource } from '../api'; import { WebitelCasesSourceList } from '../api'; /** * SourcesApi - axios parameter creator * @export */ export declare const SourcesApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Create a new source * @param {WebitelCasesInputSource} input * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSource: (input: WebitelCasesInputSource, fields?: Array, options?: any) => Promise; /** * * @summary Delete a source * @param {string} id The unique ID of the source to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSource: (id: string, options?: any) => Promise; /** * * @summary Retrieve a list of sources or search sources * @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 {string} [sort] Sort the result according to fields. * @param {Array} [id] Filter by unique IDs. * @param {string} [q] Search query string for filtering by name. Supports: - Wildcards (*) for substring matching - Placeholder (?) for single character substitution - Exact match for full names * @param {Array<'TYPE_UNSPECIFIED' | 'CALL' | 'CHAT' | 'SOCIAL_MEDIA' | 'EMAIL' | 'API' | 'MANUAL'>} [type] Filter by source type. - TYPE_UNSPECIFIED: Unspecified source type. - CALL: Phone call source type. - CHAT: Chat source type. - SOCIAL_MEDIA: Social media source type. - EMAIL: Email source type. - API: API source type. - MANUAL: Manual source type. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSources: (page?: number, size?: number, fields?: Array, sort?: string, id?: Array, q?: string, type?: Array<"TYPE_UNSPECIFIED" | "CALL" | "CHAT" | "SOCIAL_MEDIA" | "EMAIL" | "API" | "MANUAL">, options?: any) => Promise; /** * * @summary Locate a source by ID * @param {string} id The unique ID of the source to locate. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateSource: (id: string, fields?: Array, options?: any) => Promise; /** * * @summary Update an existing source * @param {string} id * @param {WebitelCasesInputSource} input * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSource: (id: string, input: WebitelCasesInputSource, fields?: Array, options?: any) => Promise; /** * * @summary Update an existing source * @param {string} id * @param {WebitelCasesInputSource} input * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSource2: (id: string, input: WebitelCasesInputSource, fields?: Array, options?: any) => Promise; }; /** * SourcesApi - functional programming interface * @export */ export declare const SourcesApiFp: (configuration?: Configuration) => { /** * * @summary Create a new source * @param {WebitelCasesInputSource} input * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSource(input: WebitelCasesInputSource, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Delete a source * @param {string} id The unique ID of the source to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSource(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Retrieve a list of sources or search sources * @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 {string} [sort] Sort the result according to fields. * @param {Array} [id] Filter by unique IDs. * @param {string} [q] Search query string for filtering by name. Supports: - Wildcards (*) for substring matching - Placeholder (?) for single character substitution - Exact match for full names * @param {Array<'TYPE_UNSPECIFIED' | 'CALL' | 'CHAT' | 'SOCIAL_MEDIA' | 'EMAIL' | 'API' | 'MANUAL'>} [type] Filter by source type. - TYPE_UNSPECIFIED: Unspecified source type. - CALL: Phone call source type. - CHAT: Chat source type. - SOCIAL_MEDIA: Social media source type. - EMAIL: Email source type. - API: API source type. - MANUAL: Manual source type. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSources(page?: number, size?: number, fields?: Array, sort?: string, id?: Array, q?: string, type?: Array<"TYPE_UNSPECIFIED" | "CALL" | "CHAT" | "SOCIAL_MEDIA" | "EMAIL" | "API" | "MANUAL">, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Locate a source by ID * @param {string} id The unique ID of the source to locate. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateSource(id: string, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update an existing source * @param {string} id * @param {WebitelCasesInputSource} input * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSource(id: string, input: WebitelCasesInputSource, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update an existing source * @param {string} id * @param {WebitelCasesInputSource} input * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSource2(id: string, input: WebitelCasesInputSource, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SourcesApi - factory interface * @export */ export declare const SourcesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Create a new source * @param {WebitelCasesInputSource} input * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSource(input: WebitelCasesInputSource, fields?: Array, options?: any): AxiosPromise; /** * * @summary Delete a source * @param {string} id The unique ID of the source to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSource(id: string, options?: any): AxiosPromise; /** * * @summary Retrieve a list of sources or search sources * @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 {string} [sort] Sort the result according to fields. * @param {Array} [id] Filter by unique IDs. * @param {string} [q] Search query string for filtering by name. Supports: - Wildcards (*) for substring matching - Placeholder (?) for single character substitution - Exact match for full names * @param {Array<'TYPE_UNSPECIFIED' | 'CALL' | 'CHAT' | 'SOCIAL_MEDIA' | 'EMAIL' | 'API' | 'MANUAL'>} [type] Filter by source type. - TYPE_UNSPECIFIED: Unspecified source type. - CALL: Phone call source type. - CHAT: Chat source type. - SOCIAL_MEDIA: Social media source type. - EMAIL: Email source type. - API: API source type. - MANUAL: Manual source type. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSources(page?: number, size?: number, fields?: Array, sort?: string, id?: Array, q?: string, type?: Array<"TYPE_UNSPECIFIED" | "CALL" | "CHAT" | "SOCIAL_MEDIA" | "EMAIL" | "API" | "MANUAL">, options?: any): AxiosPromise; /** * * @summary Locate a source by ID * @param {string} id The unique ID of the source to locate. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateSource(id: string, fields?: Array, options?: any): AxiosPromise; /** * * @summary Update an existing source * @param {string} id * @param {WebitelCasesInputSource} input * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSource(id: string, input: WebitelCasesInputSource, fields?: Array, options?: any): AxiosPromise; /** * * @summary Update an existing source * @param {string} id * @param {WebitelCasesInputSource} input * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSource2(id: string, input: WebitelCasesInputSource, fields?: Array, options?: any): AxiosPromise; }; /** * SourcesApi - object-oriented interface * @export * @class SourcesApi * @extends {BaseAPI} */ export declare class SourcesApi extends BaseAPI { /** * * @summary Create a new source * @param {WebitelCasesInputSource} input * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ createSource(input: WebitelCasesInputSource, fields?: Array, options?: any): Promise>; /** * * @summary Delete a source * @param {string} id The unique ID of the source to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ deleteSource(id: string, options?: any): Promise>; /** * * @summary Retrieve a list of sources or search sources * @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 {string} [sort] Sort the result according to fields. * @param {Array} [id] Filter by unique IDs. * @param {string} [q] Search query string for filtering by name. Supports: - Wildcards (*) for substring matching - Placeholder (?) for single character substitution - Exact match for full names * @param {Array<'TYPE_UNSPECIFIED' | 'CALL' | 'CHAT' | 'SOCIAL_MEDIA' | 'EMAIL' | 'API' | 'MANUAL'>} [type] Filter by source type. - TYPE_UNSPECIFIED: Unspecified source type. - CALL: Phone call source type. - CHAT: Chat source type. - SOCIAL_MEDIA: Social media source type. - EMAIL: Email source type. - API: API source type. - MANUAL: Manual source type. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ listSources(page?: number, size?: number, fields?: Array, sort?: string, id?: Array, q?: string, type?: Array<'TYPE_UNSPECIFIED' | 'CALL' | 'CHAT' | 'SOCIAL_MEDIA' | 'EMAIL' | 'API' | 'MANUAL'>, options?: any): Promise>; /** * * @summary Locate a source by ID * @param {string} id The unique ID of the source to locate. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ locateSource(id: string, fields?: Array, options?: any): Promise>; /** * * @summary Update an existing source * @param {string} id * @param {WebitelCasesInputSource} input * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ updateSource(id: string, input: WebitelCasesInputSource, fields?: Array, options?: any): Promise>; /** * * @summary Update an existing source * @param {string} id * @param {WebitelCasesInputSource} input * @param {Array} [fields] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ updateSource2(id: string, input: WebitelCasesInputSource, fields?: Array, options?: any): Promise>; } //# sourceMappingURL=sources-api.d.ts.map