boldsign 1.0.0-beta.1

package/model/documentProperties.ts

@@ -0,0 +1,308 @@
+/**
+ * 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 { AuditTrail } from './auditTrail';
+import { BehalfOf } from './behalfOf';
+import { DocumentCcDetails } from './documentCcDetails';
+import { DocumentFiles } from './documentFiles';
+import { DocumentFormFields } from './documentFormFields';
+import { DocumentReassign } from './documentReassign';
+import { DocumentSenderDetail } from './documentSenderDetail';
+import { DocumentSignerDetails } from './documentSignerDetails';
+import { FormGroup } from './formGroup';
+import { RecipientNotificationSettings } from './recipientNotificationSettings';
+import { ReminderSettings } from './reminderSettings';
+
+export class DocumentProperties {
+    'documentId'?: string | null;
+    'brandId'?: string | null;
+    'messageTitle'?: string | null;
+    'documentDescription'?: string | null;
+    'status'?: DocumentProperties.StatusEnum;
+    'files'?: Array<DocumentFiles> | null;
+    'senderDetail'?: DocumentSenderDetail;
+    'signerDetails'?: Array<DocumentSignerDetails> | null;
+    'formGroups'?: Array<FormGroup> | null;
+    'commonFields'?: Array<DocumentFormFields> | null;
+    'behalfOf'?: BehalfOf;
+    'ccDetails'?: Array<DocumentCcDetails> | null;
+    'reminderSettings'?: ReminderSettings;
+    'reassign'?: Array<DocumentReassign> | null;
+    'documentHistory'?: Array<AuditTrail> | null;
+    'activityBy'?: string | null;
+    'activityDate'?: number;
+    'activityAction'?: DocumentProperties.ActivityActionEnum;
+    'createdDate'?: number;
+    'expiryDays'?: number;
+    'expiryDate'?: number | null;
+    'enableSigningOrder'?: boolean;
+    'isDeleted'?: boolean;
+    'revokeMessage'?: string | null;
+    'declineMessage'?: string | null;
+    'applicationId'?: string | null;
+    'labels'?: Array<string> | null;
+    'disableEmails'?: boolean;
+    'enablePrintAndSign'?: boolean;
+    'enableReassign'?: boolean;
+    'disableExpiryAlert'?: boolean;
+    'hideDocumentId'?: boolean;
+    'expiryDateType'?: DocumentProperties.ExpiryDateTypeEnum;
+    'expiryValue'?: number;
+    'documentDownloadOption'?: DocumentProperties.DocumentDownloadOptionEnum;
+    'metaData'?: { [key: string]: string | null; } | null;
+    'enableAuditTrailLocalization'?: boolean;
+    'downloadFileName'?: string | null;
+    'recipientNotificationSettings'?: RecipientNotificationSettings;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "documentId",
+            "baseName": "documentId",
+            "type": "string"
+        },
+        {
+            "name": "brandId",
+            "baseName": "brandId",
+            "type": "string"
+        },
+        {
+            "name": "messageTitle",
+            "baseName": "messageTitle",
+            "type": "string"
+        },
+        {
+            "name": "documentDescription",
+            "baseName": "documentDescription",
+            "type": "string"
+        },
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "DocumentProperties.StatusEnum"
+        },
+        {
+            "name": "files",
+            "baseName": "files",
+            "type": "Array<DocumentFiles>"
+        },
+        {
+            "name": "senderDetail",
+            "baseName": "senderDetail",
+            "type": "DocumentSenderDetail"
+        },
+        {
+            "name": "signerDetails",
+            "baseName": "signerDetails",
+            "type": "Array<DocumentSignerDetails>"
+        },
+        {
+            "name": "formGroups",
+            "baseName": "formGroups",
+            "type": "Array<FormGroup>"
+        },
+        {
+            "name": "commonFields",
+            "baseName": "commonFields",
+            "type": "Array<DocumentFormFields>"
+        },
+        {
+            "name": "behalfOf",
+            "baseName": "behalfOf",
+            "type": "BehalfOf"
+        },
+        {
+            "name": "ccDetails",
+            "baseName": "ccDetails",
+            "type": "Array<DocumentCcDetails>"
+        },
+        {
+            "name": "reminderSettings",
+            "baseName": "reminderSettings",
+            "type": "ReminderSettings"
+        },
+        {
+            "name": "reassign",
+            "baseName": "reassign",
+            "type": "Array<DocumentReassign>"
+        },
+        {
+            "name": "documentHistory",
+            "baseName": "documentHistory",
+            "type": "Array<AuditTrail>"
+        },
+        {
+            "name": "activityBy",
+            "baseName": "activityBy",
+            "type": "string"
+        },
+        {
+            "name": "activityDate",
+            "baseName": "activityDate",
+            "type": "number"
+        },
+        {
+            "name": "activityAction",
+            "baseName": "activityAction",
+            "type": "DocumentProperties.ActivityActionEnum"
+        },
+        {
+            "name": "createdDate",
+            "baseName": "createdDate",
+            "type": "number"
+        },
+        {
+            "name": "expiryDays",
+            "baseName": "expiryDays",
+            "type": "number"
+        },
+        {
+            "name": "expiryDate",
+            "baseName": "expiryDate",
+            "type": "number"
+        },
+        {
+            "name": "enableSigningOrder",
+            "baseName": "enableSigningOrder",
+            "type": "boolean"
+        },
+        {
+            "name": "isDeleted",
+            "baseName": "isDeleted",
+            "type": "boolean"
+        },
+        {
+            "name": "revokeMessage",
+            "baseName": "revokeMessage",
+            "type": "string"
+        },
+        {
+            "name": "declineMessage",
+            "baseName": "declineMessage",
+            "type": "string"
+        },
+        {
+            "name": "applicationId",
+            "baseName": "applicationId",
+            "type": "string"
+        },
+        {
+            "name": "labels",
+            "baseName": "labels",
+            "type": "Array<string>"
+        },
+        {
+            "name": "disableEmails",
+            "baseName": "disableEmails",
+            "type": "boolean"
+        },
+        {
+            "name": "enablePrintAndSign",
+            "baseName": "enablePrintAndSign",
+            "type": "boolean"
+        },
+        {
+            "name": "enableReassign",
+            "baseName": "enableReassign",
+            "type": "boolean"
+        },
+        {
+            "name": "disableExpiryAlert",
+            "baseName": "disableExpiryAlert",
+            "type": "boolean"
+        },
+        {
+            "name": "hideDocumentId",
+            "baseName": "hideDocumentId",
+            "type": "boolean"
+        },
+        {
+            "name": "expiryDateType",
+            "baseName": "expiryDateType",
+            "type": "DocumentProperties.ExpiryDateTypeEnum"
+        },
+        {
+            "name": "expiryValue",
+            "baseName": "expiryValue",
+            "type": "number"
+        },
+        {
+            "name": "documentDownloadOption",
+            "baseName": "documentDownloadOption",
+            "type": "DocumentProperties.DocumentDownloadOptionEnum"
+        },
+        {
+            "name": "metaData",
+            "baseName": "metaData",
+            "type": "{ [key: string]: string | null; }"
+        },
+        {
+            "name": "enableAuditTrailLocalization",
+            "baseName": "enableAuditTrailLocalization",
+            "type": "boolean"
+        },
+        {
+            "name": "downloadFileName",
+            "baseName": "downloadFileName",
+            "type": "string"
+        },
+        {
+            "name": "recipientNotificationSettings",
+            "baseName": "recipientNotificationSettings",
+            "type": "RecipientNotificationSettings"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return DocumentProperties.attributeTypeMap;
+    }
+}
+
+export namespace DocumentProperties {
+    export enum StatusEnum {
+        InProgress = <any> 'InProgress',
+        Completed = <any> 'Completed',
+        Declined = <any> 'Declined',
+        Expired = <any> 'Expired',
+        Revoked = <any> 'Revoked',
+        Draft = <any> 'Draft'
+    }
+    export enum ActivityActionEnum {
+        Viewed = <any> 'Viewed',
+        Signed = <any> 'Signed',
+        Reassigned = <any> 'Reassigned',
+        Declined = <any> 'Declined',
+        Revoked = <any> 'Revoked',
+        Expired = <any> 'Expired',
+        Downloaded = <any> 'Downloaded',
+        DownloadedForPrintSign = <any> 'DownloadedForPrintSign',
+        InitiatePrintAndSign = <any> 'InitiatePrintAndSign',
+        InitiateFormSign = <any> 'InitiateFormSign',
+        CancelPrintAndSign = <any> 'CancelPrintAndSign',
+        CompletePrintAndSign = <any> 'CompletePrintAndSign',
+        Reviewed = <any> 'Reviewed',
+        None = <any> 'None',
+        EditingInitiated = <any> 'EditingInitiated',
+        EditingCancelled = <any> 'EditingCancelled',
+        EditingCompleted = <any> 'EditingCompleted'
+    }
+    export enum ExpiryDateTypeEnum {
+        Days = <any> 'Days',
+        Hours = <any> 'Hours',
+        SpecificDateTime = <any> 'SpecificDateTime'
+    }
+    export enum DocumentDownloadOptionEnum {
+        Combined = <any> 'Combined',
+        Individually = <any> 'Individually'
+    }
+}

package/model/documentReassign.ts

@@ -0,0 +1,43 @@
+/**
+ * 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 DocumentReassign {
+    'signerEmail'?: string | null;
+    'order'?: number = 0;
+    'message'?: string | null;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "signerEmail",
+            "baseName": "signerEmail",
+            "type": "string"
+        },
+        {
+            "name": "order",
+            "baseName": "order",
+            "type": "number"
+        },
+        {
+            "name": "message",
+            "baseName": "message",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return DocumentReassign.attributeTypeMap;
+    }
+}
+

package/model/documentRecords.ts

@@ -0,0 +1,39 @@
+/**
+ * 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 { Document } from './document';
+import { PageDetails } from './pageDetails';
+
+export class DocumentRecords {
+    'pageDetails'?: PageDetails;
+    'result'?: Array<Document> | null;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "pageDetails",
+            "baseName": "pageDetails",
+            "type": "PageDetails"
+        },
+        {
+            "name": "result",
+            "baseName": "result",
+            "type": "Array<Document>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return DocumentRecords.attributeTypeMap;
+    }
+}
+

package/model/documentSenderDetail.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 DocumentSenderDetail {
+    'name'?: string | null;
+    'privateMessage'?: string | null;
+    'emailAddress'?: string | null;
+    'isViewed'?: boolean = false;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "privateMessage",
+            "baseName": "privateMessage",
+            "type": "string"
+        },
+        {
+            "name": "emailAddress",
+            "baseName": "emailAddress",
+            "type": "string"
+        },
+        {
+            "name": "isViewed",
+            "baseName": "isViewed",
+            "type": "boolean"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return DocumentSenderDetail.attributeTypeMap;
+    }
+}
+

package/model/documentSigner.ts

@@ -0,0 +1,194 @@
+/**
+ * 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 { FormField } from './formField';
+import { IdentityVerificationSettings } from './identityVerificationSettings';
+import { PhoneNumber } from './phoneNumber';
+
+export class DocumentSigner {
+    'name': string;
+    'emailAddress'?: string | null;
+    'privateMessage'?: string | null;
+    'authenticationType'?: DocumentSigner.AuthenticationTypeEnum;
+    'phoneNumber'?: PhoneNumber;
+    'deliveryMode'?: DocumentSigner.DeliveryModeEnum;
+    'authenticationCode'?: string | null;
+    'identityVerificationSettings'?: IdentityVerificationSettings;
+    'signerOrder'?: number;
+    'enableEmailOTP'?: boolean;
+    'signerType'?: DocumentSigner.SignerTypeEnum;
+    'hostEmail'?: string | null;
+    'signerRole'?: string | null;
+    'allowFieldConfiguration'?: boolean;
+    'formFields'?: Array<FormField> | null;
+    /**
+    * <p>Description:</p><ul><li><i>0</i> - None</li><li><i>1</i> - English</li><li><i>2</i> - Spanish</li><li><i>3</i> - German</li><li><i>4</i> - French</li><li><i>5</i> - Romanian</li><li><i>6</i> - Norwegian</li><li><i>7</i> - Bulgarian</li><li><i>8</i> - Italian</li><li><i>9</i> - Danish</li><li><i>10</i> - Polish</li><li><i>11</i> - Portuguese</li><li><i>12</i> - Czech</li><li><i>13</i> - Dutch</li><li><i>14</i> - Swedish</li><li><i>15</i> - Russian</li></ul>
+    */
+    'language'?: DocumentSigner.LanguageEnum;
+    'locale'?: DocumentSigner.LocaleEnum;
+    'authenticationRetryCount'?: number | 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": "privateMessage",
+            "baseName": "privateMessage",
+            "type": "string"
+        },
+        {
+            "name": "authenticationType",
+            "baseName": "authenticationType",
+            "type": "DocumentSigner.AuthenticationTypeEnum"
+        },
+        {
+            "name": "phoneNumber",
+            "baseName": "phoneNumber",
+            "type": "PhoneNumber"
+        },
+        {
+            "name": "deliveryMode",
+            "baseName": "deliveryMode",
+            "type": "DocumentSigner.DeliveryModeEnum"
+        },
+        {
+            "name": "authenticationCode",
+            "baseName": "authenticationCode",
+            "type": "string"
+        },
+        {
+            "name": "identityVerificationSettings",
+            "baseName": "identityVerificationSettings",
+            "type": "IdentityVerificationSettings"
+        },
+        {
+            "name": "signerOrder",
+            "baseName": "signerOrder",
+            "type": "number"
+        },
+        {
+            "name": "enableEmailOTP",
+            "baseName": "enableEmailOTP",
+            "type": "boolean"
+        },
+        {
+            "name": "signerType",
+            "baseName": "signerType",
+            "type": "DocumentSigner.SignerTypeEnum"
+        },
+        {
+            "name": "hostEmail",
+            "baseName": "hostEmail",
+            "type": "string"
+        },
+        {
+            "name": "signerRole",
+            "baseName": "signerRole",
+            "type": "string"
+        },
+        {
+            "name": "allowFieldConfiguration",
+            "baseName": "allowFieldConfiguration",
+            "type": "boolean"
+        },
+        {
+            "name": "formFields",
+            "baseName": "formFields",
+            "type": "Array<FormField>"
+        },
+        {
+            "name": "language",
+            "baseName": "language",
+            "type": "DocumentSigner.LanguageEnum"
+        },
+        {
+            "name": "locale",
+            "baseName": "locale",
+            "type": "DocumentSigner.LocaleEnum"
+        },
+        {
+            "name": "authenticationRetryCount",
+            "baseName": "authenticationRetryCount",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return DocumentSigner.attributeTypeMap;
+    }
+}
+
+export namespace DocumentSigner {
+    export enum AuthenticationTypeEnum {
+        None = <any> 'None',
+        EmailOtp = <any> 'EmailOTP',
+        AccessCode = <any> 'AccessCode',
+        Smsotp = <any> 'SMSOTP',
+        IdVerification = <any> 'IdVerification'
+    }
+    export enum DeliveryModeEnum {
+        Email = <any> 'Email',
+        Sms = <any> 'SMS',
+        EmailAndSms = <any> 'EmailAndSMS'
+    }
+    export enum SignerTypeEnum {
+        Signer = <any> 'Signer',
+        Reviewer = <any> 'Reviewer',
+        InPersonSigner = <any> 'InPersonSigner'
+    }
+    export enum LanguageEnum {
+        NUMBER_0 = <any> 0,
+        NUMBER_1 = <any> 1,
+        NUMBER_2 = <any> 2,
+        NUMBER_3 = <any> 3,
+        NUMBER_4 = <any> 4,
+        NUMBER_5 = <any> 5,
+        NUMBER_6 = <any> 6,
+        NUMBER_7 = <any> 7,
+        NUMBER_8 = <any> 8,
+        NUMBER_9 = <any> 9,
+        NUMBER_10 = <any> 10,
+        NUMBER_11 = <any> 11,
+        NUMBER_12 = <any> 12,
+        NUMBER_13 = <any> 13,
+        NUMBER_14 = <any> 14,
+        NUMBER_15 = <any> 15
+    }
+    export enum LocaleEnum {
+        En = <any> 'EN',
+        No = <any> 'NO',
+        Fr = <any> 'FR',
+        De = <any> 'DE',
+        Es = <any> 'ES',
+        Bg = <any> 'BG',
+        Cs = <any> 'CS',
+        Da = <any> 'DA',
+        It = <any> 'IT',
+        Nl = <any> 'NL',
+        Pl = <any> 'PL',
+        Pt = <any> 'PT',
+        Ro = <any> 'RO',
+        Ru = <any> 'RU',
+        Sv = <any> 'SV',
+        Default = <any> 'Default'
+    }
+}