/** * Identity Security Cloud API - Launchers * 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 GetLaunchersV1200Response */ export interface GetLaunchersV1200Response { /** * Pagination marker * @type {string} * @memberof GetLaunchersV1200Response */ 'next'?: string; /** * * @type {Array} * @memberof GetLaunchersV1200Response */ 'items'?: Array; } /** * * @export * @interface GetLaunchersV1401Response */ export interface GetLaunchersV1401Response { /** * A message describing the error * @type {any} * @memberof GetLaunchersV1401Response */ 'error'?: any; } /** * * @export * @interface GetLaunchersV1429Response */ export interface GetLaunchersV1429Response { /** * A message describing the error * @type {any} * @memberof GetLaunchersV1429Response */ 'message'?: any; } /** * * @export * @interface Launcher */ export interface Launcher { /** * ID of the Launcher * @type {string} * @memberof Launcher */ 'id': string; /** * Date the Launcher was created * @type {string} * @memberof Launcher */ 'created': string; /** * Date the Launcher was last modified * @type {string} * @memberof Launcher */ 'modified': string; /** * * @type {LauncherOwner} * @memberof Launcher */ 'owner': LauncherOwner; /** * Name of the Launcher, limited to 255 characters * @type {string} * @memberof Launcher */ 'name': string; /** * Description of the Launcher, limited to 2000 characters * @type {string} * @memberof Launcher */ 'description': string; /** * Launcher type * @type {string} * @memberof Launcher */ 'type': LauncherTypeEnum; /** * State of the Launcher * @type {boolean} * @memberof Launcher */ 'disabled': boolean; /** * * @type {LauncherReference} * @memberof Launcher */ 'reference'?: LauncherReference; /** * JSON configuration associated with this Launcher, restricted to a max size of 4KB * @type {string} * @memberof Launcher */ 'config': string; } export declare const LauncherTypeEnum: { readonly InteractiveProcess: "INTERACTIVE_PROCESS"; }; export type LauncherTypeEnum = typeof LauncherTypeEnum[keyof typeof LauncherTypeEnum]; /** * Owner of the Launcher * @export * @interface LauncherOwner */ export interface LauncherOwner { /** * Owner type * @type {string} * @memberof LauncherOwner */ 'type': string; /** * Owner ID * @type {string} * @memberof LauncherOwner */ 'id': string; } /** * * @export * @interface LauncherReference */ export interface LauncherReference { /** * Type of Launcher reference * @type {string} * @memberof LauncherReference */ 'type'?: LauncherReferenceTypeEnum; /** * ID of Launcher reference * @type {string} * @memberof LauncherReference */ 'id'?: string; } export declare const LauncherReferenceTypeEnum: { readonly Workflow: "WORKFLOW"; }; export type LauncherReferenceTypeEnum = typeof LauncherReferenceTypeEnum[keyof typeof LauncherReferenceTypeEnum]; /** * * @export * @interface LauncherRequest */ export interface LauncherRequest { /** * Name of the Launcher, limited to 255 characters * @type {string} * @memberof LauncherRequest */ 'name': string; /** * Description of the Launcher, limited to 2000 characters * @type {string} * @memberof LauncherRequest */ 'description': string; /** * Launcher type * @type {string} * @memberof LauncherRequest */ 'type': LauncherRequestTypeEnum; /** * State of the Launcher * @type {boolean} * @memberof LauncherRequest */ 'disabled': boolean; /** * * @type {LauncherRequestReference} * @memberof LauncherRequest */ 'reference'?: LauncherRequestReference; /** * JSON configuration associated with this Launcher, restricted to a max size of 4KB * @type {string} * @memberof LauncherRequest */ 'config': string; } export declare const LauncherRequestTypeEnum: { readonly InteractiveProcess: "INTERACTIVE_PROCESS"; }; export type LauncherRequestTypeEnum = typeof LauncherRequestTypeEnum[keyof typeof LauncherRequestTypeEnum]; /** * * @export * @interface LauncherRequestReference */ export interface LauncherRequestReference { /** * Type of Launcher reference * @type {string} * @memberof LauncherRequestReference */ 'type': LauncherRequestReferenceTypeEnum; /** * ID of Launcher reference * @type {string} * @memberof LauncherRequestReference */ 'id': string; } export declare const LauncherRequestReferenceTypeEnum: { readonly Workflow: "WORKFLOW"; }; export type LauncherRequestReferenceTypeEnum = typeof LauncherRequestReferenceTypeEnum[keyof typeof LauncherRequestReferenceTypeEnum]; /** * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. * @export * @enum {string} */ export declare const LocaleOrigin: { readonly Default: "DEFAULT"; readonly Request: "REQUEST"; }; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * * @export * @interface StartLauncherV1200Response */ export interface StartLauncherV1200Response { /** * ID of the Interactive Process that was launched * @type {string} * @memberof StartLauncherV1200Response */ 'interactiveProcessId': string; } /** * LaunchersApi - axios parameter creator * @export */ export declare const LaunchersApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a Launcher with given information * @summary Create launcher * @param {LauncherRequest} launcherRequest Payload to create a Launcher * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createLauncherV1: (launcherRequest: LauncherRequest, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete the given Launcher ID * @summary Delete launcher * @param {string} launcherID ID of the Launcher to be deleted * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteLauncherV1: (launcherID: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Get details for the given Launcher ID * @summary Get launcher by id * @param {string} launcherID ID of the Launcher to be retrieved * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getLauncherV1: (launcherID: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Return a list of Launchers for the authenticated tenant * @summary List all launchers for tenant * @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: **description**: *sw* **disabled**: *eq* **name**: *sw* * @param {string} [next] Pagination marker * @param {number} [limit] Number of Launchers to return * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getLaunchersV1: (filters?: string, next?: string, limit?: number, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Replace the given Launcher ID with given payload * @summary Replace launcher * @param {string} launcherID ID of the Launcher to be replaced * @param {LauncherRequest} launcherRequest Payload to replace Launcher * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putLauncherV1: (launcherID: string, launcherRequest: LauncherRequest, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Launch the given Launcher ID * @summary Launch a launcher * @param {string} launcherID ID of the Launcher to be launched * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ startLauncherV1: (launcherID: string, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * LaunchersApi - functional programming interface * @export */ export declare const LaunchersApiFp: (configuration?: Configuration) => { /** * Create a Launcher with given information * @summary Create launcher * @param {LauncherRequest} launcherRequest Payload to create a Launcher * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createLauncherV1(launcherRequest: LauncherRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete the given Launcher ID * @summary Delete launcher * @param {string} launcherID ID of the Launcher to be deleted * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteLauncherV1(launcherID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get details for the given Launcher ID * @summary Get launcher by id * @param {string} launcherID ID of the Launcher to be retrieved * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getLauncherV1(launcherID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Return a list of Launchers for the authenticated tenant * @summary List all launchers for tenant * @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: **description**: *sw* **disabled**: *eq* **name**: *sw* * @param {string} [next] Pagination marker * @param {number} [limit] Number of Launchers to return * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getLaunchersV1(filters?: string, next?: string, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Replace the given Launcher ID with given payload * @summary Replace launcher * @param {string} launcherID ID of the Launcher to be replaced * @param {LauncherRequest} launcherRequest Payload to replace Launcher * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putLauncherV1(launcherID: string, launcherRequest: LauncherRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Launch the given Launcher ID * @summary Launch a launcher * @param {string} launcherID ID of the Launcher to be launched * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ startLauncherV1(launcherID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * LaunchersApi - factory interface * @export */ export declare const LaunchersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a Launcher with given information * @summary Create launcher * @param {LaunchersApiCreateLauncherV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createLauncherV1(requestParameters: LaunchersApiCreateLauncherV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete the given Launcher ID * @summary Delete launcher * @param {LaunchersApiDeleteLauncherV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteLauncherV1(requestParameters: LaunchersApiDeleteLauncherV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Get details for the given Launcher ID * @summary Get launcher by id * @param {LaunchersApiGetLauncherV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getLauncherV1(requestParameters: LaunchersApiGetLauncherV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Return a list of Launchers for the authenticated tenant * @summary List all launchers for tenant * @param {LaunchersApiGetLaunchersV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getLaunchersV1(requestParameters?: LaunchersApiGetLaunchersV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Replace the given Launcher ID with given payload * @summary Replace launcher * @param {LaunchersApiPutLauncherV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putLauncherV1(requestParameters: LaunchersApiPutLauncherV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Launch the given Launcher ID * @summary Launch a launcher * @param {LaunchersApiStartLauncherV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ startLauncherV1(requestParameters: LaunchersApiStartLauncherV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createLauncherV1 operation in LaunchersApi. * @export * @interface LaunchersApiCreateLauncherV1Request */ export interface LaunchersApiCreateLauncherV1Request { /** * Payload to create a Launcher * @type {LauncherRequest} * @memberof LaunchersApiCreateLauncherV1 */ readonly launcherRequest: LauncherRequest; } /** * Request parameters for deleteLauncherV1 operation in LaunchersApi. * @export * @interface LaunchersApiDeleteLauncherV1Request */ export interface LaunchersApiDeleteLauncherV1Request { /** * ID of the Launcher to be deleted * @type {string} * @memberof LaunchersApiDeleteLauncherV1 */ readonly launcherID: string; } /** * Request parameters for getLauncherV1 operation in LaunchersApi. * @export * @interface LaunchersApiGetLauncherV1Request */ export interface LaunchersApiGetLauncherV1Request { /** * ID of the Launcher to be retrieved * @type {string} * @memberof LaunchersApiGetLauncherV1 */ readonly launcherID: string; } /** * Request parameters for getLaunchersV1 operation in LaunchersApi. * @export * @interface LaunchersApiGetLaunchersV1Request */ export interface LaunchersApiGetLaunchersV1Request { /** * 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: **description**: *sw* **disabled**: *eq* **name**: *sw* * @type {string} * @memberof LaunchersApiGetLaunchersV1 */ readonly filters?: string; /** * Pagination marker * @type {string} * @memberof LaunchersApiGetLaunchersV1 */ readonly next?: string; /** * Number of Launchers to return * @type {number} * @memberof LaunchersApiGetLaunchersV1 */ readonly limit?: number; } /** * Request parameters for putLauncherV1 operation in LaunchersApi. * @export * @interface LaunchersApiPutLauncherV1Request */ export interface LaunchersApiPutLauncherV1Request { /** * ID of the Launcher to be replaced * @type {string} * @memberof LaunchersApiPutLauncherV1 */ readonly launcherID: string; /** * Payload to replace Launcher * @type {LauncherRequest} * @memberof LaunchersApiPutLauncherV1 */ readonly launcherRequest: LauncherRequest; } /** * Request parameters for startLauncherV1 operation in LaunchersApi. * @export * @interface LaunchersApiStartLauncherV1Request */ export interface LaunchersApiStartLauncherV1Request { /** * ID of the Launcher to be launched * @type {string} * @memberof LaunchersApiStartLauncherV1 */ readonly launcherID: string; } /** * LaunchersApi - object-oriented interface * @export * @class LaunchersApi * @extends {BaseAPI} */ export declare class LaunchersApi extends BaseAPI { /** * Create a Launcher with given information * @summary Create launcher * @param {LaunchersApiCreateLauncherV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof LaunchersApi */ createLauncherV1(requestParameters: LaunchersApiCreateLauncherV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete the given Launcher ID * @summary Delete launcher * @param {LaunchersApiDeleteLauncherV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof LaunchersApi */ deleteLauncherV1(requestParameters: LaunchersApiDeleteLauncherV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Get details for the given Launcher ID * @summary Get launcher by id * @param {LaunchersApiGetLauncherV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof LaunchersApi */ getLauncherV1(requestParameters: LaunchersApiGetLauncherV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Return a list of Launchers for the authenticated tenant * @summary List all launchers for tenant * @param {LaunchersApiGetLaunchersV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof LaunchersApi */ getLaunchersV1(requestParameters?: LaunchersApiGetLaunchersV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Replace the given Launcher ID with given payload * @summary Replace launcher * @param {LaunchersApiPutLauncherV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof LaunchersApi */ putLauncherV1(requestParameters: LaunchersApiPutLauncherV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Launch the given Launcher ID * @summary Launch a launcher * @param {LaunchersApiStartLauncherV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof LaunchersApi */ startLauncherV1(requestParameters: LaunchersApiStartLauncherV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; }