@verdocs/web-sdk 2.1.4 → 2.2.1

package/dist/docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2023-09-13T23:21:22",
+  "timestamp": "2023-09-21T21:22:27",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.20.0",
@@ -683,6 +683,10 @@
         "verdocs-kba-dialog",
         "verdocs-ok-dialog",
         "verdocs-send",
+        "verdocs-settings-api-keys",
+        "verdocs-settings-members",
+        "verdocs-settings-organization",
+        "verdocs-settings-profile",
         "verdocs-sign",
         "verdocs-signature-dialog",
         "verdocs-template-attachments",
@@ -734,6 +738,18 @@
         "verdocs-send": [
           "verdocs-button"
         ],
+        "verdocs-settings-api-keys": [
+          "verdocs-button"
+        ],
+        "verdocs-settings-members": [
+          "verdocs-button"
+        ],
+        "verdocs-settings-organization": [
+          "verdocs-button"
+        ],
+        "verdocs-settings-profile": [
+          "verdocs-button"
+        ],
         "verdocs-sign": [
           "verdocs-button"
         ],
@@ -5513,6 +5529,7 @@
       "parts": [],
       "dependents": [
         "verdocs-preview",
+        "verdocs-settings",
         "verdocs-sign",
         "verdocs-template-attachments",
         "verdocs-template-create",
@@ -5526,6 +5543,9 @@
         "verdocs-preview": [
           "verdocs-loader"
         ],
+        "verdocs-settings": [
+          "verdocs-loader"
+        ],
         "verdocs-sign": [
           "verdocs-loader"
         ],
@@ -6607,6 +6627,7 @@
       "parts": [],
       "dependents": [
         "verdocs-auth",
+        "verdocs-settings-organization",
         "verdocs-template-field-properties",
         "verdocs-template-fields",
         "verdocs-template-role-properties"
@@ -6616,6 +6637,9 @@
         "verdocs-auth": [
           "verdocs-select-input"
         ],
+        "verdocs-settings-organization": [
+          "verdocs-select-input"
+        ],
         "verdocs-template-field-properties": [
           "verdocs-select-input"
         ],
@@ -6740,6 +6764,397 @@
         ]
       }
     },
+    {
+      "filePath": "./src/components/embeds/verdocs-settings/verdocs-settings.tsx",
+      "encapsulation": "none",
+      "tag": "verdocs-settings",
+      "docs": "Display a template preview experience. This will display the template's attached\ndocuments with signing fields overlaid on each page. Fields will be color-coded\nby recipient, and will be read-only (cannot be filled, moved, or altered).",
+      "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
+        }
+      ],
+      "methods": [],
+      "events": [
+        {
+          "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",
+        "verdocs-settings-profile",
+        "verdocs-settings-organization",
+        "verdocs-settings-members",
+        "verdocs-settings-api-keys"
+      ],
+      "dependencyGraph": {
+        "verdocs-settings": [
+          "verdocs-loader",
+          "verdocs-settings-profile",
+          "verdocs-settings-organization",
+          "verdocs-settings-members",
+          "verdocs-settings-api-keys"
+        ],
+        "verdocs-settings-profile": [
+          "verdocs-text-input",
+          "verdocs-button"
+        ],
+        "verdocs-text-input": [
+          "verdocs-help-icon"
+        ],
+        "verdocs-settings-organization": [
+          "verdocs-text-input",
+          "verdocs-select-input",
+          "verdocs-button"
+        ],
+        "verdocs-settings-members": [
+          "verdocs-table",
+          "verdocs-button"
+        ],
+        "verdocs-settings-api-keys": [
+          "verdocs-table",
+          "verdocs-button"
+        ]
+      }
+    },
+    {
+      "filePath": "./src/components/settings/verdocs-settings-api-keys/verdocs-settings-api-keys.tsx",
+      "encapsulation": "none",
+      "tag": "verdocs-settings-api-keys",
+      "docs": "Displays a settings form that allows the user to manage their API keys.",
+      "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
+        }
+      ],
+      "methods": [],
+      "events": [
+        {
+          "event": "memberInvited",
+          "detail": "{ endpoint: VerdocsEndpoint; member: IProfile; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the user chooses to invite a new member.",
+          "docsTags": []
+        },
+        {
+          "event": "memberRemoved",
+          "detail": "{ endpoint: VerdocsEndpoint; member: IProfile; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the user chooses to invite a new member.",
+          "docsTags": []
+        },
+        {
+          "event": "memberUpdated",
+          "detail": "{ endpoint: VerdocsEndpoint; member: IProfile; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the user chooses to invite a new member.",
+          "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-settings"
+      ],
+      "dependencies": [
+        "verdocs-table",
+        "verdocs-button"
+      ],
+      "dependencyGraph": {
+        "verdocs-settings-api-keys": [
+          "verdocs-table",
+          "verdocs-button"
+        ],
+        "verdocs-settings": [
+          "verdocs-settings-api-keys"
+        ]
+      }
+    },
+    {
+      "filePath": "./src/components/settings/verdocs-settings-members/verdocs-settings-members.tsx",
+      "encapsulation": "none",
+      "tag": "verdocs-settings-members",
+      "docs": "Displays a settings form that allows the user to manage their Verdocs profile.",
+      "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
+        }
+      ],
+      "methods": [],
+      "events": [
+        {
+          "event": "memberInvited",
+          "detail": "{ endpoint: VerdocsEndpoint; member: IProfile; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the user chooses to invite a new member.",
+          "docsTags": []
+        },
+        {
+          "event": "memberRemoved",
+          "detail": "{ endpoint: VerdocsEndpoint; member: IProfile; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the user chooses to invite a new member.",
+          "docsTags": []
+        },
+        {
+          "event": "memberUpdated",
+          "detail": "{ endpoint: VerdocsEndpoint; member: IProfile; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the user chooses to invite a new member.",
+          "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-settings"
+      ],
+      "dependencies": [
+        "verdocs-table",
+        "verdocs-button"
+      ],
+      "dependencyGraph": {
+        "verdocs-settings-members": [
+          "verdocs-table",
+          "verdocs-button"
+        ],
+        "verdocs-settings": [
+          "verdocs-settings-members"
+        ]
+      }
+    },
+    {
+      "filePath": "./src/components/settings/verdocs-settings-organization/verdocs-settings-organization.tsx",
+      "encapsulation": "none",
+      "tag": "verdocs-settings-organization",
+      "docs": "Displays a settings form that allows the user to manage their Verdocs profile.",
+      "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
+        }
+      ],
+      "methods": [],
+      "events": [
+        {
+          "event": "organizationUpdated",
+          "detail": "{ endpoint: VerdocsEndpoint; organization: IOrganization; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the user chooses the Edit option from the dropdown menu.",
+          "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-settings"
+      ],
+      "dependencies": [
+        "verdocs-text-input",
+        "verdocs-select-input",
+        "verdocs-button"
+      ],
+      "dependencyGraph": {
+        "verdocs-settings-organization": [
+          "verdocs-text-input",
+          "verdocs-select-input",
+          "verdocs-button"
+        ],
+        "verdocs-text-input": [
+          "verdocs-help-icon"
+        ],
+        "verdocs-settings": [
+          "verdocs-settings-organization"
+        ]
+      }
+    },
+    {
+      "filePath": "./src/components/settings/verdocs-settings-profile/verdocs-settings-profile.tsx",
+      "encapsulation": "none",
+      "tag": "verdocs-settings-profile",
+      "docs": "Displays a settings form that allows the user to manage their Verdocs profile.",
+      "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
+        }
+      ],
+      "methods": [],
+      "events": [
+        {
+          "event": "profileUpdated",
+          "detail": "{ endpoint: VerdocsEndpoint; profile: IProfile; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the user chooses the Edit option from the dropdown menu.",
+          "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-settings"
+      ],
+      "dependencies": [
+        "verdocs-text-input",
+        "verdocs-button"
+      ],
+      "dependencyGraph": {
+        "verdocs-settings-profile": [
+          "verdocs-text-input",
+          "verdocs-button"
+        ],
+        "verdocs-text-input": [
+          "verdocs-help-icon"
+        ],
+        "verdocs-settings": [
+          "verdocs-settings-profile"
+        ]
+      }
+    },
     {
       "filePath": "./src/components/embeds/verdocs-sign/verdocs-sign.tsx",
       "encapsulation": "none",
@@ -7165,6 +7580,67 @@
         ]
       }
     },
+    {
+      "filePath": "./src/components/controls/verdocs-table/verdocs-table.tsx",
+      "encapsulation": "none",
+      "tag": "verdocs-table",
+      "docs": "Display a simple table of data. Columns and data cells may have custom renderers defined to\nsupport creating interactive table layouts.",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "columns",
+          "type": "IColumn[]",
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "The columns to display",
+          "docsTags": [],
+          "default": "[]",
+          "values": [
+            {
+              "type": "IColumn[]"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "data",
+          "type": "any[]",
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "The rows to display",
+          "docsTags": [],
+          "default": "[]",
+          "values": [
+            {
+              "type": "any[]"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "verdocs-settings-api-keys",
+        "verdocs-settings-members"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "verdocs-settings-api-keys": [
+          "verdocs-table"
+        ],
+        "verdocs-settings-members": [
+          "verdocs-table"
+        ]
+      }
+    },
     {
       "filePath": "./src/components/templates/verdocs-template-attachments/verdocs-template-attachments.tsx",
       "encapsulation": "none",
@@ -9147,6 +9623,8 @@
         "verdocs-auth",
         "verdocs-envelopes-list",
         "verdocs-initial-dialog",
+        "verdocs-settings-organization",
+        "verdocs-settings-profile",
         "verdocs-signature-dialog",
         "verdocs-template-field-properties",
         "verdocs-template-name",
@@ -9170,6 +9648,12 @@
         "verdocs-initial-dialog": [
           "verdocs-text-input"
         ],
+        "verdocs-settings-organization": [
+          "verdocs-text-input"
+        ],
+        "verdocs-settings-profile": [
+          "verdocs-text-input"
+        ],
         "verdocs-signature-dialog": [
           "verdocs-text-input"
         ],

package/dist/esm/Profiles-7645e6f1.js

@@ -0,0 +1,88 @@
+/**
+ * An Organization is the top level object for ownership for Members, Documents, and Templates.
+ *
+ * @module
+ */
+/**
+ * Get an organization by ID.
+ */
+var getOrganization = function (endpoint, organizationId) {
+    return endpoint.api //
+        .get("/organizations/".concat(organizationId))
+        .then(function (r) { return r.data; });
+};
+/**
+ * Update an organization.
+ */
+var updateOrganization = function (endpoint, organizationId, params) {
+    return endpoint.api //
+        .patch("/organizations/".concat(organizationId), params)
+        .then(function (r) { return r.data; });
+};
+/**
+ * Check if an organization name is available. Typically used during the sign-up process. This endpoint is rate-limited
+ * to prevent abuse. Developers experiencing problems with testing new applications should contact support.
+ */
+var isOrgAvailable = function (endpoint, name) {
+    return endpoint.api //
+        .post('/organizations/check-availability', { name: name }, { baseURL: endpoint.getBaseURLv2() })
+        .then(function (r) { return r.data; });
+};
+
+/**
+ * Get the user's available profiles. The current profile will be marked with `current: true`.
+ *
+ * ```typescript
+ * import {Profiles} from '@verdocs/js-sdk/Users';
+ *
+ * const profiles = await Profiles.getProfiles()
+ * ```
+ */
+/**
+ * Get the user's available profiles. The current profile will be marked with `current: true`.
+ *
+ * ```typescript
+ * import {Profiles} from '@verdocs/js-sdk/Users';
+ *
+ * const profiles = await Profiles.getCurrentProfile()
+ * ```
+ */
+var getCurrentProfile = function (endpoint) {
+    return endpoint.api //
+        .get('/profiles')
+        .then(function (r) { return (r.data || []).find(function (profile) { return profile.current; }); });
+};
+/**
+ * Update a profile. For future expansion, the profile ID to update is required, but currently this must also be the
+ * "current" profile for the caller.
+ *
+ * ```typescript
+ * import {Profiles} from '@verdocs/js-sdk/Users';
+ *
+ * const newProfile = await Profiles.updateProfile('PROFILEID');
+ * ```
+ */
+var updateProfile = function (endpoint, profileId, params) {
+    return endpoint.api //
+        .put("/profiles/".concat(profileId), params)
+        .then(function (r) { return r.data; });
+};
+/**
+ * Create a user account and parent organization. This endpoint is for creating a new organization. Users joining an
+ * existing organization should be invited, and follow their invitation links/instructions to create their accounts.
+ *
+ * ```typescript
+ * import {Profiles} from '@verdocs/js-sdk/Users';
+ *
+ * const newAccount = await Profiles.createBusinessAccount({
+ *   orgName: 'ORG', email: 'a@b.com', password: '12345678', firstName: 'FIRST', lastName: 'LAST'
+ * });
+ * ```
+ */
+var createBusinessAccount = function (endpoint, params) {
+    return endpoint.api //
+        .post('/user/business', params)
+        .then(function (r) { return r.data; });
+};
+
+export { getCurrentProfile as a, updateProfile as b, createBusinessAccount as c, getOrganization as g, isOrgAvailable as i, updateOrganization as u };