@verdocs/web-sdk 5.0.75 → 5.3.1

package/dist/types/components.d.ts

@@ -5,7 +5,7 @@
  * It contains typing information for all components that exist in this project.
  */
 import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
-import { ICreateEnvelopeRecipient, IEnvelope, IEnvelopeField, IOrganization, IRecipient, IRole, ISignerTokenResponse, ITemplate, ITemplateField, TEnvelopeStatus, TRecipientStatus, VerdocsEndpoint } from "@verdocs/js-sdk";
+import { ICreateEnvelopeRecipientFromTemplate, IEnvelope, IEnvelopeField, IOrganization, IRecipient, IRole, ISignerTokenResponse, ITemplate, ITemplateField, TEnvelopeStatus, TRecipientStatus, VerdocsEndpoint } from "@verdocs/js-sdk";
 import { IAuthStatus } from "./components/embeds/verdocs-auth/verdocs-auth";
 import { SDKError } from "./utils/errors";
 import { TVerdocsBuildStep } from "./components/embeds/verdocs-build/verdocs-build";
@@ -23,7 +23,7 @@ import { TVerdocsBuildStep as TVerdocsBuildStep1 } from "./components/templates/
 import { TAllowedTemplateAction } from "./components/templates/verdocs-templates-list/verdocs-templates-list";
 import { IToggleIconButtons } from "./components/controls/verdocs-toggle/verdocs-toggle";
 import { Placement } from "@popperjs/core/lib/enums";
-export { ICreateEnvelopeRecipient, IEnvelope, IEnvelopeField, IOrganization, IRecipient, IRole, ISignerTokenResponse, ITemplate, ITemplateField, TEnvelopeStatus, TRecipientStatus, VerdocsEndpoint } from "@verdocs/js-sdk";
+export { ICreateEnvelopeRecipientFromTemplate, IEnvelope, IEnvelopeField, IOrganization, IRecipient, IRole, ISignerTokenResponse, ITemplate, ITemplateField, TEnvelopeStatus, TRecipientStatus, VerdocsEndpoint } from "@verdocs/js-sdk";
 export { IAuthStatus } from "./components/embeds/verdocs-auth/verdocs-auth";
 export { SDKError } from "./utils/errors";
 export { TVerdocsBuildStep } from "./components/embeds/verdocs-build/verdocs-build";
@@ -396,6 +396,24 @@ export namespace Components {
          */
         "envelopeId": string;
     }
+    /**
+     * Displays a single recipient from an envelope, with the opportunity to copy an in-person
+     * signing link for that recipient to use.
+     */
+    interface VerdocsEnvelopeUpdateRecipient {
+        /**
+          * 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;
+    }
     /**
      * Displays a list of envelopes matching specified conditions.
      */
@@ -2055,6 +2073,10 @@ export interface VerdocsEnvelopeSidebarCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLVerdocsEnvelopeSidebarElement;
 }
+export interface VerdocsEnvelopeUpdateRecipientCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLVerdocsEnvelopeUpdateRecipientElement;
+}
 export interface VerdocsEnvelopesListCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLVerdocsEnvelopesListElement;
@@ -2274,7 +2296,7 @@ declare global {
         "cancel": any;
         "sdkError": SDKError;
         "stepChanged": TVerdocsBuildStep;
-        "send": {recipients: ICreateEnvelopeRecipient[]; name: string; template_id: string};
+        "send": {recipients: ICreateEnvelopeRecipientFromTemplate[]; name: string; template_id: string};
         "templateUpdated": {endpoint: VerdocsEndpoint; template: ITemplate; event: string};
         "templateCreated": {endpoint: VerdocsEndpoint; template: ITemplate; event: string};
         "rolesUpdated": {endpoint: VerdocsEndpoint; templateId: string; event: 'added' | 'deleted' | 'updated'; roles: IRole[]};
@@ -2556,6 +2578,28 @@ declare global {
         prototype: HTMLVerdocsEnvelopeSidebarElement;
         new (): HTMLVerdocsEnvelopeSidebarElement;
     };
+    interface HTMLVerdocsEnvelopeUpdateRecipientElementEventMap {
+        "next": {action: 'cancel' | 'save'; originalRecipient: IRecipient; updatedRecipient: IRecipient};
+        "sdkError": SDKError;
+    }
+    /**
+     * Displays a single recipient from an envelope, with the opportunity to copy an in-person
+     * signing link for that recipient to use.
+     */
+    interface HTMLVerdocsEnvelopeUpdateRecipientElement extends Components.VerdocsEnvelopeUpdateRecipient, HTMLStencilElement {
+        addEventListener<K extends keyof HTMLVerdocsEnvelopeUpdateRecipientElementEventMap>(type: K, listener: (this: HTMLVerdocsEnvelopeUpdateRecipientElement, ev: VerdocsEnvelopeUpdateRecipientCustomEvent<HTMLVerdocsEnvelopeUpdateRecipientElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLVerdocsEnvelopeUpdateRecipientElementEventMap>(type: K, listener: (this: HTMLVerdocsEnvelopeUpdateRecipientElement, ev: VerdocsEnvelopeUpdateRecipientCustomEvent<HTMLVerdocsEnvelopeUpdateRecipientElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+    }
+    var HTMLVerdocsEnvelopeUpdateRecipientElement: {
+        prototype: HTMLVerdocsEnvelopeUpdateRecipientElement;
+        new (): HTMLVerdocsEnvelopeUpdateRecipientElement;
+    };
     interface HTMLVerdocsEnvelopesListElementEventMap {
         "changeView": 'all' | 'inbox' | 'sent' | 'completed' | 'action' | 'waiting';
         "changeStatus": TEnvelopeStatus | 'all';
@@ -3251,8 +3295,8 @@ declare global {
         new (): HTMLVerdocsSelectInputElement;
     };
     interface HTMLVerdocsSendElementEventMap {
-        "beforeSend": {recipients: ICreateEnvelopeRecipient[]; name: string; template_id: string; template: ITemplate};
-        "send": {recipients: ICreateEnvelopeRecipient[]; name: string; template_id: string; envelope_id: string; envelope: IEnvelope};
+        "beforeSend": {recipients: ICreateEnvelopeRecipientFromTemplate[]; name: string; template_id: string; template: ITemplate};
+        "send": {recipients: ICreateEnvelopeRecipientFromTemplate[]; name: string; template_id: string; envelope_id: string; envelope: IEnvelope};
         "exit": any;
         "sdkError": SDKError;
         "searchContacts": IContactSearchEvent1;
@@ -3861,6 +3905,7 @@ declare global {
         "verdocs-envelope-recipient-link": HTMLVerdocsEnvelopeRecipientLinkElement;
         "verdocs-envelope-recipient-summary": HTMLVerdocsEnvelopeRecipientSummaryElement;
         "verdocs-envelope-sidebar": HTMLVerdocsEnvelopeSidebarElement;
+        "verdocs-envelope-update-recipient": HTMLVerdocsEnvelopeUpdateRecipientElement;
         "verdocs-envelopes-list": HTMLVerdocsEnvelopesListElement;
         "verdocs-field-attachment": HTMLVerdocsFieldAttachmentElement;
         "verdocs-field-checkbox": HTMLVerdocsFieldCheckboxElement;
@@ -3996,7 +4041,7 @@ declare namespace LocalJSX {
         /**
           * The user completed the Send form and clicked send.
          */
-        "onSend"?: (event: VerdocsBuildCustomEvent<{recipients: ICreateEnvelopeRecipient[]; name: string; template_id: string}>) => void;
+        "onSend"?: (event: VerdocsBuildCustomEvent<{recipients: ICreateEnvelopeRecipientFromTemplate[]; name: string; template_id: string}>) => void;
         /**
           * Event fired when the user selects a different step.
          */
@@ -4373,6 +4418,32 @@ declare namespace LocalJSX {
          */
         "onToggle"?: (event: VerdocsEnvelopeSidebarCustomEvent<{open: boolean}>) => void;
     }
+    /**
+     * Displays a single recipient from an envelope, with the opportunity to copy an in-person
+     * signing link for that recipient to use.
+     */
+    interface VerdocsEnvelopeUpdateRecipient {
+        /**
+          * 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;
+        /**
+          * Event fired when the user clicks Done to proceed. It is up to the host application to save any updates and proceed to the next step.
+         */
+        "onNext"?: (event: VerdocsEnvelopeUpdateRecipientCustomEvent<{action: 'cancel' | 'save'; originalRecipient: IRecipient; updatedRecipient: IRecipient}>) => void;
+        /**
+          * 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.
+         */
+        "onSdkError"?: (event: VerdocsEnvelopeUpdateRecipientCustomEvent<SDKError>) => void;
+        /**
+          * The role to load.
+         */
+        "roleName"?: string;
+    }
     /**
      * Displays a list of envelopes matching specified conditions.
      */
@@ -5652,7 +5723,7 @@ declare namespace LocalJSX {
         /**
           * The user is sending an envelope the form and clicked send.
          */
-        "onBeforeSend"?: (event: VerdocsSendCustomEvent<{recipients: ICreateEnvelopeRecipient[]; name: string; template_id: string; template: ITemplate}>) => void;
+        "onBeforeSend"?: (event: VerdocsSendCustomEvent<{recipients: ICreateEnvelopeRecipientFromTemplate[]; name: string; template_id: string; template: ITemplate}>) => void;
         /**
           * Event fired when the step is cancelled. This is called exit to avoid conflicts with the JS-reserved "cancel" event name.
          */
@@ -5668,7 +5739,7 @@ declare namespace LocalJSX {
         /**
           * The user completed the form and clicked send.
          */
-        "onSend"?: (event: VerdocsSendCustomEvent<{recipients: ICreateEnvelopeRecipient[]; name: string; template_id: string; envelope_id: string; envelope: IEnvelope}>) => void;
+        "onSend"?: (event: VerdocsSendCustomEvent<{recipients: ICreateEnvelopeRecipientFromTemplate[]; name: string; template_id: string; envelope_id: string; envelope: IEnvelope}>) => void;
         /**
           * The ID of the template to create the document from.
          */
@@ -6452,6 +6523,7 @@ declare namespace LocalJSX {
         "verdocs-envelope-recipient-link": VerdocsEnvelopeRecipientLink;
         "verdocs-envelope-recipient-summary": VerdocsEnvelopeRecipientSummary;
         "verdocs-envelope-sidebar": VerdocsEnvelopeSidebar;
+        "verdocs-envelope-update-recipient": VerdocsEnvelopeUpdateRecipient;
         "verdocs-envelopes-list": VerdocsEnvelopesList;
         "verdocs-field-attachment": VerdocsFieldAttachment;
         "verdocs-field-checkbox": VerdocsFieldCheckbox;
@@ -6652,6 +6724,11 @@ declare module "@stencil/core" {
              * This is typically the first step in a template creation workflow.
              */
             "verdocs-envelope-sidebar": LocalJSX.VerdocsEnvelopeSidebar & JSXBase.HTMLAttributes<HTMLVerdocsEnvelopeSidebarElement>;
+            /**
+             * Displays a single recipient from an envelope, with the opportunity to copy an in-person
+             * signing link for that recipient to use.
+             */
+            "verdocs-envelope-update-recipient": LocalJSX.VerdocsEnvelopeUpdateRecipient & JSXBase.HTMLAttributes<HTMLVerdocsEnvelopeUpdateRecipientElement>;
             /**
              * Displays a list of envelopes matching specified conditions.
              */

package/dist/types/utils/Datastore.d.ts

@@ -12,7 +12,7 @@ export declare const Store: {
     unsubscribe(listenerId: string): void;
     getTemplate(endpoint: VerdocsEndpoint, templateId: string, reload?: boolean): Promise<ITemplate | null>;
     updateTemplate(templateId: string, template: ITemplate): ITemplate;
-    getEnvelope(endpoint: VerdocsEndpoint, envelopeId: string, reload?: boolean): Promise<ITemplate | null>;
+    getEnvelope(endpoint: VerdocsEndpoint, envelopeId: string, reload?: boolean): Promise<IEnvelope | null>;
     updateEnvelope(envelopeId: string, envelope: IEnvelope): IEnvelope;
     getField(source: "template" | "envelope", sourceId: string, fieldName: string, fieldOverride: ITemplateField | IEnvelopeField | null | undefined): {
         index: number;