/** * Identity Security Cloud API - Transforms * 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 ListTransformsV1401Response */ export interface ListTransformsV1401Response { /** * A message describing the error * @type {any} * @memberof ListTransformsV1401Response */ 'error'?: any; } /** * * @export * @interface ListTransformsV1429Response */ export interface ListTransformsV1429Response { /** * A message describing the error * @type {any} * @memberof ListTransformsV1429Response */ '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]; /** * The representation of an internally- or customer-defined transform. * @export * @interface Transform */ export interface Transform { /** * Unique name of this transform * @type {string} * @memberof Transform */ 'name': string; /** * The type of transform operation * @type {string} * @memberof Transform */ 'type': TransformTypeEnum; /** * Meta-data about the transform. Values in this list are specific to the type of transform to be executed. * @type {object} * @memberof Transform */ 'attributes': object | null; } export declare const TransformTypeEnum: { readonly AccountAttribute: "accountAttribute"; readonly Base64Decode: "base64Decode"; readonly Base64Encode: "base64Encode"; readonly Concat: "concat"; readonly Conditional: "conditional"; readonly DateCompare: "dateCompare"; readonly DateFormat: "dateFormat"; readonly DateMath: "dateMath"; readonly DecomposeDiacriticalMarks: "decomposeDiacriticalMarks"; readonly E164phone: "e164phone"; readonly FirstValid: "firstValid"; readonly Rule: "rule"; readonly IdentityAttribute: "identityAttribute"; readonly IndexOf: "indexOf"; readonly Iso3166: "iso3166"; readonly LastIndexOf: "lastIndexOf"; readonly LeftPad: "leftPad"; readonly Lookup: "lookup"; readonly Lower: "lower"; readonly NormalizeNames: "normalizeNames"; readonly RandomAlphaNumeric: "randomAlphaNumeric"; readonly RandomNumeric: "randomNumeric"; readonly Reference: "reference"; readonly ReplaceAll: "replaceAll"; readonly Replace: "replace"; readonly RightPad: "rightPad"; readonly Split: "split"; readonly Static: "static"; readonly Substring: "substring"; readonly Trim: "trim"; readonly Upper: "upper"; readonly UsernameGenerator: "usernameGenerator"; readonly Uuid: "uuid"; readonly DisplayName: "displayName"; readonly Rfc5646: "rfc5646"; }; export type TransformTypeEnum = typeof TransformTypeEnum[keyof typeof TransformTypeEnum]; /** * * @export * @interface TransformRead */ export interface TransformRead { /** * Unique name of this transform * @type {string} * @memberof TransformRead */ 'name': string; /** * The type of transform operation * @type {string} * @memberof TransformRead */ 'type': TransformReadTypeEnum; /** * Meta-data about the transform. Values in this list are specific to the type of transform to be executed. * @type {object} * @memberof TransformRead */ 'attributes': object | null; /** * Unique ID of this transform * @type {string} * @memberof TransformRead */ 'id': string; /** * Indicates whether this is an internal SailPoint-created transform or a customer-created transform * @type {boolean} * @memberof TransformRead */ 'internal': boolean; } export declare const TransformReadTypeEnum: { readonly AccountAttribute: "accountAttribute"; readonly Base64Decode: "base64Decode"; readonly Base64Encode: "base64Encode"; readonly Concat: "concat"; readonly Conditional: "conditional"; readonly DateCompare: "dateCompare"; readonly DateFormat: "dateFormat"; readonly DateMath: "dateMath"; readonly DecomposeDiacriticalMarks: "decomposeDiacriticalMarks"; readonly E164phone: "e164phone"; readonly FirstValid: "firstValid"; readonly Rule: "rule"; readonly IdentityAttribute: "identityAttribute"; readonly IndexOf: "indexOf"; readonly Iso3166: "iso3166"; readonly LastIndexOf: "lastIndexOf"; readonly LeftPad: "leftPad"; readonly Lookup: "lookup"; readonly Lower: "lower"; readonly NormalizeNames: "normalizeNames"; readonly RandomAlphaNumeric: "randomAlphaNumeric"; readonly RandomNumeric: "randomNumeric"; readonly Reference: "reference"; readonly ReplaceAll: "replaceAll"; readonly Replace: "replace"; readonly RightPad: "rightPad"; readonly Split: "split"; readonly Static: "static"; readonly Substring: "substring"; readonly Trim: "trim"; readonly Upper: "upper"; readonly UsernameGenerator: "usernameGenerator"; readonly Uuid: "uuid"; readonly DisplayName: "displayName"; readonly Rfc5646: "rfc5646"; }; export type TransformReadTypeEnum = typeof TransformReadTypeEnum[keyof typeof TransformReadTypeEnum]; /** * TransformsApi - axios parameter creator * @export */ export declare const TransformsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. * @summary Create transform * @param {Transform} transform The transform to be created. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createTransformV1: (transform: Transform, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. * @summary Delete a transform * @param {string} id ID of the transform to delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteTransformV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API returns the transform specified by the given ID. * @summary Transform by id * @param {string} id ID of the transform to retrieve * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getTransformV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Gets a list of all saved transform objects. * @summary List transforms * @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 {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 {string} [name] Name of the transform to retrieve from the list. * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listTransformsV1: (offset?: number, limit?: number, count?: boolean, name?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. * @summary Update a transform * @param {string} id ID of the transform to update * @param {Transform} [transform] The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateTransformV1: (id: string, transform?: Transform, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * TransformsApi - functional programming interface * @export */ export declare const TransformsApiFp: (configuration?: Configuration) => { /** * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. * @summary Create transform * @param {Transform} transform The transform to be created. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createTransformV1(transform: Transform, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. * @summary Delete a transform * @param {string} id ID of the transform to delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteTransformV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API returns the transform specified by the given ID. * @summary Transform by id * @param {string} id ID of the transform to retrieve * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getTransformV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets a list of all saved transform objects. * @summary List transforms * @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 {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 {string} [name] Name of the transform to retrieve from the list. * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listTransformsV1(offset?: number, limit?: number, count?: boolean, name?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. * @summary Update a transform * @param {string} id ID of the transform to update * @param {Transform} [transform] The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateTransformV1(id: string, transform?: Transform, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * TransformsApi - factory interface * @export */ export declare const TransformsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. * @summary Create transform * @param {TransformsApiCreateTransformV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createTransformV1(requestParameters: TransformsApiCreateTransformV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. * @summary Delete a transform * @param {TransformsApiDeleteTransformV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteTransformV1(requestParameters: TransformsApiDeleteTransformV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API returns the transform specified by the given ID. * @summary Transform by id * @param {TransformsApiGetTransformV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getTransformV1(requestParameters: TransformsApiGetTransformV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Gets a list of all saved transform objects. * @summary List transforms * @param {TransformsApiListTransformsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listTransformsV1(requestParameters?: TransformsApiListTransformsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. * @summary Update a transform * @param {TransformsApiUpdateTransformV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateTransformV1(requestParameters: TransformsApiUpdateTransformV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createTransformV1 operation in TransformsApi. * @export * @interface TransformsApiCreateTransformV1Request */ export interface TransformsApiCreateTransformV1Request { /** * The transform to be created. * @type {Transform} * @memberof TransformsApiCreateTransformV1 */ readonly transform: Transform; } /** * Request parameters for deleteTransformV1 operation in TransformsApi. * @export * @interface TransformsApiDeleteTransformV1Request */ export interface TransformsApiDeleteTransformV1Request { /** * ID of the transform to delete * @type {string} * @memberof TransformsApiDeleteTransformV1 */ readonly id: string; } /** * Request parameters for getTransformV1 operation in TransformsApi. * @export * @interface TransformsApiGetTransformV1Request */ export interface TransformsApiGetTransformV1Request { /** * ID of the transform to retrieve * @type {string} * @memberof TransformsApiGetTransformV1 */ readonly id: string; } /** * Request parameters for listTransformsV1 operation in TransformsApi. * @export * @interface TransformsApiListTransformsV1Request */ export interface TransformsApiListTransformsV1Request { /** * 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 TransformsApiListTransformsV1 */ 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 TransformsApiListTransformsV1 */ readonly limit?: 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 TransformsApiListTransformsV1 */ readonly count?: boolean; /** * Name of the transform to retrieve from the list. * @type {string} * @memberof TransformsApiListTransformsV1 */ readonly name?: string; /** * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* * @type {string} * @memberof TransformsApiListTransformsV1 */ readonly filters?: string; } /** * Request parameters for updateTransformV1 operation in TransformsApi. * @export * @interface TransformsApiUpdateTransformV1Request */ export interface TransformsApiUpdateTransformV1Request { /** * ID of the transform to update * @type {string} * @memberof TransformsApiUpdateTransformV1 */ readonly id: string; /** * The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. * @type {Transform} * @memberof TransformsApiUpdateTransformV1 */ readonly transform?: Transform; } /** * TransformsApi - object-oriented interface * @export * @class TransformsApi * @extends {BaseAPI} */ export declare class TransformsApi extends BaseAPI { /** * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. * @summary Create transform * @param {TransformsApiCreateTransformV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof TransformsApi */ createTransformV1(requestParameters: TransformsApiCreateTransformV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. * @summary Delete a transform * @param {TransformsApiDeleteTransformV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof TransformsApi */ deleteTransformV1(requestParameters: TransformsApiDeleteTransformV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API returns the transform specified by the given ID. * @summary Transform by id * @param {TransformsApiGetTransformV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof TransformsApi */ getTransformV1(requestParameters: TransformsApiGetTransformV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Gets a list of all saved transform objects. * @summary List transforms * @param {TransformsApiListTransformsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof TransformsApi */ listTransformsV1(requestParameters?: TransformsApiListTransformsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. * @summary Update a transform * @param {TransformsApiUpdateTransformV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof TransformsApi */ updateTransformV1(requestParameters: TransformsApiUpdateTransformV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; }