@verdocs/js-sdk 2.0.14 → 2.0.16

package/Documents/Documents.d.ts

@@ -1,14 +1,47 @@
-import { IDocument, IDocumentsSearchResult, IDocumentsSummary, IRecipient, ISigningSession, ISigningSessionRequest } from './Types';
+import { ICreateDocumentRequest, IDocumentsSearchResult, ISigningSessionRequest } from './Types';
+import { IDocument, IDocumentsSummary, IRecipient, ISigningSession } from './Types';
+import { TDocumentUpdateResult, IDocumentFieldSettings } from './Types';
 import { VerdocsEndpoint } from '../VerdocsEndpoint';
-import { IFieldSetting } from '../Templates/Types';
-import { TDocumentUpdateResult } from './Types';
+/**
+ * Create a document
+ *
+ * ```typescript
+ * import {Documents, ICreateDocumentRole, ICreateDocumentRequest} from '@verdocs/js-sdk/Documents';
+ *
+ * const role1: ICreateDocumentRole = {
+ *   type: 'signer',
+ *   name: 'Seller',
+ *   full_name: 'Paige Turner',
+ *   email: 'paige.turner@nomail.com',
+ *   phone: '',
+ *   sequence: 1,
+ *   delegator: false,
+ *   message: '',
+ * };
+ *
+ * const role2: ICreateDocumentRole = {
+ *   type: 'signer',
+ *   name: 'Buyer',
+ *   full_name: 'Will Power',
+ *   email: 'will.power@nomail.com',
+ *   phone: '',
+ *   sequence: 2,
+ *   delegator: false,
+ *   message: '',
+ * };
+ *
+ * const request: ICreateDocumentRequest = {template_id: 'd2338742-f3a1-465b-8592-806587413cc1', name: 'Bill of Sale', roles: [role1, role2]};
+ * const {id, recipients} = await Documents.createDocument(VerdocsEndpoint.getDefault(), request);
+ * ```
+ */
+export declare const createDocument: (endpoint: VerdocsEndpoint, request: ICreateDocumentRequest) => Promise<IDocument>;
 /**
  * Get a summary of currently active documents.
  *
  * ```typescript
  * import {Documents} from '@verdocs/js-sdk/Documents';
  *
- * const {action_required, completed, waiting_on_others} = await Documents.getSummary();
+ * const {action_required, completed, waiting_on_others} = await Documents.getSummary(VerdocsEndpoint.getDefault());
  * ```
  */
 export declare const getSummary: (endpoint: VerdocsEndpoint, page: number) => Promise<IDocumentsSummary>;
@@ -18,7 +51,7 @@ export declare const getSummary: (endpoint: VerdocsEndpoint, page: number) => Pr
  * ```typescript
  * import {Documents} from '@verdocs/js-sdk/Documents';
  *
- * const {result, page, total} = await Documents.search({ ... });
+ * const {result, page, total} = await Documents.search(VerdocsEndpoint.getDefault(), { ... });
  * ```
  */
 export declare const searchDocuments: (endpoint: VerdocsEndpoint, params: any) => Promise<IDocumentsSearchResult>;
@@ -66,9 +99,9 @@ export declare const getDocumentFile: (endpoint: VerdocsEndpoint, documentId: st
 /**
  * Update a Document field. Typically called during the signing process as a Recipient fills in fields.
  */
-export declare const updateDocumentField: (endpoint: VerdocsEndpoint, documentId: string, fieldName: string, value: any) => Promise<IFieldSetting>;
+export declare const updateDocumentField: (endpoint: VerdocsEndpoint, documentId: string, fieldName: string, value: any) => Promise<IDocumentFieldSettings>;
 /**
  * Update a Document signature field. Signature fields are ID-driven. Call `Document.createSignature()` first to create a
  * signature for a Recipient, then call `Documents.updateDocumentFieldSignature()` to attach it to a field.
  */
-export declare const updateDocumentFieldSignature: (endpoint: VerdocsEndpoint, documentId: string, fieldName: string, signatureId: string) => Promise<IFieldSetting>;
+export declare const updateDocumentFieldSignature: (endpoint: VerdocsEndpoint, documentId: string, fieldName: string, signatureId: string) => Promise<IDocumentFieldSettings>;

package/Documents/Documents.js

@@ -35,13 +35,52 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 import { decodeAccessTokenBody } from '../Utils/Token';
+/**
+ * Create a document
+ *
+ * ```typescript
+ * import {Documents, ICreateDocumentRole, ICreateDocumentRequest} from '@verdocs/js-sdk/Documents';
+ *
+ * const role1: ICreateDocumentRole = {
+ *   type: 'signer',
+ *   name: 'Seller',
+ *   full_name: 'Paige Turner',
+ *   email: 'paige.turner@nomail.com',
+ *   phone: '',
+ *   sequence: 1,
+ *   delegator: false,
+ *   message: '',
+ * };
+ *
+ * const role2: ICreateDocumentRole = {
+ *   type: 'signer',
+ *   name: 'Buyer',
+ *   full_name: 'Will Power',
+ *   email: 'will.power@nomail.com',
+ *   phone: '',
+ *   sequence: 2,
+ *   delegator: false,
+ *   message: '',
+ * };
+ *
+ * const request: ICreateDocumentRequest = {template_id: 'd2338742-f3a1-465b-8592-806587413cc1', name: 'Bill of Sale', roles: [role1, role2]};
+ * const {id, recipients} = await Documents.createDocument(VerdocsEndpoint.getDefault(), request);
+ * ```
+ */
+export var createDocument = function (endpoint, request) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, endpoint.api //
+                .post('/documents', request)
+                .then(function (r) { return r.data; })];
+    });
+}); };
 /**
  * Get a summary of currently active documents.
  *
  * ```typescript
  * import {Documents} from '@verdocs/js-sdk/Documents';
  *
- * const {action_required, completed, waiting_on_others} = await Documents.getSummary();
+ * const {action_required, completed, waiting_on_others} = await Documents.getSummary(VerdocsEndpoint.getDefault());
  * ```
  */
 export var getSummary = function (endpoint, page) { return __awaiter(void 0, void 0, void 0, function () {
@@ -57,7 +96,7 @@ export var getSummary = function (endpoint, page) { return __awaiter(void 0, voi
  * ```typescript
  * import {Documents} from '@verdocs/js-sdk/Documents';
  *
- * const {result, page, total} = await Documents.search({ ... });
+ * const {result, page, total} = await Documents.search(VerdocsEndpoint.getDefault(), { ... });
  * ```
  */
 export var searchDocuments = function (endpoint, params) { return __awaiter(void 0, void 0, void 0, function () {

package/Documents/Types.d.ts

@@ -1,4 +1,3 @@
-import { IFieldSetting } from '../Templates/Types';
 import { IProfile } from '../Users/Types';
 export declare type TRecipientAction = 'submit' | 'decline' | 'prepare' | 'update';
 export interface ITemplateSummaryEntry {
@@ -126,6 +125,7 @@ export interface IRecipient {
     status: TRecipientStatus;
     type: TRecipientType;
     updated_at: string;
+    fields?: IDocumentField[];
 }
 export interface IDocumentAsset {
     created_at: string;
@@ -136,16 +136,45 @@ export interface IDocumentAsset {
     updated_at: string;
     url: string;
 }
+export interface IDocumentFieldOptions {
+    id: string;
+    x: number;
+    y: number;
+    checked?: boolean;
+    selected?: boolean;
+    value: string;
+}
+export interface IDocumentFieldSettings {
+    type?: string;
+    x: number;
+    y: number;
+    width?: number;
+    height?: number;
+    value?: number | string;
+    result?: any;
+    leading?: number;
+    alignment?: number;
+    upperCase?: boolean;
+    options?: IDocumentFieldOptions[];
+    base64?: string;
+    hash?: string;
+    ip_address?: string;
+    signature_id?: string;
+    signed_at?: string;
+    minimum_checked?: number;
+    maximum_checked?: number;
+    [key: string]: any;
+}
+export declare type TDocumentFieldType = 'signature' | 'initial' | 'checkbox_group' | 'radio_button_group' | 'textbox' | 'timestamp' | 'date' | 'dropdown' | 'textarea' | 'attachment' | 'payment';
 export interface IDocumentField {
     envelope_id: string;
-    label: string | null;
     name: string;
+    label: string | null;
     page: number;
     recipient_role: string;
-    type: string;
+    type: TDocumentFieldType;
     required: boolean;
-    settings?: IFieldSetting;
-    setting?: IFieldSetting;
+    settings?: IDocumentFieldSettings;
     validator: string | null;
     prepared?: boolean;
 }
@@ -168,7 +197,7 @@ export interface IDocument {
     certificate?: IDocumentAsset | null;
     document?: IDocumentAsset | null;
     fields?: IDocumentField[];
-    profile?: IProfile;
+    profile?: IProfile | null;
 }
 export declare type TDocumentUpdateResult = Omit<IDocument, 'histories' | 'recipients' | 'certificate' | 'document' | 'fields' | 'profile'>;
 export interface IActivityEntry {
@@ -209,3 +238,18 @@ export interface IDocumentSearchOptions {
 }
 export declare type THistoryEvent = 'recipient:invited' | 'recipient:opened' | 'recipient:agreed' | 'recipient:signed' | 'recipient:submitted';
 export declare type TEventDetail = 'in_app' | 'mail' | 'signer' | '';
+export interface ICreateDocumentRole {
+    type: TRecipientType;
+    name: string;
+    full_name: string;
+    email?: string;
+    phone?: string;
+    sequence: number;
+    delegator: boolean;
+    message: string;
+}
+export interface ICreateDocumentRequest {
+    template_id: string;
+    roles: ICreateDocumentRole[];
+    name: string;
+}

package/Templates/Types.d.ts

@@ -154,28 +154,21 @@ export interface ITemplateField {
     template_id: string;
     type: string;
     required: boolean;
-    setting?: IFieldSetting;
+    setting: ITemplateFieldSetting;
     page_sequence: number;
     validator?: string;
     label?: string;
 }
-export interface IFieldSetting {
+export interface ITemplateFieldSetting {
     x: number;
     y: number;
+    result?: string;
     width?: number;
     height?: number;
-    result?: any;
-    type?: string;
-    value?: string;
     leading?: number;
     alignment?: number;
     upperCase?: boolean;
     options?: any[];
-    base64?: string;
-    hash?: string;
-    ip_address?: string;
-    signature_id?: string;
-    signed_at?: string;
     [key: string]: any;
 }
 export interface IPage {

package/package.json

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