boldsign 1.0.0-beta.1

package/model/documentSignerDetails.ts

@@ -0,0 +1,234 @@
+/**
+ * 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 { DocumentFormFields } from './documentFormFields';
+import { IdVerification } from './idVerification';
+import { PhoneNumber } from './phoneNumber';
+import { RecipientNotificationSettings } from './recipientNotificationSettings';
+
+export class DocumentSignerDetails {
+    'signerName'?: string | null;
+    'signerRole'?: string | null;
+    'signerEmail'?: string | null;
+    'status'?: DocumentSignerDetails.StatusEnum;
+    'enableAccessCode'?: boolean;
+    'isAuthenticationFailed'?: boolean | null = false;
+    'enableEmailOTP'?: boolean;
+    'authenticationType'?: DocumentSignerDetails.AuthenticationTypeEnum;
+    'isDeliveryFailed'?: boolean = false;
+    'isViewed'?: boolean = false;
+    'order'?: number = 0;
+    'signerType'?: DocumentSignerDetails.SignerTypeEnum = DocumentSignerDetails.SignerTypeEnum.Signer;
+    'hostEmail'?: string | null;
+    'hostName'?: string | null;
+    'isReassigned'?: boolean;
+    'privateMessage'?: string | null;
+    'allowFieldConfiguration'?: boolean;
+    'formFields'?: Array<DocumentFormFields> | 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'?: DocumentSignerDetails.LanguageEnum;
+    'locale'?: DocumentSignerDetails.LocaleEnum;
+    'phoneNumber'?: PhoneNumber;
+    'idVerification'?: IdVerification;
+    'recipientNotificationSettings'?: RecipientNotificationSettings;
+    'authenticationRetryCount'?: number | null;
+
+    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": "status",
+            "baseName": "status",
+            "type": "DocumentSignerDetails.StatusEnum"
+        },
+        {
+            "name": "enableAccessCode",
+            "baseName": "enableAccessCode",
+            "type": "boolean"
+        },
+        {
+            "name": "isAuthenticationFailed",
+            "baseName": "isAuthenticationFailed",
+            "type": "boolean"
+        },
+        {
+            "name": "enableEmailOTP",
+            "baseName": "enableEmailOTP",
+            "type": "boolean"
+        },
+        {
+            "name": "authenticationType",
+            "baseName": "authenticationType",
+            "type": "DocumentSignerDetails.AuthenticationTypeEnum"
+        },
+        {
+            "name": "isDeliveryFailed",
+            "baseName": "isDeliveryFailed",
+            "type": "boolean"
+        },
+        {
+            "name": "isViewed",
+            "baseName": "isViewed",
+            "type": "boolean"
+        },
+        {
+            "name": "order",
+            "baseName": "order",
+            "type": "number"
+        },
+        {
+            "name": "signerType",
+            "baseName": "signerType",
+            "type": "DocumentSignerDetails.SignerTypeEnum"
+        },
+        {
+            "name": "hostEmail",
+            "baseName": "hostEmail",
+            "type": "string"
+        },
+        {
+            "name": "hostName",
+            "baseName": "hostName",
+            "type": "string"
+        },
+        {
+            "name": "isReassigned",
+            "baseName": "isReassigned",
+            "type": "boolean"
+        },
+        {
+            "name": "privateMessage",
+            "baseName": "privateMessage",
+            "type": "string"
+        },
+        {
+            "name": "allowFieldConfiguration",
+            "baseName": "allowFieldConfiguration",
+            "type": "boolean"
+        },
+        {
+            "name": "formFields",
+            "baseName": "formFields",
+            "type": "Array<DocumentFormFields>"
+        },
+        {
+            "name": "language",
+            "baseName": "language",
+            "type": "DocumentSignerDetails.LanguageEnum"
+        },
+        {
+            "name": "locale",
+            "baseName": "locale",
+            "type": "DocumentSignerDetails.LocaleEnum"
+        },
+        {
+            "name": "phoneNumber",
+            "baseName": "phoneNumber",
+            "type": "PhoneNumber"
+        },
+        {
+            "name": "idVerification",
+            "baseName": "idVerification",
+            "type": "IdVerification"
+        },
+        {
+            "name": "recipientNotificationSettings",
+            "baseName": "recipientNotificationSettings",
+            "type": "RecipientNotificationSettings"
+        },
+        {
+            "name": "authenticationRetryCount",
+            "baseName": "authenticationRetryCount",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return DocumentSignerDetails.attributeTypeMap;
+    }
+}
+
+export namespace DocumentSignerDetails {
+    export enum StatusEnum {
+        None = <any> 'None',
+        NotCompleted = <any> 'NotCompleted',
+        Completed = <any> 'Completed',
+        Declined = <any> 'Declined',
+        Revoked = <any> 'Revoked',
+        Expired = <any> 'Expired'
+    }
+    export enum AuthenticationTypeEnum {
+        None = <any> 'None',
+        EmailOtp = <any> 'EmailOTP',
+        AccessCode = <any> 'AccessCode',
+        Smsotp = <any> 'SMSOTP',
+        IdVerification = <any> 'IdVerification'
+    }
+    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'
+    }
+}

package/model/documentTags.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 DocumentTags {
+    'documentId': string;
+    'tags': Array<string>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "documentId",
+            "baseName": "documentId",
+            "type": "string"
+        },
+        {
+            "name": "tags",
+            "baseName": "tags",
+            "type": "Array<string>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return DocumentTags.attributeTypeMap;
+    }
+}
+

package/model/editSenderIdentityRequest.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 { NotificationSettings } from './notificationSettings';
+
+export class EditSenderIdentityRequest {
+    'name'?: string | null;
+    'notificationSettings'?: NotificationSettings;
+    'redirectUrl'?: string | null;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "notificationSettings",
+            "baseName": "notificationSettings",
+            "type": "NotificationSettings"
+        },
+        {
+            "name": "redirectUrl",
+            "baseName": "redirectUrl",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return EditSenderIdentityRequest.attributeTypeMap;
+    }
+}
+

package/model/editTemplateRequest.ts

@@ -0,0 +1,137 @@
+/**
+ * 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 { DocumentCC } from './documentCC';
+import { DocumentInfo } from './documentInfo';
+import { FormGroup } from './formGroup';
+import { TemplateRole } from './templateRole';
+
+export class EditTemplateRequest {
+    'title'?: string | null;
+    'description'?: string | null;
+    'documentTitle'?: string | null;
+    'documentMessage'?: string | null;
+    'roles'?: Array<TemplateRole> | null;
+    'cc'?: Array<DocumentCC> | null;
+    'brandId'?: string | null;
+    'allowMessageEditing'?: boolean | null;
+    'allowNewRoles'?: boolean | null;
+    'allowNewFiles'?: boolean | null;
+    'enableReassign'?: boolean | null;
+    'enablePrintAndSign'?: boolean | null;
+    'enableSigningOrder'?: boolean | null;
+    'documentInfo'?: Array<DocumentInfo> | null;
+    'onBehalfOf'?: string | null;
+    'labels'?: Array<string> | null;
+    'templateLabels'?: Array<string> | null;
+    'formGroups'?: Array<FormGroup> | null;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "title",
+            "baseName": "title",
+            "type": "string"
+        },
+        {
+            "name": "description",
+            "baseName": "description",
+            "type": "string"
+        },
+        {
+            "name": "documentTitle",
+            "baseName": "documentTitle",
+            "type": "string"
+        },
+        {
+            "name": "documentMessage",
+            "baseName": "documentMessage",
+            "type": "string"
+        },
+        {
+            "name": "roles",
+            "baseName": "roles",
+            "type": "Array<TemplateRole>"
+        },
+        {
+            "name": "cc",
+            "baseName": "cc",
+            "type": "Array<DocumentCC>"
+        },
+        {
+            "name": "brandId",
+            "baseName": "brandId",
+            "type": "string"
+        },
+        {
+            "name": "allowMessageEditing",
+            "baseName": "allowMessageEditing",
+            "type": "boolean"
+        },
+        {
+            "name": "allowNewRoles",
+            "baseName": "allowNewRoles",
+            "type": "boolean"
+        },
+        {
+            "name": "allowNewFiles",
+            "baseName": "allowNewFiles",
+            "type": "boolean"
+        },
+        {
+            "name": "enableReassign",
+            "baseName": "enableReassign",
+            "type": "boolean"
+        },
+        {
+            "name": "enablePrintAndSign",
+            "baseName": "enablePrintAndSign",
+            "type": "boolean"
+        },
+        {
+            "name": "enableSigningOrder",
+            "baseName": "enableSigningOrder",
+            "type": "boolean"
+        },
+        {
+            "name": "documentInfo",
+            "baseName": "documentInfo",
+            "type": "Array<DocumentInfo>"
+        },
+        {
+            "name": "onBehalfOf",
+            "baseName": "onBehalfOf",
+            "type": "string"
+        },
+        {
+            "name": "labels",
+            "baseName": "labels",
+            "type": "Array<string>"
+        },
+        {
+            "name": "templateLabels",
+            "baseName": "templateLabels",
+            "type": "Array<string>"
+        },
+        {
+            "name": "formGroups",
+            "baseName": "formGroups",
+            "type": "Array<FormGroup>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return EditTemplateRequest.attributeTypeMap;
+    }
+}
+

package/model/editableDateFieldSettings.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 EditableDateFieldSettings {
+    'dateFormat': string | null;
+    'minDate'?: Date | null;
+    'maxDate'?: Date | null;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "dateFormat",
+            "baseName": "dateFormat",
+            "type": "string"
+        },
+        {
+            "name": "minDate",
+            "baseName": "minDate",
+            "type": "Date"
+        },
+        {
+            "name": "maxDate",
+            "baseName": "maxDate",
+            "type": "Date"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return EditableDateFieldSettings.attributeTypeMap;
+    }
+}
+