Skip to content

Commit fba8323

Browse files
Add new certification_types parameter, for nom 151 support
1 parent c4554ed commit fba8323

31 files changed

Lines changed: 396 additions & 6 deletions

openapi-raw.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7011,6 +7011,12 @@ components:
70117011
description: '_t__SignatureRequestSend::IS_EID'
70127012
type: boolean
70137013
default: false
7014+
certification_types:
7015+
description: '_t__SignatureRequestSend::CERTIFICATION_TYPES'
7016+
type: array
7017+
items:
7018+
type: string
7019+
default: []
70147020
message:
70157021
description: '_t__SignatureRequestSend::MESSAGE'
70167022
type: string
@@ -7095,6 +7101,12 @@ components:
70957101
description: '_t__SignatureRequestSendWithTemplate::IS_EID'
70967102
type: boolean
70977103
default: false
7104+
certification_types:
7105+
description: '_t__SignatureRequestSendWithTemplate::CERTIFICATION_TYPES'
7106+
type: array
7107+
items:
7108+
type: string
7109+
default: []
70987110
message:
70997111
description: '_t__SignatureRequestSendWithTemplate::MESSAGE'
71007112
type: string

openapi-sdk.yaml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7309,6 +7309,17 @@ components:
73097309
**Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
73107310
type: boolean
73117311
default: false
7312+
certification_types:
7313+
description: |-
7314+
Optional certification types to be applied to your Signature Request after completion.
7315+
7316+
After all parties have signed and completed identity verification (if `is_eid` is `true`), your document's hash will be sent to the specified certificate authority for archiving and integrity verification.
7317+
7318+
At this time only a single certification type can be selected per Signature Request.
7319+
type: array
7320+
items:
7321+
type: string
7322+
default: []
73127323
message:
73137324
description: 'The custom message in the email that will be sent to the signers.'
73147325
type: string
@@ -7411,6 +7422,17 @@ components:
74117422
**Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
74127423
type: boolean
74137424
default: false
7425+
certification_types:
7426+
description: |-
7427+
Optional certification types to be applied to your Signature Request after completion.
7428+
7429+
After all parties have signed and completed identity verification (if `is_eid` is `true`), your document's hash will be sent to the specified certificate authority for archiving and integrity verification.
7430+
7431+
At this time only a single certification type can be selected per Signature Request.
7432+
type: array
7433+
items:
7434+
type: string
7435+
default: []
74147436
message:
74157437
description: 'The custom message in the email that will be sent to the signers.'
74167438
type: string

openapi.yaml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7163,6 +7163,17 @@ components:
71637163
**Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
71647164
type: boolean
71657165
default: false
7166+
certification_types:
7167+
description: |-
7168+
Optional certification types to be applied to your Signature Request after completion.
7169+
7170+
After all parties have signed and completed identity verification (if `is_eid` is `true`), your document's hash will be sent to the specified certificate authority for archiving and integrity verification.
7171+
7172+
At this time only a single certification type can be selected per Signature Request.
7173+
type: array
7174+
items:
7175+
type: string
7176+
default: []
71667177
message:
71677178
description: 'The custom message in the email that will be sent to the signers.'
71687179
type: string
@@ -7254,6 +7265,17 @@ components:
72547265
**Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
72557266
type: boolean
72567267
default: false
7268+
certification_types:
7269+
description: |-
7270+
Optional certification types to be applied to your Signature Request after completion.
7271+
7272+
After all parties have signed and completed identity verification (if `is_eid` is `true`), your document's hash will be sent to the specified certificate authority for archiving and integrity verification.
7273+
7274+
At this time only a single certification type can be selected per Signature Request.
7275+
type: array
7276+
items:
7277+
type: string
7278+
default: []
72577279
message:
72587280
description: 'The custom message in the email that will be sent to the signers.'
72597281
type: string

sdks/dotnet/docs/SignatureRequestSendRequest.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Name | Type | Description | Notes
2121
**HideTextTags** | **bool** | Enables automatic Text Tag removal when set to true.<br><br>**NOTE**: Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [optional] [default to false]
2222
**IsQualifiedSignature** | **bool** | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer&#39;s identity.&lt;br&gt;<br>**Note**: QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]
2323
**IsEid** | **bool** | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.&lt;br&gt;<br>**Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]
24+
**CertificationTypes** | **List&lt;string&gt;** | Optional certification types to be applied to your Signature Request after completion.<br><br>After all parties have signed and completed identity verification (if `is_eid` is `true`), your document&#39;s hash will be sent to the specified certificate authority for archiving and integrity verification.<br><br>At this time only a single certification type can be selected per Signature Request. | [optional]
2425
**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional]
2526
**Metadata** | **Dictionary&lt;string, Object&gt;** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer&#39;s order number for look up when receiving events for the signature request.<br><br>Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional]
2627
**SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional]

sdks/dotnet/docs/SignatureRequestSendWithTemplateRequest.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
1414
**FileUrls** | **List&lt;string&gt;** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | [optional]
1515
**IsQualifiedSignature** | **bool** | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer&#39;s identity.&lt;br&gt;<br>**Note**: QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]
1616
**IsEid** | **bool** | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.&lt;br&gt;<br>**Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]
17+
**CertificationTypes** | **List&lt;string&gt;** | Optional certification types to be applied to your Signature Request after completion.<br><br>After all parties have signed and completed identity verification (if `is_eid` is `true`), your document&#39;s hash will be sent to the specified certificate authority for archiving and integrity verification.<br><br>At this time only a single certification type can be selected per Signature Request. | [optional]
1718
**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional]
1819
**Metadata** | **Dictionary&lt;string, Object&gt;** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer&#39;s order number for look up when receiving events for the signature request.<br><br>Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional]
1920
**SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional]

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

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ protected SignatureRequestSendRequest() { }
5858
/// <param name="hideTextTags">Enables automatic Text Tag removal when set to true. **NOTE**: Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on &#x60;false&#x60; and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. (default to false).</param>
5959
/// <param name="isQualifiedSignature">Send with a value of &#x60;true&#x60; if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer&#39;s identity.&lt;br&gt; **Note**: QES is only available on the Premium API plan as an add-on purchase. Cannot be used in &#x60;test_mode&#x60;. Only works on requests with one signer. (default to false).</param>
6060
/// <param name="isEid">Send with a value of &#x60;true&#x60; if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.&lt;br&gt; **Note**: eID is only available on the Premium API plan. Cannot be used in &#x60;test_mode&#x60;. Only works on requests with one signer. (default to false).</param>
61+
/// <param name="certificationTypes">Optional certification types to be applied to your Signature Request after completion. After all parties have signed and completed identity verification (if &#x60;is_eid&#x60; is &#x60;true&#x60;), your document&#39;s hash will be sent to the specified certificate authority for archiving and integrity verification. At this time only a single certification type can be selected per Signature Request..</param>
6162
/// <param name="message">The custom message in the email that will be sent to the signers..</param>
6263
/// <param name="metadata">Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer&#39;s order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long..</param>
6364
/// <param name="signingOptions">signingOptions.</param>
@@ -67,7 +68,7 @@ protected SignatureRequestSendRequest() { }
6768
/// <param name="title">The title you want to assign to the SignatureRequest..</param>
6869
/// <param name="useTextTags">Send with a value of &#x60;true&#x60; if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or &#x60;false&#x60;. (default to false).</param>
6970
/// <param name="expiresAt">When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details..</param>
70-
public SignatureRequestSendRequest(List<System.IO.Stream> files = default(List<System.IO.Stream>), List<string> fileUrls = default(List<string>), List<SubSignatureRequestSigner> signers = default(List<SubSignatureRequestSigner>), List<SubSignatureRequestGroupedSigners> groupedSigners = default(List<SubSignatureRequestGroupedSigners>), bool allowDecline = false, bool allowReassign = false, List<SubAttachment> attachments = default(List<SubAttachment>), List<string> ccEmailAddresses = default(List<string>), string clientId = default(string), List<SubCustomField> customFields = default(List<SubCustomField>), SubFieldOptions fieldOptions = default(SubFieldOptions), List<SubFormFieldGroup> formFieldGroups = default(List<SubFormFieldGroup>), List<SubFormFieldRule> formFieldRules = default(List<SubFormFieldRule>), List<SubFormFieldsPerDocumentBase> formFieldsPerDocument = default(List<SubFormFieldsPerDocumentBase>), bool hideTextTags = false, bool isQualifiedSignature = false, bool isEid = false, string message = default(string), Dictionary<string, Object> metadata = default(Dictionary<string, Object>), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, int? expiresAt = default(int?))
71+
public SignatureRequestSendRequest(List<System.IO.Stream> files = default(List<System.IO.Stream>), List<string> fileUrls = default(List<string>), List<SubSignatureRequestSigner> signers = default(List<SubSignatureRequestSigner>), List<SubSignatureRequestGroupedSigners> groupedSigners = default(List<SubSignatureRequestGroupedSigners>), bool allowDecline = false, bool allowReassign = false, List<SubAttachment> attachments = default(List<SubAttachment>), List<string> ccEmailAddresses = default(List<string>), string clientId = default(string), List<SubCustomField> customFields = default(List<SubCustomField>), SubFieldOptions fieldOptions = default(SubFieldOptions), List<SubFormFieldGroup> formFieldGroups = default(List<SubFormFieldGroup>), List<SubFormFieldRule> formFieldRules = default(List<SubFormFieldRule>), List<SubFormFieldsPerDocumentBase> formFieldsPerDocument = default(List<SubFormFieldsPerDocumentBase>), bool hideTextTags = false, bool isQualifiedSignature = false, bool isEid = false, List<string> certificationTypes = default(List<string>), string message = default(string), Dictionary<string, Object> metadata = default(Dictionary<string, Object>), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, int? expiresAt = default(int?))
7172
{
7273

7374
this.Files = files;
@@ -87,6 +88,7 @@ protected SignatureRequestSendRequest() { }
8788
this.HideTextTags = hideTextTags;
8889
this.IsQualifiedSignature = isQualifiedSignature;
8990
this.IsEid = isEid;
91+
this.CertificationTypes = certificationTypes;
9092
this.Message = message;
9193
this.Metadata = metadata;
9294
this.SigningOptions = signingOptions;
@@ -233,6 +235,13 @@ public static SignatureRequestSendRequest Init(string jsonData)
233235
[DataMember(Name = "is_eid", EmitDefaultValue = true)]
234236
public bool IsEid { get; set; }
235237

238+
/// <summary>
239+
/// Optional certification types to be applied to your Signature Request after completion. After all parties have signed and completed identity verification (if &#x60;is_eid&#x60; is &#x60;true&#x60;), your document&#39;s hash will be sent to the specified certificate authority for archiving and integrity verification. At this time only a single certification type can be selected per Signature Request.
240+
/// </summary>
241+
/// <value>Optional certification types to be applied to your Signature Request after completion. After all parties have signed and completed identity verification (if &#x60;is_eid&#x60; is &#x60;true&#x60;), your document&#39;s hash will be sent to the specified certificate authority for archiving and integrity verification. At this time only a single certification type can be selected per Signature Request.</value>
242+
[DataMember(Name = "certification_types", EmitDefaultValue = true)]
243+
public List<string> CertificationTypes { get; set; }
244+
236245
/// <summary>
237246
/// The custom message in the email that will be sent to the signers.
238247
/// </summary>
@@ -320,6 +329,7 @@ public override string ToString()
320329
sb.Append(" HideTextTags: ").Append(HideTextTags).Append("\n");
321330
sb.Append(" IsQualifiedSignature: ").Append(IsQualifiedSignature).Append("\n");
322331
sb.Append(" IsEid: ").Append(IsEid).Append("\n");
332+
sb.Append(" CertificationTypes: ").Append(CertificationTypes).Append("\n");
323333
sb.Append(" Message: ").Append(Message).Append("\n");
324334
sb.Append(" Metadata: ").Append(Metadata).Append("\n");
325335
sb.Append(" SigningOptions: ").Append(SigningOptions).Append("\n");
@@ -454,6 +464,12 @@ public bool Equals(SignatureRequestSendRequest input)
454464
this.IsEid == input.IsEid ||
455465
this.IsEid.Equals(input.IsEid)
456466
) &&
467+
(
468+
this.CertificationTypes == input.CertificationTypes ||
469+
this.CertificationTypes != null &&
470+
input.CertificationTypes != null &&
471+
this.CertificationTypes.SequenceEqual(input.CertificationTypes)
472+
) &&
457473
(
458474
this.Message == input.Message ||
459475
(this.Message != null &&
@@ -562,6 +578,10 @@ public override int GetHashCode()
562578
hashCode = (hashCode * 59) + this.HideTextTags.GetHashCode();
563579
hashCode = (hashCode * 59) + this.IsQualifiedSignature.GetHashCode();
564580
hashCode = (hashCode * 59) + this.IsEid.GetHashCode();
581+
if (this.CertificationTypes != null)
582+
{
583+
hashCode = (hashCode * 59) + this.CertificationTypes.GetHashCode();
584+
}
565585
if (this.Message != null)
566586
{
567587
hashCode = (hashCode * 59) + this.Message.GetHashCode();
@@ -701,6 +721,12 @@ public List<OpenApiType> GetOpenApiTypes()
701721
Type = "bool",
702722
Value = IsEid,
703723
});
724+
types.Add(new OpenApiType(){
725+
Name = "certification_types",
726+
Property = "CertificationTypes",
727+
Type = "List<string>",
728+
Value = CertificationTypes,
729+
});
704730
types.Add(new OpenApiType(){
705731
Name = "message",
706732
Property = "Message",

0 commit comments

Comments
 (0)