@verdocs/js-sdk 3.0.0 → 3.0.2

package/Envelopes/Types.d.ts

@@ -1,4 +1,5 @@
 import { IProfile } from '../Users/Types';
+import { IPage } from '../Templates/Types';
 export declare type TRecipientAction = 'submit' | 'decline' | 'prepare' | 'update';
 export interface ISigningSessionRequest {
     envelopeId: string;
@@ -34,10 +35,15 @@ export interface IInPersonAccessKey {
 export declare type TEnvelopeStatus = 'complete' | 'pending' | 'in progress' | 'declined' | 'canceled';
 export declare type TRecipientStatus = 'invited' | 'opened' | 'signed' | 'submitted' | 'canceled' | 'pending' | 'declined';
 export declare type TRecipientType = 'signer' | 'cc' | 'approver';
+/**
+ * One entry in an envelope search result.
+ * NOTE: Many of the fields here are undefined unless "summary=true" is included in the search terms
+ */
 export interface IEnvelopesSearchResultEntry {
     id: string;
     canceled_at: string;
     certificate_document_id: string;
+    /** @deprecated. New envelopes may have more than one document attached. */
     envelope_document_id: string;
     created_at: string;
     histories: IHistory[];
@@ -98,6 +104,12 @@ export interface IRecipient {
     phone: string | null;
     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.
+     */
     sequence: number;
     status: TRecipientStatus;
     type: TRecipientType;
@@ -112,13 +124,20 @@ export interface IEnvelopeDocument {
     page_numbers: number;
     updated_at: string;
     url: string;
+    pages?: IPage[];
 }
 export interface IDocumentFieldOptions {
+    /** The unique ID of the field */
     id: string;
+    /** The X position of the field on the page. Self-placed fields will have an X value of 0. */
     x: number;
+    /** The Y position of the field on the page. Self-placed fields will have an X value of 0. */
     y: number;
+    /** For checkboxes, whether it is currently checked */
     checked?: boolean;
+    /** For radio buttons, whether it is currently selected */
     selected?: boolean;
+    /** The visible label for the field e.g. 'Not Applicable' */
     value: string;
 }
 export interface IDocumentFieldSettings {
@@ -128,31 +147,47 @@ export interface IDocumentFieldSettings {
     width?: number;
     height?: number;
     value?: number | string;
+    /** If the field has been filled in, this contains the current value */
     result?: any;
+    /** Text field settings */
     leading?: number;
     alignment?: number;
     upperCase?: boolean;
+    /** Dropdowns, checkboxes, radio groups */
     options?: IDocumentFieldOptions[];
+    /** Signatures and Initials, result will be "signed" */
     base64?: string;
     hash?: string;
     ip_address?: string;
     signature_id?: string;
     signed_at?: string;
+    /** Checkbox settings */
     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 {
+    /**
+     * The ID of the document the field is for. For historical reasons, this is called `envelope_id` because documents
+     * were previously called envelopes.
+     */
     envelope_id: string;
+    /** The machine name of the field, e.g. `checkbox_groupP1-18` */
     name: string;
+    /** If set, the placeholder/label for the field. */
     label: string | null;
+    /** The 1-based page number the field is displayed on. "Self-placed" fields that the user must apply will be on page 0. */
     page: number;
+    /** The ID of the role in the recipients list, e.g. `Recipient 2` */
     recipient_role: string;
+    /** The type of the field */
     type: TDocumentFieldType;
+    /** If true, the field will be required */
     required: boolean;
     settings?: IDocumentFieldSettings;
     validator: string | null;
+    /** Not sent by the server. Used in the UI to identify prepared fields. */
     prepared?: boolean;
 }
 /**
@@ -171,13 +206,16 @@ export interface IEnvelope {
     updated_at: string;
     canceled_at: string;
     reminder_id: string | null;
+    /** @deprecated. New envelopes will support more than one document attachment so new code should no longer refer to this field. */
     envelope_document_id: string;
     certificate_document_id: string | null;
     histories: IHistory[];
     recipients: IRecipient[];
     profile?: IProfile | null;
     certificate?: IEnvelopeDocument | null;
+    /** @deprecated. New code should use `documents[]`. */
     document?: IEnvelopeDocument | null;
+    /** Documents attached to this envelope */
     documents?: IEnvelopeDocument[] | null;
     fields?: IDocumentField[];
 }
@@ -221,12 +259,31 @@ 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 ICreateEnvelopeRole {
+    /** The type of role to create. Most participants in standard flows will be "signer" recipients. */
     type: TRecipientType;
+    /**
+     * The Role name of the recipient. Please note this is not the person's name. It is the ID of the role, e.g.
+     * 'Recipient 1', 'Seller', etc. This must match one of the pre-defined roles in the template's Recipients list.
+     */
     name: string;
+    /** The full name of the recipient as it will be displayed in reports and queries, e.g. 'Paige Turner'. */
     full_name: string;
+    /** The email address of the recipient. One of `email` or `phone` must be provided. */
     email?: string;
+    /**
+     * The phone number of the recipient. One of `email` or `phone` must be provided. If `phone` is included, the
+     * recipient will receive an SMS notification for the document.
+     */
     phone?: string;
+    /**
+     *  The 1-based sequence number for the recipient. This can be used to override the template's workflow. Recipients
+     *  are processed in parallel for each matching sequence number (e.g. all recipients at level "1" may act in parallel)
+     *  and in series between sequence numbers (e.g. all recipients at level "1" must complete their tasks before
+     *  recipients at level "2" may act).
+     */
     sequence: number;
+    /** Whether the recipient may delegate their tasks to others. Should be false for most standard workflows. */
     delegator: boolean;
+    /** A custom message to include in the email or SMS invitation. May be left blank for a default message. */
     message: string;
 }

package/Organizations/Types.d.ts

@@ -11,9 +11,28 @@ export interface IOrganization {
     is_business: boolean;
     /** If the organization is a business, its name. Note that a business name can be different from an organization name. */
     business_name: string | null;
+    /** @deprecated. The organization primary contact email address. */
     contact_email: string | null;
+    /** @deprecated. The organization's primary time zone. */
     timezone: string | null;
+    /**
+     * If a Template published by the Organization is configured to be usable to create new Envelopes by users outside that
+     * Organization (`sender: 'everyone_as_creator'`), and that action would trigger a billing event, this field controls
+     * who is reponsible for that cost. If set to TRUE, the Organization that owns the template will be billed for its use.
+     * If set to FALSE, the requestor pays.
+     *
+     * This is deprecated in favor of a future per-template approach. Please contact support@verdocs.com to discuss your
+     * application requirements if you plan to use this functionality for an immediate integration.
+     *
+     * @deprecated
+     */
     envelope_responsible: boolean;
+    /** Web site URL */
+    url: string | null;
+    /** Creation date/time. */
+    created_at: string;
+    /** Last-update date/time. */
+    updated_at: string;
 }
 export interface ICreateApiKeyRequest {
     name: string;

package/Sessions/Types.d.ts

@@ -4,6 +4,7 @@ export interface ISigningSessionRequest {
     roleId: string;
     inviteCode: string;
 }
+/** A Signing Session connects a caller to a role within an envelope, and can be used only for calls related to signing that envelope. */
 export interface ISigningSession {
     profile_id: string;
     envelope_id: string;
@@ -19,6 +20,7 @@ export interface ISigningSession {
     iat: number;
     [key: string]: any;
 }
+/** A User Session connects a caller to a Verdocs profile, and can be used for any operations that profile may perform. */
 export interface IUserSession {
     sub: string;
     email: string;

package/Templates/Types.d.ts

@@ -162,6 +162,7 @@ export interface ITemplateDocument {
     template_id: string;
     mime: string;
     thumbnail_url: string;
+    pages?: IPage[];
 }
 export interface ITemplateField {
     name: string;
@@ -189,10 +190,20 @@ export interface ITemplateFieldSetting {
 export interface IPage {
     template_id: string;
     document_id: string;
+    /** Note: Page numbers are 1-based */
     sequence: number;
+    /** @deprecated. New code should use `sequence` */
     page_number: number;
     thumbnail_url: string;
+    /**
+     * The storage location for the page once rendered server-side. This can be used to determine whether a page has
+     * finished rendering, but cannot be accessed directly - client applications should use display_uri instead.
+     */
     image_uri?: string | null;
+    /**
+     * If the page was rendered server-side and the caller has access to view it, this will contain the signed URI
+     * to access it. Note that these URIs include short expirations and should never be cached.
+     */
     display_uri?: string | null;
     template_document?: ITemplateDocument;
     fields?: ITemplateField[];

package/Users/Types.d.ts

@@ -29,6 +29,8 @@ export interface IProfile {
     phone: string | null;
     /** If true, this is the caller's "currently selected" profile. All operations will performed "as" this profile. */
     current: boolean;
+    created_at: string;
+    updated_at: string;
     /** The organization */
     organization?: IOrganization;
     /** The permissions assigned to the profilel _NOTE: Only present in the "current" profile._ */

package/package.json

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