updated doc and sdk for template response to include regex value for … (#492)

Co-authored-by: Juan Treminio <[email protected]>

Author: sainishm2

openapi-raw.yaml

@@ -12286,6 +12286,14 @@ components:
                 - employer_identification_number
                 - custom_regex
               nullable: true
+            validation_custom_regex:
+              description: '_t__TemplateResponseDocumentFormField::CUSTOM_REGEX'
+              type: string
+              nullable: true
+            validation_custom_regex_format_label:
+              description: '_t__TemplateResponseDocumentFormField::CUSTOM_REGEX_LABEL'
+              type: string
+              nullable: true
             group:
               description: '_t__TemplateResponseDocumentFormField::GROUP'
               type: string

openapi-sdk.yaml

@@ -13130,6 +13130,14 @@ components:
                 - employer_identification_number
                 - custom_regex
               nullable: true
+            validation_custom_regex:
+              description: 'When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field.'
+              type: string
+              nullable: true
+            validation_custom_regex_format_label:
+              description: 'When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern.'
+              type: string
+              nullable: true
             group:
               description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
               type: string

openapi.yaml

@@ -13108,6 +13108,14 @@ components:
                 - employer_identification_number
                 - custom_regex
               nullable: true
+            validation_custom_regex:
+              description: 'When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field.'
+              type: string
+              nullable: true
+            validation_custom_regex_format_label:
+              description: 'When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern.'
+              type: string
+              nullable: true
             group:
               description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
               type: string

sdks/dotnet/docs/TemplateResponseDocumentFormFieldText.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **Width** | **int** |  The width in pixels of this form field.  | [optional] 
 **Height** | **int** |  The height in pixels of this form field.  | [optional] 
 **Required** | **bool** |  Boolean showing whether or not this field is required.  | [optional] 
-**Type** | **string** |  The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials`  | [default to "text"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) |    | [optional] **IsMultiline** | **bool** |  Whether this form field is multiline text.  | [optional] **OriginalFontSize** | **int** |  Original font size used in this form field&#39;s text.  | [optional] **FontFamily** | **string** |  Font family used in this form field&#39;s text.  | [optional] **ValidationType** | **string** |  Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.  | [optional] **Group** | **string** |  The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.  | [optional] 
+**Type** | **string** |  The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials`  | [default to "text"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) |    | [optional] **IsMultiline** | **bool** |  Whether this form field is multiline text.  | [optional] **OriginalFontSize** | **int** |  Original font size used in this form field&#39;s text.  | [optional] **FontFamily** | **string** |  Font family used in this form field&#39;s text.  | [optional] **ValidationType** | **string** |  Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.  | [optional] **ValidationCustomRegex** | **string** |  When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field.  | [optional] **ValidationCustomRegexFormatLabel** | **string** |  When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern.  | [optional] **Group** | **string** |  The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldText.cs

@@ -122,6 +122,8 @@ protected TemplateResponseDocumentFormFieldText() { }
         /// <param name="originalFontSize">Original font size used in this form field&#39;s text..</param>
         /// <param name="fontFamily">Font family used in this form field&#39;s text..</param>
         /// <param name="validationType">Each text field may contain a &#x60;validation_type&#x60; parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values..</param>
+        /// <param name="validationCustomRegex">When &#x60;validation_type&#x60; is set to &#x60;custom_regex&#x60;, this specifies the custom regular expression pattern that will be used to validate the text field..</param>
+        /// <param name="validationCustomRegexFormatLabel">When &#x60;validation_type&#x60; is set to &#x60;custom_regex&#x60;, this specifies the error message displayed to the signer when the text does not match the provided regex pattern..</param>
         /// <param name="group">The name of the group this field is in. If this field is not a group, this defaults to &#x60;null&#x60; except for Radio fields..</param>
         /// <param name="apiId">A unique id for the form field..</param>
         /// <param name="name">The name of the form field..</param>
@@ -131,7 +133,7 @@ protected TemplateResponseDocumentFormFieldText() { }
         /// <param name="width">The width in pixels of this form field..</param>
         /// <param name="height">The height in pixels of this form field..</param>
         /// <param name="required">Boolean showing whether or not this field is required..</param>
-        public TemplateResponseDocumentFormFieldText(string type = @"text", TemplateResponseFieldAvgTextLength avgTextLength = default(TemplateResponseFieldAvgTextLength), bool isMultiline = default(bool), int originalFontSize = default(int), string fontFamily = default(string), ValidationTypeEnum? validationType = default(ValidationTypeEnum?), string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool))
+        public TemplateResponseDocumentFormFieldText(string type = @"text", TemplateResponseFieldAvgTextLength avgTextLength = default(TemplateResponseFieldAvgTextLength), bool isMultiline = default(bool), int originalFontSize = default(int), string fontFamily = default(string), ValidationTypeEnum? validationType = default(ValidationTypeEnum?), string validationCustomRegex = default(string), string validationCustomRegexFormatLabel = default(string), string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool))
         {
             this.ApiId = apiId;
             this.Name = name;
@@ -153,6 +155,8 @@ protected TemplateResponseDocumentFormFieldText() { }
             this.OriginalFontSize = originalFontSize;
             this.FontFamily = fontFamily;
             this.ValidationType = validationType;
+            this.ValidationCustomRegex = validationCustomRegex;
+            this.ValidationCustomRegexFormatLabel = validationCustomRegexFormatLabel;
             this.Group = group;
         }
 
@@ -206,6 +210,20 @@ public static TemplateResponseDocumentFormFieldText Init(string jsonData)
         [DataMember(Name = "fontFamily", EmitDefaultValue = true)]
         public string FontFamily { get; set; }
 
+        /// <summary>
+        /// When &#x60;validation_type&#x60; is set to &#x60;custom_regex&#x60;, this specifies the custom regular expression pattern that will be used to validate the text field.
+        /// </summary>
+        /// <value>When &#x60;validation_type&#x60; is set to &#x60;custom_regex&#x60;, this specifies the custom regular expression pattern that will be used to validate the text field.</value>
+        [DataMember(Name = "validation_custom_regex", EmitDefaultValue = true)]
+        public string ValidationCustomRegex { get; set; }
+
+        /// <summary>
+        /// When &#x60;validation_type&#x60; is set to &#x60;custom_regex&#x60;, this specifies the error message displayed to the signer when the text does not match the provided regex pattern.
+        /// </summary>
+        /// <value>When &#x60;validation_type&#x60; is set to &#x60;custom_regex&#x60;, this specifies the error message displayed to the signer when the text does not match the provided regex pattern.</value>
+        [DataMember(Name = "validation_custom_regex_format_label", EmitDefaultValue = true)]
+        public string ValidationCustomRegexFormatLabel { get; set; }
+
         /// <summary>
         /// The name of the group this field is in. If this field is not a group, this defaults to &#x60;null&#x60; except for Radio fields.
         /// </summary>
@@ -228,6 +246,8 @@ public override string ToString()
             sb.Append("  OriginalFontSize: ").Append(OriginalFontSize).Append("\n");
             sb.Append("  FontFamily: ").Append(FontFamily).Append("\n");
             sb.Append("  ValidationType: ").Append(ValidationType).Append("\n");
+            sb.Append("  ValidationCustomRegex: ").Append(ValidationCustomRegex).Append("\n");
+            sb.Append("  ValidationCustomRegexFormatLabel: ").Append(ValidationCustomRegexFormatLabel).Append("\n");
             sb.Append("  Group: ").Append(Group).Append("\n");
             sb.Append("}\n");
             return sb.ToString();
@@ -291,6 +311,16 @@ public bool Equals(TemplateResponseDocumentFormFieldText input)
                     this.ValidationType == input.ValidationType ||
                     this.ValidationType.Equals(input.ValidationType)
                 ) && base.Equals(input) &&
+                (
+                    this.ValidationCustomRegex == input.ValidationCustomRegex ||
+                    (this.ValidationCustomRegex != null &&
+                    this.ValidationCustomRegex.Equals(input.ValidationCustomRegex))
+                ) && base.Equals(input) &&
+                (
+                    this.ValidationCustomRegexFormatLabel == input.ValidationCustomRegexFormatLabel ||
+                    (this.ValidationCustomRegexFormatLabel != null &&
+                    this.ValidationCustomRegexFormatLabel.Equals(input.ValidationCustomRegexFormatLabel))
+                ) && base.Equals(input) &&
                 (
                     this.Group == input.Group ||
                     (this.Group != null &&
@@ -322,6 +352,14 @@ public override int GetHashCode()
                     hashCode = (hashCode * 59) + this.FontFamily.GetHashCode();
                 }
                 hashCode = (hashCode * 59) + this.ValidationType.GetHashCode();
+                if (this.ValidationCustomRegex != null)
+                {
+                    hashCode = (hashCode * 59) + this.ValidationCustomRegex.GetHashCode();
+                }
+                if (this.ValidationCustomRegexFormatLabel != null)
+                {
+                    hashCode = (hashCode * 59) + this.ValidationCustomRegexFormatLabel.GetHashCode();
+                }
                 if (this.Group != null)
                 {
                     hashCode = (hashCode * 59) + this.Group.GetHashCode();
@@ -399,6 +437,20 @@ public List<OpenApiType> GetOpenApiTypes()
                 Value = ValidationType,
             });
             types.Add(new OpenApiType()
+            {
+                Name = "validation_custom_regex",
+                Property = "ValidationCustomRegex",
+                Type = "string",
+                Value = ValidationCustomRegex,
+            });
+            types.Add(new OpenApiType()
+            {
+                Name = "validation_custom_regex_format_label",
+                Property = "ValidationCustomRegexFormatLabel",
+                Type = "string",
+                Value = ValidationCustomRegexFormatLabel,
+            });
+            types.Add(new OpenApiType()
             {
                 Name = "group",
                 Property = "Group",

sdks/java-v1/docs/TemplateResponseDocumentFormFieldText.md

@@ -14,6 +14,8 @@ This class extends `TemplateResponseDocumentFormFieldBase`
 | `originalFontSize` | ```Integer``` |  Original font size used in this form field's text.  |  |
 | `fontFamily` | ```String``` |  Font family used in this form field's text.  |  |
 | `validationType` | [```ValidationTypeEnum```](#ValidationTypeEnum) |  Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.  |  |
+| `validationCustomRegex` | ```String``` |  When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field.  |  |
+| `validationCustomRegexFormatLabel` | ```String``` |  When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern.  |  |
 | `group` | ```String``` |  The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.  |  |