diff --git a/api_beta/api/openapi.yaml b/api_beta/api/openapi.yaml index 053846182..88d163634 100644 --- a/api_beta/api/openapi.yaml +++ b/api_beta/api/openapi.yaml @@ -73522,16 +73522,16 @@ components: formElements: - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department key: department - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department @@ -73609,16 +73609,16 @@ components: formElements: - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department key: department - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department @@ -73761,16 +73761,16 @@ components: formElements: - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department key: department - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department @@ -73899,16 +73899,16 @@ components: formElements: - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department key: department - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department @@ -74274,16 +74274,16 @@ components: formElements: - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department key: department - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department @@ -74314,12 +74314,12 @@ components: type: array x-go-name: FormConditions formData: - additionalProperties: - type: object + additionalProperties: true description: FormData is the data provided by the form on submit. The data is in a key -> value map example: department: Engineering + nullable: true type: object x-go-name: FormData formDefinitionId: @@ -80994,8 +80994,8 @@ components: example: id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department @@ -81029,8 +81029,7 @@ components: type: string x-go-name: ElementType config: - additionalProperties: - type: object + additionalProperties: true description: Config object. example: label: Department @@ -82721,7 +82720,7 @@ components: value: description: Based on the ValueType. example: Engineering - type: object + type: string x-go-name: Value type: object x-go-package: github.com/sailpoint/sp-forms/domain @@ -82775,9 +82774,11 @@ components: FormElementValidationsSet: description: Set of FormElementValidation items. example: - - validationType: REQUIRED + validationType: REQUIRED properties: validationType: + description: "The type of data validation that you wish to enforce, e.g.,\ + \ a required field, a minimum length, etc." enum: - REQUIRED - MIN_LENGTH @@ -82791,6 +82792,7 @@ components: - EMAIL - DATA_SOURCE - TEXTAREA + example: REQUIRED type: string type: object x-go-package: github.com/sailpoint/sp-forms/domain @@ -83812,16 +83814,16 @@ components: formElements: - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department key: department - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department @@ -83947,16 +83949,16 @@ components: formElements: - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department key: department - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department @@ -84040,16 +84042,16 @@ components: formElements: - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department key: department - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department diff --git a/api_beta/docs/ConditionRule.md b/api_beta/docs/ConditionRule.md index 442a81f1f..bc6745365 100644 --- a/api_beta/docs/ConditionRule.md +++ b/api_beta/docs/ConditionRule.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **Source** | Pointer to **string** | 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. | [optional] **Operator** | Pointer to **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 | [optional] **ValueType** | Pointer to **string** | 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 | [optional] -**Value** | Pointer to **map[string]interface{}** | Based on the ValueType. | [optional] +**Value** | Pointer to **string** | Based on the ValueType. | [optional] ## Methods @@ -131,20 +131,20 @@ HasValueType returns a boolean if a field has been set. ### GetValue -`func (o *ConditionRule) GetValue() map[string]interface{}` +`func (o *ConditionRule) GetValue() string` GetValue returns the Value field if non-nil, zero value otherwise. ### GetValueOk -`func (o *ConditionRule) GetValueOk() (*map[string]interface{}, bool)` +`func (o *ConditionRule) GetValueOk() (*string, bool)` GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetValue -`func (o *ConditionRule) SetValue(v map[string]interface{})` +`func (o *ConditionRule) SetValue(v string)` SetValue sets Value field to given value. diff --git a/api_beta/docs/FormElement.md b/api_beta/docs/FormElement.md index 7fdd5ca83..d3269bc3d 100644 --- a/api_beta/docs/FormElement.md +++ b/api_beta/docs/FormElement.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Id** | Pointer to **string** | Form element identifier. | [optional] **ElementType** | Pointer to **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 | [optional] -**Config** | Pointer to **map[string]map[string]interface{}** | Config object. | [optional] +**Config** | Pointer to **map[string]interface{}** | Config object. | [optional] **Key** | Pointer to **string** | Technical key. | [optional] **Validations** | Pointer to [**[]FormElementValidationsSet**](FormElementValidationsSet.md) | | [optional] @@ -81,20 +81,20 @@ HasElementType returns a boolean if a field has been set. ### GetConfig -`func (o *FormElement) GetConfig() map[string]map[string]interface{}` +`func (o *FormElement) GetConfig() map[string]interface{}` GetConfig returns the Config field if non-nil, zero value otherwise. ### GetConfigOk -`func (o *FormElement) GetConfigOk() (*map[string]map[string]interface{}, bool)` +`func (o *FormElement) GetConfigOk() (*map[string]interface{}, bool)` GetConfigOk returns a tuple with the Config field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetConfig -`func (o *FormElement) SetConfig(v map[string]map[string]interface{})` +`func (o *FormElement) SetConfig(v map[string]interface{})` SetConfig sets Config field to given value. diff --git a/api_beta/docs/FormElementValidationsSet.md b/api_beta/docs/FormElementValidationsSet.md index 9e1d5f8c3..122c421d4 100644 --- a/api_beta/docs/FormElementValidationsSet.md +++ b/api_beta/docs/FormElementValidationsSet.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ValidationType** | Pointer to **string** | | [optional] +**ValidationType** | Pointer to **string** | The type of data validation that you wish to enforce, e.g., a required field, a minimum length, etc. | [optional] ## Methods diff --git a/api_beta/docs/FormInstanceResponse.md b/api_beta/docs/FormInstanceResponse.md index 58f7de9c2..8f5d8ec75 100644 --- a/api_beta/docs/FormInstanceResponse.md +++ b/api_beta/docs/FormInstanceResponse.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **CreatedBy** | Pointer to [**FormInstanceCreatedBy**](FormInstanceCreatedBy.md) | | [optional] **Expire** | Pointer to **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 | [optional] **FormConditions** | Pointer to [**[]FormCondition**](FormCondition.md) | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [optional] -**FormData** | Pointer to **map[string]map[string]interface{}** | FormData is the data provided by the form on submit. The data is in a key -> value map | [optional] +**FormData** | Pointer to **map[string]interface{}** | FormData is the data provided by the form on submit. The data is in a key -> value map | [optional] **FormDefinitionId** | Pointer to **string** | FormDefinitionID is the id of the form definition that created this form | [optional] **FormElements** | Pointer to [**[]FormElement**](FormElement.md) | FormElements is the configuration of the form, this would be a repeat of the fields from the form-config | [optional] **FormErrors** | Pointer to [**[]FormError**](FormError.md) | 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 | [optional] @@ -141,20 +141,20 @@ HasFormConditions returns a boolean if a field has been set. ### GetFormData -`func (o *FormInstanceResponse) GetFormData() map[string]map[string]interface{}` +`func (o *FormInstanceResponse) GetFormData() map[string]interface{}` GetFormData returns the FormData field if non-nil, zero value otherwise. ### GetFormDataOk -`func (o *FormInstanceResponse) GetFormDataOk() (*map[string]map[string]interface{}, bool)` +`func (o *FormInstanceResponse) GetFormDataOk() (*map[string]interface{}, bool)` GetFormDataOk returns a tuple with the FormData field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetFormData -`func (o *FormInstanceResponse) SetFormData(v map[string]map[string]interface{})` +`func (o *FormInstanceResponse) SetFormData(v map[string]interface{})` SetFormData sets FormData field to given value. @@ -164,6 +164,16 @@ SetFormData sets FormData field to given value. HasFormData returns a boolean if a field has been set. +### SetFormDataNil + +`func (o *FormInstanceResponse) SetFormDataNil(b bool)` + + SetFormDataNil sets the value for FormData to be an explicit nil + +### UnsetFormData +`func (o *FormInstanceResponse) UnsetFormData()` + +UnsetFormData ensures that no value is present for FormData, not even an explicit nil ### GetFormDefinitionId `func (o *FormInstanceResponse) GetFormDefinitionId() string` diff --git a/api_beta/model_condition_rule.go b/api_beta/model_condition_rule.go index e222616bb..1b28d65cc 100644 --- a/api_beta/model_condition_rule.go +++ b/api_beta/model_condition_rule.go @@ -28,7 +28,7 @@ type ConditionRule struct { // 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 ValueType *string `json:"valueType,omitempty"` // Based on the ValueType. - Value map[string]interface{} `json:"value,omitempty"` + Value *string `json:"value,omitempty"` AdditionalProperties map[string]interface{} } @@ -180,19 +180,19 @@ func (o *ConditionRule) SetValueType(v string) { } // GetValue returns the Value field value if set, zero value otherwise. -func (o *ConditionRule) GetValue() map[string]interface{} { +func (o *ConditionRule) GetValue() string { if o == nil || IsNil(o.Value) { - var ret map[string]interface{} + var ret string return ret } - return o.Value + return *o.Value } // GetValueOk returns a tuple with the Value field value if set, nil otherwise // and a boolean to check if the value has been set. -func (o *ConditionRule) GetValueOk() (map[string]interface{}, bool) { +func (o *ConditionRule) GetValueOk() (*string, bool) { if o == nil || IsNil(o.Value) { - return map[string]interface{}{}, false + return nil, false } return o.Value, true } @@ -206,9 +206,9 @@ func (o *ConditionRule) HasValue() bool { return false } -// SetValue gets a reference to the given map[string]interface{} and assigns it to the Value field. -func (o *ConditionRule) SetValue(v map[string]interface{}) { - o.Value = v +// SetValue gets a reference to the given string and assigns it to the Value field. +func (o *ConditionRule) SetValue(v string) { + o.Value = &v } func (o ConditionRule) MarshalJSON() ([]byte, error) { diff --git a/api_beta/model_form_element.go b/api_beta/model_form_element.go index c3c9120d9..a6092c7b7 100644 --- a/api_beta/model_form_element.go +++ b/api_beta/model_form_element.go @@ -24,7 +24,7 @@ type FormElement struct { // 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 ElementType *string `json:"elementType,omitempty"` // Config object. - Config map[string]map[string]interface{} `json:"config,omitempty"` + Config map[string]interface{} `json:"config,omitempty"` // Technical key. Key *string `json:"key,omitempty"` Validations []FormElementValidationsSet `json:"validations,omitempty"` @@ -115,9 +115,9 @@ func (o *FormElement) SetElementType(v string) { } // GetConfig returns the Config field value if set, zero value otherwise. -func (o *FormElement) GetConfig() map[string]map[string]interface{} { +func (o *FormElement) GetConfig() map[string]interface{} { if o == nil || IsNil(o.Config) { - var ret map[string]map[string]interface{} + var ret map[string]interface{} return ret } return o.Config @@ -125,9 +125,9 @@ func (o *FormElement) GetConfig() map[string]map[string]interface{} { // GetConfigOk returns a tuple with the Config field value if set, nil otherwise // and a boolean to check if the value has been set. -func (o *FormElement) GetConfigOk() (map[string]map[string]interface{}, bool) { +func (o *FormElement) GetConfigOk() (map[string]interface{}, bool) { if o == nil || IsNil(o.Config) { - return map[string]map[string]interface{}{}, false + return map[string]interface{}{}, false } return o.Config, true } @@ -141,8 +141,8 @@ func (o *FormElement) HasConfig() bool { return false } -// SetConfig gets a reference to the given map[string]map[string]interface{} and assigns it to the Config field. -func (o *FormElement) SetConfig(v map[string]map[string]interface{}) { +// SetConfig gets a reference to the given map[string]interface{} and assigns it to the Config field. +func (o *FormElement) SetConfig(v map[string]interface{}) { o.Config = v } diff --git a/api_beta/model_form_element_validations_set.go b/api_beta/model_form_element_validations_set.go index f7a4f01ef..ca79a157a 100644 --- a/api_beta/model_form_element_validations_set.go +++ b/api_beta/model_form_element_validations_set.go @@ -19,6 +19,7 @@ var _ MappedNullable = &FormElementValidationsSet{} // FormElementValidationsSet Set of FormElementValidation items. type FormElementValidationsSet struct { + // The type of data validation that you wish to enforce, e.g., a required field, a minimum length, etc. ValidationType *string `json:"validationType,omitempty"` AdditionalProperties map[string]interface{} } diff --git a/api_beta/model_form_instance_response.go b/api_beta/model_form_instance_response.go index e15dda5e1..ba7972204 100644 --- a/api_beta/model_form_instance_response.go +++ b/api_beta/model_form_instance_response.go @@ -28,7 +28,7 @@ type FormInstanceResponse struct { // FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form FormConditions []FormCondition `json:"formConditions,omitempty"` // FormData is the data provided by the form on submit. The data is in a key -> value map - FormData map[string]map[string]interface{} `json:"formData,omitempty"` + FormData map[string]interface{} `json:"formData,omitempty"` // FormDefinitionID is the id of the form definition that created this form FormDefinitionId *string `json:"formDefinitionId,omitempty"` // FormElements is the configuration of the form, this would be a repeat of the fields from the form-config @@ -203,10 +203,10 @@ func (o *FormInstanceResponse) SetFormConditions(v []FormCondition) { o.FormConditions = v } -// GetFormData returns the FormData field value if set, zero value otherwise. -func (o *FormInstanceResponse) GetFormData() map[string]map[string]interface{} { - if o == nil || IsNil(o.FormData) { - var ret map[string]map[string]interface{} +// GetFormData returns the FormData field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *FormInstanceResponse) GetFormData() map[string]interface{} { + if o == nil { + var ret map[string]interface{} return ret } return o.FormData @@ -214,9 +214,10 @@ func (o *FormInstanceResponse) GetFormData() map[string]map[string]interface{} { // GetFormDataOk returns a tuple with the FormData field value if set, nil otherwise // and a boolean to check if the value has been set. -func (o *FormInstanceResponse) GetFormDataOk() (map[string]map[string]interface{}, bool) { +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *FormInstanceResponse) GetFormDataOk() (map[string]interface{}, bool) { if o == nil || IsNil(o.FormData) { - return map[string]map[string]interface{}{}, false + return map[string]interface{}{}, false } return o.FormData, true } @@ -230,8 +231,8 @@ func (o *FormInstanceResponse) HasFormData() bool { return false } -// SetFormData gets a reference to the given map[string]map[string]interface{} and assigns it to the FormData field. -func (o *FormInstanceResponse) SetFormData(v map[string]map[string]interface{}) { +// SetFormData gets a reference to the given map[string]interface{} and assigns it to the FormData field. +func (o *FormInstanceResponse) SetFormData(v map[string]interface{}) { o.FormData = v } @@ -578,7 +579,7 @@ func (o FormInstanceResponse) ToMap() (map[string]interface{}, error) { if !IsNil(o.FormConditions) { toSerialize["formConditions"] = o.FormConditions } - if !IsNil(o.FormData) { + if o.FormData != nil { toSerialize["formData"] = o.FormData } if !IsNil(o.FormDefinitionId) { diff --git a/api_v2024/api/openapi.yaml b/api_v2024/api/openapi.yaml index 8f30a67ff..4f70cbf0d 100644 --- a/api_v2024/api/openapi.yaml +++ b/api_v2024/api/openapi.yaml @@ -88608,16 +88608,16 @@ components: formElements: - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department key: department - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department @@ -88695,16 +88695,16 @@ components: formElements: - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department key: department - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department @@ -88847,16 +88847,16 @@ components: formElements: - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department key: department - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department @@ -88985,16 +88985,16 @@ components: formElements: - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department key: department - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department @@ -89340,16 +89340,16 @@ components: formElements: - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department key: department - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department @@ -89439,16 +89439,16 @@ components: formElements: - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department key: department - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department @@ -89645,16 +89645,16 @@ components: formElements: - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department key: department - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department @@ -89685,12 +89685,12 @@ components: type: array x-go-name: FormConditions formData: - additionalProperties: - type: object + additionalProperties: true description: FormData is the data provided by the form on submit. The data is in a key -> value map example: department: Engineering + nullable: true type: object x-go-name: FormData formDefinitionId: @@ -97411,8 +97411,8 @@ components: example: id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department @@ -97446,8 +97446,7 @@ components: type: string x-go-name: ElementType config: - additionalProperties: - type: object + additionalProperties: true description: Config object. example: label: Department @@ -99726,7 +99725,7 @@ components: value: description: Based on the ValueType. example: Engineering - type: object + type: string x-go-name: Value type: object x-go-package: github.com/sailpoint/sp-forms/domain @@ -99780,9 +99779,11 @@ components: FormElementValidationsSet: description: Set of FormElementValidation items. example: - - validationType: REQUIRED + validationType: REQUIRED properties: validationType: + description: "The type of data validation that you wish to enforce, e.g.,\ + \ a required field, a minimum length, etc." enum: - REQUIRED - MIN_LENGTH @@ -99796,6 +99797,7 @@ components: - EMAIL - DATA_SOURCE - TEXTAREA + example: REQUIRED type: string type: object x-go-package: github.com/sailpoint/sp-forms/domain @@ -100984,16 +100986,16 @@ components: formElements: - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department key: department - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department @@ -101107,16 +101109,16 @@ components: formElements: - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department key: department - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department @@ -101197,16 +101199,16 @@ components: formElements: - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department key: department - id: 00000000-0000-0000-0000-000000000000 validations: - - - validationType: REQUIRED - - - validationType: REQUIRED + - validationType: REQUIRED + - validationType: REQUIRED elementType: TEXT config: label: Department diff --git a/api_v2024/docs/ConditionRule.md b/api_v2024/docs/ConditionRule.md index 442a81f1f..bc6745365 100644 --- a/api_v2024/docs/ConditionRule.md +++ b/api_v2024/docs/ConditionRule.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **Source** | Pointer to **string** | 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. | [optional] **Operator** | Pointer to **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 | [optional] **ValueType** | Pointer to **string** | 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 | [optional] -**Value** | Pointer to **map[string]interface{}** | Based on the ValueType. | [optional] +**Value** | Pointer to **string** | Based on the ValueType. | [optional] ## Methods @@ -131,20 +131,20 @@ HasValueType returns a boolean if a field has been set. ### GetValue -`func (o *ConditionRule) GetValue() map[string]interface{}` +`func (o *ConditionRule) GetValue() string` GetValue returns the Value field if non-nil, zero value otherwise. ### GetValueOk -`func (o *ConditionRule) GetValueOk() (*map[string]interface{}, bool)` +`func (o *ConditionRule) GetValueOk() (*string, bool)` GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetValue -`func (o *ConditionRule) SetValue(v map[string]interface{})` +`func (o *ConditionRule) SetValue(v string)` SetValue sets Value field to given value. diff --git a/api_v2024/docs/FormElement.md b/api_v2024/docs/FormElement.md index 7fdd5ca83..d3269bc3d 100644 --- a/api_v2024/docs/FormElement.md +++ b/api_v2024/docs/FormElement.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Id** | Pointer to **string** | Form element identifier. | [optional] **ElementType** | Pointer to **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 | [optional] -**Config** | Pointer to **map[string]map[string]interface{}** | Config object. | [optional] +**Config** | Pointer to **map[string]interface{}** | Config object. | [optional] **Key** | Pointer to **string** | Technical key. | [optional] **Validations** | Pointer to [**[]FormElementValidationsSet**](FormElementValidationsSet.md) | | [optional] @@ -81,20 +81,20 @@ HasElementType returns a boolean if a field has been set. ### GetConfig -`func (o *FormElement) GetConfig() map[string]map[string]interface{}` +`func (o *FormElement) GetConfig() map[string]interface{}` GetConfig returns the Config field if non-nil, zero value otherwise. ### GetConfigOk -`func (o *FormElement) GetConfigOk() (*map[string]map[string]interface{}, bool)` +`func (o *FormElement) GetConfigOk() (*map[string]interface{}, bool)` GetConfigOk returns a tuple with the Config field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetConfig -`func (o *FormElement) SetConfig(v map[string]map[string]interface{})` +`func (o *FormElement) SetConfig(v map[string]interface{})` SetConfig sets Config field to given value. diff --git a/api_v2024/docs/FormElementValidationsSet.md b/api_v2024/docs/FormElementValidationsSet.md index 9e1d5f8c3..122c421d4 100644 --- a/api_v2024/docs/FormElementValidationsSet.md +++ b/api_v2024/docs/FormElementValidationsSet.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ValidationType** | Pointer to **string** | | [optional] +**ValidationType** | Pointer to **string** | The type of data validation that you wish to enforce, e.g., a required field, a minimum length, etc. | [optional] ## Methods diff --git a/api_v2024/docs/FormInstanceResponse.md b/api_v2024/docs/FormInstanceResponse.md index 58f7de9c2..8f5d8ec75 100644 --- a/api_v2024/docs/FormInstanceResponse.md +++ b/api_v2024/docs/FormInstanceResponse.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **CreatedBy** | Pointer to [**FormInstanceCreatedBy**](FormInstanceCreatedBy.md) | | [optional] **Expire** | Pointer to **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 | [optional] **FormConditions** | Pointer to [**[]FormCondition**](FormCondition.md) | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [optional] -**FormData** | Pointer to **map[string]map[string]interface{}** | FormData is the data provided by the form on submit. The data is in a key -> value map | [optional] +**FormData** | Pointer to **map[string]interface{}** | FormData is the data provided by the form on submit. The data is in a key -> value map | [optional] **FormDefinitionId** | Pointer to **string** | FormDefinitionID is the id of the form definition that created this form | [optional] **FormElements** | Pointer to [**[]FormElement**](FormElement.md) | FormElements is the configuration of the form, this would be a repeat of the fields from the form-config | [optional] **FormErrors** | Pointer to [**[]FormError**](FormError.md) | 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 | [optional] @@ -141,20 +141,20 @@ HasFormConditions returns a boolean if a field has been set. ### GetFormData -`func (o *FormInstanceResponse) GetFormData() map[string]map[string]interface{}` +`func (o *FormInstanceResponse) GetFormData() map[string]interface{}` GetFormData returns the FormData field if non-nil, zero value otherwise. ### GetFormDataOk -`func (o *FormInstanceResponse) GetFormDataOk() (*map[string]map[string]interface{}, bool)` +`func (o *FormInstanceResponse) GetFormDataOk() (*map[string]interface{}, bool)` GetFormDataOk returns a tuple with the FormData field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetFormData -`func (o *FormInstanceResponse) SetFormData(v map[string]map[string]interface{})` +`func (o *FormInstanceResponse) SetFormData(v map[string]interface{})` SetFormData sets FormData field to given value. @@ -164,6 +164,16 @@ SetFormData sets FormData field to given value. HasFormData returns a boolean if a field has been set. +### SetFormDataNil + +`func (o *FormInstanceResponse) SetFormDataNil(b bool)` + + SetFormDataNil sets the value for FormData to be an explicit nil + +### UnsetFormData +`func (o *FormInstanceResponse) UnsetFormData()` + +UnsetFormData ensures that no value is present for FormData, not even an explicit nil ### GetFormDefinitionId `func (o *FormInstanceResponse) GetFormDefinitionId() string` diff --git a/api_v2024/model_condition_rule.go b/api_v2024/model_condition_rule.go index 5154be0f8..77fdd1946 100644 --- a/api_v2024/model_condition_rule.go +++ b/api_v2024/model_condition_rule.go @@ -28,7 +28,7 @@ type ConditionRule struct { // 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 ValueType *string `json:"valueType,omitempty"` // Based on the ValueType. - Value map[string]interface{} `json:"value,omitempty"` + Value *string `json:"value,omitempty"` AdditionalProperties map[string]interface{} } @@ -180,19 +180,19 @@ func (o *ConditionRule) SetValueType(v string) { } // GetValue returns the Value field value if set, zero value otherwise. -func (o *ConditionRule) GetValue() map[string]interface{} { +func (o *ConditionRule) GetValue() string { if o == nil || IsNil(o.Value) { - var ret map[string]interface{} + var ret string return ret } - return o.Value + return *o.Value } // GetValueOk returns a tuple with the Value field value if set, nil otherwise // and a boolean to check if the value has been set. -func (o *ConditionRule) GetValueOk() (map[string]interface{}, bool) { +func (o *ConditionRule) GetValueOk() (*string, bool) { if o == nil || IsNil(o.Value) { - return map[string]interface{}{}, false + return nil, false } return o.Value, true } @@ -206,9 +206,9 @@ func (o *ConditionRule) HasValue() bool { return false } -// SetValue gets a reference to the given map[string]interface{} and assigns it to the Value field. -func (o *ConditionRule) SetValue(v map[string]interface{}) { - o.Value = v +// SetValue gets a reference to the given string and assigns it to the Value field. +func (o *ConditionRule) SetValue(v string) { + o.Value = &v } func (o ConditionRule) MarshalJSON() ([]byte, error) { diff --git a/api_v2024/model_form_element.go b/api_v2024/model_form_element.go index e1ee9eb8f..9b6f257ff 100644 --- a/api_v2024/model_form_element.go +++ b/api_v2024/model_form_element.go @@ -24,7 +24,7 @@ type FormElement struct { // 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 ElementType *string `json:"elementType,omitempty"` // Config object. - Config map[string]map[string]interface{} `json:"config,omitempty"` + Config map[string]interface{} `json:"config,omitempty"` // Technical key. Key *string `json:"key,omitempty"` Validations []FormElementValidationsSet `json:"validations,omitempty"` @@ -115,9 +115,9 @@ func (o *FormElement) SetElementType(v string) { } // GetConfig returns the Config field value if set, zero value otherwise. -func (o *FormElement) GetConfig() map[string]map[string]interface{} { +func (o *FormElement) GetConfig() map[string]interface{} { if o == nil || IsNil(o.Config) { - var ret map[string]map[string]interface{} + var ret map[string]interface{} return ret } return o.Config @@ -125,9 +125,9 @@ func (o *FormElement) GetConfig() map[string]map[string]interface{} { // GetConfigOk returns a tuple with the Config field value if set, nil otherwise // and a boolean to check if the value has been set. -func (o *FormElement) GetConfigOk() (map[string]map[string]interface{}, bool) { +func (o *FormElement) GetConfigOk() (map[string]interface{}, bool) { if o == nil || IsNil(o.Config) { - return map[string]map[string]interface{}{}, false + return map[string]interface{}{}, false } return o.Config, true } @@ -141,8 +141,8 @@ func (o *FormElement) HasConfig() bool { return false } -// SetConfig gets a reference to the given map[string]map[string]interface{} and assigns it to the Config field. -func (o *FormElement) SetConfig(v map[string]map[string]interface{}) { +// SetConfig gets a reference to the given map[string]interface{} and assigns it to the Config field. +func (o *FormElement) SetConfig(v map[string]interface{}) { o.Config = v } diff --git a/api_v2024/model_form_element_validations_set.go b/api_v2024/model_form_element_validations_set.go index 1817f5b9f..f2ff32e4e 100644 --- a/api_v2024/model_form_element_validations_set.go +++ b/api_v2024/model_form_element_validations_set.go @@ -19,6 +19,7 @@ var _ MappedNullable = &FormElementValidationsSet{} // FormElementValidationsSet Set of FormElementValidation items. type FormElementValidationsSet struct { + // The type of data validation that you wish to enforce, e.g., a required field, a minimum length, etc. ValidationType *string `json:"validationType,omitempty"` AdditionalProperties map[string]interface{} } diff --git a/api_v2024/model_form_instance_response.go b/api_v2024/model_form_instance_response.go index 8cfca96ba..316801720 100644 --- a/api_v2024/model_form_instance_response.go +++ b/api_v2024/model_form_instance_response.go @@ -28,7 +28,7 @@ type FormInstanceResponse struct { // FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form FormConditions []FormCondition `json:"formConditions,omitempty"` // FormData is the data provided by the form on submit. The data is in a key -> value map - FormData map[string]map[string]interface{} `json:"formData,omitempty"` + FormData map[string]interface{} `json:"formData,omitempty"` // FormDefinitionID is the id of the form definition that created this form FormDefinitionId *string `json:"formDefinitionId,omitempty"` // FormElements is the configuration of the form, this would be a repeat of the fields from the form-config @@ -203,10 +203,10 @@ func (o *FormInstanceResponse) SetFormConditions(v []FormCondition) { o.FormConditions = v } -// GetFormData returns the FormData field value if set, zero value otherwise. -func (o *FormInstanceResponse) GetFormData() map[string]map[string]interface{} { - if o == nil || IsNil(o.FormData) { - var ret map[string]map[string]interface{} +// GetFormData returns the FormData field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *FormInstanceResponse) GetFormData() map[string]interface{} { + if o == nil { + var ret map[string]interface{} return ret } return o.FormData @@ -214,9 +214,10 @@ func (o *FormInstanceResponse) GetFormData() map[string]map[string]interface{} { // GetFormDataOk returns a tuple with the FormData field value if set, nil otherwise // and a boolean to check if the value has been set. -func (o *FormInstanceResponse) GetFormDataOk() (map[string]map[string]interface{}, bool) { +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *FormInstanceResponse) GetFormDataOk() (map[string]interface{}, bool) { if o == nil || IsNil(o.FormData) { - return map[string]map[string]interface{}{}, false + return map[string]interface{}{}, false } return o.FormData, true } @@ -230,8 +231,8 @@ func (o *FormInstanceResponse) HasFormData() bool { return false } -// SetFormData gets a reference to the given map[string]map[string]interface{} and assigns it to the FormData field. -func (o *FormInstanceResponse) SetFormData(v map[string]map[string]interface{}) { +// SetFormData gets a reference to the given map[string]interface{} and assigns it to the FormData field. +func (o *FormInstanceResponse) SetFormData(v map[string]interface{}) { o.FormData = v } @@ -578,7 +579,7 @@ func (o FormInstanceResponse) ToMap() (map[string]interface{}, error) { if !IsNil(o.FormConditions) { toSerialize["formConditions"] = o.FormConditions } - if !IsNil(o.FormData) { + if o.FormData != nil { toSerialize["formData"] = o.FormData } if !IsNil(o.FormDefinitionId) {