boldsign 3.2.0-beta.2 → 3.2.0-beta.4

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-beta.2";
+export const USER_AGENT = "boldsign-node-sdk/3.2.0-beta.4";
 
 /**
  * Generates an object containing form data.

package/api/brandingApi.ts

@@ -236,9 +236,10 @@ export class BrandingApi {
      * @param signatureFrameSettingsShowRecipientName 
      * @param signatureFrameSettingsShowRecipientEmail 
      * @param signatureFrameSettingsShowTimeStamp 
+     * @param hideReassign Enabling this option disables reassignment for all new documents. This setting cannot be changed during document creation.
      * @param options
      */
-    public async createBrand (brandName: string, brandLogo: RequestFile, backgroundColor?: string, buttonColor?: string, buttonTextColor?: string, emailDisplayName?: string, disclaimerDescription?: string, disclaimerTitle?: string, redirectUrl?: string, isDefault?: boolean, canHideTagLine?: boolean, combineAuditTrail?: boolean, combineAttachments?: boolean, excludeAuditTrailFromEmail?: boolean, emailSignedDocument?: string, documentTimeZone?: string, showBuiltInFormFields?: boolean, allowCustomFieldCreation?: boolean, showSharedCustomFields?: boolean, hideDecline?: boolean, hideSave?: boolean, documentExpirySettingsExpiryDateType?: string, documentExpirySettingsExpiryValue?: number, documentExpirySettingsEnableDefaultExpiryAlert?: boolean, documentExpirySettingsEnableAutoReminder?: boolean, documentExpirySettingsReminderDays?: number, documentExpirySettingsReminderCount?: number, customDomainSettingsDomainName?: string, customDomainSettingsFromName?: string, signatureFrameSettingsEnableSignatureFrame?: boolean, signatureFrameSettingsShowRecipientName?: boolean, signatureFrameSettingsShowRecipientEmail?: boolean, signatureFrameSettingsShowTimeStamp?: boolean, options: optionsI = {headers: {}}) : Promise<BrandCreated> {
+    public async createBrand (brandName: string, brandLogo: RequestFile, backgroundColor?: string, buttonColor?: string, buttonTextColor?: string, emailDisplayName?: string, disclaimerDescription?: string, disclaimerTitle?: string, redirectUrl?: string, isDefault?: boolean, canHideTagLine?: boolean, combineAuditTrail?: boolean, combineAttachments?: boolean, excludeAuditTrailFromEmail?: boolean, emailSignedDocument?: string, documentTimeZone?: string, showBuiltInFormFields?: boolean, allowCustomFieldCreation?: boolean, showSharedCustomFields?: boolean, hideDecline?: boolean, hideSave?: boolean, documentExpirySettingsExpiryDateType?: string, documentExpirySettingsExpiryValue?: number, documentExpirySettingsEnableDefaultExpiryAlert?: boolean, documentExpirySettingsEnableAutoReminder?: boolean, documentExpirySettingsReminderDays?: number, documentExpirySettingsReminderCount?: number, customDomainSettingsDomainName?: string, customDomainSettingsFromName?: string, signatureFrameSettingsEnableSignatureFrame?: boolean, signatureFrameSettingsShowRecipientName?: boolean, signatureFrameSettingsShowRecipientEmail?: boolean, signatureFrameSettingsShowTimeStamp?: boolean, hideReassign?: boolean, options: optionsI = {headers: {}}) : Promise<BrandCreated> {
         const localVarPath = this.basePath + '/v1/brand/create';
         let localVarQueryParameters: any = {};
         let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
@@ -399,6 +400,10 @@ export class BrandingApi {
             localVarFormParams['SignatureFrameSettings.ShowTimeStamp'] = ObjectSerializer.serialize(signatureFrameSettingsShowTimeStamp, "boolean");
         }
 
+        if (hideReassign !== undefined) {
+            localVarFormParams['HideReassign'] = ObjectSerializer.serialize(hideReassign, "boolean");
+        }
+
         let data = {};
         if (localVarUseFormData) {
           const formData = toFormData(localVarFormParams);
@@ -649,9 +654,10 @@ export class BrandingApi {
      * @param signatureFrameSettingsShowRecipientName 
      * @param signatureFrameSettingsShowRecipientEmail 
      * @param signatureFrameSettingsShowTimeStamp 
+     * @param hideReassign Enabling this option disables reassignment for all new documents. This setting cannot be changed during document creation.
      * @param options
      */
-    public async editBrand (brandId: string, brandName?: string, brandLogo?: RequestFile, backgroundColor?: string, buttonColor?: string, buttonTextColor?: string, emailDisplayName?: string, disclaimerDescription?: string, disclaimerTitle?: string, redirectUrl?: string, isDefault?: boolean, canHideTagLine?: boolean, combineAuditTrail?: boolean, combineAttachments?: boolean, excludeAuditTrailFromEmail?: boolean, emailSignedDocument?: string, documentTimeZone?: string, showBuiltInFormFields?: boolean, allowCustomFieldCreation?: boolean, showSharedCustomFields?: boolean, hideDecline?: boolean, hideSave?: boolean, documentExpirySettingsExpiryDateType?: string, documentExpirySettingsExpiryValue?: number, documentExpirySettingsEnableDefaultExpiryAlert?: boolean, documentExpirySettingsEnableAutoReminder?: boolean, documentExpirySettingsReminderDays?: number, documentExpirySettingsReminderCount?: number, customDomainSettingsDomainName?: string, customDomainSettingsFromName?: string, signatureFrameSettingsEnableSignatureFrame?: boolean, signatureFrameSettingsShowRecipientName?: boolean, signatureFrameSettingsShowRecipientEmail?: boolean, signatureFrameSettingsShowTimeStamp?: boolean, options: optionsI = {headers: {}}) : Promise<BrandCreated> {
+    public async editBrand (brandId: string, brandName?: string, brandLogo?: RequestFile, backgroundColor?: string, buttonColor?: string, buttonTextColor?: string, emailDisplayName?: string, disclaimerDescription?: string, disclaimerTitle?: string, redirectUrl?: string, isDefault?: boolean, canHideTagLine?: boolean, combineAuditTrail?: boolean, combineAttachments?: boolean, excludeAuditTrailFromEmail?: boolean, emailSignedDocument?: string, documentTimeZone?: string, showBuiltInFormFields?: boolean, allowCustomFieldCreation?: boolean, showSharedCustomFields?: boolean, hideDecline?: boolean, hideSave?: boolean, documentExpirySettingsExpiryDateType?: string, documentExpirySettingsExpiryValue?: number, documentExpirySettingsEnableDefaultExpiryAlert?: boolean, documentExpirySettingsEnableAutoReminder?: boolean, documentExpirySettingsReminderDays?: number, documentExpirySettingsReminderCount?: number, customDomainSettingsDomainName?: string, customDomainSettingsFromName?: string, signatureFrameSettingsEnableSignatureFrame?: boolean, signatureFrameSettingsShowRecipientName?: boolean, signatureFrameSettingsShowRecipientEmail?: boolean, signatureFrameSettingsShowTimeStamp?: boolean, hideReassign?: boolean, options: optionsI = {headers: {}}) : Promise<BrandCreated> {
         const localVarPath = this.basePath + '/v1/brand/edit';
         let localVarQueryParameters: any = {};
         let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
@@ -811,6 +817,10 @@ export class BrandingApi {
             localVarFormParams['SignatureFrameSettings.ShowTimeStamp'] = ObjectSerializer.serialize(signatureFrameSettingsShowTimeStamp, "boolean");
         }
 
+        if (hideReassign !== undefined) {
+            localVarFormParams['HideReassign'] = ObjectSerializer.serialize(hideReassign, "boolean");
+        }
+
         let data = {};
         if (localVarUseFormData) {
           const formData = toFormData(localVarFormParams);

package/api/documentApi.ts

@@ -1774,9 +1774,10 @@ export class DocumentApi {
      * @summary Download the document.
      * @param documentId 
      * @param onBehalfOf 
+     * @param format 
      * @param options
      */
-    public async downloadDocument (documentId: string, onBehalfOf?: string, options: optionsI = {headers: {}}) : Promise<Buffer> {
+    public async downloadDocument (documentId: string, onBehalfOf?: string, format?: 'Combined' | 'Individually', options: optionsI = {headers: {}}) : Promise<Buffer> {
         const localVarPath = this.basePath + '/v1/document/download';
         let localVarQueryParameters: any = {};
         let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
@@ -1803,6 +1804,10 @@ export class DocumentApi {
             localVarQueryParameters['onBehalfOf'] = ObjectSerializer.serialize(onBehalfOf, "string");
         }
 
+        if (format !== undefined) {
+            localVarQueryParameters['format'] = ObjectSerializer.serialize(format, "'Combined' | 'Individually'");
+        }
+
         (<any>Object).assign(localVarHeaderParams, options.headers);
 
         let localVarUseFormData = false;

package/api/groupContactsApi.ts

@@ -195,6 +195,14 @@ export class GroupContactsApi {
                         )) {
                           return;
                         }
+                        if (handleErrorCodeResponse(
+                            reject,
+                            error.response,
+                            403,
+                            "ErrorResult",
+                        )) {
+                          return;
+                        }
                         if (handleErrorCodeResponse(
                             reject,
                             error.response,
@@ -682,6 +690,14 @@ export class GroupContactsApi {
                         )) {
                           return;
                         }
+                        if (handleErrorCodeResponse(
+                            reject,
+                            error.response,
+                            403,
+                            "ErrorResult",
+                        )) {
+                          return;
+                        }
                         if (handleErrorCodeResponse(
                             reject,
                             error.response,

package/docs/BrandingApi.md

@@ -45,7 +45,7 @@ List all the brands.
 ## `createBrand()`
 
 ```typescript
-createBrand(brandName: string, brandLogo: RequestFile, backgroundColor: string, buttonColor: string, buttonTextColor: string, emailDisplayName: string, disclaimerDescription: string, disclaimerTitle: string, redirectUrl: string, isDefault: boolean, canHideTagLine: boolean, combineAuditTrail: boolean, combineAttachments: boolean, excludeAuditTrailFromEmail: boolean, emailSignedDocument: string, documentTimeZone: string, showBuiltInFormFields: boolean, allowCustomFieldCreation: boolean, showSharedCustomFields: boolean, hideDecline: boolean, hideSave: boolean, documentExpirySettingsExpiryDateType: string, documentExpirySettingsExpiryValue: number, documentExpirySettingsEnableDefaultExpiryAlert: boolean, documentExpirySettingsEnableAutoReminder: boolean, documentExpirySettingsReminderDays: number, documentExpirySettingsReminderCount: number, customDomainSettingsDomainName: string, customDomainSettingsFromName: string, signatureFrameSettingsEnableSignatureFrame: boolean, signatureFrameSettingsShowRecipientName: boolean, signatureFrameSettingsShowRecipientEmail: boolean, signatureFrameSettingsShowTimeStamp: boolean): BrandCreated
+createBrand(brandName: string, brandLogo: RequestFile, backgroundColor: string, buttonColor: string, buttonTextColor: string, emailDisplayName: string, disclaimerDescription: string, disclaimerTitle: string, redirectUrl: string, isDefault: boolean, canHideTagLine: boolean, combineAuditTrail: boolean, combineAttachments: boolean, excludeAuditTrailFromEmail: boolean, emailSignedDocument: string, documentTimeZone: string, showBuiltInFormFields: boolean, allowCustomFieldCreation: boolean, showSharedCustomFields: boolean, hideDecline: boolean, hideSave: boolean, documentExpirySettingsExpiryDateType: string, documentExpirySettingsExpiryValue: number, documentExpirySettingsEnableDefaultExpiryAlert: boolean, documentExpirySettingsEnableAutoReminder: boolean, documentExpirySettingsReminderDays: number, documentExpirySettingsReminderCount: number, customDomainSettingsDomainName: string, customDomainSettingsFromName: string, signatureFrameSettingsEnableSignatureFrame: boolean, signatureFrameSettingsShowRecipientName: boolean, signatureFrameSettingsShowRecipientEmail: boolean, signatureFrameSettingsShowTimeStamp: boolean, hideReassign: boolean): BrandCreated
 ```
 
 Create the brand.
@@ -88,6 +88,7 @@ Create the brand.
 | **signatureFrameSettingsShowRecipientName** | **boolean**|  | [optional] [default to false] |
 | **signatureFrameSettingsShowRecipientEmail** | **boolean**|  | [optional] [default to false] |
 | **signatureFrameSettingsShowTimeStamp** | **boolean**|  | [optional] [default to false] |
+| **hideReassign** | **boolean**| Enabling this option disables reassignment for all new documents. This setting cannot be changed during document creation. | [optional] [default to false] |
 
 ### Return type
 
@@ -141,7 +142,7 @@ Delete the brand.
 ## `editBrand()`
 
 ```typescript
-editBrand(brandId: string, brandName: string, brandLogo: RequestFile, backgroundColor: string, buttonColor: string, buttonTextColor: string, emailDisplayName: string, disclaimerDescription: string, disclaimerTitle: string, redirectUrl: string, isDefault: boolean, canHideTagLine: boolean, combineAuditTrail: boolean, combineAttachments: boolean, excludeAuditTrailFromEmail: boolean, emailSignedDocument: string, documentTimeZone: string, showBuiltInFormFields: boolean, allowCustomFieldCreation: boolean, showSharedCustomFields: boolean, hideDecline: boolean, hideSave: boolean, documentExpirySettingsExpiryDateType: string, documentExpirySettingsExpiryValue: number, documentExpirySettingsEnableDefaultExpiryAlert: boolean, documentExpirySettingsEnableAutoReminder: boolean, documentExpirySettingsReminderDays: number, documentExpirySettingsReminderCount: number, customDomainSettingsDomainName: string, customDomainSettingsFromName: string, signatureFrameSettingsEnableSignatureFrame: boolean, signatureFrameSettingsShowRecipientName: boolean, signatureFrameSettingsShowRecipientEmail: boolean, signatureFrameSettingsShowTimeStamp: boolean): BrandCreated
+editBrand(brandId: string, brandName: string, brandLogo: RequestFile, backgroundColor: string, buttonColor: string, buttonTextColor: string, emailDisplayName: string, disclaimerDescription: string, disclaimerTitle: string, redirectUrl: string, isDefault: boolean, canHideTagLine: boolean, combineAuditTrail: boolean, combineAttachments: boolean, excludeAuditTrailFromEmail: boolean, emailSignedDocument: string, documentTimeZone: string, showBuiltInFormFields: boolean, allowCustomFieldCreation: boolean, showSharedCustomFields: boolean, hideDecline: boolean, hideSave: boolean, documentExpirySettingsExpiryDateType: string, documentExpirySettingsExpiryValue: number, documentExpirySettingsEnableDefaultExpiryAlert: boolean, documentExpirySettingsEnableAutoReminder: boolean, documentExpirySettingsReminderDays: number, documentExpirySettingsReminderCount: number, customDomainSettingsDomainName: string, customDomainSettingsFromName: string, signatureFrameSettingsEnableSignatureFrame: boolean, signatureFrameSettingsShowRecipientName: boolean, signatureFrameSettingsShowRecipientEmail: boolean, signatureFrameSettingsShowTimeStamp: boolean, hideReassign: boolean): BrandCreated
 ```
 
 Edit the brand.
@@ -185,6 +186,7 @@ Edit the brand.
 | **signatureFrameSettingsShowRecipientName** | **boolean**|  | [optional] [default to false] |
 | **signatureFrameSettingsShowRecipientEmail** | **boolean**|  | [optional] [default to false] |
 | **signatureFrameSettingsShowTimeStamp** | **boolean**|  | [optional] [default to false] |
+| **hideReassign** | **boolean**| Enabling this option disables reassignment for all new documents. This setting cannot be changed during document creation. | [optional] [default to false] |
 
 ### Return type
 

package/docs/DocumentApi.md

@@ -474,7 +474,7 @@ Download the audit trail document.
 ## `downloadDocument()`
 
 ```typescript
-downloadDocument(documentId: string, onBehalfOf: string): Buffer
+downloadDocument(documentId: string, onBehalfOf: string, format: 'Combined' | 'Individually'): Buffer
 ```
 
 Download the document.
@@ -486,6 +486,7 @@ Download the document.
 | ------------- | ------------- | ------------- | ------------- |
 | **documentId** | **string**|  | |
 | **onBehalfOf** | **string**|  | [optional] |
+| **format** | **'Combined' | 'Individually'**|  | [optional] |
 
 ### Return type
 

package/docs/ExistingFormField.md

@@ -11,5 +11,6 @@ Name | Type | Description | Notes
 | `id` | ```string``` |   |  |
 | `value` | ```string``` |   |  |
 | `isReadOnly` | ```boolean``` |   |  |
+| `templateOrder` | ```number``` |  Used to apply a prefilled form field value to a specific occurrence of a template when the same template is included multiple times. Values start at 1. Supported only by the Merge and Send API. |  |
 
 [[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/ViewBrandDetails.md

@@ -32,5 +32,6 @@ Name | Type | Description | Notes
 | `customDomainSettings` | [```CustomDomainSettings```](CustomDomainSettings.md) |   |  |
 | `isDomainVerified` | ```boolean``` |   |  |
 | `signatureFrameSettings` | [```SignatureFrameSettings```](SignatureFrameSettings.md) |   |  |
+| `hideReassign` | ```boolean``` |   |  [default to false] |
 
 [[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/model/documentProperties.ts

@@ -360,7 +360,8 @@ export namespace DocumentProperties {
     }
     export enum DocumentDownloadOptionEnum {
         Combined = <any> 'Combined',
-        Individually = <any> 'Individually'
+        Individually = <any> 'Individually',
+        UserPreference = <any> 'UserPreference'
     }
     export enum AllowedSignatureTypesEnum {
         Text = <any> 'Text',

package/model/editDocumentRequest.ts

@@ -232,7 +232,8 @@ export namespace EditDocumentRequest {
     }
     export enum DocumentDownloadOptionEnum {
         Combined = <any> 'Combined',
-        Individually = <any> 'Individually'
+        Individually = <any> 'Individually',
+        UserPreference = <any> 'UserPreference'
     }
     export enum AllowedSignatureTypesEnum {
         Text = <any> 'Text',

package/model/embeddedDocumentRequest.ts

@@ -360,7 +360,8 @@ export namespace EmbeddedDocumentRequest {
     }
     export enum DocumentDownloadOptionEnum {
         Combined = <any> 'Combined',
-        Individually = <any> 'Individually'
+        Individually = <any> 'Individually',
+        UserPreference = <any> 'UserPreference'
     }
     export enum AllowedSignatureTypesEnum {
         Text = <any> 'Text',

package/model/embeddedMergeTemplateFormRequest.ts

@@ -366,7 +366,8 @@ export namespace EmbeddedMergeTemplateFormRequest {
     }
     export enum DocumentDownloadOptionEnum {
         Combined = <any> 'Combined',
-        Individually = <any> 'Individually'
+        Individually = <any> 'Individually',
+        UserPreference = <any> 'UserPreference'
     }
     export enum AllowedSignatureTypesEnum {
         Text = <any> 'Text',

package/model/embeddedSendTemplateFormRequest.ts

@@ -347,7 +347,8 @@ export namespace EmbeddedSendTemplateFormRequest {
     }
     export enum DocumentDownloadOptionEnum {
         Combined = <any> 'Combined',
-        Individually = <any> 'Individually'
+        Individually = <any> 'Individually',
+        UserPreference = <any> 'UserPreference'
     }
     export enum AllowedSignatureTypesEnum {
         Text = <any> 'Text',

package/model/existingFormField.ts

@@ -18,6 +18,10 @@ export class ExistingFormField {
     'id'?: string | null;
     'value'?: string | null;
     'isReadOnly'?: boolean | null;
+    /**
+    * Used to apply a prefilled form field value to a specific occurrence of a template when the same template is included multiple times. Values start at 1. Supported only by the Merge and Send API.
+    */
+    'templateOrder'?: number | null;
 
     static discriminator: string | undefined = undefined;
 
@@ -46,6 +50,11 @@ export class ExistingFormField {
             "name": "isReadOnly",
             "baseName": "isReadOnly",
             "type": "boolean"
+        },
+        {
+            "name": "templateOrder",
+            "baseName": "templateOrder",
+            "type": "number"
         }    ];
 
     static getAttributeTypeMap() {

package/model/mergeAndSendForSignForm.ts

@@ -279,7 +279,8 @@ export namespace MergeAndSendForSignForm {
     }
     export enum DocumentDownloadOptionEnum {
         Combined = <any> 'Combined',
-        Individually = <any> 'Individually'
+        Individually = <any> 'Individually',
+        UserPreference = <any> 'UserPreference'
     }
     export enum AllowedSignatureTypesEnum {
         Text = <any> 'Text',

package/model/sendForSign.ts

@@ -273,7 +273,8 @@ export namespace SendForSign {
     }
     export enum DocumentDownloadOptionEnum {
         Combined = <any> 'Combined',
-        Individually = <any> 'Individually'
+        Individually = <any> 'Individually',
+        UserPreference = <any> 'UserPreference'
     }
     export enum AllowedSignatureTypesEnum {
         Text = <any> 'Text',

package/model/sendForSignFromTemplateForm.ts

@@ -260,7 +260,8 @@ export namespace SendForSignFromTemplateForm {
     }
     export enum DocumentDownloadOptionEnum {
         Combined = <any> 'Combined',
-        Individually = <any> 'Individually'
+        Individually = <any> 'Individually',
+        UserPreference = <any> 'UserPreference'
     }
     export enum AllowedSignatureTypesEnum {
         Text = <any> 'Text',

package/model/templateProperties.ts

@@ -236,7 +236,8 @@ export class TemplateProperties {
 export namespace TemplateProperties {
     export enum DocumentDownloadOptionEnum {
         Combined = <any> 'Combined',
-        Individually = <any> 'Individually'
+        Individually = <any> 'Individually',
+        UserPreference = <any> 'UserPreference'
     }
     export enum AllowedSignatureTypesEnum {
         Text = <any> 'Text',

package/model/viewBrandDetails.ts

@@ -42,6 +42,7 @@ export class ViewBrandDetails {
     'customDomainSettings'?: CustomDomainSettings;
     'isDomainVerified'?: boolean;
     'signatureFrameSettings'?: SignatureFrameSettings;
+    'hideReassign'?: boolean = false;
 
     static discriminator: string | undefined = undefined;
 
@@ -175,6 +176,11 @@ export class ViewBrandDetails {
             "name": "signatureFrameSettings",
             "baseName": "signatureFrameSettings",
             "type": "SignatureFrameSettings"
+        },
+        {
+            "name": "hideReassign",
+            "baseName": "hideReassign",
+            "type": "boolean"
         }    ];
 
     static getAttributeTypeMap() {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "boldsign",
-    "version": "3.2.0-beta.2",
+    "version": "3.2.0-beta.4",
     "description": "NodeJS client for boldsign",
     "keywords": [
         "boldsign",
@@ -12,7 +12,7 @@
     "homepage": "https://boldsign.com/",
     "repository": {
         "type": "git",
-        "url": "git+https://github.com/boldsign/boldsign-node-sdk.git"
+        "url": "https://github.com/boldsign/boldsign-node-sdk.git"
     },
     "main": "dist/api.js",
     "types": "dist/api.d.ts",
@@ -50,4 +50,4 @@
         "typescript": "^4.0 || ^5.0",
         "sinon": "^20.0.0"
     }
-}
+}