@verdocs/js-sdk 1.1.17 → 1.2.0

package/HTTP/VerdocsEndpoint.d.ts

@@ -5,6 +5,18 @@
  * In that case, an Endpoint can be created and authenticated, used for calls related to signing operations, then
  * discarded once signing is complete.
  *
+ * Note that endpoint configuration functions return the instance, so they can be chained, e.g.
+ *
+ * ```typescript
+ * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
+ *
+ * const endpoint = new VerdocsEndpoint();
+ * endpoint
+ *     .logRequests(true)
+ *     .setClientID('1234)
+ *     .setTimeout(5000);
+ * ```
+ *
  * @module
  */
 import { AxiosInstance } from 'axios';
@@ -15,7 +27,7 @@ export declare class VerdocsEndpoint {
      * Create a new Endpoint to call Verdocs services.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
      *
      * console.log('Current timeout', Transport.getEndpoint().defaults.timeout);
      * ```
@@ -28,67 +40,67 @@ export declare class VerdocsEndpoint {
      * Set the timeout for API calls in milliseconds. 2000-4000ms is recommended for most purposes. 3000ms is the default.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
      *
-     * const endpoint = new Endpoint();
+     * const endpoint = new VerdocsEndpoint();
      * endpoint.setTimeout(3000);
      * ```
      */
-    setTimeout(timeout: number): void;
+    setTimeout(timeout: number): VerdocsEndpoint;
     /**
      * Set the Client ID for Verdocs API calls.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
      *
-     * const endpoint = new Endpoint();
+     * const endpoint = new VerdocsEndpoint();
      * endpoint.setClientID('1234);
      * ```
      */
-    setClientID(clientID: string): void;
+    setClientID(clientID: string): VerdocsEndpoint;
     /**
      * Set the auth token that will be used for Verdocs API calls.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
      *
-     * const endpoint = new Endpoint();
+     * const endpoint = new VerdocsEndpoint();
      * endpoint.setAuthorization(accessToken);
      * ```
      */
-    setAuthorization(accessToken: string | null): void;
+    setAuthorization(accessToken: string | null): VerdocsEndpoint;
     /**
      * Set the auth token used for signing sessions. Separating user from signing auth allows the same endpoint to be
      * used for multiple operations, although it is recommended that a separate endpoint be created for each operation.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
      *
-     * const endpoint = new Endpoint();
+     * const endpoint = new VerdocsEndpoint();
      * endpoint.setSigningAuthorization(accessToken);
      * ```
      */
-    setSigningAuthorization(accessToken: string | null): void;
+    setSigningAuthorization(accessToken: string | null): VerdocsEndpoint;
     /**
      * Set the base URL for API calls. May also be set via the constructor.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
      *
-     * const endpoint = new Endpoint();
+     * const endpoint = new VerdocsEndpoint();
      * endpoint.setBaseURL('https://api.verdocs.com');
      * ```
      */
-    setBaseURL(url: string): void;
+    setBaseURL(url: string): VerdocsEndpoint;
     /**
      * Enable or disable request logging. This may expose sensitive data in the console log, so it should only be used for debugging.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
      *
-     * const endpoint = new Endpoint();
+     * const endpoint = new VerdocsEndpoint();
      * endpoint.logRequests(true);
      * ```
      */
-    logRequests(enable: boolean): void;
+    logRequests(enable: boolean): VerdocsEndpoint;
 }

package/HTTP/VerdocsEndpoint.js

@@ -5,12 +5,24 @@
  * In that case, an Endpoint can be created and authenticated, used for calls related to signing operations, then
  * discarded once signing is complete.
  *
+ * Note that endpoint configuration functions return the instance, so they can be chained, e.g.
+ *
+ * ```typescript
+ * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
+ *
+ * const endpoint = new VerdocsEndpoint();
+ * endpoint
+ *     .logRequests(true)
+ *     .setClientID('1234)
+ *     .setTimeout(5000);
+ * ```
+ *
  * @module
  */
 import axios from 'axios';
 var requestLogger = function (r) {
     // tslint:disable-next-line
-    console.log("[JS-SDK] ".concat(r.method.toUpperCase(), " ").concat(r.baseURL).concat(r.url), r.data ? JSON.stringify(r.data) : '');
+    console.debug("[JS-SDK] ".concat(r.method.toUpperCase(), " ").concat(r.baseURL).concat(r.url), r.data ? JSON.stringify(r.data) : '');
     return r;
 };
 var VerdocsEndpoint = /** @class */ (function () {
@@ -18,7 +30,7 @@ var VerdocsEndpoint = /** @class */ (function () {
      * Create a new Endpoint to call Verdocs services.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
      *
      * console.log('Current timeout', Transport.getEndpoint().defaults.timeout);
      * ```
@@ -35,85 +47,90 @@ var VerdocsEndpoint = /** @class */ (function () {
      * Set the timeout for API calls in milliseconds. 2000-4000ms is recommended for most purposes. 3000ms is the default.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
      *
-     * const endpoint = new Endpoint();
+     * const endpoint = new VerdocsEndpoint();
      * endpoint.setTimeout(3000);
      * ```
      */
     VerdocsEndpoint.prototype.setTimeout = function (timeout) {
         this.api.defaults.timeout = timeout;
+        return this;
     };
     /**
      * Set the Client ID for Verdocs API calls.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
      *
-     * const endpoint = new Endpoint();
+     * const endpoint = new VerdocsEndpoint();
      * endpoint.setClientID('1234);
      * ```
      */
     VerdocsEndpoint.prototype.setClientID = function (clientID) {
-        this.api.defaults.headers['X-Client-ID'] = clientID;
+        this.api.defaults.headers.common['X-Client-ID'] = clientID;
+        return this;
     };
     /**
      * Set the auth token that will be used for Verdocs API calls.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
      *
-     * const endpoint = new Endpoint();
+     * const endpoint = new VerdocsEndpoint();
      * endpoint.setAuthorization(accessToken);
      * ```
      */
     VerdocsEndpoint.prototype.setAuthorization = function (accessToken) {
         if (accessToken) {
-            this.api.defaults.headers.Authorization = "Bearer ".concat(accessToken);
+            this.api.defaults.headers.common.Authorization = "Bearer ".concat(accessToken);
         }
         else {
-            delete this.api.defaults.headers.Authorization;
+            delete this.api.defaults.headers.common.Authorization;
         }
+        return this;
     };
     /**
      * Set the auth token used for signing sessions. Separating user from signing auth allows the same endpoint to be
      * used for multiple operations, although it is recommended that a separate endpoint be created for each operation.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
      *
-     * const endpoint = new Endpoint();
+     * const endpoint = new VerdocsEndpoint();
      * endpoint.setSigningAuthorization(accessToken);
      * ```
      */
     VerdocsEndpoint.prototype.setSigningAuthorization = function (accessToken) {
         if (accessToken) {
-            this.api.defaults.headers.signer = "Bearer ".concat(accessToken);
+            this.api.defaults.headers.common.signer = "Bearer ".concat(accessToken);
         }
         else {
-            delete this.api.defaults.headers.signer;
+            delete this.api.defaults.headers.common.signer;
         }
+        return this;
     };
     /**
      * Set the base URL for API calls. May also be set via the constructor.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
      *
-     * const endpoint = new Endpoint();
+     * const endpoint = new VerdocsEndpoint();
      * endpoint.setBaseURL('https://api.verdocs.com');
      * ```
      */
     VerdocsEndpoint.prototype.setBaseURL = function (url) {
         this.api.defaults.baseURL = url;
+        return this;
     };
     /**
      * Enable or disable request logging. This may expose sensitive data in the console log, so it should only be used for debugging.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
      *
-     * const endpoint = new Endpoint();
+     * const endpoint = new VerdocsEndpoint();
      * endpoint.logRequests(true);
      * ```
      */
@@ -124,6 +141,7 @@ var VerdocsEndpoint = /** @class */ (function () {
         else if (!enable && this.requestLoggerId !== null) {
             this.api.interceptors.request.eject(this.requestLoggerId);
         }
+        return this;
     };
     return VerdocsEndpoint;
 }());

package/Templates/Fields.d.ts

@@ -1,4 +1,13 @@
 import { ITemplateField } from './Types';
+/**
+ * Add a field to a template.
+ */
 export declare const createField: (templateId: string, params: ITemplateField) => Promise<ITemplateField>;
+/**
+ * Update a template field.
+ */
 export declare const editField: (templateId: string, fieldName: string, params: ITemplateField) => Promise<ITemplateField>;
+/**
+ * REmove a field from a template.
+ */
 export declare const deleteField: (templateId: string, fieldName: string) => Promise<any>;

package/Templates/Fields.js

@@ -1,14 +1,23 @@
 import { getEndpoint } from '../HTTP/Transport';
+/**
+ * Add a field to a template.
+ */
 export var createField = function (templateId, params) {
     return getEndpoint()
         .api.post("/templates/".concat(templateId, "/pages/"), params)
         .then(function (r) { return r.data; });
 };
+/**
+ * Update a template field.
+ */
 export var editField = function (templateId, fieldName, params) {
     return getEndpoint()
         .api.put("/templates/".concat(templateId, "/pages/").concat(fieldName), params)
         .then(function (r) { return r.data; });
 };
+/**
+ * REmove a field from a template.
+ */
 export var deleteField = function (templateId, fieldName) {
     return getEndpoint()
         .api.delete("/templates/".concat(templateId, "/pages/").concat(fieldName))

package/Templates/Pages.d.ts

@@ -1,5 +1,17 @@
 import { IPage } from './Types';
+/**
+ * Add a page to a template
+ */
 export declare const createPage: (templateId: string, params: IPage) => Promise<IPage>;
+/**
+ * Update a template page.
+ */
 export declare const editPage: (templateId: string, sequence: string) => Promise<any>;
+/**
+ * Get a page from a template.
+ */
 export declare const getPage: (templateId: string, sequence: string) => Promise<any>;
+/**
+ * Delete a page from a template
+ */
 export declare const deletePage: (templateId: string, sequence: string) => Promise<any>;

package/Templates/Pages.js

@@ -1,19 +1,31 @@
 import { getEndpoint } from '../HTTP/Transport';
+/**
+ * Add a page to a template
+ */
 export var createPage = function (templateId, params) {
     return getEndpoint()
         .api.post("/templates/".concat(templateId, "/pages/"), params)
         .then(function (r) { return r.data; });
 };
+/**
+ * Update a template page.
+ */
 export var editPage = function (templateId, sequence) {
     return getEndpoint()
         .api.put("/templates/".concat(templateId, "/pages/").concat(sequence))
         .then(function (r) { return r.data; });
 };
+/**
+ * Get a page from a template.
+ */
 export var getPage = function (templateId, sequence) {
     return getEndpoint()
         .api.get("/templates/".concat(templateId, "/pages/").concat(sequence))
         .then(function (r) { return r.data; });
 };
+/**
+ * Delete a page from a template
+ */
 export var deletePage = function (templateId, sequence) {
     return getEndpoint()
         .api.delete("/templates/".concat(templateId, "/pages/").concat(sequence))

package/Templates/Roles.d.ts

@@ -1,4 +1,11 @@
 import { ITemplateField, IRole } from './Types';
+/**
+ * A "role" is an individual participant in a signing flow, such as a signer or CC contact. Roles are identified by
+ * their names, which must be unique (e.g. 'Recipient 1'). Template fields are assigned to roles for signing operations,
+ * so you may have 'Recipient 1 Signature 1' and so forth.
+ *
+ * @module
+ */
 export declare const createRole: (templateId: string, params: IRole) => Promise<IRole>;
 export declare const getRoles: (templateId: string) => Promise<IRole[]>;
 export declare const getRole: (templateId: string, roleName: string) => Promise<IRole>;

package/Templates/Roles.js

@@ -1,4 +1,11 @@
 import { getEndpoint } from '../HTTP/Transport';
+/**
+ * A "role" is an individual participant in a signing flow, such as a signer or CC contact. Roles are identified by
+ * their names, which must be unique (e.g. 'Recipient 1'). Template fields are assigned to roles for signing operations,
+ * so you may have 'Recipient 1 Signature 1' and so forth.
+ *
+ * @module
+ */
 export var createRole = function (templateId, params) {
     return getEndpoint()
         .api.post("/templates/".concat(templateId, "/roles/"), params)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "1.1.17",
+  "version": "1.2.0",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Verdocs JS SDK",
@@ -44,7 +44,7 @@
     "access": "public"
   },
   "dependencies": {
-    "axios": "^0.21.1"
+    "axios": "^0.25.0"
   },
   "peerDependencies": {
     "typescript": "4.2.x || 4.3.x || 4.4.x || 4.5.x"