/* tslint:disable */
/* eslint-disable */
/**
 * Identity Security Cloud API - Org Config
 * 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 globalAxios from 'axios';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
import type { RequestArgs } from './base';
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } 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<ErrorMessageDto>}
     * @memberof ErrorResponseDto
     */
    'messages'?: Array<ErrorMessageDto>;
    /**
     * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
     * @type {Array<ErrorMessageDto>}
     * @memberof ErrorResponseDto
     */
    'causes'?: Array<ErrorMessageDto>;
}
/**
 * 
 * @export
 * @interface GetOrgConfigV1401Response
 */
export interface GetOrgConfigV1401Response {
    /**
     * A message describing the error
     * @type {any}
     * @memberof GetOrgConfigV1401Response
     */
    'error'?: any;
}
/**
 * 
 * @export
 * @interface GetOrgConfigV1429Response
 */
export interface GetOrgConfigV1429Response {
    /**
     * A message describing the error
     * @type {any}
     * @memberof GetOrgConfigV1429Response
     */
    '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 const JsonPatchOperationOpEnum = {
    Add: 'add',
    Remove: 'remove',
    Replace: 'replace',
    Move: 'move',
    Copy: 'copy',
    Test: 'test'
} as const;

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<ArrayInner> | 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 const LocaleOrigin = {
    Default: 'DEFAULT',
    Request: 'REQUEST'
} as const;

export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin];


/**
 * DTO class for OrgConfig data accessible by customer external org admin (\"ORG_ADMIN\") users
 * @export
 * @interface OrgConfig
 */
export interface OrgConfig {
    /**
     * The name of the org.
     * @type {string}
     * @memberof OrgConfig
     */
    'orgName'?: string;
    /**
     * The selected time zone which is to be used for the org.  This directly affects when scheduled tasks are executed.  Valid options can be found at /beta/org-config/valid-time-zones
     * @type {string}
     * @memberof OrgConfig
     */
    'timeZone'?: string;
    /**
     * Flag to determine whether the LCS_CHANGE_HONORS_SOURCE_ENABLE_FEATURE flag is enabled for the current org.
     * @type {boolean}
     * @memberof OrgConfig
     */
    'lcsChangeHonorsSourceEnableFeature'?: boolean;
    /**
     * ARM Customer ID
     * @type {string}
     * @memberof OrgConfig
     */
    'armCustomerId'?: string | null;
    /**
     * A list of IDN::sourceId to ARM::systemId mappings.
     * @type {string}
     * @memberof OrgConfig
     */
    'armSapSystemIdMappings'?: string | null;
    /**
     * ARM authentication string
     * @type {string}
     * @memberof OrgConfig
     */
    'armAuth'?: string | null;
    /**
     * ARM database name
     * @type {string}
     * @memberof OrgConfig
     */
    'armDb'?: string | null;
    /**
     * ARM SSO URL
     * @type {string}
     * @memberof OrgConfig
     */
    'armSsoUrl'?: string | null;
    /**
     * Flag to determine whether IAI Certification Recommendations are enabled for the current org
     * @type {boolean}
     * @memberof OrgConfig
     */
    'iaiEnableCertificationRecommendations'?: boolean;
    /**
     * Org opt-in flag that enables AI Agent delete-at-source lifecycle requests for the current org.
     * @type {boolean}
     * @memberof OrgConfig
     */
    'aiAgentDeleteRequestEnabled'?: boolean | null;
    /**
     * 
     * @type {Array<ReportConfigDTO>}
     * @memberof OrgConfig
     */
    'sodReportConfigs'?: Array<ReportConfigDTO>;
}
/**
 * 
 * @export
 * @interface ReportConfigDTO
 */
export interface ReportConfigDTO {
    /**
     * Name of column in report
     * @type {string}
     * @memberof ReportConfigDTO
     */
    'columnName'?: string;
    /**
     * If true, column is required in all reports, and this entry is immutable. A 400 error will result from any attempt to modify the column\'s definition.
     * @type {boolean}
     * @memberof ReportConfigDTO
     */
    'required'?: boolean;
    /**
     * If true, column is included in the report. A 400 error will be thrown if an attempt is made to set included=false if required==true.
     * @type {boolean}
     * @memberof ReportConfigDTO
     */
    'included'?: boolean;
    /**
     * Relative sort order for the column. Columns will be displayed left-to-right in nondecreasing order.
     * @type {number}
     * @memberof ReportConfigDTO
     */
    'order'?: number;
}

/**
 * OrgConfigApi - axios parameter creator
 * @export
 */
export const OrgConfigApiAxiosParamCreator = function (configuration?: Configuration) {
    return {
        /**
         * Get the current organization\'s configuration settings, only external accessible properties.
         * @summary Get org config settings
         * @param {*} [axiosOptions] Override http request option.
         * @throws {RequiredError}
         */
        getOrgConfigV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
            const localVarPath = `/org-config/v1`;
            // use dummy base URL string because the URL constructor only accepts absolute URLs.
            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
            let baseOptions;
            if (configuration) {
                baseOptions = configuration.baseOptions;
            }

            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
            const localVarHeaderParameter = {} as any;
            const localVarQueryParameter = {} as any;


    
            setSearchParams(localVarUrlObj, localVarQueryParameter);
            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};

            return {
                url: toPathString(localVarUrlObj),
                axiosOptions: localVarRequestOptions,
            };
        },
        /**
         * List the valid time zones that can be set in organization configurations.
         * @summary Get valid time zones
         * @param {number} [limit] Note that for this API the maximum value for limit is 50. 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 {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&#x3D;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 {*} [axiosOptions] Override http request option.
         * @throws {RequiredError}
         */
        getValidTimeZonesV1: async (limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
            const localVarPath = `/org-config/v1/valid-time-zones`;
            // use dummy base URL string because the URL constructor only accepts absolute URLs.
            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
            let baseOptions;
            if (configuration) {
                baseOptions = configuration.baseOptions;
            }

            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
            const localVarHeaderParameter = {} as any;
            const localVarQueryParameter = {} as any;

            if (limit !== undefined) {
                localVarQueryParameter['limit'] = limit;
            }

            if (offset !== undefined) {
                localVarQueryParameter['offset'] = offset;
            }

            if (count !== undefined) {
                localVarQueryParameter['count'] = count;
            }


    
            setSearchParams(localVarUrlObj, localVarQueryParameter);
            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};

            return {
                url: toPathString(localVarUrlObj),
                axiosOptions: localVarRequestOptions,
            };
        },
        /**
         * Patch the current organization\'s configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization\'s time zone.
         * @summary Patch org config
         * @param {Array<JsonPatchOperation>} jsonPatchOperation A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
         * @param {*} [axiosOptions] Override http request option.
         * @throws {RequiredError}
         */
        patchOrgConfigV1: async (jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
            // verify required parameter 'jsonPatchOperation' is not null or undefined
            assertParamExists('patchOrgConfigV1', 'jsonPatchOperation', jsonPatchOperation)
            const localVarPath = `/org-config/v1`;
            // use dummy base URL string because the URL constructor only accepts absolute URLs.
            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
            let baseOptions;
            if (configuration) {
                baseOptions = configuration.baseOptions;
            }

            const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...axiosOptions};
            const localVarHeaderParameter = {} as any;
            const localVarQueryParameter = {} as any;


    
            localVarHeaderParameter['Content-Type'] = 'application/json-patch+json';

            setSearchParams(localVarUrlObj, localVarQueryParameter);
            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
            localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperation, localVarRequestOptions, configuration)

            return {
                url: toPathString(localVarUrlObj),
                axiosOptions: localVarRequestOptions,
            };
        },
    }
};

/**
 * OrgConfigApi - functional programming interface
 * @export
 */
export const OrgConfigApiFp = function(configuration?: Configuration) {
    const localVarAxiosParamCreator = OrgConfigApiAxiosParamCreator(configuration)
    return {
        /**
         * Get the current organization\'s configuration settings, only external accessible properties.
         * @summary Get org config settings
         * @param {*} [axiosOptions] Override http request option.
         * @throws {RequiredError}
         */
        async getOrgConfigV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrgConfig>> {
            const localVarAxiosArgs = await localVarAxiosParamCreator.getOrgConfigV1(axiosOptions);
            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
            const localVarOperationServerBasePath = operationServerMap['OrgConfigApi.getOrgConfigV1']?.[localVarOperationServerIndex]?.url;
            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
        },
        /**
         * List the valid time zones that can be set in organization configurations.
         * @summary Get valid time zones
         * @param {number} [limit] Note that for this API the maximum value for limit is 50. 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 {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&#x3D;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 {*} [axiosOptions] Override http request option.
         * @throws {RequiredError}
         */
        async getValidTimeZonesV1(limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>> {
            const localVarAxiosArgs = await localVarAxiosParamCreator.getValidTimeZonesV1(limit, offset, count, axiosOptions);
            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
            const localVarOperationServerBasePath = operationServerMap['OrgConfigApi.getValidTimeZonesV1']?.[localVarOperationServerIndex]?.url;
            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
        },
        /**
         * Patch the current organization\'s configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization\'s time zone.
         * @summary Patch org config
         * @param {Array<JsonPatchOperation>} jsonPatchOperation A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
         * @param {*} [axiosOptions] Override http request option.
         * @throws {RequiredError}
         */
        async patchOrgConfigV1(jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrgConfig>> {
            const localVarAxiosArgs = await localVarAxiosParamCreator.patchOrgConfigV1(jsonPatchOperation, axiosOptions);
            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
            const localVarOperationServerBasePath = operationServerMap['OrgConfigApi.patchOrgConfigV1']?.[localVarOperationServerIndex]?.url;
            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
        },
    }
};

/**
 * OrgConfigApi - factory interface
 * @export
 */
export const OrgConfigApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
    const localVarFp = OrgConfigApiFp(configuration)
    return {
        /**
         * Get the current organization\'s configuration settings, only external accessible properties.
         * @summary Get org config settings
         * @param {*} [axiosOptions] Override http request option.
         * @throws {RequiredError}
         */
        getOrgConfigV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise<OrgConfig> {
            return localVarFp.getOrgConfigV1(axiosOptions).then((request) => request(axios, basePath));
        },
        /**
         * List the valid time zones that can be set in organization configurations.
         * @summary Get valid time zones
         * @param {OrgConfigApiGetValidTimeZonesV1Request} requestParameters Request parameters.
         * @param {*} [axiosOptions] Override http request option.
         * @throws {RequiredError}
         */
        getValidTimeZonesV1(requestParameters: OrgConfigApiGetValidTimeZonesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<string>> {
            return localVarFp.getValidTimeZonesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath));
        },
        /**
         * Patch the current organization\'s configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization\'s time zone.
         * @summary Patch org config
         * @param {OrgConfigApiPatchOrgConfigV1Request} requestParameters Request parameters.
         * @param {*} [axiosOptions] Override http request option.
         * @throws {RequiredError}
         */
        patchOrgConfigV1(requestParameters: OrgConfigApiPatchOrgConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<OrgConfig> {
            return localVarFp.patchOrgConfigV1(requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath));
        },
    };
};

/**
 * Request parameters for getValidTimeZonesV1 operation in OrgConfigApi.
 * @export
 * @interface OrgConfigApiGetValidTimeZonesV1Request
 */
export interface OrgConfigApiGetValidTimeZonesV1Request {
    /**
     * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
     * @type {number}
     * @memberof OrgConfigApiGetValidTimeZonesV1
     */
    readonly limit?: number

    /**
     * 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 OrgConfigApiGetValidTimeZonesV1
     */
    readonly offset?: 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&#x3D;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 OrgConfigApiGetValidTimeZonesV1
     */
    readonly count?: boolean
}

/**
 * Request parameters for patchOrgConfigV1 operation in OrgConfigApi.
 * @export
 * @interface OrgConfigApiPatchOrgConfigV1Request
 */
export interface OrgConfigApiPatchOrgConfigV1Request {
    /**
     * A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
     * @type {Array<JsonPatchOperation>}
     * @memberof OrgConfigApiPatchOrgConfigV1
     */
    readonly jsonPatchOperation: Array<JsonPatchOperation>
}

/**
 * OrgConfigApi - object-oriented interface
 * @export
 * @class OrgConfigApi
 * @extends {BaseAPI}
 */
export class OrgConfigApi extends BaseAPI {
    /**
     * Get the current organization\'s configuration settings, only external accessible properties.
     * @summary Get org config settings
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     * @memberof OrgConfigApi
     */
    public getOrgConfigV1(axiosOptions?: RawAxiosRequestConfig) {
        return OrgConfigApiFp(this.configuration).getOrgConfigV1(axiosOptions).then((request) => request(this.axios, this.basePath));
    }

    /**
     * List the valid time zones that can be set in organization configurations.
     * @summary Get valid time zones
     * @param {OrgConfigApiGetValidTimeZonesV1Request} requestParameters Request parameters.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     * @memberof OrgConfigApi
     */
    public getValidTimeZonesV1(requestParameters: OrgConfigApiGetValidTimeZonesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) {
        return OrgConfigApiFp(this.configuration).getValidTimeZonesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath));
    }

    /**
     * Patch the current organization\'s configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization\'s time zone.
     * @summary Patch org config
     * @param {OrgConfigApiPatchOrgConfigV1Request} requestParameters Request parameters.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     * @memberof OrgConfigApi
     */
    public patchOrgConfigV1(requestParameters: OrgConfigApiPatchOrgConfigV1Request, axiosOptions?: RawAxiosRequestConfig) {
        return OrgConfigApiFp(this.configuration).patchOrgConfigV1(requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath));
    }
}