/** * Generic Identity Security Cloud V2025 API * Generic API specification for the Identity Security Cloud platform * * The version of the OpenAPI document: v2025 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * @type GenericResponse * @export */ export type GenericResponse = Array<{ [key: string]: any; }> | { [key: string]: any; }; /** * DefaultApi - axios parameter creator * @export */ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Generic DELETE request * @param {string} path * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ genericDelete: (path: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * * @summary Generic GET request * @param {string} path * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ genericGet: (path: string, limit?: number, count?: boolean, offset?: number, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * * @summary Generic PATCH request * @param {string} path * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {{ [key: string]: any; }} [requestBody] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ genericPatch: (path: string, xSailPointExperimental?: string, requestBody?: { [key: string]: any; }, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * * @summary Generic POST request * @param {string} path * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {{ [key: string]: any; }} [requestBody] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ genericPost: (path: string, xSailPointExperimental?: string, requestBody?: { [key: string]: any; }, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * * @summary Generic PUT request * @param {string} path * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {{ [key: string]: any; }} [requestBody] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ genericPut: (path: string, xSailPointExperimental?: string, requestBody?: { [key: string]: any; }, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * DefaultApi - functional programming interface * @export */ export declare const DefaultApiFp: (configuration?: Configuration) => { /** * * @summary Generic DELETE request * @param {string} path * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ genericDelete(path: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Generic GET request * @param {string} path * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ genericGet(path: string, limit?: number, count?: boolean, offset?: number, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Generic PATCH request * @param {string} path * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {{ [key: string]: any; }} [requestBody] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ genericPatch(path: string, xSailPointExperimental?: string, requestBody?: { [key: string]: any; }, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Generic POST request * @param {string} path * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {{ [key: string]: any; }} [requestBody] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ genericPost(path: string, xSailPointExperimental?: string, requestBody?: { [key: string]: any; }, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Generic PUT request * @param {string} path * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {{ [key: string]: any; }} [requestBody] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ genericPut(path: string, xSailPointExperimental?: string, requestBody?: { [key: string]: any; }, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * DefaultApi - factory interface * @export */ export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Generic DELETE request * @param {DefaultApiGenericDeleteRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ genericDelete(requestParameters: DefaultApiGenericDeleteRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Generic GET request * @param {DefaultApiGenericGetRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ genericGet(requestParameters: DefaultApiGenericGetRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Generic PATCH request * @param {DefaultApiGenericPatchRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ genericPatch(requestParameters: DefaultApiGenericPatchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Generic POST request * @param {DefaultApiGenericPostRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ genericPost(requestParameters: DefaultApiGenericPostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Generic PUT request * @param {DefaultApiGenericPutRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ genericPut(requestParameters: DefaultApiGenericPutRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for genericDelete operation in DefaultApi. * @export * @interface DefaultApiGenericDeleteRequest */ export interface DefaultApiGenericDeleteRequest { /** * * @type {string} * @memberof DefaultApiGenericDelete */ readonly path: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof DefaultApiGenericDelete */ readonly xSailPointExperimental?: string; } /** * Request parameters for genericGet operation in DefaultApi. * @export * @interface DefaultApiGenericGetRequest */ export interface DefaultApiGenericGetRequest { /** * * @type {string} * @memberof DefaultApiGenericGet */ readonly path: string; /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof DefaultApiGenericGet */ readonly limit?: number; /** * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {boolean} * @memberof DefaultApiGenericGet */ readonly count?: boolean; /** * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof DefaultApiGenericGet */ readonly offset?: number; /** * Use this header to enable this experimental API. * @type {string} * @memberof DefaultApiGenericGet */ readonly xSailPointExperimental?: string; } /** * Request parameters for genericPatch operation in DefaultApi. * @export * @interface DefaultApiGenericPatchRequest */ export interface DefaultApiGenericPatchRequest { /** * * @type {string} * @memberof DefaultApiGenericPatch */ readonly path: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof DefaultApiGenericPatch */ readonly xSailPointExperimental?: string; /** * * @type {{ [key: string]: any; }} * @memberof DefaultApiGenericPatch */ readonly requestBody?: { [key: string]: any; }; } /** * Request parameters for genericPost operation in DefaultApi. * @export * @interface DefaultApiGenericPostRequest */ export interface DefaultApiGenericPostRequest { /** * * @type {string} * @memberof DefaultApiGenericPost */ readonly path: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof DefaultApiGenericPost */ readonly xSailPointExperimental?: string; /** * * @type {{ [key: string]: any; }} * @memberof DefaultApiGenericPost */ readonly requestBody?: { [key: string]: any; }; } /** * Request parameters for genericPut operation in DefaultApi. * @export * @interface DefaultApiGenericPutRequest */ export interface DefaultApiGenericPutRequest { /** * * @type {string} * @memberof DefaultApiGenericPut */ readonly path: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof DefaultApiGenericPut */ readonly xSailPointExperimental?: string; /** * * @type {{ [key: string]: any; }} * @memberof DefaultApiGenericPut */ readonly requestBody?: { [key: string]: any; }; } /** * DefaultApi - object-oriented interface * @export * @class DefaultApi * @extends {BaseAPI} */ export declare class DefaultApi extends BaseAPI { /** * * @summary Generic DELETE request * @param {DefaultApiGenericDeleteRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ genericDelete(requestParameters: DefaultApiGenericDeleteRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * * @summary Generic GET request * @param {DefaultApiGenericGetRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ genericGet(requestParameters: DefaultApiGenericGetRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * * @summary Generic PATCH request * @param {DefaultApiGenericPatchRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ genericPatch(requestParameters: DefaultApiGenericPatchRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * * @summary Generic POST request * @param {DefaultApiGenericPostRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ genericPost(requestParameters: DefaultApiGenericPostRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * * @summary Generic PUT request * @param {DefaultApiGenericPutRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ genericPut(requestParameters: DefaultApiGenericPutRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; }