/** * Identity Security Cloud API - Tenant Context * 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 ArrayInner */ export interface ArrayInner { } /** * * @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 GetTenantContextV1200ResponseInner */ export interface GetTenantContextV1200ResponseInner { /** * * @type {string} * @memberof GetTenantContextV1200ResponseInner */ 'key'?: string; /** * * @type {string} * @memberof GetTenantContextV1200ResponseInner */ 'value'?: string; } /** * * @export * @interface GetTenantContextV1401Response */ export interface GetTenantContextV1401Response { /** * A message describing the error * @type {any} * @memberof GetTenantContextV1401Response */ 'error'?: any; } /** * * @export * @interface GetTenantContextV1429Response */ export interface GetTenantContextV1429Response { /** * A message describing the error * @type {any} * @memberof GetTenantContextV1429Response */ 'message'?: any; } /** * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) * @export * @interface JsonPatchOperation */ export interface JsonPatchOperation { /** * The operation to be performed * @type {string} * @memberof JsonPatchOperation */ 'op': JsonPatchOperationOpEnum; /** * A string JSON Pointer representing the target path to an element to be affected by the operation * @type {string} * @memberof JsonPatchOperation */ 'path': string; /** * * @type {JsonPatchOperationValue} * @memberof JsonPatchOperation */ 'value'?: JsonPatchOperationValue; } export declare const JsonPatchOperationOpEnum: { readonly Add: "add"; readonly Remove: "remove"; readonly Replace: "replace"; readonly Move: "move"; readonly Copy: "copy"; readonly Test: "test"; }; export type JsonPatchOperationOpEnum = typeof JsonPatchOperationOpEnum[keyof typeof JsonPatchOperationOpEnum]; /** * @type JsonPatchOperationValue * The value to be used for the operation, required for \"add\" and \"replace\" operations * @export */ export type JsonPatchOperationValue = Array | boolean | number | object | string; /** * 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]; /** * TenantContextApi - axios parameter creator * @export */ export declare const TenantContextApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns all key-value pairs representing the current state of the tenant\'s context. Each tenant is limited to a maximum of 100 key-value pairs. * @summary Retrieve tenant context * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getTenantContextV1: (axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. This endpoint is specifically designed to modify the `/Key/_*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs. Note that each tenant is limited to a maximum of 100 key-value pairs. * @summary Update tenant context * @param {JsonPatchOperation} jsonPatchOperation * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchTenantContextV1: (jsonPatchOperation: JsonPatchOperation, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * TenantContextApi - functional programming interface * @export */ export declare const TenantContextApiFp: (configuration?: Configuration) => { /** * Returns all key-value pairs representing the current state of the tenant\'s context. Each tenant is limited to a maximum of 100 key-value pairs. * @summary Retrieve tenant context * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getTenantContextV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. This endpoint is specifically designed to modify the `/Key/_*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs. Note that each tenant is limited to a maximum of 100 key-value pairs. * @summary Update tenant context * @param {JsonPatchOperation} jsonPatchOperation * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchTenantContextV1(jsonPatchOperation: JsonPatchOperation, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * TenantContextApi - factory interface * @export */ export declare const TenantContextApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns all key-value pairs representing the current state of the tenant\'s context. Each tenant is limited to a maximum of 100 key-value pairs. * @summary Retrieve tenant context * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getTenantContextV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. This endpoint is specifically designed to modify the `/Key/_*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs. Note that each tenant is limited to a maximum of 100 key-value pairs. * @summary Update tenant context * @param {TenantContextApiPatchTenantContextV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchTenantContextV1(requestParameters: TenantContextApiPatchTenantContextV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for patchTenantContextV1 operation in TenantContextApi. * @export * @interface TenantContextApiPatchTenantContextV1Request */ export interface TenantContextApiPatchTenantContextV1Request { /** * * @type {JsonPatchOperation} * @memberof TenantContextApiPatchTenantContextV1 */ readonly jsonPatchOperation: JsonPatchOperation; } /** * TenantContextApi - object-oriented interface * @export * @class TenantContextApi * @extends {BaseAPI} */ export declare class TenantContextApi extends BaseAPI { /** * Returns all key-value pairs representing the current state of the tenant\'s context. Each tenant is limited to a maximum of 100 key-value pairs. * @summary Retrieve tenant context * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof TenantContextApi */ getTenantContextV1(axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. This endpoint is specifically designed to modify the `/Key/_*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs. Note that each tenant is limited to a maximum of 100 key-value pairs. * @summary Update tenant context * @param {TenantContextApiPatchTenantContextV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof TenantContextApi */ patchTenantContextV1(requestParameters: TenantContextApiPatchTenantContextV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; }