bkper-js 1.36.0 → 1.38.0

package/lib/index.d.ts

@@ -724,6 +724,7 @@ export declare class Book {
 
 
 
+
     constructor(payload?: bkper.Book);
     /**
      * @returns An immutable copy of the json payload
@@ -1113,6 +1114,10 @@ export declare class Book {
      * ```
      */
     getBalancesReport(query: string): Promise<BalancesReport>;
+    /**
+     * @return The saved queries from this book
+     */
+    getSavedQueries(): Promise<Query[]>;
 }
 
 /**
@@ -1764,6 +1769,20 @@ export declare class Group {
      * @returns This Group, for chainning.
      */
     setName(name: string): Group;
+    /**
+     * Tells if the Group is locked by the Book owner.
+     *
+     * @returns True if the Group is locked.
+     */
+    isLocked(): boolean;
+    /**
+     * Sets the locked state of the Group.
+     *
+     * @param locked - The locked state of the Group.
+     *
+     * @returns This Group, for chainning.
+     */
+    setLocked(locked: boolean): Group;
     /**
      * @returns The name of this group without spaces and special characters
      */
@@ -2237,6 +2256,35 @@ export declare enum Permission {
     OWNER = "OWNER"
 }
 
+/**
+ * Defines a saved Query in a [[Book]].
+ *
+ * Queries can be saved on Books by users.
+ *
+ * @public
+ */
+export declare class Query {
+    payload: bkper.Query;
+
+    constructor(book: Book, payload?: bkper.Query);
+    /**
+     * @returns The wrapped plain json object
+     */
+    json(): bkper.Query;
+    /**
+     * @returns The Query universal identifier
+     */
+    getId(): string | undefined;
+    /**
+     * @return The title of this saved Query
+     */
+    getTitle(): string | undefined;
+    /**
+     * @return This Query string to be executed
+     */
+    getQuery(): string | undefined;
+}
+
 /**
  * This class defines a Template.
  *

package/lib/index.js

@@ -19,6 +19,7 @@ export { File } from './model/File.js';
 export { Group } from './model/Group.js';
 export { Integration } from './model/Integration.js';
 export { Message } from './model/Message.js';
+export { Query } from './model/Query.js';
 export { Template } from './model/Template.js';
 export { Transaction } from './model/Transaction.js';
 export { TransactionList } from './model/TransactionList.js';

package/lib/model/Book.js

@@ -27,6 +27,7 @@ import { Transaction } from './Transaction.js';
 import { TransactionList } from './TransactionList.js';
 import { BalancesReport } from './BalancesReport.js';
 import { App } from './App.js';
+import { Query } from './Query.js';
 /**
  *
  * A Book represents [General Ledger](https://en.wikipedia.org/wiki/General_ledger) for a company or business, but can also represent a [Ledger](https://en.wikipedia.org/wiki/Ledger) for a project or department
@@ -859,5 +860,17 @@ export class Book {
             return new BalancesReport(this, balances);
         });
     }
+    /**
+     * @return The saved queries from this book
+     */
+    getSavedQueries() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.queries == null) {
+                const queryPayloads = yield BookService.getSavedQueries(this.getId());
+                this.queries = queryPayloads.map(payload => new Query(this, payload));
+            }
+            return this.queries;
+        });
+    }
 }
 //# sourceMappingURL=Book.js.map

package/lib/model/Group.js

@@ -55,6 +55,28 @@ export class Group {
         this.payload.name = name;
         return this;
     }
+    /**
+     * Tells if the Group is locked by the Book owner.
+     *
+     * @returns True if the Group is locked.
+     */
+    isLocked() {
+        if (this.payload.locked == null) {
+            return false;
+        }
+        return this.payload.locked;
+    }
+    /**
+     * Sets the locked state of the Group.
+     *
+     * @param locked - The locked state of the Group.
+     *
+     * @returns This Group, for chainning.
+     */
+    setLocked(locked) {
+        this.payload.locked = locked;
+        return this;
+    }
     /**
      * @returns The name of this group without spaces and special characters
      */

package/lib/model/Query.js

@@ -0,0 +1,38 @@
+/**
+ * Defines a saved Query in a [[Book]].
+ *
+ * Queries can be saved on Books by users.
+ *
+ * @public
+ */
+export class Query {
+    constructor(book, payload) {
+        this.book = book;
+        this.payload = payload || {};
+    }
+    /**
+     * @returns The wrapped plain json object
+     */
+    json() {
+        return Object.assign({}, this.payload);
+    }
+    /**
+     * @returns The Query universal identifier
+     */
+    getId() {
+        return this.payload.id;
+    }
+    /**
+     * @return The title of this saved Query
+     */
+    getTitle() {
+        return this.payload.title;
+    }
+    /**
+     * @return This Query string to be executed
+     */
+    getQuery() {
+        return this.payload.query;
+    }
+}
+//# sourceMappingURL=Query.js.map

package/lib/service/book-service.js

@@ -56,4 +56,11 @@ export function getApps(bookId) {
         return ((_a = response === null || response === void 0 ? void 0 : response.data) === null || _a === void 0 ? void 0 : _a.items) || [];
     });
 }
+export function getSavedQueries(bookId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        let response = yield new HttpBooksApiV5Request(`${bookId}/queries`).setMethod('GET').fetch();
+        return ((_a = response === null || response === void 0 ? void 0 : response.data) === null || _a === void 0 ? void 0 : _a.items) || [];
+    });
+}
 //# sourceMappingURL=book-service.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bkper-js",
-  "version": "1.36.0",
+  "version": "1.38.0",
   "description": "Javascript client for Bkper REST API",
   "main": "./lib/index.js",
   "module": "./lib/index.js",