/** * Identity Security Cloud API - Custom Forms * 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'; /** * Effect produced by a condition. * @export * @interface ConditionEffect */ export interface ConditionEffect { /** * Type of effect to perform when the conditions are evaluated for this logic block. HIDE ConditionEffectTypeHide Disables validations. SHOW ConditionEffectTypeShow Enables validations. DISABLE ConditionEffectTypeDisable Disables validations. ENABLE ConditionEffectTypeEnable Enables validations. REQUIRE ConditionEffectTypeRequire OPTIONAL ConditionEffectTypeOptional SUBMIT_MESSAGE ConditionEffectTypeSubmitMessage SUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification SET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue This value is ignored on purpose. * @type {string} * @memberof ConditionEffect */ 'effectType'?: ConditionEffectEffectTypeEnum; /** * * @type {ConditionEffectConfig} * @memberof ConditionEffect */ 'config'?: ConditionEffectConfig; } export declare const ConditionEffectEffectTypeEnum: { readonly Hide: "HIDE"; readonly Show: "SHOW"; readonly Disable: "DISABLE"; readonly Enable: "ENABLE"; readonly Require: "REQUIRE"; readonly Optional: "OPTIONAL"; readonly SubmitMessage: "SUBMIT_MESSAGE"; readonly SubmitNotification: "SUBMIT_NOTIFICATION"; readonly SetDefaultValue: "SET_DEFAULT_VALUE"; }; export type ConditionEffectEffectTypeEnum = typeof ConditionEffectEffectTypeEnum[keyof typeof ConditionEffectEffectTypeEnum]; /** * Arbitrary map containing a configuration based on the EffectType. * @export * @interface ConditionEffectConfig */ export interface ConditionEffectConfig { /** * Effect type\'s label. * @type {string} * @memberof ConditionEffectConfig */ 'defaultValueLabel'?: string; /** * Element\'s identifier. * @type {string} * @memberof ConditionEffectConfig */ 'element'?: string; } /** * * @export * @interface ConditionRule */ export interface ConditionRule { /** * Defines the type of object being selected. It will be either a reference to a form input (by input name) or a form element (by technical key). INPUT ConditionRuleSourceTypeInput ELEMENT ConditionRuleSourceTypeElement * @type {string} * @memberof ConditionRule */ 'sourceType'?: ConditionRuleSourceTypeEnum; /** * Source - if the sourceType is ConditionRuleSourceTypeInput, the source type is the name of the form input to accept. However, if the sourceType is ConditionRuleSourceTypeElement, the source is the name of a technical key of an element to retrieve its value. * @type {string} * @memberof ConditionRule */ 'source'?: string; /** * ConditionRuleComparisonOperatorType value. EQ ConditionRuleComparisonOperatorTypeEquals This comparison operator compares the source and target for equality. NE ConditionRuleComparisonOperatorTypeNotEquals This comparison operator compares the source and target for inequality. CO ConditionRuleComparisonOperatorTypeContains This comparison operator searches the source to see whether it contains the value. NOT_CO ConditionRuleComparisonOperatorTypeNotContains IN ConditionRuleComparisonOperatorTypeIncludes This comparison operator searches the source if it equals any of the values. NOT_IN ConditionRuleComparisonOperatorTypeNotIncludes EM ConditionRuleComparisonOperatorTypeEmpty NOT_EM ConditionRuleComparisonOperatorTypeNotEmpty SW ConditionRuleComparisonOperatorTypeStartsWith Checks whether a string starts with another substring of the same string. This operator is case-sensitive. NOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith EW ConditionRuleComparisonOperatorTypeEndsWith Checks whether a string ends with another substring of the same string. This operator is case-sensitive. NOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith * @type {string} * @memberof ConditionRule */ 'operator'?: ConditionRuleOperatorEnum; /** * ConditionRuleValueType type. STRING ConditionRuleValueTypeString This value is a static string. STRING_LIST ConditionRuleValueTypeStringList This value is an array of string values. INPUT ConditionRuleValueTypeInput This value is a reference to a form input. ELEMENT ConditionRuleValueTypeElement This value is a reference to a form element (by technical key). LIST ConditionRuleValueTypeList BOOLEAN ConditionRuleValueTypeBoolean * @type {string} * @memberof ConditionRule */ 'valueType'?: ConditionRuleValueTypeEnum; /** * Based on the ValueType. * @type {string} * @memberof ConditionRule */ 'value'?: string; } export declare const ConditionRuleSourceTypeEnum: { readonly Input: "INPUT"; readonly Element: "ELEMENT"; }; export type ConditionRuleSourceTypeEnum = typeof ConditionRuleSourceTypeEnum[keyof typeof ConditionRuleSourceTypeEnum]; export declare const ConditionRuleOperatorEnum: { readonly Eq: "EQ"; readonly Ne: "NE"; readonly Co: "CO"; readonly NotCo: "NOT_CO"; readonly In: "IN"; readonly NotIn: "NOT_IN"; readonly Em: "EM"; readonly NotEm: "NOT_EM"; readonly Sw: "SW"; readonly NotSw: "NOT_SW"; readonly Ew: "EW"; readonly NotEw: "NOT_EW"; }; export type ConditionRuleOperatorEnum = typeof ConditionRuleOperatorEnum[keyof typeof ConditionRuleOperatorEnum]; export declare const ConditionRuleValueTypeEnum: { readonly String: "STRING"; readonly StringList: "STRING_LIST"; readonly Input: "INPUT"; readonly Element: "ELEMENT"; readonly List: "LIST"; readonly Boolean: "BOOLEAN"; }; export type ConditionRuleValueTypeEnum = typeof ConditionRuleValueTypeEnum[keyof typeof ConditionRuleValueTypeEnum]; /** * * @export * @interface CreateFormDefinitionFileRequestV1Request */ export interface CreateFormDefinitionFileRequestV1Request { /** * File specifying the multipart * @type {File} * @memberof CreateFormDefinitionFileRequestV1Request */ 'file': File; } /** * * @export * @interface CreateFormDefinitionRequest */ export interface CreateFormDefinitionRequest { /** * Description is the form definition description * @type {string} * @memberof CreateFormDefinitionRequest */ 'description'?: string; /** * FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form * @type {Array} * @memberof CreateFormDefinitionRequest */ 'formConditions'?: Array; /** * FormElements is a list of nested form elements * @type {Array} * @memberof CreateFormDefinitionRequest */ 'formElements'?: Array; /** * FormInput is a list of form inputs that are required when creating a form-instance object * @type {Array} * @memberof CreateFormDefinitionRequest */ 'formInput'?: Array; /** * Name is the form definition name * @type {string} * @memberof CreateFormDefinitionRequest */ 'name': string; /** * * @type {FormOwner} * @memberof CreateFormDefinitionRequest */ 'owner': FormOwner; /** * UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used * @type {Array} * @memberof CreateFormDefinitionRequest */ 'usedBy'?: Array; } /** * * @export * @interface CreateFormInstanceRequest */ export interface CreateFormInstanceRequest { /** * * @type {FormInstanceCreatedBy} * @memberof CreateFormInstanceRequest */ 'createdBy': FormInstanceCreatedBy; /** * Expire is required * @type {string} * @memberof CreateFormInstanceRequest */ 'expire': string; /** * FormDefinitionID is the id of the form definition that created this form * @type {string} * @memberof CreateFormInstanceRequest */ 'formDefinitionId': string; /** * FormInput is an object of form input labels to value * @type {{ [key: string]: any; }} * @memberof CreateFormInstanceRequest */ 'formInput'?: { [key: string]: any; }; /** * Recipients is required * @type {Array} * @memberof CreateFormInstanceRequest */ 'recipients': Array; /** * StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form * @type {boolean} * @memberof CreateFormInstanceRequest */ 'standAloneForm'?: boolean; /** * State is required, if not present initial state is FormInstanceStateAssigned ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled * @type {string} * @memberof CreateFormInstanceRequest */ 'state'?: CreateFormInstanceRequestStateEnum; /** * TTL an epoch timestamp in seconds, it most be in seconds or dynamodb will ignore it SEE: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/time-to-live-ttl-before-you-start.html * @type {number} * @memberof CreateFormInstanceRequest */ 'ttl'?: number; } export declare const CreateFormInstanceRequestStateEnum: { readonly Assigned: "ASSIGNED"; readonly InProgress: "IN_PROGRESS"; readonly Submitted: "SUBMITTED"; readonly Completed: "COMPLETED"; readonly Cancelled: "CANCELLED"; }; export type CreateFormInstanceRequestStateEnum = typeof CreateFormInstanceRequestStateEnum[keyof typeof CreateFormInstanceRequestStateEnum]; /** * * @export * @interface ErrorMessage */ export interface ErrorMessage { /** * Locale is the current Locale * @type {string} * @memberof ErrorMessage */ 'locale'?: string; /** * LocaleOrigin holds possible values of how the locale was selected * @type {string} * @memberof ErrorMessage */ 'localeOrigin'?: string; /** * Text is the actual text of the error message * @type {string} * @memberof ErrorMessage */ 'text'?: string; } /** * * @export * @interface ExportFormDefinitionsByTenantV1200ResponseInner */ export interface ExportFormDefinitionsByTenantV1200ResponseInner { /** * * @type {FormDefinitionResponse} * @memberof ExportFormDefinitionsByTenantV1200ResponseInner */ 'object'?: FormDefinitionResponse; /** * * @type {ExportFormDefinitionsByTenantV1200ResponseInnerSelf} * @memberof ExportFormDefinitionsByTenantV1200ResponseInner */ 'self'?: ExportFormDefinitionsByTenantV1200ResponseInnerSelf; /** * * @type {number} * @memberof ExportFormDefinitionsByTenantV1200ResponseInner */ 'version'?: number; } /** * * @export * @interface ExportFormDefinitionsByTenantV1200ResponseInnerSelf */ export interface ExportFormDefinitionsByTenantV1200ResponseInnerSelf { /** * * @type {FormDefinitionSelfImportExportDto} * @memberof ExportFormDefinitionsByTenantV1200ResponseInnerSelf */ 'object'?: FormDefinitionSelfImportExportDto; } /** * Represent a form conditional. * @export * @interface FormCondition */ export interface FormCondition { /** * ConditionRuleLogicalOperatorType value. AND ConditionRuleLogicalOperatorTypeAnd OR ConditionRuleLogicalOperatorTypeOr * @type {string} * @memberof FormCondition */ 'ruleOperator'?: FormConditionRuleOperatorEnum; /** * List of rules. * @type {Array} * @memberof FormCondition */ 'rules'?: Array; /** * List of effects. * @type {Array} * @memberof FormCondition */ 'effects'?: Array; } export declare const FormConditionRuleOperatorEnum: { readonly And: "AND"; readonly Or: "OR"; }; export type FormConditionRuleOperatorEnum = typeof FormConditionRuleOperatorEnum[keyof typeof FormConditionRuleOperatorEnum]; /** * * @export * @interface FormDefinitionDynamicSchemaRequest */ export interface FormDefinitionDynamicSchemaRequest { /** * * @type {FormDefinitionDynamicSchemaRequestAttributes} * @memberof FormDefinitionDynamicSchemaRequest */ 'attributes'?: FormDefinitionDynamicSchemaRequestAttributes; /** * Description is the form definition dynamic schema description text * @type {string} * @memberof FormDefinitionDynamicSchemaRequest */ 'description'?: string; /** * ID is a unique identifier * @type {string} * @memberof FormDefinitionDynamicSchemaRequest */ 'id'?: string; /** * Type is the form definition dynamic schema type * @type {string} * @memberof FormDefinitionDynamicSchemaRequest */ 'type'?: string; /** * VersionNumber is the form definition dynamic schema version number * @type {number} * @memberof FormDefinitionDynamicSchemaRequest */ 'versionNumber'?: number; } /** * * @export * @interface FormDefinitionDynamicSchemaRequestAttributes */ export interface FormDefinitionDynamicSchemaRequestAttributes { /** * FormDefinitionID is a unique guid identifying this form definition * @type {string} * @memberof FormDefinitionDynamicSchemaRequestAttributes */ 'formDefinitionId'?: string; } /** * * @export * @interface FormDefinitionDynamicSchemaResponse */ export interface FormDefinitionDynamicSchemaResponse { /** * OutputSchema holds a JSON schema generated dynamically * @type {{ [key: string]: any; }} * @memberof FormDefinitionDynamicSchemaResponse */ 'outputSchema'?: { [key: string]: any; }; } /** * * @export * @interface FormDefinitionFileUploadResponse */ export interface FormDefinitionFileUploadResponse { /** * Created is the date the file was uploaded * @type {string} * @memberof FormDefinitionFileUploadResponse */ 'created'?: string; /** * fileId is a unique ULID that serves as an identifier for the form definition file * @type {string} * @memberof FormDefinitionFileUploadResponse */ 'fileId'?: string; /** * FormDefinitionID is a unique guid identifying this form definition * @type {string} * @memberof FormDefinitionFileUploadResponse */ 'formDefinitionId'?: string; } /** * * @export * @interface FormDefinitionInput */ export interface FormDefinitionInput { /** * Unique identifier for the form input. * @type {string} * @memberof FormDefinitionInput */ 'id'?: string; /** * FormDefinitionInputType value. STRING FormDefinitionInputTypeString * @type {string} * @memberof FormDefinitionInput */ 'type'?: FormDefinitionInputTypeEnum; /** * Name for the form input. * @type {string} * @memberof FormDefinitionInput */ 'label'?: string; /** * Form input\'s description. * @type {string} * @memberof FormDefinitionInput */ 'description'?: string; } export declare const FormDefinitionInputTypeEnum: { readonly String: "STRING"; readonly Array: "ARRAY"; }; export type FormDefinitionInputTypeEnum = typeof FormDefinitionInputTypeEnum[keyof typeof FormDefinitionInputTypeEnum]; /** * * @export * @interface FormDefinitionResponse */ export interface FormDefinitionResponse { /** * Unique guid identifying the form definition. * @type {string} * @memberof FormDefinitionResponse */ 'id'?: string; /** * Name of the form definition. * @type {string} * @memberof FormDefinitionResponse */ 'name'?: string; /** * Form definition\'s description. * @type {string} * @memberof FormDefinitionResponse */ 'description'?: string; /** * * @type {FormOwner} * @memberof FormDefinitionResponse */ 'owner'?: FormOwner; /** * List of objects using the form definition. Whenever a system uses a form, the API reaches out to the form service to record that the system is currently using it. * @type {Array} * @memberof FormDefinitionResponse */ 'usedBy'?: Array; /** * List of form inputs required to create a form-instance object. * @type {Array} * @memberof FormDefinitionResponse */ 'formInput'?: Array; /** * List of nested form elements. * @type {Array} * @memberof FormDefinitionResponse */ 'formElements'?: Array; /** * Conditional logic that can dynamically modify the form as the recipient is interacting with it. * @type {Array} * @memberof FormDefinitionResponse */ 'formConditions'?: Array; /** * Created is the date the form definition was created * @type {string} * @memberof FormDefinitionResponse */ 'created'?: string; /** * Modified is the last date the form definition was modified * @type {string} * @memberof FormDefinitionResponse */ 'modified'?: string; } /** * Self block for imported/exported object. * @export * @interface FormDefinitionSelfImportExportDto */ export interface FormDefinitionSelfImportExportDto { /** * Imported/exported object\'s DTO type. * @type {string} * @memberof FormDefinitionSelfImportExportDto */ 'type'?: FormDefinitionSelfImportExportDtoTypeEnum; /** * Imported/exported object\'s ID. * @type {string} * @memberof FormDefinitionSelfImportExportDto */ 'id'?: string; /** * Imported/exported object\'s display name. * @type {string} * @memberof FormDefinitionSelfImportExportDto */ 'name'?: string; } export declare const FormDefinitionSelfImportExportDtoTypeEnum: { readonly FormDefinition: "FORM_DEFINITION"; }; export type FormDefinitionSelfImportExportDtoTypeEnum = typeof FormDefinitionSelfImportExportDtoTypeEnum[keyof typeof FormDefinitionSelfImportExportDtoTypeEnum]; /** * * @export * @interface FormElement */ export interface FormElement { /** * Form element identifier. * @type {string} * @memberof FormElement */ 'id'?: string; /** * FormElementType value. TEXT FormElementTypeText TOGGLE FormElementTypeToggle TEXTAREA FormElementTypeTextArea HIDDEN FormElementTypeHidden PHONE FormElementTypePhone EMAIL FormElementTypeEmail SELECT FormElementTypeSelect DATE FormElementTypeDate SECTION FormElementTypeSection COLUMN_SET FormElementTypeColumns IMAGE FormElementTypeImage DESCRIPTION FormElementTypeDescription * @type {string} * @memberof FormElement */ 'elementType'?: FormElementElementTypeEnum; /** * Config object. * @type {{ [key: string]: any; }} * @memberof FormElement */ 'config'?: { [key: string]: any; }; /** * Technical key. * @type {string} * @memberof FormElement */ 'key'?: string; /** * * @type {Array} * @memberof FormElement */ 'validations'?: Array | null; } export declare const FormElementElementTypeEnum: { readonly Text: "TEXT"; readonly Toggle: "TOGGLE"; readonly Textarea: "TEXTAREA"; readonly Hidden: "HIDDEN"; readonly Phone: "PHONE"; readonly Email: "EMAIL"; readonly Select: "SELECT"; readonly Date: "DATE"; readonly Section: "SECTION"; readonly ColumnSet: "COLUMN_SET"; readonly Image: "IMAGE"; readonly Description: "DESCRIPTION"; }; export type FormElementElementTypeEnum = typeof FormElementElementTypeEnum[keyof typeof FormElementElementTypeEnum]; /** * * @export * @interface FormElementDataSourceConfigOptions */ export interface FormElementDataSourceConfigOptions { /** * Label is the main label to display to the user when selecting this option * @type {string} * @memberof FormElementDataSourceConfigOptions */ 'label'?: string; /** * SubLabel is the sub label to display below the label in diminutive styling to help describe or identify this option * @type {string} * @memberof FormElementDataSourceConfigOptions */ 'subLabel'?: string; /** * Value is the value to save as an entry when the user selects this option * @type {string} * @memberof FormElementDataSourceConfigOptions */ 'value'?: string; } /** * * @export * @interface FormElementDynamicDataSource */ export interface FormElementDynamicDataSource { /** * * @type {FormElementDynamicDataSourceConfig} * @memberof FormElementDynamicDataSource */ 'config'?: FormElementDynamicDataSourceConfig; /** * DataSourceType is a FormElementDataSourceType value STATIC FormElementDataSourceTypeStatic INTERNAL FormElementDataSourceTypeInternal SEARCH FormElementDataSourceTypeSearch FORM_INPUT FormElementDataSourceTypeFormInput * @type {string} * @memberof FormElementDynamicDataSource */ 'dataSourceType'?: FormElementDynamicDataSourceDataSourceTypeEnum; } export declare const FormElementDynamicDataSourceDataSourceTypeEnum: { readonly Static: "STATIC"; readonly Internal: "INTERNAL"; readonly Search: "SEARCH"; readonly FormInput: "FORM_INPUT"; }; export type FormElementDynamicDataSourceDataSourceTypeEnum = typeof FormElementDynamicDataSourceDataSourceTypeEnum[keyof typeof FormElementDynamicDataSourceDataSourceTypeEnum]; /** * * @export * @interface FormElementDynamicDataSourceConfig */ export interface FormElementDynamicDataSourceConfig { /** * AggregationBucketField is the aggregation bucket field name * @type {string} * @memberof FormElementDynamicDataSourceConfig */ 'aggregationBucketField'?: string; /** * Indices is a list of indices to use * @type {Array} * @memberof FormElementDynamicDataSourceConfig */ 'indices'?: Array; /** * ObjectType is a PreDefinedSelectOption value IDENTITY PreDefinedSelectOptionIdentity ACCESS_PROFILE PreDefinedSelectOptionAccessProfile SOURCES PreDefinedSelectOptionSources ROLE PreDefinedSelectOptionRole ENTITLEMENT PreDefinedSelectOptionEntitlement * @type {string} * @memberof FormElementDynamicDataSourceConfig */ 'objectType'?: FormElementDynamicDataSourceConfigObjectTypeEnum; /** * Query is a text * @type {string} * @memberof FormElementDynamicDataSourceConfig */ 'query'?: string; } export declare const FormElementDynamicDataSourceConfigIndicesEnum: { readonly Accessprofiles: "accessprofiles"; readonly Accountactivities: "accountactivities"; readonly Entitlements: "entitlements"; readonly Identities: "identities"; readonly Events: "events"; readonly Roles: "roles"; readonly Star: "*"; }; export type FormElementDynamicDataSourceConfigIndicesEnum = typeof FormElementDynamicDataSourceConfigIndicesEnum[keyof typeof FormElementDynamicDataSourceConfigIndicesEnum]; export declare const FormElementDynamicDataSourceConfigObjectTypeEnum: { readonly Identity: "IDENTITY"; readonly AccessProfile: "ACCESS_PROFILE"; readonly Sources: "SOURCES"; readonly Role: "ROLE"; readonly Entitlement: "ENTITLEMENT"; }; export type FormElementDynamicDataSourceConfigObjectTypeEnum = typeof FormElementDynamicDataSourceConfigObjectTypeEnum[keyof typeof FormElementDynamicDataSourceConfigObjectTypeEnum]; /** * * @export * @interface FormElementPreviewRequest */ export interface FormElementPreviewRequest { /** * * @type {FormElementDynamicDataSource} * @memberof FormElementPreviewRequest */ 'dataSource'?: FormElementDynamicDataSource; } /** * Set of FormElementValidation items. * @export * @interface FormElementValidationsSet */ export interface FormElementValidationsSet { /** * The type of data validation that you wish to enforce, e.g., a required field, a minimum length, etc. * @type {string} * @memberof FormElementValidationsSet */ 'validationType'?: FormElementValidationsSetValidationTypeEnum; } export declare const FormElementValidationsSetValidationTypeEnum: { readonly Required: "REQUIRED"; readonly MinLength: "MIN_LENGTH"; readonly MaxLength: "MAX_LENGTH"; readonly Regex: "REGEX"; readonly Date: "DATE"; readonly MaxDate: "MAX_DATE"; readonly MinDate: "MIN_DATE"; readonly LessThanDate: "LESS_THAN_DATE"; readonly Phone: "PHONE"; readonly Email: "EMAIL"; readonly DataSource: "DATA_SOURCE"; readonly Textarea: "TEXTAREA"; }; export type FormElementValidationsSetValidationTypeEnum = typeof FormElementValidationsSetValidationTypeEnum[keyof typeof FormElementValidationsSetValidationTypeEnum]; /** * * @export * @interface FormError */ export interface FormError { /** * Key is the technical key * @type {string} * @memberof FormError */ 'key'?: string; /** * Messages is a list of web.ErrorMessage items * @type {Array} * @memberof FormError */ 'messages'?: Array; /** * Value is the value associated with a Key * @type {any} * @memberof FormError */ 'value'?: any; } /** * * @export * @interface FormInstanceCreatedBy */ export interface FormInstanceCreatedBy { /** * ID is a unique identifier * @type {string} * @memberof FormInstanceCreatedBy */ 'id'?: string; /** * Type is a form instance created by type enum value WORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution SOURCE FormInstanceCreatedByTypeSource * @type {string} * @memberof FormInstanceCreatedBy */ 'type'?: FormInstanceCreatedByTypeEnum; } export declare const FormInstanceCreatedByTypeEnum: { readonly WorkflowExecution: "WORKFLOW_EXECUTION"; readonly Source: "SOURCE"; }; export type FormInstanceCreatedByTypeEnum = typeof FormInstanceCreatedByTypeEnum[keyof typeof FormInstanceCreatedByTypeEnum]; /** * * @export * @interface FormInstanceRecipient */ export interface FormInstanceRecipient { /** * ID is a unique identifier * @type {string} * @memberof FormInstanceRecipient */ 'id'?: string; /** * Type is a FormInstanceRecipientType value IDENTITY FormInstanceRecipientIdentity * @type {string} * @memberof FormInstanceRecipient */ 'type'?: FormInstanceRecipientTypeEnum; } export declare const FormInstanceRecipientTypeEnum: { readonly Identity: "IDENTITY"; }; export type FormInstanceRecipientTypeEnum = typeof FormInstanceRecipientTypeEnum[keyof typeof FormInstanceRecipientTypeEnum]; /** * * @export * @interface FormInstanceResponse */ export interface FormInstanceResponse { /** * Unique guid identifying this form instance * @type {string} * @memberof FormInstanceResponse */ 'id'?: string; /** * Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record * @type {string} * @memberof FormInstanceResponse */ 'expire'?: string; /** * State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled * @type {string} * @memberof FormInstanceResponse */ 'state'?: FormInstanceResponseStateEnum; /** * StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form * @type {boolean} * @memberof FormInstanceResponse */ 'standAloneForm'?: boolean; /** * StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI * @type {string} * @memberof FormInstanceResponse */ 'standAloneFormUrl'?: string; /** * * @type {FormInstanceCreatedBy} * @memberof FormInstanceResponse */ 'createdBy'?: FormInstanceCreatedBy; /** * FormDefinitionID is the id of the form definition that created this form * @type {string} * @memberof FormInstanceResponse */ 'formDefinitionId'?: string; /** * FormInput is an object of form input labels to value * @type {{ [key: string]: any; }} * @memberof FormInstanceResponse */ 'formInput'?: { [key: string]: any; } | null; /** * FormElements is the configuration of the form, this would be a repeat of the fields from the form-config * @type {Array} * @memberof FormInstanceResponse */ 'formElements'?: Array; /** * FormData is the data provided by the form on submit. The data is in a key -> value map * @type {{ [key: string]: any; }} * @memberof FormInstanceResponse */ 'formData'?: { [key: string]: any; } | null; /** * FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors * @type {Array} * @memberof FormInstanceResponse */ 'formErrors'?: Array; /** * FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form * @type {Array} * @memberof FormInstanceResponse */ 'formConditions'?: Array; /** * Created is the date the form instance was assigned * @type {string} * @memberof FormInstanceResponse */ 'created'?: string; /** * Modified is the last date the form instance was modified * @type {string} * @memberof FormInstanceResponse */ 'modified'?: string; /** * Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it * @type {Array} * @memberof FormInstanceResponse */ 'recipients'?: Array; } export declare const FormInstanceResponseStateEnum: { readonly Assigned: "ASSIGNED"; readonly InProgress: "IN_PROGRESS"; readonly Submitted: "SUBMITTED"; readonly Completed: "COMPLETED"; readonly Cancelled: "CANCELLED"; }; export type FormInstanceResponseStateEnum = typeof FormInstanceResponseStateEnum[keyof typeof FormInstanceResponseStateEnum]; /** * * @export * @interface FormOwner */ export interface FormOwner { /** * FormOwnerType value. IDENTITY FormOwnerTypeIdentity * @type {string} * @memberof FormOwner */ 'type'?: FormOwnerTypeEnum; /** * Unique identifier of the form\'s owner. * @type {string} * @memberof FormOwner */ 'id'?: string; /** * Name of the form\'s owner. * @type {string} * @memberof FormOwner */ 'name'?: string; } export declare const FormOwnerTypeEnum: { readonly Identity: "IDENTITY"; }; export type FormOwnerTypeEnum = typeof FormOwnerTypeEnum[keyof typeof FormOwnerTypeEnum]; /** * * @export * @interface FormUsedBy */ export interface FormUsedBy { /** * FormUsedByType value. WORKFLOW FormUsedByTypeWorkflow SOURCE FormUsedByTypeSource MySailPoint FormUsedByType * @type {string} * @memberof FormUsedBy */ 'type'?: FormUsedByTypeEnum; /** * Unique identifier of the system using the form. * @type {string} * @memberof FormUsedBy */ 'id'?: string; /** * Name of the system using the form. * @type {string} * @memberof FormUsedBy */ 'name'?: string; } export declare const FormUsedByTypeEnum: { readonly Workflow: "WORKFLOW"; readonly Source: "SOURCE"; readonly MySailPoint: "MySailPoint"; }; export type FormUsedByTypeEnum = typeof FormUsedByTypeEnum[keyof typeof FormUsedByTypeEnum]; /** * * @export * @interface ImportFormDefinitionsV1202Response */ export interface ImportFormDefinitionsV1202Response { /** * * @type {Array} * @memberof ImportFormDefinitionsV1202Response */ 'errors'?: Array; /** * * @type {Array} * @memberof ImportFormDefinitionsV1202Response */ 'importedObjects'?: Array; /** * * @type {Array} * @memberof ImportFormDefinitionsV1202Response */ 'infos'?: Array; /** * * @type {Array} * @memberof ImportFormDefinitionsV1202Response */ 'warnings'?: Array; } /** * * @export * @interface ImportFormDefinitionsV1202ResponseErrorsInner */ export interface ImportFormDefinitionsV1202ResponseErrorsInner { /** * * @type {{ [key: string]: object; }} * @memberof ImportFormDefinitionsV1202ResponseErrorsInner */ 'detail'?: { [key: string]: object; }; /** * * @type {string} * @memberof ImportFormDefinitionsV1202ResponseErrorsInner */ 'key'?: string; /** * * @type {string} * @memberof ImportFormDefinitionsV1202ResponseErrorsInner */ 'text'?: string; } /** * * @export * @interface ImportFormDefinitionsV1RequestInner */ export interface ImportFormDefinitionsV1RequestInner { /** * * @type {FormDefinitionResponse} * @memberof ImportFormDefinitionsV1RequestInner */ 'object'?: FormDefinitionResponse; /** * * @type {string} * @memberof ImportFormDefinitionsV1RequestInner */ 'self'?: string; /** * * @type {number} * @memberof ImportFormDefinitionsV1RequestInner */ 'version'?: number; } /** * * @export * @interface ListFormDefinitionsByTenantResponse */ export interface ListFormDefinitionsByTenantResponse { /** * Count number of results. * @type {number} * @memberof ListFormDefinitionsByTenantResponse */ 'count'?: number; /** * List of FormDefinitionResponse items. * @type {Array} * @memberof ListFormDefinitionsByTenantResponse */ 'results'?: Array; } /** * * @export * @interface ListFormElementDataByElementIDResponse */ export interface ListFormElementDataByElementIDResponse { /** * Results holds a list of FormElementDataSourceConfigOptions items * @type {Array} * @memberof ListFormElementDataByElementIDResponse */ 'results'?: Array; } /** * List of FormInstanceResponse items * @export * @interface ListFormInstancesByTenantResponse */ export interface ListFormInstancesByTenantResponse { /** * Unique guid identifying this form instance * @type {string} * @memberof ListFormInstancesByTenantResponse */ 'id'?: string; /** * Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record * @type {string} * @memberof ListFormInstancesByTenantResponse */ 'expire'?: string; /** * State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled * @type {string} * @memberof ListFormInstancesByTenantResponse */ 'state'?: ListFormInstancesByTenantResponseStateEnum; /** * StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form * @type {boolean} * @memberof ListFormInstancesByTenantResponse */ 'standAloneForm'?: boolean; /** * StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI * @type {string} * @memberof ListFormInstancesByTenantResponse */ 'standAloneFormUrl'?: string; /** * * @type {FormInstanceCreatedBy} * @memberof ListFormInstancesByTenantResponse */ 'createdBy'?: FormInstanceCreatedBy; /** * FormDefinitionID is the id of the form definition that created this form * @type {string} * @memberof ListFormInstancesByTenantResponse */ 'formDefinitionId'?: string; /** * FormInput is an object of form input labels to value * @type {{ [key: string]: any; }} * @memberof ListFormInstancesByTenantResponse */ 'formInput'?: { [key: string]: any; } | null; /** * FormElements is the configuration of the form, this would be a repeat of the fields from the form-config * @type {Array} * @memberof ListFormInstancesByTenantResponse */ 'formElements'?: Array; /** * FormData is the data provided by the form on submit. The data is in a key -> value map * @type {{ [key: string]: any; }} * @memberof ListFormInstancesByTenantResponse */ 'formData'?: { [key: string]: any; } | null; /** * FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors * @type {Array} * @memberof ListFormInstancesByTenantResponse */ 'formErrors'?: Array; /** * FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form * @type {Array} * @memberof ListFormInstancesByTenantResponse */ 'formConditions'?: Array; /** * Created is the date the form instance was assigned * @type {string} * @memberof ListFormInstancesByTenantResponse */ 'created'?: string; /** * Modified is the last date the form instance was modified * @type {string} * @memberof ListFormInstancesByTenantResponse */ 'modified'?: string; /** * Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it * @type {Array} * @memberof ListFormInstancesByTenantResponse */ 'recipients'?: Array; } export declare const ListFormInstancesByTenantResponseStateEnum: { readonly Assigned: "ASSIGNED"; readonly InProgress: "IN_PROGRESS"; readonly Submitted: "SUBMITTED"; readonly Completed: "COMPLETED"; readonly Cancelled: "CANCELLED"; }; export type ListFormInstancesByTenantResponseStateEnum = typeof ListFormInstancesByTenantResponseStateEnum[keyof typeof ListFormInstancesByTenantResponseStateEnum]; /** * * @export * @interface ListPredefinedSelectOptionsResponse */ export interface ListPredefinedSelectOptionsResponse { /** * Results holds a list of PreDefinedSelectOption items * @type {Array} * @memberof ListPredefinedSelectOptionsResponse */ 'results'?: Array; } /** * * @export * @interface ModelError */ export interface ModelError { /** * DetailCode is the text of the status code returned * @type {string} * @memberof ModelError */ 'detailCode'?: string; /** * * @type {Array} * @memberof ModelError */ 'messages'?: Array; /** * TrackingID is the request tracking unique identifier * @type {string} * @memberof ModelError */ 'trackingId'?: string; } /** * PreviewDataSourceResponse is the response sent by `/form-definitions/{formDefinitionID}/data-source` endpoint * @export * @interface PreviewDataSourceResponse */ export interface PreviewDataSourceResponse { /** * Results holds a list of FormElementDataSourceConfigOptions items * @type {Array} * @memberof PreviewDataSourceResponse */ 'results'?: Array; } /** * * @export * @interface SearchFormDefinitionsByTenantV1400Response */ export interface SearchFormDefinitionsByTenantV1400Response { /** * * @type {string} * @memberof SearchFormDefinitionsByTenantV1400Response */ 'detailCode'?: string; /** * * @type {Array} * @memberof SearchFormDefinitionsByTenantV1400Response */ 'messages'?: Array; /** * * @type {number} * @memberof SearchFormDefinitionsByTenantV1400Response */ 'statusCode'?: number; /** * * @type {string} * @memberof SearchFormDefinitionsByTenantV1400Response */ 'trackingId'?: string; } /** * CustomFormsApi - axios parameter creator * @export */ export declare const CustomFormsApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Generate json schema dynamically. * @param {FormDefinitionDynamicSchemaRequest} [body] Body is the request payload to create a form definition dynamic schema * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createFormDefinitionDynamicSchemaV1: (body?: FormDefinitionDynamicSchemaRequest, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Parameter `{formDefinitionID}` should match a form definition ID. * @summary Upload new form definition file. * @param {string} formDefinitionID FormDefinitionID String specifying FormDefinitionID * @param {File} file File specifying the multipart * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createFormDefinitionFileRequestV1: (formDefinitionID: string, file: File, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * * @summary Creates a form definition. * @param {CreateFormDefinitionRequest} [body] Body is the request payload to create form definition request * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createFormDefinitionV1: (body?: CreateFormDefinitionRequest, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * * @summary Creates a form instance. * @param {CreateFormInstanceRequest} [body] Body is the request payload to create a form instance * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createFormInstanceV1: (body?: CreateFormInstanceRequest, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Parameter `{formDefinitionID}` should match a form definition ID. * @summary Deletes a form definition. * @param {string} formDefinitionID Form definition ID * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteFormDefinitionV1: (formDefinitionID: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * No parameters required. * @summary List form definitions by tenant. * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. * @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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ exportFormDefinitionsByTenantV1: (offset?: number, limit?: number, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * * @summary Download definition file by fileid. * @param {string} formDefinitionID FormDefinitionID Form definition ID * @param {string} fileID FileID String specifying the hashed name of the uploaded file we are retrieving. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFileFromS3V1: (formDefinitionID: string, fileID: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Parameter `{formDefinitionID}` should match a form definition ID. * @summary Return a form definition. * @param {string} formDefinitionID Form definition ID * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFormDefinitionByKeyV1: (formDefinitionID: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. * @summary Returns a form instance. * @param {string} formInstanceID Form instance ID * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFormInstanceByKeyV1: (formInstanceID: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * * @summary Download instance file by fileid. * @param {string} formInstanceID FormInstanceID Form instance ID * @param {string} fileID FileID String specifying the hashed name of the uploaded file we are retrieving. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFormInstanceFileV1: (formInstanceID: string, fileID: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * * @summary Import form definitions from export. * @param {Array} [body] Body is the request payload to import form definitions * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importFormDefinitionsV1: (body?: Array, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Parameter `{formDefinitionID}` should match a form definition ID. * @summary Patch a form definition. * @param {string} formDefinitionID Form definition ID * @param {Array<{ [key: string]: object; }>} [body] Body is the request payload to patch a form definition, check: https://jsonpatch.com * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchFormDefinitionV1: (formDefinitionID: string, body?: { [key: string]: object; }[], axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. * @summary Patch a form instance. * @param {string} formInstanceID Form instance ID * @param {Array<{ [key: string]: object; }>} [body] Body is the request payload to patch a form instance, check: https://jsonpatch.com * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchFormInstanceV1: (formInstanceID: string, body?: { [key: string]: object; }[], axiosOptions?: RawAxiosRequestConfig) => Promise; /** * No parameters required. * @summary Export form definitions by tenant. * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. * @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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ searchFormDefinitionsByTenantV1: (offset?: number, limit?: number, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formElementID}` should match a form element ID at the data source configuration. * @summary Retrieves dynamic data by element. * @param {string} formInstanceID Form instance ID * @param {string} formElementID Form element ID * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. * @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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` * @param {string} [query] String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ searchFormElementDataByElementIDV1: (formInstanceID: string, formElementID: string, limit?: number, filters?: string, query?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Returns a list of form instances for the tenant. Optionally filter by form definition ID. * @summary List form instances by tenant. * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. * @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: **formDefinitionId**: *eq* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ searchFormInstancesByTenantV1: (offset?: number, limit?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * No parameters required. * @summary List predefined select options. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ searchPreDefinedSelectOptionsV1: (axiosOptions?: RawAxiosRequestConfig) => Promise; /** * * @summary Preview form definition data source. * @param {string} formDefinitionID Form definition ID * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. * @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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` * @param {string} [query] String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. * @param {FormElementPreviewRequest} [formElementPreviewRequest] Body is the request payload to create a form definition dynamic schema * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ showPreviewDataSourceV1: (formDefinitionID: string, limit?: number, filters?: string, query?: string, formElementPreviewRequest?: FormElementPreviewRequest, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * CustomFormsApi - functional programming interface * @export */ export declare const CustomFormsApiFp: (configuration?: Configuration) => { /** * * @summary Generate json schema dynamically. * @param {FormDefinitionDynamicSchemaRequest} [body] Body is the request payload to create a form definition dynamic schema * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createFormDefinitionDynamicSchemaV1(body?: FormDefinitionDynamicSchemaRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Parameter `{formDefinitionID}` should match a form definition ID. * @summary Upload new form definition file. * @param {string} formDefinitionID FormDefinitionID String specifying FormDefinitionID * @param {File} file File specifying the multipart * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createFormDefinitionFileRequestV1(formDefinitionID: string, file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Creates a form definition. * @param {CreateFormDefinitionRequest} [body] Body is the request payload to create form definition request * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createFormDefinitionV1(body?: CreateFormDefinitionRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Creates a form instance. * @param {CreateFormInstanceRequest} [body] Body is the request payload to create a form instance * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createFormInstanceV1(body?: CreateFormInstanceRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Parameter `{formDefinitionID}` should match a form definition ID. * @summary Deletes a form definition. * @param {string} formDefinitionID Form definition ID * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteFormDefinitionV1(formDefinitionID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * No parameters required. * @summary List form definitions by tenant. * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. * @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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ exportFormDefinitionsByTenantV1(offset?: number, limit?: number, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * * @summary Download definition file by fileid. * @param {string} formDefinitionID FormDefinitionID Form definition ID * @param {string} fileID FileID String specifying the hashed name of the uploaded file we are retrieving. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFileFromS3V1(formDefinitionID: string, fileID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Parameter `{formDefinitionID}` should match a form definition ID. * @summary Return a form definition. * @param {string} formDefinitionID Form definition ID * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFormDefinitionByKeyV1(formDefinitionID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. * @summary Returns a form instance. * @param {string} formInstanceID Form instance ID * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFormInstanceByKeyV1(formInstanceID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Download instance file by fileid. * @param {string} formInstanceID FormInstanceID Form instance ID * @param {string} fileID FileID String specifying the hashed name of the uploaded file we are retrieving. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFormInstanceFileV1(formInstanceID: string, fileID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Import form definitions from export. * @param {Array} [body] Body is the request payload to import form definitions * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importFormDefinitionsV1(body?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Parameter `{formDefinitionID}` should match a form definition ID. * @summary Patch a form definition. * @param {string} formDefinitionID Form definition ID * @param {Array<{ [key: string]: object; }>} [body] Body is the request payload to patch a form definition, check: https://jsonpatch.com * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchFormDefinitionV1(formDefinitionID: string, body?: { [key: string]: object; }[], axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. * @summary Patch a form instance. * @param {string} formInstanceID Form instance ID * @param {Array<{ [key: string]: object; }>} [body] Body is the request payload to patch a form instance, check: https://jsonpatch.com * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchFormInstanceV1(formInstanceID: string, body?: { [key: string]: object; }[], axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * No parameters required. * @summary Export form definitions by tenant. * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. * @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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ searchFormDefinitionsByTenantV1(offset?: number, limit?: number, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formElementID}` should match a form element ID at the data source configuration. * @summary Retrieves dynamic data by element. * @param {string} formInstanceID Form instance ID * @param {string} formElementID Form element ID * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. * @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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` * @param {string} [query] String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ searchFormElementDataByElementIDV1(formInstanceID: string, formElementID: string, limit?: number, filters?: string, query?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a list of form instances for the tenant. Optionally filter by form definition ID. * @summary List form instances by tenant. * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. * @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: **formDefinitionId**: *eq* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ searchFormInstancesByTenantV1(offset?: number, limit?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * No parameters required. * @summary List predefined select options. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ searchPreDefinedSelectOptionsV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Preview form definition data source. * @param {string} formDefinitionID Form definition ID * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. * @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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` * @param {string} [query] String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. * @param {FormElementPreviewRequest} [formElementPreviewRequest] Body is the request payload to create a form definition dynamic schema * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ showPreviewDataSourceV1(formDefinitionID: string, limit?: number, filters?: string, query?: string, formElementPreviewRequest?: FormElementPreviewRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CustomFormsApi - factory interface * @export */ export declare const CustomFormsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Generate json schema dynamically. * @param {CustomFormsApiCreateFormDefinitionDynamicSchemaV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createFormDefinitionDynamicSchemaV1(requestParameters?: CustomFormsApiCreateFormDefinitionDynamicSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Parameter `{formDefinitionID}` should match a form definition ID. * @summary Upload new form definition file. * @param {CustomFormsApiCreateFormDefinitionFileRequestV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createFormDefinitionFileRequestV1(requestParameters: CustomFormsApiCreateFormDefinitionFileRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Creates a form definition. * @param {CustomFormsApiCreateFormDefinitionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createFormDefinitionV1(requestParameters?: CustomFormsApiCreateFormDefinitionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Creates a form instance. * @param {CustomFormsApiCreateFormInstanceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createFormInstanceV1(requestParameters?: CustomFormsApiCreateFormInstanceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Parameter `{formDefinitionID}` should match a form definition ID. * @summary Deletes a form definition. * @param {CustomFormsApiDeleteFormDefinitionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteFormDefinitionV1(requestParameters: CustomFormsApiDeleteFormDefinitionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * No parameters required. * @summary List form definitions by tenant. * @param {CustomFormsApiExportFormDefinitionsByTenantV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ exportFormDefinitionsByTenantV1(requestParameters?: CustomFormsApiExportFormDefinitionsByTenantV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * * @summary Download definition file by fileid. * @param {CustomFormsApiGetFileFromS3V1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFileFromS3V1(requestParameters: CustomFormsApiGetFileFromS3V1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Parameter `{formDefinitionID}` should match a form definition ID. * @summary Return a form definition. * @param {CustomFormsApiGetFormDefinitionByKeyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFormDefinitionByKeyV1(requestParameters: CustomFormsApiGetFormDefinitionByKeyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. * @summary Returns a form instance. * @param {CustomFormsApiGetFormInstanceByKeyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFormInstanceByKeyV1(requestParameters: CustomFormsApiGetFormInstanceByKeyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Download instance file by fileid. * @param {CustomFormsApiGetFormInstanceFileV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFormInstanceFileV1(requestParameters: CustomFormsApiGetFormInstanceFileV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Import form definitions from export. * @param {CustomFormsApiImportFormDefinitionsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importFormDefinitionsV1(requestParameters?: CustomFormsApiImportFormDefinitionsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Parameter `{formDefinitionID}` should match a form definition ID. * @summary Patch a form definition. * @param {CustomFormsApiPatchFormDefinitionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchFormDefinitionV1(requestParameters: CustomFormsApiPatchFormDefinitionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. * @summary Patch a form instance. * @param {CustomFormsApiPatchFormInstanceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchFormInstanceV1(requestParameters: CustomFormsApiPatchFormInstanceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * No parameters required. * @summary Export form definitions by tenant. * @param {CustomFormsApiSearchFormDefinitionsByTenantV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ searchFormDefinitionsByTenantV1(requestParameters?: CustomFormsApiSearchFormDefinitionsByTenantV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formElementID}` should match a form element ID at the data source configuration. * @summary Retrieves dynamic data by element. * @param {CustomFormsApiSearchFormElementDataByElementIDV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ searchFormElementDataByElementIDV1(requestParameters: CustomFormsApiSearchFormElementDataByElementIDV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a list of form instances for the tenant. Optionally filter by form definition ID. * @summary List form instances by tenant. * @param {CustomFormsApiSearchFormInstancesByTenantV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ searchFormInstancesByTenantV1(requestParameters?: CustomFormsApiSearchFormInstancesByTenantV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * No parameters required. * @summary List predefined select options. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ searchPreDefinedSelectOptionsV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Preview form definition data source. * @param {CustomFormsApiShowPreviewDataSourceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ showPreviewDataSourceV1(requestParameters: CustomFormsApiShowPreviewDataSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createFormDefinitionDynamicSchemaV1 operation in CustomFormsApi. * @export * @interface CustomFormsApiCreateFormDefinitionDynamicSchemaV1Request */ export interface CustomFormsApiCreateFormDefinitionDynamicSchemaV1Request { /** * Body is the request payload to create a form definition dynamic schema * @type {FormDefinitionDynamicSchemaRequest} * @memberof CustomFormsApiCreateFormDefinitionDynamicSchemaV1 */ readonly body?: FormDefinitionDynamicSchemaRequest; } /** * Request parameters for createFormDefinitionFileRequestV1 operation in CustomFormsApi. * @export * @interface CustomFormsApiCreateFormDefinitionFileRequestV1Request */ export interface CustomFormsApiCreateFormDefinitionFileRequestV1Request { /** * FormDefinitionID String specifying FormDefinitionID * @type {string} * @memberof CustomFormsApiCreateFormDefinitionFileRequestV1 */ readonly formDefinitionID: string; /** * File specifying the multipart * @type {File} * @memberof CustomFormsApiCreateFormDefinitionFileRequestV1 */ readonly file: File; } /** * Request parameters for createFormDefinitionV1 operation in CustomFormsApi. * @export * @interface CustomFormsApiCreateFormDefinitionV1Request */ export interface CustomFormsApiCreateFormDefinitionV1Request { /** * Body is the request payload to create form definition request * @type {CreateFormDefinitionRequest} * @memberof CustomFormsApiCreateFormDefinitionV1 */ readonly body?: CreateFormDefinitionRequest; } /** * Request parameters for createFormInstanceV1 operation in CustomFormsApi. * @export * @interface CustomFormsApiCreateFormInstanceV1Request */ export interface CustomFormsApiCreateFormInstanceV1Request { /** * Body is the request payload to create a form instance * @type {CreateFormInstanceRequest} * @memberof CustomFormsApiCreateFormInstanceV1 */ readonly body?: CreateFormInstanceRequest; } /** * Request parameters for deleteFormDefinitionV1 operation in CustomFormsApi. * @export * @interface CustomFormsApiDeleteFormDefinitionV1Request */ export interface CustomFormsApiDeleteFormDefinitionV1Request { /** * Form definition ID * @type {string} * @memberof CustomFormsApiDeleteFormDefinitionV1 */ readonly formDefinitionID: string; } /** * Request parameters for exportFormDefinitionsByTenantV1 operation in CustomFormsApi. * @export * @interface CustomFormsApiExportFormDefinitionsByTenantV1Request */ export interface CustomFormsApiExportFormDefinitionsByTenantV1Request { /** * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. * @type {number} * @memberof CustomFormsApiExportFormDefinitionsByTenantV1 */ readonly offset?: number; /** * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. * @type {number} * @memberof CustomFormsApiExportFormDefinitionsByTenantV1 */ readonly limit?: number; /** * 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* * @type {string} * @memberof CustomFormsApiExportFormDefinitionsByTenantV1 */ readonly filters?: string; /** * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** * @type {string} * @memberof CustomFormsApiExportFormDefinitionsByTenantV1 */ readonly sorters?: string; } /** * Request parameters for getFileFromS3V1 operation in CustomFormsApi. * @export * @interface CustomFormsApiGetFileFromS3V1Request */ export interface CustomFormsApiGetFileFromS3V1Request { /** * FormDefinitionID Form definition ID * @type {string} * @memberof CustomFormsApiGetFileFromS3V1 */ readonly formDefinitionID: string; /** * FileID String specifying the hashed name of the uploaded file we are retrieving. * @type {string} * @memberof CustomFormsApiGetFileFromS3V1 */ readonly fileID: string; } /** * Request parameters for getFormDefinitionByKeyV1 operation in CustomFormsApi. * @export * @interface CustomFormsApiGetFormDefinitionByKeyV1Request */ export interface CustomFormsApiGetFormDefinitionByKeyV1Request { /** * Form definition ID * @type {string} * @memberof CustomFormsApiGetFormDefinitionByKeyV1 */ readonly formDefinitionID: string; } /** * Request parameters for getFormInstanceByKeyV1 operation in CustomFormsApi. * @export * @interface CustomFormsApiGetFormInstanceByKeyV1Request */ export interface CustomFormsApiGetFormInstanceByKeyV1Request { /** * Form instance ID * @type {string} * @memberof CustomFormsApiGetFormInstanceByKeyV1 */ readonly formInstanceID: string; } /** * Request parameters for getFormInstanceFileV1 operation in CustomFormsApi. * @export * @interface CustomFormsApiGetFormInstanceFileV1Request */ export interface CustomFormsApiGetFormInstanceFileV1Request { /** * FormInstanceID Form instance ID * @type {string} * @memberof CustomFormsApiGetFormInstanceFileV1 */ readonly formInstanceID: string; /** * FileID String specifying the hashed name of the uploaded file we are retrieving. * @type {string} * @memberof CustomFormsApiGetFormInstanceFileV1 */ readonly fileID: string; } /** * Request parameters for importFormDefinitionsV1 operation in CustomFormsApi. * @export * @interface CustomFormsApiImportFormDefinitionsV1Request */ export interface CustomFormsApiImportFormDefinitionsV1Request { /** * Body is the request payload to import form definitions * @type {Array} * @memberof CustomFormsApiImportFormDefinitionsV1 */ readonly body?: Array; } /** * Request parameters for patchFormDefinitionV1 operation in CustomFormsApi. * @export * @interface CustomFormsApiPatchFormDefinitionV1Request */ export interface CustomFormsApiPatchFormDefinitionV1Request { /** * Form definition ID * @type {string} * @memberof CustomFormsApiPatchFormDefinitionV1 */ readonly formDefinitionID: string; /** * Body is the request payload to patch a form definition, check: https://jsonpatch.com * @type {Array<{ [key: string]: object; }>} * @memberof CustomFormsApiPatchFormDefinitionV1 */ readonly body?: Array<{ [key: string]: object; }>; } /** * Request parameters for patchFormInstanceV1 operation in CustomFormsApi. * @export * @interface CustomFormsApiPatchFormInstanceV1Request */ export interface CustomFormsApiPatchFormInstanceV1Request { /** * Form instance ID * @type {string} * @memberof CustomFormsApiPatchFormInstanceV1 */ readonly formInstanceID: string; /** * Body is the request payload to patch a form instance, check: https://jsonpatch.com * @type {Array<{ [key: string]: object; }>} * @memberof CustomFormsApiPatchFormInstanceV1 */ readonly body?: Array<{ [key: string]: object; }>; } /** * Request parameters for searchFormDefinitionsByTenantV1 operation in CustomFormsApi. * @export * @interface CustomFormsApiSearchFormDefinitionsByTenantV1Request */ export interface CustomFormsApiSearchFormDefinitionsByTenantV1Request { /** * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. * @type {number} * @memberof CustomFormsApiSearchFormDefinitionsByTenantV1 */ readonly offset?: number; /** * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. * @type {number} * @memberof CustomFormsApiSearchFormDefinitionsByTenantV1 */ readonly limit?: number; /** * 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* * @type {string} * @memberof CustomFormsApiSearchFormDefinitionsByTenantV1 */ readonly filters?: string; /** * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** * @type {string} * @memberof CustomFormsApiSearchFormDefinitionsByTenantV1 */ readonly sorters?: string; } /** * Request parameters for searchFormElementDataByElementIDV1 operation in CustomFormsApi. * @export * @interface CustomFormsApiSearchFormElementDataByElementIDV1Request */ export interface CustomFormsApiSearchFormElementDataByElementIDV1Request { /** * Form instance ID * @type {string} * @memberof CustomFormsApiSearchFormElementDataByElementIDV1 */ readonly formInstanceID: string; /** * Form element ID * @type {string} * @memberof CustomFormsApiSearchFormElementDataByElementIDV1 */ readonly formElementID: string; /** * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. * @type {number} * @memberof CustomFormsApiSearchFormElementDataByElementIDV1 */ readonly limit?: number; /** * 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` * @type {string} * @memberof CustomFormsApiSearchFormElementDataByElementIDV1 */ readonly filters?: string; /** * String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. * @type {string} * @memberof CustomFormsApiSearchFormElementDataByElementIDV1 */ readonly query?: string; } /** * Request parameters for searchFormInstancesByTenantV1 operation in CustomFormsApi. * @export * @interface CustomFormsApiSearchFormInstancesByTenantV1Request */ export interface CustomFormsApiSearchFormInstancesByTenantV1Request { /** * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. * @type {number} * @memberof CustomFormsApiSearchFormInstancesByTenantV1 */ readonly offset?: number; /** * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. * @type {number} * @memberof CustomFormsApiSearchFormInstancesByTenantV1 */ readonly limit?: number; /** * 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: **formDefinitionId**: *eq* * @type {string} * @memberof CustomFormsApiSearchFormInstancesByTenantV1 */ readonly filters?: string; } /** * Request parameters for showPreviewDataSourceV1 operation in CustomFormsApi. * @export * @interface CustomFormsApiShowPreviewDataSourceV1Request */ export interface CustomFormsApiShowPreviewDataSourceV1Request { /** * Form definition ID * @type {string} * @memberof CustomFormsApiShowPreviewDataSourceV1 */ readonly formDefinitionID: string; /** * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. * @type {number} * @memberof CustomFormsApiShowPreviewDataSourceV1 */ readonly limit?: number; /** * 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` * @type {string} * @memberof CustomFormsApiShowPreviewDataSourceV1 */ readonly filters?: string; /** * String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. * @type {string} * @memberof CustomFormsApiShowPreviewDataSourceV1 */ readonly query?: string; /** * Body is the request payload to create a form definition dynamic schema * @type {FormElementPreviewRequest} * @memberof CustomFormsApiShowPreviewDataSourceV1 */ readonly formElementPreviewRequest?: FormElementPreviewRequest; } /** * CustomFormsApi - object-oriented interface * @export * @class CustomFormsApi * @extends {BaseAPI} */ export declare class CustomFormsApi extends BaseAPI { /** * * @summary Generate json schema dynamically. * @param {CustomFormsApiCreateFormDefinitionDynamicSchemaV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomFormsApi */ createFormDefinitionDynamicSchemaV1(requestParameters?: CustomFormsApiCreateFormDefinitionDynamicSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Parameter `{formDefinitionID}` should match a form definition ID. * @summary Upload new form definition file. * @param {CustomFormsApiCreateFormDefinitionFileRequestV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomFormsApi */ createFormDefinitionFileRequestV1(requestParameters: CustomFormsApiCreateFormDefinitionFileRequestV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * * @summary Creates a form definition. * @param {CustomFormsApiCreateFormDefinitionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomFormsApi */ createFormDefinitionV1(requestParameters?: CustomFormsApiCreateFormDefinitionV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * * @summary Creates a form instance. * @param {CustomFormsApiCreateFormInstanceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomFormsApi */ createFormInstanceV1(requestParameters?: CustomFormsApiCreateFormInstanceV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Parameter `{formDefinitionID}` should match a form definition ID. * @summary Deletes a form definition. * @param {CustomFormsApiDeleteFormDefinitionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomFormsApi */ deleteFormDefinitionV1(requestParameters: CustomFormsApiDeleteFormDefinitionV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * No parameters required. * @summary List form definitions by tenant. * @param {CustomFormsApiExportFormDefinitionsByTenantV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomFormsApi */ exportFormDefinitionsByTenantV1(requestParameters?: CustomFormsApiExportFormDefinitionsByTenantV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * * @summary Download definition file by fileid. * @param {CustomFormsApiGetFileFromS3V1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomFormsApi */ getFileFromS3V1(requestParameters: CustomFormsApiGetFileFromS3V1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Parameter `{formDefinitionID}` should match a form definition ID. * @summary Return a form definition. * @param {CustomFormsApiGetFormDefinitionByKeyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomFormsApi */ getFormDefinitionByKeyV1(requestParameters: CustomFormsApiGetFormDefinitionByKeyV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. * @summary Returns a form instance. * @param {CustomFormsApiGetFormInstanceByKeyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomFormsApi */ getFormInstanceByKeyV1(requestParameters: CustomFormsApiGetFormInstanceByKeyV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * * @summary Download instance file by fileid. * @param {CustomFormsApiGetFormInstanceFileV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomFormsApi */ getFormInstanceFileV1(requestParameters: CustomFormsApiGetFormInstanceFileV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * * @summary Import form definitions from export. * @param {CustomFormsApiImportFormDefinitionsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomFormsApi */ importFormDefinitionsV1(requestParameters?: CustomFormsApiImportFormDefinitionsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Parameter `{formDefinitionID}` should match a form definition ID. * @summary Patch a form definition. * @param {CustomFormsApiPatchFormDefinitionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomFormsApi */ patchFormDefinitionV1(requestParameters: CustomFormsApiPatchFormDefinitionV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. * @summary Patch a form instance. * @param {CustomFormsApiPatchFormInstanceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomFormsApi */ patchFormInstanceV1(requestParameters: CustomFormsApiPatchFormInstanceV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * No parameters required. * @summary Export form definitions by tenant. * @param {CustomFormsApiSearchFormDefinitionsByTenantV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomFormsApi */ searchFormDefinitionsByTenantV1(requestParameters?: CustomFormsApiSearchFormDefinitionsByTenantV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formElementID}` should match a form element ID at the data source configuration. * @summary Retrieves dynamic data by element. * @param {CustomFormsApiSearchFormElementDataByElementIDV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomFormsApi */ searchFormElementDataByElementIDV1(requestParameters: CustomFormsApiSearchFormElementDataByElementIDV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Returns a list of form instances for the tenant. Optionally filter by form definition ID. * @summary List form instances by tenant. * @param {CustomFormsApiSearchFormInstancesByTenantV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomFormsApi */ searchFormInstancesByTenantV1(requestParameters?: CustomFormsApiSearchFormInstancesByTenantV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * No parameters required. * @summary List predefined select options. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomFormsApi */ searchPreDefinedSelectOptionsV1(axiosOptions?: RawAxiosRequestConfig): Promise>; /** * * @summary Preview form definition data source. * @param {CustomFormsApiShowPreviewDataSourceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CustomFormsApi */ showPreviewDataSourceV1(requestParameters: CustomFormsApiShowPreviewDataSourceV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; }