@verdocs/web-sdk 1.10.1 → 1.10.3

package/dist/docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2023-02-03T16:08:47",
+  "timestamp": "2023-02-08T15:42:02",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.20.0",
@@ -102,6 +102,9 @@
           "verdocs-text-input",
           "verdocs-ok-dialog"
         ],
+        "verdocs-text-input": [
+          "verdocs-help-icon"
+        ],
         "verdocs-ok-dialog": [
           "verdocs-button"
         ]
@@ -370,7 +373,8 @@
         "verdocs-template-properties",
         "verdocs-template-recipients",
         "verdocs-template-reminders",
-        "verdocs-template-sender-dialog",
+        "verdocs-template-role-properties",
+        "verdocs-template-sender",
         "verdocs-template-visibility",
         "verdocs-upload-dialog"
       ],
@@ -415,7 +419,10 @@
         "verdocs-template-reminders": [
           "verdocs-button"
         ],
-        "verdocs-template-sender-dialog": [
+        "verdocs-template-role-properties": [
+          "verdocs-button"
+        ],
+        "verdocs-template-sender": [
           "verdocs-button"
         ],
         "verdocs-template-visibility": [
@@ -614,6 +621,7 @@
         "verdocs-sign",
         "verdocs-template-properties",
         "verdocs-template-reminders",
+        "verdocs-template-role-properties",
         "verdocs-template-visibility"
       ],
       "dependencies": [],
@@ -627,6 +635,9 @@
         "verdocs-template-reminders": [
           "verdocs-checkbox"
         ],
+        "verdocs-template-role-properties": [
+          "verdocs-checkbox"
+        ],
         "verdocs-template-visibility": [
           "verdocs-checkbox"
         ]
@@ -1414,6 +1425,9 @@
           "verdocs-button-panel",
           "verdocs-select-input",
           "verdocs-text-input"
+        ],
+        "verdocs-text-input": [
+          "verdocs-help-icon"
         ]
       }
     },
@@ -1713,6 +1727,9 @@
         "verdocs-initial-dialog": [
           "verdocs-text-input",
           "verdocs-button"
+        ],
+        "verdocs-text-input": [
+          "verdocs-help-icon"
         ]
       }
     },
@@ -2305,6 +2322,9 @@
         "verdocs-signature-dialog": [
           "verdocs-text-input",
           "verdocs-button"
+        ],
+        "verdocs-text-input": [
+          "verdocs-help-icon"
         ]
       }
     },
@@ -2450,6 +2470,9 @@
           "verdocs-button-panel",
           "verdocs-select-input",
           "verdocs-text-input"
+        ],
+        "verdocs-text-input": [
+          "verdocs-help-icon"
         ]
       }
     },
@@ -2605,6 +2628,9 @@
           "verdocs-button-panel",
           "verdocs-select-input",
           "verdocs-text-input"
+        ],
+        "verdocs-text-input": [
+          "verdocs-help-icon"
         ]
       }
     },
@@ -2750,6 +2776,9 @@
           "verdocs-button-panel",
           "verdocs-select-input",
           "verdocs-text-input"
+        ],
+        "verdocs-text-input": [
+          "verdocs-help-icon"
         ]
       }
     },
@@ -2842,11 +2871,19 @@
       "slots": [],
       "parts": [],
       "dependents": [
-        "verdocs-template-sender-dialog"
+        "verdocs-template-role-properties",
+        "verdocs-template-sender",
+        "verdocs-text-input"
       ],
       "dependencies": [],
       "dependencyGraph": {
-        "verdocs-template-sender-dialog": [
+        "verdocs-template-role-properties": [
+          "verdocs-help-icon"
+        ],
+        "verdocs-template-sender": [
+          "verdocs-help-icon"
+        ],
+        "verdocs-text-input": [
           "verdocs-help-icon"
         ]
       }
@@ -2914,6 +2951,9 @@
           "verdocs-text-input",
           "verdocs-button"
         ],
+        "verdocs-text-input": [
+          "verdocs-help-icon"
+        ],
         "verdocs-field-initial": [
           "verdocs-initial-dialog"
         ]
@@ -3120,6 +3160,7 @@
       "dependents": [
         "verdocs-preview",
         "verdocs-sign",
+        "verdocs-template-attachments",
         "verdocs-template-fields",
         "verdocs-template-name",
         "verdocs-view"
@@ -3132,6 +3173,9 @@
         "verdocs-sign": [
           "verdocs-loader"
         ],
+        "verdocs-template-attachments": [
+          "verdocs-loader"
+        ],
         "verdocs-template-fields": [
           "verdocs-loader"
         ],
@@ -3500,14 +3544,14 @@
       "parts": [],
       "dependents": [
         "verdocs-template-properties",
-        "verdocs-template-sender-dialog"
+        "verdocs-template-sender"
       ],
       "dependencies": [],
       "dependencyGraph": {
         "verdocs-template-properties": [
           "verdocs-radio-button"
         ],
-        "verdocs-template-sender-dialog": [
+        "verdocs-template-sender": [
           "verdocs-radio-button"
         ]
       }
@@ -3917,7 +3961,8 @@
         "verdocs-field-signature",
         "verdocs-field-textarea",
         "verdocs-field-textbox",
-        "verdocs-field-timestamp"
+        "verdocs-field-timestamp",
+        "verdocs-template-role-properties"
       ],
       "dependencies": [],
       "dependencyGraph": {
@@ -3938,6 +3983,9 @@
         ],
         "verdocs-field-timestamp": [
           "verdocs-select-input"
+        ],
+        "verdocs-template-role-properties": [
+          "verdocs-select-input"
         ]
       }
     },
@@ -4220,6 +4268,9 @@
           "verdocs-text-input",
           "verdocs-button"
         ],
+        "verdocs-text-input": [
+          "verdocs-help-icon"
+        ],
         "verdocs-field-signature": [
           "verdocs-signature-dialog"
         ]
@@ -4356,6 +4407,83 @@
       "dependencies": [],
       "dependencyGraph": {}
     },
+    {
+      "filePath": "./src/components/templates/verdocs-template-attachments/verdocs-template-attachments.tsx",
+      "encapsulation": "none",
+      "tag": "verdocs-template-attachments",
+      "docs": "Displays an edit form that allows the user to view, add, or remove a template's attachments.\nNote that an active session and valid template ID must be supplied.",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "endpoint",
+          "type": "VerdocsEndpoint",
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.",
+          "docsTags": [],
+          "default": "VerdocsEndpoint.getDefault()",
+          "values": [
+            {
+              "type": "VerdocsEndpoint"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "templateId",
+          "type": "string",
+          "mutable": false,
+          "attr": "template-id",
+          "reflectToAttr": false,
+          "docs": "The template ID to edit.",
+          "docsTags": [],
+          "default": "''",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [
+        {
+          "event": "close",
+          "detail": "any",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the user cancels the dialog.",
+          "docsTags": []
+        },
+        {
+          "event": "sdkError",
+          "detail": "SDKError",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired if an error occurs. The event details will contain information about the error. Most errors will\nterminate the process, and the calling application should correct the condition and re-render the component.",
+          "docsTags": []
+        }
+      ],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [
+        "verdocs-loader"
+      ],
+      "dependencyGraph": {
+        "verdocs-template-attachments": [
+          "verdocs-loader"
+        ]
+      }
+    },
     {
       "filePath": "./src/components/controls/verdocs-template-card/verdocs-template-card.tsx",
       "encapsulation": "none",
@@ -4644,6 +4772,9 @@
           "verdocs-loader",
           "verdocs-text-input",
           "verdocs-button"
+        ],
+        "verdocs-text-input": [
+          "verdocs-help-icon"
         ]
       }
     },
@@ -4738,6 +4869,9 @@
           "verdocs-checkbox",
           "verdocs-radio-button",
           "verdocs-button"
+        ],
+        "verdocs-text-input": [
+          "verdocs-help-icon"
         ]
       }
     },
@@ -4745,7 +4879,7 @@
       "filePath": "./src/components/templates/verdocs-template-recipients/verdocs-template-recipients.tsx",
       "encapsulation": "none",
       "tag": "verdocs-template-recipients",
-      "docs": "Displays a contact picker suitable for filling out Recipient objects when sending Documents.\n\nThis picker can also be integrated with a backend to provide contact list / suggestion / address-book style behavior. As the\nuser interacts with the component, the text entered in the name field is sent back to the parent via the `searchContacts` event.\nThe parent can use that text as a query string to call a backend to obtain appropriate contacts to show. This list may also be\nhard-coded ahead of time to provide the user with smart suggestions on initial display, such as \"Recently Used\" contacts, or\nto always display the user's own contact record.",
+      "docs": "Displays an edit form that allows the user to adjust a template's recipients and workflow.",
       "docsTags": [],
       "usage": {},
       "props": [
@@ -4811,14 +4945,26 @@
       "dependents": [],
       "dependencies": [
         "verdocs-button",
-        "verdocs-template-sender-dialog"
+        "verdocs-template-role-properties",
+        "verdocs-template-sender"
       ],
       "dependencyGraph": {
         "verdocs-template-recipients": [
           "verdocs-button",
-          "verdocs-template-sender-dialog"
+          "verdocs-template-role-properties",
+          "verdocs-template-sender"
+        ],
+        "verdocs-template-role-properties": [
+          "verdocs-text-input",
+          "verdocs-select-input",
+          "verdocs-help-icon",
+          "verdocs-checkbox",
+          "verdocs-button"
         ],
-        "verdocs-template-sender-dialog": [
+        "verdocs-text-input": [
+          "verdocs-help-icon"
+        ],
+        "verdocs-template-sender": [
           "verdocs-radio-button",
           "verdocs-help-icon",
           "verdocs-button"
@@ -4829,7 +4975,7 @@
       "filePath": "./src/components/templates/verdocs-template-reminders/verdocs-template-reminders.tsx",
       "encapsulation": "none",
       "tag": "verdocs-template-reminders",
-      "docs": "Displays a collection of settings boxes that allow a user to configure a template's behavior.",
+      "docs": "Displays an edit form that allows the user to adjust a template's reminders.",
       "docsTags": [],
       "usage": {},
       "props": [
@@ -4908,43 +5054,101 @@
           "verdocs-button",
           "verdocs-ok-dialog"
         ],
+        "verdocs-text-input": [
+          "verdocs-help-icon"
+        ],
         "verdocs-ok-dialog": [
           "verdocs-button"
         ]
       }
     },
     {
-      "filePath": "./src/components/dialogs/verdocs-template-sender-dialog/verdocs-template-sender-dialog.tsx",
+      "filePath": "./src/components/templates/verdocs-template-role-properties/verdocs-template-role-properties.tsx",
       "encapsulation": "none",
-      "tag": "verdocs-template-sender-dialog",
+      "tag": "verdocs-template-role-properties",
       "docs": "Display a dialog that allows a template sender to be selected.",
       "docsTags": [],
       "usage": {},
       "props": [
         {
-          "name": "value",
-          "type": "TemplateSenderTypes.CREATOR | TemplateSenderTypes.EVERYONE | TemplateSenderTypes.EVERYONE_AS_CREATOR | TemplateSenderTypes.ORGANIZATION_MEMBER | TemplateSenderTypes.ORGANIZATION_MEMBER_AS_CREATOR",
+          "name": "endpoint",
+          "type": "VerdocsEndpoint",
           "mutable": false,
-          "attr": "value",
+          "reflectToAttr": false,
+          "docs": "The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.",
+          "docsTags": [],
+          "default": "VerdocsEndpoint.getDefault()",
+          "values": [
+            {
+              "type": "VerdocsEndpoint"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "roleName",
+          "type": "string",
+          "mutable": false,
+          "attr": "role-name",
+          "reflectToAttr": false,
+          "docs": "The role name to edit.",
+          "docsTags": [],
+          "default": "''",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "sender",
+          "type": "\"creator\" | \"everyone\" | \"everyone_as_creator\" | \"organization_member\" | \"organization_member_as_creator\"",
+          "mutable": false,
+          "attr": "sender",
           "reflectToAttr": false,
           "docs": "Whether the dialog is currently being displayed. This allows it to be added to the DOM before being displayed.",
           "docsTags": [],
           "default": "TemplateSenderTypes.EVERYONE",
           "values": [
             {
-              "type": "TemplateSenderTypes.CREATOR"
+              "value": "creator",
+              "type": "string"
             },
             {
-              "type": "TemplateSenderTypes.EVERYONE"
+              "value": "everyone",
+              "type": "string"
             },
             {
-              "type": "TemplateSenderTypes.EVERYONE_AS_CREATOR"
+              "value": "everyone_as_creator",
+              "type": "string"
             },
             {
-              "type": "TemplateSenderTypes.ORGANIZATION_MEMBER"
+              "value": "organization_member",
+              "type": "string"
             },
             {
-              "type": "TemplateSenderTypes.ORGANIZATION_MEMBER_AS_CREATOR"
+              "value": "organization_member_as_creator",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "templateId",
+          "type": "string",
+          "mutable": false,
+          "attr": "template-id",
+          "reflectToAttr": false,
+          "docs": "The template ID to edit.",
+          "docsTags": [],
+          "default": "''",
+          "values": [
+            {
+              "type": "string"
             }
           ],
           "optional": false,
@@ -4954,21 +5158,157 @@
       "methods": [],
       "events": [
         {
-          "event": "cancel",
+          "event": "close",
           "detail": "any",
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "Event fired when the dialog is closed. The event data will contain the closure reason.",
+          "docs": "Event fired when the user cancels the dialog.",
           "docsTags": []
         },
         {
-          "event": "next",
-          "detail": "TemplateSenderTypes.CREATOR | TemplateSenderTypes.EVERYONE | TemplateSenderTypes.EVERYONE_AS_CREATOR | TemplateSenderTypes.ORGANIZATION_MEMBER | TemplateSenderTypes.ORGANIZATION_MEMBER_AS_CREATOR",
+          "event": "delete",
+          "detail": "{ templateId: string; roleName: string; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the user deletes the role. The parent should update its UI to reflect the removal. When this event is emitted,\nthe role will have already been deleted server-side.",
+          "docsTags": []
+        },
+        {
+          "event": "sdkError",
+          "detail": "SDKError",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired if an error occurs. The event details will contain information about the error. Most errors will\nterminate the process, and the calling application should correct the condition and re-render the component.",
+          "docsTags": []
+        }
+      ],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "verdocs-template-recipients"
+      ],
+      "dependencies": [
+        "verdocs-text-input",
+        "verdocs-select-input",
+        "verdocs-help-icon",
+        "verdocs-checkbox",
+        "verdocs-button"
+      ],
+      "dependencyGraph": {
+        "verdocs-template-role-properties": [
+          "verdocs-text-input",
+          "verdocs-select-input",
+          "verdocs-help-icon",
+          "verdocs-checkbox",
+          "verdocs-button"
+        ],
+        "verdocs-text-input": [
+          "verdocs-help-icon"
+        ],
+        "verdocs-template-recipients": [
+          "verdocs-template-role-properties"
+        ]
+      }
+    },
+    {
+      "filePath": "./src/components/templates/verdocs-template-sender/verdocs-template-sender.tsx",
+      "encapsulation": "none",
+      "tag": "verdocs-template-sender",
+      "docs": "Display a dialog that allows a template sender to be selected.",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "endpoint",
+          "type": "VerdocsEndpoint",
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.",
+          "docsTags": [],
+          "default": "VerdocsEndpoint.getDefault()",
+          "values": [
+            {
+              "type": "VerdocsEndpoint"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "sender",
+          "type": "\"creator\" | \"everyone\" | \"everyone_as_creator\" | \"organization_member\" | \"organization_member_as_creator\"",
+          "mutable": false,
+          "attr": "sender",
+          "reflectToAttr": false,
+          "docs": "Whether the dialog is currently being displayed. This allows it to be added to the DOM before being displayed.",
+          "docsTags": [],
+          "default": "TemplateSenderTypes.EVERYONE",
+          "values": [
+            {
+              "value": "creator",
+              "type": "string"
+            },
+            {
+              "value": "everyone",
+              "type": "string"
+            },
+            {
+              "value": "everyone_as_creator",
+              "type": "string"
+            },
+            {
+              "value": "organization_member",
+              "type": "string"
+            },
+            {
+              "value": "organization_member_as_creator",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "templateId",
+          "type": "string",
+          "mutable": false,
+          "attr": "template-id",
+          "reflectToAttr": false,
+          "docs": "The template ID to edit.",
+          "docsTags": [],
+          "default": "''",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [
+        {
+          "event": "close",
+          "detail": "any",
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "Event fired when the dialog is closed. The event data will contain the selected value.",
+          "docs": "Event fired when the user cancels the dialog.",
+          "docsTags": []
+        },
+        {
+          "event": "sdkError",
+          "detail": "SDKError",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired if an error occurs. The event details will contain information about the error. Most errors will\nterminate the process, and the calling application should correct the condition and re-render the component.",
           "docsTags": []
         }
       ],
@@ -4985,13 +5325,13 @@
         "verdocs-button"
       ],
       "dependencyGraph": {
-        "verdocs-template-sender-dialog": [
+        "verdocs-template-sender": [
           "verdocs-radio-button",
           "verdocs-help-icon",
           "verdocs-button"
         ],
         "verdocs-template-recipients": [
-          "verdocs-template-sender-dialog"
+          "verdocs-template-sender"
         ]
       }
     },
@@ -5033,7 +5373,7 @@
       "filePath": "./src/components/templates/verdocs-template-visibillity/verdocs-template-visibility.tsx",
       "encapsulation": "none",
       "tag": "verdocs-template-visibility",
-      "docs": "Displays a collection of settings boxes that allow a user to configure a template's behavior.",
+      "docs": "Displays an edit form that allows the user to adjust a template's visibility.",
       "docsTags": [],
       "usage": {},
       "props": [
@@ -5152,6 +5492,23 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "helpText",
+          "type": "string",
+          "mutable": false,
+          "attr": "help-text",
+          "reflectToAttr": false,
+          "docs": "If supplied, a help icon will be displayed to provide the user more information.",
+          "docsTags": [],
+          "default": "''",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "label",
           "type": "string",
@@ -5264,10 +5621,16 @@
         "verdocs-signature-dialog",
         "verdocs-template-name",
         "verdocs-template-properties",
-        "verdocs-template-reminders"
+        "verdocs-template-reminders",
+        "verdocs-template-role-properties"
+      ],
+      "dependencies": [
+        "verdocs-help-icon"
       ],
-      "dependencies": [],
       "dependencyGraph": {
+        "verdocs-text-input": [
+          "verdocs-help-icon"
+        ],
         "verdocs-auth": [
           "verdocs-text-input"
         ],
@@ -5303,6 +5666,9 @@
         ],
         "verdocs-template-reminders": [
           "verdocs-text-input"
+        ],
+        "verdocs-template-role-properties": [
+          "verdocs-text-input"
         ]
       }
     },