bkper-js 1.47.2 → 2.0.0

package/lib/model/Group.js

@@ -29,18 +29,24 @@ export class Group {
         };
     }
     /**
+     * Gets an immutable copy of the json payload.
+     *
      * @returns An immutable copy of the json payload
      */
     json() {
         return Object.assign({}, this.payload);
     }
     /**
+     * Gets the id of this Group.
+     *
      * @returns The id of this Group
      */
     getId() {
         return this.payload.id;
     }
     /**
+     * Gets the name of this Group.
+     *
      * @returns The name of this Group
      */
     getName() {
@@ -49,7 +55,7 @@ export class Group {
     /**
      * Sets the name of the Group.
      *
-     * @returns This Group, for chainning.
+     * @returns This Group, for chaining
      */
     setName(name) {
         this.payload.name = name;
@@ -58,7 +64,7 @@ export class Group {
     /**
      * Tells if the Group is locked by the Book owner.
      *
-     * @returns True if the Group is locked.
+     * @returns True if the Group is locked
      */
     isLocked() {
         if (this.payload.locked == null) {
@@ -71,13 +77,15 @@ export class Group {
      *
      * @param locked - The locked state of the Group.
      *
-     * @returns This Group, for chainning.
+     * @returns This Group, for chaining
      */
     setLocked(locked) {
         this.payload.locked = locked;
         return this;
     }
     /**
+     * Gets the normalized name of this group without spaces and special characters.
+     *
      * @returns The name of this group without spaces and special characters
      */
     getNormalizedName() {
@@ -89,7 +97,9 @@ export class Group {
         }
     }
     /**
-     * @returns All Accounts of this group.
+     * Gets all Accounts of this group.
+     *
+     * @returns All Accounts of this group
      */
     getAccounts() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -105,13 +115,17 @@ export class Group {
         });
     }
     /**
+     * Gets the type of the accounts of this group.
+     *
      * @returns The type for of the accounts of this group. Null if mixed
      */
     getType() {
         return this.payload.type;
     }
     /**
-     * Gets the custom properties stored in this Group
+     * Gets the custom properties stored in this Group.
+     *
+     * @returns The custom properties as a key/value object
      */
     getProperties() {
         return this.payload.properties != null ? Object.assign({}, this.payload.properties) : {};
@@ -121,16 +135,18 @@ export class Group {
      *
      * @param properties - Object with key/value pair properties
      *
-     * @returns This Group, for chainning.
+     * @returns This Group, for chaining
      */
     setProperties(properties) {
         this.payload.properties = Object.assign({}, properties);
         return this;
     }
     /**
-     * Gets the property value for given keys. First property found will be retrieved
+     * Gets the property value for given keys. First property found will be retrieved.
      *
      * @param keys - The property key
+     *
+     * @returns The property value, or undefined if not found
      */
     getProperty(...keys) {
         for (let index = 0; index < keys.length; index++) {
@@ -147,6 +163,8 @@ export class Group {
      *
      * @param key - The property key
      * @param value - The property value
+     *
+     * @returns This Group, for chaining
      */
     setProperty(key, value) {
         if (key == null || key.trim() == '') {
@@ -166,44 +184,58 @@ export class Group {
      *
      * @param key - The property key
      *
-     * @returns This Group, for chainning.
+     * @returns This Group, for chaining
      */
     deleteProperty(key) {
         this.setProperty(key, null);
         return this;
     }
     /**
-     * Tell if the Group is hidden on main transactions menu
+     * Tells if the Group is hidden on main transactions menu.
+     *
+     * @returns True if the Group is hidden, false otherwise
      */
     isHidden() {
         return this.payload.hidden;
     }
     /**
-     *  Hide/Show group on main menu.
+     * Hide/Show group on main menu.
+     *
+     * @param hidden - Whether to hide the group
+     *
+     * @returns This Group, for chaining
      */
     setHidden(hidden) {
         this.payload.hidden = hidden;
         return this;
     }
     /**
-     * Tell if this is a credit (Incoming and Liabities) group
+     * Tells if this is a credit (Incoming and Liabilities) group.
+     *
+     * @returns True if this is a credit group
      */
     isCredit() {
         return this.payload.credit;
     }
     /**
-     * Tell if this is a mixed (Assets/Liabilities or Incoming/Outgoing) group
+     * Tells if this is a mixed (Assets/Liabilities or Incoming/Outgoing) group.
+     *
+     * @returns True if this is a mixed group
      */
     isMixed() {
         return this.payload.mixed;
     }
     /**
-     * Tell if the Group is permanent
+     * Tells if the Group is permanent.
+     *
+     * @returns True if the Group is permanent
      */
     isPermanent() {
         return this.payload.permanent;
     }
     /**
+     * Gets the parent Group.
+     *
      * @returns The parent Group
      */
     getParent() {
@@ -212,7 +244,9 @@ export class Group {
     /**
      * Sets the parent Group.
      *
-     * @returns This Group, for chainning.
+     * @param group - The parent Group to set
+     *
+     * @returns This Group, for chaining
      */
     setParent(group) {
         if (group) {
@@ -226,15 +260,15 @@ export class Group {
     /**
      * Checks if the Group has a parent.
      *
-     * @returns True if the Group has a parent, otherwise false.
+     * @returns True if the Group has a parent, otherwise false
      */
     hasParent() {
         return this.payload.parent != null;
     }
     /**
-     * Retrieves the children of the Group.
+     * Gets the children of the Group.
      *
-     * @returns An array of child Groups.
+     * @returns An array of child Groups
      */
     getChildren() {
         return Array.from(this.children.values()) || [];
@@ -247,9 +281,9 @@ export class Group {
         }
     }
     /**
-     * Retrieves all descendant Groups of the current Group.
+     * Gets all descendant Groups of the current Group.
      *
-     * @returns A set of descendant Groups.
+     * @returns A set of descendant Groups
      */
     getDescendants() {
         const descendants = new Set();
@@ -257,9 +291,9 @@ export class Group {
         return descendants;
     }
     /**
-     * Retrieves the IDs of all descendant Groups in a tree structure.
+     * Gets the IDs of all descendant Groups in a tree structure.
      *
-     * @returns A set of descendant Group IDs.
+     * @returns A set of descendant Group IDs
      */
     getDescendantTreeIds() {
         return new Set(Array.from(this.getDescendants()).map(g => g.getId() || ""));
@@ -267,7 +301,7 @@ export class Group {
     /**
      * Checks if the Group has any children.
      *
-     * @returns True if the Group has children, otherwise false.
+     * @returns True if the Group has children, otherwise false
      */
     hasChildren() {
         return this.getChildren().length > 0;
@@ -275,7 +309,7 @@ export class Group {
     /**
      * Checks if the Group is a leaf node (i.e., has no children).
      *
-     * @returns True if the Group is a leaf, otherwise false.
+     * @returns True if the Group is a leaf, otherwise false
      */
     isLeaf() {
         return this.getChildren().length === 0;
@@ -283,15 +317,15 @@ export class Group {
     /**
      * Checks if the Group is a root node (i.e., has no parent).
      *
-     * @returns True if the Group is a root, otherwise false.
+     * @returns True if the Group is a root, otherwise false
      */
     isRoot() {
         return this.getParent() == undefined;
     }
     /**
-     * Retrieves the depth of the Group in the hierarchy.
+     * Gets the depth of the Group in the hierarchy.
      *
-     * @returns The depth of the Group.
+     * @returns The depth of the Group
      */
     getDepth() {
         if (this.depth == undefined) {
@@ -305,9 +339,9 @@ export class Group {
         return this.depth;
     }
     /**
-     * Retrieves the root Group of the current Group.
+     * Gets the root Group of the current Group.
      *
-     * @returns The root Group.
+     * @returns The root Group
      */
     getRoot() {
         if (this.root == undefined) {
@@ -321,9 +355,9 @@ export class Group {
         return this.root;
     }
     /**
-     * Retrieves the name of the root Group.
+     * Gets the name of the root Group.
      *
-     * @returns The name of the root Group.
+     * @returns The name of the root Group
      */
     getRootName() {
         const root = this.getRoot();
@@ -366,13 +400,17 @@ export class Group {
         }
     }
     /**
+     * Tells if this group has any account in it.
+     *
      * @returns True if this group has any account in it
      */
     hasAccounts() {
         return this.payload.hasAccounts;
     }
     /**
-     * Perform create new group.
+     * Performs create new group.
+     *
+     * @returns A promise that resolves to this Group
      */
     create() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -382,7 +420,9 @@ export class Group {
         });
     }
     /**
-     * Perform update group, applying pending changes.
+     * Performs update group, applying pending changes.
+     *
+     * @returns A promise that resolves to this Group
      */
     update() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -392,7 +432,9 @@ export class Group {
         });
     }
     /**
-     * Perform delete group.
+     * Performs delete group.
+     *
+     * @returns A promise that resolves to this Group
      */
     remove() {
         return __awaiter(this, void 0, void 0, function* () {

package/lib/model/Integration.js

@@ -18,6 +18,8 @@ export class Integration {
         this.payload = payload || {};
     }
     /**
+     * Gets an immutable copy of the JSON payload for this Integration.
+     *
      * @returns An immutable copy of the json payload
      */
     json() {
@@ -100,7 +102,7 @@ export class Integration {
      *
      * @param properties - Object with key/value pair properties
      *
-     * @returns The Integration, for chainning
+     * @returns The Integration, for chaining
      */
     setProperties(properties) {
         this.payload.properties = Object.assign({}, properties);
@@ -149,7 +151,7 @@ export class Integration {
      *
      * @param key - The property key
      *
-     * @returns The Integration, for chainning
+     * @returns The Integration, for chaining
      */
     deleteProperty(key) {
         this.setProperty(key, null);

package/lib/model/Message.js

@@ -23,12 +23,15 @@ export class Message {
         this.payload = payload || {};
     }
     /**
+     * Gets the wrapped plain json object.
+     *
      * @returns The wrapped plain json object
      */
     json() {
         return Object.assign({}, this.payload);
     }
     /**
+     * Gets the Message universal identifier.
      *
      * @returns The Message universal identifier
      */
@@ -36,13 +39,15 @@ export class Message {
         return this.payload.id;
     }
     /**
+     * Gets the Agent associated with the Message.
      *
-     * @returns The Agent associated with the Message, in any
+     * @returns The Agent associated with the Message, if any
      */
     getAgent() {
         return this.payload.agent ? new Agent(this.payload.agent) : undefined;
     }
     /**
+     * Gets the Conversation of the Message.
      *
      * @returns The Conversation of the Message
      */
@@ -50,6 +55,7 @@ export class Message {
         return this.conversation;
     }
     /**
+     * Gets the User associated with the Message.
      *
      * @returns The User associated with the Message
      */
@@ -57,6 +63,7 @@ export class Message {
         return this.payload.user ? new User(this.payload.user) : undefined;
     }
     /**
+     * Gets the Date the Message was created.
      *
      * @returns The Date the Message was created
      */
@@ -64,6 +71,7 @@ export class Message {
         return this.payload.createdAt ? new Date(new Number(this.payload.createdAt).valueOf()) : undefined;
     }
     /**
+     * Gets the text content of the Message.
      *
      * @returns The text content of the Message
      */
@@ -71,8 +79,9 @@ export class Message {
         return this.payload.content;
     }
     /**
+     * Sets the text content of the Message.
      *
-     * @param content The text content of the Message
+     * @param content - The text content of the Message
      *
      * @returns This Message, for chaining
      */
@@ -81,6 +90,8 @@ export class Message {
         return this;
     }
     /**
+     * Gets the custom properties stored in this Message.
+     *
      * @returns The custom properties stored in this Message
      */
     getProperties() {
@@ -91,7 +102,7 @@ export class Message {
      *
      * @param properties - Object with key/value pair properties
      *
-     * @returns This Message, for chainning.
+     * @returns This Message, for chaining
      */
     setProperties(properties) {
         this.payload.properties = Object.assign({}, properties);
@@ -120,7 +131,7 @@ export class Message {
      * @param key - The property key
      * @param value - The property value
      *
-     * @returns This Message, for chainning.
+     * @returns This Message, for chaining
      */
     setProperty(key, value) {
         if (key == null || key.trim() == '') {
@@ -140,7 +151,7 @@ export class Message {
      *
      * @param key - The property key
      *
-     * @returns This Message, for chainning.
+     * @returns This Message, for chaining
      */
     deleteProperty(key) {
         this.setProperty(key, null);
@@ -173,6 +184,8 @@ export class Message {
     }
     /**
      * Streams the Message to the Bkper API.
+     *
+     * @returns A Promise that resolves when the streaming is complete
      */
     stream() {
         return __awaiter(this, void 0, void 0, function* () {

package/lib/model/Query.js

@@ -21,19 +21,25 @@ export class Query {
         this.payload = payload || {};
     }
     /**
+     * Gets the wrapped plain json object.
+     *
      * @returns The wrapped plain json object
      */
     json() {
         return Object.assign({}, this.payload);
     }
     /**
+     * Gets the Query universal identifier.
+     *
      * @returns The Query universal identifier
      */
     getId() {
         return this.payload.id;
     }
     /**
-     * @return The title of this saved Query
+     * Gets the title of this saved Query.
+     *
+     * @returns The title of this saved Query
      */
     getTitle() {
         return this.payload.title;
@@ -41,7 +47,7 @@ export class Query {
     /**
      * Sets the title of this saved Query.
      *
-     * @param title The title of this saved Query
+     * @param title - The title of this saved Query
      *
      * @returns This Query, for chaining
      */
@@ -50,7 +56,9 @@ export class Query {
         return this;
     }
     /**
-     * @return This Query string to be executed
+     * Gets the query string to be executed.
+     *
+     * @returns This Query string to be executed
      */
     getQuery() {
         return this.payload.query;
@@ -58,7 +66,7 @@ export class Query {
     /**
      * Sets the query string associated with this saved Query.
      *
-     * @param query The query string to be executed
+     * @param query - The query string to be executed
      *
      * @returns This Query, for chaining
      */
@@ -68,6 +76,8 @@ export class Query {
     }
     /**
      * Perform create new Query.
+     *
+     * @returns This Query, for chaining
      */
     create() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -78,6 +88,8 @@ export class Query {
     }
     /**
      * Perform update Query, applying pending changes.
+     *
+     * @returns This Query, for chaining
      */
     update() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -88,6 +100,8 @@ export class Query {
     }
     /**
      * Perform delete Query.
+     *
+     * @returns This Query, for chaining
      */
     remove() {
         return __awaiter(this, void 0, void 0, function* () {

package/lib/model/Template.js

@@ -10,6 +10,8 @@ export class Template {
         this.payload = json || {};
     }
     /**
+     * Gets an immutable copy of the JSON payload for this Template.
+     *
      * @returns An immutable copy of the json payload
      */
     json() {