diff --git a/openapi-raw.yaml b/openapi-raw.yaml index 207e9ebbb..a0417176b 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -7248,6 +7248,8 @@ components: description: '_t__SignatureRequestSend::EXPIRES_AT' type: integer nullable: true + certification_types: + $ref: '#/components/schemas/SubCertificationTypes' type: object SignatureRequestSendWithTemplateRequest: description: '' @@ -7329,6 +7331,8 @@ components: description: '_t__SignatureRequestSendWithTemplate::TITLE' type: string maxLength: 255 + certification_types: + $ref: '#/components/schemas/SubCertificationTypes' type: object SignatureRequestUpdateRequest: required: @@ -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: diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 1e78afe08..48f628b59 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -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: '' @@ -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: @@ -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. diff --git a/openapi.yaml b/openapi.yaml index d1572ac22..7859a4722 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -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: '' @@ -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: @@ -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. diff --git a/sdks/dotnet/README.md b/sdks/dotnet/README.md index 58834c76e..e0ce8e584 100644 --- a/sdks/dotnet/README.md +++ b/sdks/dotnet/README.md @@ -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) diff --git a/sdks/dotnet/docs/SignatureRequestSendRequest.md b/sdks/dotnet/docs/SignatureRequestSendRequest.md index 7828abaa8..2b0b749e8 100644 --- a/sdks/dotnet/docs/SignatureRequestSendRequest.md +++ b/sdks/dotnet/docs/SignatureRequestSendRequest.md @@ -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) diff --git a/sdks/dotnet/docs/SignatureRequestSendWithTemplateRequest.md b/sdks/dotnet/docs/SignatureRequestSendWithTemplateRequest.md index 1f9dd836f..e6e497953 100644 --- a/sdks/dotnet/docs/SignatureRequestSendWithTemplateRequest.md +++ b/sdks/dotnet/docs/SignatureRequestSendWithTemplateRequest.md @@ -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) diff --git a/sdks/dotnet/docs/SubCertificationTypes.md b/sdks/dotnet/docs/SubCertificationTypes.md new file mode 100644 index 000000000..6e1ce5f6c --- /dev/null +++ b/sdks/dotnet/docs/SubCertificationTypes.md @@ -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) + diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendRequest.cs index b0b84a051..9b53e5fc7 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendRequest.cs @@ -67,7 +67,8 @@ protected SignatureRequestSendRequest() { } /// The title you want to assign to the SignatureRequest.. /// 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`. (default to false). /// 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.. - public SignatureRequestSendRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, bool isQualifiedSignature = false, bool isEid = false, string message = default(string), Dictionary metadata = default(Dictionary), 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?)) + /// certificationTypes. + public SignatureRequestSendRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, bool isQualifiedSignature = false, bool isEid = false, string message = default(string), Dictionary metadata = default(Dictionary), 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; @@ -96,6 +97,7 @@ protected SignatureRequestSendRequest() { } this.Title = title; this.UseTextTags = useTextTags; this.ExpiresAt = expiresAt; + this.CertificationTypes = certificationTypes; } /// @@ -295,6 +297,12 @@ public static SignatureRequestSendRequest Init(string jsonData) [DataMember(Name = "expires_at", EmitDefaultValue = true)] public int? ExpiresAt { get; set; } + /// + /// Gets or Sets CertificationTypes + /// + [DataMember(Name = "certification_types", EmitDefaultValue = true)] + public SubCertificationTypes CertificationTypes { get; set; } + /// /// Returns the string presentation of the object /// @@ -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(); } @@ -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)) ); } @@ -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; } } @@ -755,6 +773,12 @@ public List GetOpenApiTypes() Type = "int?", Value = ExpiresAt, }); + types.Add(new OpenApiType(){ + Name = "certification_types", + Property = "CertificationTypes", + Type = "SubCertificationTypes", + Value = CertificationTypes, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendWithTemplateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendWithTemplateRequest.cs index 70eaa60f9..7837ace17 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendWithTemplateRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendWithTemplateRequest.cs @@ -58,7 +58,8 @@ protected SignatureRequestSendWithTemplateRequest() { } /// The subject in the email that will be sent to the signers.. /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. (default to false). /// The title you want to assign to the SignatureRequest.. - public SignatureRequestSendWithTemplateRequest(List templateIds = default(List), bool allowDecline = false, List ccs = default(List), string clientId = default(string), List customFields = default(List), List files = default(List), List fileUrls = default(List), bool isQualifiedSignature = false, bool isEid = false, string message = default(string), Dictionary metadata = default(Dictionary), List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, string title = default(string)) + /// certificationTypes. + public SignatureRequestSendWithTemplateRequest(List templateIds = default(List), bool allowDecline = false, List ccs = default(List), string clientId = default(string), List customFields = default(List), List files = default(List), List fileUrls = default(List), bool isQualifiedSignature = false, bool isEid = false, string message = default(string), Dictionary metadata = default(Dictionary), List signers = default(List), 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) @@ -88,6 +89,7 @@ protected SignatureRequestSendWithTemplateRequest() { } this.Subject = subject; this.TestMode = testMode; this.Title = title; + this.CertificationTypes = certificationTypes; } /// @@ -225,6 +227,12 @@ public static SignatureRequestSendWithTemplateRequest Init(string jsonData) [DataMember(Name = "title", EmitDefaultValue = true)] public string Title { get; set; } + /// + /// Gets or Sets CertificationTypes + /// + [DataMember(Name = "certification_types", EmitDefaultValue = true)] + public SubCertificationTypes CertificationTypes { get; set; } + /// /// Returns the string presentation of the object /// @@ -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(); } @@ -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)) ); } @@ -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; } } @@ -549,6 +567,12 @@ public List GetOpenApiTypes() Type = "string", Value = Title, }); + types.Add(new OpenApiType(){ + Name = "certification_types", + Property = "CertificationTypes", + Type = "SubCertificationTypes", + Value = CertificationTypes, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubCertificationTypes.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubCertificationTypes.cs new file mode 100644 index 000000000..2fbcb91fb --- /dev/null +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubCertificationTypes.cs @@ -0,0 +1,162 @@ +/* + * Dropbox Sign API + * + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.IO; +using System.Runtime.Serialization; +using System.Text; +using System.Text.RegularExpressions; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using System.ComponentModel.DataAnnotations; +using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; + +namespace Dropbox.Sign.Model +{ + /// + /// 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. + /// + [DataContract(Name = "SubCertificationTypes")] + [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] + public partial class SubCertificationTypes : IOpenApiTyped, IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + protected SubCertificationTypes() { } + /// + /// Initializes a new instance of the class. + /// + /// NOM 151, or Normativa 151, is a certificate which verifies the integrity of an electronically signed document in compliance with Mexican regulations. (default to false). + public SubCertificationTypes(bool nom151 = false) + { + + this.Nom151 = nom151; + } + + /// + /// Attempt to instantiate and hydrate a new instance of this class + /// + /// String of JSON data representing target object + public static SubCertificationTypes Init(string jsonData) + { + var obj = JsonConvert.DeserializeObject(jsonData); + + if (obj == null) + { + throw new Exception("Unable to deserialize JSON to instance of SubCertificationTypes"); + } + + return obj; + } + + /// + /// NOM 151, or Normativa 151, is a certificate which verifies the integrity of an electronically signed document in compliance with Mexican regulations. + /// + /// NOM 151, or Normativa 151, is a certificate which verifies the integrity of an electronically signed document in compliance with Mexican regulations. + [DataMember(Name = "nom_151", EmitDefaultValue = true)] + public bool Nom151 { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class SubCertificationTypes {\n"); + sb.Append(" Nom151: ").Append(Nom151).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson() + { + return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object input) + { + return this.Equals(input as SubCertificationTypes); + } + + /// + /// Returns true if SubCertificationTypes instances are equal + /// + /// Instance of SubCertificationTypes to be compared + /// Boolean + public bool Equals(SubCertificationTypes input) + { + if (input == null) + { + return false; + } + return + ( + this.Nom151 == input.Nom151 || + this.Nom151.Equals(input.Nom151) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + hashCode = (hashCode * 59) + this.Nom151.GetHashCode(); + return hashCode; + } + } + + public List GetOpenApiTypes() + { + var types = new List(); + types.Add(new OpenApiType(){ + Name = "nom_151", + Property = "Nom151", + Type = "bool", + Value = Nom151, + }); + + return types; + } + + /// + /// To validate all properties of the instance + /// + /// Validation context + /// Validation Result + public IEnumerable Validate(ValidationContext validationContext) + { + yield break; + } + } + +} diff --git a/sdks/java/README.md b/sdks/java/README.md index 47f1ac41e..d3d35b692 100644 --- a/sdks/java/README.md +++ b/sdks/java/README.md @@ -302,6 +302,7 @@ Class | Method | HTTP request | Description - [SubBulkSignerList](docs/SubBulkSignerList.md) - [SubBulkSignerListCustomField](docs/SubBulkSignerListCustomField.md) - [SubCC](docs/SubCC.md) + - [SubCertificationTypes](docs/SubCertificationTypes.md) - [SubCustomField](docs/SubCustomField.md) - [SubEditorOptions](docs/SubEditorOptions.md) - [SubFieldOptions](docs/SubFieldOptions.md) diff --git a/sdks/java/docs/SignatureRequestSendRequest.md b/sdks/java/docs/SignatureRequestSendRequest.md index 814b97325..05a66a2ce 100644 --- a/sdks/java/docs/SignatureRequestSendRequest.md +++ b/sdks/java/docs/SignatureRequestSendRequest.md @@ -34,6 +34,7 @@ Name | Type | Description | Notes | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `useTextTags` | ```Boolean``` | 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`. | | | `expiresAt` | ```Integer``` | 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. | | +| `certificationTypes` | [```SubCertificationTypes```](SubCertificationTypes.md) | | | diff --git a/sdks/java/docs/SignatureRequestSendWithTemplateRequest.md b/sdks/java/docs/SignatureRequestSendWithTemplateRequest.md index ecb3b0f91..67f87df69 100644 --- a/sdks/java/docs/SignatureRequestSendWithTemplateRequest.md +++ b/sdks/java/docs/SignatureRequestSendWithTemplateRequest.md @@ -25,6 +25,7 @@ Name | Type | Description | Notes | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | +| `certificationTypes` | [```SubCertificationTypes```](SubCertificationTypes.md) | | | diff --git a/sdks/java/docs/SubCertificationTypes.md b/sdks/java/docs/SubCertificationTypes.md new file mode 100644 index 000000000..683ac207f --- /dev/null +++ b/sdks/java/docs/SubCertificationTypes.md @@ -0,0 +1,18 @@ + + +# 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` | ```Boolean``` | NOM 151, or Normativa 151, is a certificate which verifies the integrity of an electronically signed document in compliance with Mexican regulations. | | + + + diff --git a/sdks/java/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java b/sdks/java/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java index dcf391e0b..af5d66672 100644 --- a/sdks/java/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java +++ b/sdks/java/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java @@ -18,6 +18,7 @@ import java.util.Map; import java.util.HashMap; import com.dropbox.sign.model.SubAttachment; +import com.dropbox.sign.model.SubCertificationTypes; import com.dropbox.sign.model.SubCustomField; import com.dropbox.sign.model.SubFieldOptions; import com.dropbox.sign.model.SubFormFieldGroup; @@ -74,7 +75,8 @@ SignatureRequestSendRequest.JSON_PROPERTY_TEST_MODE, SignatureRequestSendRequest.JSON_PROPERTY_TITLE, SignatureRequestSendRequest.JSON_PROPERTY_USE_TEXT_TAGS, - SignatureRequestSendRequest.JSON_PROPERTY_EXPIRES_AT + SignatureRequestSendRequest.JSON_PROPERTY_EXPIRES_AT, + SignatureRequestSendRequest.JSON_PROPERTY_CERTIFICATION_TYPES }) @JsonIgnoreProperties(ignoreUnknown=true) @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen") @@ -157,6 +159,9 @@ public class SignatureRequestSendRequest { public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; private Integer expiresAt; + public static final String JSON_PROPERTY_CERTIFICATION_TYPES = "certification_types"; + private SubCertificationTypes certificationTypes; + public SignatureRequestSendRequest() { } @@ -941,6 +946,32 @@ public void setExpiresAt(Integer expiresAt) { } + public SignatureRequestSendRequest certificationTypes(SubCertificationTypes certificationTypes) { + this.certificationTypes = certificationTypes; + return this; + } + + /** + * Get certificationTypes + * @return certificationTypes + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_CERTIFICATION_TYPES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubCertificationTypes getCertificationTypes() { + return certificationTypes; + } + + + @JsonProperty(JSON_PROPERTY_CERTIFICATION_TYPES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCertificationTypes(SubCertificationTypes certificationTypes) { + this.certificationTypes = certificationTypes; + } + + /** * Return true if this SignatureRequestSendRequest object is equal to o. */ @@ -978,12 +1009,13 @@ public boolean equals(Object o) { Objects.equals(this.testMode, signatureRequestSendRequest.testMode) && Objects.equals(this.title, signatureRequestSendRequest.title) && Objects.equals(this.useTextTags, signatureRequestSendRequest.useTextTags) && - Objects.equals(this.expiresAt, signatureRequestSendRequest.expiresAt); + Objects.equals(this.expiresAt, signatureRequestSendRequest.expiresAt) && + Objects.equals(this.certificationTypes, signatureRequestSendRequest.certificationTypes); } @Override public int hashCode() { - return Objects.hash(files, fileUrls, signers, groupedSigners, allowDecline, allowReassign, attachments, ccEmailAddresses, clientId, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, isQualifiedSignature, isEid, message, metadata, signingOptions, signingRedirectUrl, subject, testMode, title, useTextTags, expiresAt); + return Objects.hash(files, fileUrls, signers, groupedSigners, allowDecline, allowReassign, attachments, ccEmailAddresses, clientId, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, isQualifiedSignature, isEid, message, metadata, signingOptions, signingRedirectUrl, subject, testMode, title, useTextTags, expiresAt, certificationTypes); } @Override @@ -1016,6 +1048,7 @@ public String toString() { sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); + sb.append(" certificationTypes: ").append(toIndentedString(certificationTypes)).append("\n"); sb.append("}"); return sb.toString(); } @@ -1518,6 +1551,25 @@ public Map createFormData() throws ApiException { map.put("expires_at", JSON.getDefault().getMapper().writeValueAsString(expiresAt)); } } + if (certificationTypes != null) { + if (isFileTypeOrListOfFiles(certificationTypes)) { + fileTypeFound = true; + } + + if (certificationTypes.getClass().equals(java.io.File.class) || + certificationTypes.getClass().equals(Integer.class) || + certificationTypes.getClass().equals(String.class) || + certificationTypes.getClass().isEnum()) { + map.put("certification_types", certificationTypes); + } else if (isListOfFile(certificationTypes)) { + for(int i = 0; i< getListSize(certificationTypes); i++) { + map.put("certification_types[" + i + "]", getFromList(certificationTypes, i)); + } + } + else { + map.put("certification_types", JSON.getDefault().getMapper().writeValueAsString(certificationTypes)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java b/sdks/java/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java index ec7036792..7830a7b82 100644 --- a/sdks/java/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java +++ b/sdks/java/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java @@ -18,6 +18,7 @@ import java.util.Map; import java.util.HashMap; import com.dropbox.sign.model.SubCC; +import com.dropbox.sign.model.SubCertificationTypes; import com.dropbox.sign.model.SubCustomField; import com.dropbox.sign.model.SubSignatureRequestTemplateSigner; import com.dropbox.sign.model.SubSigningOptions; @@ -60,7 +61,8 @@ SignatureRequestSendWithTemplateRequest.JSON_PROPERTY_SIGNING_REDIRECT_URL, SignatureRequestSendWithTemplateRequest.JSON_PROPERTY_SUBJECT, SignatureRequestSendWithTemplateRequest.JSON_PROPERTY_TEST_MODE, - SignatureRequestSendWithTemplateRequest.JSON_PROPERTY_TITLE + SignatureRequestSendWithTemplateRequest.JSON_PROPERTY_TITLE, + SignatureRequestSendWithTemplateRequest.JSON_PROPERTY_CERTIFICATION_TYPES }) @JsonIgnoreProperties(ignoreUnknown=true) @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen") @@ -116,6 +118,9 @@ public class SignatureRequestSendWithTemplateRequest { public static final String JSON_PROPERTY_TITLE = "title"; private String title; + public static final String JSON_PROPERTY_CERTIFICATION_TYPES = "certification_types"; + private SubCertificationTypes certificationTypes; + public SignatureRequestSendWithTemplateRequest() { } @@ -628,6 +633,32 @@ public void setTitle(String title) { } + public SignatureRequestSendWithTemplateRequest certificationTypes(SubCertificationTypes certificationTypes) { + this.certificationTypes = certificationTypes; + return this; + } + + /** + * Get certificationTypes + * @return certificationTypes + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_CERTIFICATION_TYPES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubCertificationTypes getCertificationTypes() { + return certificationTypes; + } + + + @JsonProperty(JSON_PROPERTY_CERTIFICATION_TYPES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCertificationTypes(SubCertificationTypes certificationTypes) { + this.certificationTypes = certificationTypes; + } + + /** * Return true if this SignatureRequestSendWithTemplateRequest object is equal to o. */ @@ -656,12 +687,13 @@ public boolean equals(Object o) { Objects.equals(this.signingRedirectUrl, signatureRequestSendWithTemplateRequest.signingRedirectUrl) && Objects.equals(this.subject, signatureRequestSendWithTemplateRequest.subject) && Objects.equals(this.testMode, signatureRequestSendWithTemplateRequest.testMode) && - Objects.equals(this.title, signatureRequestSendWithTemplateRequest.title); + Objects.equals(this.title, signatureRequestSendWithTemplateRequest.title) && + Objects.equals(this.certificationTypes, signatureRequestSendWithTemplateRequest.certificationTypes); } @Override public int hashCode() { - return Objects.hash(templateIds, signers, allowDecline, ccs, clientId, customFields, files, fileUrls, isQualifiedSignature, isEid, message, metadata, signingOptions, signingRedirectUrl, subject, testMode, title); + return Objects.hash(templateIds, signers, allowDecline, ccs, clientId, customFields, files, fileUrls, isQualifiedSignature, isEid, message, metadata, signingOptions, signingRedirectUrl, subject, testMode, title, certificationTypes); } @Override @@ -685,6 +717,7 @@ public String toString() { sb.append(" subject: ").append(toIndentedString(subject)).append("\n"); sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); + sb.append(" certificationTypes: ").append(toIndentedString(certificationTypes)).append("\n"); sb.append("}"); return sb.toString(); } @@ -1016,6 +1049,25 @@ public Map createFormData() throws ApiException { map.put("title", JSON.getDefault().getMapper().writeValueAsString(title)); } } + if (certificationTypes != null) { + if (isFileTypeOrListOfFiles(certificationTypes)) { + fileTypeFound = true; + } + + if (certificationTypes.getClass().equals(java.io.File.class) || + certificationTypes.getClass().equals(Integer.class) || + certificationTypes.getClass().equals(String.class) || + certificationTypes.getClass().isEnum()) { + map.put("certification_types", certificationTypes); + } else if (isListOfFile(certificationTypes)) { + for(int i = 0; i< getListSize(certificationTypes); i++) { + map.put("certification_types[" + i + "]", getFromList(certificationTypes, i)); + } + } + else { + map.put("certification_types", JSON.getDefault().getMapper().writeValueAsString(certificationTypes)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java/src/main/java/com/dropbox/sign/model/SubCertificationTypes.java b/sdks/java/src/main/java/com/dropbox/sign/model/SubCertificationTypes.java new file mode 100644 index 000000000..f8881a972 --- /dev/null +++ b/sdks/java/src/main/java/com/dropbox/sign/model/SubCertificationTypes.java @@ -0,0 +1,182 @@ +/* + * Dropbox Sign API + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.dropbox.sign.model; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.dropbox.sign.JSON; + + +import com.dropbox.sign.ApiException; +/** + * 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. + */ +@ApiModel(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.") +@JsonPropertyOrder({ + SubCertificationTypes.JSON_PROPERTY_NOM151 +}) +@JsonIgnoreProperties(ignoreUnknown=true) +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen") +public class SubCertificationTypes { + public static final String JSON_PROPERTY_NOM151 = "nom_151"; + private Boolean nom151 = false; + + public SubCertificationTypes() { + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + * @param jsonData String of JSON data representing target object + */ + static public SubCertificationTypes init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, SubCertificationTypes.class); + } + + static public SubCertificationTypes init(HashMap data) throws Exception { + return new ObjectMapper().readValue( + new ObjectMapper().writeValueAsString(data), + SubCertificationTypes.class + ); + } + + public SubCertificationTypes nom151(Boolean nom151) { + this.nom151 = nom151; + return this; + } + + /** + * NOM 151, or Normativa 151, is a certificate which verifies the integrity of an electronically signed document in compliance with Mexican regulations. + * @return nom151 + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "NOM 151, or Normativa 151, is a certificate which verifies the integrity of an electronically signed document in compliance with Mexican regulations.") + @JsonProperty(JSON_PROPERTY_NOM151) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getNom151() { + return nom151; + } + + + @JsonProperty(JSON_PROPERTY_NOM151) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setNom151(Boolean nom151) { + this.nom151 = nom151; + } + + + /** + * Return true if this SubCertificationTypes object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SubCertificationTypes subCertificationTypes = (SubCertificationTypes) o; + return Objects.equals(this.nom151, subCertificationTypes.nom151); + } + + @Override + public int hashCode() { + return Objects.hash(nom151); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SubCertificationTypes {\n"); + sb.append(" nom151: ").append(toIndentedString(nom151)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (nom151 != null) { + if (isFileTypeOrListOfFiles(nom151)) { + fileTypeFound = true; + } + + if (nom151.getClass().equals(java.io.File.class) || + nom151.getClass().equals(Integer.class) || + nom151.getClass().equals(String.class) || + nom151.getClass().isEnum()) { + map.put("nom_151", nom151); + } else if (isListOfFile(nom151)) { + for(int i = 0; i< getListSize(nom151); i++) { + map.put("nom_151[" + i + "]", getFromList(nom151, i)); + } + } + else { + map.put("nom_151", JSON.getDefault().getMapper().writeValueAsString(nom151)); + } + } + } catch (Exception e) { + throw new ApiException(e); + } + + return fileTypeFound ? map : new HashMap<>(); + } + + private boolean isFileTypeOrListOfFiles(Object obj) throws Exception { + return obj.getClass().equals(java.io.File.class) || isListOfFile(obj); + } + + private boolean isListOfFile(Object obj) throws Exception { + return obj instanceof java.util.List && !isListEmpty(obj) && getFromList(obj, 0) instanceof java.io.File; + } + + private boolean isListEmpty(Object obj) throws Exception { + return (boolean) Class.forName(java.util.List.class.getName()).getMethod("isEmpty").invoke(obj); + } + + private Object getFromList(Object obj, int index) throws Exception { + return Class.forName(java.util.List.class.getName()).getMethod("get", int.class).invoke(obj, index); + } + + private int getListSize(Object obj) throws Exception { + return (int) Class.forName(java.util.List.class.getName()).getMethod("size").invoke(obj); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/sdks/node/README.md b/sdks/node/README.md index 0b7ee6e85..2ad633760 100644 --- a/sdks/node/README.md +++ b/sdks/node/README.md @@ -245,6 +245,7 @@ All URIs are relative to *https://api.hellosign.com/v3* - [SubBulkSignerList](./docs/model/SubBulkSignerList.md) - [SubBulkSignerListCustomField](./docs/model/SubBulkSignerListCustomField.md) - [SubCC](./docs/model/SubCC.md) +- [SubCertificationTypes](./docs/model/SubCertificationTypes.md) - [SubCustomField](./docs/model/SubCustomField.md) - [SubEditorOptions](./docs/model/SubEditorOptions.md) - [SubFieldOptions](./docs/model/SubFieldOptions.md) diff --git a/sdks/node/dist/api.js b/sdks/node/dist/api.js index be5e32e80..f656b8d32 100644 --- a/sdks/node/dist/api.js +++ b/sdks/node/dist/api.js @@ -18087,6 +18087,7 @@ __export(api_exports, { SubBulkSignerList: () => SubBulkSignerList, SubBulkSignerListCustomField: () => SubBulkSignerListCustomField, SubCC: () => SubCC, + SubCertificationTypes: () => SubCertificationTypes, SubCustomField: () => SubCustomField, SubEditorOptions: () => SubEditorOptions, SubFieldOptions: () => SubFieldOptions, @@ -24313,6 +24314,11 @@ SignatureRequestSendRequest.attributeTypeMap = [ name: "expiresAt", baseName: "expires_at", type: "number" + }, + { + name: "certificationTypes", + baseName: "certification_types", + type: "SubCertificationTypes" } ]; @@ -24421,6 +24427,11 @@ SignatureRequestSendWithTemplateRequest.attributeTypeMap = [ name: "title", baseName: "title", type: "string" + }, + { + name: "certificationTypes", + baseName: "certification_types", + type: "SubCertificationTypes" } ]; @@ -24567,6 +24578,28 @@ SubCC.attributeTypeMap = [ } ]; +// model/subCertificationTypes.ts +var _SubCertificationTypes = class { + constructor() { + this["nom151"] = false; + } + static getAttributeTypeMap() { + return _SubCertificationTypes.attributeTypeMap; + } + static init(data) { + return ObjectSerializer.deserialize(data, "SubCertificationTypes"); + } +}; +var SubCertificationTypes = _SubCertificationTypes; +SubCertificationTypes.discriminator = void 0; +SubCertificationTypes.attributeTypeMap = [ + { + name: "nom151", + baseName: "nom_151", + type: "boolean" + } +]; + // model/subCustomField.ts var _SubCustomField = class { constructor() { @@ -29133,6 +29166,7 @@ var typeMap = { SubBulkSignerList, SubBulkSignerListCustomField, SubCC, + SubCertificationTypes, SubCustomField, SubEditorOptions, SubFieldOptions, @@ -36732,6 +36766,7 @@ var APIS = [ SubBulkSignerList, SubBulkSignerListCustomField, SubCC, + SubCertificationTypes, SubCustomField, SubEditorOptions, SubFieldOptions, diff --git a/sdks/node/docs/model/SignatureRequestSendRequest.md b/sdks/node/docs/model/SignatureRequestSendRequest.md index 75923ab50..6e75e2170 100644 --- a/sdks/node/docs/model/SignatureRequestSendRequest.md +++ b/sdks/node/docs/model/SignatureRequestSendRequest.md @@ -32,5 +32,6 @@ Name | Type | Description | Notes | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `useTextTags` | ```boolean``` | 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`. | [default to false] | | `expiresAt` | ```number``` | 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. | | +| `certificationTypes` | [```SubCertificationTypes```](SubCertificationTypes.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestSendWithTemplateRequest.md b/sdks/node/docs/model/SignatureRequestSendWithTemplateRequest.md index 76c6d6950..96a51cd9c 100644 --- a/sdks/node/docs/model/SignatureRequestSendWithTemplateRequest.md +++ b/sdks/node/docs/model/SignatureRequestSendWithTemplateRequest.md @@ -23,5 +23,6 @@ Name | Type | Description | Notes | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | | `testMode` | ```boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | +| `certificationTypes` | [```SubCertificationTypes```](SubCertificationTypes.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SubCertificationTypes.md b/sdks/node/docs/model/SubCertificationTypes.md new file mode 100644 index 000000000..eb0526a29 --- /dev/null +++ b/sdks/node/docs/model/SubCertificationTypes.md @@ -0,0 +1,15 @@ +# # 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` | ```boolean``` | NOM 151, or Normativa 151, is a certificate which verifies the integrity of an electronically signed document in compliance with Mexican regulations. | [default to false] | + +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/model/index.ts b/sdks/node/model/index.ts index 97f7e50a3..f573c60c6 100644 --- a/sdks/node/model/index.ts +++ b/sdks/node/model/index.ts @@ -74,6 +74,7 @@ import { SubAttachment } from "./subAttachment"; import { SubBulkSignerList } from "./subBulkSignerList"; import { SubBulkSignerListCustomField } from "./subBulkSignerListCustomField"; import { SubCC } from "./subCC"; +import { SubCertificationTypes } from "./subCertificationTypes"; import { SubCustomField } from "./subCustomField"; import { SubEditorOptions } from "./subEditorOptions"; import { SubFieldOptions } from "./subFieldOptions"; @@ -321,6 +322,7 @@ export let typeMap: { [index: string]: any } = { SubBulkSignerList: SubBulkSignerList, SubBulkSignerListCustomField: SubBulkSignerListCustomField, SubCC: SubCC, + SubCertificationTypes: SubCertificationTypes, SubCustomField: SubCustomField, SubEditorOptions: SubEditorOptions, SubFieldOptions: SubFieldOptions, @@ -517,6 +519,7 @@ export { SubBulkSignerList, SubBulkSignerListCustomField, SubCC, + SubCertificationTypes, SubCustomField, SubEditorOptions, SubFieldOptions, diff --git a/sdks/node/model/signatureRequestSendRequest.ts b/sdks/node/model/signatureRequestSendRequest.ts index 222c6efdf..904469d6a 100644 --- a/sdks/node/model/signatureRequestSendRequest.ts +++ b/sdks/node/model/signatureRequestSendRequest.ts @@ -24,6 +24,7 @@ import { RequestFile, AttributeTypeMap, ObjectSerializer } from "./"; import { SubAttachment } from "./subAttachment"; +import { SubCertificationTypes } from "./subCertificationTypes"; import { SubCustomField } from "./subCustomField"; import { SubFieldOptions } from "./subFieldOptions"; import { SubFormFieldGroup } from "./subFormFieldGroup"; @@ -132,6 +133,7 @@ export class SignatureRequestSendRequest { * 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. */ "expiresAt"?: number | null; + "certificationTypes"?: SubCertificationTypes; static discriminator: string | undefined = undefined; @@ -266,6 +268,11 @@ export class SignatureRequestSendRequest { baseName: "expires_at", type: "number", }, + { + name: "certificationTypes", + baseName: "certification_types", + type: "SubCertificationTypes", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/signatureRequestSendWithTemplateRequest.ts b/sdks/node/model/signatureRequestSendWithTemplateRequest.ts index 65bcf3021..00a2e379b 100644 --- a/sdks/node/model/signatureRequestSendWithTemplateRequest.ts +++ b/sdks/node/model/signatureRequestSendWithTemplateRequest.ts @@ -24,6 +24,7 @@ import { RequestFile, AttributeTypeMap, ObjectSerializer } from "./"; import { SubCC } from "./subCC"; +import { SubCertificationTypes } from "./subCertificationTypes"; import { SubCustomField } from "./subCustomField"; import { SubSignatureRequestTemplateSigner } from "./subSignatureRequestTemplateSigner"; import { SubSigningOptions } from "./subSigningOptions"; @@ -94,6 +95,7 @@ export class SignatureRequestSendWithTemplateRequest { * The title you want to assign to the SignatureRequest. */ "title"?: string; + "certificationTypes"?: SubCertificationTypes; static discriminator: string | undefined = undefined; @@ -183,6 +185,11 @@ export class SignatureRequestSendWithTemplateRequest { baseName: "title", type: "string", }, + { + name: "certificationTypes", + baseName: "certification_types", + type: "SubCertificationTypes", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/subCertificationTypes.ts b/sdks/node/model/subCertificationTypes.ts new file mode 100644 index 000000000..bd3162757 --- /dev/null +++ b/sdks/node/model/subCertificationTypes.ts @@ -0,0 +1,54 @@ +/** + * The MIT License (MIT) + * + * Copyright (C) 2023 dropbox.com + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +import { RequestFile, AttributeTypeMap, ObjectSerializer } from "./"; + +/** + * 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. + */ +export class SubCertificationTypes { + /** + * NOM 151, or Normativa 151, is a certificate which verifies the integrity of an electronically signed document in compliance with Mexican regulations. + */ + "nom151"?: boolean = false; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: AttributeTypeMap = [ + { + name: "nom151", + baseName: "nom_151", + type: "boolean", + }, + ]; + + static getAttributeTypeMap(): AttributeTypeMap { + return SubCertificationTypes.attributeTypeMap; + } + + /** Attempt to instantiate and hydrate a new instance of this class */ + static init(data: any): SubCertificationTypes { + return ObjectSerializer.deserialize(data, "SubCertificationTypes"); + } +} diff --git a/sdks/node/types/model/index.d.ts b/sdks/node/types/model/index.d.ts index e86ec7cd1..a1dedb8cc 100644 --- a/sdks/node/types/model/index.d.ts +++ b/sdks/node/types/model/index.d.ts @@ -74,6 +74,7 @@ import { SubAttachment } from "./subAttachment"; import { SubBulkSignerList } from "./subBulkSignerList"; import { SubBulkSignerListCustomField } from "./subBulkSignerListCustomField"; import { SubCC } from "./subCC"; +import { SubCertificationTypes } from "./subCertificationTypes"; import { SubCustomField } from "./subCustomField"; import { SubEditorOptions } from "./subEditorOptions"; import { SubFieldOptions } from "./subFieldOptions"; @@ -179,4 +180,4 @@ export declare let enumsMap: { export declare let typeMap: { [index: string]: any; }; -export { AccountCreateRequest, AccountCreateResponse, AccountGetResponse, AccountResponse, AccountResponseQuotas, AccountUpdateRequest, AccountVerifyRequest, AccountVerifyResponse, AccountVerifyResponseAccount, ApiAppCreateRequest, ApiAppGetResponse, ApiAppListResponse, ApiAppResponse, ApiAppResponseOAuth, ApiAppResponseOptions, ApiAppResponseOwnerAccount, ApiAppResponseWhiteLabelingOptions, ApiAppUpdateRequest, BulkSendJobGetResponse, BulkSendJobGetResponseSignatureRequests, BulkSendJobListResponse, BulkSendJobResponse, BulkSendJobSendResponse, EmbeddedEditUrlRequest, EmbeddedEditUrlResponse, EmbeddedEditUrlResponseEmbedded, EmbeddedSignUrlResponse, EmbeddedSignUrlResponseEmbedded, ErrorResponse, ErrorResponseError, EventCallbackRequest, EventCallbackRequestEvent, EventCallbackRequestEventMetadata, FileResponse, FileResponseDataUri, ListInfoResponse, OAuthTokenGenerateRequest, OAuthTokenRefreshRequest, OAuthTokenResponse, ReportCreateRequest, ReportCreateResponse, ReportResponse, SignatureRequestBulkCreateEmbeddedWithTemplateRequest, SignatureRequestBulkSendWithTemplateRequest, SignatureRequestCreateEmbeddedRequest, SignatureRequestCreateEmbeddedWithTemplateRequest, SignatureRequestEditRequest, SignatureRequestEditWithTemplateRequest, SignatureRequestGetResponse, SignatureRequestListResponse, SignatureRequestRemindRequest, SignatureRequestResponse, SignatureRequestResponseAttachment, SignatureRequestResponseCustomFieldBase, SignatureRequestResponseCustomFieldCheckbox, SignatureRequestResponseCustomFieldText, SignatureRequestResponseCustomFieldTypeEnum, SignatureRequestResponseDataBase, SignatureRequestResponseDataTypeEnum, SignatureRequestResponseDataValueCheckbox, SignatureRequestResponseDataValueCheckboxMerge, SignatureRequestResponseDataValueDateSigned, SignatureRequestResponseDataValueDropdown, SignatureRequestResponseDataValueInitials, SignatureRequestResponseDataValueRadio, SignatureRequestResponseDataValueSignature, SignatureRequestResponseDataValueText, SignatureRequestResponseDataValueTextMerge, SignatureRequestResponseSignatures, SignatureRequestSendRequest, SignatureRequestSendWithTemplateRequest, SignatureRequestUpdateRequest, SubAttachment, SubBulkSignerList, SubBulkSignerListCustomField, SubCC, SubCustomField, SubEditorOptions, SubFieldOptions, SubFormFieldGroup, SubFormFieldRule, SubFormFieldRuleAction, SubFormFieldRuleTrigger, SubFormFieldsPerDocumentBase, SubFormFieldsPerDocumentCheckbox, SubFormFieldsPerDocumentCheckboxMerge, SubFormFieldsPerDocumentDateSigned, SubFormFieldsPerDocumentDropdown, SubFormFieldsPerDocumentFontEnum, SubFormFieldsPerDocumentHyperlink, SubFormFieldsPerDocumentInitials, SubFormFieldsPerDocumentRadio, SubFormFieldsPerDocumentSignature, SubFormFieldsPerDocumentText, SubFormFieldsPerDocumentTextMerge, SubFormFieldsPerDocumentTypeEnum, SubMergeField, SubOAuth, SubOptions, SubSignatureRequestGroupedSigners, SubSignatureRequestSigner, SubSignatureRequestTemplateSigner, SubSigningOptions, SubTeamResponse, SubTemplateRole, SubUnclaimedDraftSigner, SubUnclaimedDraftTemplateSigner, SubWhiteLabelingOptions, TeamAddMemberRequest, TeamCreateRequest, TeamGetInfoResponse, TeamGetResponse, TeamInfoResponse, TeamInviteResponse, TeamInvitesResponse, TeamMemberResponse, TeamMembersResponse, TeamParentResponse, TeamRemoveMemberRequest, TeamResponse, TeamSubTeamsResponse, TeamUpdateRequest, TemplateAddUserRequest, TemplateCreateEmbeddedDraftRequest, TemplateCreateEmbeddedDraftResponse, TemplateCreateEmbeddedDraftResponseTemplate, TemplateCreateRequest, TemplateCreateResponse, TemplateCreateResponseTemplate, TemplateEditResponse, TemplateGetResponse, TemplateListResponse, TemplateRemoveUserRequest, TemplateResponse, TemplateResponseAccount, TemplateResponseAccountQuota, TemplateResponseCCRole, TemplateResponseDocument, TemplateResponseDocumentCustomFieldBase, TemplateResponseDocumentCustomFieldCheckbox, TemplateResponseDocumentCustomFieldText, TemplateResponseDocumentFieldGroup, TemplateResponseDocumentFieldGroupRule, TemplateResponseDocumentFormFieldBase, TemplateResponseDocumentFormFieldCheckbox, TemplateResponseDocumentFormFieldDateSigned, TemplateResponseDocumentFormFieldDropdown, TemplateResponseDocumentFormFieldHyperlink, TemplateResponseDocumentFormFieldInitials, TemplateResponseDocumentFormFieldRadio, TemplateResponseDocumentFormFieldSignature, TemplateResponseDocumentFormFieldText, TemplateResponseDocumentStaticFieldBase, TemplateResponseDocumentStaticFieldCheckbox, TemplateResponseDocumentStaticFieldDateSigned, TemplateResponseDocumentStaticFieldDropdown, TemplateResponseDocumentStaticFieldHyperlink, TemplateResponseDocumentStaticFieldInitials, TemplateResponseDocumentStaticFieldRadio, TemplateResponseDocumentStaticFieldSignature, TemplateResponseDocumentStaticFieldText, TemplateResponseFieldAvgTextLength, TemplateResponseSignerRole, TemplateUpdateFilesRequest, TemplateUpdateFilesResponse, TemplateUpdateFilesResponseTemplate, UnclaimedDraftCreateEmbeddedRequest, UnclaimedDraftCreateEmbeddedWithTemplateRequest, UnclaimedDraftCreateRequest, UnclaimedDraftCreateResponse, UnclaimedDraftEditAndResendRequest, UnclaimedDraftResponse, WarningResponse, EventCallbackHelper, RequestDetailedFile, RequestFile, AttributeTypeMap, ObjectSerializer, Authentication, HttpBasicAuth, HttpBearerAuth, ApiKeyAuth, OAuth, VoidAuth, Interceptor, }; +export { AccountCreateRequest, AccountCreateResponse, AccountGetResponse, AccountResponse, AccountResponseQuotas, AccountUpdateRequest, AccountVerifyRequest, AccountVerifyResponse, AccountVerifyResponseAccount, ApiAppCreateRequest, ApiAppGetResponse, ApiAppListResponse, ApiAppResponse, ApiAppResponseOAuth, ApiAppResponseOptions, ApiAppResponseOwnerAccount, ApiAppResponseWhiteLabelingOptions, ApiAppUpdateRequest, BulkSendJobGetResponse, BulkSendJobGetResponseSignatureRequests, BulkSendJobListResponse, BulkSendJobResponse, BulkSendJobSendResponse, EmbeddedEditUrlRequest, EmbeddedEditUrlResponse, EmbeddedEditUrlResponseEmbedded, EmbeddedSignUrlResponse, EmbeddedSignUrlResponseEmbedded, ErrorResponse, ErrorResponseError, EventCallbackRequest, EventCallbackRequestEvent, EventCallbackRequestEventMetadata, FileResponse, FileResponseDataUri, ListInfoResponse, OAuthTokenGenerateRequest, OAuthTokenRefreshRequest, OAuthTokenResponse, ReportCreateRequest, ReportCreateResponse, ReportResponse, SignatureRequestBulkCreateEmbeddedWithTemplateRequest, SignatureRequestBulkSendWithTemplateRequest, SignatureRequestCreateEmbeddedRequest, SignatureRequestCreateEmbeddedWithTemplateRequest, SignatureRequestEditRequest, SignatureRequestEditWithTemplateRequest, SignatureRequestGetResponse, SignatureRequestListResponse, SignatureRequestRemindRequest, SignatureRequestResponse, SignatureRequestResponseAttachment, SignatureRequestResponseCustomFieldBase, SignatureRequestResponseCustomFieldCheckbox, SignatureRequestResponseCustomFieldText, SignatureRequestResponseCustomFieldTypeEnum, SignatureRequestResponseDataBase, SignatureRequestResponseDataTypeEnum, SignatureRequestResponseDataValueCheckbox, SignatureRequestResponseDataValueCheckboxMerge, SignatureRequestResponseDataValueDateSigned, SignatureRequestResponseDataValueDropdown, SignatureRequestResponseDataValueInitials, SignatureRequestResponseDataValueRadio, SignatureRequestResponseDataValueSignature, SignatureRequestResponseDataValueText, SignatureRequestResponseDataValueTextMerge, SignatureRequestResponseSignatures, SignatureRequestSendRequest, SignatureRequestSendWithTemplateRequest, SignatureRequestUpdateRequest, SubAttachment, SubBulkSignerList, SubBulkSignerListCustomField, SubCC, SubCertificationTypes, SubCustomField, SubEditorOptions, SubFieldOptions, SubFormFieldGroup, SubFormFieldRule, SubFormFieldRuleAction, SubFormFieldRuleTrigger, SubFormFieldsPerDocumentBase, SubFormFieldsPerDocumentCheckbox, SubFormFieldsPerDocumentCheckboxMerge, SubFormFieldsPerDocumentDateSigned, SubFormFieldsPerDocumentDropdown, SubFormFieldsPerDocumentFontEnum, SubFormFieldsPerDocumentHyperlink, SubFormFieldsPerDocumentInitials, SubFormFieldsPerDocumentRadio, SubFormFieldsPerDocumentSignature, SubFormFieldsPerDocumentText, SubFormFieldsPerDocumentTextMerge, SubFormFieldsPerDocumentTypeEnum, SubMergeField, SubOAuth, SubOptions, SubSignatureRequestGroupedSigners, SubSignatureRequestSigner, SubSignatureRequestTemplateSigner, SubSigningOptions, SubTeamResponse, SubTemplateRole, SubUnclaimedDraftSigner, SubUnclaimedDraftTemplateSigner, SubWhiteLabelingOptions, TeamAddMemberRequest, TeamCreateRequest, TeamGetInfoResponse, TeamGetResponse, TeamInfoResponse, TeamInviteResponse, TeamInvitesResponse, TeamMemberResponse, TeamMembersResponse, TeamParentResponse, TeamRemoveMemberRequest, TeamResponse, TeamSubTeamsResponse, TeamUpdateRequest, TemplateAddUserRequest, TemplateCreateEmbeddedDraftRequest, TemplateCreateEmbeddedDraftResponse, TemplateCreateEmbeddedDraftResponseTemplate, TemplateCreateRequest, TemplateCreateResponse, TemplateCreateResponseTemplate, TemplateEditResponse, TemplateGetResponse, TemplateListResponse, TemplateRemoveUserRequest, TemplateResponse, TemplateResponseAccount, TemplateResponseAccountQuota, TemplateResponseCCRole, TemplateResponseDocument, TemplateResponseDocumentCustomFieldBase, TemplateResponseDocumentCustomFieldCheckbox, TemplateResponseDocumentCustomFieldText, TemplateResponseDocumentFieldGroup, TemplateResponseDocumentFieldGroupRule, TemplateResponseDocumentFormFieldBase, TemplateResponseDocumentFormFieldCheckbox, TemplateResponseDocumentFormFieldDateSigned, TemplateResponseDocumentFormFieldDropdown, TemplateResponseDocumentFormFieldHyperlink, TemplateResponseDocumentFormFieldInitials, TemplateResponseDocumentFormFieldRadio, TemplateResponseDocumentFormFieldSignature, TemplateResponseDocumentFormFieldText, TemplateResponseDocumentStaticFieldBase, TemplateResponseDocumentStaticFieldCheckbox, TemplateResponseDocumentStaticFieldDateSigned, TemplateResponseDocumentStaticFieldDropdown, TemplateResponseDocumentStaticFieldHyperlink, TemplateResponseDocumentStaticFieldInitials, TemplateResponseDocumentStaticFieldRadio, TemplateResponseDocumentStaticFieldSignature, TemplateResponseDocumentStaticFieldText, TemplateResponseFieldAvgTextLength, TemplateResponseSignerRole, TemplateUpdateFilesRequest, TemplateUpdateFilesResponse, TemplateUpdateFilesResponseTemplate, UnclaimedDraftCreateEmbeddedRequest, UnclaimedDraftCreateEmbeddedWithTemplateRequest, UnclaimedDraftCreateRequest, UnclaimedDraftCreateResponse, UnclaimedDraftEditAndResendRequest, UnclaimedDraftResponse, WarningResponse, EventCallbackHelper, RequestDetailedFile, RequestFile, AttributeTypeMap, ObjectSerializer, Authentication, HttpBasicAuth, HttpBearerAuth, ApiKeyAuth, OAuth, VoidAuth, Interceptor, }; diff --git a/sdks/node/types/model/signatureRequestSendRequest.d.ts b/sdks/node/types/model/signatureRequestSendRequest.d.ts index 4465f5ca7..ea8261e83 100644 --- a/sdks/node/types/model/signatureRequestSendRequest.d.ts +++ b/sdks/node/types/model/signatureRequestSendRequest.d.ts @@ -1,5 +1,6 @@ import { RequestFile, AttributeTypeMap } from "./"; import { SubAttachment } from "./subAttachment"; +import { SubCertificationTypes } from "./subCertificationTypes"; import { SubCustomField } from "./subCustomField"; import { SubFieldOptions } from "./subFieldOptions"; import { SubFormFieldGroup } from "./subFormFieldGroup"; @@ -37,6 +38,7 @@ export declare class SignatureRequestSendRequest { "title"?: string; "useTextTags"?: boolean; "expiresAt"?: number | null; + "certificationTypes"?: SubCertificationTypes; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/signatureRequestSendWithTemplateRequest.d.ts b/sdks/node/types/model/signatureRequestSendWithTemplateRequest.d.ts index abd2727a2..1216bffc8 100644 --- a/sdks/node/types/model/signatureRequestSendWithTemplateRequest.d.ts +++ b/sdks/node/types/model/signatureRequestSendWithTemplateRequest.d.ts @@ -1,5 +1,6 @@ import { RequestFile, AttributeTypeMap } from "./"; import { SubCC } from "./subCC"; +import { SubCertificationTypes } from "./subCertificationTypes"; import { SubCustomField } from "./subCustomField"; import { SubSignatureRequestTemplateSigner } from "./subSignatureRequestTemplateSigner"; import { SubSigningOptions } from "./subSigningOptions"; @@ -23,6 +24,7 @@ export declare class SignatureRequestSendWithTemplateRequest { "subject"?: string; "testMode"?: boolean; "title"?: string; + "certificationTypes"?: SubCertificationTypes; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/subCertificationTypes.d.ts b/sdks/node/types/model/subCertificationTypes.d.ts new file mode 100644 index 000000000..abcbc56b6 --- /dev/null +++ b/sdks/node/types/model/subCertificationTypes.d.ts @@ -0,0 +1,8 @@ +import { AttributeTypeMap } from "./"; +export declare class SubCertificationTypes { + "nom151"?: boolean; + static discriminator: string | undefined; + static attributeTypeMap: AttributeTypeMap; + static getAttributeTypeMap(): AttributeTypeMap; + static init(data: any): SubCertificationTypes; +} diff --git a/sdks/php/README.md b/sdks/php/README.md index 5f7dbf765..dbd1480e2 100644 --- a/sdks/php/README.md +++ b/sdks/php/README.md @@ -285,6 +285,7 @@ All URIs are relative to *https://api.hellosign.com/v3* - [SubBulkSignerList](docs/Model/SubBulkSignerList.md) - [SubBulkSignerListCustomField](docs/Model/SubBulkSignerListCustomField.md) - [SubCC](docs/Model/SubCC.md) +- [SubCertificationTypes](docs/Model/SubCertificationTypes.md) - [SubCustomField](docs/Model/SubCustomField.md) - [SubEditorOptions](docs/Model/SubEditorOptions.md) - [SubFieldOptions](docs/Model/SubFieldOptions.md) diff --git a/sdks/php/docs/Model/SignatureRequestSendRequest.md b/sdks/php/docs/Model/SignatureRequestSendRequest.md index d514c6778..82f360364 100644 --- a/sdks/php/docs/Model/SignatureRequestSendRequest.md +++ b/sdks/php/docs/Model/SignatureRequestSendRequest.md @@ -32,5 +32,6 @@ Name | Type | Description | Notes | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `use_text_tags` | ```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`. | [default to false] | | `expires_at` | ```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. | | +| `certification_types` | [```\Dropbox\Sign\Model\SubCertificationTypes```](SubCertificationTypes.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestSendWithTemplateRequest.md b/sdks/php/docs/Model/SignatureRequestSendWithTemplateRequest.md index f55fb441f..ec98c851b 100644 --- a/sdks/php/docs/Model/SignatureRequestSendWithTemplateRequest.md +++ b/sdks/php/docs/Model/SignatureRequestSendWithTemplateRequest.md @@ -23,5 +23,6 @@ Name | Type | Description | Notes | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | +| `certification_types` | [```\Dropbox\Sign\Model\SubCertificationTypes```](SubCertificationTypes.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubCertificationTypes.md b/sdks/php/docs/Model/SubCertificationTypes.md new file mode 100644 index 000000000..9396d0293 --- /dev/null +++ b/sdks/php/docs/Model/SubCertificationTypes.md @@ -0,0 +1,15 @@ +# # 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 +------------ | ------------- | ------------- | ------------- +| `nom_151` | ```bool``` | NOM 151, or Normativa 151, is a certificate which verifies the integrity of an electronically signed document in compliance with Mexican regulations. | [default to false] | + +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/src/Model/SignatureRequestSendRequest.php b/sdks/php/src/Model/SignatureRequestSendRequest.php index efac23b73..2efe0fd2c 100644 --- a/sdks/php/src/Model/SignatureRequestSendRequest.php +++ b/sdks/php/src/Model/SignatureRequestSendRequest.php @@ -88,6 +88,7 @@ class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, JsonSe 'title' => 'string', 'use_text_tags' => 'bool', 'expires_at' => 'int', + 'certification_types' => '\Dropbox\Sign\Model\SubCertificationTypes', ]; /** @@ -124,6 +125,7 @@ class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, JsonSe 'title' => null, 'use_text_tags' => null, 'expires_at' => null, + 'certification_types' => null, ]; /** @@ -179,6 +181,7 @@ public static function openAPIFormats() 'title' => 'title', 'use_text_tags' => 'use_text_tags', 'expires_at' => 'expires_at', + 'certification_types' => 'certification_types', ]; /** @@ -213,6 +216,7 @@ public static function openAPIFormats() 'title' => 'setTitle', 'use_text_tags' => 'setUseTextTags', 'expires_at' => 'setExpiresAt', + 'certification_types' => 'setCertificationTypes', ]; /** @@ -247,6 +251,7 @@ public static function openAPIFormats() 'title' => 'getTitle', 'use_text_tags' => 'getUseTextTags', 'expires_at' => 'getExpiresAt', + 'certification_types' => 'getCertificationTypes', ]; /** @@ -331,6 +336,7 @@ public function __construct(array $data = null) $this->container['title'] = $data['title'] ?? null; $this->container['use_text_tags'] = $data['use_text_tags'] ?? false; $this->container['expires_at'] = $data['expires_at'] ?? null; + $this->container['certification_types'] = $data['certification_types'] ?? null; } /** @deprecated use ::init() */ @@ -1024,6 +1030,30 @@ public function setExpiresAt(?int $expires_at) return $this; } + /** + * Gets certification_types + * + * @return SubCertificationTypes|null + */ + public function getCertificationTypes() + { + return $this->container['certification_types']; + } + + /** + * Sets certification_types + * + * @param SubCertificationTypes|null $certification_types certification_types + * + * @return self + */ + public function setCertificationTypes(?SubCertificationTypes $certification_types) + { + $this->container['certification_types'] = $certification_types; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/SignatureRequestSendWithTemplateRequest.php b/sdks/php/src/Model/SignatureRequestSendWithTemplateRequest.php index 3aa0902c0..f33d29b21 100644 --- a/sdks/php/src/Model/SignatureRequestSendWithTemplateRequest.php +++ b/sdks/php/src/Model/SignatureRequestSendWithTemplateRequest.php @@ -79,6 +79,7 @@ class SignatureRequestSendWithTemplateRequest implements ModelInterface, ArrayAc 'subject' => 'string', 'test_mode' => 'bool', 'title' => 'string', + 'certification_types' => '\Dropbox\Sign\Model\SubCertificationTypes', ]; /** @@ -106,6 +107,7 @@ class SignatureRequestSendWithTemplateRequest implements ModelInterface, ArrayAc 'subject' => null, 'test_mode' => null, 'title' => null, + 'certification_types' => null, ]; /** @@ -152,6 +154,7 @@ public static function openAPIFormats() 'subject' => 'subject', 'test_mode' => 'test_mode', 'title' => 'title', + 'certification_types' => 'certification_types', ]; /** @@ -177,6 +180,7 @@ public static function openAPIFormats() 'subject' => 'setSubject', 'test_mode' => 'setTestMode', 'title' => 'setTitle', + 'certification_types' => 'setCertificationTypes', ]; /** @@ -202,6 +206,7 @@ public static function openAPIFormats() 'subject' => 'getSubject', 'test_mode' => 'getTestMode', 'title' => 'getTitle', + 'certification_types' => 'getCertificationTypes', ]; /** @@ -277,6 +282,7 @@ public function __construct(array $data = null) $this->container['subject'] = $data['subject'] ?? null; $this->container['test_mode'] = $data['test_mode'] ?? false; $this->container['title'] = $data['title'] ?? null; + $this->container['certification_types'] = $data['certification_types'] ?? null; } /** @deprecated use ::init() */ @@ -760,6 +766,30 @@ public function setTitle(?string $title) return $this; } + /** + * Gets certification_types + * + * @return SubCertificationTypes|null + */ + public function getCertificationTypes() + { + return $this->container['certification_types']; + } + + /** + * Sets certification_types + * + * @param SubCertificationTypes|null $certification_types certification_types + * + * @return self + */ + public function setCertificationTypes(?SubCertificationTypes $certification_types) + { + $this->container['certification_types'] = $certification_types; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/SubCertificationTypes.php b/sdks/php/src/Model/SubCertificationTypes.php new file mode 100644 index 000000000..95da255ab --- /dev/null +++ b/sdks/php/src/Model/SubCertificationTypes.php @@ -0,0 +1,342 @@ + + * @template TKey int|null + * @template TValue mixed|null + */ +class SubCertificationTypes implements ModelInterface, ArrayAccess, JsonSerializable +{ + public const DISCRIMINATOR = null; + + /** + * The original name of the model. + * + * @var string + */ + protected static $openAPIModelName = 'SubCertificationTypes'; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $openAPITypes = [ + 'nom_151' => 'bool', + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ + protected static $openAPIFormats = [ + 'nom_151' => null, + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ + public static function openAPITypes() + { + return self::$openAPITypes; + } + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function openAPIFormats() + { + return self::$openAPIFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @var string[] + */ + protected static $attributeMap = [ + 'nom_151' => 'nom_151', + ]; + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @var string[] + */ + protected static $setters = [ + 'nom_151' => 'setNom151', + ]; + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @var string[] + */ + protected static $getters = [ + 'nom_151' => 'getNom151', + ]; + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ + public static function attributeMap() + { + return self::$attributeMap; + } + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ + public static function setters() + { + return self::$setters; + } + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ + public static function getters() + { + return self::$getters; + } + + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$openAPIModelName; + } + + /** + * Associative array for storing property values + * + * @var array + */ + protected $container = []; + + /** + * Constructor + * + * @param array|null $data Associated array of property values + * initializing the model + */ + public function __construct(array $data = null) + { + $this->container['nom_151'] = $data['nom_151'] ?? false; + } + + /** @deprecated use ::init() */ + public static function fromArray(array $data): SubCertificationTypes + { + return self::init($data); + } + + /** Attempt to instantiate and hydrate a new instance of this class */ + public static function init(array $data): SubCertificationTypes + { + /** @var SubCertificationTypes $obj */ + $obj = ObjectSerializer::deserialize( + $data, + SubCertificationTypes::class, + ); + + return $obj; + } + + /** + * Show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalidProperties = []; + + return $invalidProperties; + } + + /** + * Validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + return count($this->listInvalidProperties()) === 0; + } + + /** + * Gets nom_151 + * + * @return bool|null + */ + public function getNom151() + { + return $this->container['nom_151']; + } + + /** + * Sets nom_151 + * + * @param bool|null $nom_151 NOM 151, or Normativa 151, is a certificate which verifies the integrity of an electronically signed document in compliance with Mexican regulations + * + * @return self + */ + public function setNom151(?bool $nom_151) + { + $this->container['nom_151'] = $nom_151; + + return $this; + } + + /** + * Returns true if offset exists. False otherwise. + * + * @param mixed $offset Offset + * + * @return bool + */ + #[ReturnTypeWillChange] + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * + * @param mixed $offset Offset + * + * @return mixed|null + */ + #[ReturnTypeWillChange] + public function offsetGet($offset) + { + return $this->container[$offset] ?? null; + } + + /** + * Sets value based on offset. + * + * @param mixed $offset Offset + * @param mixed $value Value to be set + * + * @return void + */ + #[ReturnTypeWillChange] + public function offsetSet($offset, $value) + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * + * @param mixed $offset Offset + * + * @return void + */ + #[ReturnTypeWillChange] + public function offsetUnset($offset) + { + unset($this->container[$offset]); + } + + /** + * Serializes the object to a value that can be serialized natively by json_encode(). + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * + * @return scalar|object|array|null returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource + */ + #[ReturnTypeWillChange] + public function jsonSerialize() + { + return ObjectSerializer::sanitizeForSerialization($this); + } + + /** + * Gets the string presentation of the object + * + * @return string + */ + public function __toString() + { + return json_encode( + ObjectSerializer::sanitizeForSerialization($this), + JSON_UNESCAPED_SLASHES + ); + } + + /** + * Gets a header-safe presentation of the object + * + * @return string + */ + public function toHeaderValue() + { + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); + } +} diff --git a/sdks/python/.openapi-generator/FILES b/sdks/python/.openapi-generator/FILES index b6eee370f..55953e5f1 100644 --- a/sdks/python/.openapi-generator/FILES +++ b/sdks/python/.openapi-generator/FILES @@ -86,6 +86,7 @@ docs/SubAttachment.md docs/SubBulkSignerList.md docs/SubBulkSignerListCustomField.md docs/SubCC.md +docs/SubCertificationTypes.md docs/SubCustomField.md docs/SubEditorOptions.md docs/SubFieldOptions.md @@ -280,6 +281,7 @@ dropbox_sign/model/sub_attachment.py dropbox_sign/model/sub_bulk_signer_list.py dropbox_sign/model/sub_bulk_signer_list_custom_field.py dropbox_sign/model/sub_cc.py +dropbox_sign/model/sub_certification_types.py dropbox_sign/model/sub_custom_field.py dropbox_sign/model/sub_editor_options.py dropbox_sign/model/sub_field_options.py diff --git a/sdks/python/README.md b/sdks/python/README.md index fd0c058cb..a121b3e5f 100644 --- a/sdks/python/README.md +++ b/sdks/python/README.md @@ -244,6 +244,7 @@ All URIs are relative to *https://api.hellosign.com/v3* - [SubBulkSignerList](docs/SubBulkSignerList.md) - [SubBulkSignerListCustomField](docs/SubBulkSignerListCustomField.md) - [SubCC](docs/SubCC.md) + - [SubCertificationTypes](docs/SubCertificationTypes.md) - [SubCustomField](docs/SubCustomField.md) - [SubEditorOptions](docs/SubEditorOptions.md) - [SubFieldOptions](docs/SubFieldOptions.md) diff --git a/sdks/python/docs/SignatureRequestSendRequest.md b/sdks/python/docs/SignatureRequestSendRequest.md index 529d9ff07..cdfceb526 100644 --- a/sdks/python/docs/SignatureRequestSendRequest.md +++ b/sdks/python/docs/SignatureRequestSendRequest.md @@ -32,6 +32,7 @@ | `title` | ```str``` | The title you want to assign to the SignatureRequest. | | | `use_text_tags` | ```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`. | [default to False] | | `expires_at` | ```int, none_type``` | 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. | | +| `certification_types` | [```SubCertificationTypes```](SubCertificationTypes.md) | | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestSendWithTemplateRequest.md b/sdks/python/docs/SignatureRequestSendWithTemplateRequest.md index 7f604a1ed..f8fc2217d 100644 --- a/sdks/python/docs/SignatureRequestSendWithTemplateRequest.md +++ b/sdks/python/docs/SignatureRequestSendWithTemplateRequest.md @@ -23,6 +23,7 @@ | `subject` | ```str``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | | `title` | ```str``` | The title you want to assign to the SignatureRequest. | | +| `certification_types` | [```SubCertificationTypes```](SubCertificationTypes.md) | | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SubCertificationTypes.md b/sdks/python/docs/SubCertificationTypes.md new file mode 100644 index 000000000..ed2aa0f90 --- /dev/null +++ b/sdks/python/docs/SubCertificationTypes.md @@ -0,0 +1,18 @@ +# 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 | +| ---- | ---- | ----------- | ----- | +| `nom_151` | ```bool``` | NOM 151, or Normativa 151, is a certificate which verifies the integrity of an electronically signed document in compliance with Mexican regulations. | [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) + + diff --git a/sdks/python/dropbox_sign/model/signature_request_send_request.py b/sdks/python/dropbox_sign/model/signature_request_send_request.py index aa468b781..8de0b2188 100644 --- a/sdks/python/dropbox_sign/model/signature_request_send_request.py +++ b/sdks/python/dropbox_sign/model/signature_request_send_request.py @@ -34,6 +34,7 @@ from dropbox_sign.exceptions import ApiAttributeError if TYPE_CHECKING: from dropbox_sign.model.sub_attachment import SubAttachment + from dropbox_sign.model.sub_certification_types import SubCertificationTypes from dropbox_sign.model.sub_custom_field import SubCustomField from dropbox_sign.model.sub_field_options import SubFieldOptions from dropbox_sign.model.sub_form_field_group import SubFormFieldGroup @@ -46,6 +47,7 @@ def lazy_import(): from dropbox_sign.model.sub_attachment import SubAttachment + from dropbox_sign.model.sub_certification_types import SubCertificationTypes from dropbox_sign.model.sub_custom_field import SubCustomField from dropbox_sign.model.sub_field_options import SubFieldOptions from dropbox_sign.model.sub_form_field_group import SubFormFieldGroup @@ -55,6 +57,7 @@ def lazy_import(): from dropbox_sign.model.sub_signature_request_signer import SubSignatureRequestSigner from dropbox_sign.model.sub_signing_options import SubSigningOptions globals()['SubAttachment'] = SubAttachment + globals()['SubCertificationTypes'] = SubCertificationTypes globals()['SubCustomField'] = SubCustomField globals()['SubFieldOptions'] = SubFieldOptions globals()['SubFormFieldGroup'] = SubFormFieldGroup @@ -155,6 +158,7 @@ def openapi_types(): 'title': (str,), # noqa: E501 'use_text_tags': (bool,), # noqa: E501 'expires_at': (int, none_type,), # noqa: E501 + 'certification_types': (SubCertificationTypes,), # noqa: E501 } @cached_property @@ -204,6 +208,7 @@ def init(data: any) -> SignatureRequestSendRequest: 'title': 'title', # noqa: E501 'use_text_tags': 'use_text_tags', # noqa: E501 'expires_at': 'expires_at', # noqa: E501 + 'certification_types': 'certification_types', # noqa: E501 } read_only_vars = { @@ -419,6 +424,14 @@ def expires_at(self) -> Optional[int]: def expires_at(self, value: Optional[int]): setattr(self, "expires_at", value) + @property + def certification_types(self) -> SubCertificationTypes: + return self.get("certification_types") + + @certification_types.setter + def certification_types(self, value: SubCertificationTypes): + setattr(self, "certification_types", value) + @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @@ -481,6 +494,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 title (str): The title you want to assign to the SignatureRequest.. [optional] # noqa: E501 use_text_tags (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] if omitted the server will use the default value of False # noqa: E501 expires_at (int, none_type): 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] # noqa: E501 + certification_types (SubCertificationTypes): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -588,6 +602,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 title (str): The title you want to assign to the SignatureRequest.. [optional] # noqa: E501 use_text_tags (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] if omitted the server will use the default value of False # noqa: E501 expires_at (int, none_type): 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] # noqa: E501 + certification_types (SubCertificationTypes): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/sdks/python/dropbox_sign/model/signature_request_send_with_template_request.py b/sdks/python/dropbox_sign/model/signature_request_send_with_template_request.py index f348a3f00..d61a7114c 100644 --- a/sdks/python/dropbox_sign/model/signature_request_send_with_template_request.py +++ b/sdks/python/dropbox_sign/model/signature_request_send_with_template_request.py @@ -34,6 +34,7 @@ from dropbox_sign.exceptions import ApiAttributeError if TYPE_CHECKING: from dropbox_sign.model.sub_cc import SubCC + from dropbox_sign.model.sub_certification_types import SubCertificationTypes from dropbox_sign.model.sub_custom_field import SubCustomField from dropbox_sign.model.sub_signature_request_template_signer import SubSignatureRequestTemplateSigner from dropbox_sign.model.sub_signing_options import SubSigningOptions @@ -41,10 +42,12 @@ def lazy_import(): from dropbox_sign.model.sub_cc import SubCC + from dropbox_sign.model.sub_certification_types import SubCertificationTypes from dropbox_sign.model.sub_custom_field import SubCustomField from dropbox_sign.model.sub_signature_request_template_signer import SubSignatureRequestTemplateSigner from dropbox_sign.model.sub_signing_options import SubSigningOptions globals()['SubCC'] = SubCC + globals()['SubCertificationTypes'] = SubCertificationTypes globals()['SubCustomField'] = SubCustomField globals()['SubSignatureRequestTemplateSigner'] = SubSignatureRequestTemplateSigner globals()['SubSigningOptions'] = SubSigningOptions @@ -131,6 +134,7 @@ def openapi_types(): 'subject': (str,), # noqa: E501 'test_mode': (bool,), # noqa: E501 'title': (str,), # noqa: E501 + 'certification_types': (SubCertificationTypes,), # noqa: E501 } @cached_property @@ -171,6 +175,7 @@ def init(data: any) -> SignatureRequestSendWithTemplateRequest: 'subject': 'subject', # noqa: E501 'test_mode': 'test_mode', # noqa: E501 'title': 'title', # noqa: E501 + 'certification_types': 'certification_types', # noqa: E501 } read_only_vars = { @@ -314,6 +319,14 @@ def title(self) -> str: def title(self, value: str): setattr(self, "title", value) + @property + def certification_types(self) -> SubCertificationTypes: + return self.get("certification_types") + + @certification_types.setter + def certification_types(self, value: SubCertificationTypes): + setattr(self, "certification_types", value) + @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, template_ids, signers, *args, **kwargs): # noqa: E501 @@ -369,6 +382,7 @@ def _from_openapi_data(cls, template_ids, signers, *args, **kwargs): # noqa: E5 subject (str): The subject in the email that will be sent to the signers.. [optional] # noqa: E501 test_mode (bool): Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.. [optional] if omitted the server will use the default value of False # noqa: E501 title (str): The title you want to assign to the SignatureRequest.. [optional] # noqa: E501 + certification_types (SubCertificationTypes): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -471,6 +485,7 @@ def __init__(self, template_ids, signers, *args, **kwargs): # noqa: E501 subject (str): The subject in the email that will be sent to the signers.. [optional] # noqa: E501 test_mode (bool): Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.. [optional] if omitted the server will use the default value of False # noqa: E501 title (str): The title you want to assign to the SignatureRequest.. [optional] # noqa: E501 + certification_types (SubCertificationTypes): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/sdks/python/dropbox_sign/model/sub_certification_types.py b/sdks/python/dropbox_sign/model/sub_certification_types.py new file mode 100644 index 000000000..a82818da0 --- /dev/null +++ b/sdks/python/dropbox_sign/model/sub_certification_types.py @@ -0,0 +1,283 @@ +""" + Dropbox Sign API + + Dropbox Sign v3 API # noqa: E501 + + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by: https://openapi-generator.tech +""" + + +from __future__ import annotations +from typing import TYPE_CHECKING, Optional, List, Dict, Union +import json # noqa: F401 +import re # noqa: F401 +import sys # noqa: F401 + +from dropbox_sign import ApiClient +from dropbox_sign.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from dropbox_sign.exceptions import ApiAttributeError + + + +class SubCertificationTypes(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'nom_151': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + @staticmethod + def init(data: any) -> SubCertificationTypes: + """ + Attempt to instantiate and hydrate a new instance of this class + """ + try: + obj_data = json.dumps(data) + except TypeError: + obj_data = data + + return ApiClient().deserialize( + response=type('obj_dict', (object,), {'data': obj_data}), + response_type=[SubCertificationTypes], + _check_type=True, + ) + + attribute_map = { + 'nom_151': 'nom_151', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @property + def nom_151(self) -> bool: + return self.get("nom_151") + + @nom_151.setter + def nom_151(self, value: bool): + setattr(self, "nom_151", value) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """SubCertificationTypes - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + nom_151 (bool): NOM 151, or Normativa 151, is a certificate which verifies the integrity of an electronically signed document in compliance with Mexican regulations.. [optional] if omitted the server will use the default value of False # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """SubCertificationTypes - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + nom_151 (bool): NOM 151, or Normativa 151, is a certificate which verifies the integrity of an electronically signed document in compliance with Mexican regulations.. [optional] if omitted the server will use the default value of False # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/sdks/python/dropbox_sign/models/__init__.py b/sdks/python/dropbox_sign/models/__init__.py index 4382eb06d..97b9bb66e 100644 --- a/sdks/python/dropbox_sign/models/__init__.py +++ b/sdks/python/dropbox_sign/models/__init__.py @@ -85,6 +85,7 @@ from dropbox_sign.model.sub_bulk_signer_list import SubBulkSignerList from dropbox_sign.model.sub_bulk_signer_list_custom_field import SubBulkSignerListCustomField from dropbox_sign.model.sub_cc import SubCC +from dropbox_sign.model.sub_certification_types import SubCertificationTypes from dropbox_sign.model.sub_custom_field import SubCustomField from dropbox_sign.model.sub_editor_options import SubEditorOptions from dropbox_sign.model.sub_field_options import SubFieldOptions diff --git a/sdks/ruby/.openapi-generator/FILES b/sdks/ruby/.openapi-generator/FILES index 547a90cd7..0426341ea 100644 --- a/sdks/ruby/.openapi-generator/FILES +++ b/sdks/ruby/.openapi-generator/FILES @@ -89,6 +89,7 @@ docs/SubAttachment.md docs/SubBulkSignerList.md docs/SubBulkSignerListCustomField.md docs/SubCC.md +docs/SubCertificationTypes.md docs/SubCustomField.md docs/SubEditorOptions.md docs/SubFieldOptions.md @@ -281,6 +282,7 @@ lib/dropbox-sign/models/sub_attachment.rb lib/dropbox-sign/models/sub_bulk_signer_list.rb lib/dropbox-sign/models/sub_bulk_signer_list_custom_field.rb lib/dropbox-sign/models/sub_cc.rb +lib/dropbox-sign/models/sub_certification_types.rb lib/dropbox-sign/models/sub_custom_field.rb lib/dropbox-sign/models/sub_editor_options.rb lib/dropbox-sign/models/sub_field_options.rb diff --git a/sdks/ruby/README.md b/sdks/ruby/README.md index e2d30994d..c66a0b69b 100644 --- a/sdks/ruby/README.md +++ b/sdks/ruby/README.md @@ -245,6 +245,7 @@ All URIs are relative to *https://api.hellosign.com/v3* - [Dropbox::Sign::SubBulkSignerList](docs/SubBulkSignerList.md) - [Dropbox::Sign::SubBulkSignerListCustomField](docs/SubBulkSignerListCustomField.md) - [Dropbox::Sign::SubCC](docs/SubCC.md) + - [Dropbox::Sign::SubCertificationTypes](docs/SubCertificationTypes.md) - [Dropbox::Sign::SubCustomField](docs/SubCustomField.md) - [Dropbox::Sign::SubEditorOptions](docs/SubEditorOptions.md) - [Dropbox::Sign::SubFieldOptions](docs/SubFieldOptions.md) diff --git a/sdks/ruby/docs/SignatureRequestSendRequest.md b/sdks/ruby/docs/SignatureRequestSendRequest.md index 390e33eac..27061381b 100644 --- a/sdks/ruby/docs/SignatureRequestSendRequest.md +++ b/sdks/ruby/docs/SignatureRequestSendRequest.md @@ -32,4 +32,5 @@ | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `use_text_tags` | ```Boolean``` | 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`. | [default to false] | | `expires_at` | ```Integer``` | 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. | | +| `certification_types` | [```SubCertificationTypes```](SubCertificationTypes.md) | | | diff --git a/sdks/ruby/docs/SignatureRequestSendWithTemplateRequest.md b/sdks/ruby/docs/SignatureRequestSendWithTemplateRequest.md index aa570eef5..b963ba8d9 100644 --- a/sdks/ruby/docs/SignatureRequestSendWithTemplateRequest.md +++ b/sdks/ruby/docs/SignatureRequestSendWithTemplateRequest.md @@ -23,4 +23,5 @@ | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | +| `certification_types` | [```SubCertificationTypes```](SubCertificationTypes.md) | | | diff --git a/sdks/ruby/docs/SubCertificationTypes.md b/sdks/ruby/docs/SubCertificationTypes.md new file mode 100644 index 000000000..adab826ea --- /dev/null +++ b/sdks/ruby/docs/SubCertificationTypes.md @@ -0,0 +1,14 @@ +# Dropbox::Sign::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 | +| ---- | ---- | ----------- | ----- | +| `nom_151` | ```Boolean``` | NOM 151, or Normativa 151, is a certificate which verifies the integrity of an electronically signed document in compliance with Mexican regulations. | [default to false] | + diff --git a/sdks/ruby/lib/dropbox-sign.rb b/sdks/ruby/lib/dropbox-sign.rb index f0075eca0..e92496f19 100644 --- a/sdks/ruby/lib/dropbox-sign.rb +++ b/sdks/ruby/lib/dropbox-sign.rb @@ -82,6 +82,7 @@ require 'dropbox-sign/models/sub_bulk_signer_list' require 'dropbox-sign/models/sub_bulk_signer_list_custom_field' require 'dropbox-sign/models/sub_cc' +require 'dropbox-sign/models/sub_certification_types' require 'dropbox-sign/models/sub_custom_field' require 'dropbox-sign/models/sub_editor_options' require 'dropbox-sign/models/sub_field_options' diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_send_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_send_request.rb index 448b867a7..a44d817cd 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_send_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_send_request.rb @@ -120,6 +120,9 @@ class SignatureRequestSendRequest # @return [Integer, nil] attr_accessor :expires_at + # @return [SubCertificationTypes] + attr_accessor :certification_types + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { @@ -148,7 +151,8 @@ def self.attribute_map :'test_mode' => :'test_mode', :'title' => :'title', :'use_text_tags' => :'use_text_tags', - :'expires_at' => :'expires_at' + :'expires_at' => :'expires_at', + :'certification_types' => :'certification_types' } end @@ -190,7 +194,8 @@ def self.openapi_types :'test_mode' => :'Boolean', :'title' => :'String', :'use_text_tags' => :'Boolean', - :'expires_at' => :'Integer' + :'expires_at' => :'Integer', + :'certification_types' => :'SubCertificationTypes' } end @@ -202,7 +207,7 @@ def self.merged_types # List of attributes with nullable: true def self.openapi_nullable Set.new([ - :'expires_at' + :'expires_at', ]) end @@ -375,6 +380,10 @@ def initialize(attributes = {}) if attributes.key?(:'expires_at') self.expires_at = attributes[:'expires_at'] end + + if attributes.key?(:'certification_types') + self.certification_types = attributes[:'certification_types'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -471,7 +480,8 @@ def ==(o) test_mode == o.test_mode && title == o.title && use_text_tags == o.use_text_tags && - expires_at == o.expires_at + expires_at == o.expires_at && + certification_types == o.certification_types end # @see the `==` method @@ -483,7 +493,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, attachments, cc_email_addresses, client_id, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, is_qualified_signature, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title, use_text_tags, expires_at].hash + [files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, attachments, cc_email_addresses, client_id, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, is_qualified_signature, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title, use_text_tags, expires_at, certification_types].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_send_with_template_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_send_with_template_request.rb index 9c0da8b25..cfccb5ce5 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_send_with_template_request.rb @@ -85,6 +85,9 @@ class SignatureRequestSendWithTemplateRequest # @return [String] attr_accessor :title + # @return [SubCertificationTypes] + attr_accessor :certification_types + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { @@ -104,7 +107,8 @@ def self.attribute_map :'signing_redirect_url' => :'signing_redirect_url', :'subject' => :'subject', :'test_mode' => :'test_mode', - :'title' => :'title' + :'title' => :'title', + :'certification_types' => :'certification_types' } end @@ -137,7 +141,8 @@ def self.openapi_types :'signing_redirect_url' => :'String', :'subject' => :'String', :'test_mode' => :'Boolean', - :'title' => :'String' + :'title' => :'String', + :'certification_types' => :'SubCertificationTypes' } end @@ -271,6 +276,10 @@ def initialize(attributes = {}) if attributes.key?(:'title') self.title = attributes[:'title'] end + + if attributes.key?(:'certification_types') + self.certification_types = attributes[:'certification_types'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -368,7 +377,8 @@ def ==(o) signing_redirect_url == o.signing_redirect_url && subject == o.subject && test_mode == o.test_mode && - title == o.title + title == o.title && + certification_types == o.certification_types end # @see the `==` method @@ -380,7 +390,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [template_ids, signers, allow_decline, ccs, client_id, custom_fields, files, file_urls, is_qualified_signature, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title].hash + [template_ids, signers, allow_decline, ccs, client_id, custom_fields, files, file_urls, is_qualified_signature, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title, certification_types].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/sub_certification_types.rb b/sdks/ruby/lib/dropbox-sign/models/sub_certification_types.rb new file mode 100644 index 000000000..d56493623 --- /dev/null +++ b/sdks/ruby/lib/dropbox-sign/models/sub_certification_types.rb @@ -0,0 +1,254 @@ +=begin +#Dropbox Sign API + +#Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.3.0 + +=end + +require 'date' +require 'time' + +module Dropbox +end + +module Dropbox::Sign + # 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. + class SubCertificationTypes + # NOM 151, or Normativa 151, is a certificate which verifies the integrity of an electronically signed document in compliance with Mexican regulations. + # @return [Boolean] + attr_accessor :nom_151 + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'nom_151' => :'nom_151' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Returns attribute map of this model + parent + def self.merged_attributes + self.attribute_map + end + + # Attribute type mapping. + def self.openapi_types + { + :'nom_151' => :'Boolean' + } + end + + # Attribute type mapping of this model + parent + def self.merged_types + self.openapi_types + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Returns list of attributes with nullable: true of this model + parent + def self.merged_nullable + self.openapi_nullable + end + + # Attempt to instantiate and hydrate a new instance of this class + # @param [Object] data Data to be converted + # @return [SubCertificationTypes] + def self.init(data) + return ApiClient.default.convert_to_type( + data, + "SubCertificationTypes" + ) || SubCertificationTypes.new + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::SubCertificationTypes` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.merged_attributes.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubCertificationTypes`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'nom_151') + self.nom_151 = attributes[:'nom_151'] + else + self.nom_151 = false + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + nom_151 == o.nom_151 + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [nom_151].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attribute_map = self.class.merged_attributes + + self.class.merged_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :File + value + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + # models (e.g. Pet) + klass = Dropbox::Sign.const_get(type) + klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash(include_nil = true) + hash = {} + self.class.merged_attributes.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + next unless include_nil + is_nullable = self.class.merged_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value, include_nil) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value, include_nil = true) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v, include_nil) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v, include_nil) } + end + elsif value.respond_to? :to_hash + value.to_hash(include_nil) + else + value + end + end + + end + +end diff --git a/translations/en.yaml b/translations/en.yaml index 8ed7406dc..1ec4ad6a3 100644 --- a/translations/en.yaml +++ b/translations/en.yaml @@ -848,6 +848,14 @@ "Sub::CC::EMAIL_ADDRESS": The email address of the CC recipient. "Sub::CC::ROLE": Must match an existing CC role in chosen Template(s). Multiple CC recipients cannot share the same CC role. +"Sub::CertificationTypes::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. +"Sub::CertificationTypes::NOM_151": NOM 151, or Normativa 151, is a certificate which verifies the integrity of an electronically signed document in compliance with Mexican regulations. + "Sub::CustomField::DESCRIPTION": |- When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.