boldsign 3.2.0 → 3.3.0

package/.openapi-generator/FILES

@@ -1,4 +1,5 @@
 .gitignore
+.openapi-generator-ignore
 LICENSE
 README.md
 api.ts
@@ -27,6 +28,7 @@ model/base64File.ts
 model/behalfDocument.ts
 model/behalfDocumentRecords.ts
 model/behalfOf.ts
+model/behalfOfWebhookModel.ts
 model/billingViewModel.ts
 model/brandCreated.ts
 model/brandCustomFieldDetails.ts
@@ -34,6 +36,7 @@ model/brandingMessage.ts
 model/brandingRecords.ts
 model/changeRecipient.ts
 model/changeTeamRequest.ts
+model/checkboxValidationSettings.ts
 model/collaborationSettings.ts
 model/conditionalRule.ts
 model/contactCreated.ts
@@ -56,27 +59,37 @@ model/deleteCustomFieldReply.ts
 model/document.ts
 model/documentCC.ts
 model/documentCcDetails.ts
+model/documentCcWebhookModel.ts
 model/documentCreated.ts
 model/documentEdited.ts
+model/documentEvent.ts
 model/documentExpirySettings.ts
 model/documentFiles.ts
 model/documentFormFields.ts
+model/documentGroupSignerWebhookModel.ts
 model/documentInfo.ts
 model/documentProperties.ts
 model/documentReassign.ts
 model/documentRecords.ts
+model/documentSender.ts
 model/documentSenderDetail.ts
 model/documentSigner.ts
 model/documentSignerDetails.ts
+model/documentSignerWebhookModel.ts
 model/documentTags.ts
 model/downloadImageRequest.ts
 model/editDocumentFile.ts
+model/editDocumentJsonFile.ts
 model/editDocumentRequest.ts
 model/editDocumentSigner.ts
 model/editFormField.ts
 model/editSenderIdentityRequest.ts
 model/editTemplateRequest.ts
 model/editableDateFieldSettings.ts
+model/embeddedCloneDocumentJsonRequest.ts
+model/embeddedCloneTemplateJsonRequest.ts
+model/embeddedClonedDocument.ts
+model/embeddedClonedTemplate.ts
 model/embeddedCreateTemplateRequest.ts
 model/embeddedCustomFieldCreated.ts
 model/embeddedDocumentEditJsonRequest.ts
@@ -101,21 +114,31 @@ model/fileInfo.ts
 model/font.ts
 model/formField.ts
 model/formFieldPermission.ts
+model/formFieldPermissionWebhookModel.ts
 model/formGroup.ts
 model/formulaFieldSettings.ts
 model/getGroupContactDetails.ts
 model/groupContact.ts
 model/groupContactDetails.ts
 model/groupContactsList.ts
+model/groupOption.ts
 model/groupSigner.ts
 model/groupSignerSettings.ts
+model/groupSignerSettingsWebhookModel.ts
 model/groupUser.ts
+model/iWebhookData.ts
 model/idDocument.ts
 model/idReport.ts
 model/idVerificationDetails.ts
+model/idVerificationSignerWebhookModel.ts
+model/identityVerificationEvent.ts
 model/identityVerificationSettings.ts
 model/imageInfo.ts
 model/index.ts
+model/kbaAuthenticationEvent.ts
+model/kbaDetails.ts
+model/kbaSettings.ts
+model/kbaSignerWebhookModel.ts
 model/mergeAndSendForSignForm.ts
 model/modelDate.ts
 model/modelError.ts
@@ -124,6 +147,7 @@ model/modificationDetails.ts
 model/notificationSettings.ts
 model/pageDetails.ts
 model/phoneNumber.ts
+model/phoneNumberWebhookModel.ts
 model/prefillField.ts
 model/prefillFieldRequest.ts
 model/recipientChangeLog.ts
@@ -139,10 +163,13 @@ model/roles.ts
 model/sendForSign.ts
 model/sendForSignFromTemplateForm.ts
 model/senderIdentityCreated.ts
+model/senderIdentityCreator.ts
+model/senderIdentityEvent.ts
 model/senderIdentityList.ts
 model/senderIdentityViewModel.ts
 model/signatureFrameSettings.ts
 model/signerAuthenticationSettings.ts
+model/signerAuthenticationWebhookModel.ts
 model/size.ts
 model/teamCreated.ts
 model/teamDocumentRecords.ts
@@ -154,19 +181,24 @@ model/teamUsers.ts
 model/teams.ts
 model/template.ts
 model/templateCC.ts
+model/templateCcWebhookModel.ts
 model/templateCreated.ts
+model/templateEvent.ts
 model/templateFiles.ts
 model/templateFormFields.ts
 model/templateGroupSigner.ts
+model/templateGroupSignerWebhookModel.ts
 model/templateProperties.ts
 model/templateRecords.ts
 model/templateRole.ts
+model/templateSender.ts
 model/templateSenderDetail.ts
 model/templateSenderDetails.ts
 model/templateShareErrorResponse.ts
 model/templateShareRequest.ts
 model/templateSharedTemplateDetail.ts
 model/templateSharing.ts
+model/templateSigner.ts
 model/templateSignerDetails.ts
 model/templateTag.ts
 model/templateTeamShare.ts
@@ -184,5 +216,9 @@ model/validation.ts
 model/verificationDataRequest.ts
 model/viewBrandDetails.ts
 model/viewCustomFieldDetails.ts
+model/webhookActorDetails.ts
+model/webhookContext.ts
+model/webhookEvent.ts
+model/webhookEventMetadata.ts
 package.json
 tsconfig.json

package/README.md

@@ -88,6 +88,7 @@ All URIs are relative to *https://api.boldsign.com*
 | *DocumentApi* | [**cancelEditing**](./docs/DocumentApi.md#cancelediting) | **POST** /v1/document/cancelEditing | Cancels editing for a document that is currently in edit-mode. |
 | *DocumentApi* | [**changeAccessCode**](./docs/DocumentApi.md#changeaccesscode) | **PATCH** /v1/document/changeAccessCode | Changes the access code for the given document signer. |
 | *DocumentApi* | [**changeRecipient**](./docs/DocumentApi.md#changerecipient) | **PATCH** /v1/document/changeRecipient | Change recipient details of a document. |
+| *DocumentApi* | [**createEmbeddedDocumentCloneUrl**](./docs/DocumentApi.md#createembeddeddocumentcloneurl) | **POST** /v1/document/createEmbeddedCloneUrl | Generates a URL to embeds Clone document process into your application. |
 | *DocumentApi* | [**createEmbeddedEditUrl**](./docs/DocumentApi.md#createembeddedediturl) | **POST** /v1/document/createEmbeddedEditUrl | Generates an embedded edit URL that allows the document editing process to be integrated into your application. |
 | *DocumentApi* | [**createEmbeddedRequestUrlDocument**](./docs/DocumentApi.md#createembeddedrequesturldocument) | **POST** /v1/document/createEmbeddedRequestUrl | Generates a send URL which embeds document sending process into your application. |
 | *DocumentApi* | [**deleteDocument**](./docs/DocumentApi.md#deletedocument) | **DELETE** /v1/document/delete | Delete the document. |
@@ -130,6 +131,7 @@ All URIs are relative to *https://api.boldsign.com*
 | *TemplateApi* | [**addTag**](./docs/TemplateApi.md#addtag) | **PATCH** /v1/template/addTags | Add the Tags in Templates. |
 | *TemplateApi* | [**createEmbeddedPreviewUrl**](./docs/TemplateApi.md#createembeddedpreviewurl) | **POST** /v1/template/createEmbeddedPreviewUrl | Generates a preview URL for a template to view it. |
 | *TemplateApi* | [**createEmbeddedRequestUrlTemplate**](./docs/TemplateApi.md#createembeddedrequesturltemplate) | **POST** /v1/template/createEmbeddedRequestUrl | Generates a send URL using a template which embeds document sending process into your application. |
+| *TemplateApi* | [**createEmbeddedTemplateCloneUrl**](./docs/TemplateApi.md#createembeddedtemplatecloneurl) | **POST** /v1/template/createEmbeddedCloneUrl | Generates a URL to embeds Clone template process into your application. |
 | *TemplateApi* | [**createEmbeddedTemplateUrl**](./docs/TemplateApi.md#createembeddedtemplateurl) | **POST** /v1/template/createEmbeddedTemplateUrl | Generates a create URL to embeds template create process into your application. |
 | *TemplateApi* | [**createTemplate**](./docs/TemplateApi.md#createtemplate) | **POST** /v1/template/create | Creates a new template. |
 | *TemplateApi* | [**deleteTemplate**](./docs/TemplateApi.md#deletetemplate) | **DELETE** /v1/template/delete | Deletes a template. |
@@ -165,6 +167,7 @@ All URIs are relative to *https://api.boldsign.com*
 - [BehalfDocument](./docs/BehalfDocument.md)
 - [BehalfDocumentRecords](./docs/BehalfDocumentRecords.md)
 - [BehalfOf](./docs/BehalfOf.md)
+- [BehalfOfWebhookModel](./docs/BehalfOfWebhookModel.md)
 - [BillingViewModel](./docs/BillingViewModel.md)
 - [BrandCreated](./docs/BrandCreated.md)
 - [BrandCustomFieldDetails](./docs/BrandCustomFieldDetails.md)
@@ -172,6 +175,7 @@ All URIs are relative to *https://api.boldsign.com*
 - [BrandingRecords](./docs/BrandingRecords.md)
 - [ChangeRecipient](./docs/ChangeRecipient.md)
 - [ChangeTeamRequest](./docs/ChangeTeamRequest.md)
+- [CheckboxValidationSettings](./docs/CheckboxValidationSettings.md)
 - [CollaborationSettings](./docs/CollaborationSettings.md)
 - [ConditionalRule](./docs/ConditionalRule.md)
 - [ContactCreated](./docs/ContactCreated.md)
@@ -194,27 +198,37 @@ All URIs are relative to *https://api.boldsign.com*
 - [Document](./docs/Document.md)
 - [DocumentCC](./docs/DocumentCC.md)
 - [DocumentCcDetails](./docs/DocumentCcDetails.md)
+- [DocumentCcWebhookModel](./docs/DocumentCcWebhookModel.md)
 - [DocumentCreated](./docs/DocumentCreated.md)
 - [DocumentEdited](./docs/DocumentEdited.md)
+- [DocumentEvent](./docs/DocumentEvent.md)
 - [DocumentExpirySettings](./docs/DocumentExpirySettings.md)
 - [DocumentFiles](./docs/DocumentFiles.md)
 - [DocumentFormFields](./docs/DocumentFormFields.md)
+- [DocumentGroupSignerWebhookModel](./docs/DocumentGroupSignerWebhookModel.md)
 - [DocumentInfo](./docs/DocumentInfo.md)
 - [DocumentProperties](./docs/DocumentProperties.md)
 - [DocumentReassign](./docs/DocumentReassign.md)
 - [DocumentRecords](./docs/DocumentRecords.md)
+- [DocumentSender](./docs/DocumentSender.md)
 - [DocumentSenderDetail](./docs/DocumentSenderDetail.md)
 - [DocumentSigner](./docs/DocumentSigner.md)
 - [DocumentSignerDetails](./docs/DocumentSignerDetails.md)
+- [DocumentSignerWebhookModel](./docs/DocumentSignerWebhookModel.md)
 - [DocumentTags](./docs/DocumentTags.md)
 - [DownloadImageRequest](./docs/DownloadImageRequest.md)
 - [EditDocumentFile](./docs/EditDocumentFile.md)
+- [EditDocumentJsonFile](./docs/EditDocumentJsonFile.md)
 - [EditDocumentRequest](./docs/EditDocumentRequest.md)
 - [EditDocumentSigner](./docs/EditDocumentSigner.md)
 - [EditFormField](./docs/EditFormField.md)
 - [EditSenderIdentityRequest](./docs/EditSenderIdentityRequest.md)
 - [EditTemplateRequest](./docs/EditTemplateRequest.md)
 - [EditableDateFieldSettings](./docs/EditableDateFieldSettings.md)
+- [EmbeddedCloneDocumentJsonRequest](./docs/EmbeddedCloneDocumentJsonRequest.md)
+- [EmbeddedCloneTemplateJsonRequest](./docs/EmbeddedCloneTemplateJsonRequest.md)
+- [EmbeddedClonedDocument](./docs/EmbeddedClonedDocument.md)
+- [EmbeddedClonedTemplate](./docs/EmbeddedClonedTemplate.md)
 - [EmbeddedCreateTemplateRequest](./docs/EmbeddedCreateTemplateRequest.md)
 - [EmbeddedCustomFieldCreated](./docs/EmbeddedCustomFieldCreated.md)
 - [EmbeddedDocumentEditJsonRequest](./docs/EmbeddedDocumentEditJsonRequest.md)
@@ -239,20 +253,30 @@ All URIs are relative to *https://api.boldsign.com*
 - [Font](./docs/Font.md)
 - [FormField](./docs/FormField.md)
 - [FormFieldPermission](./docs/FormFieldPermission.md)
+- [FormFieldPermissionWebhookModel](./docs/FormFieldPermissionWebhookModel.md)
 - [FormGroup](./docs/FormGroup.md)
 - [FormulaFieldSettings](./docs/FormulaFieldSettings.md)
 - [GetGroupContactDetails](./docs/GetGroupContactDetails.md)
 - [GroupContact](./docs/GroupContact.md)
 - [GroupContactDetails](./docs/GroupContactDetails.md)
 - [GroupContactsList](./docs/GroupContactsList.md)
+- [GroupOption](./docs/GroupOption.md)
 - [GroupSigner](./docs/GroupSigner.md)
 - [GroupSignerSettings](./docs/GroupSignerSettings.md)
+- [GroupSignerSettingsWebhookModel](./docs/GroupSignerSettingsWebhookModel.md)
 - [GroupUser](./docs/GroupUser.md)
+- [IWebhookData](./docs/IWebhookData.md)
 - [IdDocument](./docs/IdDocument.md)
 - [IdReport](./docs/IdReport.md)
 - [IdVerificationDetails](./docs/IdVerificationDetails.md)
+- [IdVerificationSignerWebhookModel](./docs/IdVerificationSignerWebhookModel.md)
+- [IdentityVerificationEvent](./docs/IdentityVerificationEvent.md)
 - [IdentityVerificationSettings](./docs/IdentityVerificationSettings.md)
 - [ImageInfo](./docs/ImageInfo.md)
+- [KbaAuthenticationEvent](./docs/KbaAuthenticationEvent.md)
+- [KbaDetails](./docs/KbaDetails.md)
+- [KbaSettings](./docs/KbaSettings.md)
+- [KbaSignerWebhookModel](./docs/KbaSignerWebhookModel.md)
 - [MergeAndSendForSignForm](./docs/MergeAndSendForSignForm.md)
 - [ModelDate](./docs/ModelDate.md)
 - [ModelError](./docs/ModelError.md)
@@ -260,6 +284,7 @@ All URIs are relative to *https://api.boldsign.com*
 - [NotificationSettings](./docs/NotificationSettings.md)
 - [PageDetails](./docs/PageDetails.md)
 - [PhoneNumber](./docs/PhoneNumber.md)
+- [PhoneNumberWebhookModel](./docs/PhoneNumberWebhookModel.md)
 - [PrefillField](./docs/PrefillField.md)
 - [PrefillFieldRequest](./docs/PrefillFieldRequest.md)
 - [RecipientChangeLog](./docs/RecipientChangeLog.md)
@@ -275,10 +300,13 @@ All URIs are relative to *https://api.boldsign.com*
 - [SendForSign](./docs/SendForSign.md)
 - [SendForSignFromTemplateForm](./docs/SendForSignFromTemplateForm.md)
 - [SenderIdentityCreated](./docs/SenderIdentityCreated.md)
+- [SenderIdentityCreator](./docs/SenderIdentityCreator.md)
+- [SenderIdentityEvent](./docs/SenderIdentityEvent.md)
 - [SenderIdentityList](./docs/SenderIdentityList.md)
 - [SenderIdentityViewModel](./docs/SenderIdentityViewModel.md)
 - [SignatureFrameSettings](./docs/SignatureFrameSettings.md)
 - [SignerAuthenticationSettings](./docs/SignerAuthenticationSettings.md)
+- [SignerAuthenticationWebhookModel](./docs/SignerAuthenticationWebhookModel.md)
 - [Size](./docs/Size.md)
 - [TeamCreated](./docs/TeamCreated.md)
 - [TeamDocumentRecords](./docs/TeamDocumentRecords.md)
@@ -290,19 +318,24 @@ All URIs are relative to *https://api.boldsign.com*
 - [Teams](./docs/Teams.md)
 - [Template](./docs/Template.md)
 - [TemplateCC](./docs/TemplateCC.md)
+- [TemplateCcWebhookModel](./docs/TemplateCcWebhookModel.md)
 - [TemplateCreated](./docs/TemplateCreated.md)
+- [TemplateEvent](./docs/TemplateEvent.md)
 - [TemplateFiles](./docs/TemplateFiles.md)
 - [TemplateFormFields](./docs/TemplateFormFields.md)
 - [TemplateGroupSigner](./docs/TemplateGroupSigner.md)
+- [TemplateGroupSignerWebhookModel](./docs/TemplateGroupSignerWebhookModel.md)
 - [TemplateProperties](./docs/TemplateProperties.md)
 - [TemplateRecords](./docs/TemplateRecords.md)
 - [TemplateRole](./docs/TemplateRole.md)
+- [TemplateSender](./docs/TemplateSender.md)
 - [TemplateSenderDetail](./docs/TemplateSenderDetail.md)
 - [TemplateSenderDetails](./docs/TemplateSenderDetails.md)
 - [TemplateShareErrorResponse](./docs/TemplateShareErrorResponse.md)
 - [TemplateShareRequest](./docs/TemplateShareRequest.md)
 - [TemplateSharedTemplateDetail](./docs/TemplateSharedTemplateDetail.md)
 - [TemplateSharing](./docs/TemplateSharing.md)
+- [TemplateSigner](./docs/TemplateSigner.md)
 - [TemplateSignerDetails](./docs/TemplateSignerDetails.md)
 - [TemplateTag](./docs/TemplateTag.md)
 - [TemplateTeamShare](./docs/TemplateTeamShare.md)
@@ -320,6 +353,10 @@ All URIs are relative to *https://api.boldsign.com*
 - [VerificationDataRequest](./docs/VerificationDataRequest.md)
 - [ViewBrandDetails](./docs/ViewBrandDetails.md)
 - [ViewCustomFieldDetails](./docs/ViewCustomFieldDetails.md)
+- [WebhookActorDetails](./docs/WebhookActorDetails.md)
+- [WebhookContext](./docs/WebhookContext.md)
+- [WebhookEvent](./docs/WebhookEvent.md)
+- [WebhookEventMetadata](./docs/WebhookEventMetadata.md)
 
 ## Authorization
 

package/WebhookUtility.ts

@@ -0,0 +1,145 @@
+import * as crypto from "crypto";
+import { DocumentEvent, IdentityVerificationEvent, SenderIdentityEvent, TemplateEvent, WebhookEvent } from "./model";
+
+export class BoldSignSignatureException extends Error {}
+
+export class WebhookUtility {
+    public static readonly BOLD_SIGN_EVENT_HEADER = "X-BoldSign-Event";
+    public static readonly BOLD_SIGN_SIGNATURE_HEADER = "X-BoldSign-Signature";
+    public static readonly DEFAULT_TIME_TOLERANCE = 300;
+
+    /**
+     * Parses the raw JSON payload into a WebhookEvent object.
+     * @param jsonPayload The raw JSON string from the webhook request.
+     * @returns A WebhookEvent object.
+     */
+    public static parseEvent(
+        jsonPayload: string,
+    ): WebhookEvent {
+        const raw = JSON.parse(jsonPayload);
+        const webhookEvent = raw as WebhookEvent;
+
+        this.resolveEventData(webhookEvent);
+        return webhookEvent;
+
+    }
+
+    /**
+     * Resolves webhook data into one of the concrete event models
+     */
+    private static resolveEventData(webhookEvent: WebhookEvent): void {
+        const data: any = webhookEvent.data;
+        if (!data || typeof data !== "object") {
+            return;
+        }
+
+        if (data.object) {
+            switch (data.object) {
+                case "document":
+                    webhookEvent.data = Object.assign(
+                        new DocumentEvent(),
+                        data
+                    );
+                    return;
+
+                case "template":
+                    webhookEvent.data = Object.assign(
+                        new TemplateEvent(),
+                        data
+                    );
+                    return;
+                case "senderIdentity":
+                    webhookEvent.data = Object.assign(
+                        new SenderIdentityEvent(),
+                        data
+                    );
+                    return;
+
+                case "identityVerification":
+                    webhookEvent.data = Object.assign(
+                        new IdentityVerificationEvent(),
+                        data
+                    );
+                    return;
+            }
+        }
+    }
+
+
+    public static validateSignature(
+        jsonPayload: string,
+        signatureHeader: string,
+        secretKey: string,
+        tolerance: number = WebhookUtility.DEFAULT_TIME_TOLERANCE
+    ): void {
+        const signatures = this.parseSignatureHeader(signatureHeader);
+
+        const timestamp = signatures.t?.[0];
+        if (!timestamp) {
+            throw new BoldSignSignatureException("Timestamp not found");
+        }
+
+        const expectedSignature = this.generateSignature(
+            secretKey,
+            jsonPayload,
+            timestamp
+        );
+
+        if (
+            !this.isSignatureMatched(expectedSignature, signatures.s0) &&
+            !this.isSignatureMatched(expectedSignature, signatures.s1)
+        ) {
+            throw new BoldSignSignatureException("Signature mismatch");
+        }
+
+        const ts = parseInt(timestamp, 10);
+        const now = Math.floor(Date.now() / 1000);
+
+        if (Math.abs(now - ts) > tolerance) {
+            throw new BoldSignSignatureException("Timestamp out of tolerance");
+        }
+    }
+
+    private static parseSignatureHeader(
+        header: string
+    ): Record<string, string[]> {
+        const result: Record<string, string[]> = {};
+
+        for (const part of header.split(",")) {
+            const [key, value] = part.trim().split("=", 2);
+            if (!key || !value) {
+                throw new BoldSignSignatureException("Invalid signature header");
+            }
+            result[key] ??= [];
+            result[key].push(value);
+        }
+
+        return result;
+    }
+
+    private static generateSignature(
+        secret: string,
+        payload: string,
+        timestamp: string
+    ): string {
+        return crypto
+            .createHmac("sha256", secret)
+            .update(`${timestamp}.${payload}`)
+            .digest("hex")
+            .toLowerCase();
+    }
+
+    private static isSignatureMatched(
+        signature: string,
+        signatures?: string[]
+    ): boolean {
+        if (!signatures) return false;
+
+        return signatures.some(sig =>
+            crypto.timingSafeEqual(
+                Buffer.from(sig.toLowerCase()),
+                Buffer.from(signature)
+            )
+        );
+    }
+}

package/api/apis.ts

@@ -24,7 +24,7 @@ export const queryParamsSerializer = (params) => {
     return Qs.stringify(params, { arrayFormat: 'repeat' })
 }
 
-export const USER_AGENT = "boldsign-node-sdk/3.2.0";
+export const USER_AGENT = "boldsign-node-sdk/3.3.0";
 
 /**
  * Generates an object containing form data.

package/api/brandingApi.ts

@@ -222,14 +222,14 @@ export class BrandingApi {
      * @param showBuiltInFormFields 
      * @param allowCustomFieldCreation 
      * @param showSharedCustomFields 
-     * @param hideDecline 
-     * @param hideSave 
-     * @param documentExpirySettingsExpiryDateType 
-     * @param documentExpirySettingsExpiryValue 
-     * @param documentExpirySettingsEnableDefaultExpiryAlert 
-     * @param documentExpirySettingsEnableAutoReminder 
-     * @param documentExpirySettingsReminderDays 
-     * @param documentExpirySettingsReminderCount 
+     * @param hideDecline This option prevents signers to decline the document during the signing process.
+     * @param hideSave This option prevents signers to save their changes during the signing process and continue signing later.
+     * @param documentExpirySettingsExpiryDateType This property represents the type for the expiry date
+     * @param documentExpirySettingsExpiryValue This property is used to set the expiry value based on the expiry type
+     * @param documentExpirySettingsEnableDefaultExpiryAlert This property will send the expiry alert email before the day of expiry for the pending signers.
+     * @param documentExpirySettingsEnableAutoReminder When auto reminder is enabled, you can select how often to remind in terms of days and select the maximum number of reminders.
+     * @param documentExpirySettingsReminderDays Remind in terms of days.
+     * @param documentExpirySettingsReminderCount Number of reminder count.
      * @param customDomainSettingsDomainName 
      * @param customDomainSettingsFromName 
      * @param signatureFrameSettingsEnableSignatureFrame 
@@ -496,7 +496,7 @@ export class BrandingApi {
     /**
      * 
      * @summary Delete the brand.
-     * @param brandId brand Id.
+     * @param brandId 
      * @param options
      */
     public async deleteBrand (brandId: string, options: optionsI = {headers: {}}) : Promise<BrandingMessage> {
@@ -615,7 +615,7 @@ export class BrandingApi {
     /**
      * 
      * @summary Edit the brand.
-     * @param brandId The brand id.
+     * @param brandId 
      * @param brandName 
      * @param brandLogo 
      * @param backgroundColor 
@@ -635,14 +635,14 @@ export class BrandingApi {
      * @param showBuiltInFormFields 
      * @param allowCustomFieldCreation 
      * @param showSharedCustomFields 
-     * @param hideDecline 
-     * @param hideSave 
-     * @param documentExpirySettingsExpiryDateType 
-     * @param documentExpirySettingsExpiryValue 
-     * @param documentExpirySettingsEnableDefaultExpiryAlert 
-     * @param documentExpirySettingsEnableAutoReminder 
-     * @param documentExpirySettingsReminderDays 
-     * @param documentExpirySettingsReminderCount 
+     * @param hideDecline This option prevents signers to decline the document during the signing process.
+     * @param hideSave This option prevents signers to save their changes during the signing process and continue signing later.
+     * @param documentExpirySettingsExpiryDateType This property represents the type for the expiry date
+     * @param documentExpirySettingsExpiryValue This property is used to set the expiry value based on the expiry type
+     * @param documentExpirySettingsEnableDefaultExpiryAlert This property will send the expiry alert email before the day of expiry for the pending signers.
+     * @param documentExpirySettingsEnableAutoReminder When auto reminder is enabled, you can select how often to remind in terms of days and select the maximum number of reminders.
+     * @param documentExpirySettingsReminderDays Remind in terms of days.
+     * @param documentExpirySettingsReminderCount Number of reminder count.
      * @param customDomainSettingsDomainName 
      * @param customDomainSettingsFromName 
      * @param signatureFrameSettingsEnableSignatureFrame 
@@ -908,7 +908,7 @@ export class BrandingApi {
     /**
      * 
      * @summary Get the specific brand details.
-     * @param brandId The brand id.
+     * @param brandId 
      * @param options
      */
     public async getBrand (brandId: string, options: optionsI = {headers: {}}) : Promise<ViewBrandDetails> {
@@ -1035,7 +1035,7 @@ export class BrandingApi {
     /**
      * 
      * @summary Reset default brand.
-     * @param brandId brand Id.
+     * @param brandId 
      * @param options
      */
     public async resetDefaultBrand (brandId: string, options: optionsI = {headers: {}}) : Promise<BrandingMessage> {

package/api/contactsApi.ts

@@ -347,7 +347,7 @@ export class ContactsApi {
     /**
      * 
      * @summary Deletes a contact.
-     * @param id The contact id.
+     * @param id 
      * @param options
      */
     public async deleteContacts (id: string, options: optionsI = {headers: {}}) : Promise<returnTypeI> {
@@ -458,7 +458,7 @@ export class ContactsApi {
     /**
      * 
      * @summary Get summary of the contact.
-     * @param id Contact Id.
+     * @param id 
      * @param options
      */
     public async getContact (id: string, options: optionsI = {headers: {}}) : Promise<ContactsDetails> {
@@ -577,7 +577,7 @@ export class ContactsApi {
     /**
      * 
      * @summary Update the contact.
-     * @param id The contactId.
+     * @param id 
      * @param contactDetails The contact details.
      * @param options
      */

package/api/customFieldApi.ts

@@ -226,7 +226,7 @@ export class CustomFieldApi {
     /**
      * 
      * @summary List the custom fields respective to the brand id.
-     * @param brandId The brand id.
+     * @param brandId 
      * @param options
      */
     public async customFieldsList (brandId: string, options: optionsI = {headers: {}}) : Promise<CustomFieldCollection> {
@@ -345,7 +345,7 @@ export class CustomFieldApi {
     /**
      * 
      * @summary Delete the custom field.
-     * @param customFieldId The custom field id.
+     * @param customFieldId 
      * @param options
      */
     public async deleteCustomField (customFieldId: string, options: optionsI = {headers: {}}) : Promise<DeleteCustomFieldReply> {
@@ -472,7 +472,7 @@ export class CustomFieldApi {
     /**
      * 
      * @summary Edit the custom field.
-     * @param customFieldId The custom field id.
+     * @param customFieldId 
      * @param brandCustomFieldDetails The custom field details.
      * @param options
      */