Skip to content

Add new certification_types parameter, for nom 151 support #347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
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
12 changes: 12 additions & 0 deletions openapi-raw.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7248,6 +7248,8 @@ components:
description: '_t__SignatureRequestSend::EXPIRES_AT'
type: integer
nullable: true
certification_types:
$ref: '#/components/schemas/SubCertificationTypes'
type: object
SignatureRequestSendWithTemplateRequest:
description: ''
Expand Down Expand Up @@ -7329,6 +7331,8 @@ components:
description: '_t__SignatureRequestSendWithTemplate::TITLE'
type: string
maxLength: 255
certification_types:
$ref: '#/components/schemas/SubCertificationTypes'
type: object
SignatureRequestUpdateRequest:
required:
Expand Down Expand Up @@ -7406,6 +7410,14 @@ components:
type: string
format: email
type: object
SubCertificationTypes:
description: '_t__Sub::CertificationTypes::DESCRIPTION'
properties:
nom_151:
description: '_t__Sub::CertificationTypes::NOM_151'
type: boolean
default: false
type: object
SubCustomField:
description: '_t__Sub::CustomField::DESCRIPTION'
required:
Expand Down
17 changes: 17 additions & 0 deletions openapi-sdk.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7571,6 +7571,8 @@ components:
description: '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.'
type: integer
nullable: true
certification_types:
$ref: '#/components/schemas/SubCertificationTypes'
type: object
SignatureRequestSendWithTemplateRequest:
description: ''
Expand Down Expand Up @@ -7670,6 +7672,8 @@ components:
description: 'The title you want to assign to the SignatureRequest.'
type: string
maxLength: 255
certification_types:
$ref: '#/components/schemas/SubCertificationTypes'
type: object
SignatureRequestUpdateRequest:
required:
Expand Down Expand Up @@ -7761,6 +7765,19 @@ components:
type: string
format: email
type: object
SubCertificationTypes:
description: |-
Optional certification types to be applied to your Signature Request after completion.

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.

At this time only a single certification type can be selected per Signature Request.
properties:
nom_151:
description: 'NOM 151, or Normativa 151, is a certificate which verifies the integrity of an electronically signed document in compliance with Mexican regulations.'
type: boolean
default: false
type: object
SubCustomField:
description: |-
When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.
Expand Down
17 changes: 17 additions & 0 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7292,6 +7292,8 @@ components:
description: '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.'
type: integer
nullable: true
certification_types:
$ref: '#/components/schemas/SubCertificationTypes'
type: object
SignatureRequestSendWithTemplateRequest:
description: ''
Expand Down Expand Up @@ -7380,6 +7382,8 @@ components:
description: 'The title you want to assign to the SignatureRequest.'
type: string
maxLength: 255
certification_types:
$ref: '#/components/schemas/SubCertificationTypes'
type: object
SignatureRequestUpdateRequest:
required:
Expand Down Expand Up @@ -7471,6 +7475,19 @@ components:
type: string
format: email
type: object
SubCertificationTypes:
description: |-
Optional certification types to be applied to your Signature Request after completion.

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.

At this time only a single certification type can be selected per Signature Request.
properties:
nom_151:
description: 'NOM 151, or Normativa 151, is a certificate which verifies the integrity of an electronically signed document in compliance with Mexican regulations.'
type: boolean
default: false
type: object
SubCustomField:
description: |-
When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.
Expand Down
1 change: 1 addition & 0 deletions sdks/dotnet/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,7 @@ Class | Method | HTTP request | Description
- [Model.SubBulkSignerList](docs/SubBulkSignerList.md)
- [Model.SubBulkSignerListCustomField](docs/SubBulkSignerListCustomField.md)
- [Model.SubCC](docs/SubCC.md)
- [Model.SubCertificationTypes](docs/SubCertificationTypes.md)
- [Model.SubCustomField](docs/SubCustomField.md)
- [Model.SubEditorOptions](docs/SubEditorOptions.md)
- [Model.SubFieldOptions](docs/SubFieldOptions.md)
Expand Down
1 change: 1 addition & 0 deletions sdks/dotnet/docs/SignatureRequestSendRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Name | Type | Description | Notes
**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional]
**UseTextTags** | **bool** | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [optional] [default to false]
**ExpiresAt** | **int?** | 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. | [optional]
**CertificationTypes** | [**SubCertificationTypes**](SubCertificationTypes.md) | | [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)

Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Name | Type | Description | Notes
**Subject** | **string** | The subject in the email that will be sent to the signers. | [optional]
**TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]
**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional]
**CertificationTypes** | [**SubCertificationTypes**](SubCertificationTypes.md) | | [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)

11 changes: 11 additions & 0 deletions sdks/dotnet/docs/SubCertificationTypes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Dropbox.Sign.Model.SubCertificationTypes
Optional certification types to be applied to your Signature Request after completion. 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. At this time only a single certification type can be selected per Signature Request.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Nom151** | **bool** | NOM 151, or Normativa 151, is a certificate which verifies the integrity of an electronically signed document in compliance with Mexican regulations. | [optional] [default to false]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,8 @@ protected SignatureRequestSendRequest() { }
/// <param name="title">The title you want to assign to the SignatureRequest..</param>
/// <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>
/// <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>
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?))
/// <param name="certificationTypes">certificationTypes.</param>
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?), SubCertificationTypes certificationTypes = default(SubCertificationTypes))
{

this.Files = files;
Expand Down Expand Up @@ -96,6 +97,7 @@ protected SignatureRequestSendRequest() { }
this.Title = title;
this.UseTextTags = useTextTags;
this.ExpiresAt = expiresAt;
this.CertificationTypes = certificationTypes;
}

/// <summary>
Expand Down Expand Up @@ -295,6 +297,12 @@ public static SignatureRequestSendRequest Init(string jsonData)
[DataMember(Name = "expires_at", EmitDefaultValue = true)]
public int? ExpiresAt { get; set; }

/// <summary>
/// Gets or Sets CertificationTypes
/// </summary>
[DataMember(Name = "certification_types", EmitDefaultValue = true)]
public SubCertificationTypes CertificationTypes { get; set; }

/// <summary>
/// Returns the string presentation of the object
/// </summary>
Expand Down Expand Up @@ -329,6 +337,7 @@ public override string ToString()
sb.Append(" Title: ").Append(Title).Append("\n");
sb.Append(" UseTextTags: ").Append(UseTextTags).Append("\n");
sb.Append(" ExpiresAt: ").Append(ExpiresAt).Append("\n");
sb.Append(" CertificationTypes: ").Append(CertificationTypes).Append("\n");
sb.Append("}\n");
return sb.ToString();
}
Expand Down Expand Up @@ -497,6 +506,11 @@ public bool Equals(SignatureRequestSendRequest input)
this.ExpiresAt == input.ExpiresAt ||
(this.ExpiresAt != null &&
this.ExpiresAt.Equals(input.ExpiresAt))
) &&
(
this.CertificationTypes == input.CertificationTypes ||
(this.CertificationTypes != null &&
this.CertificationTypes.Equals(input.CertificationTypes))
);
}

Expand Down Expand Up @@ -592,6 +606,10 @@ public override int GetHashCode()
{
hashCode = (hashCode * 59) + this.ExpiresAt.GetHashCode();
}
if (this.CertificationTypes != null)
{
hashCode = (hashCode * 59) + this.CertificationTypes.GetHashCode();
}
return hashCode;
}
}
Expand Down Expand Up @@ -755,6 +773,12 @@ public List<OpenApiType> GetOpenApiTypes()
Type = "int?",
Value = ExpiresAt,
});
types.Add(new OpenApiType(){
Name = "certification_types",
Property = "CertificationTypes",
Type = "SubCertificationTypes",
Value = CertificationTypes,
});

return types;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,8 @@ protected SignatureRequestSendWithTemplateRequest() { }
/// <param name="subject">The subject in the email that will be sent to the signers..</param>
/// <param name="testMode">Whether this is a test, the signature request will not be legally binding if set to &#x60;true&#x60;. Defaults to &#x60;false&#x60;. (default to false).</param>
/// <param name="title">The title you want to assign to the SignatureRequest..</param>
public SignatureRequestSendWithTemplateRequest(List<string> templateIds = default(List<string>), bool allowDecline = false, List<SubCC> ccs = default(List<SubCC>), string clientId = default(string), List<SubCustomField> customFields = default(List<SubCustomField>), List<System.IO.Stream> files = default(List<System.IO.Stream>), List<string> fileUrls = default(List<string>), bool isQualifiedSignature = false, bool isEid = false, string message = default(string), Dictionary<string, Object> metadata = default(Dictionary<string, Object>), List<SubSignatureRequestTemplateSigner> signers = default(List<SubSignatureRequestTemplateSigner>), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, string title = default(string))
/// <param name="certificationTypes">certificationTypes.</param>
public SignatureRequestSendWithTemplateRequest(List<string> templateIds = default(List<string>), bool allowDecline = false, List<SubCC> ccs = default(List<SubCC>), string clientId = default(string), List<SubCustomField> customFields = default(List<SubCustomField>), List<System.IO.Stream> files = default(List<System.IO.Stream>), List<string> fileUrls = default(List<string>), bool isQualifiedSignature = false, bool isEid = false, string message = default(string), Dictionary<string, Object> metadata = default(Dictionary<string, Object>), List<SubSignatureRequestTemplateSigner> signers = default(List<SubSignatureRequestTemplateSigner>), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, string title = default(string), SubCertificationTypes certificationTypes = default(SubCertificationTypes))
{

// to ensure "templateIds" is required (not null)
Expand Down Expand Up @@ -88,6 +89,7 @@ protected SignatureRequestSendWithTemplateRequest() { }
this.Subject = subject;
this.TestMode = testMode;
this.Title = title;
this.CertificationTypes = certificationTypes;
}

/// <summary>
Expand Down Expand Up @@ -225,6 +227,12 @@ public static SignatureRequestSendWithTemplateRequest Init(string jsonData)
[DataMember(Name = "title", EmitDefaultValue = true)]
public string Title { get; set; }

/// <summary>
/// Gets or Sets CertificationTypes
/// </summary>
[DataMember(Name = "certification_types", EmitDefaultValue = true)]
public SubCertificationTypes CertificationTypes { get; set; }

/// <summary>
/// Returns the string presentation of the object
/// </summary>
Expand All @@ -250,6 +258,7 @@ public override string ToString()
sb.Append(" Subject: ").Append(Subject).Append("\n");
sb.Append(" TestMode: ").Append(TestMode).Append("\n");
sb.Append(" Title: ").Append(Title).Append("\n");
sb.Append(" CertificationTypes: ").Append(CertificationTypes).Append("\n");
sb.Append("}\n");
return sb.ToString();
}
Expand Down Expand Up @@ -372,6 +381,11 @@ public bool Equals(SignatureRequestSendWithTemplateRequest input)
this.Title == input.Title ||
(this.Title != null &&
this.Title.Equals(input.Title))
) &&
(
this.CertificationTypes == input.CertificationTypes ||
(this.CertificationTypes != null &&
this.CertificationTypes.Equals(input.CertificationTypes))
);
}

Expand Down Expand Up @@ -440,6 +454,10 @@ public override int GetHashCode()
{
hashCode = (hashCode * 59) + this.Title.GetHashCode();
}
if (this.CertificationTypes != null)
{
hashCode = (hashCode * 59) + this.CertificationTypes.GetHashCode();
}
return hashCode;
}
}
Expand Down Expand Up @@ -549,6 +567,12 @@ public List<OpenApiType> GetOpenApiTypes()
Type = "string",
Value = Title,
});
types.Add(new OpenApiType(){
Name = "certification_types",
Property = "CertificationTypes",
Type = "SubCertificationTypes",
Value = CertificationTypes,
});

return types;
}
Expand Down
Loading