boldsign 3.2.0 → 3.3.1

package/model/documentEvent.ts

@@ -0,0 +1,213 @@
+/**
+ * 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';
+import { BehalfOfWebhookModel } from './behalfOfWebhookModel';
+import { DocumentCcWebhookModel } from './documentCcWebhookModel';
+import { DocumentSender } from './documentSender';
+import { DocumentSignerWebhookModel } from './documentSignerWebhookModel';
+import { GroupSignerSettingsWebhookModel } from './groupSignerSettingsWebhookModel';
+
+export class DocumentEvent {
+    'object'?: string | null;
+    'documentId'?: string | null;
+    'messageTitle'?: string | null;
+    'documentDescription'?: string | null;
+    'status'?: DocumentEvent.StatusEnum;
+    'senderDetail'?: DocumentSender;
+    'signerDetails'?: Array<DocumentSignerWebhookModel> | null;
+    'ccDetails'?: Array<DocumentCcWebhookModel> | null;
+    'onBehalfOf'?: string | null;
+    'createdDate'?: Date | null;
+    'expiryDate'?: Date | null;
+    'enableSigningOrder'?: boolean;
+    'disableEmails'?: boolean;
+    'revokeMessage'?: string | null;
+    'errorMessage'?: string | null;
+    'labels'?: Array<string> | null;
+    'isCombinedAudit'?: boolean;
+    'isCombinedAttachment'?: boolean;
+    'brandId'?: string | null;
+    'documentDownloadOption'?: string | null;
+    'metaData'?: { [key: string]: string | null; } | null;
+    'failedDeliveryMode'?: DocumentEvent.FailedDeliveryModeEnum;
+    'behalfOf'?: BehalfOfWebhookModel;
+    'allowedSignatureTypes'?: Array<DocumentEvent.AllowedSignatureTypesEnum>;
+    'groupSignerSettings'?: GroupSignerSettingsWebhookModel;
+    'enableAllowSignEverywhere'?: boolean | null;
+    'documentTimeZone'?: string | null;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "object",
+            "baseName": "object",
+            "type": "string"
+        },
+        {
+            "name": "documentId",
+            "baseName": "documentId",
+            "type": "string"
+        },
+        {
+            "name": "messageTitle",
+            "baseName": "messageTitle",
+            "type": "string"
+        },
+        {
+            "name": "documentDescription",
+            "baseName": "documentDescription",
+            "type": "string"
+        },
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "DocumentEvent.StatusEnum"
+        },
+        {
+            "name": "senderDetail",
+            "baseName": "senderDetail",
+            "type": "DocumentSender"
+        },
+        {
+            "name": "signerDetails",
+            "baseName": "signerDetails",
+            "type": "Array<DocumentSignerWebhookModel>"
+        },
+        {
+            "name": "ccDetails",
+            "baseName": "ccDetails",
+            "type": "Array<DocumentCcWebhookModel>"
+        },
+        {
+            "name": "onBehalfOf",
+            "baseName": "onBehalfOf",
+            "type": "string"
+        },
+        {
+            "name": "createdDate",
+            "baseName": "createdDate",
+            "type": "Date"
+        },
+        {
+            "name": "expiryDate",
+            "baseName": "expiryDate",
+            "type": "Date"
+        },
+        {
+            "name": "enableSigningOrder",
+            "baseName": "enableSigningOrder",
+            "type": "boolean"
+        },
+        {
+            "name": "disableEmails",
+            "baseName": "disableEmails",
+            "type": "boolean"
+        },
+        {
+            "name": "revokeMessage",
+            "baseName": "revokeMessage",
+            "type": "string"
+        },
+        {
+            "name": "errorMessage",
+            "baseName": "errorMessage",
+            "type": "string"
+        },
+        {
+            "name": "labels",
+            "baseName": "labels",
+            "type": "Array<string>"
+        },
+        {
+            "name": "isCombinedAudit",
+            "baseName": "isCombinedAudit",
+            "type": "boolean"
+        },
+        {
+            "name": "isCombinedAttachment",
+            "baseName": "isCombinedAttachment",
+            "type": "boolean"
+        },
+        {
+            "name": "brandId",
+            "baseName": "brandId",
+            "type": "string"
+        },
+        {
+            "name": "documentDownloadOption",
+            "baseName": "documentDownloadOption",
+            "type": "string"
+        },
+        {
+            "name": "metaData",
+            "baseName": "metaData",
+            "type": "{ [key: string]: string | null; }"
+        },
+        {
+            "name": "failedDeliveryMode",
+            "baseName": "failedDeliveryMode",
+            "type": "DocumentEvent.FailedDeliveryModeEnum"
+        },
+        {
+            "name": "behalfOf",
+            "baseName": "behalfOf",
+            "type": "BehalfOfWebhookModel"
+        },
+        {
+            "name": "allowedSignatureTypes",
+            "baseName": "allowedSignatureTypes",
+            "type": "Array<DocumentEvent.AllowedSignatureTypesEnum>"
+        },
+        {
+            "name": "groupSignerSettings",
+            "baseName": "groupSignerSettings",
+            "type": "GroupSignerSettingsWebhookModel"
+        },
+        {
+            "name": "enableAllowSignEverywhere",
+            "baseName": "enableAllowSignEverywhere",
+            "type": "boolean"
+        },
+        {
+            "name": "documentTimeZone",
+            "baseName": "documentTimeZone",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return DocumentEvent.attributeTypeMap;
+    }
+}
+
+export namespace DocumentEvent {
+    export enum StatusEnum {
+        InProgress = <any> 'InProgress',
+        Completed = <any> 'Completed',
+        Declined = <any> 'Declined',
+        Expired = <any> 'Expired',
+        Revoked = <any> 'Revoked',
+        Draft = <any> 'Draft',
+        Scheduled = <any> 'Scheduled'
+    }
+    export enum FailedDeliveryModeEnum {
+        Email = <any> 'Email',
+        Sms = <any> 'SMS',
+        WhatsApp = <any> 'WhatsApp'
+    }
+    export enum AllowedSignatureTypesEnum {
+        Text = <any> 'Text',
+        Draw = <any> 'Draw',
+        Image = <any> 'Image'
+    }
+}

package/model/documentGroupSignerWebhookModel.ts

@@ -0,0 +1,83 @@
+/**
+ * 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 DocumentGroupSignerWebhookModel {
+    'id'?: string | null;
+    'signerEmail'?: string | null;
+    'signerName'?: string | null;
+    'status'?: DocumentGroupSignerWebhookModel.StatusEnum;
+    'isViewed'?: boolean;
+    'isDeliveryFailed'?: boolean;
+    'isAuthenticationFailed'?: boolean | null;
+    'lastReminderSentOn'?: Date | null;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        },
+        {
+            "name": "signerEmail",
+            "baseName": "signerEmail",
+            "type": "string"
+        },
+        {
+            "name": "signerName",
+            "baseName": "signerName",
+            "type": "string"
+        },
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "DocumentGroupSignerWebhookModel.StatusEnum"
+        },
+        {
+            "name": "isViewed",
+            "baseName": "isViewed",
+            "type": "boolean"
+        },
+        {
+            "name": "isDeliveryFailed",
+            "baseName": "isDeliveryFailed",
+            "type": "boolean"
+        },
+        {
+            "name": "isAuthenticationFailed",
+            "baseName": "isAuthenticationFailed",
+            "type": "boolean"
+        },
+        {
+            "name": "lastReminderSentOn",
+            "baseName": "lastReminderSentOn",
+            "type": "Date"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return DocumentGroupSignerWebhookModel.attributeTypeMap;
+    }
+}
+
+export namespace DocumentGroupSignerWebhookModel {
+    export enum StatusEnum {
+        None = <any> 'None',
+        NotCompleted = <any> 'NotCompleted',
+        Completed = <any> 'Completed',
+        Declined = <any> 'Declined',
+        Revoked = <any> 'Revoked',
+        Expired = <any> 'Expired'
+    }
+}

package/model/documentProperties.ts

@@ -72,6 +72,7 @@ export class DocumentProperties {
     'enableAllowSignEverywhere'?: boolean;
     'isCombinedAudit'?: boolean;
     'isCombinedAttachment'?: boolean;
+    'documentTimeZone'?: string | null;
 
     static discriminator: string | undefined = undefined;
 
@@ -310,6 +311,11 @@ export class DocumentProperties {
             "name": "isCombinedAttachment",
             "baseName": "isCombinedAttachment",
             "type": "boolean"
+        },
+        {
+            "name": "documentTimeZone",
+            "baseName": "documentTimeZone",
+            "type": "string"
         }    ];
 
     static getAttributeTypeMap() {
@@ -354,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/documentSender.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 DocumentSender {
+    'name'?: string | null;
+    'emailAddress'?: string | null;
+    'userId'?: string | null;
+    'teamId'?: string | null;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "emailAddress",
+            "baseName": "emailAddress",
+            "type": "string"
+        },
+        {
+            "name": "userId",
+            "baseName": "userId",
+            "type": "string"
+        },
+        {
+            "name": "teamId",
+            "baseName": "teamId",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return DocumentSender.attributeTypeMap;
+    }
+}
+

package/model/documentSigner.ts

@@ -14,6 +14,7 @@ import { RequestFile } from './models';
 import { AuthenticationSettings } from './authenticationSettings';
 import { FormField } from './formField';
 import { IdentityVerificationSettings } from './identityVerificationSettings';
+import { KbaSettings } from './kbaSettings';
 import { PhoneNumber } from './phoneNumber';
 import { RecipientNotificationSettings } from './recipientNotificationSettings';
 
@@ -27,6 +28,7 @@ export class DocumentSigner {
     'deliveryMode'?: DocumentSigner.DeliveryModeEnum;
     'authenticationCode'?: string | null;
     'identityVerificationSettings'?: IdentityVerificationSettings;
+    'kbaSettings'?: KbaSettings;
     'signerOrder'?: number;
     'enableEmailOTP'?: boolean;
     'signerType'?: DocumentSigner.SignerTypeEnum;
@@ -94,6 +96,11 @@ export class DocumentSigner {
             "baseName": "identityVerificationSettings",
             "type": "IdentityVerificationSettings"
         },
+        {
+            "name": "kbaSettings",
+            "baseName": "kbaSettings",
+            "type": "KbaSettings"
+        },
         {
             "name": "signerOrder",
             "baseName": "signerOrder",
@@ -181,7 +188,8 @@ export namespace DocumentSigner {
         EmailOtp = <any> 'EmailOTP',
         AccessCode = <any> 'AccessCode',
         Smsotp = <any> 'SMSOTP',
-        IdVerification = <any> 'IdVerification'
+        IdVerification = <any> 'IdVerification',
+        Kba = <any> 'KBA'
     }
     export enum DeliveryModeEnum {
         Email = <any> 'Email',

package/model/documentSignerDetails.ts

@@ -14,6 +14,7 @@ import { RequestFile } from './models';
 import { DocumentFormFields } from './documentFormFields';
 import { GroupSigner } from './groupSigner';
 import { IdVerificationDetails } from './idVerificationDetails';
+import { KbaDetails } from './kbaDetails';
 import { PhoneNumber } from './phoneNumber';
 import { RecipientNotificationSettings } from './recipientNotificationSettings';
 import { SignerAuthenticationSettings } from './signerAuthenticationSettings';
@@ -47,6 +48,7 @@ export class DocumentSignerDetails {
     'groupId'?: string | null;
     'phoneNumber'?: PhoneNumber;
     'idVerification'?: IdVerificationDetails;
+    'kba'?: KbaDetails;
     'recipientNotificationSettings'?: RecipientNotificationSettings;
     'authenticationRetryCount'?: number | null;
     'enableQes'?: boolean | null;
@@ -182,6 +184,11 @@ export class DocumentSignerDetails {
             "baseName": "idVerification",
             "type": "IdVerificationDetails"
         },
+        {
+            "name": "kba",
+            "baseName": "kba",
+            "type": "KbaDetails"
+        },
         {
             "name": "recipientNotificationSettings",
             "baseName": "recipientNotificationSettings",
@@ -232,7 +239,8 @@ export namespace DocumentSignerDetails {
         EmailOtp = <any> 'EmailOTP',
         AccessCode = <any> 'AccessCode',
         Smsotp = <any> 'SMSOTP',
-        IdVerification = <any> 'IdVerification'
+        IdVerification = <any> 'IdVerification',
+        Kba = <any> 'KBA'
     }
     export enum SignerTypeEnum {
         Signer = <any> 'Signer',

package/model/documentSignerWebhookModel.ts

@@ -0,0 +1,202 @@
+/**
+ * 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';
+import { DocumentGroupSignerWebhookModel } from './documentGroupSignerWebhookModel';
+import { IdVerificationSignerWebhookModel } from './idVerificationSignerWebhookModel';
+import { KbaSignerWebhookModel } from './kbaSignerWebhookModel';
+import { PhoneNumberWebhookModel } from './phoneNumberWebhookModel';
+import { SignerAuthenticationWebhookModel } from './signerAuthenticationWebhookModel';
+
+export class DocumentSignerWebhookModel {
+    'signerName'?: string | null;
+    'signerRole'?: string | null;
+    'signerEmail'?: string | null;
+    'id'?: string | null;
+    'groupSigners'?: Array<DocumentGroupSignerWebhookModel> | null;
+    'phoneNumber'?: PhoneNumberWebhookModel;
+    'status'?: DocumentSignerWebhookModel.StatusEnum;
+    'enableAccessCode'?: boolean;
+    'isAuthenticationFailed'?: boolean | null;
+    'enableEmailOTP'?: boolean;
+    'isDeliveryFailed'?: boolean;
+    'isViewed'?: boolean;
+    'order'?: number;
+    'signerType'?: string | null;
+    'signType'?: string | null;
+    'groupId'?: string | null;
+    'isReassigned'?: boolean;
+    'reassignMessage'?: string | null;
+    'declineMessage'?: string | null;
+    'lastActivityDate'?: Date | null;
+    'authenticationType'?: string | null;
+    'idVerification'?: IdVerificationSignerWebhookModel;
+    'kba'?: KbaSignerWebhookModel;
+    'allowFieldConfiguration'?: boolean;
+    'lastReminderSentOn'?: Date | null;
+    'authenticationRetryCount'?: number | null;
+    'authenticationSettings'?: SignerAuthenticationWebhookModel;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "signerName",
+            "baseName": "signerName",
+            "type": "string"
+        },
+        {
+            "name": "signerRole",
+            "baseName": "signerRole",
+            "type": "string"
+        },
+        {
+            "name": "signerEmail",
+            "baseName": "signerEmail",
+            "type": "string"
+        },
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        },
+        {
+            "name": "groupSigners",
+            "baseName": "groupSigners",
+            "type": "Array<DocumentGroupSignerWebhookModel>"
+        },
+        {
+            "name": "phoneNumber",
+            "baseName": "phoneNumber",
+            "type": "PhoneNumberWebhookModel"
+        },
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "DocumentSignerWebhookModel.StatusEnum"
+        },
+        {
+            "name": "enableAccessCode",
+            "baseName": "enableAccessCode",
+            "type": "boolean"
+        },
+        {
+            "name": "isAuthenticationFailed",
+            "baseName": "isAuthenticationFailed",
+            "type": "boolean"
+        },
+        {
+            "name": "enableEmailOTP",
+            "baseName": "enableEmailOTP",
+            "type": "boolean"
+        },
+        {
+            "name": "isDeliveryFailed",
+            "baseName": "isDeliveryFailed",
+            "type": "boolean"
+        },
+        {
+            "name": "isViewed",
+            "baseName": "isViewed",
+            "type": "boolean"
+        },
+        {
+            "name": "order",
+            "baseName": "order",
+            "type": "number"
+        },
+        {
+            "name": "signerType",
+            "baseName": "signerType",
+            "type": "string"
+        },
+        {
+            "name": "signType",
+            "baseName": "signType",
+            "type": "string"
+        },
+        {
+            "name": "groupId",
+            "baseName": "groupId",
+            "type": "string"
+        },
+        {
+            "name": "isReassigned",
+            "baseName": "isReassigned",
+            "type": "boolean"
+        },
+        {
+            "name": "reassignMessage",
+            "baseName": "reassignMessage",
+            "type": "string"
+        },
+        {
+            "name": "declineMessage",
+            "baseName": "declineMessage",
+            "type": "string"
+        },
+        {
+            "name": "lastActivityDate",
+            "baseName": "lastActivityDate",
+            "type": "Date"
+        },
+        {
+            "name": "authenticationType",
+            "baseName": "authenticationType",
+            "type": "string"
+        },
+        {
+            "name": "idVerification",
+            "baseName": "idVerification",
+            "type": "IdVerificationSignerWebhookModel"
+        },
+        {
+            "name": "kba",
+            "baseName": "kba",
+            "type": "KbaSignerWebhookModel"
+        },
+        {
+            "name": "allowFieldConfiguration",
+            "baseName": "allowFieldConfiguration",
+            "type": "boolean"
+        },
+        {
+            "name": "lastReminderSentOn",
+            "baseName": "lastReminderSentOn",
+            "type": "Date"
+        },
+        {
+            "name": "authenticationRetryCount",
+            "baseName": "authenticationRetryCount",
+            "type": "number"
+        },
+        {
+            "name": "authenticationSettings",
+            "baseName": "authenticationSettings",
+            "type": "SignerAuthenticationWebhookModel"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return DocumentSignerWebhookModel.attributeTypeMap;
+    }
+}
+
+export namespace DocumentSignerWebhookModel {
+    export enum StatusEnum {
+        None = <any> 'None',
+        NotCompleted = <any> 'NotCompleted',
+        Completed = <any> 'Completed',
+        Declined = <any> 'Declined',
+        Revoked = <any> 'Revoked',
+        Expired = <any> 'Expired'
+    }
+}