boldsign 1.0.0-beta.1

package/model/viewBrandDetails.ts

@@ -0,0 +1,177 @@
+/**
+ * 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 { CustomDomainSettings } from './customDomainSettings';
+import { DocumentExpirySettings } from './documentExpirySettings';
+
+export class ViewBrandDetails {
+    'brandId'?: string | null;
+    'brandLogo'?: string | null;
+    'brandName'?: string | null;
+    'backgroundColor'?: string | null;
+    'buttonColor'?: string | null;
+    'buttonTextColor'?: string | null;
+    'emailDisplayName'?: string | null;
+    'disclaimerTitle'?: string | null;
+    'disclaimerDescription'?: string | null;
+    'redirectUrl'?: string | null;
+    'isDefault'?: boolean;
+    'canHideTagLine'?: boolean;
+    'combineAuditTrail'?: boolean;
+    'excludeAuditTrailFromEmail'?: boolean;
+    'emailSignedDocument'?: ViewBrandDetails.EmailSignedDocumentEnum;
+    'documentTimeZone'?: string | null;
+    'showBuiltInFormFields'?: boolean;
+    'allowCustomFieldCreation'?: boolean;
+    'showSharedCustomFields'?: boolean;
+    'hideDecline'?: boolean;
+    'hideSave'?: boolean;
+    'documentExpirySettings'?: DocumentExpirySettings;
+    'customDomainSettings'?: CustomDomainSettings;
+    'isDomainVerified'?: boolean;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "brandId",
+            "baseName": "brandId",
+            "type": "string"
+        },
+        {
+            "name": "brandLogo",
+            "baseName": "brandLogo",
+            "type": "string"
+        },
+        {
+            "name": "brandName",
+            "baseName": "brandName",
+            "type": "string"
+        },
+        {
+            "name": "backgroundColor",
+            "baseName": "backgroundColor",
+            "type": "string"
+        },
+        {
+            "name": "buttonColor",
+            "baseName": "buttonColor",
+            "type": "string"
+        },
+        {
+            "name": "buttonTextColor",
+            "baseName": "buttonTextColor",
+            "type": "string"
+        },
+        {
+            "name": "emailDisplayName",
+            "baseName": "emailDisplayName",
+            "type": "string"
+        },
+        {
+            "name": "disclaimerTitle",
+            "baseName": "disclaimerTitle",
+            "type": "string"
+        },
+        {
+            "name": "disclaimerDescription",
+            "baseName": "disclaimerDescription",
+            "type": "string"
+        },
+        {
+            "name": "redirectUrl",
+            "baseName": "redirectUrl",
+            "type": "string"
+        },
+        {
+            "name": "isDefault",
+            "baseName": "isDefault",
+            "type": "boolean"
+        },
+        {
+            "name": "canHideTagLine",
+            "baseName": "canHideTagLine",
+            "type": "boolean"
+        },
+        {
+            "name": "combineAuditTrail",
+            "baseName": "combineAuditTrail",
+            "type": "boolean"
+        },
+        {
+            "name": "excludeAuditTrailFromEmail",
+            "baseName": "excludeAuditTrailFromEmail",
+            "type": "boolean"
+        },
+        {
+            "name": "emailSignedDocument",
+            "baseName": "emailSignedDocument",
+            "type": "ViewBrandDetails.EmailSignedDocumentEnum"
+        },
+        {
+            "name": "documentTimeZone",
+            "baseName": "documentTimeZone",
+            "type": "string"
+        },
+        {
+            "name": "showBuiltInFormFields",
+            "baseName": "showBuiltInFormFields",
+            "type": "boolean"
+        },
+        {
+            "name": "allowCustomFieldCreation",
+            "baseName": "allowCustomFieldCreation",
+            "type": "boolean"
+        },
+        {
+            "name": "showSharedCustomFields",
+            "baseName": "showSharedCustomFields",
+            "type": "boolean"
+        },
+        {
+            "name": "hideDecline",
+            "baseName": "hideDecline",
+            "type": "boolean"
+        },
+        {
+            "name": "hideSave",
+            "baseName": "hideSave",
+            "type": "boolean"
+        },
+        {
+            "name": "documentExpirySettings",
+            "baseName": "documentExpirySettings",
+            "type": "DocumentExpirySettings"
+        },
+        {
+            "name": "customDomainSettings",
+            "baseName": "customDomainSettings",
+            "type": "CustomDomainSettings"
+        },
+        {
+            "name": "isDomainVerified",
+            "baseName": "isDomainVerified",
+            "type": "boolean"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return ViewBrandDetails.attributeTypeMap;
+    }
+}
+
+export namespace ViewBrandDetails {
+    export enum EmailSignedDocumentEnum {
+        Attachment = <any> 'Attachment',
+        DocumentLink = <any> 'DocumentLink'
+    }
+}

package/model/viewCustomFieldDetails.ts

@@ -0,0 +1,68 @@
+/**
+ * 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 { CustomFormField } from './customFormField';
+
+export class ViewCustomFieldDetails {
+    'customFieldId'?: string | null;
+    'fieldName'?: string | null;
+    'fieldDescription'?: string | null;
+    'fieldOrder'?: number;
+    'brandId'?: string | null;
+    'sharedField'?: boolean;
+    'formField'?: CustomFormField;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "customFieldId",
+            "baseName": "customFieldId",
+            "type": "string"
+        },
+        {
+            "name": "fieldName",
+            "baseName": "fieldName",
+            "type": "string"
+        },
+        {
+            "name": "fieldDescription",
+            "baseName": "fieldDescription",
+            "type": "string"
+        },
+        {
+            "name": "fieldOrder",
+            "baseName": "fieldOrder",
+            "type": "number"
+        },
+        {
+            "name": "brandId",
+            "baseName": "brandId",
+            "type": "string"
+        },
+        {
+            "name": "sharedField",
+            "baseName": "sharedField",
+            "type": "boolean"
+        },
+        {
+            "name": "formField",
+            "baseName": "formField",
+            "type": "CustomFormField"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return ViewCustomFieldDetails.attributeTypeMap;
+    }
+}
+

package/package.json

@@ -0,0 +1,48 @@
+{
+    "name": "boldsign",
+    "version": "1.0.0-beta.1",
+    "description": "NodeJS client for boldsign",
+    "keywords": [
+        "boldsign",
+        "api",
+        "sdk",
+        "boldsign api",
+        "e-signature"
+    ],
+    "homepage": "https://boldsign.com/",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/boldsign/boldsign-node-sdk.git"
+    },
+    "main": "dist/api.js",
+    "types": "dist/api.d.ts",
+    "scripts": {
+        "clean": "rm -Rf node_modules/ *.js",
+        "build": "tsc",
+        "test": "npm run build && node dist/client.js"
+    },
+    "author": "BoldSign",
+    "license": "MIT",
+    "dependencies": {
+        "axios": "^1.7.0",
+        "bluebird": "^3.7.2",
+        "form-data": "^4.0.0",
+        "qs": "^6.10.3",
+        "@types/node": "^20.8.10"
+    },
+    "devDependencies": {
+        "@types/bluebird": "^3.5.33",
+        "@types/jest": "^29.5.7",
+        "@types/json-diff": "^1.0.3",
+        "@types/qs": "^6.9.15",
+        "axios-mock-adapter": "^1.20.0",
+        "esbuild": "^0.14.54",
+        "jest": "^29.7.0",
+        "json-diff": "^0.7.1",
+        "prettier": "2.5.1",
+        "prettier-plugin-organize-imports": "^4.0.0",
+        "ts-jest": "^29.1.1",
+        "ts-node": "^10.9.1",
+        "typescript": "^4.0 || ^5.0"
+    }
+}

package/tests/integration/BrandingApiTest.spec.ts

@@ -0,0 +1,141 @@
+import { BrandingApi } from '../../api/brandingApi';
+import * as fs from 'fs';
+
+describe('Test suite', () => {
+  let brandingApi;
+  let brandId;
+  beforeAll(() => {
+    brandId = null;
+    const apiKey = process.env.API_KEY;
+    const baseUrl = process.env.HOST_URL;
+    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/integration/documents/Logo.png");
+    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.body.brandId);
+      brandId = createBrandApiResponse.body.brandId;
+      expect(brandId).toBeDefined();
+      expect(brandId).toBeGreaterThan(0);
+    } catch (error) {
+      console.log("Error occurred while creating the brand:", error);
+    }
+  });
+  test('should fail to create a brand without brand name', async () => {
+    const brandName = "";
+    const brandLogo = fs.createReadStream("tests/integration/documents/Logo.png");
+    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);
+      expect(error).toBeDefined();
+      expect(error.response.status).toBe(400);
+    }
+  });
+  test('should update a brand successfully', async () => {
+    const brandName = "Node-SDK-Test";
+    const brandLogo = fs.createReadStream("tests/integration/documents/Logo.png");
+    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.body.brandId);
+      expect(updateBrandApiResponse.body).toBeDefined();
+    } catch (error) {
+      console.error("Error occurred while updating the brand:", error);
+      throw new Error("API call failed");
+    }
+  });
+  test('should get brand details successfully', async () => {
+    try {
+      const brandDetailsResponse = await brandingApi.getBrand(brandId);
+      console.log("Brand details retrieved successfully:", brandDetailsResponse.body);
+      expect(brandDetailsResponse.body).toBeDefined();
+      expect(brandDetailsResponse.body.id).toBe(brandId);
+    } catch (error) {
+      console.log("Error occurred while calling the API:", error);
+    }
+  });
+  test('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.body);
+      expect(brandDetailsResponse.body).toBeUndefined();
+    } catch (error:any) {
+      console.error("Error occurred while calling the API:", error);
+      expect(error).toBeDefined();
+      expect(error.response.status).toBe(400);
+    }
+  });
+  test('should retrieve the brand list successfully', async () => {
+    try {
+      const brandListResponse = await brandingApi.brandList();
+      console.log("Brand List:", brandListResponse);
+    } catch (error) {
+      console.error("Error occurred while calling the API:", error);
+      throw new Error("API call failed");
+    }
+  });
+  test('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) {
+      console.error("Error occurred while calling the API:", error);
+      throw new Error("API call failed to reset default brand");
+    }
+  });
+  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) {
+      console.error("Expected error occurred while calling the API:", error);
+    }
+  });
+  test('should delete a brand successfully', async () => {
+    try {
+      const deleteResponse = await brandingApi.deleteBrand(brandId);
+      console.log("Brand deleted successfully:", deleteResponse.body);
+      expect(deleteResponse.body).toBeDefined();
+      expect(deleteResponse.body.success).toBe(true);
+    } catch (error) {
+      console.log("Error occurred while calling the API:", error);
+    }
+  });
+  test('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.body);
+      expect(deleteResponse.body).toBeDefined();
+      expect(deleteResponse.body.success).toBe(false);
+    } catch (error:any) {
+      console.error("Error occurred while calling the API:", error);
+      expect(error).toBeDefined();
+      expect(error.response).toBeDefined();
+      expect(error.response.status).toBe(400);
+    }
+  });
+});

package/tests/integration/ContactsApiTest.spec.ts

@@ -0,0 +1,202 @@
+import { ContactsApi } from '../../api/contactsApi';
+import { ContactDetails, PhoneNumber } from '../../model';
+
+describe('Test suite', () => {
+  let contactsApi;
+  let contactId;  
+  let emailId;
+  const generateRandomEmail = () => {
+    const randomNum = Math.floor(1000 + Math.random() * 9000); 
+    return `sdktesting${randomNum}@syncfusion.com`;
+  };
+  beforeAll(() => {
+    contactId = null;
+    emailId = null;
+    const baseUrl = process.env.HOST_URL;
+    const apiKey = process.env.API_KEY;
+    if (!baseUrl || !apiKey) {
+      throw new Error("Environment variables 'HOST_URL' or 'API_KEY' are not set.");
+    }
+    emailId = generateRandomEmail();
+    contactsApi = new ContactsApi(baseUrl);
+    contactsApi.setApiKey(apiKey);
+    console.log(`Generated email: ${emailId}`);
+  });
+test('Test1:should create a contact successfully', async () => {
+    const contactDetails = new ContactDetails();
+    contactDetails.name = "sdktesting";
+    contactDetails.email = emailId;
+    contactDetails.jobTitle = "HR";
+    contactDetails.companyName = "Syncfusion";
+    const phoneNumber = new PhoneNumber();
+    phoneNumber.countryCode = "+1";
+    phoneNumber.number = "2015660123";
+    contactDetails.phoneNumber = phoneNumber;
+    const contact = [contactDetails];
+    try {
+      const createContactResponse = await contactsApi.createContact(contact);
+      console.log("Contact created successfully:", createContactResponse.body.createdContacts);
+      contactId = createContactResponse.body.createdContacts[0].id;
+      console.log("Created Contact ID: ", contactId);
+    } catch (error) {
+      console.error("Error occurred while calling the API:", error);
+      throw new Error("API call failed");
+    }
+  });
+  test('Test2:should fail to create a contact with invalid data', async () => {
+    const contactDetails = new ContactDetails();
+    contactDetails.name = "sdktesting82";
+    contactDetails.email = "invalid-email";
+    contactDetails.jobTitle = "Developer";
+    contactDetails.companyName = "CubeFlakes";
+    const phoneNumber = new PhoneNumber();
+    phoneNumber.countryCode = "+1";
+    phoneNumber.number = "2015550123";
+    contactDetails.phoneNumber = phoneNumber;
+    const contact = [contactDetails];
+    try {
+      const createContactResponse = await contactsApi.createContact(contact);
+      console.log("Contacts created successfully:", createContactResponse.body.createdContacts);
+      expect(createContactResponse.body.createdContacts).toBeUndefined();
+    } catch (error) {
+      console.error("Error occurred while calling the API:", error);
+      expect(error).toBeDefined();
+    }
+  });
+  test('Test3:should update a contact successfully', async () => {
+    const updatedContactDetails = new ContactDetails();
+    updatedContactDetails.name = "Test_Engineer";
+    updatedContactDetails.email = emailId;
+    updatedContactDetails.jobTitle = "Tester";
+    updatedContactDetails.companyName = "Flakes";
+    const updatedPhoneNumber = new PhoneNumber();
+    updatedPhoneNumber.countryCode = "+91";
+    updatedPhoneNumber.number = "9876563210";
+    updatedContactDetails.phoneNumber = updatedPhoneNumber;
+    try {
+      const updateContactResponse = await contactsApi.updateContact(contactId, updatedContactDetails);
+      console.log("Contact updated successfully:", updateContactResponse.body);
+      expect(updateContactResponse.body).toBeDefined();
+    } catch (error) {
+      console.log("Error occurred while updating the contact:", error);
+    }
+  });
+  test('Test4:should fail to update contact due to missing required field (email)', async () => {
+    const contactDetails = new ContactDetails();
+    contactDetails.name = "TestEngineer";
+    contactDetails.email = "";
+    contactDetails.jobTitle = "Tester";
+    contactDetails.companyName = "Flakes";
+    const phoneNumber = new PhoneNumber();
+    phoneNumber.countryCode = "+1";
+    phoneNumber.number = "2015550123";
+    contactDetails.phoneNumber = phoneNumber;
+    try {
+      const updateContactResponse = await contactsApi.updateContact(contactId, contactDetails);
+      console.log("Unexpected success:", updateContactResponse.body);
+      expect(updateContactResponse.body).toBeDefined();
+    } catch (error:any) {
+      console.error("Error occurred while calling the API:", error);
+      expect(error).toBeDefined();
+      expect(error.response).toBeDefined();
+      expect(error.response.status).toBe(400);
+    }
+  });
+  test('Test5:should fail to update contact due to non-existing contact ID', async () => {
+    const contactDetails = new ContactDetails();
+    contactDetails.name = "Test_Engineer";
+    contactDetails.email = "test1705@gmail.com";
+    contactDetails.jobTitle = "Tester";
+    contactDetails.companyName = "Flakes";
+    const phoneNumber = new PhoneNumber();
+    phoneNumber.countryCode = "+1";
+    phoneNumber.number = "2015550123";
+    contactDetails.phoneNumber = phoneNumber;
+    try {
+      const updateContactResponse = await contactsApi.updateContact("NON_EXISTENT_CONTACT_ID", contactDetails);
+      console.log("Unexpected success:", updateContactResponse.body);
+      expect(updateContactResponse.body).toBeDefined();
+    } catch (error:any) {
+      console.error("Error occurred while calling the API:", error);
+      expect(error).toBeDefined();
+      expect(error.response).toBeDefined();
+      expect(error.response.status).toBe(400);
+    }
+  });
+  test('Test6:should retrieve contact details successfully', async () => {
+    try {
+      const contactDetailsResponse = await contactsApi.getContact(contactId);
+      console.log("Contact details retrieved successfully:", contactDetailsResponse.body);
+      expect(contactDetailsResponse.body).toBeDefined();
+      expect(contactDetailsResponse.body.id).toBe(contactId);
+    } catch (error) {
+      console.error("Error occurred while calling the API:", error);
+      throw new Error("API call failed");
+    }
+  });
+  test('Test7:should return error for invalid contact ID in get contact', async () => {
+    const invalidContactId = "INVALID_CONTACT_ID";
+    try {
+      const contactDetailsResponse = await contactsApi.getContact(invalidContactId);
+      console.log("Unexpected success:", contactDetailsResponse.body);
+      fail("API should not have succeeded with an invalid contact ID");
+    } catch (error:any) {
+      console.error("Expected error occurred while calling the API:", error);
+      expect(error).toBeDefined();
+      expect(error.response).toBeDefined();
+      expect(error.response.status).toBe(400);
+    }
+  });
+  test('Test8:should delete a contact successfully', async () => {
+    try {
+      const deleteResponse = await contactsApi.deleteContacts(contactId);
+      console.log("Contact deleted successfully:", deleteResponse.body);
+      expect(deleteResponse.body).toBeDefined();
+      expect(deleteResponse.body.success).toBe(true);
+    } catch (error) {
+      console.log("Error occurred while calling the API:", error);
+    }
+  });
+  test('Test9:should fail to delete a contact with an invalid contact ID', async () => {
+    const invalidContactId = "INVALID_CONTACT_ID";
+    try {
+      const deleteResponse = await contactsApi.deleteContacts(invalidContactId);
+      console.error("Unexpected success response:", deleteResponse);
+      throw new Error("Expected error, but the API call was successful.");
+    } catch (error:any) {
+      console.log("Error occurred as expected while calling the API:", error);
+      expect(error.response).toBeDefined();
+      expect(error.response.status).toBe(400);
+      expect(error.response.data).toBeDefined();
+    }
+  });
+  test('Test10:should retrieve contact list successfully', async () => {
+    const page = 1;
+    const pageSize = 10;
+    try {
+      const contactListResponse = await contactsApi.contactUserList(page, pageSize);
+      console.log("Contact list retrieved successfully:", contactListResponse.body);
+      expect(contactListResponse.body).toBeDefined();
+      expect(contactListResponse.body.contacts).toBeDefined();
+      expect(contactListResponse.body.contacts.length).toBeGreaterThan(0);
+      expect(contactListResponse.body.page).toBe(page);
+      expect(contactListResponse.body.pageSize).toBe(pageSize);
+    } catch (error) {
+      console.log("Error occurred while calling the API:", error);
+    }
+  });
+  test('Test11:should fail to retrieve contact list with invalid pagination parameters', async () => {
+    const page = -1;
+    const pageSize = 0;
+    try {
+      const contactListResponse = await contactsApi.contactUserList(page, pageSize);
+      console.log("Contact list retrieved unexpectedly:", contactListResponse.body);
+      throw new Error("API call should have failed due to invalid pagination parameters");
+    } catch (error:any) {
+      console.error("Expected error occurred while calling the API:", error);
+      expect(error).toBeDefined();
+      expect(error.response).toBeDefined();
+      expect(error.response.status).toBe(400);
+    }
+  });
+});