boldsign 3.1.4 → 3.2.0

package/examples/documentAddTags.ts

@@ -1,19 +0,0 @@
-import { DocumentApi } from '../api/documentApi';
-import { DocumentTags } from '../model';
-
-const documentApi = new DocumentApi();
-documentApi.setApiKey("YOUR_API_KEY");
-
-var documentTags = new DocumentTags();
-documentTags.documentId = "YOUR_DOCUMENT_ID";
-documentTags.tags = ["test", "api"];
-
-async function addTagsToDocument() {
-    try {
-        await documentApi.addTag(documentTags);
-        console.log("Tags added successfully!");
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-addTagsToDocument();

package/examples/documentCancelEditing.ts

@@ -1,14 +0,0 @@
-import { DocumentApi } from '../api/documentApi';
-
-const documentApi = new DocumentApi();
-documentApi.setApiKey("API_KEY");
-
-async function cancelEditing() {
-    try {
-        await documentApi.cancelEditing("DOCUMENT_ID");
-        console.log("Document Editing canceled successfully.");
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-cancelEditing();

package/examples/documentChangeAccessCode.ts

@@ -1,20 +0,0 @@
-import { DocumentApi } from '../api/documentApi';
-import { AccessCodeDetails } from '../model';
-
-const documentApi = new DocumentApi();
-documentApi.setApiKey("YOUR_API_KEY");
-
-var accessCodeDetails = new AccessCodeDetails();
-accessCodeDetails.accessCode = "12345";
-var documentId = "YOUR_DOCUMENT_ID";
-var email = "hankyWhites@cubeflakes.com";
-
-async function changeDocumentAccessCode() {
-    try {
-        await documentApi.changeAccessCode(documentId, accessCodeDetails, email);
-        console.log("Access code changed successfully!");
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-changeDocumentAccessCode();

package/examples/documentChangeRecipients.ts

@@ -1,22 +0,0 @@
-import { DocumentApi } from '../api/documentApi';
-import { ChangeRecipient } from '../model';
-
-const documentApi = new DocumentApi();
-documentApi.setApiKey("YOUR_API_KEY");
-
-var changeRecipient = new ChangeRecipient();
-changeRecipient.newSignerName = "David";
-changeRecipient.newSignerEmail = "david@cubeflakes.com";
-changeRecipient.oldSignerEmail = "hankyWhites@cubeflakes.com";
-changeRecipient.reason = "Wrongly sent";
-var documentId = "YOUR_DOCUMENT_ID";
-
-async function changeDocumentRecipient() {
-    try {
-        await documentApi.changeRecipient(documentId, changeRecipient);
-        console.log("Recipient changed successfully!");
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-changeDocumentRecipient();

package/examples/documentCreateEmbeddedEditUrl.ts

@@ -1,19 +0,0 @@
-import { DocumentApi } from '../api/documentApi';
-import { EmbeddedDocumentEditJsonRequest } from '../model';
-
-const documentApi = new DocumentApi();
-documentApi.setApiKey("API_KEY");
-var editRequest = new EmbeddedDocumentEditJsonRequest();
-editRequest.locale = EmbeddedDocumentEditJsonRequest.LocaleEnum.En;
-editRequest.showToolbar = true;
-editRequest.redirectUrl = "https://yourapp.com/redirect";
-
-async function editDocument() {
-    try {
-        var editUrl = await documentApi.createEmbeddedEditUrl("DOCUMENT_ID",editRequest)
-        console.log("Embedded Edit URL:", editUrl);
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-editDocument();

package/examples/documentDelete.ts

@@ -1,16 +0,0 @@
-import { DocumentApi } from '../api/documentApi';
-
-const documentApi = new DocumentApi();
-documentApi.setApiKey("YOUR_API_KEY");
-
-var deletePermanently = false;
-var documentId = "YOUR_DOCUMENT_ID";
-async function deleteDocument() {
-    try {
-        await documentApi.deleteDocument(documentId, deletePermanently);
-        console.log("Document deleted successfully!");
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-deleteDocument();

package/examples/documentDeleteTags.ts

@@ -1,19 +0,0 @@
-import { DocumentApi } from '../api/documentApi';
-import { DocumentTags } from '../model';
-
-const documentApi = new DocumentApi();
-documentApi.setApiKey("YOUR_API_KEY");
-
-const documentTags = new DocumentTags();
-documentTags.documentId = "YOUR_DOCUMENT_ID";
-documentTags.tags = ["test", "api"];
-
-async function deleteTagsFromDocument() {
-    try {
-        await documentApi.deleteTag(documentTags);
-        console.log("Tags deleted successfully!");
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-deleteTagsFromDocument();

package/examples/documentDownload.ts

@@ -1,16 +0,0 @@
-import { DocumentApi } from '../api/documentApi';
-
-const documentApi = new DocumentApi();
-documentApi.setApiKey("YOUR_API_KEY");
-
-var documentId = "YOUR_DOCUMENT_ID";
-var onBehalfOf = "YOUR_BEHALF_EMAIL";
-async function downloadDocument() {
-    try {
-        await documentApi.downloadDocument(documentId, onBehalfOf);
-        console.log("Document downloaded successfully!");
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-downloadDocument();

package/examples/documentDownloadAttachment.ts

@@ -1,17 +0,0 @@
-import { DocumentApi } from '../api/documentApi';
-
-const documentApi = new DocumentApi();
-documentApi.setApiKey("YOUR_API_KEY");
-
-var documentId = "YOUR_DOCUMENT_ID";
-var attachmentId = "YOUR_ATTACHMENT_ID";
-var onBehalfOf = "YOUR_BEHALF_EMAIL";
-async function downloadAttachment() {
-    try {
-        await documentApi.downloadAttachment(documentId, attachmentId, onBehalfOf);
-        console.log("Attachment downloaded successfully!");
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-downloadAttachment();

package/examples/documentDownloadAuditTrial.ts

@@ -1,16 +0,0 @@
-import { DocumentApi } from '../api/documentApi';
-
-const documentApi = new DocumentApi();
-documentApi.setApiKey("YOUR_API_KEY");
-
-var documentId = "YOUR_DOCUMENT_ID";
-var onBehalfOf = "YOUR_BEHALF_EMAIL";
-async function downloadAuditLog() {
-    try {
-        await documentApi.downloadAuditLog(documentId, onBehalfOf);
-        console.log("Audit log downloaded successfully!");
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-downloadAuditLog();

package/examples/documentEdit.ts

@@ -1,43 +0,0 @@
-import * as fs from 'fs';
-import { DocumentApi, EditDocumentFile, EditDocumentRequest, EditDocumentSigner, EditFormField, Rectangle } from '../api';
-
-const documentApi = new DocumentApi();
-documentApi.setApiKey("API_KEY");
-
-const bounds = new Rectangle();
-bounds.x = 100;
-bounds.y = 50;
-bounds.width = 100;
-bounds.height = 100;
-
-const formField = new EditFormField();
-formField.fieldType = EditFormField.FieldTypeEnum.Signature;
-formField.pageNumber = 1;
-formField.editAction = EditFormField.EditActionEnum.Add;
-formField.bounds = bounds;
-var signers = new EditDocumentSigner();
-signers.editAction = EditDocumentSigner.EditActionEnum.Add,
-signers.emailAddress = "signer1@gamil.com",
-signers.name = "signer1",
-signers.signerRole = "Signer";
-signers.formFields = [formField];
-
-var documentfile = new EditDocumentFile();
-documentfile.file = fs.createReadStream("examples/documents/agreement.pdf");
-documentfile.editAction = EditDocumentFile.EditActionEnum.Add;
-var editDocumentRequest = new EditDocumentRequest();
-editDocumentRequest.message = "Please review and sign the attached document.";
-editDocumentRequest.signers = [signers];
-editDocumentRequest.files = [documentfile]
-var documentId = "DOCUMENT_ID" ;
-
-async function editDocument() {
-    try {
-        debugger
-        var editDocumentResponse = await documentApi.editDocument(documentId, editDocumentRequest);
-        console.log("Document edited successfully!", editDocumentResponse);
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-editDocument();

package/examples/documentEmbeddedRequestLink.ts

@@ -1,49 +0,0 @@
-import { DocumentApi } from '../api/documentApi';
-import { DocumentSigner, EmbeddedDocumentRequest, FormField, Rectangle } from '../model';
-import * as fs from 'fs';
-import * as path from 'path';
-
-const documentApi = new DocumentApi();
-documentApi.setApiKey("YOUR_API_KEY");
-const formField = new FormField();
-formField.fieldType = FormField.FieldTypeEnum.Signature;
-formField.pageNumber = 1;
-const bounds = new Rectangle();
-bounds.x = 100;
-bounds.y = 50;
-bounds.width = 100;
-bounds.height = 100;
-formField.bounds = bounds;
-const documentSigner = new DocumentSigner();
-documentSigner.name = "David";
-documentSigner.emailAddress = "david@cubeflakes.com";
-documentSigner.signerOrder = 1;
-documentSigner.signerType = DocumentSigner.SignerTypeEnum.Signer;
-documentSigner.privateMessage = "This is private message for signer";
-documentSigner.formFields = [formField];
-const embeddedDocumentRequest = new EmbeddedDocumentRequest();
-embeddedDocumentRequest.title = "Sent from API Node SDK";
-embeddedDocumentRequest.showToolbar = true;
-embeddedDocumentRequest.showNavigationButtons = true;
-embeddedDocumentRequest.showPreviewButton = true;
-embeddedDocumentRequest.showSendButton = true;
-embeddedDocumentRequest.showSaveButton = true;
-embeddedDocumentRequest.sendViewOption = EmbeddedDocumentRequest.SendViewOptionEnum.FillingPage;
-embeddedDocumentRequest.locale = EmbeddedDocumentRequest.LocaleEnum.En;
-embeddedDocumentRequest.showTooltip = false;
-embeddedDocumentRequest.redirectUrl = "https://boldsign.dev/";
-embeddedDocumentRequest.message = "This is document message sent from API Node SDK";
-embeddedDocumentRequest.enableSigningOrder = false;
-embeddedDocumentRequest.signers = [documentSigner];
-const filePath = path.resolve("YOUR_FILE_PATH");
-const files = fs.createReadStream(filePath);
-embeddedDocumentRequest.files = [files];
-async function createEmbeddedRequestUrlDocument() {
-    try {
-        const requestLinkResponse = await documentApi.createEmbeddedRequestUrlDocument(embeddedDocumentRequest);
-        console.log('Embedded Document URL:', requestLinkResponse.sendUrl);
-    } catch (error:any) {
-        console.error("Error occurred while calling the API for embedded template:", error.message);
-    }
-}
-createEmbeddedRequestUrlDocument();

package/examples/documentEmbeddedSignLink.ts

@@ -1,23 +0,0 @@
-import { DocumentApi } from '../api/documentApi';
-
-const documentApi = new DocumentApi();
-documentApi.setApiKey("YOUR_API_KEY");
-
-var documentId = "YOUR_DOCUMENT_ID";
-var signerEmail = "david@cubeflakes.com";
-var countryCode = "+91";
-var phoneNumber = "6381261236";
-var dateType: string = "2025-01-22";
-var date: Date = new Date(dateType);
-var signLinkValidTill = date;
-var redirectUrl = "https://www.syncfusion.com/";
-
-async function getEmbeddedSignLink() {
-    try {
-        var embeddedSignLinkResponse = await documentApi.getEmbeddedSignLink(documentId, signerEmail, countryCode, phoneNumber, signLinkValidTill, redirectUrl);
-        console.log("Embedded Sign Link created successfully:", embeddedSignLinkResponse);
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-getEmbeddedSignLink();

package/examples/documentExtendExpiry.ts

@@ -1,20 +0,0 @@
-import { DocumentApi } from '../api/documentApi';
-import { ExtendExpiry } from '../model';
-
-const documentApi = new DocumentApi();
-documentApi.setApiKey("YOUR_API_KEY");
-
-const extendExpiry = new ExtendExpiry();
-extendExpiry.newExpiryValue = "2025-03-18";
-extendExpiry.warnPrior = true;
-var documentId = "YOUR_DOCUMENT_ID";
-
-async function extendDocumentExpiry() {
-    try {
-        await documentApi.extendExpiry(documentId, extendExpiry);
-        console.log("Expiry extended successfully!");
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-extendDocumentExpiry();

package/examples/documentList.ts

@@ -1,19 +0,0 @@
-import { DocumentApi } from '../api/documentApi';
-
-const documentApi = new DocumentApi();
-documentApi.setApiKey("YOUR_API_KEY");
-
-var page = 1
-const status: Array<
-  'None' | 'WaitingForMe' | 'WaitingForOthers' | 'NeedAttention' |
-  'Completed' | 'Declined' | 'Revoked' | 'Expired' | 'Draft' | 'Scheduled'
-> = ['WaitingForOthers', 'Completed', 'Expired'];
-async function listDocuments() {
-    try {
-        var listDocumentResponse = await documentApi.listDocuments(page,undefined,undefined,undefined,undefined,10,undefined,status);
-        console.log("Documents listed successfully:", listDocumentResponse);
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-listDocuments();

package/examples/documentListBehalf.ts

@@ -1,15 +0,0 @@
-import { DocumentApi } from '../api/documentApi';
-
-const documentApi = new DocumentApi();
-documentApi.setApiKey("YOUR_API_KEY");
-
-var page = 1;
-async function getBehalfDocuments() {
-    try {
-        var behalfDocumentResponse = await documentApi.behalfDocuments(page);
-        console.log("Behalf Documents fetched successfully:", behalfDocumentResponse);
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-getBehalfDocuments();

package/examples/documentListTeam.ts

@@ -1,15 +0,0 @@
-import { DocumentApi } from '../api/documentApi';
-
-const documentApi = new DocumentApi();
-documentApi.setApiKey("YOUR_API_KEY");
-
-var page = 1;
-async function getTeamDocuments() {
-    try {
-        var teamDocumentResponse = await documentApi.teamDocuments(page);
-        console.log("Team Documents fetched successfully:", teamDocumentResponse);
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-getTeamDocuments();

package/examples/documentPrefillFieldCheckBox.ts

@@ -1,23 +0,0 @@
-import { DocumentApi } from '../api/documentApi';
-import { PrefillField, PrefillFieldRequest } from '../model';
-
-const documentApi = new DocumentApi();
-documentApi.setApiKey("YOUR_API_KEY");
-
-var prefillField = new PrefillField();
-prefillField.id = "CheckBox1";
-prefillField.value = "Prefill value";
-
-var prefillFieldRequest = new PrefillFieldRequest();
-prefillFieldRequest.fields = [prefillField];
-var documentId = "YOUR_DOCUMENT_ID";
-
-async function prefillDocumentFields() {
-    try {
-        await documentApi.prefillFields(documentId, prefillFieldRequest);
-        console.log("Fields have been prefilled successfully!");
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-prefillDocumentFields();

package/examples/documentPrefillFieldDropDown.ts

@@ -1,23 +0,0 @@
-import { DocumentApi } from '../api/documentApi';
-import { PrefillField, PrefillFieldRequest } from '../model';
-
-const documentApi = new DocumentApi();
-documentApi.setApiKey("YOUR_API_KEY");
-
-const prefillField = new PrefillField();
-prefillField.id = "Dropdown1";
-prefillField.value = "Prefill value";
-
-const prefillFieldRequest = new PrefillFieldRequest();
-prefillFieldRequest.fields = [prefillField];
-var documentId = "YOUR_DOCUMENT_ID";
-
-async function prefillDocumentFields() {
-    try {
-        await documentApi.prefillFields(documentId, prefillFieldRequest);
-        console.log("Fields have been prefilled successfully!");
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-prefillDocumentFields();

package/examples/documentPrefillFieldEditableDate.ts

@@ -1,23 +0,0 @@
-import { DocumentApi } from '../api/documentApi';
-import { PrefillField, PrefillFieldRequest } from '../model';
-
-const documentApi = new DocumentApi();
-documentApi.setApiKey("YOUR_API_KEY");
-
-const prefillField = new PrefillField();
-prefillField.id = "EditableDate1";
-prefillField.value = "Prefill value";
-
-const prefillFieldRequest = new PrefillFieldRequest();
-prefillFieldRequest.fields = [prefillField];
-var documentId = "YOUR_DOCUMENT_ID";
-
-async function prefillDocumentFields() {
-    try {
-        await documentApi.prefillFields(documentId, prefillFieldRequest);
-        console.log("Fields have been prefilled successfully!");
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-prefillDocumentFields();

package/examples/documentPrefillFieldImage.ts

@@ -1,23 +0,0 @@
-import { DocumentApi } from '../api/documentApi';
-import { PrefillField, PrefillFieldRequest } from '../model';
-
-const documentApi = new DocumentApi();
-documentApi.setApiKey("YOUR_API_KEY");
-
-const prefillField = new PrefillField();
-prefillField.id = "Image1";
-prefillField.value = "Prefill value";
-
-const prefillFieldRequest = new PrefillFieldRequest();
-prefillFieldRequest.fields = [prefillField];
-var documentId = "YOUR_DOCUMENT_ID";
-
-async function prefillDocumentFields() {
-    try {
-        await documentApi.prefillFields(documentId, prefillFieldRequest);
-        console.log("Fields have been prefilled successfully!");
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-prefillDocumentFields();

package/examples/documentPrefillFieldRadioButton.ts

@@ -1,23 +0,0 @@
-import { DocumentApi } from '../api/documentApi';
-import { PrefillField, PrefillFieldRequest } from '../model';
-
-const documentApi = new DocumentApi();
-documentApi.setApiKey("YOUR_API_KEY");
-
-const prefillField = new PrefillField();
-prefillField.id = "radioChild_97gYJ";
-prefillField.value = "Prefill value";
-
-const prefillFieldRequest = new PrefillFieldRequest();
-prefillFieldRequest.fields = [prefillField];
-var documentId = "YOUR_DOCUMENT_ID";
-
-async function prefillDocumentFields() {
-    try {
-        await documentApi.prefillFields(documentId, prefillFieldRequest);
-        console.log("Fields have been prefilled successfully!");
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-prefillDocumentFields();

package/examples/documentPrefillFieldTextBox.ts

@@ -1,23 +0,0 @@
-import { DocumentApi } from '../api/documentApi';
-import { PrefillField, PrefillFieldRequest } from '../model';
-
-const documentApi = new DocumentApi();
-documentApi.setApiKey("YOUR_API_KEY");
-
-const prefillField = new PrefillField();
-prefillField.id = "TextBox1";
-prefillField.value = "Prefill value";
-
-const prefillFieldRequest = new PrefillFieldRequest();
-prefillFieldRequest.fields = [prefillField];
-var documentId = "YOUR_DOCUMENT_ID";
-
-async function prefillDocumentFields() {
-    try {
-        await documentApi.prefillFields(documentId, prefillFieldRequest);
-        console.log("Fields have been prefilled successfully!");
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-prefillDocumentFields();

package/examples/documentRemoveAuthentication.ts

@@ -1,19 +0,0 @@
-import { DocumentApi } from '../api/documentApi';
-import { RemoveAuthentication } from '../model';
-
-const documentApi = new DocumentApi();
-documentApi.setApiKey("YOUR_API_KEY");
-
-var removeAuthentication = new RemoveAuthentication();
-removeAuthentication.emailId = "david@cubeflakes.com";
-var documentId = "YOUR_DOCUMENT_ID";
-
-async function removeAuthenticationFromDocument() {
-    try {
-        await documentApi.removeAuthentication(documentId, removeAuthentication);
-        console.log("Authentication removed successfully!");
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-removeAuthenticationFromDocument();

package/examples/documentRevoke.ts

@@ -1,19 +0,0 @@
-import { DocumentApi } from '../api/documentApi';
-import { RevokeDocument } from '../model';
-
-const documentApi = new DocumentApi();
-documentApi.setApiKey("YOUR_API_KEY");
-
-var revokeDocumentRequest = new RevokeDocument();
-revokeDocumentRequest.message = "This is document revoke message";
-var documentId = "YOUR_DOCUMENT_ID";
-
-async function revokeDocument() {
-    try {
-        await documentApi.revokeDocument(documentId, revokeDocumentRequest);
-        console.log("Document revoked successfully!");
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-revokeDocument();

package/examples/documentSend.ts

@@ -1,51 +0,0 @@
-import { DocumentApi } from '../api/documentApi';
-import { DocumentSigner, FormField, Rectangle, RequestDetailedFile, SendForSign } from '../model';
-import * as fs from 'fs'; 
-
-const documentApi = new DocumentApi();
-documentApi.setApiKey("YOUR_API_KEY");
-
-const bounds = new Rectangle();
-bounds.x = 100;
-bounds.y = 50;
-bounds.width = 100;
-bounds.height = 100;
-
-var formField = new FormField();
-formField.fieldType = FormField.FieldTypeEnum.Signature;
-formField.pageNumber = 1;
-formField.bounds = bounds;
-
-var documentSigner = new DocumentSigner();
-documentSigner.name = "SR";
-documentSigner.emailAddress = "selvarani.s+stg1@syncfusion.com";
-documentSigner.signerType = DocumentSigner.SignerTypeEnum.Signer;
-documentSigner.formFields = [formField];
-
-var documentSigner1 = new DocumentSigner();
-documentSigner1.name = "SR1";
-documentSigner1.emailAddress = "selvarani.s+stg11@syncfusion.com";
-documentSigner1.signerType = DocumentSigner.SignerTypeEnum.Signer;
-documentSigner1.formFields = [formField];
-
-
-var sendForSign = new SendForSign();
-sendForSign.title = "Agreement";
-sendForSign.signers = [documentSigner, documentSigner1];
-var files = fs.createReadStream("examples/documents/agreement.pdf");
-sendForSign.files = [files];
-sendForSign.metaData = {
-    'DocumentType': 'new',
-    'DocumentCategory': 'Software'
-}
-
-async function sendDocument() {
-    try {
-        var sendDocumentResponse = await documentApi.sendDocument(sendForSign);
-        console.log("Document sent successfully:", sendDocumentResponse.documentId);
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-
-sendDocument();