crisp-api 7.1.0 → 7.3.0

package/CHANGELOG.md

@@ -1,7 +1,19 @@
 Changelog
 =========
 
-## v7.0.1
+## v7.3.0
+
+### New Features
+
+* Added the new `CrispClient.website.listConversationFiles` method.
+
+## v7.2.0
+
+### New Features
+
+* Automated the package release process via GitHub Actions (ie. `npm publish`).
+
+## v7.1.0
 
 ### New Features
 

package/EXAMPLES.md

@@ -292,6 +292,16 @@ CrispClient.website.listConversationEvents(websiteID, sessionID, pageNumber);
 
 =========================
 
+https://docs.crisp.chat/references/rest-api/v1/#list-conversation-files
+
+var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
+var pageNumber = 1;
+
+CrispClient.website.listConversationFiles(websiteID, sessionID, pageNumber);
+
+=========================
+
 https://docs.crisp.chat/references/rest-api/v1/#get-conversation-state
 
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Crisp
+Copyright (c) 2023 Crisp
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,12 +1,12 @@
 # Crisp API Wrapper
 
-[![Test and Build](https://github.com/crisp-im/node-crisp-api/workflows/Test%20and%20Build/badge.svg?branch=master)](https://github.com/crisp-im/node-crisp-api/actions?query=workflow%3A%22Test+and+Build%22) [![NPM](https://img.shields.io/npm/v/crisp-api.svg)](https://www.npmjs.com/package/crisp-api) [![Downloads](https://img.shields.io/npm/dt/crisp-api.svg)](https://www.npmjs.com/package/crisp-api)
+[![Test and Build](https://github.com/crisp-im/node-crisp-api/workflows/Test%20and%20Build/badge.svg?branch=master)](https://github.com/crisp-im/node-crisp-api/actions?query=workflow%3A%22Test+and+Build%22) [![Build and Release](https://github.com/crisp-im/node-crisp-api/workflows/Build%20and%20Release/badge.svg)](https://github.com/crisp-im/node-crisp-api/actions?query=workflow%3A%22Build+and+Release%22) [![Version](https://img.shields.io/npm/v/crisp-api.svg)](https://www.npmjs.com/package/crisp-api) [![Downloads](https://img.shields.io/npm/dt/crisp-api.svg)](https://www.npmjs.com/package/crisp-api)
 
 The Crisp API Node wrapper. Authenticate, send messages, fetch conversations, access your agent accounts from your JavaScript code.
 
-Copyright 2022 Crisp IM SAS. See LICENSE for copying information.
+Copyright 2023 Crisp IM SAS. See LICENSE for copying information.
 
-* **📝 Implements**: [REST API Reference (V1)](https://docs.crisp.chat/references/rest-api/v1/) at revision: 29/07/2022
+* **📝 Implements**: [REST API Reference (V1)](https://docs.crisp.chat/references/rest-api/v1/) at revision: 16/01/2023
 * **😘 Maintainers**: [@baptistejamin](https://github.com/baptistejamin), [@eliottvincent](https://github.com/eliottvincent), [@valeriansaliou](https://github.com/valeriansaliou)
 
 ## Installation
@@ -566,6 +566,20 @@ All methods that you will most likely need when building a Crisp integration are
       ```
       </details>
 
+  * **List Conversation Files** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-conversation-files)
+    * `CrispClient.website.listConversationFiles(websiteID, sessionID, pageNumber)`
+    * <details>
+      <summary>See Example</summary>
+
+      ```javascript
+      var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
+      var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
+      var pageNumber = 1;
+
+      CrispClient.website.listConversationFiles(websiteID, sessionID, pageNumber);
+      ```
+      </details>
+
   * **Get Conversation State** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-conversation-state)
     * `CrispClient.website.getConversationState(websiteID, sessionID)`
     * <details>

package/lib/crisp.js

@@ -998,8 +998,7 @@ Crisp.prototype = {
   },
 
   /**
-   * Verifies an event string and checks that signatures match (used for Web \
-   *   Hooks, Widgets)
+   * Verifies an event string and checks that signatures match
    * @memberof Crisp
    * @private
    * @method verifyHook

package/lib/resources/WebsiteConversation.js

@@ -432,6 +432,20 @@ function WebsiteConversation(service, crisp) {
     );
   };
 
+  /**
+   * List Conversation Files
+   * @memberof WebsiteConversation
+   * @method listConversationFiles
+   * @return Promise
+   */
+  service.listConversationFiles = function(websiteID, sessionID, pageNumber) {
+    return crisp.get(
+      crisp._prepareRestUrl([
+        "website", websiteID, "conversation", sessionID, "files", pageNumber
+      ])
+    );
+  };
+
   /**
    * Get Conversation State
    * @memberof WebsiteConversation

package/package.json

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