/** * Identity Security Cloud API - Connector Customizers * 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 ConnectorCustomizerCreateRequest */ export interface ConnectorCustomizerCreateRequest { /** * Connector customizer name. * @type {string} * @memberof ConnectorCustomizerCreateRequest */ 'name'?: string; } /** * ConnectorCustomizerResponse * @export * @interface ConnectorCustomizerCreateResponse */ export interface ConnectorCustomizerCreateResponse { /** * the ID of connector customizer. * @type {string} * @memberof ConnectorCustomizerCreateResponse */ 'id'?: string; /** * name of the connector customizer. * @type {string} * @memberof ConnectorCustomizerCreateResponse */ 'name'?: string; /** * Connector customizer tenant id. * @type {string} * @memberof ConnectorCustomizerCreateResponse */ 'tenantID'?: string; /** * Date-time when the connector customizer was created. * @type {string} * @memberof ConnectorCustomizerCreateResponse */ 'created'?: string; } /** * ConnectorCustomizerUpdateRequest * @export * @interface ConnectorCustomizerUpdateRequest */ export interface ConnectorCustomizerUpdateRequest { /** * Connector customizer name. * @type {string} * @memberof ConnectorCustomizerUpdateRequest */ 'name'?: string; } /** * ConnectorCustomizerUpdateResponse * @export * @interface ConnectorCustomizerUpdateResponse */ export interface ConnectorCustomizerUpdateResponse { /** * the ID of connector customizer. * @type {string} * @memberof ConnectorCustomizerUpdateResponse */ 'id'?: string; /** * name of the connector customizer. * @type {string} * @memberof ConnectorCustomizerUpdateResponse */ 'name'?: string; /** * Connector customizer tenant id. * @type {string} * @memberof ConnectorCustomizerUpdateResponse */ 'tenantID'?: string; /** * Date-time when the connector customizer was created. * @type {string} * @memberof ConnectorCustomizerUpdateResponse */ 'created'?: string; /** * Connector customizer image version. * @type {number} * @memberof ConnectorCustomizerUpdateResponse */ 'imageVersion'?: number; /** * Connector customizer image id. * @type {string} * @memberof ConnectorCustomizerUpdateResponse */ 'imageID'?: string; } /** * ConnectorCustomizerVersionCreateResponse * @export * @interface ConnectorCustomizerVersionCreateResponse */ export interface ConnectorCustomizerVersionCreateResponse { /** * ID of connector customizer. * @type {string} * @memberof ConnectorCustomizerVersionCreateResponse */ 'customizerID'?: string; /** * ImageID of the connector customizer. * @type {string} * @memberof ConnectorCustomizerVersionCreateResponse */ 'imageID'?: string; /** * Image version of the connector customizer. * @type {number} * @memberof ConnectorCustomizerVersionCreateResponse */ 'version'?: number; /** * Date-time when the connector customizer version was created. * @type {string} * @memberof ConnectorCustomizerVersionCreateResponse */ 'created'?: string; } /** * * @export * @interface ConnectorCustomizersResponse */ export interface ConnectorCustomizersResponse { /** * Connector customizer ID. * @type {string} * @memberof ConnectorCustomizersResponse */ 'id'?: string; /** * Connector customizer name. * @type {string} * @memberof ConnectorCustomizersResponse */ 'name'?: string; /** * Connector customizer image version. * @type {number} * @memberof ConnectorCustomizersResponse */ 'imageVersion'?: number; /** * Connector customizer image id. * @type {string} * @memberof ConnectorCustomizersResponse */ 'imageID'?: string; /** * Connector customizer tenant id. * @type {string} * @memberof ConnectorCustomizersResponse */ 'tenantID'?: string; /** * Date-time when the connector customizer was created * @type {string} * @memberof ConnectorCustomizersResponse */ 'created'?: 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 ListConnectorCustomizersV1401Response */ export interface ListConnectorCustomizersV1401Response { /** * A message describing the error * @type {any} * @memberof ListConnectorCustomizersV1401Response */ 'error'?: any; } /** * * @export * @interface ListConnectorCustomizersV1429Response */ export interface ListConnectorCustomizersV1429Response { /** * A message describing the error * @type {any} * @memberof ListConnectorCustomizersV1429Response */ '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]; /** * ConnectorCustomizersApi - axios parameter creator * @export */ export declare const ConnectorCustomizersApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a connector customizer. * @summary Create connector customizer * @param {ConnectorCustomizerCreateRequest} connectorCustomizerCreateRequest Connector customizer to create. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createConnectorCustomizerV1: (connectorCustomizerCreateRequest: ConnectorCustomizerCreateRequest, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Creates a new version for the customizer. * @summary Creates a connector customizer version * @param {string} id The id of the connector customizer. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createConnectorCustomizerVersionV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete the connector customizer for the given ID. * @summary Delete connector customizer * @param {string} id ID of the connector customizer to delete. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteConnectorCustomizerV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Gets connector customizer by ID. * @summary Get connector customizer * @param {string} id ID of the connector customizer to get. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getConnectorCustomizerV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * List all connector customizers. * @summary List all connector customizers * @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 {number} [limit] Max number of results to return. 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} */ listConnectorCustomizersV1: (offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update an existing connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`. * @summary Update connector customizer * @param {string} id ID of the connector customizer to update. * @param {ConnectorCustomizerUpdateRequest} [connectorCustomizerUpdateRequest] Connector rule with updated data. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putConnectorCustomizerV1: (id: string, connectorCustomizerUpdateRequest?: ConnectorCustomizerUpdateRequest, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * ConnectorCustomizersApi - functional programming interface * @export */ export declare const ConnectorCustomizersApiFp: (configuration?: Configuration) => { /** * Create a connector customizer. * @summary Create connector customizer * @param {ConnectorCustomizerCreateRequest} connectorCustomizerCreateRequest Connector customizer to create. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createConnectorCustomizerV1(connectorCustomizerCreateRequest: ConnectorCustomizerCreateRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a new version for the customizer. * @summary Creates a connector customizer version * @param {string} id The id of the connector customizer. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createConnectorCustomizerVersionV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete the connector customizer for the given ID. * @summary Delete connector customizer * @param {string} id ID of the connector customizer to delete. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteConnectorCustomizerV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets connector customizer by ID. * @summary Get connector customizer * @param {string} id ID of the connector customizer to get. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getConnectorCustomizerV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List all connector customizers. * @summary List all connector customizers * @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 {number} [limit] Max number of results to return. 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} */ listConnectorCustomizersV1(offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Update an existing connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`. * @summary Update connector customizer * @param {string} id ID of the connector customizer to update. * @param {ConnectorCustomizerUpdateRequest} [connectorCustomizerUpdateRequest] Connector rule with updated data. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putConnectorCustomizerV1(id: string, connectorCustomizerUpdateRequest?: ConnectorCustomizerUpdateRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ConnectorCustomizersApi - factory interface * @export */ export declare const ConnectorCustomizersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a connector customizer. * @summary Create connector customizer * @param {ConnectorCustomizersApiCreateConnectorCustomizerV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createConnectorCustomizerV1(requestParameters: ConnectorCustomizersApiCreateConnectorCustomizerV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Creates a new version for the customizer. * @summary Creates a connector customizer version * @param {ConnectorCustomizersApiCreateConnectorCustomizerVersionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createConnectorCustomizerVersionV1(requestParameters: ConnectorCustomizersApiCreateConnectorCustomizerVersionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete the connector customizer for the given ID. * @summary Delete connector customizer * @param {ConnectorCustomizersApiDeleteConnectorCustomizerV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteConnectorCustomizerV1(requestParameters: ConnectorCustomizersApiDeleteConnectorCustomizerV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Gets connector customizer by ID. * @summary Get connector customizer * @param {ConnectorCustomizersApiGetConnectorCustomizerV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getConnectorCustomizerV1(requestParameters: ConnectorCustomizersApiGetConnectorCustomizerV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * List all connector customizers. * @summary List all connector customizers * @param {ConnectorCustomizersApiListConnectorCustomizersV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listConnectorCustomizersV1(requestParameters?: ConnectorCustomizersApiListConnectorCustomizersV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * Update an existing connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`. * @summary Update connector customizer * @param {ConnectorCustomizersApiPutConnectorCustomizerV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putConnectorCustomizerV1(requestParameters: ConnectorCustomizersApiPutConnectorCustomizerV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createConnectorCustomizerV1 operation in ConnectorCustomizersApi. * @export * @interface ConnectorCustomizersApiCreateConnectorCustomizerV1Request */ export interface ConnectorCustomizersApiCreateConnectorCustomizerV1Request { /** * Connector customizer to create. * @type {ConnectorCustomizerCreateRequest} * @memberof ConnectorCustomizersApiCreateConnectorCustomizerV1 */ readonly connectorCustomizerCreateRequest: ConnectorCustomizerCreateRequest; } /** * Request parameters for createConnectorCustomizerVersionV1 operation in ConnectorCustomizersApi. * @export * @interface ConnectorCustomizersApiCreateConnectorCustomizerVersionV1Request */ export interface ConnectorCustomizersApiCreateConnectorCustomizerVersionV1Request { /** * The id of the connector customizer. * @type {string} * @memberof ConnectorCustomizersApiCreateConnectorCustomizerVersionV1 */ readonly id: string; } /** * Request parameters for deleteConnectorCustomizerV1 operation in ConnectorCustomizersApi. * @export * @interface ConnectorCustomizersApiDeleteConnectorCustomizerV1Request */ export interface ConnectorCustomizersApiDeleteConnectorCustomizerV1Request { /** * ID of the connector customizer to delete. * @type {string} * @memberof ConnectorCustomizersApiDeleteConnectorCustomizerV1 */ readonly id: string; } /** * Request parameters for getConnectorCustomizerV1 operation in ConnectorCustomizersApi. * @export * @interface ConnectorCustomizersApiGetConnectorCustomizerV1Request */ export interface ConnectorCustomizersApiGetConnectorCustomizerV1Request { /** * ID of the connector customizer to get. * @type {string} * @memberof ConnectorCustomizersApiGetConnectorCustomizerV1 */ readonly id: string; } /** * Request parameters for listConnectorCustomizersV1 operation in ConnectorCustomizersApi. * @export * @interface ConnectorCustomizersApiListConnectorCustomizersV1Request */ export interface ConnectorCustomizersApiListConnectorCustomizersV1Request { /** * 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 ConnectorCustomizersApiListConnectorCustomizersV1 */ readonly offset?: number; /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof ConnectorCustomizersApiListConnectorCustomizersV1 */ readonly limit?: number; } /** * Request parameters for putConnectorCustomizerV1 operation in ConnectorCustomizersApi. * @export * @interface ConnectorCustomizersApiPutConnectorCustomizerV1Request */ export interface ConnectorCustomizersApiPutConnectorCustomizerV1Request { /** * ID of the connector customizer to update. * @type {string} * @memberof ConnectorCustomizersApiPutConnectorCustomizerV1 */ readonly id: string; /** * Connector rule with updated data. * @type {ConnectorCustomizerUpdateRequest} * @memberof ConnectorCustomizersApiPutConnectorCustomizerV1 */ readonly connectorCustomizerUpdateRequest?: ConnectorCustomizerUpdateRequest; } /** * ConnectorCustomizersApi - object-oriented interface * @export * @class ConnectorCustomizersApi * @extends {BaseAPI} */ export declare class ConnectorCustomizersApi extends BaseAPI { /** * Create a connector customizer. * @summary Create connector customizer * @param {ConnectorCustomizersApiCreateConnectorCustomizerV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConnectorCustomizersApi */ createConnectorCustomizerV1(requestParameters: ConnectorCustomizersApiCreateConnectorCustomizerV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Creates a new version for the customizer. * @summary Creates a connector customizer version * @param {ConnectorCustomizersApiCreateConnectorCustomizerVersionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConnectorCustomizersApi */ createConnectorCustomizerVersionV1(requestParameters: ConnectorCustomizersApiCreateConnectorCustomizerVersionV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete the connector customizer for the given ID. * @summary Delete connector customizer * @param {ConnectorCustomizersApiDeleteConnectorCustomizerV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConnectorCustomizersApi */ deleteConnectorCustomizerV1(requestParameters: ConnectorCustomizersApiDeleteConnectorCustomizerV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Gets connector customizer by ID. * @summary Get connector customizer * @param {ConnectorCustomizersApiGetConnectorCustomizerV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConnectorCustomizersApi */ getConnectorCustomizerV1(requestParameters: ConnectorCustomizersApiGetConnectorCustomizerV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * List all connector customizers. * @summary List all connector customizers * @param {ConnectorCustomizersApiListConnectorCustomizersV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConnectorCustomizersApi */ listConnectorCustomizersV1(requestParameters?: ConnectorCustomizersApiListConnectorCustomizersV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update an existing connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`. * @summary Update connector customizer * @param {ConnectorCustomizersApiPutConnectorCustomizerV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConnectorCustomizersApi */ putConnectorCustomizerV1(requestParameters: ConnectorCustomizersApiPutConnectorCustomizerV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; }