boldsign 3.0.1 → 3.0.2

package/examples/embeddedCreatePreviewUrl.ts

@@ -0,0 +1,15 @@
+import { EmbeddedTemplatePreview, EmbeddedTemplatePreviewJsonRequest, TemplateApi } from "../api";
+
+const templateApi = new TemplateApi();
+templateApi.setApiKey("API_KEY");
+async function createEmbeddedPreviewUrl() {
+     try {
+        var embeddedTemplatePreview = new EmbeddedTemplatePreviewJsonRequest();
+        embeddedTemplatePreview.showToolbar = true;
+        var preview_url = await templateApi.createEmbeddedPreviewUrl("TEMPLATE_ID", embeddedTemplatePreview);
+        console.log(preview_url);
+    } catch (error:any) {
+        console.error("Error occurred while calling the API:", error.message);
+    }
+}
+createEmbeddedPreviewUrl();

package/model/attachmentInfo.ts

@@ -14,9 +14,9 @@ import { RequestFile } from './models';
 
 export class AttachmentInfo {
     'title': string | null;
-    'allowedFileTypes': string | null;
+    'acceptedFileTypes': Array<string> | null;
     'description'?: string | null;
-    'acceptedFileTypes'?: Array<string> | null;
+    'allowedFileTypes'?: string | null;
 
     static discriminator: string | undefined = undefined;
 
@@ -27,9 +27,9 @@ export class AttachmentInfo {
             "type": "string"
         },
         {
-            "name": "allowedFileTypes",
-            "baseName": "allowedFileTypes",
-            "type": "string"
+            "name": "acceptedFileTypes",
+            "baseName": "acceptedFileTypes",
+            "type": "Array<string>"
         },
         {
             "name": "description",
@@ -37,9 +37,9 @@ export class AttachmentInfo {
             "type": "string"
         },
         {
-            "name": "acceptedFileTypes",
-            "baseName": "acceptedFileTypes",
-            "type": "Array<string>"
+            "name": "allowedFileTypes",
+            "baseName": "allowedFileTypes",
+            "type": "string"
         }    ];
 
     static getAttributeTypeMap() {

package/model/createTemplateRequest.ts

@@ -15,6 +15,7 @@ import { DocumentCC } from './documentCC';
 import { DocumentInfo } from './documentInfo';
 import { FormFieldPermission } from './formFieldPermission';
 import { FormGroup } from './formGroup';
+import { GroupSignerSettings } from './groupSignerSettings';
 import { RecipientNotificationSettings } from './recipientNotificationSettings';
 import { TemplateRole } from './templateRole';
 import { TextTagDefinition } from './textTagDefinition';
@@ -47,6 +48,7 @@ export class CreateTemplateRequest {
     'recipientNotificationSettings'?: RecipientNotificationSettings;
     'allowedSignatureTypes'?: Array<CreateTemplateRequest.AllowedSignatureTypesEnum>;
     'formFieldPermission'?: FormFieldPermission;
+    'groupSignerSettings'?: GroupSignerSettings;
 
     static discriminator: string | undefined = undefined;
 
@@ -185,6 +187,11 @@ export class CreateTemplateRequest {
             "name": "formFieldPermission",
             "baseName": "formFieldPermission",
             "type": "FormFieldPermission"
+        },
+        {
+            "name": "groupSignerSettings",
+            "baseName": "groupSignerSettings",
+            "type": "GroupSignerSettings"
         }    ];
 
     static getAttributeTypeMap() {

package/model/documentProperties.ts

@@ -20,6 +20,7 @@ import { DocumentReassign } from './documentReassign';
 import { DocumentSenderDetail } from './documentSenderDetail';
 import { DocumentSignerDetails } from './documentSignerDetails';
 import { FormGroup } from './formGroup';
+import { GroupSignerSettings } from './groupSignerSettings';
 import { RecipientNotificationSettings } from './recipientNotificationSettings';
 import { ReminderSettings } from './reminderSettings';
 
@@ -65,6 +66,7 @@ export class DocumentProperties {
     'downloadFileName'?: string | null;
     'scheduledSendTime'?: number | null;
     'allowedSignatureTypes'?: Array<DocumentProperties.AllowedSignatureTypesEnum>;
+    'groupSignerSettings'?: GroupSignerSettings;
 
     static discriminator: string | undefined = undefined;
 
@@ -273,6 +275,11 @@ export class DocumentProperties {
             "name": "allowedSignatureTypes",
             "baseName": "allowedSignatureTypes",
             "type": "Array<DocumentProperties.AllowedSignatureTypesEnum>"
+        },
+        {
+            "name": "groupSignerSettings",
+            "baseName": "groupSignerSettings",
+            "type": "GroupSignerSettings"
         }    ];
 
     static getAttributeTypeMap() {

package/model/documentSigner.ts

@@ -18,8 +18,8 @@ import { PhoneNumber } from './phoneNumber';
 import { RecipientNotificationSettings } from './recipientNotificationSettings';
 
 export class DocumentSigner {
-    'name': string;
     'id'?: string | null;
+    'name'?: string | null;
     'emailAddress'?: string | null;
     'privateMessage'?: string | null;
     'authenticationType'?: DocumentSigner.AuthenticationTypeEnum;
@@ -39,6 +39,8 @@ export class DocumentSigner {
     */
     'language'?: DocumentSigner.LanguageEnum;
     'locale'?: DocumentSigner.LocaleEnum;
+    'signType'?: DocumentSigner.SignTypeEnum;
+    'groupId'?: string | null;
     'recipientNotificationSettings'?: RecipientNotificationSettings;
     'authenticationRetryCount'?: number | null;
     'enableQes'?: boolean | null;
@@ -48,13 +50,13 @@ export class DocumentSigner {
 
     static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
         {
-            "name": "name",
-            "baseName": "name",
+            "name": "id",
+            "baseName": "id",
             "type": "string"
         },
         {
-            "name": "id",
-            "baseName": "id",
+            "name": "name",
+            "baseName": "name",
             "type": "string"
         },
         {
@@ -137,6 +139,16 @@ export class DocumentSigner {
             "baseName": "locale",
             "type": "DocumentSigner.LocaleEnum"
         },
+        {
+            "name": "signType",
+            "baseName": "signType",
+            "type": "DocumentSigner.SignTypeEnum"
+        },
+        {
+            "name": "groupId",
+            "baseName": "groupId",
+            "type": "string"
+        },
         {
             "name": "recipientNotificationSettings",
             "baseName": "recipientNotificationSettings",
@@ -228,4 +240,8 @@ export namespace DocumentSigner {
         ZhTw = <any> 'ZH_TW',
         Ko = <any> 'KO'
     }
+    export enum SignTypeEnum {
+        Single = <any> 'Single',
+        Group = <any> 'Group'
+    }
 }

package/model/documentSignerDetails.ts

@@ -12,6 +12,7 @@
 
 import { RequestFile } from './models';
 import { DocumentFormFields } from './documentFormFields';
+import { GroupSigner } from './groupSigner';
 import { IdVerificationDetails } from './idVerificationDetails';
 import { PhoneNumber } from './phoneNumber';
 import { RecipientNotificationSettings } from './recipientNotificationSettings';
@@ -42,6 +43,8 @@ export class DocumentSignerDetails {
     */
     'language'?: DocumentSignerDetails.LanguageEnum;
     'locale'?: DocumentSignerDetails.LocaleEnum;
+    'signType'?: DocumentSignerDetails.SignTypeEnum = DocumentSignerDetails.SignTypeEnum.Single;
+    'groupId'?: string | null;
     'phoneNumber'?: PhoneNumber;
     'idVerification'?: IdVerificationDetails;
     'recipientNotificationSettings'?: RecipientNotificationSettings;
@@ -49,6 +52,7 @@ export class DocumentSignerDetails {
     'enableQes'?: boolean | null;
     'deliveryMode'?: DocumentSignerDetails.DeliveryModeEnum;
     'authenticationSettings'?: SignerAuthenticationSettings;
+    'groupSigners'?: Array<GroupSigner> | null;
 
     static discriminator: string | undefined = undefined;
 
@@ -158,6 +162,16 @@ export class DocumentSignerDetails {
             "baseName": "locale",
             "type": "DocumentSignerDetails.LocaleEnum"
         },
+        {
+            "name": "signType",
+            "baseName": "signType",
+            "type": "DocumentSignerDetails.SignTypeEnum"
+        },
+        {
+            "name": "groupId",
+            "baseName": "groupId",
+            "type": "string"
+        },
         {
             "name": "phoneNumber",
             "baseName": "phoneNumber",
@@ -192,6 +206,11 @@ export class DocumentSignerDetails {
             "name": "authenticationSettings",
             "baseName": "authenticationSettings",
             "type": "SignerAuthenticationSettings"
+        },
+        {
+            "name": "groupSigners",
+            "baseName": "groupSigners",
+            "type": "Array<GroupSigner>"
         }    ];
 
     static getAttributeTypeMap() {
@@ -266,6 +285,10 @@ export namespace DocumentSignerDetails {
         ZhTw = <any> 'ZH_TW',
         Ko = <any> 'KO'
     }
+    export enum SignTypeEnum {
+        Single = <any> 'Single',
+        Group = <any> 'Group'
+    }
     export enum DeliveryModeEnum {
         Email = <any> 'Email',
         Sms = <any> 'SMS',

package/model/editTemplateRequest.ts

@@ -15,6 +15,7 @@ import { DocumentCC } from './documentCC';
 import { DocumentInfo } from './documentInfo';
 import { FormFieldPermission } from './formFieldPermission';
 import { FormGroup } from './formGroup';
+import { GroupSignerSettings } from './groupSignerSettings';
 import { RecipientNotificationSettings } from './recipientNotificationSettings';
 import { TemplateRole } from './templateRole';
 
@@ -40,6 +41,7 @@ export class EditTemplateRequest {
     'recipientNotificationSettings'?: RecipientNotificationSettings;
     'allowedSignatureTypes'?: Array<EditTemplateRequest.AllowedSignatureTypesEnum>;
     'formFieldPermission'?: FormFieldPermission;
+    'groupSignerSettings'?: GroupSignerSettings;
 
     static discriminator: string | undefined = undefined;
 
@@ -148,6 +150,11 @@ export class EditTemplateRequest {
             "name": "formFieldPermission",
             "baseName": "formFieldPermission",
             "type": "FormFieldPermission"
+        },
+        {
+            "name": "groupSignerSettings",
+            "baseName": "groupSignerSettings",
+            "type": "GroupSignerSettings"
         }    ];
 
     static getAttributeTypeMap() {

package/model/embeddedCreateTemplateRequest.ts

@@ -15,6 +15,7 @@ import { DocumentCC } from './documentCC';
 import { DocumentInfo } from './documentInfo';
 import { FormFieldPermission } from './formFieldPermission';
 import { FormGroup } from './formGroup';
+import { GroupSignerSettings } from './groupSignerSettings';
 import { RecipientNotificationSettings } from './recipientNotificationSettings';
 import { TemplateRole } from './templateRole';
 import { TextTagDefinition } from './textTagDefinition';
@@ -58,6 +59,7 @@ export class EmbeddedCreateTemplateRequest {
     'recipientNotificationSettings'?: RecipientNotificationSettings;
     'allowedSignatureTypes'?: Array<EmbeddedCreateTemplateRequest.AllowedSignatureTypesEnum>;
     'formFieldPermission'?: FormFieldPermission;
+    'groupSignerSettings'?: GroupSignerSettings;
 
     static discriminator: string | undefined = undefined;
 
@@ -251,6 +253,11 @@ export class EmbeddedCreateTemplateRequest {
             "name": "formFieldPermission",
             "baseName": "formFieldPermission",
             "type": "FormFieldPermission"
+        },
+        {
+            "name": "groupSignerSettings",
+            "baseName": "groupSignerSettings",
+            "type": "GroupSignerSettings"
         }    ];
 
     static getAttributeTypeMap() {

package/model/embeddedDocumentRequest.ts

@@ -15,6 +15,7 @@ import { DocumentCC } from './documentCC';
 import { DocumentInfo } from './documentInfo';
 import { DocumentSigner } from './documentSigner';
 import { FormGroup } from './formGroup';
+import { GroupSignerSettings } from './groupSignerSettings';
 import { RecipientNotificationSettings } from './recipientNotificationSettings';
 import { ReminderSettings } from './reminderSettings';
 import { TextTagDefinition } from './textTagDefinition';
@@ -66,6 +67,7 @@ export class EmbeddedDocumentRequest {
     'scheduledSendTime'?: number | null;
     'allowScheduledSend'?: boolean = false;
     'allowedSignatureTypes'?: Array<EmbeddedDocumentRequest.AllowedSignatureTypesEnum>;
+    'groupSignerSettings'?: GroupSignerSettings;
 
     static discriminator: string | undefined = undefined;
 
@@ -299,6 +301,11 @@ export class EmbeddedDocumentRequest {
             "name": "allowedSignatureTypes",
             "baseName": "allowedSignatureTypes",
             "type": "Array<EmbeddedDocumentRequest.AllowedSignatureTypesEnum>"
+        },
+        {
+            "name": "groupSignerSettings",
+            "baseName": "groupSignerSettings",
+            "type": "GroupSignerSettings"
         }    ];
 
     static getAttributeTypeMap() {

package/model/embeddedMergeTemplateFormRequest.ts

@@ -14,6 +14,7 @@ import { RequestFile } from './models';
 import { DocumentCC } from './documentCC';
 import { DocumentInfo } from './documentInfo';
 import { FormGroup } from './formGroup';
+import { GroupSignerSettings } from './groupSignerSettings';
 import { RecipientNotificationSettings } from './recipientNotificationSettings';
 import { ReminderSettings } from './reminderSettings';
 import { Role } from './role';
@@ -67,6 +68,7 @@ export class EmbeddedMergeTemplateFormRequest {
     'scheduledSendTime'?: number | null;
     'allowScheduledSend'?: boolean = false;
     'allowedSignatureTypes'?: Array<EmbeddedMergeTemplateFormRequest.AllowedSignatureTypesEnum>;
+    'groupSignerSettings'?: GroupSignerSettings;
 
     static discriminator: string | undefined = undefined;
 
@@ -305,6 +307,11 @@ export class EmbeddedMergeTemplateFormRequest {
             "name": "allowedSignatureTypes",
             "baseName": "allowedSignatureTypes",
             "type": "Array<EmbeddedMergeTemplateFormRequest.AllowedSignatureTypesEnum>"
+        },
+        {
+            "name": "groupSignerSettings",
+            "baseName": "groupSignerSettings",
+            "type": "GroupSignerSettings"
         }    ];
 
     static getAttributeTypeMap() {

package/model/embeddedSendTemplateFormRequest.ts

@@ -14,6 +14,7 @@ import { RequestFile } from './models';
 import { DocumentCC } from './documentCC';
 import { DocumentInfo } from './documentInfo';
 import { FormGroup } from './formGroup';
+import { GroupSignerSettings } from './groupSignerSettings';
 import { RecipientNotificationSettings } from './recipientNotificationSettings';
 import { ReminderSettings } from './reminderSettings';
 import { Role } from './role';
@@ -63,6 +64,7 @@ export class EmbeddedSendTemplateFormRequest {
     'scheduledSendTime'?: number | null;
     'allowScheduledSend'?: boolean = false;
     'allowedSignatureTypes'?: Array<EmbeddedSendTemplateFormRequest.AllowedSignatureTypesEnum>;
+    'groupSignerSettings'?: GroupSignerSettings;
 
     static discriminator: string | undefined = undefined;
 
@@ -286,6 +288,11 @@ export class EmbeddedSendTemplateFormRequest {
             "name": "allowedSignatureTypes",
             "baseName": "allowedSignatureTypes",
             "type": "Array<EmbeddedSendTemplateFormRequest.AllowedSignatureTypesEnum>"
+        },
+        {
+            "name": "groupSignerSettings",
+            "baseName": "groupSignerSettings",
+            "type": "GroupSignerSettings"
         }    ];
 
     static getAttributeTypeMap() {

package/model/embeddedTemplatePreview.ts

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

package/model/embeddedTemplatePreviewJsonRequest.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 EmbeddedTemplatePreviewJsonRequest {
+    'linkValidTill'?: Date | null;
+    'showToolbar'?: boolean;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "linkValidTill",
+            "baseName": "linkValidTill",
+            "type": "Date"
+        },
+        {
+            "name": "showToolbar",
+            "baseName": "showToolbar",
+            "type": "boolean"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return EmbeddedTemplatePreviewJsonRequest.attributeTypeMap;
+    }
+}
+

package/model/font.ts

@@ -15,9 +15,9 @@ import { RequestFile } from './models';
 export class Font {
     'name'?: Font.NameEnum;
     'color'?: string | null;
-    'size'?: number;
+    'size'?: number | null;
     'style'?: Font.StyleEnum;
-    'lineHeight'?: number;
+    'lineHeight'?: number | null;
     'isBoldFont'?: boolean;
     'isItalicFont'?: boolean;
     'isUnderLineFont'?: boolean;

package/model/groupSigner.ts

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

package/model/groupSignerSettings.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 GroupSignerSettings {
+    'enabled'?: boolean;
+    'allowedDirectories'?: Array<string> | null;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "enabled",
+            "baseName": "enabled",
+            "type": "boolean"
+        },
+        {
+            "name": "allowedDirectories",
+            "baseName": "allowedDirectories",
+            "type": "Array<string>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GroupSignerSettings.attributeTypeMap;
+    }
+}
+