boldsign 3.1.4 → 3.2.0

package/examples/templateEmbeddedRequestLink.ts

@@ -1,34 +0,0 @@
-import { TemplateApi } from '../api/templateApi';
-import { EmbeddedCreateTemplateRequest, EmbeddedSendTemplateFormRequest, Role} from '../model';
-import * as fs from 'fs'; 
-
-const templateApi = new TemplateApi();
-templateApi.setApiKey("YOUR_API_KEY");
-
-var role = new Role();
-role.roleIndex = 1;
-role.signerName = "Manager";
-
-var embeddedSendTemplateFormRequest = new EmbeddedSendTemplateFormRequest();
-embeddedSendTemplateFormRequest.title = "Api template";
-embeddedSendTemplateFormRequest.roles = [role];
-embeddedSendTemplateFormRequest.showToolbar = true;
-embeddedSendTemplateFormRequest.showNavigationButtons = true;
-embeddedSendTemplateFormRequest.showPreviewButton = true;
-embeddedSendTemplateFormRequest.showSaveButton = true;
-embeddedSendTemplateFormRequest.locale = EmbeddedCreateTemplateRequest.LocaleEnum.En;
-embeddedSendTemplateFormRequest.showTooltip = false;
-embeddedSendTemplateFormRequest.sendViewOption = EmbeddedSendTemplateFormRequest.SendViewOptionEnum.FillingPage;
-var files = fs.createReadStream("YOUR_FILE_PATH");
-embeddedSendTemplateFormRequest.files = [files];
-var templateId = "YOUR_TEMPLATE_ID";
-
-async function createEmbeddedTemplateRequestUrl() {
-    try {
-        var embeddedTemplateUrlResponse = await templateApi.createEmbeddedRequestUrlTemplate(templateId, embeddedSendTemplateFormRequest);
-        console.log("Embedded Template URL:", embeddedTemplateUrlResponse);
-    } catch (error:any) {
-        console.error('Error occurred while calling the API:', error.message);
-    }
-}
-createEmbeddedTemplateRequestUrl();

package/examples/templateMergerEmbeddedRequestUrl.ts

@@ -1,37 +0,0 @@
-import { TemplateApi } from '../api/templateApi';
-import { EmbeddedCreateTemplateRequest, EmbeddedMergeTemplateFormRequest, EmbeddedSendTemplateFormRequest, Role} from '../model';
-import * as fs from 'fs'; 
-
-const templateApi = new TemplateApi();
-templateApi.setApiKey("YOUR_API_KEY");
-
-var role1 = new Role();
-role1.signerEmail = "sivaramani.sivaraj@syncfusion.com";
-role1.signerName = "Sivaramani";
-role1.roleIndex = 1;
-role1.signerType = Role.SignerTypeEnum.Signer;
-role1.signerRole = "Manager";
-
-var role2 = new Role();
-role2.signerEmail = "john@gmail.com";
-role2.signerName = "John";
-role2.roleIndex = 2;
-role2.signerType = Role.SignerTypeEnum.Signer;
-role2.signerRole = "Employee";
-var file = fs.createReadStream("examples/documents/agreement.pdf")
-var embeddedMergeTemplateUrl = new EmbeddedMergeTemplateFormRequest();
-embeddedMergeTemplateUrl.files = [file];
-embeddedMergeTemplateUrl.title = "Template Request URL"
-embeddedMergeTemplateUrl.roles= [role1,role2];
-embeddedMergeTemplateUrl.templateIds = ["YOUR_TEMPLATE_ID1","YOUR_TEMPLATE_ID2"];
-
-
-async function mergeEmbeddedTemplateRequestUrl() {
-    try {
-        var mergeTemplateUrl = await templateApi.mergeCreateEmbeddedRequestUrlTemplate(embeddedMergeTemplateUrl);
-        console.log("Merge Embedded Template URL:", mergeTemplateUrl);
-    } catch (error:any) {
-        console.error('Error occurred while calling the API:', error.message);
-    }
-}
-mergeEmbeddedTemplateRequestUrl();

package/examples/templateSendDocument.ts

@@ -1,60 +0,0 @@
-import { TemplateApi } from '../api/templateApi';
-import { FormField, Rectangle, ReminderSettings, Role, SendForSignFromTemplateForm } from '../model';
-import * as fs from 'fs'; 
-
-const templateApi = new TemplateApi();
-templateApi.setApiKey("YOUR_API_KEY");
-
-var 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;
-
-var role = new Role();
-role.roleIndex = 50;
-role.signerName = "Richard";
-role.signerEmail = "richard@cubeflakes.com";
-role.signerOrder = 1;
-role.enableEmailOTP = false;
-role.signerType =  Role.SignerTypeEnum.Signer;
-role.signerRole = "Manager";
-role.privateMessage = "Please check and sign the document";
-role.formFields = [formField];
-
-var templateId = "YOUR_TEMPLATE_ID";
-
-var sendForSignFromTemplate = new SendForSignFromTemplateForm();
-var files = fs.createReadStream("YOUR_FILE_PATH");
-sendForSignFromTemplate.files = [files];
-sendForSignFromTemplate.title = "Invitation form";
-sendForSignFromTemplate.message = "Kindly review and sign this.";
-sendForSignFromTemplate.roles = [role];
-sendForSignFromTemplate.disableEmails = false;
-sendForSignFromTemplate.disableSMS = false;
-sendForSignFromTemplate.hideDocumentId = true;
-sendForSignFromTemplate.labels = ["Invitation", "Form", "Test"];
-var reminderSettings = new ReminderSettings();
-reminderSettings.reminderDays = 3;
-reminderSettings.reminderCount = 5;
-reminderSettings.enableAutoReminder = false;
-sendForSignFromTemplate.reminderSettings = reminderSettings;
-sendForSignFromTemplate.expiryValue = 60;
-sendForSignFromTemplate.disableExpiryAlert = true;
-sendForSignFromTemplate.enablePrintAndSign = true;
-sendForSignFromTemplate.enableReassign = true;
-sendForSignFromTemplate.enableSigningOrder = true;
-
-async function sendDocumentFromTemplate() {
-    try {
-        var sendDocumentTemplateResponse = await templateApi.sendUsingTemplate(templateId, sendForSignFromTemplate);
-        console.log("Document sent for signing using template successfully:", sendDocumentTemplateResponse);
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-sendDocumentFromTemplate();

package/examples/templateSendDocumentUsingMultipleTemplate.ts

@@ -1,40 +0,0 @@
-import { TemplateApi } from '../api/templateApi';
-import { FormField, MergeAndSendForSignForm, Rectangle, Role } from '../model';
-
-const templateApi = new TemplateApi();
-templateApi.setApiKey("YOUR_API_KEY");
-
-var 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;
-
-var role = new Role();
-role.roleIndex = 50;
-role.signerName = "Richard";
-role.signerEmail = "richard@cubeflakes.com";
-role.signerOrder = 1;
-role.signerType =  Role.SignerTypeEnum.Signer;
-role.signerRole = "Manager";
-role.formFields = [formField];
-
-var mergeAndSendForsign = new MergeAndSendForSignForm();
-mergeAndSendForsign.title = "Invitation form";
-mergeAndSendForsign.message = "Kindly review and sign this.";
-mergeAndSendForsign.roles = [role];
-mergeAndSendForsign.templateIds =  ["YOUR_TEMPLATE_ID", "YOUR_TEMPLATE_ID"];
-
-async function sendDocumentUsingMultipleTemplates() {
-    try {
-        var multipleTemplateResponse = await templateApi.mergeAndSend(mergeAndSendForsign);
-        console.log("Document sent for signing using multiple templates successfully", multipleTemplateResponse);
-    } catch (error:any) {
-        console.error('Error occurred while calling the API:', error.message);
-    }
-}
-sendDocumentUsingMultipleTemplates();

package/examples/userChangeTeam.ts

@@ -1,15 +0,0 @@
-import { UserApi } from '../api/userApi';
-import { ChangeTeamRequest } from '../model';
-const userApi = new UserApi();
-userApi.setApiKey("YOUR_API_KEY");
-var changeTeam = new ChangeTeamRequest();
-changeTeam.toTeamId = "TEAM_ID";
-async function UserChangeteam() {
-    try {
-        await userApi.changeTeam("USER_ID",changeTeam);
-        console.log("user changed the team");
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-UserChangeteam();

package/examples/userCreate.ts

@@ -1,20 +0,0 @@
-import { UserApi } from '../api/userApi';
-import { CreateUser } from '../model';
-
-const userApi = new UserApi();
-userApi.setApiKey("YOUR_API_KEY");
-
-var createUserRequest = new CreateUser();
-createUserRequest.teamId = "YOUR_TEAM_ID";
-createUserRequest.emailId = "luthercooper@cubeflakes.com";
-createUserRequest.userRole = CreateUser.UserRoleEnum.Member;
-
-async function createUser() {
-    try {
-        var createUserResponse = await userApi.createUser([createUserRequest]); 
-        console.log("User created successfully:", createUserResponse);
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-createUser();

package/examples/userGet.ts

@@ -1,15 +0,0 @@
-import { UserApi } from '../api/userApi';
-
-const userApi = new UserApi();
-userApi.setApiKey("YOUR_API_KEY");
-
-var userId = "YOUR_USER_ID";
-async function getUserDetails() {
-    try {
-        var userDetailsResponse = await userApi.getUser(userId);
-        console.log("User Details:", userDetailsResponse);
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-getUserDetails();

package/examples/userInvitationCancel.ts

@@ -1,15 +0,0 @@
-import { UserApi } from '../api/userApi';
-
-const userApi = new UserApi();
-userApi.setApiKey("YOUR_API_KEY");
-
-var userId = "YOUR_USER_ID";
-async function cancelUserInvitation() {
-    try {
-        await userApi.cancelInvitation(userId);
-        console.log("Invitation canceled successfully!");
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-cancelUserInvitation();

package/examples/userList.ts

@@ -1,16 +0,0 @@
-import { UserApi } from '../api/userApi';
-
-const userApi = new UserApi();
-userApi.setApiKey("YOUR_API_KEY");
-
-var page = 1;
-var pageSize = 10;
-async function listUsers() {
-    try {
-        var userListResponse = await userApi.listUsers(page, pageSize);
-        console.log("User List:", userListResponse);
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-listUsers();

package/examples/userResendInvitation.ts

@@ -1,15 +0,0 @@
-import { UserApi } from '../api/userApi';
-
-const userApi = new UserApi();
-userApi.setApiKey("YOUR_API_KEY");
-
-var userId = "YOUR_USER_ID";
-async function resendUserInvitation() {
-    try {
-        await userApi.resendInvitation(userId);
-        console.log("Invitation resent successfully!");
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-resendUserInvitation();

package/examples/userUpdateRole.ts

@@ -1,19 +0,0 @@
-import { UserApi } from '../api/userApi';
-import { UpdateUser } from '../model';
-
-const userApi = new UserApi();
-userApi.setApiKey("YOUR_API_KEY");
-
-var updateUserRequest = new UpdateUser();
-updateUserRequest.userId = "YOUR_USER_ID";
-updateUserRequest.userRole = UpdateUser.UserRoleEnum.TeamAdmin;
-
-async function updateUser() {
-    try {
-        await userApi.updateUser(updateUserRequest);  
-        console.log("Userrole updated successfully!");
-    } catch (error:any) {
-        console.error("Error occurred while calling the API:", error.message);
-    }
-}
-updateUser();

package/tests/config.ts

@@ -1,20 +0,0 @@
-import * as dotenv from 'dotenv';
-
-dotenv.config();
-
-const config = {
-    apiKey: process.env.API_KEY,
-    baseUrl: process.env.HOST_URL
-};
-export default config;
-
-// How to section to add an API key and Base url in environmental variables
-//     1. Generate an API key through your Bold Sign account.
-//     2. Select the search bar on the taskbar and search for 'Edit environmental variables for your account'.
-//     3. Add the API key and URL to 'API_KEY' and 'HOST_URL' respectively.
-//     4. Once the API key and URL are added, restart your application and then run the test cases.
-
-// If you use your own API key in environmental variables kindly follow theses steps:
-//     1. Activate SMS option while sending document to SMS OTP
-//     2. Approved sender identity person for while sending on behalf document use the approve mail id in approved onbehalf email 
-//     3. While executing testcases mostly use Enterprise API plan and Live API key.

package/tests/integration/BrandingApiTest.spec.ts

@@ -1,254 +0,0 @@
-import { BrandingApi } from '../../api/brandingApi';
-import config from '../config';
-import * as fs from 'fs';
-
-describe('Test suite', () => {
-  let brandingApi;
-  let brandId;
-  beforeAll(() => {
-    brandId = null;
-    const apiKey = config.apiKey;
-    const baseUrl = config.baseUrl;
-    if (!baseUrl || !apiKey) {
-      throw new Error("Environment variables 'HOST_URL' or 'API_KEY' are not set");
-    }
-    brandingApi = new BrandingApi(baseUrl);
-    brandingApi.setApiKey(apiKey);
-  });
-  test('Test1:should create a brand successfully', async () => {
-    const brandName = "NodeSDK";
-    const brandLogo = fs.createReadStream("tests/documents/logo.jpg");
-    const backgroundColor = "Blue";
-    const buttonColor = "Black";
-    const buttonTextColor = "White";
-    const emailDisplayName = "{SenderName} from Syncfusion";
-    try {
-      const createBrandApiResponse = await brandingApi.createBrand(brandName, brandLogo, backgroundColor, buttonColor, buttonTextColor, emailDisplayName);
-      console.log("Brand created successfully:", createBrandApiResponse.brandId);
-      brandId = createBrandApiResponse.brandId;
-      expect(brandId).toBeDefined();
-      expect(brandId).toBeGreaterThan(0);
-    } catch (error:any) {
-      console.log("Error occurred while creating the brand:", error.message);
-    }
-  }, 20000);
-  test('Test2:should create a brand only with required fields', async () => {
-    const brandName = "NodeSDK";
-    const brandLogo = fs.createReadStream("tests/documents/logo.jpg");
-    try {
-      const createBrandApiResponse = await brandingApi.createBrand(brandName, brandLogo);
-      console.log("Brand created successfully:", createBrandApiResponse.brandId);
-      expect(createBrandApiResponse).toBeDefined();
-    } catch (error) {
-      console.log("Error occurred while creating the brand:", error);
-      expect(error).toBeUndefined();
-    }
-  }, 20000);
-  test('Test3:should fail to create a brand without brand name', async () => {
-    const brandName = "";
-    const brandLogo = fs.createReadStream("tests/documents/logo.jpg");
-    const backgroundColor = "Blue";
-    const buttonColor = "Black";
-    const buttonTextColor = "White";
-    const emailDisplayName = "{SenderName} from Syncfusion";
-    try {
-      await brandingApi.createBrand(brandName, brandLogo, backgroundColor, buttonColor, buttonTextColor, emailDisplayName);
-      throw new Error("API call should have failed");
-    } catch (error:any) {
-      console.error("Error occurred while creating the brand:", error.message);
-      expect(error.message).toBeDefined();
-    }
-  }, 20000);
-  test('Test4:should fail to create a brand with invalid background color', async () => {
-    const brandName = "Node SDK";
-    const brandLogo = fs.createReadStream("tests/documents/logo.jpg");
-    const backgroundColor = "invalid-color";
-    const buttonColor = "Black";
-    const buttonTextColor = "White";
-    const emailDisplayName = "{SenderName} from Syncfusion";
-    try {
-      await brandingApi.createBrand(brandName,brandLogo,backgroundColor,buttonColor,buttonTextColor,emailDisplayName);
-      throw new Error("API call should have failed due to invalid background color");
-    } catch (error: any) {
-      console.error("Expected error for invalid background color:", error);
-      expect(error.response).toBeDefined();
-      expect(error.response?.status).toBe(400);
-      expect(error.response.statusText).toBe("Bad Request");
-    }
-  }, 20000);
-  test('Test5:should fail to create a brand with invalid button color', async () => {
-    const brandName = "Node SDK";
-    const brandLogo = fs.createReadStream("tests/documents/logo.jpg");
-    const backgroundColor = "Blue";
-    const buttonColor = "not-a-color";
-    const buttonTextColor = "White";
-    const emailDisplayName = "{SenderName} from Syncfusion";
-    try {
-      await brandingApi.createBrand(
-        brandName,
-        brandLogo,
-        backgroundColor,
-        buttonColor,
-        buttonTextColor,
-        emailDisplayName
-      );
-      throw new Error("API call should have failed due to invalid button color");
-    } catch (error: any) {
-      console.error("Expected error for invalid button color:", error);
-      expect(error.response).toBeDefined();
-      expect(error.response?.status).toBe(400);
-      expect(error.response.statusText).toBe("Bad Request");
-    }
-  }, 20000);
-  test('Test6:should fail to create a brand with invalid button text color', async () => {
-    const brandName = "Node SDK";
-    const brandLogo = fs.createReadStream("tests/documents/logo.jpg");
-    const backgroundColor = "Blue";
-    const buttonColor = "Black";
-    const buttonTextColor = "invalid-text-color";
-    const emailDisplayName = "{SenderName} from Syncfusion";
-    try {
-      await brandingApi.createBrand(
-        brandName,
-        brandLogo,
-        backgroundColor,
-        buttonColor,
-        buttonTextColor,
-        emailDisplayName
-      );
-      throw new Error("API call should have failed due to invalid button text color");
-    } catch (error: any) {
-      console.error("Expected error for invalid button text color:", error);
-      expect(error.response).toBeDefined();
-      expect(error.response?.status).toBe(400);
-      expect(error.response.statusText).toBe("Bad Request");
-    }
-  }, 20000);
-  test('Test7:should fail to create a brand with invalid logo path', async () => {
-    const brandName = "Node SDK";
-    const brandLogo = fs.createReadStream("tests/documents/agreement.pdf");
-    try {
-      await brandingApi.createBrand(brandName,brandLogo);
-      throw new Error("API call should have failed due to invalid button text color");
-    } catch (error: any) {
-      console.error("Expected error for invalid button text color:", error);
-      expect(error.response).toBeDefined();
-      expect(error.response?.status).toBe(400);
-      expect(error.response.statusText).toBe("Bad Request");
-    }
-  }, 20000);
-  test('Test8:should update a brand successfully', async () => {
-    const brandName = "Node-SDK-Test";
-    const brandLogo = fs.createReadStream("tests/documents/logo.jpg");
-    const backgroundColor = "Blue";
-    const buttonColor = "Black";
-    const buttonTextColor = "White";
-    const emailDisplayName = "divya.boopathy+12@syncfusion.com";
-    try {
-      const updateBrandApiResponse = await brandingApi.editBrand(brandId, brandName, brandLogo, backgroundColor, buttonColor, buttonTextColor, emailDisplayName);
-      console.log("Brand updated successfully:", updateBrandApiResponse.brandId);
-      expect(updateBrandApiResponse).toBeDefined();
-    } catch (error:any) {
-      console.error("Error occurred while updating the brand:", error.message);
-      throw new Error("API call failed");
-    }
-  }, 20000);
-  test('Test9: should fail to update a brand with invalid logo path', async () => {
-    const brandName = "Node-SDK-Test";
-    try {
-      const brandLogo = fs.createReadStream("tests/documents/agreement.pdf");
-      await brandingApi.editBrand(brandId,brandName,brandLogo);
-    } catch (error:any) {
-      console.error("Expected error while updating with invalid logo path:");
-      expect(error.response).toBeDefined();
-      expect(error.response?.status).toBe(400);
-      expect(error.response.statusText).toBe("Bad Request");
-    }
-  }, 20000);
-  test('Test10: should fail to update a brand with invalid brand ID', async () => {
-    const brandName = "Node-SDK-Test";
-    try {
-      const invalidBrandId = "invalid-brand-id";
-      const brandLogo = fs.createReadStream("tests/documents/logo.jpg");
-      await brandingApi.editBrand(invalidBrandId,brandName,brandLogo);
-      throw new Error("API call should have failed due to invalid brand ID");
-    } catch (error: any) {
-      console.error("Expected error while updating with invalid brand ID:", error.message);
-      expect(error.response).toBeDefined();
-      expect(error.response?.status).toBe(400);
-      expect(error.response.statusText).toBe("Bad Request");
-    }
-  }, 20000);
-  test('Test11:should get brand details successfully', async () => {
-    try {
-      const brandDetailsResponse = await brandingApi.getBrand(brandId);
-      console.log("Brand details retrieved successfully:", brandDetailsResponse);
-      expect(brandDetailsResponse).toBeDefined();
-      expect(brandDetailsResponse.id).toBe(brandId);
-    } catch (error:any) {
-      console.log("Error occurred while calling the API:", error.message);
-    }
-  }, 20000);
-  test('Test12:should fail to retrieve brand details with non-existent brand ID', async () => {
-    const brandId = "INVALID_BRAND_ID";
-    try {
-      const brandDetailsResponse = await brandingApi.getBrand(brandId);
-      console.log("Brand details retrieved successfully:", brandDetailsResponse);
-      expect(brandDetailsResponse).toBeUndefined();
-    } catch (error:any) {
-      console.error("Error occurred while calling the API:", error.message);
-      expect(error.message).toBeDefined();
-    }
-  }, 20000);
-  test('Test13:should retrieve the brand list successfully', async () => {
-    try {
-      const brandListResponse = await brandingApi.brandList();
-      console.log("Brand List:", brandListResponse);
-    } catch (error:any) {
-      console.error("Error occurred while calling the API:", error.message);
-      throw new Error("API call failed");
-    }
-  }, 20000);
-  test('Test14:should reset the default brand successfully', async () => {
-    try {
-      const response = await brandingApi.resetDefaultBrand(brandId);
-      console.log("Brand reset as default successfully:", response);
-      expect(response).toBeDefined();
-    } catch (error:any) {
-      console.error("Error occurred while calling the API:", error.message);
-      throw new Error("API call failed to reset default brand");
-    }
-  }, 30000);
-  test('should fail to reset the default brand with non-existent brand ID', async () => {
-    const brandId = "NON_EXISTENT_BRAND_ID";
-    try {
-      const response = await brandingApi.resetDefaultBrand(brandId);
-      console.log("Brand reset unexpectedly succeeded:", response);
-      throw new Error("Test failed. API call should have failed with non-existent brand ID.");
-    } catch (error:any) {
-      console.error("Expected error occurred while calling the API:", error.message);
-    }
-  }, 20000);
-  test('Tes16:should delete a brand successfully', async () => {
-    try {
-      const deleteResponse = await brandingApi.deleteBrand(brandId);
-      console.log("Brand deleted successfully:", deleteResponse);
-      expect(deleteResponse).toBeDefined();
-      expect(deleteResponse.success).toBe(true);
-    } catch (error:any) {
-      console.log("Error occurred while calling the API:", error.message);
-    }
-  }, 20000);
-  test('Test17:should fail to delete a brand with invalid brand ID', async () => {
-    const brandId = "invalid-brand-id";
-    try {
-      const deleteResponse = await brandingApi.deleteBrand(brandId);
-      console.log("Brand deleted unexpectedly:", deleteResponse);
-      expect(deleteResponse).toBeDefined();
-      expect(deleteResponse.success).toBe(false);
-    } catch (error:any) {
-      console.error("Error occurred while calling the API:", error.message);
-      expect(error.message).toBeDefined();
-    }
-  }, 20000);
-});