boldsign 3.2.0 → 3.3.1

package/docs/TemplateEvent.md

@@ -0,0 +1,36 @@
+# # TemplateEvent
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `object` | ```string``` |   |  |
+| `templateId` | ```string``` |   |  |
+| `allowNewFiles` | ```boolean``` |   |  |
+| `allowModifyFiles` | ```boolean``` |   |  |
+| `senderDetail` | [```TemplateSender```](TemplateSender.md) |   |  |
+| `ccDetails` | [```Array<TemplateCcWebhookModel>```](TemplateCcWebhookModel.md) |   |  |
+| `createdDate` | ```Date``` |   |  |
+| `activityDate` | ```Date``` |   |  |
+| `activityBy` | ```string``` |   |  |
+| `messageTitle` | ```string``` |   |  |
+| `status` | ```string``` |   |  |
+| `signerDetails` | [```Array<TemplateSigner>```](TemplateSigner.md) |   |  |
+| `enableSigningOrder` | ```boolean``` |   |  |
+| `templateName` | ```string``` |   |  |
+| `templateDescription` | ```string``` |   |  |
+| `errorMessage` | ```string``` |   |  |
+| `isTemplate` | ```boolean``` |   |  [default to false] |
+| `brandId` | ```string``` |   |  |
+| `onBehalfOf` | ```string``` |   |  |
+| `labels` | ```Array<string>``` |   |  |
+| `templateLabels` | ```Array<string>``` |   |  |
+| `formFieldPermission` | [```FormFieldPermissionWebhookModel```](FormFieldPermissionWebhookModel.md) |   |  |
+| `groupSignerSettings` | [```GroupSignerSettingsWebhookModel```](GroupSignerSettingsWebhookModel.md) |   |  |
+| `behalfOf` | [```BehalfOfWebhookModel```](BehalfOfWebhookModel.md) |   |  |
+| `enableAllowSignEverywhere` | ```boolean``` |   |  |
+| `documentTimeZone` | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/TemplateFormFields.md

@@ -7,6 +7,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 | `id` | ```string``` |   |  |
+| `formFieldId` | ```string``` |   |  |
 | `fieldType` | ```string``` |   |  |
 | `type` | ```string``` |   |  |
 | `value` | ```string``` |   |  |

package/docs/TemplateGroupSignerWebhookModel.md

@@ -0,0 +1,12 @@
+# # TemplateGroupSignerWebhookModel
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `signerEmail` | ```string``` |   |  |
+| `signerName` | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/TemplateProperties.md

@@ -38,5 +38,6 @@ Name | Type | Description | Notes
 | `groupSignerSettings` | [```GroupSignerSettings```](GroupSignerSettings.md) |   |  |
 | `sharing` | [```TemplateSharing```](TemplateSharing.md) |   |  |
 | `enableAllowSignEverywhere` | ```boolean``` |   |  |
+| `documentTimeZone` | ```string``` |   |  |
 
 [[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/TemplateSender.md

@@ -0,0 +1,15 @@
+# # TemplateSender
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `name` | ```string``` |   |  |
+| `teamId` | ```string``` |   |  |
+| `emailAddress` | ```string``` |   |  |
+| `userId` | ```string``` |   |  |
+| `id` | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/TemplateShareErrorResponse.md

@@ -0,0 +1,14 @@
+# # TemplateShareErrorResponse
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `teams` | ```Array<string>``` |   |  |
+| `templateId` | ```string``` |   |  |
+| `errorType` | ```string``` |   |  |
+| `error` | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/TemplateShareRequest.md

@@ -0,0 +1,11 @@
+# # TemplateShareRequest
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `teams` | [```Array<TemplateTeamShareRequest>```](TemplateTeamShareRequest.md) |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/TemplateSigner.md

@@ -0,0 +1,29 @@
+# # TemplateSigner
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `signerName` | ```string``` |   |  |
+| `signerRole` | ```string``` |   |  |
+| `signerEmail` | ```string``` |   |  |
+| `groupSigners` | [```Array<TemplateGroupSignerWebhookModel>```](TemplateGroupSignerWebhookModel.md) |   |  |
+| `phoneNumber` | [```PhoneNumberWebhookModel```](PhoneNumberWebhookModel.md) |   |  |
+| `enableAccessCode` | ```boolean``` |   |  |
+| `enableEmailOTP` | ```boolean``` |   |  |
+| `status` | ```string``` |   |  |
+| `userId` | ```string``` |   |  |
+| `order` | ```number``` |   |  |
+| `signerType` | ```string``` |   |  |
+| `signType` | ```string``` |   |  |
+| `groupId` | ```string``` |   |  |
+| `hostEmail` | ```string``` |   |  |
+| `hostName` | ```string``` |   |  |
+| `hostUserId` | ```string``` |   |  |
+| `imposeAuthentication` | ```string``` |   |  |
+| `allowFieldConfiguration` | ```boolean``` |   |  |
+| `roleIndex` | ```number``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/TemplateTeamShareRequest.md

@@ -0,0 +1,13 @@
+# # TemplateTeamShareRequest
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `teamId`<sup>*_required_</sup> | ```string``` |   |  |
+| `action`<sup>*_required_</sup> | ```string``` |   |  |
+| `accessLevel` | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/UserApi.md

@@ -59,7 +59,7 @@ Change users to other team.
 
 |Name | Type | Description  | Notes |
 | ------------- | ------------- | ------------- | ------------- |
-| **userId** | **string**| user Id. | |
+| **userId** | **string**|  | |
 | **changeTeamRequest** | [**ChangeTeamRequest**](../docs/ChangeTeamRequest.md)| Change team request. | [optional] |
 
 ### Return type
@@ -124,7 +124,7 @@ Get summary of the user.
 
 |Name | Type | Description  | Notes |
 | ------------- | ------------- | ------------- | ------------- |
-| **userId** | **string**| User Id. | |
+| **userId** | **string**|  | |
 
 ### Return type
 

package/docs/WebhookActorDetails.md

@@ -0,0 +1,12 @@
+# # WebhookActorDetails
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `userType`<sup>*_required_</sup> | ```string``` |   |  |
+| `id`<sup>*_required_</sup> | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/WebhookContext.md

@@ -0,0 +1,13 @@
+# # WebhookContext
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `eventType` | ```string``` |   |  |
+| `actor` | [```WebhookActorDetails```](WebhookActorDetails.md) |   |  |
+| `previousState` | ```any``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/WebhookEvent.md

@@ -0,0 +1,14 @@
+# # WebhookEvent
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `event` | [```WebhookEventMetadata```](WebhookEventMetadata.md) |   |  |
+| `context` | [```WebhookContext```](WebhookContext.md) |   |  |
+| `data` | [```IWebhookData```](IWebhookData.md) |   |  |
+| `document` | [```DocumentEvent```](DocumentEvent.md) |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/WebhookEventMetadata.md

@@ -0,0 +1,15 @@
+# # WebhookEventMetadata
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `id` | ```string``` |   |  |
+| `created` | ```Date``` |   |  |
+| `eventType` | ```string``` |   |  |
+| `clientId` | ```string``` |   |  |
+| `environment` | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/model/accessCodeDetail.ts

@@ -13,6 +13,7 @@
 import { RequestFile } from './models';
 import { AuthenticationSettings } from './authenticationSettings';
 import { IdentityVerificationSettings } from './identityVerificationSettings';
+import { KbaSettings } from './kbaSettings';
 import { PhoneNumber } from './phoneNumber';
 
 export class AccessCodeDetail {
@@ -23,6 +24,7 @@ export class AccessCodeDetail {
     'onBehalfOf'?: string | null;
     'phoneNumber'?: PhoneNumber;
     'identityVerificationSettings'?: IdentityVerificationSettings;
+    'kbaSettings'?: KbaSettings;
     'authenticationRetryCount'?: number | null;
     'authenticationSettings'?: AuthenticationSettings;
 
@@ -64,6 +66,11 @@ export class AccessCodeDetail {
             "baseName": "identityVerificationSettings",
             "type": "IdentityVerificationSettings"
         },
+        {
+            "name": "kbaSettings",
+            "baseName": "kbaSettings",
+            "type": "KbaSettings"
+        },
         {
             "name": "authenticationRetryCount",
             "baseName": "authenticationRetryCount",
@@ -86,6 +93,7 @@ export namespace AccessCodeDetail {
         EmailOtp = <any> 'EmailOTP',
         AccessCode = <any> 'AccessCode',
         Smsotp = <any> 'SMSOTP',
-        IdVerification = <any> 'IdVerification'
+        IdVerification = <any> 'IdVerification',
+        Kba = <any> 'KBA'
     }
 }

package/model/auditTrail.ts

@@ -196,6 +196,12 @@ export namespace AuditTrail {
         QesExpired = <any> 'QESExpired',
         QesWithdrawn = <any> 'QESWithdrawn',
         ResentForApproval = <any> 'ResentForApproval',
-        DocumentFieldMarkup = <any> 'DocumentFieldMarkup'
+        DocumentFieldMarkup = <any> 'DocumentFieldMarkup',
+        KbaInitiated = <any> 'KBAInitiated',
+        KbaCompleted = <any> 'KBACompleted',
+        KbaFailed = <any> 'KBAFailed',
+        KbaReset = <any> 'KBAReset',
+        KbaAdded = <any> 'KBAAdded',
+        KbaRemoved = <any> 'KBARemoved'
     }
 }

package/model/behalfOfWebhookModel.ts

@@ -0,0 +1,37 @@
+/**
+ * BoldSign API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+
+export class BehalfOfWebhookModel {
+    'id'?: string | null;
+    'email'?: string | null;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        },
+        {
+            "name": "email",
+            "baseName": "email",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return BehalfOfWebhookModel.attributeTypeMap;
+    }
+}
+

package/model/checkboxValidationSettings.ts

@@ -0,0 +1,51 @@
+/**
+ * BoldSign API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+
+export class CheckboxValidationSettings {
+    'validationType'?: CheckboxValidationSettings.ValidationTypeEnum;
+    'minSelection'?: number | null;
+    'maxSelection'?: number | null;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "validationType",
+            "baseName": "validationType",
+            "type": "CheckboxValidationSettings.ValidationTypeEnum"
+        },
+        {
+            "name": "minSelection",
+            "baseName": "minSelection",
+            "type": "number"
+        },
+        {
+            "name": "maxSelection",
+            "baseName": "maxSelection",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CheckboxValidationSettings.attributeTypeMap;
+    }
+}
+
+export namespace CheckboxValidationSettings {
+    export enum ValidationTypeEnum {
+        Minimum = <any> 'Minimum',
+        Maximum = <any> 'Maximum',
+        Absolute = <any> 'Absolute',
+        Range = <any> 'Range'
+    }
+}

package/model/createTemplateRequest.ts

@@ -50,6 +50,7 @@ export class CreateTemplateRequest {
     'formFieldPermission'?: FormFieldPermission;
     'groupSignerSettings'?: GroupSignerSettings;
     'enableAllowSignEverywhere'?: boolean | null;
+    'documentTimeZone'?: string | null;
 
     static discriminator: string | undefined = undefined;
 
@@ -198,6 +199,11 @@ export class CreateTemplateRequest {
             "name": "enableAllowSignEverywhere",
             "baseName": "enableAllowSignEverywhere",
             "type": "boolean"
+        },
+        {
+            "name": "documentTimeZone",
+            "baseName": "documentTimeZone",
+            "type": "string"
         }    ];
 
     static getAttributeTypeMap() {

package/model/customFormField.ts

@@ -12,7 +12,9 @@
 
 import { RequestFile } from './models';
 import { AttachmentInfo } from './attachmentInfo';
+import { CheckboxValidationSettings } from './checkboxValidationSettings';
 import { EditableDateFieldSettings } from './editableDateFieldSettings';
+import { GroupOption } from './groupOption';
 import { ImageInfo } from './imageInfo';
 
 export class CustomFormField {
@@ -24,6 +26,8 @@ export class CustomFormField {
     'value'?: string | null;
     'fontSize'?: number = 13;
     'font'?: CustomFormField.FontEnum;
+    'groupOptions'?: Array<GroupOption> | null;
+    'checkboxValidationSettings'?: CheckboxValidationSettings;
     'fontHexColor'?: string | null;
     'isBoldFont'?: boolean;
     'isItalicFont'?: boolean;
@@ -94,6 +98,16 @@ export class CustomFormField {
             "baseName": "font",
             "type": "CustomFormField.FontEnum"
         },
+        {
+            "name": "groupOptions",
+            "baseName": "groupOptions",
+            "type": "Array<GroupOption>"
+        },
+        {
+            "name": "checkboxValidationSettings",
+            "baseName": "checkboxValidationSettings",
+            "type": "CheckboxValidationSettings"
+        },
         {
             "name": "fontHexColor",
             "baseName": "fontHexColor",

package/model/documentCcWebhookModel.ts

@@ -0,0 +1,37 @@
+/**
+ * BoldSign API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+
+export class DocumentCcWebhookModel {
+    'emailAddress'?: string | null;
+    'id'?: string | null;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "emailAddress",
+            "baseName": "emailAddress",
+            "type": "string"
+        },
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return DocumentCcWebhookModel.attributeTypeMap;
+    }
+}
+