boldsign 1.0.1 → 1.0.2

package/dist/tests/unit/userApi.spec.js

@@ -0,0 +1,163 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const userApi_1 = require("../../api/userApi");
+const sinon = __importStar(require("sinon"));
+describe('UserApi Unit Test', () => {
+    let userApiStub;
+    beforeEach(() => {
+        userApiStub = sinon.createStubInstance(userApi_1.UserApi);
+        userApiStub.createUser = sinon.stub().resolves({ userId: 'user_id' });
+        userApiStub.updateUser = sinon.stub().resolves({
+            success: true,
+            message: 'User updated successfully',
+        });
+    });
+    afterEach(() => {
+        sinon.restore();
+    });
+    it('should mock and verify createUser call', () => __awaiter(void 0, void 0, void 0, function* () {
+        const mockUserCreated = {
+            userId: 'user_id',
+        };
+        const userData = {
+            name: 'New User',
+            email: 'newuser@example.com',
+            role: 'Admin',
+        };
+        userApiStub.createUser.resolves(mockUserCreated);
+        const result = yield userApiStub.createUser(userData);
+        expect(result).toBeDefined();
+        expect(result.userId).toBe('user_id');
+        sinon.assert.calledOnceWithExactly(userApiStub.createUser, userData);
+    }));
+    it('should mock and verify updateUser call', () => __awaiter(void 0, void 0, void 0, function* () {
+        const mockUpdatedUser = {
+            success: true,
+            message: 'User updated successfully',
+        };
+        const userId = 'user_id';
+        const updatedUserData = {
+            name: 'Updated User',
+            email: 'updateduser@example.com',
+            role: 'Manager',
+        };
+        userApiStub.updateUser.resolves(mockUpdatedUser);
+        const result = yield userApiStub.updateUser(userId, updatedUserData);
+        expect(result).toBeDefined();
+        expect(result.success).toBe(true);
+        expect(result.message).toBe('User updated successfully');
+        sinon.assert.calledOnceWithExactly(userApiStub.updateUser, userId, updatedUserData);
+    }));
+    it('should mock and verify listUsers call', () => __awaiter(void 0, void 0, void 0, function* () {
+        const mockListResponse = {
+            users: [
+                {
+                    userId: 'user_1',
+                    name: 'User One',
+                    email: 'userone@example.com',
+                    role: 'Admin',
+                },
+                {
+                    userId: 'user_2',
+                    name: 'User Two',
+                    email: 'usertwo@example.com',
+                    role: 'Manager',
+                },
+            ],
+        };
+        userApiStub.listUsers = sinon.stub().resolves(mockListResponse);
+        const result = yield userApiStub.listUsers();
+        expect(result).toBeDefined();
+        expect(Array.isArray(result.users)).toBe(true);
+        expect(result.users.length).toBe(2);
+        expect(result.users[0].name).toBe('User One');
+        expect(result.users[1].role).toBe('Manager');
+        sinon.assert.calledOnce(userApiStub.listUsers);
+    }));
+    it('should mock and verify getUserDetails call', () => __awaiter(void 0, void 0, void 0, function* () {
+        const mockUserDetails = {
+            userId: 'user_1',
+            name: 'User One',
+            email: 'userone@example.com',
+            role: 'Admin',
+        };
+        const userId = 'user_1';
+        userApiStub.getUserDetails = sinon.stub().resolves(mockUserDetails);
+        const result = yield userApiStub.getUserDetails(userId);
+        expect(result).toBeDefined();
+        expect(result.userId).toBe('user_1');
+        expect(result.name).toBe('User One');
+        expect(result.email).toBe('userone@example.com');
+        expect(result.role).toBe('Admin');
+        sinon.assert.calledOnceWithExactly(userApiStub.getUserDetails, userId);
+    }));
+    it('should mock and verify resendUserInvitation call', () => __awaiter(void 0, void 0, void 0, function* () {
+        const mockResendResponse = {
+            success: true,
+            message: 'User invitation resent successfully',
+        };
+        const userId = 'user_1';
+        userApiStub.resendUserInvitation = sinon.stub().resolves(mockResendResponse);
+        const result = yield userApiStub.resendUserInvitation(userId);
+        expect(result).toBeDefined();
+        expect(result.success).toBe(true);
+        expect(result.message).toBe('User invitation resent successfully');
+        sinon.assert.calledOnceWithExactly(userApiStub.resendUserInvitation, userId);
+    }));
+    it('should mock and verify cancelUserInvitation call', () => __awaiter(void 0, void 0, void 0, function* () {
+        const mockCancelResponse = {
+            success: true,
+            message: 'Invitation canceled successfully',
+        };
+        const userId = 'user_1';
+        userApiStub.cancelUserInvitation = sinon.stub().resolves(mockCancelResponse);
+        const result = yield userApiStub.cancelUserInvitation(userId);
+        expect(result).toBeDefined();
+        expect(result.success).toBe(true);
+        expect(result.message).toBe('Invitation canceled successfully');
+        sinon.assert.calledOnceWithExactly(userApiStub.cancelUserInvitation, userId);
+    }));
+});
+//# sourceMappingURL=userApi.spec.js.map

package/dist/tests/unit/userApi.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"userApi.spec.js","sourceRoot":"","sources":["../../../tests/unit/userApi.spec.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAA4C;AAC5C,6CAA+B;AAE/B,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IAC/B,IAAI,WAAgD,CAAC;IAErD,UAAU,CAAC,GAAG,EAAE;QAEZ,WAAW,GAAG,KAAK,CAAC,kBAAkB,CAAC,iBAAO,CAAC,CAAC;QAEhD,WAAW,CAAC,UAAU,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;QACtE,WAAW,CAAC,UAAU,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC;YAC3C,OAAO,EAAE,IAAI;YACb,OAAO,EAAE,2BAA2B;SACvC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACX,KAAK,CAAC,OAAO,EAAE,CAAC;IACpB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,GAAS,EAAE;QACpD,MAAM,eAAe,GAAG;YACpB,MAAM,EAAE,SAAS;SACpB,CAAC;QAEF,MAAM,QAAQ,GAAG;YACb,IAAI,EAAE,UAAU;YAChB,KAAK,EAAE,qBAAqB;YAC5B,IAAI,EAAE,OAAO;SAChB,CAAC;QAEF,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;QAEjD,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAEtD,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;QAC7B,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAEtC,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,WAAW,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IACzE,CAAC,CAAA,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,GAAS,EAAE;QACpD,MAAM,eAAe,GAAG;YACpB,OAAO,EAAE,IAAI;YACb,OAAO,EAAE,2BAA2B;SACvC,CAAC;QAEF,MAAM,MAAM,GAAG,SAAS,CAAC;QACzB,MAAM,eAAe,GAAG;YACpB,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE,yBAAyB;YAChC,IAAI,EAAE,SAAS;SAClB,CAAC;QAEF,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;QAEjD,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,UAAU,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;QAErE,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;QAC7B,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;QAEzD,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAC9B,WAAW,CAAC,UAAU,EACtB,MAAM,EACN,eAAe,CAClB,CAAC;IACN,CAAC,CAAA,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAS,EAAE;QACnD,MAAM,gBAAgB,GAAG;YACrB,KAAK,EAAE;gBACH;oBACI,MAAM,EAAE,QAAQ;oBAChB,IAAI,EAAE,UAAU;oBAChB,KAAK,EAAE,qBAAqB;oBAC5B,IAAI,EAAE,OAAO;iBAChB;gBACD;oBACI,MAAM,EAAE,QAAQ;oBAChB,IAAI,EAAE,UAAU;oBAChB,KAAK,EAAE,qBAAqB;oBAC5B,IAAI,EAAE,SAAS;iBAClB;aACJ;SACJ,CAAC;QAEF,WAAW,CAAC,SAAS,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;QAEhE,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,SAAS,EAAE,CAAC;QAE7C,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;QAC7B,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/C,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACpC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC9C,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAE7C,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IACnD,CAAC,CAAA,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,GAAS,EAAE;QACxD,MAAM,eAAe,GAAG;YACpB,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,UAAU;YAChB,KAAK,EAAE,qBAAqB;YAC5B,IAAI,EAAE,OAAO;SAChB,CAAC;QAEF,MAAM,MAAM,GAAG,QAAQ,CAAC;QAExB,WAAW,CAAC,cAAc,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;QAEpE,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAExD,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;QAC7B,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACrC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACrC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QACjD,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAElC,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,WAAW,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;IAC3E,CAAC,CAAA,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,GAAS,EAAE;QAC9D,MAAM,kBAAkB,GAAG;YACvB,OAAO,EAAE,IAAI;YACb,OAAO,EAAE,qCAAqC;SACjD,CAAC;QAEF,MAAM,MAAM,GAAG,QAAQ,CAAC;QAExB,WAAW,CAAC,oBAAoB,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC;QAE7E,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAE9D,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;QAC7B,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;QAEnE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,WAAW,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;IACjF,CAAC,CAAA,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,GAAS,EAAE;QAC9D,MAAM,kBAAkB,GAAG;YACvB,OAAO,EAAE,IAAI;YACb,OAAO,EAAE,kCAAkC;SAC9C,CAAC;QAEF,MAAM,MAAM,GAAG,QAAQ,CAAC;QAExB,WAAW,CAAC,oBAAoB,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC;QAE7E,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAE9D,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;QAC7B,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;QAEhE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,WAAW,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;IACjF,CAAC,CAAA,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/docs/AccessCodeDetail.md

@@ -0,0 +1,19 @@
+# # AccessCodeDetail
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `authenticationType`<sup>*_required_</sup> | ```string``` |   |  |
+| `emailId` | ```string``` |   |  |
+| `order` | ```number``` |   |  |
+| `accessCode` | ```string``` |   |  |
+| `onBehalfOf` | ```string``` |   |  |
+| `phoneNumber` | [```PhoneNumber```](PhoneNumber.md) |   |  |
+| `identityVerificationSettings` | [```IdentityVerificationSettings```](IdentityVerificationSettings.md) |   |  |
+| `authenticationRetryCount` | ```number``` |   |  |
+| `authenticationSettings` | [```AuthenticationSettings```](AuthenticationSettings.md) |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/AccessCodeDetails.md

@@ -0,0 +1,13 @@
+# # AccessCodeDetails
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `accessCode`<sup>*_required_</sup> | ```string``` |   |  |
+| `phoneNumber` | [```PhoneNumber```](PhoneNumber.md) |   |  |
+| `onBehalfOf` | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/Address.md

@@ -0,0 +1,16 @@
+# # Address
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `city` | ```string``` |   |  |
+| `country` | ```string``` |   |  |
+| `line1` | ```string``` |   |  |
+| `line2` | ```string``` |   |  |
+| `postalCode` | ```string``` |   |  |
+| `state` | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/AttachmentInfo.md

@@ -0,0 +1,14 @@
+# # AttachmentInfo
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `title`<sup>*_required_</sup> | ```string``` |   |  |
+| `allowedFileTypes`<sup>*_required_</sup> | ```string``` |   |  |
+| `description` | ```string``` |   |  |
+| `acceptedFileTypes` | ```Array<string>``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/AuditTrail.md

@@ -0,0 +1,18 @@
+# # AuditTrail
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `id` | ```string``` |   |  |
+| `name` | ```string``` |   |  |
+| `email` | ```string``` |   |  |
+| `toName` | ```string``` |   |  |
+| `toEmail` | ```string``` |   |  |
+| `ipaddress` | ```string``` |   |  |
+| `action` | ```string``` |   |  |
+| `timestamp` | ```number``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/AuthenticationSettings.md

@@ -0,0 +1,11 @@
+# # AuthenticationSettings
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `authenticationFrequency` | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/Base64File.md

@@ -0,0 +1,12 @@
+# # Base64File
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `base64`<sup>*_required_</sup> | ```string``` |   |  |
+| `fileName` | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/BehalfDocument.md

@@ -0,0 +1,27 @@
+# # BehalfDocument
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `behalfOf` | [```BehalfOf```](BehalfOf.md) |   |  |
+| `documentId` | ```string``` |   |  |
+| `senderDetail` | [```DocumentSenderDetail```](DocumentSenderDetail.md) |   |  |
+| `ccDetails` | [```Array<DocumentCcDetails>```](DocumentCcDetails.md) |   |  |
+| `createdDate` | ```number``` |   |  |
+| `activityDate` | ```number``` |   |  |
+| `activityBy` | ```string``` |   |  |
+| `messageTitle` | ```string``` |   |  |
+| `status` | ```string``` |   |  |
+| `signerDetails` | [```Array<DocumentSignerDetails>```](DocumentSignerDetails.md) |   |  |
+| `expiryDate` | ```number``` |   |  |
+| `enableSigningOrder` | ```boolean``` |   |  |
+| `isDeleted` | ```boolean``` |   |  |
+| `labels` | ```Array<string>``` |   |  |
+| `cursor` | ```number``` |   |  |
+| `brandId` | ```string``` |   |  |
+| `scheduledSendTime` | ```number``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/BehalfDocumentRecords.md

@@ -0,0 +1,12 @@
+# # BehalfDocumentRecords
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `pageDetails` | [```PageDetails```](PageDetails.md) |   |  |
+| `result` | [```Array<BehalfDocument>```](BehalfDocument.md) |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/BehalfOf.md

@@ -0,0 +1,12 @@
+# # BehalfOf
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `name` | ```string``` |   |  |
+| `emailAddress` | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/BillingViewModel.md

@@ -0,0 +1,11 @@
+# # BillingViewModel
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `balanceCredits` | ```number``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/BrandCreated.md

@@ -0,0 +1,11 @@
+# # BrandCreated
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `brandId` | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/BrandCustomFieldDetails.md

@@ -0,0 +1,16 @@
+# # BrandCustomFieldDetails
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `fieldName` | ```string``` |   |  |
+| `fieldDescription` | ```string``` |   |  |
+| `fieldOrder` | ```number``` |   |  [default to 1] |
+| `brandId` | ```string``` |   |  |
+| `sharedField` | ```boolean``` |   |  |
+| `formField` | [```CustomFormField```](CustomFormField.md) |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/BrandingApi.md

@@ -0,0 +1,258 @@
+# BrandingApi
+
+All URIs are relative to https://api.boldsign.com.
+
+| Method | HTTP request | Description |
+| ------------- | ------------- | ------------- |
+| [**brandList()**](BrandingApi.md#brandList) | **GET** /v1/brand/list | List all the brands. |
+| [**createBrand()**](BrandingApi.md#createBrand) | **POST** /v1/brand/create | Create the brand. |
+| [**deleteBrand()**](BrandingApi.md#deleteBrand) | **DELETE** /v1/brand/delete | Delete the brand. |
+| [**editBrand()**](BrandingApi.md#editBrand) | **POST** /v1/brand/edit | Edit the brand. |
+| [**getBrand()**](BrandingApi.md#getBrand) | **GET** /v1/brand/get | Get the specific brand details. |
+| [**resetDefaultBrand()**](BrandingApi.md#resetDefaultBrand) | **POST** /v1/brand/resetdefault | Reset default brand. |
+
+
+## `brandList()`
+
+```typescript
+brandList(): BrandingRecords
+```
+
+List all the brands.
+
+
+### Parameters
+
+|This endpoint does not need any parameter. |
+
+### Return type
+
+[**BrandingRecords**](../docs/BrandingRecords.md)
+
+### Authorization
+
+[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
+[[Back to Model list]](../README.md#models)
+[[Back to README]](../README.md)
+
+## `createBrand()`
+
+```typescript
+createBrand(brandName: string, brandLogo: RequestFile, backgroundColor: string, buttonColor: string, buttonTextColor: string, emailDisplayName: string, disclaimerDescription: string, disclaimerTitle: string, redirectUrl: string, isDefault: boolean, canHideTagLine: boolean, combineAuditTrail: boolean, excludeAuditTrailFromEmail: boolean, emailSignedDocument: string, documentTimeZone: string, showBuiltInFormFields: boolean, allowCustomFieldCreation: boolean, showSharedCustomFields: boolean, hideDecline: boolean, hideSave: boolean, documentExpirySettingsExpiryDateType: string, documentExpirySettingsExpiryValue: number, documentExpirySettingsEnableDefaultExpiryAlert: boolean, documentExpirySettingsEnableAutoReminder: boolean, documentExpirySettingsReminderDays: number, documentExpirySettingsReminderCount: number, customDomainSettingsDomainName: string, customDomainSettingsFromName: string): BrandCreated
+```
+
+Create the brand.
+
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **brandName** | **string**|  | |
+| **brandLogo** | **RequestFile****RequestFile**|  | |
+| **backgroundColor** | **string**|  | [optional] |
+| **buttonColor** | **string**|  | [optional] |
+| **buttonTextColor** | **string**|  | [optional] |
+| **emailDisplayName** | **string**|  | [optional] |
+| **disclaimerDescription** | **string**|  | [optional] |
+| **disclaimerTitle** | **string**|  | [optional] |
+| **redirectUrl** | **string**|  | [optional] |
+| **isDefault** | **boolean**|  | [optional] [default to false] |
+| **canHideTagLine** | **boolean**|  | [optional] [default to false] |
+| **combineAuditTrail** | **boolean**|  | [optional] [default to false] |
+| **excludeAuditTrailFromEmail** | **boolean**|  | [optional] [default to false] |
+| **emailSignedDocument** | **string**|  | [optional] [default to 'Attachment'] |
+| **documentTimeZone** | **string**|  | [optional] |
+| **showBuiltInFormFields** | **boolean**|  | [optional] [default to true] |
+| **allowCustomFieldCreation** | **boolean**|  | [optional] [default to false] |
+| **showSharedCustomFields** | **boolean**|  | [optional] [default to false] |
+| **hideDecline** | **boolean**|  | [optional] |
+| **hideSave** | **boolean**|  | [optional] |
+| **documentExpirySettingsExpiryDateType** | **string**|  | [optional] |
+| **documentExpirySettingsExpiryValue** | **number**|  | [optional] |
+| **documentExpirySettingsEnableDefaultExpiryAlert** | **boolean**|  | [optional] |
+| **documentExpirySettingsEnableAutoReminder** | **boolean**|  | [optional] |
+| **documentExpirySettingsReminderDays** | **number**|  | [optional] |
+| **documentExpirySettingsReminderCount** | **number**|  | [optional] |
+| **customDomainSettingsDomainName** | **string**|  | [optional] |
+| **customDomainSettingsFromName** | **string**|  | [optional] |
+
+### Return type
+
+[**BrandCreated**](../docs/BrandCreated.md)
+
+### Authorization
+
+[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: `multipart/form-data`
+- **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
+[[Back to Model list]](../README.md#models)
+[[Back to README]](../README.md)
+
+## `deleteBrand()`
+
+```typescript
+deleteBrand(brandId: string): BrandingMessage
+```
+
+Delete the brand.
+
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **brandId** | **string**| brand Id. | |
+
+### Return type
+
+[**BrandingMessage**](../docs/BrandingMessage.md)
+
+### Authorization
+
+[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
+[[Back to Model list]](../README.md#models)
+[[Back to README]](../README.md)
+
+## `editBrand()`
+
+```typescript
+editBrand(brandId: string, brandName: string, brandLogo: RequestFile, backgroundColor: string, buttonColor: string, buttonTextColor: string, emailDisplayName: string, disclaimerDescription: string, disclaimerTitle: string, redirectUrl: string, isDefault: boolean, canHideTagLine: boolean, combineAuditTrail: boolean, excludeAuditTrailFromEmail: boolean, emailSignedDocument: string, documentTimeZone: string, showBuiltInFormFields: boolean, allowCustomFieldCreation: boolean, showSharedCustomFields: boolean, hideDecline: boolean, hideSave: boolean, documentExpirySettingsExpiryDateType: string, documentExpirySettingsExpiryValue: number, documentExpirySettingsEnableDefaultExpiryAlert: boolean, documentExpirySettingsEnableAutoReminder: boolean, documentExpirySettingsReminderDays: number, documentExpirySettingsReminderCount: number, customDomainSettingsDomainName: string, customDomainSettingsFromName: string): BrandCreated
+```
+
+Edit the brand.
+
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **brandId** | **string**| The brand id. | |
+| **brandName** | **string**|  | [optional] |
+| **brandLogo** | **RequestFile****RequestFile**|  | [optional] |
+| **backgroundColor** | **string**|  | [optional] |
+| **buttonColor** | **string**|  | [optional] |
+| **buttonTextColor** | **string**|  | [optional] |
+| **emailDisplayName** | **string**|  | [optional] |
+| **disclaimerDescription** | **string**|  | [optional] |
+| **disclaimerTitle** | **string**|  | [optional] |
+| **redirectUrl** | **string**|  | [optional] |
+| **isDefault** | **boolean**|  | [optional] [default to false] |
+| **canHideTagLine** | **boolean**|  | [optional] [default to false] |
+| **combineAuditTrail** | **boolean**|  | [optional] [default to false] |
+| **excludeAuditTrailFromEmail** | **boolean**|  | [optional] [default to false] |
+| **emailSignedDocument** | **string**|  | [optional] [default to 'Attachment'] |
+| **documentTimeZone** | **string**|  | [optional] |
+| **showBuiltInFormFields** | **boolean**|  | [optional] [default to true] |
+| **allowCustomFieldCreation** | **boolean**|  | [optional] [default to false] |
+| **showSharedCustomFields** | **boolean**|  | [optional] [default to false] |
+| **hideDecline** | **boolean**|  | [optional] |
+| **hideSave** | **boolean**|  | [optional] |
+| **documentExpirySettingsExpiryDateType** | **string**|  | [optional] |
+| **documentExpirySettingsExpiryValue** | **number**|  | [optional] |
+| **documentExpirySettingsEnableDefaultExpiryAlert** | **boolean**|  | [optional] |
+| **documentExpirySettingsEnableAutoReminder** | **boolean**|  | [optional] |
+| **documentExpirySettingsReminderDays** | **number**|  | [optional] |
+| **documentExpirySettingsReminderCount** | **number**|  | [optional] |
+| **customDomainSettingsDomainName** | **string**|  | [optional] |
+| **customDomainSettingsFromName** | **string**|  | [optional] |
+
+### Return type
+
+[**BrandCreated**](../docs/BrandCreated.md)
+
+### Authorization
+
+[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: `multipart/form-data`
+- **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
+[[Back to Model list]](../README.md#models)
+[[Back to README]](../README.md)
+
+## `getBrand()`
+
+```typescript
+getBrand(brandId: string): ViewBrandDetails
+```
+
+Get the specific brand details.
+
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **brandId** | **string**| The brand id. | |
+
+### Return type
+
+[**ViewBrandDetails**](../docs/ViewBrandDetails.md)
+
+### Authorization
+
+[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
+[[Back to Model list]](../README.md#models)
+[[Back to README]](../README.md)
+
+## `resetDefaultBrand()`
+
+```typescript
+resetDefaultBrand(brandId: string): BrandingMessage
+```
+
+Reset default brand.
+
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **brandId** | **string**| brand Id. | |
+
+### Return type
+
+[**BrandingMessage**](../docs/BrandingMessage.md)
+
+### Authorization
+
+[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
+[[Back to Model list]](../README.md#models)
+[[Back to README]](../README.md)