Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions openapi-raw.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11893,6 +11893,10 @@ components:
type: array
items:
$ref: '#/components/schemas/SignatureRequestResponseAttachment'
allow_form_view:
description: '_t__TemplateResponse::ALLOW_FORM_VIEW'
type: boolean
nullable: false
type: object
x-internal-class: true
TemplateResponseAccount:
Expand Down
4 changes: 4 additions & 0 deletions openapi-sdk.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12644,6 +12644,10 @@ components:
type: array
items:
$ref: '#/components/schemas/SignatureRequestResponseAttachment'
allow_form_view:
description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.'
type: boolean
nullable: false
type: object
x-internal-class: true
TemplateResponseAccount:
Expand Down
4 changes: 4 additions & 0 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12622,6 +12622,10 @@ components:
type: array
items:
$ref: '#/components/schemas/SignatureRequestResponseAttachment'
allow_form_view:
description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.'
type: boolean
nullable: false
type: object
x-internal-class: true
TemplateResponseAccount:
Expand Down
2 changes: 1 addition & 1 deletion sdks/dotnet/docs/TemplateResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Contains information about the templates you and your team have created.

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**TemplateId** | **string** | The id of the Template. | [optional] **Title** | **string** | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | [optional] **Message** | **string** | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | [optional] **UpdatedAt** | **int** | Time the template was last updated. | [optional] **IsEmbedded** | **bool?** | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | [optional] **IsCreator** | **bool** | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | [optional] **CanEdit** | **bool** | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | [optional] **IsLocked** | **bool** | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | [optional] **Metadata** | **Dictionary<string, Object>** | The metadata attached to the template. | [optional] **SignerRoles** | [**List<TemplateResponseSignerRole>**](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | [optional] **CcRoles** | [**List<TemplateResponseCCRole>**](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | [optional] **Documents** | [**List<TemplateResponseDocument>**](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | [optional] **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **NamedFormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **Accounts** | [**List<TemplateResponseAccount>**](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | [optional] **Attachments** | [**List<SignatureRequestResponseAttachment>**](SignatureRequestResponseAttachment.md) | Signer attachments. | [optional]
**TemplateId** | **string** | The id of the Template. | [optional] **Title** | **string** | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | [optional] **Message** | **string** | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | [optional] **UpdatedAt** | **int** | Time the template was last updated. | [optional] **IsEmbedded** | **bool?** | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | [optional] **IsCreator** | **bool** | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | [optional] **CanEdit** | **bool** | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | [optional] **IsLocked** | **bool** | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | [optional] **Metadata** | **Dictionary<string, Object>** | The metadata attached to the template. | [optional] **SignerRoles** | [**List<TemplateResponseSignerRole>**](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | [optional] **CcRoles** | [**List<TemplateResponseCCRole>**](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | [optional] **Documents** | [**List<TemplateResponseDocument>**](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | [optional] **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **NamedFormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **Accounts** | [**List<TemplateResponseAccount>**](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | [optional] **Attachments** | [**List<SignatureRequestResponseAttachment>**](SignatureRequestResponseAttachment.md) | Signer attachments. | [optional] **AllowFormView** | **bool** | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [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)

24 changes: 23 additions & 1 deletion sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@ protected TemplateResponse() { }
/// <param name="namedFormFields">Deprecated. Use &#x60;form_fields&#x60; inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c&#x3D;200&amp;path&#x3D;template/documents&amp;t&#x3D;response) array instead..</param>
/// <param name="accounts">An array of the Accounts that can use this Template..</param>
/// <param name="attachments">Signer attachments..</param>
public TemplateResponse(string templateId = default(string), string title = default(string), string message = default(string), int updatedAt = default(int), bool? isEmbedded = default(bool?), bool isCreator = default(bool), bool canEdit = default(bool), bool isLocked = default(bool), Dictionary<string, Object> metadata = default(Dictionary<string, Object>), List<TemplateResponseSignerRole> signerRoles = default(List<TemplateResponseSignerRole>), List<TemplateResponseCCRole> ccRoles = default(List<TemplateResponseCCRole>), List<TemplateResponseDocument> documents = default(List<TemplateResponseDocument>), List<TemplateResponseDocumentCustomFieldBase> customFields = default(List<TemplateResponseDocumentCustomFieldBase>), List<TemplateResponseDocumentFormFieldBase> namedFormFields = default(List<TemplateResponseDocumentFormFieldBase>), List<TemplateResponseAccount> accounts = default(List<TemplateResponseAccount>), List<SignatureRequestResponseAttachment> attachments = default(List<SignatureRequestResponseAttachment>))
/// <param name="allowFormView">Allows signers to view the form fields before signing if set to &#x60;true&#x60;. Defaults to &#x60;false&#x60;..</param>
public TemplateResponse(string templateId = default(string), string title = default(string), string message = default(string), int updatedAt = default(int), bool? isEmbedded = default(bool?), bool isCreator = default(bool), bool canEdit = default(bool), bool isLocked = default(bool), Dictionary<string, Object> metadata = default(Dictionary<string, Object>), List<TemplateResponseSignerRole> signerRoles = default(List<TemplateResponseSignerRole>), List<TemplateResponseCCRole> ccRoles = default(List<TemplateResponseCCRole>), List<TemplateResponseDocument> documents = default(List<TemplateResponseDocument>), List<TemplateResponseDocumentCustomFieldBase> customFields = default(List<TemplateResponseDocumentCustomFieldBase>), List<TemplateResponseDocumentFormFieldBase> namedFormFields = default(List<TemplateResponseDocumentFormFieldBase>), List<TemplateResponseAccount> accounts = default(List<TemplateResponseAccount>), List<SignatureRequestResponseAttachment> attachments = default(List<SignatureRequestResponseAttachment>), bool allowFormView = default(bool))
{

this.TemplateId = templateId;
Expand All @@ -76,6 +77,7 @@ protected TemplateResponse() { }
this.NamedFormFields = namedFormFields;
this.Accounts = accounts;
this.Attachments = attachments;
this.AllowFormView = allowFormView;
}

/// <summary>
Expand Down Expand Up @@ -208,6 +210,13 @@ public static TemplateResponse Init(string jsonData)
[DataMember(Name = "attachments", EmitDefaultValue = true)]
public List<SignatureRequestResponseAttachment> Attachments { get; set; }

/// <summary>
/// Allows signers to view the form fields before signing if set to &#x60;true&#x60;. Defaults to &#x60;false&#x60;.
/// </summary>
/// <value>Allows signers to view the form fields before signing if set to &#x60;true&#x60;. Defaults to &#x60;false&#x60;.</value>
[DataMember(Name = "allow_form_view", EmitDefaultValue = true)]
public bool AllowFormView { get; set; }

/// <summary>
/// Returns the string presentation of the object
/// </summary>
Expand All @@ -232,6 +241,7 @@ public override string ToString()
sb.Append(" NamedFormFields: ").Append(NamedFormFields).Append("\n");
sb.Append(" Accounts: ").Append(Accounts).Append("\n");
sb.Append(" Attachments: ").Append(Attachments).Append("\n");
sb.Append(" AllowFormView: ").Append(AllowFormView).Append("\n");
sb.Append("}\n");
return sb.ToString();
}
Expand Down Expand Up @@ -350,6 +360,10 @@ public bool Equals(TemplateResponse input)
this.Attachments != null &&
input.Attachments != null &&
this.Attachments.SequenceEqual(input.Attachments)
) &&
(
this.AllowFormView == input.AllowFormView ||
this.AllowFormView.Equals(input.AllowFormView)
);
}

Expand Down Expand Up @@ -414,6 +428,7 @@ public override int GetHashCode()
{
hashCode = (hashCode * 59) + this.Attachments.GetHashCode();
}
hashCode = (hashCode * 59) + this.AllowFormView.GetHashCode();
return hashCode;
}
}
Expand Down Expand Up @@ -542,6 +557,13 @@ public List<OpenApiType> GetOpenApiTypes()
Type = "List<SignatureRequestResponseAttachment>",
Value = Attachments,
});
types.Add(new OpenApiType()
{
Name = "allow_form_view",
Property = "AllowFormView",
Type = "bool",
Value = AllowFormView,
});

return types;
}
Expand Down
1 change: 1 addition & 0 deletions sdks/java-v1/docs/TemplateResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Contains information about the templates you and your team have created.
| `namedFormFields` | [```List<TemplateResponseDocumentFormFieldBase>```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c&#x3D;200&amp;path&#x3D;template/documents&amp;t&#x3D;response) array instead. | |
| `accounts` | [```List<TemplateResponseAccount>```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | |
| `attachments` | [```List<SignatureRequestResponseAttachment>```](SignatureRequestResponseAttachment.md) | Signer attachments. | |
| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | |



Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@
TemplateResponse.JSON_PROPERTY_CUSTOM_FIELDS,
TemplateResponse.JSON_PROPERTY_NAMED_FORM_FIELDS,
TemplateResponse.JSON_PROPERTY_ACCOUNTS,
TemplateResponse.JSON_PROPERTY_ATTACHMENTS
TemplateResponse.JSON_PROPERTY_ATTACHMENTS,
TemplateResponse.JSON_PROPERTY_ALLOW_FORM_VIEW
})
@javax.annotation.Generated(
value = "org.openapitools.codegen.languages.JavaClientCodegen",
Expand Down Expand Up @@ -99,6 +100,9 @@ public class TemplateResponse {
public static final String JSON_PROPERTY_ATTACHMENTS = "attachments";
@javax.annotation.Nullable private List<SignatureRequestResponseAttachment> attachments = null;

public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view";
@javax.annotation.Nullable private Boolean allowFormView;

public TemplateResponse() {}

/**
Expand Down Expand Up @@ -568,6 +572,29 @@ public void setAttachments(
this.attachments = attachments;
}

public TemplateResponse allowFormView(@javax.annotation.Nullable Boolean allowFormView) {
this.allowFormView = allowFormView;
return this;
}

/**
* Allows signers to view the form fields before signing if set to &#x60;true&#x60;. Defaults to
* &#x60;false&#x60;.
*
* @return allowFormView
*/
@javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Boolean getAllowFormView() {
return allowFormView;
}

@JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setAllowFormView(@javax.annotation.Nullable Boolean allowFormView) {
this.allowFormView = allowFormView;
}

/** Return true if this TemplateResponse object is equal to o. */
@Override
public boolean equals(Object o) {
Expand All @@ -593,7 +620,8 @@ public boolean equals(Object o) {
&& Objects.equals(this.customFields, templateResponse.customFields)
&& Objects.equals(this.namedFormFields, templateResponse.namedFormFields)
&& Objects.equals(this.accounts, templateResponse.accounts)
&& Objects.equals(this.attachments, templateResponse.attachments);
&& Objects.equals(this.attachments, templateResponse.attachments)
&& Objects.equals(this.allowFormView, templateResponse.allowFormView);
}

@Override
Expand All @@ -614,7 +642,8 @@ public int hashCode() {
customFields,
namedFormFields,
accounts,
attachments);
attachments,
allowFormView);
}

@Override
Expand All @@ -637,6 +666,7 @@ public String toString() {
sb.append(" namedFormFields: ").append(toIndentedString(namedFormFields)).append("\n");
sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n");
sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n");
sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n");
sb.append("}");
return sb.toString();
}
Expand Down Expand Up @@ -953,6 +983,26 @@ public Map<String, Object> createFormData() throws ApiException {
JSON.getDefault().getMapper().writeValueAsString(attachments));
}
}
if (allowFormView != null) {
if (isFileTypeOrListOfFiles(allowFormView)) {
fileTypeFound = true;
}

if (allowFormView.getClass().equals(java.io.File.class)
|| allowFormView.getClass().equals(Integer.class)
|| allowFormView.getClass().equals(String.class)
|| allowFormView.getClass().isEnum()) {
map.put("allow_form_view", allowFormView);
} else if (isListOfFile(allowFormView)) {
for (int i = 0; i < getListSize(allowFormView); i++) {
map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i));
}
} else {
map.put(
"allow_form_view",
JSON.getDefault().getMapper().writeValueAsString(allowFormView));
}
}
} catch (Exception e) {
throw new ApiException(e);
}
Expand Down
1 change: 1 addition & 0 deletions sdks/java-v2/docs/TemplateResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Contains information about the templates you and your team have created.
| `namedFormFields` | [```List<TemplateResponseDocumentFormFieldBase>```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c&#x3D;200&amp;path&#x3D;template/documents&amp;t&#x3D;response) array instead. | |
| `accounts` | [```List<TemplateResponseAccount>```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | |
| `attachments` | [```List<SignatureRequestResponseAttachment>```](SignatureRequestResponseAttachment.md) | Signer attachments. | |
| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | |



Loading