crisp-api 8.2.3 → 8.3.1

package/CHANGELOG.md

@@ -1,17 +1,29 @@
 Changelog
 =========
 
+## v8.3.1
+
+### New Features
+
+* Added the new `CrispClient.plugin.getPluginUsageBills` method.
+
+## v8.3.0
+
+### New Features
+
+* Added the new `CrispClient.plugin.reportPluginUsageToBill` method.
+
 ## v8.2.3
 
-### Changes
+### Bug Fixes
 
-* Use a `github:` prefix for dependency `fbemitter` to fix issue 59 related to Yarn 3
+* Use a `github:` prefix on dependency `fbemitter` to fix Yarn 3 (closes [#59](https://github.com/crisp-im/node-crisp-api/issues/59)).
 
 ## v8.2.2
 
 ### Changes
 
-* Added an options parameter on `CrispClient.website.listHelpdeskLocales(websiteID, pageNumber, options)`
+* Added an options parameter on `CrispClient.website.listHelpdeskLocales(websiteID, pageNumber, options)`.
 
 ## v8.2.1
 

package/EXAMPLES.md

@@ -1570,6 +1570,7 @@ var settings = {
   "chatbox": {
     "tile": "default",
     "wait_game": false,
+    "website_logo": true,
     "last_operator_face": false,
     "ongoing_operator_face": true,
     "activity_metrics": true,

package/README.md

@@ -2288,6 +2288,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
         "chatbox": {
           "tile": "default",
           "wait_game": false,
+          "website_logo": true,
           "last_operator_face": false,
           "ongoing_operator_face": true,
           "activity_metrics": true,
@@ -3205,6 +3206,38 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
       ```
       </details>
 
+  * **Get Plugin Usage Bills** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-plugin-usage-bills)
+    * `CrispClient.plugin.getPluginUsageBills(websiteID, pluginID)`
+    * <details>
+      <summary>See Example</summary>
+
+      ```javascript
+      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+      var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
+
+      CrispClient.plugin.getPluginUsageBills(websiteID, pluginID);
+      ```
+      </details>
+
+  * **Report Plugin Usage To Bill** [`plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#report-plugin-usage-to-bill)
+    * `CrispClient.plugin.reportPluginUsageToBill(websiteID, pluginID, usage)`
+    * <details>
+      <summary>See Example</summary>
+
+      ```javascript
+      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+      var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
+
+      var usage = {
+        "name": "Paid messages sent",
+        "units": 250,
+        "price": 0.10
+      };
+
+      CrispClient.plugin.reportPluginUsageToBill(websiteID, pluginID, usage);
+      ```
+      </details>
+
   * **Forward Plugin Payload To Channel** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#forward-plugin-payload-to-channel)
     * `CrispClient.plugin.forwardPluginPayloadToChannel(websiteID, pluginID, payload)`
     * <details>

package/lib/resources/PluginSubscription.js

@@ -150,6 +150,43 @@ function PluginSubscription(service, crisp) {
     );
   };
 
+  /**
+   * Get Plugin Usage Bills
+   * @memberof PluginSubscription
+   * @public
+   * @method getPluginUsageBills
+   * @param {string} websiteID
+   * @param {string} pluginID
+   * @return {Promise}
+   */
+  service.getPluginUsageBills = function(websiteID, pluginID) {
+    return crisp.get(
+      crisp._prepareRestUrl([
+        "plugins", "subscription", websiteID, pluginID, "bill", "usage"
+      ])
+    );
+  };
+
+  /**
+   * Report Plugin Usage To Bill
+   * @memberof PluginSubscription
+   * @public
+   * @method reportPluginUsageToBill
+   * @param {string} websiteID
+   * @param {string} pluginID
+   * @param {object} usage
+   * @return {Promise}
+   */
+  service.reportPluginUsageToBill = function(websiteID, pluginID, usage) {
+    return crisp.post(
+      crisp._prepareRestUrl([
+        "plugins", "subscription", websiteID, pluginID, "bill", "usage"
+      ]),
+
+      null, usage
+    );
+  };
+
   /**
    * Forward Plugin Payload To Channel
    * @memberof PluginSubscription

package/lib/resources/WebsiteHelpdesk.js

@@ -184,7 +184,8 @@ function WebsiteHelpdesk(service, crisp) {
    * @return {Promise}
    */
   service.listHelpdeskLocaleArticles = function(
-    websiteID, locale, pageNumber, options = {}) {
+    websiteID, locale, pageNumber, options={}
+  ) {
     return crisp.get(
       crisp._prepareRestUrl([
         "website", websiteID, "helpdesk", "locale", locale, "articles",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "crisp-api",
   "description": "Crisp API wrapper for Node - official, maintained by Crisp",
-  "version": "8.2.3",
+  "version": "8.3.1",
   "homepage": "https://github.com/crisp-im/node-crisp-api",
   "license": "MIT",
   "author": {