⚠️ Changed theverifyargument of theCrispClient.website.inviteWebsiteOperatormethod (to be a verification challenge).⚠️ Changed theverifyargument of theCrispClient.website.deleteHelpdeskmethod (to be a verification challenge).⚠️ Changed theverifyargument of theCrispClient.website.deleteWebsitemethod (to be a verification challenge).
⚠️ Restored the argument of theCrispClient.website.inviteWebsiteOperatormethod to its specification from pre-v9.3.0.
⚠️ Changed the argument of theCrispClient.website.inviteWebsiteOperatormethod.
- Added support for the
spam:messageRTM API event. - Added support for the
spam:decisionRTM API event.
- Added the new
CrispClient.website.listSpamConversationmethod. - Added the new
CrispClient.website.resolveSpamConversationContentmethod. - Added the new
CrispClient.website.submitSpamConversationDecisionmethod.
⚠️ Removed theCrispClient.website.acquireAnalyticsPointsmethod (API route has been removed).⚠️ Removed theCrispClient.website.listAnalyticsFiltersmethod (API route has been removed).⚠️ Removed theCrispClient.website.listAnalyticsClassifiersmethod (API route has been removed).
- Added the new
CrispClient.website.generateAnalyticsmethod.
⚠️ Changed the argument of theCrispClient.website.batchResolveConversationsmethod.⚠️ Changed the argument of theCrispClient.website.batchReadConversationsmethod.⚠️ Changed the argument of theCrispClient.website.batchRemoveConversationsmethod.
- Added the new
CrispClient.website.updateConversationInboxmethod.
- Added the new
CrispClient.website.abortWebsiteDeletionmethod.
- Added the new
CrispClient.website.resolveHelpdeskLocaleArticlePagemethod.
- Added the new
CrispClient.plugin.getPluginUsageBillsmethod.
- Added the new
CrispClient.plugin.reportPluginUsageToBillmethod.
- Use a
github:prefix on dependencyfbemitterto fix Yarn 3 (closes #59).
- Added an options parameter on
CrispClient.website.listHelpdeskLocales(websiteID, pageNumber, options).
- Added provenance information upon building NPM package over GitHub Actions.
- Added support for the
session:sync:topicRTM API event.
- Fixed an issue where
CrispClient.rebindSocketandCrispClient._connectLoopbackbase methods would not work due to undefinedthisreferences.
- Updated
socket.io-clientdependency to latest.
- Updated TypeScript definitions.
- Updated TypeScript definitions.
- Added support for all Helpdesk REST API routes, which have been opened to integrations.
- Minor
README.mdtitle fixes.
- Changed type of exported services in JSDoc to
anyso that TypeScript projects can use resource methods withouttscthrowing errors.
- Generated up-to-date TypeScript definitions.
- Fixed the automatic generation of TypeScript definitions.
- Added the new
CrispClient.website.listConversationFilesmethod.
- Automated the package release process via GitHub Actions (ie.
npm publish).
- Added
CrispClient.verifyWidgetto verify Widget Events.
⚠️ Renamed theCrispClient.rebindmethod intoCrispClient.rebindSocket(update your code if you use it).
- Added support for receiving Web Hooks through the RTM events pipeline (via
CrispClient.setRtmMode(Crisp.RTM_MODES.WebHooks)).
- Return more informative error reasons for non
2xx / 3xxresponse codes onHEADrequests.
- Added the new
CrispClient.website.requestUserFeedbackForConversationmethod.
- Prevent Got from throwing errors for non
2xx / 3xxresponse codes. - Fixed body payload type.
⚠️ Support for NodeJS 8 has been removed. The minimum version is now NodeJS 10.
- Upgraded dependencies (closes #30).
- Added the new
CrispClient.rebindmethod, which requests the RTM API to rebind to newly installed/subscribed websites (depending on the authentication tier).
- Added the new
CrispClient.website.getVerifyStatusForConversationmethod. - Added the new
CrispClient.website.updateVerifyStatusForConversationmethod.
- Added the new
CrispClient.website.removeMessageInConversationmethod. - Added support for the
message:removedRTM API event.
⚠️ Support for NodeJS 6 has been removed. The minimum version is now NodeJS 8.⚠️ TheCrispClient.onmethod now returns aPromise. Please update your code accordingly. We do recommend that you add error catchers.
- The RTM API URL is now dynamically pulled from the REST API, based on the authentication tier. This allows for (much) more efficient message routing at Crisp scale, and offers performance and stability benefits to your integration.
- Fixed an issue where the library would not reconnect to the RTM API when it lost connection with the server.
- Added the new
CrispClient.plugin.getConnectEndpointsmethod.
- Upgraded Socket.IO from v2 to v4, meaning that
node-crisp-apiis now connecting to the RTM API over EIO protocol version 4 (versus EIO 3 before).
- Added support for the
session:set_subjectRTM API event.
- Added a new parameter
modeto theCrispClient.website.initiateNewCallSessionForConversationmethod.
- Improved
README.mdreferences to REST API and RTM API resources.
- Added a new parameter
datato theCrispClient.website.deliverWidgetDataFetchActionForConversationmethod.
- Minor
README.mdtitle change.
⚠️ The package has been renamed fromnode-crisp-apitocrisp-api. Since it is typical of NPM packages to skip thenode-prefix in their name, we chose to normalize the package name to this community standard. The programmatic API did not change, so you can simply update the package name to the new name in yourpackage.jsonand all imports.
- Added the new
CrispClient.website.updatePeopleDatamethod.
- Fixed TypeScript types not being picked up correctly.
- Added TypeScript definitions.
- Fixed a typo in the
BucketURLresource include from itsBucketservice.
- The
CrispClient.website.debugExistingBrowsingSessionmethod has been removed, following the sunset of the LiveDebug feature across our products.
🆘 Major changes follow, that will likely require that you update your integration code. If you want to wait to apply those changes, we recommend that you pin node-crisp-api to 3.0.0 or lower in your package.json.
⚠️ All resource methods have been nested into their parent category, eg.website. So all calls to eg.CrispClient.websiteConversationorCrispClient.websitePeoplebecomeCrispClient.website. This makes API calls more readable throughout your code.
🆘 Major changes follow, that will likely require that you update your integration code. If you want to wait to apply those changes, we recommend that you pin node-crisp-api to 2.0.0 or lower in your package.json.
⚠️ The programmatic interface tonode-crisp-apihas been completely revamped, so that all REST API methods specified in REST API Reference (V1) are also available in this wrapper. Most method names have been changed as to match their name in the reference. Please check the README for a full list of available methods.