/** * Identity Security Cloud API - Tenant * 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 GetTenantV1401Response */ export interface GetTenantV1401Response { /** * A message describing the error * @type {any} * @memberof GetTenantV1401Response */ 'error'?: any; } /** * * @export * @interface GetTenantV1429Response */ export interface GetTenantV1429Response { /** * A message describing the error * @type {any} * @memberof GetTenantV1429Response */ 'message'?: any; } /** * * @export * @interface License */ export interface License { /** * Name of the license * @type {string} * @memberof License */ 'licenseId'?: string; /** * Legacy name of the license * @type {string} * @memberof License */ 'legacyFeatureName'?: 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]; /** * * @export * @interface Product */ export interface Product { /** * Name of the Product * @type {string} * @memberof Product */ 'productName'?: string; /** * URL of the Product * @type {string} * @memberof Product */ 'url'?: string; /** * An identifier for a specific product-tenant combination * @type {string} * @memberof Product */ 'productTenantId'?: string; /** * Product region * @type {string} * @memberof Product */ 'productRegion'?: string; /** * Right needed for the Product * @type {string} * @memberof Product */ 'productRight'?: string; /** * API URL of the Product * @type {string} * @memberof Product */ 'apiUrl'?: string | null; /** * * @type {Array} * @memberof Product */ 'licenses'?: Array; /** * Additional attributes for a product * @type {{ [key: string]: any; }} * @memberof Product */ 'attributes'?: { [key: string]: any; }; /** * Zone * @type {string} * @memberof Product */ 'zone'?: string; /** * Status of the product * @type {string} * @memberof Product */ 'status'?: string; /** * Status datetime * @type {string} * @memberof Product */ 'statusDateTime'?: string; /** * If there\'s a tenant provisioning failure then reason will have the description of error * @type {string} * @memberof Product */ 'reason'?: string; /** * Product could have additional notes added during tenant provisioning. * @type {string} * @memberof Product */ 'notes'?: string; /** * Date when the product was created * @type {string} * @memberof Product */ 'dateCreated'?: string | null; /** * Date when the product was last updated * @type {string} * @memberof Product */ 'lastUpdated'?: string | null; /** * Type of org * @type {string} * @memberof Product */ 'orgType'?: ProductOrgTypeEnum | null; } export declare const ProductOrgTypeEnum: { readonly Development: "development"; readonly Staging: "staging"; readonly Production: "production"; readonly Test: "test"; readonly Partner: "partner"; readonly Training: "training"; readonly Demonstration: "demonstration"; readonly Sandbox: "sandbox"; }; export type ProductOrgTypeEnum = typeof ProductOrgTypeEnum[keyof typeof ProductOrgTypeEnum]; /** * * @export * @interface Tenant */ export interface Tenant { /** * The unique identifier for the Tenant * @type {string} * @memberof Tenant */ 'id'?: string; /** * Abbreviated name of the Tenant * @type {string} * @memberof Tenant */ 'name'?: string; /** * Human-readable name of the Tenant * @type {string} * @memberof Tenant */ 'fullName'?: string; /** * Deployment pod for the Tenant * @type {string} * @memberof Tenant */ 'pod'?: string; /** * Deployment region for the Tenant * @type {string} * @memberof Tenant */ 'region'?: string; /** * Description of the Tenant * @type {string} * @memberof Tenant */ 'description'?: string; /** * * @type {Array} * @memberof Tenant */ 'products'?: Array; } /** * TenantApi - axios parameter creator * @export */ export declare const TenantApiAxiosParamCreator: (configuration?: Configuration) => { /** * This rest endpoint can be used to retrieve tenant details. * @summary Get tenant information. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getTenantV1: (axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * TenantApi - functional programming interface * @export */ export declare const TenantApiFp: (configuration?: Configuration) => { /** * This rest endpoint can be used to retrieve tenant details. * @summary Get tenant information. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getTenantV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * TenantApi - factory interface * @export */ export declare const TenantApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This rest endpoint can be used to retrieve tenant details. * @summary Get tenant information. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getTenantV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * TenantApi - object-oriented interface * @export * @class TenantApi * @extends {BaseAPI} */ export declare class TenantApi extends BaseAPI { /** * This rest endpoint can be used to retrieve tenant details. * @summary Get tenant information. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof TenantApi */ getTenantV1(axiosOptions?: RawAxiosRequestConfig): Promise>; }