/** * Identity Security Cloud API - Api Usage * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. * * The version of the OpenAPI document: v1 * * * 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'; /** * * @export * @interface ErrorMessageDto */ export interface ErrorMessageDto { /** * The locale for the message text, a BCP 47 language tag. * @type {string} * @memberof ErrorMessageDto */ 'locale'?: string | null; /** * * @type {LocaleOrigin} * @memberof ErrorMessageDto */ 'localeOrigin'?: LocaleOrigin | null; /** * Actual text of the error message in the indicated locale. * @type {string} * @memberof ErrorMessageDto */ 'text'?: string; } /** * * @export * @interface ErrorResponseDto */ export interface ErrorResponseDto { /** * Fine-grained error code providing more detail of the error. * @type {string} * @memberof ErrorResponseDto */ 'detailCode'?: string; /** * Unique tracking id for the error. * @type {string} * @memberof ErrorResponseDto */ 'trackingId'?: string; /** * Generic localized reason for error * @type {Array} * @memberof ErrorResponseDto */ 'messages'?: Array; /** * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field * @type {Array} * @memberof ErrorResponseDto */ 'causes'?: Array; } /** * * @export * @interface GetTotalCountV1401Response */ export interface GetTotalCountV1401Response { /** * A message describing the error * @type {any} * @memberof GetTotalCountV1401Response */ 'error'?: any; } /** * * @export * @interface GetTotalCountV1429Response */ export interface GetTotalCountV1429Response { /** * A message describing the error * @type {any} * @memberof GetTotalCountV1429Response */ 'message'?: any; } /** * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. * @export * @enum {string} */ export declare const LocaleOrigin: { readonly Default: "DEFAULT"; readonly Request: "REQUEST"; }; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * * @export * @interface SummaryResponse */ export interface SummaryResponse { /** * The endpoint of a SailPoint API * @type {string} * @memberof SummaryResponse */ 'RequestedUri'?: string; /** * Number of calls made to a specific SailPoint API * @type {number} * @memberof SummaryResponse */ 'NumberOfCalls'?: number; } /** * ApiUsageApi - axios parameter creator * @export */ export declare const ApiUsageApiAxiosParamCreator: (configuration?: Configuration) => { /** * This API gets an aggregated number of all API calls from an org in a specific timespan. Unless specified, the results are aggregated between the first day of the current month and today. * @summary Total number of API requests * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getTotalCountV1: (xSailPointExperimental?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API gets a list of APIs called by the org in a specific timespan, sorted by number of calls. Unless specified, the results are aggregated between the first day of the current month and today. * @summary Get Api Summary * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* * @param {number} [limit] Max number of results to return. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listApiSummaryV1: (xSailPointExperimental?: string, filters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * ApiUsageApi - functional programming interface * @export */ export declare const ApiUsageApiFp: (configuration?: Configuration) => { /** * This API gets an aggregated number of all API calls from an org in a specific timespan. Unless specified, the results are aggregated between the first day of the current month and today. * @summary Total number of API requests * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getTotalCountV1(xSailPointExperimental?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API gets a list of APIs called by the org in a specific timespan, sorted by number of calls. Unless specified, the results are aggregated between the first day of the current month and today. * @summary Get Api Summary * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* * @param {number} [limit] Max number of results to return. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listApiSummaryV1(xSailPointExperimental?: string, filters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; }; /** * ApiUsageApi - factory interface * @export */ export declare const ApiUsageApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This API gets an aggregated number of all API calls from an org in a specific timespan. Unless specified, the results are aggregated between the first day of the current month and today. * @summary Total number of API requests * @param {ApiUsageApiGetTotalCountV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getTotalCountV1(requestParameters?: ApiUsageApiGetTotalCountV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API gets a list of APIs called by the org in a specific timespan, sorted by number of calls. Unless specified, the results are aggregated between the first day of the current month and today. * @summary Get Api Summary * @param {ApiUsageApiListApiSummaryV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listApiSummaryV1(requestParameters?: ApiUsageApiListApiSummaryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; }; /** * Request parameters for getTotalCountV1 operation in ApiUsageApi. * @export * @interface ApiUsageApiGetTotalCountV1Request */ export interface ApiUsageApiGetTotalCountV1Request { /** * Use this header to enable this experimental API. * @type {string} * @memberof ApiUsageApiGetTotalCountV1 */ readonly xSailPointExperimental?: string; /** * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* * @type {string} * @memberof ApiUsageApiGetTotalCountV1 */ readonly filters?: string; } /** * Request parameters for listApiSummaryV1 operation in ApiUsageApi. * @export * @interface ApiUsageApiListApiSummaryV1Request */ export interface ApiUsageApiListApiSummaryV1Request { /** * Use this header to enable this experimental API. * @type {string} * @memberof ApiUsageApiListApiSummaryV1 */ readonly xSailPointExperimental?: string; /** * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* * @type {string} * @memberof ApiUsageApiListApiSummaryV1 */ readonly filters?: string; /** * Max number of results to return. * @type {number} * @memberof ApiUsageApiListApiSummaryV1 */ readonly limit?: number; /** * Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. * @type {number} * @memberof ApiUsageApiListApiSummaryV1 */ readonly offset?: number; } /** * ApiUsageApi - object-oriented interface * @export * @class ApiUsageApi * @extends {BaseAPI} */ export declare class ApiUsageApi extends BaseAPI { /** * This API gets an aggregated number of all API calls from an org in a specific timespan. Unless specified, the results are aggregated between the first day of the current month and today. * @summary Total number of API requests * @param {ApiUsageApiGetTotalCountV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ApiUsageApi */ getTotalCountV1(requestParameters?: ApiUsageApiGetTotalCountV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API gets a list of APIs called by the org in a specific timespan, sorted by number of calls. Unless specified, the results are aggregated between the first day of the current month and today. * @summary Get Api Summary * @param {ApiUsageApiListApiSummaryV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ApiUsageApi */ listApiSummaryV1(requestParameters?: ApiUsageApiListApiSummaryV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; }