@verdocs/js-sdk 3.0.24 → 3.0.26

package/Envelopes/Types.d.ts

@@ -106,12 +106,17 @@ export interface IRecipient {
     profile_id: string;
     role_name: string;
     /**
-     * The sequence number indicates the order in which recipients act. Note that it is the workflow "level" not the
-     * recipient's individual index in the list. There may be multiple recipients with the same sequence. Recipients
-     * with the same sequence number may act independently, in parallel to each other (co-signers), as long as all
-     * Recipients with an earlier sequence number have completed their tasks.
+     * 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
+     * all Recipients at sequence 1 have signed.)
      */
     sequence: number;
+    /**
+     * The order indicates the order in which recipients are listed in a single "level" of the workflow. Note that
+     * recipients at the same level may act in parallel despite this value. However, it can often be useful to visually
+     * arrange recipients to match related business processes so this field allows for that.
+     */
+    order: number;
     status: TRecipientStatus;
     type: TRecipientType;
     updated_at: string;

package/Templates/Fields.js

@@ -3,7 +3,6 @@
  */
 export var createField = function (endpoint, templateId, params) {
     return endpoint.api //
-        // curl -X POST 'https://api.verdocs.com/templates/d2338742-f3a1-465b-8592-806587413cc1/fields' \
         .post("/templates/".concat(templateId, "/fields"), params)
         .then(function (r) { return r.data; });
 };

package/Templates/Reminders.d.ts

@@ -1,6 +1,10 @@
-import { IReminder, ITemplate } from './Types';
 import { VerdocsEndpoint } from '../VerdocsEndpoint';
-export declare const createReminder: (endpoint: VerdocsEndpoint, templateId: string, params: any) => Promise<ITemplate>;
+import { IReminder, ITemplate } from './Types';
+export interface ICreateTemplateReminderRequest {
+    setup_time: number;
+    interval_time: number;
+}
+export declare const createReminder: (endpoint: VerdocsEndpoint, templateId: string, params: ICreateTemplateReminderRequest) => Promise<ITemplate>;
 export declare const getReminder: (endpoint: VerdocsEndpoint, templateId: string, reminderId: string) => Promise<IReminder>;
-export declare const editReminder: (endpoint: VerdocsEndpoint, templateId: string, reminderId: string) => Promise<IReminder>;
+export declare const updateReminder: (endpoint: VerdocsEndpoint, templateId: string, reminderId: string, params: ICreateTemplateReminderRequest) => Promise<IReminder>;
 export declare const deleteReminder: (endpoint: VerdocsEndpoint, templateId: string, reminderId: string) => Promise<any>;

package/Templates/Reminders.js

@@ -8,9 +8,9 @@ export var getReminder = function (endpoint, templateId, reminderId) {
         .get("/templates/".concat(templateId, "/reminder/").concat(reminderId))
         .then(function (r) { return r.data; });
 };
-export var editReminder = function (endpoint, templateId, reminderId) {
+export var updateReminder = function (endpoint, templateId, reminderId, params) {
     return endpoint.api //
-        .put("/templates/".concat(templateId, "/reminder/").concat(reminderId))
+        .put("/templates/".concat(templateId, "/reminder/").concat(reminderId), params)
         .then(function (r) { return r.data; });
 };
 export var deleteReminder = function (endpoint, templateId, reminderId) {

package/Templates/Types.d.ts

@@ -1,4 +1,5 @@
 import { IOrganization } from '../Organizations/Types';
+import { TRecipientType } from '../Envelopes/Types';
 /**
  * A reusable template for creating signable instruments. Templates are used to create Envelopes which contain
  * Documents to sign.
@@ -201,15 +202,29 @@ export interface IStar {
     profile_id: string;
 }
 /**
- * An individual recipient, CC, or other party in a signing flow.
+ * A placeholder for an individual recipient, CC, or other party in a signing flow. Roles may be "known" or "unknown."
+ * "Known" roles will have their email address supplied in the template which will get copied to envelopes created from
+ * it. This is used when a certain party will always be the same, e.g. a leasing agent counter-signing a lease.
+ * "Unknown" roles are dynamic, and will be filled in later when the envelope is created.
  */
 export interface IRole {
     template_id: string;
     name: string;
     full_name?: string;
     email?: string;
-    type: string;
+    type: TRecipientType;
+    /**
+     * The sequence number indicates the order in which Roles act. Multiple roles may have the same sequence
+     * number, in which case they may act in parallel. (e.g. all Roles at sequence 2 will receive invites once
+     * all Recipients at sequence 1 have signed.)
+     */
     sequence: number;
+    /**
+     * The order indicates the order in which recipients are listed in a single "level" of the workflow. Note that
+     * recipients at the same level may act in parallel despite this value. However, it can often be useful to visually
+     * arrange recipients to match related business processes so this field allows for that.
+     */
+    order: number;
     fields?: ITemplateField[];
     delegator?: boolean;
     message?: string;

package/package.json

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