bkper-js 1.47.2 → 1.47.3

package/lib/model/BotResponse.js

@@ -20,30 +20,40 @@ export class BotResponse {
         this.payload = payload || {};
     }
     /**
-     * @return The type of this Bot Response
+     * Gets the type of this Bot Response.
+     *
+     * @returns The type of this Bot Response
      */
     getType() {
         return this.payload.type;
     }
     /**
-     * @return The agent id of this Bot Response
+     * Gets the agent id of this Bot Response.
+     *
+     * @returns The agent id of this Bot Response
      */
     getAgentId() {
         return this.payload.agentId;
     }
     /**
-     * @return The message of this Bot Response
+     * Gets the message of this Bot Response.
+     *
+     * @returns The message of this Bot Response
      */
     getMessage() {
         return this.payload.message;
     }
     /**
+     * Gets the date this Bot Response was created.
+     *
      * @returns The date this Bot Response was created
      */
     getCreatedAt() {
         return this.payload.createdAt ? new Date(new Number(this.payload.createdAt).valueOf()) : undefined;
     }
     /**
+     * Gets the Event this Bot Response is associated to.
+     *
      * @returns The Event this Bot Response is associated to
      */
     getEvent() {

package/lib/model/Collection.js

@@ -19,18 +19,24 @@ export class Collection {
         this.payload = payload || {};
     }
     /**
+     * Gets an immutable copy of the JSON payload for this Collection.
+     *
      * @returns The wrapped plain json object
      */
     json() {
         return Object.assign({}, this.payload);
     }
     /**
+     * Gets the unique identifier of this Collection.
+     *
      * @returns The id of this Collection
      */
     getId() {
         return this.payload.id;
     }
     /**
+     * Gets the name of this Collection.
+     *
      * @returns The name of this Collection
      */
     getName() {
@@ -39,7 +45,9 @@ export class Collection {
     /**
      * Sets the name of the Collection.
      *
-     * @returns This Collection, for chainning.
+     * @param name - The name to set
+     *
+     * @returns This Collection, for chaining
      */
     setName(name) {
         this.payload.name = name;
@@ -62,7 +70,9 @@ export class Collection {
         return this.payload.permission ? this.payload.permission : undefined;
     }
     /**
-     * @returns All Books of this collection.
+     * Gets all Books of this collection.
+     *
+     * @returns All Books of this collection
      */
     getBooks() {
         let books = [];
@@ -78,6 +88,8 @@ export class Collection {
     /**
      * Adds Books to this Collection.
      *
+     * @param books - The Books to add to this Collection
+     *
      * @returns The added Book objects
      */
     addBooks(books) {
@@ -94,6 +106,8 @@ export class Collection {
     /**
      * Removes Books from this Collection.
      *
+     * @param books - The Books to remove from this Collection
+     *
      * @returns The removed Book objects
      */
     removeBooks(books) {

package/lib/model/Connection.js

@@ -19,6 +19,8 @@ export class Connection {
         this.payload = payload || {};
     }
     /**
+     * Gets an immutable copy of the JSON payload for this Connection.
+     *
      * @returns An immutable copy of the json payload
      */
     json() {
@@ -45,7 +47,7 @@ export class Connection {
      *
      * @param agentId - The Connection agentId
      *
-     * @returns The Connection, for chainning
+     * @returns The Connection, for chaining
      */
     setAgentId(agentId) {
         this.payload.agentId = agentId;
@@ -88,7 +90,7 @@ export class Connection {
      *
      * @param name - The name of the Connection
      *
-     * @returns The Connection, for chainning
+     * @returns The Connection, for chaining
      */
     setName(name) {
         this.payload.name = name;
@@ -99,7 +101,7 @@ export class Connection {
      *
      * @param uuid - The universal unique identifier of the Connection
      *
-     * @returns The Connection, for chainning
+     * @returns The Connection, for chaining
      */
     setUUID(uuid) {
         this.payload.uuid = uuid;
@@ -126,7 +128,7 @@ export class Connection {
      *
      * @param type - The Connection type
      *
-     * @returns The Connection, for chainning
+     * @returns The Connection, for chaining
      */
     setType(type) {
         this.payload.type = type;
@@ -145,7 +147,7 @@ export class Connection {
      *
      * @param properties - Object with key/value pair properties
      *
-     * @returns The Connection, for chainning
+     * @returns The Connection, for chaining
      */
     setProperties(properties) {
         this.payload.properties = Object.assign({}, properties);
@@ -194,7 +196,7 @@ export class Connection {
      *
      * @param key - The property key
      *
-     * @returns The Connection, for chainning
+     * @returns The Connection, for chaining
      */
     deleteProperty(key) {
         this.setProperty(key, null);

package/lib/model/Conversation.js

@@ -23,12 +23,15 @@ export class Conversation {
         this.payload = payload || {};
     }
     /**
+     * Gets an immutable copy of the JSON payload for this Conversation.
+     *
      * @returns The wrapped plain json object
      */
     json() {
         return Object.assign({}, this.payload);
     }
     /**
+     * Gets the Agent associated to this Conversation.
      *
      * @returns The Agent associated to this Conversation
      */
@@ -36,6 +39,7 @@ export class Conversation {
         return this.agent;
     }
     /**
+     * Gets the Conversation universal identifier.
      *
      * @returns The Conversation universal identifier
      */
@@ -43,6 +47,7 @@ export class Conversation {
         return this.payload.id;
     }
     /**
+     * Gets the title of the Conversation.
      *
      * @returns The title of the Conversation
      */
@@ -50,6 +55,7 @@ export class Conversation {
         return this.payload.title;
     }
     /**
+     * Gets the Date the Conversation was created.
      *
      * @returns The Date the Conversation was created
      */
@@ -57,6 +63,7 @@ export class Conversation {
         return this.payload.createdAt ? new Date(new Number(this.payload.createdAt).valueOf()) : undefined;
     }
     /**
+     * Gets the Date the Conversation was last updated.
      *
      * @returns The Date the Conversation was last updated
      */
@@ -64,7 +71,7 @@ export class Conversation {
         return this.payload.updatedAt ? new Date(new Number(this.payload.updatedAt).valueOf()) : undefined;
     }
     /**
-     * Gets the Messages that compose this Conversation
+     * Gets the Messages that compose this Conversation.
      *
      * @returns The Messages in this Conversation
      */
@@ -102,7 +109,7 @@ export class Conversation {
         this.payload.updatedAt = updatedAtMs;
     }
     /**
-     * Performs create Conversation
+     * Performs create Conversation.
      *
      * @returns The created Conversation object
      */

package/lib/model/Event.js

@@ -16,48 +16,64 @@ export class Event {
         this.payload = payload || {};
     }
     /**
+     * Gets an immutable copy of the JSON payload for this Event.
+     *
      * @returns The wrapped plain json object
      */
     json() {
         return Object.assign({}, this.payload);
     }
     /**
+     * Gets the book in which the Event was created.
+     *
      * @returns The book in which the Event was created
      */
     getBook() {
         return this.book;
     }
     /**
+     * Gets the id of the Event.
+     *
      * @returns The id of the Event
      */
     getId() {
         return this.payload.id;
     }
     /**
+     * Gets the user who performed the Event.
+     *
      * @returns The user who performed the Event
      */
     getUser() {
         return this.payload.user ? new User(this.payload.user) : undefined;
     }
     /**
+     * Gets the Agent who performed the Event.
+     *
      * @returns The Agent who performed the Event
      */
     getAgent() {
         return this.payload.agent ? new Agent(this.payload.agent) : undefined;
     }
     /**
+     * Gets 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;
     }
     /**
+     * Gets the type of the Event.
+     *
      * @returns The type of the Event
      */
     getType() {
         return this.payload.type;
     }
     /**
+     * Gets the Bot Responses associated to this Event.
+     *
      * @returns The Bot Responses associated to this Event
      */
     getBotResponses() {
@@ -74,6 +90,8 @@ export class Event {
         return this.botResponses;
     }
     /**
+     * Checks if this Event has at least one Bot Response of type ERROR.
+     *
      * @returns True if this Event has at least one Bot Response of type ERROR
      */
     hasErrorResponse() {

package/lib/model/EventList.js

@@ -1,6 +1,8 @@
 import { Event } from "./Event.js";
 /**
  * A list associated with an event query.
+ *
+ * @public
  */
 export class EventList {
     constructor(book, payload) {
@@ -8,23 +10,26 @@ export class EventList {
         this.payload = payload || {};
     }
     /**
-     * @returns The cursor associated with the query for pagination.
+     * Gets the cursor associated with the query for pagination.
+     *
+     * @returns The cursor associated with the query for pagination
      */
     getCursor() {
         return this.payload.cursor;
     }
     /**
-     * @returns The first Event in the list.
+     * Gets the first Event in the list.
+     *
+     * @returns The first Event in the list
      */
     getFirst() {
         const events = this.getItems();
         return events.length > 0 ? events[0] : undefined;
     }
     /**
-     *
      * Get the total number of events in the list.
      *
-     * @returns The total number of events.
+     * @returns The total number of events
      */
     size() {
         var _a;
@@ -33,7 +38,7 @@ export class EventList {
     /**
      * Get the events in the list.
      *
-     * @returns An array of Event objects.
+     * @returns An array of Event objects
      */
     getItems() {
         var _a;

package/lib/model/File.js

@@ -25,51 +25,63 @@ export class File {
         ;
     }
     /**
+     * Gets an immutable copy of the JSON payload for this File.
+     *
      * @returns An immutable copy of the json payload
      */
     json() {
         return Object.assign({}, this.payload);
     }
     /**
-     * Gets the File id
+     * Gets the File id.
+     *
+     * @returns The File id
      */
     getId() {
         return this.payload.id;
     }
     /**
-     * Gets the File name
+     * Gets the File name.
+     *
+     * @returns The File name
      */
     getName() {
         return this.payload.name;
     }
     /**
-     *
      * Sets the name of the File.
      *
-     * @returns This File, for chainning.
+     * @param name - The name to set
+     *
+     * @returns This File, for chaining
      */
     setName(name) {
         this.payload.name = name;
         return this;
     }
     /**
-     * Gets the File content type
+     * Gets the File content type.
+     *
+     * @returns The File content type
      */
     getContentType() {
         return this.payload.contentType;
     }
     /**
-     *
      * Sets the File content type.
      *
-     * @returns This File, for chainning.
+     * @param contentType - The content type to set
+     *
+     * @returns This File, for chaining
      */
     setContentType(contentType) {
         this.payload.contentType = contentType;
         return this;
     }
     /**
-     * Gets the file content Base64 encoded
+     * Gets the file content Base64 encoded.
+     *
+     * @returns The file content Base64 encoded
      */
     getContent() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -81,29 +93,36 @@ export class File {
         });
     }
     /**
-     *
      * Sets the File content Base64 encoded.
      *
-     * @returns This File, for chainning.
+     * @param content - The content to set (Base64 encoded)
+     *
+     * @returns This File, for chaining
      */
     setContent(content) {
         this.payload.content = content;
         return this;
     }
     /**
-     * Gets the file serving url for accessing via browser
+     * Gets the file serving url for accessing via browser.
+     *
+     * @returns The file serving url
      */
     getUrl() {
         return this.payload.url;
     }
     /**
-     * Gets the file size in bytes
+     * Gets the file size in bytes.
+     *
+     * @returns The file size in bytes
      */
     getSize() {
         return this.payload.size;
     }
     /**
      * Perform create new File.
+     *
+     * @returns The created File object
      */
     create() {
         return __awaiter(this, void 0, void 0, function* () {