Release 1.11.0 (#31)

Author: adanilowski-dropbox

README.md

@@ -160,6 +160,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
 - [AccountGetResponse](./docs/model/AccountGetResponse.md)
 - [AccountResponse](./docs/model/AccountResponse.md)
 - [AccountResponseQuotas](./docs/model/AccountResponseQuotas.md)
+- [AccountResponseSettings](./docs/model/AccountResponseSettings.md)
 - [AccountResponseUsage](./docs/model/AccountResponseUsage.md)
 - [AccountUpdateRequest](./docs/model/AccountUpdateRequest.md)
 - [AccountVerifyRequest](./docs/model/AccountVerifyRequest.md)
@@ -303,7 +304,6 @@ All URIs are relative to *https://api.hellosign.com/v3*
 - [TemplateCreateRequest](./docs/model/TemplateCreateRequest.md)
 - [TemplateCreateResponse](./docs/model/TemplateCreateResponse.md)
 - [TemplateCreateResponseTemplate](./docs/model/TemplateCreateResponseTemplate.md)
-- [TemplateEditResponse](./docs/model/TemplateEditResponse.md)
 - [TemplateGetResponse](./docs/model/TemplateGetResponse.md)
 - [TemplateListResponse](./docs/model/TemplateListResponse.md)
 - [TemplateRemoveUserRequest](./docs/model/TemplateRemoveUserRequest.md)

VERSION

@@ -1 +1 @@
-1.10.0
+1.11.0

api/apis.ts

@@ -38,7 +38,7 @@ export const queryParamsSerializer = (params) => {
   return Qs.stringify(params, { arrayFormat: "brackets" });
 };
 
-export const USER_AGENT = "OpenAPI-Generator/1.10.0/node";
+export const USER_AGENT = "OpenAPI-Generator/1.11.0/node";
 
 /**
  * Generates an object containing form data.

api/templateApi.ts

@@ -290,7 +290,7 @@ export class TemplateApi {
     });
   }
   /**
-   * Creates a template that can then be used.
+   * Creates a template that can be used in future signature requests.  If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/).  Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.
    * @summary Create Template
    * @param templateCreateRequest
    * @param options

dist/api.js

@@ -13150,6 +13150,7 @@ __export(api_exports, {
   AccountGetResponse: () => AccountGetResponse,
   AccountResponse: () => AccountResponse,
   AccountResponseQuotas: () => AccountResponseQuotas,
+  AccountResponseSettings: () => AccountResponseSettings,
   AccountResponseUsage: () => AccountResponseUsage,
   AccountUpdateRequest: () => AccountUpdateRequest,
   AccountVerifyRequest: () => AccountVerifyRequest,
@@ -13310,7 +13311,6 @@ __export(api_exports, {
   TemplateCreateRequest: () => TemplateCreateRequest,
   TemplateCreateResponse: () => TemplateCreateResponse,
   TemplateCreateResponseTemplate: () => TemplateCreateResponseTemplate,
-  TemplateEditResponse: () => TemplateEditResponse,
   TemplateGetResponse: () => TemplateGetResponse,
   TemplateListResponse: () => TemplateListResponse,
   TemplateRemoveUserRequest: () => TemplateRemoveUserRequest,
@@ -16823,6 +16823,11 @@ var AccountResponse = class _AccountResponse {
         name: "usage",
         baseName: "usage",
         type: "AccountResponseUsage"
+      },
+      {
+        name: "settings",
+        baseName: "settings",
+        type: "AccountResponseSettings"
       }
     ];
   }
@@ -16883,6 +16888,39 @@ var AccountResponseQuotas = class _AccountResponseQuotas {
   }
 };
 
+// model/accountResponseSettings.ts
+var AccountResponseSettings = class _AccountResponseSettings {
+  static {
+    this.discriminator = void 0;
+  }
+  static {
+    this.attributeTypeMap = [
+      {
+        name: "signerAccessCodes",
+        baseName: "signer_access_codes",
+        type: "boolean"
+      },
+      {
+        name: "smsDelivery",
+        baseName: "sms_delivery",
+        type: "boolean"
+      },
+      {
+        name: "smsAuthentication",
+        baseName: "sms_authentication",
+        type: "boolean"
+      }
+    ];
+  }
+  static getAttributeTypeMap() {
+    return _AccountResponseSettings.attributeTypeMap;
+  }
+  /** Attempt to instantiate and hydrate a new instance of this class */
+  static init(data) {
+    return ObjectSerializer.deserialize(data, "AccountResponseSettings");
+  }
+};
+
 // model/accountResponseUsage.ts
 var AccountResponseUsage = class _AccountResponseUsage {
   static {
@@ -19240,6 +19278,7 @@ var ReportCreateRequest = class _ReportCreateRequest {
     ReportTypeEnum2["UserActivity"] = "user_activity";
     ReportTypeEnum2["DocumentStatus"] = "document_status";
     ReportTypeEnum2["SmsActivity"] = "sms_activity";
+    ReportTypeEnum2["FaxUsage"] = "fax_usage";
   })(ReportTypeEnum = ReportCreateRequest2.ReportTypeEnum || (ReportCreateRequest2.ReportTypeEnum = {}));
 })(ReportCreateRequest || (ReportCreateRequest = {}));
 
@@ -19314,6 +19353,7 @@ var ReportResponse = class _ReportResponse {
     ReportTypeEnum2["UserActivity"] = "user_activity";
     ReportTypeEnum2["DocumentStatus"] = "document_status";
     ReportTypeEnum2["SmsActivity"] = "sms_activity";
+    ReportTypeEnum2["FaxUsage"] = "fax_usage";
   })(ReportTypeEnum = ReportResponse2.ReportTypeEnum || (ReportResponse2.ReportTypeEnum = {}));
 })(ReportResponse || (ReportResponse = {}));
 
@@ -20079,7 +20119,7 @@ var SignatureRequestEditRequest = class _SignatureRequestEditRequest {
      */
     this["hideTextTags"] = false;
     /**
-     * Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
+     * Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer.
      */
     this["isEid"] = false;
     /**
@@ -20240,7 +20280,7 @@ var SignatureRequestEditWithTemplateRequest = class _SignatureRequestEditWithTem
      */
     this["allowDecline"] = false;
     /**
-     * Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
+     * Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer.
      */
     this["isEid"] = false;
     /**
@@ -21346,7 +21386,7 @@ var SignatureRequestSendRequest = class _SignatureRequestSendRequest {
      */
     this["isQualifiedSignature"] = false;
     /**
-     * Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
+     * Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer.
      */
     this["isEid"] = false;
     /**
@@ -21518,7 +21558,7 @@ var SignatureRequestSendWithTemplateRequest = class _SignatureRequestSendWithTem
      */
     this["isQualifiedSignature"] = false;
     /**
-     * Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
+     * Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer.
      */
     this["isEid"] = false;
     /**
@@ -23090,6 +23130,10 @@ var SubSigningOptions = class _SubSigningOptions {
      * Allows uploading the signature
      */
     this["upload"] = false;
+    /**
+     * Turning on advanced signature details for the signature request
+     */
+    this["forceAdvancedSignatureDetails"] = false;
   }
   static {
     this.discriminator = void 0;
@@ -23120,6 +23164,11 @@ var SubSigningOptions = class _SubSigningOptions {
         name: "upload",
         baseName: "upload",
         type: "boolean"
+      },
+      {
+        name: "forceAdvancedSignatureDetails",
+        baseName: "force_advanced_signature_details",
+        type: "boolean"
       }
     ];
   }
@@ -24336,29 +24385,6 @@ var TemplateCreateResponseTemplate = class _TemplateCreateResponseTemplate {
   }
 };
 
-// model/templateEditResponse.ts
-var TemplateEditResponse = class _TemplateEditResponse {
-  static {
-    this.discriminator = void 0;
-  }
-  static {
-    this.attributeTypeMap = [
-      {
-        name: "templateId",
-        baseName: "template_id",
-        type: "string"
-      }
-    ];
-  }
-  static getAttributeTypeMap() {
-    return _TemplateEditResponse.attributeTypeMap;
-  }
-  /** Attempt to instantiate and hydrate a new instance of this class */
-  static init(data) {
-    return ObjectSerializer.deserialize(data, "TemplateEditResponse");
-  }
-};
-
 // model/templateGetResponse.ts
 var TemplateGetResponse = class _TemplateGetResponse {
   static {
@@ -26803,6 +26829,7 @@ var typeMap = {
   AccountGetResponse,
   AccountResponse,
   AccountResponseQuotas,
+  AccountResponseSettings,
   AccountResponseUsage,
   AccountUpdateRequest,
   AccountVerifyRequest,
@@ -26939,7 +26966,6 @@ var typeMap = {
   TemplateCreateRequest,
   TemplateCreateResponse,
   TemplateCreateResponseTemplate,
-  TemplateEditResponse,
   TemplateGetResponse,
   TemplateListResponse,
   TemplateRemoveUserRequest,
@@ -34474,7 +34500,7 @@ var TemplateApi = class {
     });
   }
   /**
-   * Creates a template that can then be used.
+   * Creates a template that can be used in future signature requests.  If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/).  Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.
    * @summary Create Template
    * @param templateCreateRequest
    * @param options
@@ -36235,7 +36261,7 @@ var HttpError = class extends Error {
 var queryParamsSerializer = (params) => {
   return import_qs.default.stringify(params, { arrayFormat: "brackets" });
 };
-var USER_AGENT = "OpenAPI-Generator/1.10.0/node";
+var USER_AGENT = "OpenAPI-Generator/1.11.0/node";
 var generateFormData = (obj, typemap) => {
   const data = {};
   let localVarUseFormData = false;
@@ -36316,6 +36342,7 @@ var APIS = [
   AccountGetResponse,
   AccountResponse,
   AccountResponseQuotas,
+  AccountResponseSettings,
   AccountResponseUsage,
   AccountUpdateRequest,
   AccountVerifyRequest,
@@ -36476,7 +36503,6 @@ var APIS = [
   TemplateCreateRequest,
   TemplateCreateResponse,
   TemplateCreateResponseTemplate,
-  TemplateEditResponse,
   TemplateGetResponse,
   TemplateListResponse,
   TemplateRemoveUserRequest,

docs/api/SignatureRequestApi.md

@@ -366,6 +366,7 @@ const signingOptions: models.SubSigningOptions = {
   phone: false,
   type: true,
   upload: true,
+  force_advanced_signature_details: false,
 };
 
 const signers1: models.SubSignatureRequestSigner = {
@@ -463,6 +464,7 @@ const signingOptions: models.SubSigningOptions = {
   phone: false,
   type: true,
   upload: true,
+  force_advanced_signature_details: false,
 };
 
 const signers1: models.SubSignatureRequestTemplateSigner = {
@@ -1406,6 +1408,7 @@ const signingOptions: models.SubSigningOptions = {
   phone: false,
   type: true,
   upload: true,
+  force_advanced_signature_details: false,
 };
 
 const signers1: models.SubSignatureRequestSigner = {
@@ -1507,6 +1510,7 @@ const signingOptions: models.SubSigningOptions = {
   phone: false,
   type: true,
   upload: true,
+  force_advanced_signature_details: false,
 };
 
 const signers1: models.SubSignatureRequestTemplateSigner = {

docs/api/TemplateApi.md

@@ -86,7 +86,7 @@ templateCreate(templateCreateRequest: TemplateCreateRequest): TemplateCreateResp
 
 Create Template
 
-Creates a template that can then be used.
+Creates a template that can be used in future signature requests.  If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/).  Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.
 
 ### TypeScript Example
 

docs/model/AccountResponse.md

@@ -17,5 +17,6 @@ Name | Type | Description | Notes
 | `teamId` | ```string``` |  The id of the team account belongs to.  |  |
 | `locale` | ```string``` |  The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.  |  |
 | `usage` | [```AccountResponseUsage```](AccountResponseUsage.md) |    |  |
+| `settings` | [```AccountResponseSettings```](AccountResponseSettings.md) |    |  |
 
 [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

docs/model/AccountResponseSettings.md

@@ -0,0 +1,13 @@
+# # AccountResponseSettings
+
+Subset of configured settings
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `signerAccessCodes` | ```boolean``` |  Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).  |  |
+| `smsDelivery` | ```boolean``` |  Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).  |  |
+| `smsAuthentication` | ```boolean``` |  Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).  |  |
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

docs/model/SignatureRequestEditRequest.md

@@ -21,7 +21,7 @@ Name | Type | Description | Notes
 | `formFieldRules` | [```Array<SubFormFieldRule>```](SubFormFieldRule.md) |  Conditional Logic rules for fields defined in `form_fields_per_document`.  |  |
 | `formFieldsPerDocument` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) |  The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`  |  |
 | `hideTextTags` | ```boolean``` |  Enables automatic Text Tag removal when set to true.<br><br>**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.  |  [default to false] |
-| `isEid` | ```boolean``` |  Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.&lt;br&gt;<br>**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.  |  [default to false] |
+| `isEid` | ```boolean``` |  Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.&lt;br&gt;<br>**NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer.  |  [default to false] |
 | `message` | ```string``` |  The custom message in the email that will be sent to the signers.  |  |
 | `metadata` | ```{ [key: string]: any; }``` |  Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer&#39;s order number for look up when receiving events for the signature request.<br><br>Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.  |  |
 | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) |    |  |