From 9127bc59cbac8090f336b3c676c0a0cf4fedb6d3 Mon Sep 17 00:00:00 2001 From: Valerian Saliou Date: Thu, 17 Oct 2024 11:12:06 +0200 Subject: [PATCH] Update specs (verify becomes an object with keys: method={password|token},secret) --- EXAMPLES.md | 16 +++++++++++++--- README.md | 16 +++++++++++++--- lib/resources/WebsiteBase.js | 2 +- lib/resources/WebsiteHelpdesk.js | 2 +- lib/resources/WebsiteOperator.js | 2 +- 5 files changed, 29 insertions(+), 9 deletions(-) diff --git a/EXAMPLES.md b/EXAMPLES.md index 19d603d..4ea9110 100644 --- a/EXAMPLES.md +++ b/EXAMPLES.md @@ -948,7 +948,10 @@ https://docs.crisp.chat/references/rest-api/v1/#delete-helpdesk var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc"; -var verify = "MySuperSecurePassword"; +var verify = { + "method": "password", + "secret": "MySuperSecurePassword"; +}; CrispClient.website.deleteHelpdesk(websiteID, verify); @@ -1581,7 +1584,10 @@ https://docs.crisp.chat/references/rest-api/v1/#delete-a-website var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc"; -var verify = "MySuperSecurePassword"; +var verify = { + "method": "password", + "secret": "MySuperSecurePassword"; +}; CrispClient.website.deleteWebsite(websiteID, verify); @@ -1736,7 +1742,11 @@ var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc"; var email = "julien@crisp.chat"; var role = "member"; -var verify = "MySuperSecurePassword"; + +var verify = { + "method": "password", + "secret": "MySuperSecurePassword"; +}; CrispClient.website.inviteWebsiteOperator(websiteID, email, role, verify); diff --git a/README.md b/README.md index b057054..cfb1192 100644 --- a/README.md +++ b/README.md @@ -1457,7 +1457,10 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._ ```javascript var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc"; - var verify = "MySuperSecurePassword"; + var verify = { + "method": "password", + "secret": "MySuperSecurePassword"; + }; CrispClient.website.deleteHelpdesk(websiteID, verify); ``` @@ -2309,7 +2312,10 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._ ```javascript var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc"; - var verify = "MySuperSecurePassword"; + var verify = { + "method": "password", + "secret": "MySuperSecurePassword"; + }; CrispClient.website.deleteWebsite(websiteID, verify); ``` @@ -2504,7 +2510,11 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._ var email = "julien@crisp.chat"; var role = "member"; - var verify = "MySuperSecurePassword"; + + var verify = { + "method": "password", + "secret": "MySuperSecurePassword"; + }; CrispClient.website.inviteWebsiteOperator(websiteID, email, role, verify); ``` diff --git a/lib/resources/WebsiteBase.js b/lib/resources/WebsiteBase.js index 5ddd0b7..40a92e8 100644 --- a/lib/resources/WebsiteBase.js +++ b/lib/resources/WebsiteBase.js @@ -67,7 +67,7 @@ function WebsiteBase(service, crisp) { * @public * @method deleteWebsite * @param {string} websiteID - * @param {string} verify + * @param {object} verify * @return {Promise} */ service.deleteWebsite = function(websiteID, verify) { diff --git a/lib/resources/WebsiteHelpdesk.js b/lib/resources/WebsiteHelpdesk.js index 5beb8f5..1c8a6d6 100644 --- a/lib/resources/WebsiteHelpdesk.js +++ b/lib/resources/WebsiteHelpdesk.js @@ -70,7 +70,7 @@ function WebsiteHelpdesk(service, crisp) { * @public * @method deleteHelpdesk * @param {string} websiteID - * @param {string} verify + * @param {object} verify * @return {Promise} */ service.deleteHelpdesk = function(websiteID, verify) { diff --git a/lib/resources/WebsiteOperator.js b/lib/resources/WebsiteOperator.js index 676171b..c64fb3a 100644 --- a/lib/resources/WebsiteOperator.js +++ b/lib/resources/WebsiteOperator.js @@ -105,7 +105,7 @@ function WebsiteOperator(service, crisp) { * @param {string} websiteID * @param {string} email * @param {string} role - * @param {string} verify + * @param {object} verify * @return {Promise} */ service.inviteWebsiteOperator = function(websiteID, email, role, verify) {