@verdocs/js-sdk 3.0.39 → 3.1.1

package/Envelopes/Envelopes.d.ts

@@ -1,4 +1,4 @@
-import { IEnvelope, IEnvelopesSummary, IRecipient, ISigningSession, TEnvelopeUpdateResult, IDocumentFieldSettings, IEnvelopeDocument } from './Types';
+import { IEnvelope, IEnvelopesSummary, IRecipient, ISigningSession, TEnvelopeUpdateResult, IDocumentFieldSettings, IEnvelopeDocument, TEnvelopeStatus, TRecipientStatus } from './Types';
 import { ICreateEnvelopeRole, IEnvelopesSearchResult, ISigningSessionRequest } from './Types';
 import { VerdocsEndpoint } from '../VerdocsEndpoint';
 export interface ICreateEnvelopeRequest {
@@ -50,6 +50,61 @@ export declare const createEnvelope: (endpoint: VerdocsEndpoint, request: ICreat
  * ```
  */
 export declare const getSummary: (endpoint: VerdocsEndpoint, page: number) => Promise<IEnvelopesSummary>;
+export interface IEnvelopeSearchParams {
+    /** The envelope must have been created via the specified template ID. */
+    template_id?: string;
+    /** The envelope must match one of the specified statuses. */
+    envelope_status?: TEnvelopeStatus[];
+    /** At least one of the recipients must match one of the specified statuses. */
+    recipient_status?: TRecipientStatus[];
+    /** The envelope's name (inherited from the template) must match the specified string. */
+    envelope_name?: string;
+    /** At least one of the envelope's recipients must match the specified name. */
+    recipient_name?: string;
+    /** At least one of the envelope's recipients must match the specified email address. */
+    recipient_email?: 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. */
+    created_at: {
+        start_time: string;
+        end_time: string;
+    };
+    /**
+     * The date-range in which the envelope was last updated. Values should be specified in ISO8601 "UTC" format.
+     * Note that any operations that alter the envelope are considered "updates", including status changes (cancellation),
+     * recipient actions (opening/signing), etc.
+     */
+    updated_at: {
+        start_time: string;
+        end_time: string;
+    };
+    /** The date-range in which the envelope was canceled. Values should be specified in ISO8601 "UTC" format. */
+    canceled_at: {
+        start_time: string;
+        end_time: string;
+    };
+    /** Perform a "contains" search where any of the attached documents' fields contains the specified value. */
+    text_field_value?: string;
+    /** Set to true to retrieve only summary records (IEnvelopeSummary). */
+    summary?: boolean;
+    /** Set to true to retrieve only those envelopes owned by the caller. */
+    is_owner?: boolean;
+    /** Set to true to retrieve only those envelopes in which the caller is one of the recipients. */
+    is_recipient?: boolean;
+    /** Whether the recipient has "claimed" the envelope. */
+    recipient_claimed?: boolean;
+    /** @deprecated. Use `limit`. */
+    row?: number;
+    /** The maximum number of records to return. Should be used in place of `row`. */
+    limit?: number;
+    /** The page number to return. Page numbers are 0-based. */
+    page?: number;
+    /** The field to sort the results by. */
+    sort_by?: 'created_at' | 'updated_at' | 'envelope_name' | 'canceled_at' | 'envelope_status';
+    /** Whether to sort in ascending (default) or descending order. */
+    ascending?: boolean;
+}
 /**
  * Search for envelopes matching various criteria.
  *
@@ -59,7 +114,7 @@ export declare const getSummary: (endpoint: VerdocsEndpoint, page: number) => Pr
  * const {result, page, total} = await Envelopes.search(VerdocsEndpoint.getDefault(), { ... });
  * ```
  */
-export declare const searchEnvelopes: (endpoint: VerdocsEndpoint, params: any) => Promise<IEnvelopesSearchResult>;
+export declare const searchEnvelopes: (endpoint: VerdocsEndpoint, params: IEnvelopeSearchParams) => Promise<IEnvelopesSearchResult>;
 export interface ISigningSessionResult {
     recipient: IRecipient;
     session: ISigningSession;
@@ -132,3 +187,9 @@ export declare const getFieldAttachment: (endpoint: VerdocsEndpoint, envelopeId:
  * @deprecated
  */
 export declare const getEnvelopesByTemplateId: (endpoint: VerdocsEndpoint, templateId: string) => Promise<IEnvelope[]>;
+/**
+ * Get a display URI for a given page in a file attached to an envelope document. These pages are rendered server-side
+ * into PNG resources suitable for display in IMG tags although they may be used elsewhere. Note that these are intended
+ * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants.
+ */
+export declare const getEnvelopeDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, envelopeId: string, documentId: string, page: number) => Promise<string>;

package/Envelopes/Envelopes.js

@@ -250,3 +250,11 @@ export var getEnvelopesByTemplateId = function (endpoint, templateId) { return _
                 .then(function (r) { return r.data; })];
     });
 }); };
+/**
+ * Get a display URI for a given page in a file attached to an envelope document. These pages are rendered server-side
+ * into PNG resources suitable for display in IMG tags although they may be used elsewhere. Note that these are intended
+ * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants.
+ */
+export var getEnvelopeDocumentPageDisplayUri = function (endpoint, envelopeId, documentId, page) { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+    return [2 /*return*/, endpoint.api.get("/envelopes/".concat(envelopeId, "/envelope_documents/").concat(documentId, "/pages/").concat(page, "/image")).then(function (r) { return r.data; })];
+}); }); };

package/Templates/TemplateDocuments.d.ts

@@ -59,8 +59,8 @@ export declare const getTemplateDocumentFile: (endpoint: VerdocsEndpoint, templa
 export declare const getTemplateDocumentThumbnail: (endpoint: VerdocsEndpoint, templateId: string, documentId: string) => Promise<any>;
 /**
  * Get a display URI for a given page in a file attached to a template document. These pages are rendered server-side
- * into PNG resources suitable for display in IMG tags although they may be used elsewhere. Note that these are
- * intended for DISPLAY ONLY, and do not contain any encoded metadata from participants. The original asset may be
- * obtained by calling `getTemplateDocumentFile()` or similar.
+ * into PNG resources suitable for display in IMG tags although they may be used elsewhere. Note that these are intended
+ * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants. The
+ * original asset may be obtained by calling `getTemplateDocumentFile()` or similar.
  */
 export declare const getTemplateDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, templateId: string, documentId: string, page: number) => Promise<string>;

package/Templates/TemplateDocuments.js

@@ -130,9 +130,9 @@ export var getTemplateDocumentThumbnail = function (endpoint, templateId, docume
 }); };
 /**
  * Get a display URI for a given page in a file attached to a template document. These pages are rendered server-side
- * into PNG resources suitable for display in IMG tags although they may be used elsewhere. Note that these are
- * intended for DISPLAY ONLY, and do not contain any encoded metadata from participants. The original asset may be
- * obtained by calling `getTemplateDocumentFile()` or similar.
+ * into PNG resources suitable for display in IMG tags although they may be used elsewhere. Note that these are intended
+ * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants. The
+ * original asset may be obtained by calling `getTemplateDocumentFile()` or similar.
  */
 export var getTemplateDocumentPageDisplayUri = function (endpoint, templateId, documentId, page) { 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, "/pages/").concat(page, "/image")).then(function (r) { return r.data; })];

package/Templates/Types.d.ts

@@ -266,9 +266,19 @@ export interface ITemplateField {
     validator?: string;
     label?: string;
 }
-export interface ITemplateFieldSetting {
+export interface ITextFieldSetting {
     x: number;
     y: number;
+    width: number;
+    height: number;
+    result: string;
+    leading: number;
+    alignment: number;
+    upperCase: boolean;
+}
+export interface ITemplateFieldSetting {
+    x?: number;
+    y?: number;
     result?: string;
     width?: number;
     height?: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "3.0.39",
+  "version": "3.1.1",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Verdocs JS SDK",
@@ -46,21 +46,21 @@
     "access": "public"
   },
   "dependencies": {
-    "axios": "^1.3.3"
+    "axios": "^1.3.4"
   },
   "peerDependencies": {
     "typescript": "^4.7.3"
   },
   "devDependencies": {
-    "@jest/globals": "^29.4.1",
+    "@jest/globals": "^29.5.0",
     "@types/jest": "^29.4.0",
     "axios-mock-adapter": "^1.21.2",
-    "jest": "^29.4.1",
-    "prettier": "^2.8.3",
+    "jest": "^29.5.0",
+    "prettier": "^2.8.4",
     "ts-jest": "^29.0.5",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
-    "typedoc": "^0.23.25",
+    "typedoc": "^0.23.26",
     "typedoc-plugin-markdown": "^3.14.0",
     "typescript": "^4.9.5"
   }