@verdocs/js-sdk 3.6.5 → 3.6.7

package/Envelopes/Envelopes.d.ts

@@ -69,6 +69,8 @@ export interface IEnvelopeSearchParams {
     recipient_name?: string;
     /** At least one of the envelope's recipients must match the specified email address. */
     recipient_email?: string;
+    /** Match against envelope_name, recipient_name, or recipient_email all at once. */
+    name?: string;
     /** At least one of the envelope's recipients must match the specified ID. */
     recipient_id?: string;
     /** The date-range in which the envelope was created. Values should be specified in ISO8601 "UTC" format. */

package/Envelopes/Reminders.d.ts

@@ -0,0 +1,23 @@
+import { VerdocsEndpoint } from '../VerdocsEndpoint';
+import { IReminder } from '../Templates/Types';
+export interface ICreateEnvelopeReminderRequest {
+    setup_time: number;
+    interval_time: number;
+}
+/**
+ * Enable automatic reminders. setup_time is the number of days after the envelope is sent that the first reminder
+ * should be sent. interval_time is the number of days between reminders.
+ */
+export declare const createReminder: (endpoint: VerdocsEndpoint, envelopeId: string, params: ICreateEnvelopeReminderRequest) => Promise<IReminder>;
+/**
+ * Get the reminder configuration for an envelope.
+ */
+export declare const getReminder: (endpoint: VerdocsEndpoint, envelopeId: string, reminderId: string) => Promise<IReminder>;
+/**
+ * Update the reminder configuration for an envelope.
+ */
+export declare const updateReminder: (endpoint: VerdocsEndpoint, envelopeId: string, reminderId: string, params: ICreateEnvelopeReminderRequest) => Promise<IReminder>;
+/**
+ * Delete the reminder configuration for an envelope.
+ */
+export declare const deleteReminder: (endpoint: VerdocsEndpoint, envelopeId: string, reminderId: string) => Promise<any>;

package/Envelopes/Reminders.js

@@ -0,0 +1,33 @@
+/**
+ * Enable automatic reminders. setup_time is the number of days after the envelope is sent that the first reminder
+ * should be sent. interval_time is the number of days between reminders.
+ */
+export var createReminder = function (endpoint, envelopeId, params) {
+    return endpoint.api //
+        .post("/envelopes/".concat(envelopeId, "/reminder/"), params)
+        .then(function (r) { return r.data; });
+};
+/**
+ * Get the reminder configuration for an envelope.
+ */
+export var getReminder = function (endpoint, envelopeId, reminderId) {
+    return endpoint.api //
+        .get("/envelopes/".concat(envelopeId, "/reminder/").concat(reminderId))
+        .then(function (r) { return r.data; });
+};
+/**
+ * Update the reminder configuration for an envelope.
+ */
+export var updateReminder = function (endpoint, envelopeId, reminderId, params) {
+    return endpoint.api //
+        .put("/envelopes/".concat(envelopeId, "/reminder/").concat(reminderId), params)
+        .then(function (r) { return r.data; });
+};
+/**
+ * Delete the reminder configuration for an envelope.
+ */
+export var deleteReminder = function (endpoint, envelopeId, reminderId) {
+    return endpoint.api //
+        .delete("/envelopes/".concat(envelopeId, "/reminder/").concat(reminderId))
+        .then(function (r) { return r.data; });
+};

package/Envelopes/index.d.ts

@@ -1,6 +1,7 @@
 export * as Envelopes from './Envelopes';
 export * as Permissions from './Permissions';
 export * as Recipients from './Recipients';
+export * as Reminders from './Reminders';
 export * as Signatures from './Signatures';
 export * as Initials from './Initials';
 export * as Types from './Types';

package/Envelopes/index.js

@@ -1,6 +1,7 @@
 export * as Envelopes from './Envelopes';
 export * as Permissions from './Permissions';
 export * as Recipients from './Recipients';
+export * as Reminders from './Reminders';
 export * as Signatures from './Signatures';
 export * as Initials from './Initials';
 export * as Types from './Types';

package/Templates/Reminders.d.ts

@@ -4,7 +4,20 @@ export interface ICreateTemplateReminderRequest {
     setup_time: number;
     interval_time: number;
 }
+/**
+ * Enable automatic reminders. setup_time is the number of days after the envelope is sent that the first reminder
+ * should be sent. interval_time is the number of days between reminders.
+ */
 export declare const createReminder: (endpoint: VerdocsEndpoint, templateId: string, params: ICreateTemplateReminderRequest) => Promise<ITemplate>;
+/**
+ * Get the reminder configuration for a template.
+ */
 export declare const getReminder: (endpoint: VerdocsEndpoint, templateId: string, reminderId: string) => Promise<IReminder>;
+/**
+ * Update the reminder configuration for a template.
+ */
 export declare const updateReminder: (endpoint: VerdocsEndpoint, templateId: string, reminderId: string, params: ICreateTemplateReminderRequest) => Promise<IReminder>;
+/**
+ * Delete the reminder configuration for a template.
+ */
 export declare const deleteReminder: (endpoint: VerdocsEndpoint, templateId: string, reminderId: string) => Promise<any>;

package/Templates/Reminders.js

@@ -1,18 +1,31 @@
+/**
+ * Enable automatic reminders. setup_time is the number of days after the envelope is sent that the first reminder
+ * should be sent. interval_time is the number of days between reminders.
+ */
 export var createReminder = function (endpoint, templateId, params) {
     return endpoint.api //
         .post("/templates/".concat(templateId, "/reminder/"), params)
         .then(function (r) { return r.data; });
 };
+/**
+ * Get the reminder configuration for a template.
+ */
 export var getReminder = function (endpoint, templateId, reminderId) {
     return endpoint.api //
         .get("/templates/".concat(templateId, "/reminder/").concat(reminderId))
         .then(function (r) { return r.data; });
 };
+/**
+ * Update the reminder configuration for a template.
+ */
 export var updateReminder = function (endpoint, templateId, reminderId, params) {
     return endpoint.api //
         .put("/templates/".concat(templateId, "/reminder/").concat(reminderId), params)
         .then(function (r) { return r.data; });
 };
+/**
+ * Delete the reminder configuration for a template.
+ */
 export var deleteReminder = function (endpoint, templateId, reminderId) {
     return endpoint.api //
         .delete("/templates/".concat(templateId, "/reminder/").concat(reminderId))

package/Templates/Templates.d.ts

@@ -142,6 +142,7 @@ export interface ISearchTimeRange {
     start_time: string;
     end_time: string;
 }
+export type IGetTemplateSummarySortBy = 'created_at' | 'updated_at' | 'name' | 'last_used_at' | 'counter' | 'star_counter';
 export interface IGetTemplateSummaryParams {
     id?: string;
     name?: string;
@@ -154,7 +155,7 @@ export interface IGetTemplateSummaryParams {
     last_used_at?: ISearchTimeRange;
     is_personal?: boolean;
     is_public?: boolean;
-    sort_by?: 'created_at' | 'updated_at' | 'name' | 'last_used_at' | 'counter' | 'star_counter';
+    sort_by?: IGetTemplateSummarySortBy;
     ascending?: boolean;
     row?: number;
     page?: number;

package/package.json

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