crisp-api 10.0.3 → 10.0.5

package/CHANGELOG.md

@@ -1,16 +1,40 @@
 Changelog
 =========
 
+## v10.0.5
+
+### Changes
+
+* Provide more types.
+
+## v10.0.4
+
+### Changes
+
+* Provide more types.
+
 ## v10.0.3
 
-# Return missing type on website.listHelpdeskLocales
+### Changes
+
+* Provide more types.
+
+## v10.0.2
+
+### Changes
+
+* No changes.
 
 ## v10.0.1
 
+### Changes
+
 * Routes supporting pagination can be used without a page argument (page is set to `1` by default).
 
 ## v10.0.0
 
+### New Features
+
 * Added TypeScript support (retro-compatible).
 
 ## v9.13.0

package/dist/crisp.js

@@ -45,7 +45,7 @@ const AVAILABLE_RTM_MODES = [
     "websockets",
     "webhooks"
 ];
-const VERSION = "10.0.3";
+const VERSION = "10.0.5";
 // Base configuration
 const DEFAULT_REQUEST_TIMEOUT = 10000;
 const DEFAULT_SOCKET_TIMEOUT = 10000;

package/dist/resources/PluginConnect.d.ts

@@ -8,7 +8,7 @@ import BaseResource from "./BaseResource";
 export type PluginConnectAccount = {
     plugin_id?: string;
 };
-export type PluginConnectAllWebsites = {
+export type PluginConnectAllWebsite = {
     website_id?: string;
     token?: string;
     settings?: object;
@@ -43,7 +43,7 @@ declare class PluginConnect extends BaseResource {
     /**
      * List All Connect Websites
      */
-    listAllConnectWebsites(pageNumber: number, filterConfigured: boolean): Promise<PluginConnectAllWebsites>;
+    listAllConnectWebsites(pageNumber: number, filterConfigured: boolean): Promise<PluginConnectAllWebsite[]>;
     /**
      * List Connect Websites Since
      */

package/dist/resources/PluginSubscription.d.ts

@@ -5,7 +5,7 @@ import BaseResource from "./BaseResource";
 /**************************************************************************
  * TYPES
  ***************************************************************************/
-type PluginSubscription = {
+export type PluginSubscription = {
     id?: string;
     urn?: string;
     type?: string;
@@ -27,12 +27,12 @@ type PluginSubscription = {
     website_id?: string;
     card_id?: string;
 };
-type PluginSubscriptionPlan = {
+export type PluginSubscriptionPlan = {
     id?: string;
     name?: string;
     price?: number;
 };
-type PluginSubscriptionSettings = {
+export type PluginSubscriptionSettings = {
     plugin_id?: string;
     website_id?: string;
     token?: string;
@@ -41,12 +41,12 @@ type PluginSubscriptionSettings = {
     settings_form_url?: string;
     callback_url?: string;
 };
-type PluginSubscriptionChannelForward = {
+export type PluginSubscriptionChannelForward = {
     namespace?: string;
     identifier?: string;
     payload?: object;
 };
-type PluginSubscriptionEventDispatch = {
+export type PluginSubscriptionEventDispatch = {
     name?: string;
     data?: object;
 };

package/dist/resources/WebsiteHelpdesk.d.ts

@@ -35,6 +35,10 @@ export interface HelpdeskLocaleArticleAlternate {
     locale?: string;
     article_id?: string;
 }
+export interface HelpdeskLocaleArticlePage {
+    title?: string;
+    url?: string;
+}
 export interface HelpdeskLocaleSection {
     section_id?: string;
     name?: string;
@@ -200,7 +204,7 @@ declare class WebsiteHelpdesk extends BaseResource {
     /**
      * Resolve Helpdesk Locale Article Page
      */
-    resolveHelpdeskLocaleArticlePage(websiteID: string, locale: string, articleId: string): Promise<any>;
+    resolveHelpdeskLocaleArticlePage(websiteID: string, locale: string, articleId: string): Promise<HelpdeskLocaleArticlePage>;
     /**
      * Resolve Helpdesk Locale Article Category
      */

package/lib/resources/PluginConnect.ts

@@ -20,7 +20,7 @@ export type PluginConnectAccount = {
   plugin_id?: string;
 };
 
-export type PluginConnectAllWebsites = {
+export type PluginConnectAllWebsite = {
   website_id?: string;
   token?: string;
   settings?: object;
@@ -74,7 +74,7 @@ class PluginConnect extends BaseResource {
    */
   listAllConnectWebsites(
     pageNumber: number, filterConfigured: boolean
-  ): Promise<PluginConnectAllWebsites> {
+  ): Promise<PluginConnectAllWebsite[]> {
     // Generate query
     let query = {
       filter_configured: (

package/lib/resources/PluginSubscription.ts

@@ -16,7 +16,7 @@ import BaseResource from "./BaseResource";
  * TYPES
  ***************************************************************************/
 
-type PluginSubscription = {
+export type PluginSubscription = {
   id?:            string;
   urn?:           string;
   type?:          string;
@@ -39,13 +39,13 @@ type PluginSubscription = {
   card_id?:       string;
 }
 
-type PluginSubscriptionPlan = {
+export type PluginSubscriptionPlan = {
   id?:     string;
   name?:   string;
   price?:  number;
 }
 
-type PluginSubscriptionSettings = {
+export type PluginSubscriptionSettings = {
   plugin_id?:       string;
   website_id?:      string;
   token?:           string;
@@ -55,13 +55,13 @@ type PluginSubscriptionSettings = {
   callback_url?:    string;
 }
 
-type PluginSubscriptionChannelForward = {
+export type PluginSubscriptionChannelForward = {
   namespace?:   string;
   identifier?:  string;
   payload?:     object;
 }
 
-type PluginSubscriptionEventDispatch = {
+export type PluginSubscriptionEventDispatch = {
   name?:   string;
   data?:   object;
 }

package/lib/resources/WebsiteHelpdesk.ts

@@ -52,6 +52,11 @@ export interface HelpdeskLocaleArticleAlternate {
   article_id?: string;
 }
 
+export interface HelpdeskLocaleArticlePage {
+  title?: string;
+  url?: string;
+}
+
 export interface HelpdeskLocaleSection {
   section_id?: string;
   name?: string;
@@ -392,7 +397,7 @@ class WebsiteHelpdesk extends BaseResource {
    */
   resolveHelpdeskLocaleArticlePage(
     websiteID: string, locale: string, articleId: string
-  ) {
+  ) : Promise<HelpdeskLocaleArticlePage> {
     return this.crisp.get(
       this.crisp.prepareRestUrl([
         "website", websiteID, "helpdesk", "locale", locale, "article",

package/package.json

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