/* tslint:disable */ /* eslint-disable */ /** * Identity Security Cloud API - Connector Rule Management * 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 Argument */ export interface Argument { /** * the name of the argument * @type {string} * @memberof Argument */ 'name': string; /** * the description of the argument * @type {string} * @memberof Argument */ 'description'?: string | null; /** * the programmatic type of the argument * @type {string} * @memberof Argument */ 'type'?: string | null; } /** * ConnectorRuleCreateRequest * @export * @interface ConnectorRuleCreateRequest */ export interface ConnectorRuleCreateRequest { /** * the name of the rule * @type {string} * @memberof ConnectorRuleCreateRequest */ 'name': string; /** * a description of the rule\'s purpose * @type {string} * @memberof ConnectorRuleCreateRequest */ 'description'?: string | null; /** * the type of rule * @type {string} * @memberof ConnectorRuleCreateRequest */ 'type': ConnectorRuleCreateRequestTypeEnum; /** * * @type {ConnectorRuleCreateRequestSignature} * @memberof ConnectorRuleCreateRequest */ 'signature'?: ConnectorRuleCreateRequestSignature; /** * * @type {SourceCode} * @memberof ConnectorRuleCreateRequest */ 'sourceCode': SourceCode; /** * a map of string to objects * @type {object} * @memberof ConnectorRuleCreateRequest */ 'attributes'?: object | null; } export const ConnectorRuleCreateRequestTypeEnum = { BuildMap: 'BuildMap', ConnectorAfterCreate: 'ConnectorAfterCreate', ConnectorAfterDelete: 'ConnectorAfterDelete', ConnectorAfterModify: 'ConnectorAfterModify', ConnectorBeforeCreate: 'ConnectorBeforeCreate', ConnectorBeforeDelete: 'ConnectorBeforeDelete', ConnectorBeforeModify: 'ConnectorBeforeModify', JdbcBuildMap: 'JDBCBuildMap', JdbcOperationProvisioning: 'JDBCOperationProvisioning', JdbcProvision: 'JDBCProvision', PeopleSoftHrmsBuildMap: 'PeopleSoftHRMSBuildMap', PeopleSoftHrmsOperationProvisioning: 'PeopleSoftHRMSOperationProvisioning', PeopleSoftHrmsProvision: 'PeopleSoftHRMSProvision', RacfPermissionCustomization: 'RACFPermissionCustomization', ResourceObjectCustomization: 'ResourceObjectCustomization', SapBuildMap: 'SAPBuildMap', SapHrManagerRule: 'SapHrManagerRule', SapHrOperationProvisioning: 'SapHrOperationProvisioning', SapHrProvision: 'SapHrProvision', SuccessFactorsOperationProvisioning: 'SuccessFactorsOperationProvisioning', WebServiceAfterOperationRule: 'WebServiceAfterOperationRule', WebServiceBeforeOperationRule: 'WebServiceBeforeOperationRule', ResourceObjectCustomization2: 'ResourceObjectCustomization' } as const; export type ConnectorRuleCreateRequestTypeEnum = typeof ConnectorRuleCreateRequestTypeEnum[keyof typeof ConnectorRuleCreateRequestTypeEnum]; /** * The rule\'s function signature. Describes the rule\'s input arguments and output (if any) * @export * @interface ConnectorRuleCreateRequestSignature */ export interface ConnectorRuleCreateRequestSignature { /** * * @type {Array} * @memberof ConnectorRuleCreateRequestSignature */ 'input': Array; /** * * @type {Argument} * @memberof ConnectorRuleCreateRequestSignature */ 'output'?: Argument | null; } /** * ConnectorRuleResponse * @export * @interface ConnectorRuleResponse */ export interface ConnectorRuleResponse { /** * the name of the rule * @type {string} * @memberof ConnectorRuleResponse */ 'name': string; /** * a description of the rule\'s purpose * @type {string} * @memberof ConnectorRuleResponse */ 'description'?: string | null; /** * the type of rule * @type {string} * @memberof ConnectorRuleResponse */ 'type': ConnectorRuleResponseTypeEnum; /** * * @type {ConnectorRuleCreateRequestSignature} * @memberof ConnectorRuleResponse */ 'signature'?: ConnectorRuleCreateRequestSignature; /** * * @type {SourceCode} * @memberof ConnectorRuleResponse */ 'sourceCode': SourceCode; /** * a map of string to objects * @type {object} * @memberof ConnectorRuleResponse */ 'attributes'?: object | null; /** * the ID of the rule * @type {string} * @memberof ConnectorRuleResponse */ 'id': string; /** * an ISO 8601 UTC timestamp when this rule was created * @type {string} * @memberof ConnectorRuleResponse */ 'created': string; /** * an ISO 8601 UTC timestamp when this rule was last modified * @type {string} * @memberof ConnectorRuleResponse */ 'modified'?: string | null; } export const ConnectorRuleResponseTypeEnum = { BuildMap: 'BuildMap', ConnectorAfterCreate: 'ConnectorAfterCreate', ConnectorAfterDelete: 'ConnectorAfterDelete', ConnectorAfterModify: 'ConnectorAfterModify', ConnectorBeforeCreate: 'ConnectorBeforeCreate', ConnectorBeforeDelete: 'ConnectorBeforeDelete', ConnectorBeforeModify: 'ConnectorBeforeModify', JdbcBuildMap: 'JDBCBuildMap', JdbcOperationProvisioning: 'JDBCOperationProvisioning', JdbcProvision: 'JDBCProvision', PeopleSoftHrmsBuildMap: 'PeopleSoftHRMSBuildMap', PeopleSoftHrmsOperationProvisioning: 'PeopleSoftHRMSOperationProvisioning', PeopleSoftHrmsProvision: 'PeopleSoftHRMSProvision', RacfPermissionCustomization: 'RACFPermissionCustomization', ResourceObjectCustomization: 'ResourceObjectCustomization', SapBuildMap: 'SAPBuildMap', SapHrManagerRule: 'SapHrManagerRule', SapHrOperationProvisioning: 'SapHrOperationProvisioning', SapHrProvision: 'SapHrProvision', SuccessFactorsOperationProvisioning: 'SuccessFactorsOperationProvisioning', WebServiceAfterOperationRule: 'WebServiceAfterOperationRule', WebServiceBeforeOperationRule: 'WebServiceBeforeOperationRule', ResourceObjectCustomization2: 'ResourceObjectCustomization' } as const; export type ConnectorRuleResponseTypeEnum = typeof ConnectorRuleResponseTypeEnum[keyof typeof ConnectorRuleResponseTypeEnum]; /** * ConnectorRuleUpdateRequest * @export * @interface ConnectorRuleUpdateRequest */ export interface ConnectorRuleUpdateRequest { /** * the name of the rule * @type {string} * @memberof ConnectorRuleUpdateRequest */ 'name': string; /** * a description of the rule\'s purpose * @type {string} * @memberof ConnectorRuleUpdateRequest */ 'description'?: string | null; /** * the type of rule * @type {string} * @memberof ConnectorRuleUpdateRequest */ 'type': ConnectorRuleUpdateRequestTypeEnum; /** * * @type {ConnectorRuleCreateRequestSignature} * @memberof ConnectorRuleUpdateRequest */ 'signature'?: ConnectorRuleCreateRequestSignature; /** * * @type {SourceCode} * @memberof ConnectorRuleUpdateRequest */ 'sourceCode': SourceCode; /** * a map of string to objects * @type {object} * @memberof ConnectorRuleUpdateRequest */ 'attributes'?: object | null; /** * the ID of the rule to update * @type {string} * @memberof ConnectorRuleUpdateRequest */ 'id': string; } export const ConnectorRuleUpdateRequestTypeEnum = { BuildMap: 'BuildMap', ConnectorAfterCreate: 'ConnectorAfterCreate', ConnectorAfterDelete: 'ConnectorAfterDelete', ConnectorAfterModify: 'ConnectorAfterModify', ConnectorBeforeCreate: 'ConnectorBeforeCreate', ConnectorBeforeDelete: 'ConnectorBeforeDelete', ConnectorBeforeModify: 'ConnectorBeforeModify', JdbcBuildMap: 'JDBCBuildMap', JdbcOperationProvisioning: 'JDBCOperationProvisioning', JdbcProvision: 'JDBCProvision', PeopleSoftHrmsBuildMap: 'PeopleSoftHRMSBuildMap', PeopleSoftHrmsOperationProvisioning: 'PeopleSoftHRMSOperationProvisioning', PeopleSoftHrmsProvision: 'PeopleSoftHRMSProvision', RacfPermissionCustomization: 'RACFPermissionCustomization', ResourceObjectCustomization: 'ResourceObjectCustomization', SapBuildMap: 'SAPBuildMap', SapHrManagerRule: 'SapHrManagerRule', SapHrOperationProvisioning: 'SapHrOperationProvisioning', SapHrProvision: 'SapHrProvision', SuccessFactorsOperationProvisioning: 'SuccessFactorsOperationProvisioning', WebServiceAfterOperationRule: 'WebServiceAfterOperationRule', WebServiceBeforeOperationRule: 'WebServiceBeforeOperationRule', ResourceObjectCustomization2: 'ResourceObjectCustomization' } as const; export type ConnectorRuleUpdateRequestTypeEnum = typeof ConnectorRuleUpdateRequestTypeEnum[keyof typeof ConnectorRuleUpdateRequestTypeEnum]; /** * ConnectorRuleValidationResponse * @export * @interface ConnectorRuleValidationResponse */ export interface ConnectorRuleValidationResponse { /** * * @type {string} * @memberof ConnectorRuleValidationResponse */ 'state': ConnectorRuleValidationResponseStateEnum; /** * * @type {Array} * @memberof ConnectorRuleValidationResponse */ 'details': Array; } export const ConnectorRuleValidationResponseStateEnum = { Ok: 'OK', Error: 'ERROR' } as const; export type ConnectorRuleValidationResponseStateEnum = typeof ConnectorRuleValidationResponseStateEnum[keyof typeof ConnectorRuleValidationResponseStateEnum]; /** * CodeErrorDetail * @export * @interface ConnectorRuleValidationResponseDetailsInner */ export interface ConnectorRuleValidationResponseDetailsInner { /** * The line number where the issue occurred * @type {number} * @memberof ConnectorRuleValidationResponseDetailsInner */ 'line': number; /** * the column number where the issue occurred * @type {number} * @memberof ConnectorRuleValidationResponseDetailsInner */ 'column': number; /** * a description of the issue in the code * @type {string} * @memberof ConnectorRuleValidationResponseDetailsInner */ 'messsage'?: string; } /** * * @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 GetConnectorRuleListV1401Response */ export interface GetConnectorRuleListV1401Response { /** * A message describing the error * @type {any} * @memberof GetConnectorRuleListV1401Response */ 'error'?: any; } /** * * @export * @interface GetConnectorRuleListV1429Response */ export interface GetConnectorRuleListV1429Response { /** * A message describing the error * @type {any} * @memberof GetConnectorRuleListV1429Response */ '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 const LocaleOrigin = { Default: 'DEFAULT', Request: 'REQUEST' } as const; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * SourceCode * @export * @interface SourceCode */ export interface SourceCode { /** * the version of the code * @type {string} * @memberof SourceCode */ 'version': string; /** * The code * @type {string} * @memberof SourceCode */ 'script': string; } /** * ConnectorRuleManagementApi - axios parameter creator * @export */ export const ConnectorRuleManagementApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * Create a connector rule from the available types. * @summary Create connector rule * @param {ConnectorRuleCreateRequest} connectorRuleCreateRequest Connector rule to create. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createConnectorRuleV1: async (connectorRuleCreateRequest: ConnectorRuleCreateRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'connectorRuleCreateRequest' is not null or undefined assertParamExists('createConnectorRuleV1', 'connectorRuleCreateRequest', connectorRuleCreateRequest) const localVarPath = `/connector-rules/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: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(connectorRuleCreateRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Delete the connector rule for the given ID. * @summary Delete connector rule * @param {string} id ID of the connector rule to delete. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteConnectorRuleV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('deleteConnectorRuleV1', 'id', id) const localVarPath = `/connector-rules/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // 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: 'DELETE', ...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 existing connector rules. * @summary List connector rules * @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=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} */ getConnectorRuleListV1: async (limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/connector-rules/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; 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, }; }, /** * Get a connector rule by ID. * @summary Get connector rule * @param {string} id ID of the connector rule to get. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getConnectorRuleV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getConnectorRuleV1', 'id', id) const localVarPath = `/connector-rules/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // 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, }; }, /** * Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` * @summary Update connector rule * @param {string} id ID of the connector rule to update. * @param {ConnectorRuleUpdateRequest} [connectorRuleUpdateRequest] Connector rule with updated data. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putConnectorRuleV1: async (id: string, connectorRuleUpdateRequest?: ConnectorRuleUpdateRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('putConnectorRuleV1', 'id', id) const localVarPath = `/connector-rules/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // 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: 'PUT', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(connectorRuleUpdateRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Detect issues within the connector rule\'s code to fix and list them. * @summary Validate connector rule * @param {SourceCode} sourceCode Code to validate. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ testConnectorRuleV1: async (sourceCode: SourceCode, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'sourceCode' is not null or undefined assertParamExists('testConnectorRuleV1', 'sourceCode', sourceCode) const localVarPath = `/connector-rules/v1/validate`; // 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: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(sourceCode, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, } }; /** * ConnectorRuleManagementApi - functional programming interface * @export */ export const ConnectorRuleManagementApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = ConnectorRuleManagementApiAxiosParamCreator(configuration) return { /** * Create a connector rule from the available types. * @summary Create connector rule * @param {ConnectorRuleCreateRequest} connectorRuleCreateRequest Connector rule to create. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async createConnectorRuleV1(connectorRuleCreateRequest: ConnectorRuleCreateRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createConnectorRuleV1(connectorRuleCreateRequest, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementApi.createConnectorRuleV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Delete the connector rule for the given ID. * @summary Delete connector rule * @param {string} id ID of the connector rule to delete. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deleteConnectorRuleV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteConnectorRuleV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementApi.deleteConnectorRuleV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * List existing connector rules. * @summary List connector rules * @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=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 getConnectorRuleListV1(limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorRuleListV1(limit, offset, count, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementApi.getConnectorRuleListV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Get a connector rule by ID. * @summary Get connector rule * @param {string} id ID of the connector rule to get. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getConnectorRuleV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorRuleV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementApi.getConnectorRuleV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` * @summary Update connector rule * @param {string} id ID of the connector rule to update. * @param {ConnectorRuleUpdateRequest} [connectorRuleUpdateRequest] Connector rule with updated data. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async putConnectorRuleV1(id: string, connectorRuleUpdateRequest?: ConnectorRuleUpdateRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorRuleV1(id, connectorRuleUpdateRequest, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementApi.putConnectorRuleV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Detect issues within the connector rule\'s code to fix and list them. * @summary Validate connector rule * @param {SourceCode} sourceCode Code to validate. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async testConnectorRuleV1(sourceCode: SourceCode, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.testConnectorRuleV1(sourceCode, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementApi.testConnectorRuleV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, } }; /** * ConnectorRuleManagementApi - factory interface * @export */ export const ConnectorRuleManagementApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = ConnectorRuleManagementApiFp(configuration) return { /** * Create a connector rule from the available types. * @summary Create connector rule * @param {ConnectorRuleManagementApiCreateConnectorRuleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createConnectorRuleV1(requestParameters: ConnectorRuleManagementApiCreateConnectorRuleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createConnectorRuleV1(requestParameters.connectorRuleCreateRequest, axiosOptions).then((request) => request(axios, basePath)); }, /** * Delete the connector rule for the given ID. * @summary Delete connector rule * @param {ConnectorRuleManagementApiDeleteConnectorRuleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteConnectorRuleV1(requestParameters: ConnectorRuleManagementApiDeleteConnectorRuleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteConnectorRuleV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * List existing connector rules. * @summary List connector rules * @param {ConnectorRuleManagementApiGetConnectorRuleListV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getConnectorRuleListV1(requestParameters: ConnectorRuleManagementApiGetConnectorRuleListV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.getConnectorRuleListV1(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); }, /** * Get a connector rule by ID. * @summary Get connector rule * @param {ConnectorRuleManagementApiGetConnectorRuleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getConnectorRuleV1(requestParameters: ConnectorRuleManagementApiGetConnectorRuleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getConnectorRuleV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` * @summary Update connector rule * @param {ConnectorRuleManagementApiPutConnectorRuleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putConnectorRuleV1(requestParameters: ConnectorRuleManagementApiPutConnectorRuleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.putConnectorRuleV1(requestParameters.id, requestParameters.connectorRuleUpdateRequest, axiosOptions).then((request) => request(axios, basePath)); }, /** * Detect issues within the connector rule\'s code to fix and list them. * @summary Validate connector rule * @param {ConnectorRuleManagementApiTestConnectorRuleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ testConnectorRuleV1(requestParameters: ConnectorRuleManagementApiTestConnectorRuleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.testConnectorRuleV1(requestParameters.sourceCode, axiosOptions).then((request) => request(axios, basePath)); }, }; }; /** * Request parameters for createConnectorRuleV1 operation in ConnectorRuleManagementApi. * @export * @interface ConnectorRuleManagementApiCreateConnectorRuleV1Request */ export interface ConnectorRuleManagementApiCreateConnectorRuleV1Request { /** * Connector rule to create. * @type {ConnectorRuleCreateRequest} * @memberof ConnectorRuleManagementApiCreateConnectorRuleV1 */ readonly connectorRuleCreateRequest: ConnectorRuleCreateRequest } /** * Request parameters for deleteConnectorRuleV1 operation in ConnectorRuleManagementApi. * @export * @interface ConnectorRuleManagementApiDeleteConnectorRuleV1Request */ export interface ConnectorRuleManagementApiDeleteConnectorRuleV1Request { /** * ID of the connector rule to delete. * @type {string} * @memberof ConnectorRuleManagementApiDeleteConnectorRuleV1 */ readonly id: string } /** * Request parameters for getConnectorRuleListV1 operation in ConnectorRuleManagementApi. * @export * @interface ConnectorRuleManagementApiGetConnectorRuleListV1Request */ export interface ConnectorRuleManagementApiGetConnectorRuleListV1Request { /** * 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 ConnectorRuleManagementApiGetConnectorRuleListV1 */ 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 ConnectorRuleManagementApiGetConnectorRuleListV1 */ 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=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 ConnectorRuleManagementApiGetConnectorRuleListV1 */ readonly count?: boolean } /** * Request parameters for getConnectorRuleV1 operation in ConnectorRuleManagementApi. * @export * @interface ConnectorRuleManagementApiGetConnectorRuleV1Request */ export interface ConnectorRuleManagementApiGetConnectorRuleV1Request { /** * ID of the connector rule to get. * @type {string} * @memberof ConnectorRuleManagementApiGetConnectorRuleV1 */ readonly id: string } /** * Request parameters for putConnectorRuleV1 operation in ConnectorRuleManagementApi. * @export * @interface ConnectorRuleManagementApiPutConnectorRuleV1Request */ export interface ConnectorRuleManagementApiPutConnectorRuleV1Request { /** * ID of the connector rule to update. * @type {string} * @memberof ConnectorRuleManagementApiPutConnectorRuleV1 */ readonly id: string /** * Connector rule with updated data. * @type {ConnectorRuleUpdateRequest} * @memberof ConnectorRuleManagementApiPutConnectorRuleV1 */ readonly connectorRuleUpdateRequest?: ConnectorRuleUpdateRequest } /** * Request parameters for testConnectorRuleV1 operation in ConnectorRuleManagementApi. * @export * @interface ConnectorRuleManagementApiTestConnectorRuleV1Request */ export interface ConnectorRuleManagementApiTestConnectorRuleV1Request { /** * Code to validate. * @type {SourceCode} * @memberof ConnectorRuleManagementApiTestConnectorRuleV1 */ readonly sourceCode: SourceCode } /** * ConnectorRuleManagementApi - object-oriented interface * @export * @class ConnectorRuleManagementApi * @extends {BaseAPI} */ export class ConnectorRuleManagementApi extends BaseAPI { /** * Create a connector rule from the available types. * @summary Create connector rule * @param {ConnectorRuleManagementApiCreateConnectorRuleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConnectorRuleManagementApi */ public createConnectorRuleV1(requestParameters: ConnectorRuleManagementApiCreateConnectorRuleV1Request, axiosOptions?: RawAxiosRequestConfig) { return ConnectorRuleManagementApiFp(this.configuration).createConnectorRuleV1(requestParameters.connectorRuleCreateRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Delete the connector rule for the given ID. * @summary Delete connector rule * @param {ConnectorRuleManagementApiDeleteConnectorRuleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConnectorRuleManagementApi */ public deleteConnectorRuleV1(requestParameters: ConnectorRuleManagementApiDeleteConnectorRuleV1Request, axiosOptions?: RawAxiosRequestConfig) { return ConnectorRuleManagementApiFp(this.configuration).deleteConnectorRuleV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * List existing connector rules. * @summary List connector rules * @param {ConnectorRuleManagementApiGetConnectorRuleListV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConnectorRuleManagementApi */ public getConnectorRuleListV1(requestParameters: ConnectorRuleManagementApiGetConnectorRuleListV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return ConnectorRuleManagementApiFp(this.configuration).getConnectorRuleListV1(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Get a connector rule by ID. * @summary Get connector rule * @param {ConnectorRuleManagementApiGetConnectorRuleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConnectorRuleManagementApi */ public getConnectorRuleV1(requestParameters: ConnectorRuleManagementApiGetConnectorRuleV1Request, axiosOptions?: RawAxiosRequestConfig) { return ConnectorRuleManagementApiFp(this.configuration).getConnectorRuleV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` * @summary Update connector rule * @param {ConnectorRuleManagementApiPutConnectorRuleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConnectorRuleManagementApi */ public putConnectorRuleV1(requestParameters: ConnectorRuleManagementApiPutConnectorRuleV1Request, axiosOptions?: RawAxiosRequestConfig) { return ConnectorRuleManagementApiFp(this.configuration).putConnectorRuleV1(requestParameters.id, requestParameters.connectorRuleUpdateRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Detect issues within the connector rule\'s code to fix and list them. * @summary Validate connector rule * @param {ConnectorRuleManagementApiTestConnectorRuleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConnectorRuleManagementApi */ public testConnectorRuleV1(requestParameters: ConnectorRuleManagementApiTestConnectorRuleV1Request, axiosOptions?: RawAxiosRequestConfig) { return ConnectorRuleManagementApiFp(this.configuration).testConnectorRuleV1(requestParameters.sourceCode, axiosOptions).then((request) => request(this.axios, this.basePath)); } }