@verdocs/web-sdk 2.3.88 → 4.0.6

package/dist/types/components/envelopes/verdocs-envelope-document-page/verdocs-envelope-document-page.d.ts

@@ -7,63 +7,63 @@ import { IDocumentPageInfo, IPageLayer } from '../../../utils/Types';
  * on its own as an individual component.
  */
 export declare class VerdocsEnvelopeDocumentPage {
-  container: HTMLElement;
-  private resizeObserver;
-  /**
-   * The endpoint to load from.
-   */
-  endpoint: VerdocsEndpoint;
-  /**
-   * The ID of the envelope the document is for.
-   */
-  envelopeId: string;
-  /**
-   * The ID of the document to display.
-   */
-  documentId: string;
-  /**
-   * The page number being rendered. (Reminder: page numbers are 1-based.)
-   */
-  pageNumber: number;
-  /**
-   * The "virtual" width of the page canvas. Defaults to 612 which at 72dpi is 8.5" wide. This is used to compute
-   * the aspect ratio of the final rendered element when scaling up/down.
-   */
-  virtualWidth: number;
-  /**
-   * The "virtual" height of the page canvas.  Defaults to 792 which at 72dpi is 11" tall. This is used to compute
-   * the aspect ratio of the final rendered element when scaling up/down.
-   */
-  virtualHeight: number;
-  /**
-   * The layers that will be rendered. The DOM structure will be a DIV container with one child DIV for each layer.
-   * The parent DIV will have a unique ID, and each child DIV will have that ID with the layer name appended, e.g.
-   * if `pages` was ['page', 'fields'] the structure will be:
-   *
-   * ```
-   *     <div id="verdocs-envelope-document-page-ker2fr1p9">
-   *       <div id="verdocs-envelope-document-page-ker2fr1p9-page"></div>
-   *       <div id="verdocs-envelope-document-page-ker2fr1p9-fields"></div>
-   *     </div>
-   * ```
-   */
-  layers: IPageLayer[];
-  type: 'original' | 'filled' | 'certificate';
-  /**
-   * Fired when a page has been rendered. This is also fired when the page is resized.
-   */
-  pageRendered: EventEmitter<IDocumentPageInfo>;
-  containerId: string;
-  renderedWidth: number;
-  renderedHeight: number;
-  naturalWidth: number;
-  naturalHeight: number;
-  aspectRatio: number;
-  skipFirstNotification: boolean;
-  pageDisplayUri: string;
-  componentWillLoad(): Promise<void>;
-  componentDidLoad(): void;
-  disconnectedCallback(): void;
-  notifyRenderedSize(): void;
-  render(): any;
+    container: HTMLElement;
+    private resizeObserver;
+    /**
+     * The endpoint to load from.
+     */
+    endpoint: VerdocsEndpoint;
+    /**
+     * The ID of the envelope the document is for.
+     */
+    envelopeId: string;
+    /**
+     * The ID of the document to display.
+     */
+    documentId: string;
+    /**
+     * The page number being rendered. (Reminder: page numbers are 1-based.)
+     */
+    pageNumber: number;
+    /**
+     * The "virtual" width of the page canvas. Defaults to 612 which at 72dpi is 8.5" wide. This is used to compute
+     * the aspect ratio of the final rendered element when scaling up/down.
+     */
+    virtualWidth: number;
+    /**
+     * The "virtual" height of the page canvas.  Defaults to 792 which at 72dpi is 11" tall. This is used to compute
+     * the aspect ratio of the final rendered element when scaling up/down.
+     */
+    virtualHeight: number;
+    /**
+     * The layers that will be rendered. The DOM structure will be a DIV container with one child DIV for each layer.
+     * The parent DIV will have a unique ID, and each child DIV will have that ID with the layer name appended, e.g.
+     * if `pages` was ['page', 'fields'] the structure will be:
+     *
+     * ```
+     *     <div id="verdocs-envelope-document-page-ker2fr1p9">
+     *       <div id="verdocs-envelope-document-page-ker2fr1p9-page"></div>
+     *       <div id="verdocs-envelope-document-page-ker2fr1p9-fields"></div>
+     *     </div>
+     * ```
+     */
+    layers: IPageLayer[];
+    type: 'original' | 'filled' | 'certificate';
+    /**
+     * Fired when a page has been rendered. This is also fired when the page is resized.
+     */
+    pageRendered: EventEmitter<IDocumentPageInfo>;
+    containerId: string;
+    renderedWidth: number;
+    renderedHeight: number;
+    naturalWidth: number;
+    naturalHeight: number;
+    aspectRatio: number;
+    skipFirstNotification: boolean;
+    pageDisplayUri: string;
+    componentWillLoad(): Promise<void>;
+    componentDidLoad(): void;
+    disconnectedCallback(): void;
+    notifyRenderedSize(): void;
+    render(): any;
 }

package/dist/types/components/envelopes/verdocs-envelope-recipient-link/verdocs-envelope-recipient-link.d.ts

@@ -1,6 +1,5 @@
-import { VerdocsEndpoint } from '@verdocs/js-sdk';
-import { IEnvelope, IRecipient } from '@verdocs/js-sdk/Envelopes/Types';
 import { EventEmitter } from '../../../stencil-public-runtime';
+import { IEnvelope, IRecipient, VerdocsEndpoint } from '@verdocs/js-sdk';
 import { TEnvelopeStore } from '../../../utils/EnvelopeStore';
 import { SDKError } from '../../../utils/errors';
 /**
@@ -8,39 +7,39 @@ import { SDKError } from '../../../utils/errors';
  * signing link for that recipient to use.
  */
 export declare class VerdocsEnvelopeRecipientLink {
-  /**
-   * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
-   */
-  endpoint: VerdocsEndpoint;
-  /**
-   * The envelope ID to edit.
-   */
-  envelopeId: string;
-  /**
-   * The role to load.
-   */
-  roleName: string;
-  /**
-   * Event fired when the user clicks Done to proceed. It is up to the host application
-   * to redirect the user to the appropriate next workflow step.
-   */
-  next: EventEmitter<{
-    envelope: IEnvelope;
-  }>;
-  /**
-   * Event fired if an error occurs. The event details will contain information about the error. Most errors will
-   * terminate the process, and the calling application should correct the condition and re-render the component.
-   */
-  sdkError: EventEmitter<SDKError>;
-  isOpen: boolean;
-  loading: boolean;
-  gettingLink: boolean;
-  link: string;
-  store: TEnvelopeStore | null;
-  recipient: IRecipient | null;
-  componentWillLoad(): Promise<void>;
-  handleDone(e: any): void;
-  copyLink(link: string): void;
-  getLink(recipient: IRecipient): void;
-  render(): any;
+    /**
+     * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
+     */
+    endpoint: VerdocsEndpoint;
+    /**
+     * The envelope ID to edit.
+     */
+    envelopeId: string;
+    /**
+     * The role to load.
+     */
+    roleName: string;
+    /**
+     * Event fired when the user clicks Done to proceed. It is up to the host application
+     * to redirect the user to the appropriate next workflow step.
+     */
+    next: EventEmitter<{
+        envelope: IEnvelope;
+    }>;
+    /**
+     * Event fired if an error occurs. The event details will contain information about the error. Most errors will
+     * terminate the process, and the calling application should correct the condition and re-render the component.
+     */
+    sdkError: EventEmitter<SDKError>;
+    isOpen: boolean;
+    loading: boolean;
+    gettingLink: boolean;
+    link: string;
+    store: TEnvelopeStore | null;
+    recipient: IRecipient | null;
+    componentWillLoad(): Promise<void>;
+    handleDone(e: any): void;
+    copyLink(link: string): void;
+    getLink(recipient: IRecipient): void;
+    render(): any;
 }

package/dist/types/components/envelopes/verdocs-envelope-recipient-summary/verdocs-envelope-recipient-summary.d.ts

@@ -1,5 +1,4 @@
-import { VerdocsEndpoint } from '@verdocs/js-sdk';
-import { IEnvelope, IRecipient } from '@verdocs/js-sdk/Envelopes/Types';
+import { IEnvelope, IRecipient, VerdocsEndpoint } from '@verdocs/js-sdk';
 import { EventEmitter } from '../../../stencil-public-runtime';
 import { TEnvelopeStore } from '../../../utils/EnvelopeStore';
 import { SDKError } from '../../../utils/errors';
@@ -7,65 +6,65 @@ import { SDKError } from '../../../utils/errors';
  * Displays a list of recipients with options to get in-person signing links for each one.
  */
 export declare class VerdocsEnvelopeRecipientSummary {
-  /**
-   * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
-   */
-  endpoint: VerdocsEndpoint;
-  /**
-   * The envelope ID to edit.
-   */
-  envelopeId: string;
-  /**
-   * Enable or disable the Send Another button.
-   */
-  canSendAnother: boolean;
-  /**
-   * Enable or disable the View button.
-   */
-  canView: boolean;
-  /**
-   * Enable or disable the Done button.
-   */
-  canDone: boolean;
-  /**
-   * Event fired when the user clicks Send Another to proceed. It is up to the host application
-   * to redirect the user to the appropriate next workflow step.
-   */
-  another: EventEmitter<{
-    envelope: IEnvelope;
-  }>;
-  /**
-   * Event fired when the user clicks Send Another to proceed. It is up to the host application
-   * to redirect the user to the appropriate next workflow step.
-   */
-  view: EventEmitter<{
-    envelope: IEnvelope;
-  }>;
-  /**
-   * Event fired when the user clicks Done to proceed. It is up to the host application
-   * to redirect the user to the appropriate next workflow step.
-   */
-  next: EventEmitter<{
-    envelope: IEnvelope;
-  }>;
-  /**
-   * Event fired if an error occurs. The event details will contain information about the error. Most errors will
-   * terminate the process, and the calling application should correct the condition and re-render the component.
-   */
-  sdkError: EventEmitter<SDKError>;
-  isOpen: boolean;
-  loading: boolean;
-  recipientStatusIcons: any[];
-  containerId: string;
-  gettingLinks: Record<string, boolean>;
-  links: Record<string, string>;
-  store: TEnvelopeStore | null;
-  componentWillLoad(): Promise<void>;
-  sortEnvelopeRecipients(): void;
-  handleAnother(e: any): void;
-  handleView(e: any): void;
-  handleDone(e: any): void;
-  copyLink(link: string): void;
-  getLink(recipient: IRecipient): void;
-  render(): any;
+    /**
+     * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
+     */
+    endpoint: VerdocsEndpoint;
+    /**
+     * The envelope ID to edit.
+     */
+    envelopeId: string;
+    /**
+     * Enable or disable the Send Another button.
+     */
+    canSendAnother: boolean;
+    /**
+     * Enable or disable the View button.
+     */
+    canView: boolean;
+    /**
+     * Enable or disable the Done button.
+     */
+    canDone: boolean;
+    /**
+     * Event fired when the user clicks Send Another to proceed. It is up to the host application
+     * to redirect the user to the appropriate next workflow step.
+     */
+    another: EventEmitter<{
+        envelope: IEnvelope;
+    }>;
+    /**
+     * Event fired when the user clicks Send Another to proceed. It is up to the host application
+     * to redirect the user to the appropriate next workflow step.
+     */
+    view: EventEmitter<{
+        envelope: IEnvelope;
+    }>;
+    /**
+     * Event fired when the user clicks Done to proceed. It is up to the host application
+     * to redirect the user to the appropriate next workflow step.
+     */
+    next: EventEmitter<{
+        envelope: IEnvelope;
+    }>;
+    /**
+     * Event fired if an error occurs. The event details will contain information about the error. Most errors will
+     * terminate the process, and the calling application should correct the condition and re-render the component.
+     */
+    sdkError: EventEmitter<SDKError>;
+    isOpen: boolean;
+    loading: boolean;
+    recipientStatusIcons: any[];
+    containerId: string;
+    gettingLinks: Record<string, boolean>;
+    links: Record<string, string>;
+    store: TEnvelopeStore | null;
+    componentWillLoad(): Promise<void>;
+    sortEnvelopeRecipients(): void;
+    handleAnother(e: any): void;
+    handleView(e: any): void;
+    handleDone(e: any): void;
+    copyLink(link: string): void;
+    getLink(recipient: IRecipient): void;
+    render(): any;
 }

package/dist/types/components/envelopes/verdocs-envelope-sidebar/verdocs-envelope-sidebar.d.ts

@@ -1,66 +1,65 @@
-import { VerdocsEndpoint } from '@verdocs/js-sdk';
-import { IEnvelope, IRecipient } from '@verdocs/js-sdk/Envelopes/Types';
+import { IEnvelope, IRecipient, VerdocsEndpoint } from '@verdocs/js-sdk';
 import { EventEmitter } from '../../../stencil-public-runtime';
 import { TEnvelopeStore } from '../../../utils/EnvelopeStore';
 import { SDKError } from '../../../utils/errors';
 interface IHistoryEntry {
-  icon: string;
-  message: string;
-  date: Date;
+    icon: string;
+    message: string;
+    date: Date;
 }
 /**
  * Displays a file upload mechanism suitable for the first step of creating a template.
  * This is typically the first step in a template creation workflow.
  */
 export declare class VerdocsEnvelopeSidebar {
-  /**
-   * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
-   */
-  endpoint: VerdocsEndpoint;
-  /**
-   * The envelope ID to render. Set ONE OF templateId or envelopeId. If both are set, envelopeId will be ignored.
-   */
-  envelopeId: string;
-  /**
-   * Event fired if an error occurs. The event details will contain information about the error. Most errors will
-   * terminate the process, and the calling application should correct the condition and re-render the component.
-   */
-  sdkError: EventEmitter<SDKError>;
-  /**
-   * Event fired when the envelope is updated in any way. May be used for tasks such as cache invalidation or reporting to other systems.
-   */
-  envelopeUpdated: EventEmitter<{
+    /**
+     * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
+     */
     endpoint: VerdocsEndpoint;
-    envelope: IEnvelope;
-    event: string;
-  }>;
-  /**
-   * Event fired when the sidebar is opened or closed.
-   */
-  toggle: EventEmitter<{
-    open: boolean;
-  }>;
-  /**
-   * Event fired when the user clicks Send Another in the Manage Recipients dialog. It is up to the host application
-   * to redirect the user to the appropriate next workflow step.
-   */
-  another: EventEmitter<{
-    envelope: IEnvelope;
-  }>;
-  activeTab: number;
-  panelOpen: boolean;
-  showManageDialog: boolean;
-  showRecipientDialog: string;
-  showCancelDialog: boolean;
-  loading: boolean;
-  store: TEnvelopeStore | null;
-  componentWillLoad(): Promise<void>;
-  sortEnvelopeRecipients(): void;
-  setTab(tab: number): void;
-  canResendRecipient(recipient: IRecipient): boolean;
-  handleRecipientAction(recipient: IRecipient, id: string): void;
-  cancelEnvelope(): void;
-  prepareHistoryEntries(): IHistoryEntry[];
-  render(): any;
+    /**
+     * The envelope ID to render. Set ONE OF templateId or envelopeId. If both are set, envelopeId will be ignored.
+     */
+    envelopeId: string;
+    /**
+     * Event fired if an error occurs. The event details will contain information about the error. Most errors will
+     * terminate the process, and the calling application should correct the condition and re-render the component.
+     */
+    sdkError: EventEmitter<SDKError>;
+    /**
+     * Event fired when the envelope is updated in any way. May be used for tasks such as cache invalidation or reporting to other systems.
+     */
+    envelopeUpdated: EventEmitter<{
+        endpoint: VerdocsEndpoint;
+        envelope: IEnvelope;
+        event: string;
+    }>;
+    /**
+     * Event fired when the sidebar is opened or closed.
+     */
+    toggle: EventEmitter<{
+        open: boolean;
+    }>;
+    /**
+     * Event fired when the user clicks Send Another in the Manage Recipients dialog. It is up to the host application
+     * to redirect the user to the appropriate next workflow step.
+     */
+    another: EventEmitter<{
+        envelope: IEnvelope;
+    }>;
+    activeTab: number;
+    panelOpen: boolean;
+    showManageDialog: boolean;
+    showRecipientDialog: string;
+    showCancelDialog: boolean;
+    loading: boolean;
+    store: TEnvelopeStore | null;
+    componentWillLoad(): Promise<void>;
+    sortEnvelopeRecipients(): void;
+    setTab(tab: number): void;
+    canResendRecipient(recipient: IRecipient): boolean;
+    handleRecipientAction(recipient: IRecipient, id: string): void;
+    cancelEnvelope(): void;
+    prepareHistoryEntries(): IHistoryEntry[];
+    render(): any;
 }
 export {};

package/dist/types/components/envelopes/verdocs-envelopes-list/verdocs-envelopes-list.d.ts

@@ -1,102 +1,101 @@
-import { VerdocsEndpoint } from '@verdocs/js-sdk';
-import { IEnvelope, TEnvelopeStatus } from '@verdocs/js-sdk/Envelopes/Types';
 import { EventEmitter } from '../../../stencil-public-runtime';
+import { IEnvelope, TEnvelopeStatus, VerdocsEndpoint } from '@verdocs/js-sdk';
 import { SDKError } from '../../../utils/errors';
 /**
  * Displays a list of envelopes matching specified conditions.
  */
 export declare class VerdocsEnvelopesList {
-  /**
-   * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
-   */
-  endpoint: VerdocsEndpoint;
-  /**
-   * The filtered view to display. "completed" will show envelopes that have been submitted. "action" will
-   * show envelopes where the user is a recipient and the envelope is not completed. "waiting" will show
-   * only envelopes where the user is the sender and the envelope is not completed.
-   */
-  view?: 'all' | 'inbox' | 'sent' | 'completed' | 'action' | 'waiting';
-  /**
-   * The status value to filter by
-   */
-  status: TEnvelopeStatus | 'all';
-  /**
-   * The sort field to use
-   */
-  sort: 'name' | 'created_at' | 'updated_at' | 'canceled_at' | 'status';
-  /**
-   * If set, filter envelopes by the specified string.
-   */
-  match: string;
-  /**
-   * If set, filter envelopes by the specified "containing" value.
-   */
-  /**
-   * Whether or not pagination should be enabled.
-   */
-  showPagination: boolean;
-  /**
-   * The number of rows to display per page.
-   */
-  rowsPerPage: number;
-  /**
-   * The initial page number to select. Pagination is internally controlled but may be overriden by the
-   * host applicaiton.
-   */
-  selectedPage: number;
-  /**
-   * Event fired when the user changes their view. Host applications can use this to save the user's preferences.
-   */
-  changeView: EventEmitter<'all' | 'inbox' | 'sent' | 'completed' | 'action' | 'waiting'>;
-  /**
-   * Event fired when the user changes their status filter. Host applications can use this to save the user's preferences.
-   */
-  changeStatus: EventEmitter<TEnvelopeStatus | 'all'>;
-  /**
-   * Event fired when the user changes their sort order. Host applications can use this to save the user's preferences.
-   */
-  changeSort: EventEmitter<'name' | 'created_at' | 'updated_at' | 'canceled_at' | 'status'>;
-  /**
-   * Event fired when the user changes the match filter. This is fired for every inputChange event (every character
-   * typed). This event is provided for balance with the other events, but host applications should generally not
-   * save this value. Users might appreciate applications remembering their sorting or filtering preferences, but
-   * probably not their search terms.
-   */
-  changeMatch: EventEmitter<string>;
-  /**
-   * Event fired if an error occurs. The event details will contain information about the error. Most errors will
-   * terminate the process, and the calling application should correct the condition and re-render the component.
-   */
-  sdkError: EventEmitter<SDKError>;
-  /**
-   * Event fired when the user clicks an activity entry. Typically the host application will use this to navigate
-   * to the envelope detail view.
-   */
-  viewEnvelope: EventEmitter<{
+    /**
+     * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
+     */
     endpoint: VerdocsEndpoint;
-    envelope: IEnvelope;
-  }>;
-  /**
-   * Event fired when the user clicks to finish the envelope.
-   */
-  finishEnvelope: EventEmitter<{
-    endpoint: VerdocsEndpoint;
-    envelope: IEnvelope;
-  }>;
-  count: number;
-  initiallyLoaded: boolean;
-  loading: boolean;
-  selectedEnvelopes: IEnvelope[];
-  envelopes: IEnvelope[];
-  handleViewUpdated(): Promise<void>;
-  handleStatusUpdated(): Promise<void>;
-  handleSortUpdated(): Promise<void>;
-  handleMatchUpdated(): Promise<void>;
-  handlePageUpdated(): Promise<void>;
-  componentWillLoad(): void;
-  componentDidLoad(): Promise<void>;
-  queryEnvelopes(): Promise<void>;
-  handleDownload(): void;
-  downloadEnvelope(envelope: IEnvelope): void;
-  render(): any;
+    /**
+     * The filtered view to display. "completed" will show envelopes that have been submitted. "action" will
+     * show envelopes where the user is a recipient and the envelope is not completed. "waiting" will show
+     * only envelopes where the user is the sender and the envelope is not completed.
+     */
+    view?: 'all' | 'inbox' | 'sent' | 'completed' | 'action' | 'waiting';
+    /**
+     * The status value to filter by
+     */
+    status: TEnvelopeStatus | 'all';
+    /**
+     * The sort field to use
+     */
+    sort: 'name' | 'created_at' | 'updated_at' | 'canceled_at' | 'status';
+    /**
+     * If set, filter envelopes by the specified string.
+     */
+    match: string;
+    /**
+     * If set, filter envelopes by the specified "containing" value.
+     */
+    /**
+     * Whether or not pagination should be enabled.
+     */
+    showPagination: boolean;
+    /**
+     * The number of rows to display per page.
+     */
+    rowsPerPage: number;
+    /**
+     * The initial page number to select. Pagination is internally controlled but may be overriden by the
+     * host applicaiton.
+     */
+    selectedPage: number;
+    /**
+     * Event fired when the user changes their view. Host applications can use this to save the user's preferences.
+     */
+    changeView: EventEmitter<'all' | 'inbox' | 'sent' | 'completed' | 'action' | 'waiting'>;
+    /**
+     * Event fired when the user changes their status filter. Host applications can use this to save the user's preferences.
+     */
+    changeStatus: EventEmitter<TEnvelopeStatus | 'all'>;
+    /**
+     * Event fired when the user changes their sort order. Host applications can use this to save the user's preferences.
+     */
+    changeSort: EventEmitter<'name' | 'created_at' | 'updated_at' | 'canceled_at' | 'status'>;
+    /**
+     * Event fired when the user changes the match filter. This is fired for every inputChange event (every character
+     * typed). This event is provided for balance with the other events, but host applications should generally not
+     * save this value. Users might appreciate applications remembering their sorting or filtering preferences, but
+     * probably not their search terms.
+     */
+    changeMatch: EventEmitter<string>;
+    /**
+     * Event fired if an error occurs. The event details will contain information about the error. Most errors will
+     * terminate the process, and the calling application should correct the condition and re-render the component.
+     */
+    sdkError: EventEmitter<SDKError>;
+    /**
+     * Event fired when the user clicks an activity entry. Typically the host application will use this to navigate
+     * to the envelope detail view.
+     */
+    viewEnvelope: EventEmitter<{
+        endpoint: VerdocsEndpoint;
+        envelope: IEnvelope;
+    }>;
+    /**
+     * Event fired when the user clicks to finish the envelope.
+     */
+    finishEnvelope: EventEmitter<{
+        endpoint: VerdocsEndpoint;
+        envelope: IEnvelope;
+    }>;
+    count: number;
+    initiallyLoaded: boolean;
+    loading: boolean;
+    selectedEnvelopes: IEnvelope[];
+    envelopes: IEnvelope[];
+    handleViewUpdated(): Promise<void>;
+    handleStatusUpdated(): Promise<void>;
+    handleSortUpdated(): Promise<void>;
+    handleMatchUpdated(): Promise<void>;
+    handlePageUpdated(): Promise<void>;
+    componentWillLoad(): void;
+    componentDidLoad(): Promise<void>;
+    queryEnvelopes(): Promise<void>;
+    handleDownload(): void;
+    downloadEnvelope(envelope: IEnvelope): void;
+    render(): any;
 }