bkper-js 1.24.0 → 1.25.0

package/lib/index.d.ts

@@ -1071,6 +1071,53 @@ export declare class Book {
     getBalancesReport(query: string): Promise<BalancesReport>;
 }
 
+/**
+ *
+ * This class defines a Bot Response associated to an [[Event]].
+ *
+ * @public
+ */
+export declare class BotResponse {
+    payload: bkper.BotResponse;
+    constructor(payload?: bkper.BotResponse);
+    /**
+     * @return The type of this Bot Response
+     */
+    getType(): BotResponseType | undefined;
+    /**
+     * @return The agent id of this Bot Response
+     */
+    getAgentId(): string | undefined;
+    /**
+     * @return The message of this Bot Response
+     */
+    getMessage(): string | undefined;
+    /**
+     * @returns The date this Bot Response was created
+     */
+    getCreatedAt(): Date | undefined;
+}
+
+/**
+ * Enum that represents the type of a Bot Response
+ *
+ * @public
+ */
+export declare enum BotResponseType {
+    /**
+     * Info bot response
+     */
+    INFO = "INFO",
+    /**
+     * Warning bot response
+     */
+    WARNING = "WARNING",
+    /**
+     * Error bot response
+     */
+    ERROR = "ERROR"
+}
+
 /**
  * This class defines a Collection of [[Books]].
  *
@@ -1389,27 +1436,32 @@ export declare enum DecimalSeparator {
  */
 export declare class Event {
     payload: bkper.Event;
+
     constructor(payload?: bkper.Event);
     /**
      * @returns The wrapped plain json object
      */
     json(): bkper.Event;
     /**
-     * @returns The user who performed the event
+     * @returns The user who performed the Event
      */
     getUser(): User | undefined;
     /**
-     * @returns The user who performed the event
+     * @returns The user who performed the Event
      */
     getAgent(): Agent | undefined;
     /**
-     * @returns The date the event was created
+     * @returns The date the Event was created
      */
     getCreatedAt(): Date | undefined;
     /**
-     * @returns The type of the event
+     * @returns The type of the Event
      */
     getType(): EventType | undefined;
+    /**
+     * @returns The Bot Responses associated to this Event
+     */
+    getBotResponses(): BotResponse[];
 }
 
 /**

package/lib/index.js

@@ -21,7 +21,8 @@ export { Template } from './model/Template.js';
 export { Transaction } from './model/Transaction.js';
 export { TransactionList } from './model/TransactionList.js';
 export { Event } from './model/Event.js';
+export { BotResponse } from './model/BotResponse.js';
 export { EventList } from './model/EventList.js';
 export { User } from './model/User.js';
-export { Periodicity, DecimalSeparator, Permission, Visibility, AccountType, Period, Month, EventType, AppType } from './model/Enums.js';
+export { Periodicity, DecimalSeparator, Permission, Visibility, AccountType, Period, Month, EventType, AppType, BotResponseType } from './model/Enums.js';
 //# sourceMappingURL=index.js.map

package/lib/model/BotResponse.js

@@ -0,0 +1,36 @@
+/**
+ *
+ * This class defines a Bot Response associated to an [[Event]].
+ *
+ * @public
+ */
+export class BotResponse {
+    constructor(payload) {
+        this.payload = payload || {};
+    }
+    /**
+     * @return The type of this Bot Response
+     */
+    getType() {
+        return this.payload.type;
+    }
+    /**
+     * @return The agent id of this Bot Response
+     */
+    getAgentId() {
+        return this.payload.agentId;
+    }
+    /**
+     * @return The message of this Bot Response
+     */
+    getMessage() {
+        return this.payload.message;
+    }
+    /**
+     * @returns The date this Bot Response was created
+     */
+    getCreatedAt() {
+        return this.payload.createdAt ? new Date(new Number(this.payload.createdAt).valueOf()) : undefined;
+    }
+}
+//# sourceMappingURL=BotResponse.js.map

package/lib/model/Enums.js

@@ -170,6 +170,26 @@ export var AppType;
      */
     AppType["BOT"] = "BOT";
 })(AppType || (AppType = {}));
+/**
+ * Enum that represents the type of a Bot Response
+ *
+ * @public
+ */
+export var BotResponseType;
+(function (BotResponseType) {
+    /**
+     * Info bot response
+     */
+    BotResponseType["INFO"] = "INFO";
+    /**
+     * Warning bot response
+     */
+    BotResponseType["WARNING"] = "WARNING";
+    /**
+     * Error bot response
+     */
+    BotResponseType["ERROR"] = "ERROR";
+})(BotResponseType || (BotResponseType = {}));
 /**
  * Enum that represents event types.
  *

package/lib/model/Event.js

@@ -1,5 +1,6 @@
-import { Agent } from "./Agent";
-import { User } from "./User";
+import { Agent } from "./Agent.js";
+import { BotResponse } from "./BotResponse.js";
+import { User } from "./User.js";
 /**
  *
  * This class defines an Event from a [[Book]].
@@ -19,28 +20,44 @@ export class Event {
         return Object.assign({}, this.payload);
     }
     /**
-     * @returns The user who performed the event
+     * @returns The user who performed the Event
      */
     getUser() {
         return this.payload.user ? new User(this.payload.user) : undefined;
     }
     /**
-     * @returns The user who performed the event
+     * @returns The user who performed the Event
      */
     getAgent() {
         return this.payload.agent ? new Agent(this.payload.agent) : undefined;
     }
     /**
-     * @returns The date the event was created
+     * @returns The date the Event was created
      */
     getCreatedAt() {
         return this.payload.createdAt ? new Date(new Number(this.payload.createdAt).valueOf()) : undefined;
     }
     /**
-     * @returns The type of the event
+     * @returns The type of the Event
      */
     getType() {
         return this.payload.type;
     }
+    /**
+     * @returns The Bot Responses associated to this Event
+     */
+    getBotResponses() {
+        if (this.botResponses !== undefined) {
+            return this.botResponses;
+        }
+        let botResponses = [];
+        if (this.payload.botResponses) {
+            for (const botResponse of this.payload.botResponses) {
+                botResponses.push(new BotResponse(botResponse));
+            }
+        }
+        this.botResponses = botResponses;
+        return this.botResponses;
+    }
 }
 //# sourceMappingURL=Event.js.map

package/lib/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.47.11"
+      "packageVersion": "7.50.0"
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bkper-js",
-  "version": "1.24.0",
+  "version": "1.25.0",
   "description": "Javascript client for Bkper REST API",
   "main": "./lib/index.js",
   "module": "./lib/index.js",
@@ -34,7 +34,7 @@
     "postversion": "git push --tags && yarn publish --new-version $npm_package_version && git push && echo \"Successfully released version $npm_package_version!\""
   },
   "peerDependencies": {
-    "@bkper/bkper-api-types": "^5.12.0"
+    "@bkper/bkper-api-types": "^5.13.0"
   },
   "dependencies": {
     "@google-cloud/local-auth": "^3.0.1",