@verdocs/js-sdk 3.0.33 → 3.0.36

package/Envelopes/Envelopes.d.ts

@@ -5,6 +5,7 @@ export interface ICreateEnvelopeRequest {
     template_id: string;
     roles: ICreateEnvelopeRole[];
     name: string;
+    environment?: string;
 }
 /**
  * Create an envelope
@@ -120,3 +121,14 @@ export declare const updateEnvelopeFieldSignature: (endpoint: VerdocsEndpoint, e
  * signature for a Recipient, then call `Documents.updateDocumentFieldSignature()` to attach it to a field.
  */
 export declare const updateEnvelopeFieldInitials: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string, initialId: string) => Promise<IDocumentFieldSettings>;
+/**
+ * Get the attached file for an attachment field (if any)
+ */
+export declare const getFieldAttachment: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string) => Promise<any>;
+/**
+ * Get all of the envelopes that were sent using a given template.
+ * NOTE: This endpoint will be retired soon. Its response is not paginated and it is typically used only to retrieve
+ * "submitted data" for a template. A new endpoint will be introduced to provide this function more directly.
+ * @deprecated
+ */
+export declare const getEnvelopesByTemplateId: (endpoint: VerdocsEndpoint, templateId: string) => Promise<IEnvelope[]>;

package/Envelopes/Envelopes.js

@@ -227,3 +227,26 @@ export var updateEnvelopeFieldInitials = function (endpoint, envelopeId, fieldNa
                 .then(function (r) { return r.data; })];
     });
 }); };
+/**
+ * Get the attached file for an attachment field (if any)
+ */
+export var getFieldAttachment = function (endpoint, envelopeId, fieldName) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, endpoint.api //
+                .get("/envelopes/".concat(envelopeId, "/fields/").concat(fieldName, "/document"), { responseType: 'blob' })
+                .then(function (r) { return r.data; })];
+    });
+}); };
+/**
+ * Get all of the envelopes that were sent using a given template.
+ * NOTE: This endpoint will be retired soon. Its response is not paginated and it is typically used only to retrieve
+ * "submitted data" for a template. A new endpoint will be introduced to provide this function more directly.
+ * @deprecated
+ */
+export var getEnvelopesByTemplateId = function (endpoint, templateId) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, endpoint.api //
+                .get("/envelopes?template_id=".concat(templateId))
+                .then(function (r) { return r.data; })];
+    });
+}); };

package/Envelopes/Recipients.d.ts

@@ -62,5 +62,22 @@ export interface ISignerTokenResponse {
     signerToken: string;
     inPersonAccessKey: IInPersonAccessKey;
 }
+/**
+ * Get a signing token.
+ */
 export declare const getSignerToken: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<ISignerTokenResponse>;
-export declare const getInPersonLink: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<ISignerTokenResponse>;
+export interface IInPersonLinkResponse {
+    link: string;
+}
+/**
+ * Get an in-person signing link.
+ */
+export declare const getInPersonLink: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<IInPersonLinkResponse>;
+/**
+ * Send a delegation request.
+ */
+export declare const sendDelegate: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<IEnvelope>;
+/**
+ * Resend a recipient's invitation.
+ */
+export declare const resendInvitation: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<any>;

package/Envelopes/Recipients.js

@@ -78,13 +78,35 @@ export var envelopeRecipientUpdateName = function (endpoint, envelopeId, roleNam
 export var envelopeRecipientPrepare = function (endpoint, envelopeId, roleName, recipients) {
     return updateRecipient(endpoint, envelopeId, roleName, { action: 'prepare', recipients: recipients });
 };
+/**
+ * Get a signing token.
+ */
 export var getSignerToken = function (endpoint, envelopeId, roleName) {
     return endpoint.api //
         .get("/envelopes/".concat(envelopeId, "/recipients/").concat(encodeURIComponent(roleName), "/signer-token"))
         .then(function (r) { return r.data; });
 };
+/**
+ * Get an in-person signing link.
+ */
 export var getInPersonLink = function (endpoint, envelopeId, roleName) {
     return endpoint.api //
         .get("/envelopes/".concat(envelopeId, "/recipients/").concat(encodeURIComponent(roleName), "?in_person_link=true"))
         .then(function (r) { return r.data; });
 };
+/**
+ * Send a delegation request.
+ */
+export var sendDelegate = function (endpoint, envelopeId, roleName) {
+    return endpoint.api //
+        .post("/envelopes/".concat(envelopeId, "/recipients/").concat(encodeURIComponent(roleName), "/delegate"))
+        .then(function (r) { return r.data; });
+};
+/**
+ * Resend a recipient's invitation.
+ */
+export var resendInvitation = function (endpoint, envelopeId, roleName) {
+    return endpoint.api //
+        .post("/envelopes/".concat(envelopeId, "/recipients/").concat(encodeURIComponent(roleName), "/resend_invitation"))
+        .then(function (r) { return r.data; });
+};

package/Envelopes/Types.d.ts

@@ -91,20 +91,21 @@ export interface IEnvelopesSummary {
     };
 }
 export interface IRecipient {
+    envelope_id: string;
+    role_name: string;
     agreed: boolean;
     claimed: boolean;
     created_at: string;
     delegated_to: string | null;
     delegator: boolean;
     email: string;
-    envelope_id: string;
     full_name: string;
     in_app_access_key?: string;
     key_used_to_conclude?: string;
     message: string | null;
     phone: string | null;
     profile_id: string;
-    role_name: string;
+    environment: string;
     /**
      * The sequence number indicates the order in which Recipients act. Multiple recipients may have the same sequence
      * number, in which case they may act in parallel. (e.g. all Recipients at sequence 2 will receive invites once

package/package.json

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