@verdocs/js-sdk 2.0.17 → 2.0.18

package/Documents/Documents.d.ts

@@ -93,7 +93,9 @@ export declare const recipientCanAct: (recipient: IRecipient, recipientsWithActi
  */
 export declare const userCanAct: (email: string, recipientsWithActions: IRecipient[]) => boolean | undefined;
 /**
- * Get (binary download) a file attached to a Document.
+ * Get (binary download) a file attached to a Document. It is important to use this method
+ * rather than a direct A HREF or similar link to set the authorization headers for the
+ * request.
  */
 export declare const getDocumentFile: (endpoint: VerdocsEndpoint, documentId: string, envelopeDocumentId: string) => Promise<string>;
 /**

package/Documents/Documents.js

@@ -174,7 +174,9 @@ export var userCanAct = function (email, recipientsWithActions) {
     return recipient && recipient.sequence === ((_a = recipientsWithActions === null || recipientsWithActions === void 0 ? void 0 : recipientsWithActions[0]) === null || _a === void 0 ? void 0 : _a.sequence);
 };
 /**
- * Get (binary download) a file attached to a Document.
+ * Get (binary download) a file attached to a Document. It is important to use this method
+ * rather than a direct A HREF or similar link to set the authorization headers for the
+ * request.
  */
 export var getDocumentFile = function (endpoint, documentId, envelopeDocumentId) { return __awaiter(void 0, void 0, void 0, function () {
     return __generator(this, function (_a) {

package/Documents/Recipients.d.ts

@@ -8,7 +8,7 @@ export interface IUpdateRecipientParams {
 /**
  * Update a recipient's status block
  */
-export declare const updateRecipientStatus: (endpoint: VerdocsEndpoint, documentId: string, roleName: string, action: TRecipientAction, params?: IUpdateRecipientParams) => Promise<IRecipient>;
+export declare const updateRecipientStatus: (endpoint: VerdocsEndpoint, documentId: string, roleName: string, action: TRecipientAction, params?: IUpdateRecipientParams | undefined) => Promise<IRecipient>;
 export interface ISignerTokenResponse {
     recipient: IRecipient;
     envelope: IDocument;

package/Organizations/Groups.d.ts

@@ -28,7 +28,7 @@ export declare const getGroups: (endpoint: VerdocsEndpoint, organizationId: stri
  * const groups = await Groups.getGroups(ORGID);
  * ```
  */
-export declare const getGroupByName: (endpoint: VerdocsEndpoint, organizationId: string, name?: string) => Promise<IGroupDetail>;
+export declare const getGroupByName: (endpoint: VerdocsEndpoint, organizationId: string, name?: string | undefined) => Promise<IGroupDetail>;
 /**
  * Get the details for a group.
  *

package/Templates/TemplateDocuments.d.ts

@@ -45,3 +45,15 @@ export declare const getTemplateDocument: (endpoint: VerdocsEndpoint, templateId
  * ```
  */
 export declare const deleteTemplateDocument: (endpoint: VerdocsEndpoint, templateId: string, documentId: string) => Promise<any>;
+/**
+ * Get (binary download) a file attached to a Template. It is important to use this method
+ * rather than a direct A HREF or similar link to set the authorization headers for the
+ * request.
+ */
+export declare const getTemplateDocumentFile: (endpoint: VerdocsEndpoint, templateId: string, documentId: string) => Promise<string>;
+/**
+ * Get (binary download) a file attached to a Template. It is important to use this method
+ * rather than a direct A HREF or similar link to set the authorization headers for the
+ * request.
+ */
+export declare const getTemplateDocumentThumbnail: (endpoint: VerdocsEndpoint, templateId: string, documentId: string) => Promise<string>;

package/Templates/TemplateDocuments.js

@@ -3,6 +3,42 @@
  *
  * @module
  */
+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());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
 /**
  * Get all the Template Documents associated to a particular Template.
  *
@@ -59,3 +95,31 @@ export var deleteTemplateDocument = function (endpoint, templateId, documentId)
         .delete("/templates/".concat(templateId, "/documents/").concat(documentId))
         .then(function (r) { return r.data; });
 };
+/**
+ * Get (binary download) a file attached to a Template. It is important to use this method
+ * rather than a direct A HREF or similar link to set the authorization headers for the
+ * request.
+ */
+export var getTemplateDocumentFile = function (endpoint, templateId, documentId) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, endpoint.api //
+                .get("/templates/".concat(templateId, "/documents/").concat(documentId, "?file=true"), {
+                responseType: 'arraybuffer',
+            })
+                .then(function (r) { return Buffer.from(r.data, 'binary').toString('base64'); })];
+    });
+}); };
+/**
+ * Get (binary download) a file attached to a Template. It is important to use this method
+ * rather than a direct A HREF or similar link to set the authorization headers for the
+ * request.
+ */
+export var getTemplateDocumentThumbnail = function (endpoint, templateId, documentId) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, endpoint.api //
+                .get("/templates/".concat(templateId, "/documents/").concat(documentId, "?thumbnail=true"), {
+                responseType: 'arraybuffer',
+            })
+                .then(function (r) { return Buffer.from(r.data, 'binary').toString('base64'); })];
+    });
+}); };

package/Templates/Templates.d.ts

@@ -23,7 +23,7 @@ export interface IGetTemplatesParams {
  * await Templates.getTemplates({ is_organization: true });
  * ```
  */
-export declare const getTemplates: (endpoint: VerdocsEndpoint, params?: IGetTemplatesParams) => Promise<ITemplate[]>;
+export declare const getTemplates: (endpoint: VerdocsEndpoint, params?: IGetTemplatesParams | undefined) => Promise<ITemplate[]>;
 /**
  * Get one template by its ID.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "2.0.17",
+  "version": "2.0.18",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Verdocs JS SDK",