Add dropdown options to template responses (#560)

Author: mchatlas-hellosign

openapi-fern.yaml

@@ -28363,6 +28363,11 @@ components:
               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
               nullable: true
+            options:
+              description: The options available for this dropdown form field.
+              type: array
+              items:
+                type: string
           type: object
     TemplateResponseDocumentFormFieldHyperlink:
       description: This class extends `TemplateResponseDocumentFormFieldBase`

openapi-raw.yaml

@@ -12664,6 +12664,11 @@ components:
               description: '_t__TemplateResponseDocumentFormField::GROUP'
               type: string
               nullable: true
+            options:
+              description: '_t__TemplateResponseDocumentFormField::OPTIONS'
+              type: array
+              items:
+                type: string
           type: object
     TemplateResponseDocumentFormFieldHyperlink:
       description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS'

openapi-sdk.yaml

@@ -13106,6 +13106,11 @@ components:
               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
               nullable: true
+            options:
+              description: 'The options available for this dropdown form field.'
+              type: array
+              items:
+                type: string
           type: object
     TemplateResponseDocumentFormFieldHyperlink:
       description: 'This class extends `TemplateResponseDocumentFormFieldBase`'

openapi.yaml

@@ -13092,6 +13092,11 @@ components:
               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
               nullable: true
+            options:
+              description: 'The options available for this dropdown form field.'
+              type: array
+              items:
+                type: string
           type: object
     TemplateResponseDocumentFormFieldHyperlink:
       description: 'This class extends `TemplateResponseDocumentFormFieldBase`'

sdks/dotnet/docs/TemplateResponseDocumentFormFieldDropdown.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 "dropdown"]**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 "dropdown"]**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] **Options** | **List&lt;string&gt;** |  The options available for this dropdown form field.  | [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/TemplateResponseDocumentFormFieldDropdown.cs

@@ -43,6 +43,7 @@ protected TemplateResponseDocumentFormFieldDropdown() { }
         /// </summary>
         /// <param name="type">The type of this form field. See [field types](/api/reference/constants/#field-types).  * Text Field uses &#x60;TemplateResponseDocumentFormFieldText&#x60; * Dropdown Field uses &#x60;TemplateResponseDocumentFormFieldDropdown&#x60; * Hyperlink Field uses &#x60;TemplateResponseDocumentFormFieldHyperlink&#x60; * Checkbox Field uses &#x60;TemplateResponseDocumentFormFieldCheckbox&#x60; * Radio Field uses &#x60;TemplateResponseDocumentFormFieldRadio&#x60; * Signature Field uses &#x60;TemplateResponseDocumentFormFieldSignature&#x60; * Date Signed Field uses &#x60;TemplateResponseDocumentFormFieldDateSigned&#x60; * Initials Field uses &#x60;TemplateResponseDocumentFormFieldInitials&#x60; (required) (default to &quot;dropdown&quot;).</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="options">The options available for this dropdown form field..</param>
         /// <param name="apiId">A unique id for the form field..</param>
         /// <param name="name">The name of the form field..</param>
         /// <param name="signer">The signer of the Form Field..</param>
@@ -51,7 +52,7 @@ protected TemplateResponseDocumentFormFieldDropdown() { }
         /// <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 TemplateResponseDocumentFormFieldDropdown(string type = @"dropdown", 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 TemplateResponseDocumentFormFieldDropdown(string type = @"dropdown", string group = default(string), List<string> options = default(List<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;
@@ -69,6 +70,7 @@ protected TemplateResponseDocumentFormFieldDropdown() { }
             }
             this.Type = type;
             this.Group = group;
+            this.Options = options;
         }
 
         /// <summary>
@@ -101,6 +103,13 @@ public static TemplateResponseDocumentFormFieldDropdown Init(string jsonData)
         [DataMember(Name = "group", EmitDefaultValue = true)]
         public string Group { get; set; }
 
+        /// <summary>
+        /// The options available for this dropdown form field.
+        /// </summary>
+        /// <value>The options available for this dropdown form field.</value>
+        [DataMember(Name = "options", EmitDefaultValue = true)]
+        public List<string> Options { get; set; }
+
         /// <summary>
         /// Returns the string presentation of the object
         /// </summary>
@@ -112,6 +121,7 @@ public override string ToString()
             sb.Append("  ").Append(base.ToString().Replace("\n", "\n  ")).Append("\n");
             sb.Append("  Type: ").Append(Type).Append("\n");
             sb.Append("  Group: ").Append(Group).Append("\n");
+            sb.Append("  Options: ").Append(Options).Append("\n");
             sb.Append("}\n");
             return sb.ToString();
         }
@@ -156,6 +166,12 @@ public bool Equals(TemplateResponseDocumentFormFieldDropdown input)
                     this.Group == input.Group ||
                     (this.Group != null &&
                     this.Group.Equals(input.Group))
+                ) && base.Equals(input) &&
+                (
+                    this.Options == input.Options ||
+                    this.Options != null &&
+                    input.Options != null &&
+                    this.Options.SequenceEqual(input.Options)
                 );
         }
 
@@ -176,6 +192,10 @@ public override int GetHashCode()
                 {
                     hashCode = (hashCode * 59) + this.Group.GetHashCode();
                 }
+                if (this.Options != null)
+                {
+                    hashCode = (hashCode * 59) + this.Options.GetHashCode();
+                }
                 return hashCode;
             }
         }
@@ -220,6 +240,13 @@ public List<OpenApiType> GetOpenApiTypes()
                 Type = "string",
                 Value = Group,
             });
+            types.Add(new OpenApiType()
+            {
+                Name = "options",
+                Property = "Options",
+                Type = "List<string>",
+                Value = Options,
+            });
 
             return types;
         }

sdks/java-v1/docs/TemplateResponseDocumentFormFieldDropdown.md

@@ -10,6 +10,7 @@ This class extends `TemplateResponseDocumentFormFieldBase`
 |------------ | ------------- | ------------- | -------------|
 | `type`<sup>*_required_</sup> | ```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`  |  |
 | `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.  |  |
+| `options` | ```List<String>``` |  The options available for this dropdown form field.  |  |
 
 
 

sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java

@@ -20,14 +20,17 @@
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
 import com.fasterxml.jackson.annotation.JsonTypeInfo;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 import java.util.Objects;
 
 /** This class extends `TemplateResponseDocumentFormFieldBase` */
 @JsonPropertyOrder({
     TemplateResponseDocumentFormFieldDropdown.JSON_PROPERTY_TYPE,
-    TemplateResponseDocumentFormFieldDropdown.JSON_PROPERTY_GROUP
+    TemplateResponseDocumentFormFieldDropdown.JSON_PROPERTY_GROUP,
+    TemplateResponseDocumentFormFieldDropdown.JSON_PROPERTY_OPTIONS
 })
 @javax.annotation.Generated(
         value = "org.openapitools.codegen.languages.JavaClientCodegen",
@@ -48,6 +51,9 @@ public class TemplateResponseDocumentFormFieldDropdown
     public static final String JSON_PROPERTY_GROUP = "group";
     @javax.annotation.Nullable private String group;
 
+    public static final String JSON_PROPERTY_OPTIONS = "options";
+    @javax.annotation.Nullable private List<String> options = null;
+
     public TemplateResponseDocumentFormFieldDropdown() {}
 
     /**
@@ -122,6 +128,37 @@ public void setGroup(@javax.annotation.Nullable String group) {
         this.group = group;
     }
 
+    public TemplateResponseDocumentFormFieldDropdown options(
+            @javax.annotation.Nullable List<String> options) {
+        this.options = options;
+        return this;
+    }
+
+    public TemplateResponseDocumentFormFieldDropdown addOptionsItem(String optionsItem) {
+        if (this.options == null) {
+            this.options = new ArrayList<>();
+        }
+        this.options.add(optionsItem);
+        return this;
+    }
+
+    /**
+     * The options available for this dropdown form field.
+     *
+     * @return options
+     */
+    @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_OPTIONS)
+    @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+    public List<String> getOptions() {
+        return options;
+    }
+
+    @JsonProperty(JSON_PROPERTY_OPTIONS)
+    @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+    public void setOptions(@javax.annotation.Nullable List<String> options) {
+        this.options = options;
+    }
+
     /** Return true if this TemplateResponseDocumentFormFieldDropdown object is equal to o. */
     @Override
     public boolean equals(Object o) {
@@ -135,12 +172,13 @@ public boolean equals(Object o) {
                 (TemplateResponseDocumentFormFieldDropdown) o;
         return Objects.equals(this.type, templateResponseDocumentFormFieldDropdown.type)
                 && Objects.equals(this.group, templateResponseDocumentFormFieldDropdown.group)
+                && Objects.equals(this.options, templateResponseDocumentFormFieldDropdown.options)
                 && super.equals(o);
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(type, group, super.hashCode());
+        return Objects.hash(type, group, options, super.hashCode());
     }
 
     @Override
@@ -150,6 +188,7 @@ public String toString() {
         sb.append("    ").append(toIndentedString(super.toString())).append("\n");
         sb.append("    type: ").append(toIndentedString(type)).append("\n");
         sb.append("    group: ").append(toIndentedString(group)).append("\n");
+        sb.append("    options: ").append(toIndentedString(options)).append("\n");
         sb.append("}");
         return sb.toString();
     }
@@ -195,6 +234,24 @@ public Map<String, Object> createFormData() throws ApiException {
                     map.put("group", JSON.getDefault().getMapper().writeValueAsString(group));
                 }
             }
+            if (options != null) {
+                if (isFileTypeOrListOfFiles(options)) {
+                    fileTypeFound = true;
+                }
+
+                if (options.getClass().equals(java.io.File.class)
+                        || options.getClass().equals(Integer.class)
+                        || options.getClass().equals(String.class)
+                        || options.getClass().isEnum()) {
+                    map.put("options", options);
+                } else if (isListOfFile(options)) {
+                    for (int i = 0; i < getListSize(options); i++) {
+                        map.put("options[" + i + "]", getFromList(options, i));
+                    }
+                } else {
+                    map.put("options", JSON.getDefault().getMapper().writeValueAsString(options));
+                }
+            }
         } catch (Exception e) {
             throw new ApiException(e);
         }

sdks/java-v2/docs/TemplateResponseDocumentFormFieldDropdown.md

@@ -10,6 +10,7 @@ This class extends `TemplateResponseDocumentFormFieldBase`
 |------------ | ------------- | ------------- | -------------|
 | `type`<sup>*_required_</sup> | ```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`  |  |
 | `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.  |  |
+| `options` | ```List<String>``` |  The options available for this dropdown form field.  |  |