boldsign 3.2.0-beta.3 → 3.2.0-beta.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/api/apis.ts CHANGED
@@ -24,7 +24,7 @@ export const queryParamsSerializer = (params) => {
24
24
  return Qs.stringify(params, { arrayFormat: 'repeat' })
25
25
  }
26
26
 
27
- export const USER_AGENT = "boldsign-node-sdk/3.2.0-beta.3";
27
+ export const USER_AGENT = "boldsign-node-sdk/3.2.0-beta.4";
28
28
 
29
29
  /**
30
30
  * Generates an object containing form data.
@@ -236,9 +236,10 @@ export class BrandingApi {
236
236
  * @param signatureFrameSettingsShowRecipientName
237
237
  * @param signatureFrameSettingsShowRecipientEmail
238
238
  * @param signatureFrameSettingsShowTimeStamp
239
+ * @param hideReassign Enabling this option disables reassignment for all new documents. This setting cannot be changed during document creation.
239
240
  * @param options
240
241
  */
241
- 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> {
242
+ 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> {
242
243
  const localVarPath = this.basePath + '/v1/brand/create';
243
244
  let localVarQueryParameters: any = {};
244
245
  let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
@@ -399,6 +400,10 @@ export class BrandingApi {
399
400
  localVarFormParams['SignatureFrameSettings.ShowTimeStamp'] = ObjectSerializer.serialize(signatureFrameSettingsShowTimeStamp, "boolean");
400
401
  }
401
402
 
403
+ if (hideReassign !== undefined) {
404
+ localVarFormParams['HideReassign'] = ObjectSerializer.serialize(hideReassign, "boolean");
405
+ }
406
+
402
407
  let data = {};
403
408
  if (localVarUseFormData) {
404
409
  const formData = toFormData(localVarFormParams);
@@ -649,9 +654,10 @@ export class BrandingApi {
649
654
  * @param signatureFrameSettingsShowRecipientName
650
655
  * @param signatureFrameSettingsShowRecipientEmail
651
656
  * @param signatureFrameSettingsShowTimeStamp
657
+ * @param hideReassign Enabling this option disables reassignment for all new documents. This setting cannot be changed during document creation.
652
658
  * @param options
653
659
  */
654
- 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> {
660
+ 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> {
655
661
  const localVarPath = this.basePath + '/v1/brand/edit';
656
662
  let localVarQueryParameters: any = {};
657
663
  let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
@@ -811,6 +817,10 @@ export class BrandingApi {
811
817
  localVarFormParams['SignatureFrameSettings.ShowTimeStamp'] = ObjectSerializer.serialize(signatureFrameSettingsShowTimeStamp, "boolean");
812
818
  }
813
819
 
820
+ if (hideReassign !== undefined) {
821
+ localVarFormParams['HideReassign'] = ObjectSerializer.serialize(hideReassign, "boolean");
822
+ }
823
+
814
824
  let data = {};
815
825
  if (localVarUseFormData) {
816
826
  const formData = toFormData(localVarFormParams);
@@ -45,7 +45,7 @@ List all the brands.
45
45
  ## `createBrand()`
46
46
 
47
47
  ```typescript
48
- 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
48
+ 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
49
49
  ```
50
50
 
51
51
  Create the brand.
@@ -88,6 +88,7 @@ Create the brand.
88
88
  | **signatureFrameSettingsShowRecipientName** | **boolean**| | [optional] [default to false] |
89
89
  | **signatureFrameSettingsShowRecipientEmail** | **boolean**| | [optional] [default to false] |
90
90
  | **signatureFrameSettingsShowTimeStamp** | **boolean**| | [optional] [default to false] |
91
+ | **hideReassign** | **boolean**| Enabling this option disables reassignment for all new documents. This setting cannot be changed during document creation. | [optional] [default to false] |
91
92
 
92
93
  ### Return type
93
94
 
@@ -141,7 +142,7 @@ Delete the brand.
141
142
  ## `editBrand()`
142
143
 
143
144
  ```typescript
144
- 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
145
+ 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
145
146
  ```
146
147
 
147
148
  Edit the brand.
@@ -185,6 +186,7 @@ Edit the brand.
185
186
  | **signatureFrameSettingsShowRecipientName** | **boolean**| | [optional] [default to false] |
186
187
  | **signatureFrameSettingsShowRecipientEmail** | **boolean**| | [optional] [default to false] |
187
188
  | **signatureFrameSettingsShowTimeStamp** | **boolean**| | [optional] [default to false] |
189
+ | **hideReassign** | **boolean**| Enabling this option disables reassignment for all new documents. This setting cannot be changed during document creation. | [optional] [default to false] |
188
190
 
189
191
  ### Return type
190
192
 
@@ -11,5 +11,6 @@ Name | Type | Description | Notes
11
11
  | `id` | ```string``` | | |
12
12
  | `value` | ```string``` | | |
13
13
  | `isReadOnly` | ```boolean``` | | |
14
+ | `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. | |
14
15
 
15
16
  [[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
@@ -32,5 +32,6 @@ Name | Type | Description | Notes
32
32
  | `customDomainSettings` | [```CustomDomainSettings```](CustomDomainSettings.md) | | |
33
33
  | `isDomainVerified` | ```boolean``` | | |
34
34
  | `signatureFrameSettings` | [```SignatureFrameSettings```](SignatureFrameSettings.md) | | |
35
+ | `hideReassign` | ```boolean``` | | [default to false] |
35
36
 
36
37
  [[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
@@ -18,6 +18,10 @@ export class ExistingFormField {
18
18
  'id'?: string | null;
19
19
  'value'?: string | null;
20
20
  'isReadOnly'?: boolean | null;
21
+ /**
22
+ * 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.
23
+ */
24
+ 'templateOrder'?: number | null;
21
25
 
22
26
  static discriminator: string | undefined = undefined;
23
27
 
@@ -46,6 +50,11 @@ export class ExistingFormField {
46
50
  "name": "isReadOnly",
47
51
  "baseName": "isReadOnly",
48
52
  "type": "boolean"
53
+ },
54
+ {
55
+ "name": "templateOrder",
56
+ "baseName": "templateOrder",
57
+ "type": "number"
49
58
  } ];
50
59
 
51
60
  static getAttributeTypeMap() {
@@ -42,6 +42,7 @@ export class ViewBrandDetails {
42
42
  'customDomainSettings'?: CustomDomainSettings;
43
43
  'isDomainVerified'?: boolean;
44
44
  'signatureFrameSettings'?: SignatureFrameSettings;
45
+ 'hideReassign'?: boolean = false;
45
46
 
46
47
  static discriminator: string | undefined = undefined;
47
48
 
@@ -175,6 +176,11 @@ export class ViewBrandDetails {
175
176
  "name": "signatureFrameSettings",
176
177
  "baseName": "signatureFrameSettings",
177
178
  "type": "SignatureFrameSettings"
179
+ },
180
+ {
181
+ "name": "hideReassign",
182
+ "baseName": "hideReassign",
183
+ "type": "boolean"
178
184
  } ];
179
185
 
180
186
  static getAttributeTypeMap() {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "boldsign",
3
- "version": "3.2.0-beta.3",
3
+ "version": "3.2.0-beta.4",
4
4
  "description": "NodeJS client for boldsign",
5
5
  "keywords": [
6
6
  "boldsign",