bkper-js 1.6.0 → 1.8.0

package/lib/index.d.ts

@@ -408,10 +408,11 @@ export declare class Bkper {
      * Gets the [[Book]] with the specified bookId from url param.
      *
      * @param id - The universal book id - The same bookId param of URL you access at app.bkper.com
+     * @param includeAccounts - Optional parameter to include accounts in the retrieved Book
      *
      * @returns The retrieved Book, for chaining
      */
-    static getBook(id: string): Promise<Book>;
+    static getBook(id: string, includeAccounts?: boolean): Promise<Book>;
     /**
      * Gets all [[Books]] the user has access to.
      *
@@ -424,6 +425,12 @@ export declare class Bkper {
      * @returns The retrieved list of Apps
      */
     static getApps(): Promise<App[]>;
+    /**
+     * Gets all [[Templates]] available for the user.
+     *
+     * @returns The retrieved list of Templates
+     */
+    static getTemplates(): Promise<Template[]>;
     /**
      * Gets the current logged [[User]].
      *
@@ -723,21 +730,13 @@ export declare class Book {
      * @returns The updated Integration object
      */
     updateIntegration(integration: bkper.Integration): Promise<Integration>;
-    /**
-     * Resumes a transaction iteration using a continuation token from a previous iterator.
-     *
-     * @param continuationToken - continuation token from a previous transaction iterator
-     *
-     * @returns a collection of transactions that remained in a previous iterator when the continuation token was generated
-     */
-    continueTransactionIterator(query: string, continuationToken: string): TransactionIterator;
     /**
      * Instantiate a new [[Transaction]]
      *
      * Example:
      *
      * ```js
-     * var book = BkperApp.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");
+     * var book = Bkper.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");
      *
      * book.newTransaction()
      *  .setDate('2013-01-25')
@@ -756,7 +755,7 @@ export declare class Book {
      *
      * Example:
      * ```js
-     * var book = BkperApp.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");
+     * var book = Bkper.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");
      *
      * book.newAccount()
      *  .setName('Some New Account')
@@ -772,7 +771,7 @@ export declare class Book {
      *
      * Example:
      * ```js
-     * var book = BkperApp.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");
+     * var book = Bkper.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");
      *
      * book.newGroup()
      *  .setName('Some New Group')
@@ -790,7 +789,9 @@ export declare class Book {
      */
     getAccount(idOrName?: string): Promise<Account | undefined>;
 
-    removeGroupCache(group: Group): void;
+
+
+
     /**
      * Gets a [[Group]] object
      *
@@ -803,33 +804,19 @@ export declare class Book {
      * Gets all [[Groups]] of this Book
      */
     getGroups(): Promise<Group[]>;
+    private mapGroups;
+    getAccounts(): Promise<Account[]>;
+    private mapAccounts;
     /**
-     * Get the [[Groups]] of a given account.
-     */
-    getGroupsByAccount(accountIdOrName: string): Promise<Group[]>;
-    /**
-     * Get Book transactions based on a query.
-     *
-     * See [Query Guide](https://help.bkper.com/en/articles/2569178-search-query-guide) to learn more
+     * Lists transactions in the Book based on the provided query, limit, and cursor, for pagination.
      *
-     * @param query - The query string.
-     *
-     * @returns The Transactions result as an iterator.
-     *
-     * Example:
+     * @param query - The query string to filter transactions
+     * @param limit - The maximum number of transactions to return. Default to 100, max to 1000;
+     * @param cursor - The cursor for pagination
      *
-     * ```js
-     * var book = BkperApp.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");
-     *
-     * var transactions = book.getTransactions("account:CreditCard after:28/01/2013 before:29/01/2013");
-     *
-     * while (transactions.hasNext()) {
-     *  var transaction = transactions.next();
-     *  Logger.log(transaction.getDescription());
-     * }
-     * ```
+     * @returns A TransactionPage object containing the list of transactions
      */
-    getTransactions(query?: string): TransactionIterator;
+    listTransactions(query?: string, limit?: number, cursor?: string): Promise<TransactionPage>;
     /**
      * Retrieve a transaction by id
      */
@@ -839,7 +826,7 @@ export declare class Book {
      *
      * Example:
      * ```js
-     * var book = BkperApp.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");
+     * var book = Bkper.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");
      *
      * book.newFile()
      *  .setBlob(UrlFetchApp.fetch('https://bkper.com/images/index/integrations4.png').getBlob())
@@ -1367,7 +1354,7 @@ export declare class Integration {
  *
  * @public
  */
-declare enum Month {
+export declare enum Month {
     JANUARY = "JANUARY",
     FEBRUARY = "FEBRUARY",
     MARCH = "MARCH",
@@ -1387,7 +1374,7 @@ declare enum Month {
  *
  * @public
  */
-declare enum Period {
+export declare enum Period {
     /**
      *  Monthly period
      */
@@ -1456,6 +1443,72 @@ export declare enum Permission {
     OWNER = "OWNER"
 }
 
+/**
+ * This class defines a Template.
+ *
+ * A Template is a pre-configured setup for [[Books]] and associated Google Sheets that provides users with a starting point for specific accounting or financial management needs.
+ *
+ * @public
+ */
+export declare class Template {
+
+    constructor(json?: bkper.Template);
+    /**
+     * Gets the name of the Template.
+     *
+     * @returns The Template's name
+     */
+    getName(): string | undefined;
+    /**
+     * Gets the description of the Template.
+     *
+     * @returns The Template's description
+     */
+    getDescription(): string | undefined;
+    /**
+     * Gets the url of the image of the Template.
+     *
+     * @returns The url of the Template's image
+     */
+    getImageUrl(): string | undefined;
+    /**
+     * Gets the category of the Template.
+     *
+     * @returns The Template's category. Example: "PERSONAL", "BUSINESS", etc
+     */
+    getCategory(): string | undefined;
+    /**
+     * Gets the times the Template has been used.
+     *
+     * @returns The number of times the Template has been used
+     */
+    getTimesUsed(): number;
+    /**
+     * Gets the bookId of the [[Book]] associated with the Template.
+     *
+     * @returns The bookId of the Book associated with the Template
+     */
+    getBookId(): string | undefined;
+    /**
+     * Gets the link of the [[Book]] associated with the Template.
+     *
+     * @returns The link of the Book associated with the Template
+     */
+    getBookLink(): string | undefined;
+    /**
+     * Gets the link of the Google Sheets spreadsheet associated with the Template.
+     *
+     * @returns The link of the Google Sheets spreadsheet associated with the Template
+     */
+    getSheetsLink(): string | undefined;
+    /**
+     * Gets the wrapped plain json object of the Template.
+     *
+     * @returns The Template wrapped plain json object
+     */
+    json(): bkper.Template;
+}
+
 /**
  *
  * This class defines a Transaction between [credit and debit](http://en.wikipedia.org/wiki/Debits_and_credits) [[Accounts]].
@@ -1473,6 +1526,10 @@ export declare class Transaction {
      * @returns The wrapped plain json object
      */
     json(): bkper.Transaction;
+    /**
+     * @returns The book of the Transaction.
+     */
+    getBook(): Book;
     /**
      * @returns The id of the Transaction.
      */
@@ -1790,59 +1847,37 @@ export declare class Transaction {
 }
 
 /**
- *
- * An iterator that allows scripts to iterate over a potentially large collection of transactions.
- *
- * Example:
- *
- * ```js
- * var book = BkperApp.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");
- *
- * var transactionIterator = book.getTransactions("account:CreditCard after:28/01/2013 before:29/01/2013");
- *
- * while (transactionIterator.hasNext()) {
- *  var transaction = transactions.next();
- *  Logger.log(transaction.getDescription());
- * }
- * ```
- *
- * @public
+ * A list associated with a transaction query.
  */
-export declare class TransactionIterator {
-
-
-
-
-
-
+export declare class TransactionPage {
+    private book;
+    private wrapped;
+    constructor(book: Book, transactionList: bkper.TransactionList);
     /**
-     * Gets the Book that originate the iterator
+     * @returns The cursor associated with the query for pagination.
      */
-    getBook(): Book;
-    /**
-     * Gets a token that can be used to resume this iteration at a later time.
-     *
-     * This method is useful if processing an iterator in one execution would exceed the maximum execution time.
-     *
-     * Continuation tokens are generally valid short period of time.
-     */
-    getContinuationToken(): string | undefined;
+    getCursor(): string | undefined;
     /**
-     * Sets a continuation token from previous paused iteration
+     * Retrieves the account associated with the query, when filtering by account.
      */
-    setContinuationToken(continuationToken: string): Promise<void>;
+    getAccount(): Promise<Account | undefined>;
     /**
-     * Determines whether calling next() will return a transaction.
+     * @returns The first Transaction in the list.
      */
-    hasNext(): Promise<boolean>;
+    getFirst(): Transaction | undefined;
     /**
-     * Gets the next transaction in the collection of transactions.
+     *
+     * Get the total number of transactions in the list.
+     *
+     * @returns The total number of transactions.
      */
-    next(): Promise<Transaction | undefined>;
+    size(): number;
     /**
-     * @returns The account, when filtering by a single account.
+     * Get the transactions in the list.
+     *
+     * @returns An array of Transaction objects.
      */
-    getAccount(): Promise<Account | undefined>;
+    getItems(): Transaction[];
 }
 
 /**
@@ -1932,7 +1967,7 @@ export declare class User {
  *
  * @public
  */
-declare enum Visibility {
+export declare enum Visibility {
     /**
      * The book can be accessed by anyone with the link
      */

package/lib/index.js

@@ -5,18 +5,19 @@
  *
  * @packageDocumentation
  */
-export { App } from './model/App.js';
+export { Account } from './model/Account.js';
 export { Amount } from "./model/Amount.js";
+export { App } from './model/App.js';
 export { Bkper } from './model/Bkper.js';
-export { Account } from './model/Account.js';
 export { Book } from './model/Book.js';
 export { Collection } from './model/Collection.js';
+export { Connection } from './model/Connection.js';
 export { File } from './model/File.js';
 export { Group } from './model/Group.js';
+export { Integration } from './model/Integration.js';
+export { Template } from './model/Template.js';
 export { Transaction } from './model/Transaction.js';
-export { TransactionIterator } from './model/TransactionIterator.js';
+export { TransactionList as TransactionPage } from './model/TransactionList.js';
 export { User } from './model/User.js';
-export { Integration } from './model/Integration.js';
-export { Connection } from './model/Connection.js';
-export { Periodicity, AccountType, DecimalSeparator, Permission } from './model/Enums.js';
+export { Periodicity, DecimalSeparator, Permission, Visibility, AccountType, Period, Month } from './model/Enums.js';
 //# sourceMappingURL=index.js.map

package/lib/model/Bkper.js

@@ -12,8 +12,10 @@ import { App } from "./App.js";
 import * as AppService from '../service/app-service.js';
 import * as BookService from '../service/book-service.js';
 import * as UserService from '../service/user-service.js';
+import * as TemplateService from '../service/template-service.js';
 import { HttpApiRequest } from '../service/http-api-request.js';
 import { User } from "./User.js";
+import { Template } from "./Template.js";
 /**
  * This is the main entry point of the [bkper-js](https://www.npmjs.com/package/bkper-js) library.
  *
@@ -52,12 +54,13 @@ export class Bkper {
      * Gets the [[Book]] with the specified bookId from url param.
      *
      * @param id - The universal book id - The same bookId param of URL you access at app.bkper.com
+     * @param includeAccounts - Optional parameter to include accounts in the retrieved Book
      *
      * @returns The retrieved Book, for chaining
      */
-    static getBook(id) {
+    static getBook(id, includeAccounts) {
         return __awaiter(this, void 0, void 0, function* () {
-            let book = yield BookService.loadBook(id);
+            let book = yield BookService.loadBook(id, includeAccounts);
             return new Book(book);
         });
     }
@@ -83,6 +86,17 @@ export class Bkper {
             return apps.map(app => new App(app));
         });
     }
+    /**
+     * Gets all [[Templates]] available for the user.
+     *
+     * @returns The retrieved list of Templates
+     */
+    static getTemplates() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let templates = yield TemplateService.getTemplates();
+            return templates.map(template => new Template(template));
+        });
+    }
     /**
      * Gets the current logged [[User]].
      *

package/lib/model/Book.js

@@ -14,14 +14,13 @@ import * as FileService from '../service/file-service.js';
 import * as TransactionService from '../service/transaction-service.js';
 import * as IntegrationService from '../service/integration-service.js';
 import * as Utils from '../utils.js';
-import { normalizeName } from '../utils.js';
 import { Account } from './Account.js';
 import { Collection } from './Collection.js';
 import { File } from './File.js';
 import { Group } from './Group.js';
 import { Transaction } from './Transaction.js';
-import { TransactionIterator } from './TransactionIterator.js';
 import { Integration } from './Integration.js';
+import { TransactionList } from './TransactionList.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
@@ -33,6 +32,8 @@ import { Integration } from './Integration.js';
 export class Book {
     constructor(json) {
         this.wrapped = json || {};
+        this.mapGroups();
+        this.mapAccounts();
     }
     /**
      * @returns The wrapped plain json object
@@ -452,25 +453,13 @@ export class Book {
             return new Integration(integration);
         });
     }
-    /**
-     * Resumes a transaction iteration using a continuation token from a previous iterator.
-     *
-     * @param continuationToken - continuation token from a previous transaction iterator
-     *
-     * @returns a collection of transactions that remained in a previous iterator when the continuation token was generated
-     */
-    continueTransactionIterator(query, continuationToken) {
-        var transactionIterator = new TransactionIterator(this, query);
-        transactionIterator.setContinuationToken(continuationToken);
-        return transactionIterator;
-    }
     /**
      * Instantiate a new [[Transaction]]
      *
      * Example:
      *
      * ```js
-     * var book = BkperApp.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");
+     * var book = Bkper.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");
      *
      * book.newTransaction()
      *  .setDate('2013-01-25')
@@ -492,7 +481,7 @@ export class Book {
      *
      * Example:
      * ```js
-     * var book = BkperApp.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");
+     * var book = Bkper.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");
      *
      * book.newAccount()
      *  .setName('Some New Account')
@@ -512,7 +501,7 @@ export class Book {
      *
      * Example:
      * ```js
-     * var book = BkperApp.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");
+     * var book = Bkper.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");
      *
      * book.newGroup()
      *  .setName('Some New Group')
@@ -533,16 +522,22 @@ export class Book {
      */
     getAccount(idOrName) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!idOrName) {
+            if (!idOrName || idOrName.trim() == '') {
                 return undefined;
             }
-            idOrName = idOrName + '';
+            let account;
+            if (this.idAccountMap) {
+                account = this.idAccountMap.get(idOrName);
+                if (account) {
+                    return account;
+                }
+            }
             const accountPlain = yield AccountService.getAccount(this.getId(), idOrName);
-            if (!accountPlain) {
-                return undefined;
+            if (accountPlain) {
+                account = new Account(this, accountPlain);
+                return account;
             }
-            const account = new Account(this, accountPlain);
-            return account;
+            return undefined;
         });
     }
     /** @internal */
@@ -553,16 +548,26 @@ export class Book {
                 this.idGroupMap.set(id, group);
             }
         }
-        if (this.nameGroupMap) {
-            this.nameGroupMap.set(normalizeName(group.getName()), group);
-        }
     }
+    /** @internal */
     removeGroupCache(group) {
         if (this.idGroupMap) {
             this.idGroupMap.delete(group.getId() || '');
         }
-        if (this.nameGroupMap) {
-            this.nameGroupMap.delete(normalizeName(group.getName()));
+    }
+    /** @internal */
+    updateAccountCache(account) {
+        if (this.idAccountMap) {
+            const id = account.getId();
+            if (id) {
+                this.idAccountMap.set(id, account);
+            }
+        }
+    }
+    /** @internal */
+    removeAccountCache(account) {
+        if (this.idAccountMap) {
+            this.idAccountMap.delete(account.getId() || '');
         }
     }
     /**
@@ -580,9 +585,6 @@ export class Book {
             idOrName = idOrName + '';
             if (this.idGroupMap) {
                 let group = this.idGroupMap.get(idOrName);
-                if (!group && this.nameGroupMap) {
-                    group = this.nameGroupMap.get(normalizeName(idOrName));
-                }
                 if (group) {
                     return group;
                 }
@@ -605,50 +607,54 @@ export class Book {
                 return Array.from(this.idGroupMap.values());
             }
             let groups = yield GroupService.getGroups(this.getId());
-            let groupsObj = groups.map(group => new Group(this, group));
-            this.idGroupMap = new Map();
-            this.nameGroupMap = new Map();
-            for (var i = 0; i < groupsObj.length; i++) {
-                var group = groupsObj[i];
-                this.updateGroupCache(group);
-            }
-            return groupsObj;
+            return this.mapGroups(groups);
         });
     }
-    /**
-     * Get the [[Groups]] of a given account.
-     */
-    getGroupsByAccount(accountIdOrName) {
+    mapGroups(groups) {
+        if (!groups) {
+            return [];
+        }
+        let groupsObj = groups.map(group => new Group(this, group));
+        this.idGroupMap = new Map();
+        for (const group of groupsObj) {
+            this.updateGroupCache(group);
+        }
+        return groupsObj;
+    }
+    getAccounts() {
         return __awaiter(this, void 0, void 0, function* () {
-            let groups = yield GroupService.getGroupsByAccountId(this.getId(), accountIdOrName);
-            let groupsObj = groups.map(group => new Group(this, group));
-            return groupsObj;
+            if (this.idAccountMap) {
+                return Array.from(this.idAccountMap.values());
+            }
+            let accounts = yield AccountService.getAccounts(this.getId());
+            return this.mapAccounts(accounts);
         });
     }
+    mapAccounts(accounts) {
+        if (!accounts) {
+            return [];
+        }
+        let accountsObj = accounts.map(account => new Account(this, account));
+        this.idAccountMap = new Map();
+        for (const account of accountsObj) {
+            this.updateAccountCache(account);
+        }
+        return accountsObj;
+    }
     /**
-     * Get Book transactions based on a query.
+     * Lists transactions in the Book based on the provided query, limit, and cursor, for pagination.
      *
-     * See [Query Guide](https://help.bkper.com/en/articles/2569178-search-query-guide) to learn more
+     * @param query - The query string to filter transactions
+     * @param limit - The maximum number of transactions to return. Default to 100, max to 1000;
+     * @param cursor - The cursor for pagination
      *
-     * @param query - The query string.
-     *
-     * @returns The Transactions result as an iterator.
-     *
-     * Example:
-     *
-     * ```js
-     * var book = BkperApp.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");
-     *
-     * var transactions = book.getTransactions("account:CreditCard after:28/01/2013 before:29/01/2013");
-     *
-     * while (transactions.hasNext()) {
-     *  var transaction = transactions.next();
-     *  Logger.log(transaction.getDescription());
-     * }
-     * ```
+     * @returns A TransactionPage object containing the list of transactions
      */
-    getTransactions(query) {
-        return new TransactionIterator(this, query);
+    listTransactions(query, limit, cursor) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const transactionsList = yield TransactionService.listTransactions(this.getId(), query, limit, cursor);
+            return new TransactionList(this, transactionsList);
+        });
     }
     /**
      * Retrieve a transaction by id
@@ -668,7 +674,7 @@ export class Book {
      *
      * Example:
      * ```js
-     * var book = BkperApp.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");
+     * var book = Bkper.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");
      *
      * book.newFile()
      *  .setBlob(UrlFetchApp.fetch('https://bkper.com/images/index/integrations4.png').getBlob())

package/lib/model/Template.js

@@ -0,0 +1,85 @@
+/**
+ * This class defines a Template.
+ *
+ * A Template is a pre-configured setup for [[Books]] and associated Google Sheets that provides users with a starting point for specific accounting or financial management needs.
+ *
+ * @public
+ */
+export class Template {
+    constructor(json) {
+        this.wrapped = json || {};
+    }
+    /**
+     * Gets the name of the Template.
+     *
+     * @returns The Template's name
+     */
+    getName() {
+        return this.wrapped.name;
+    }
+    /**
+     * Gets the description of the Template.
+     *
+     * @returns The Template's description
+     */
+    getDescription() {
+        return this.wrapped.description;
+    }
+    /**
+     * Gets the url of the image of the Template.
+     *
+     * @returns The url of the Template's image
+     */
+    getImageUrl() {
+        return this.wrapped.imageUrl;
+    }
+    /**
+     * Gets the category of the Template.
+     *
+     * @returns The Template's category. Example: "PERSONAL", "BUSINESS", etc
+     */
+    getCategory() {
+        return this.wrapped.category;
+    }
+    /**
+     * Gets the times the Template has been used.
+     *
+     * @returns The number of times the Template has been used
+     */
+    getTimesUsed() {
+        return this.wrapped.timesUsed || 0;
+    }
+    /**
+     * Gets the bookId of the [[Book]] associated with the Template.
+     *
+     * @returns The bookId of the Book associated with the Template
+     */
+    getBookId() {
+        return this.wrapped.bookId;
+    }
+    /**
+     * Gets the link of the [[Book]] associated with the Template.
+     *
+     * @returns The link of the Book associated with the Template
+     */
+    getBookLink() {
+        return this.wrapped.bookLink;
+    }
+    /**
+     * Gets the link of the Google Sheets spreadsheet associated with the Template.
+     *
+     * @returns The link of the Google Sheets spreadsheet associated with the Template
+     */
+    getSheetsLink() {
+        return this.wrapped.sheetsLink;
+    }
+    /**
+     * Gets the wrapped plain json object of the Template.
+     *
+     * @returns The Template wrapped plain json object
+     */
+    json() {
+        return this.wrapped;
+    }
+}
+//# sourceMappingURL=Template.js.map

package/lib/model/Transaction.js

@@ -32,6 +32,12 @@ export class Transaction {
     json() {
         return this.wrapped;
     }
+    /**
+     * @returns The book of the Transaction.
+     */
+    getBook() {
+        return this.book;
+    }
     /**
      * @returns The id of the Transaction.
      */

package/lib/model/TransactionList.js

@@ -0,0 +1,67 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { Transaction } from "./Transaction.js";
+/**
+ * A list associated with a transaction query.
+ */
+export class TransactionList {
+    constructor(book, transactionList) {
+        this.book = book;
+        this.wrapped = transactionList;
+    }
+    /**
+     * @returns The cursor associated with the query for pagination.
+     */
+    getCursor() {
+        return this.wrapped.cursor;
+    }
+    /**
+     * Retrieves the account associated with the query, when filtering by account.
+     */
+    getAccount() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.wrapped.account) {
+                return undefined;
+            }
+            return yield this.book.getAccount(this.wrapped.account);
+        });
+    }
+    /**
+     * @returns The first Transaction in the list.
+     */
+    getFirst() {
+        const transactions = this.getItems();
+        return transactions.length > 0 ? transactions[0] : undefined;
+    }
+    /**
+     *
+     * Get the total number of transactions in the list.
+     *
+     * @returns The total number of transactions.
+     */
+    size() {
+        var _a;
+        return ((_a = this.wrapped.items) === null || _a === void 0 ? void 0 : _a.length) || 0;
+    }
+    /**
+     * Get the transactions in the list.
+     *
+     * @returns An array of Transaction objects.
+     */
+    getItems() {
+        var _a;
+        let transactions = [];
+        for (let transaction of (_a = this.wrapped.items) !== null && _a !== void 0 ? _a : []) {
+            transactions.push(new Transaction(this.book, transaction));
+        }
+        return transactions;
+    }
+}
+//# sourceMappingURL=TransactionList.js.map

package/lib/service/account-service.js

@@ -33,4 +33,10 @@ export function getAccount(bookId, idOrName) {
         return response.data;
     });
 }
+export function getAccounts(bookId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var response = yield new HttpBooksApiV5Request(`${bookId}/accounts`).setMethod('GET').fetch();
+        return response.data;
+    });
+}
 //# sourceMappingURL=account-service.js.map

package/lib/service/book-service.js

@@ -22,12 +22,13 @@ export function loadBooks() {
         return booksJson;
     });
 }
-export function loadBook(bookId) {
+export function loadBook(bookId, loadAccounts) {
     return __awaiter(this, void 0, void 0, function* () {
         if (bookId == null) {
             throw new Error("Book id null!");
         }
-        let response = yield new HttpBooksApiV5Request(bookId).fetch();
+        loadAccounts = loadAccounts || false;
+        let response = yield new HttpBooksApiV5Request(bookId).addParam('loadAccounts', loadAccounts).fetch();
         return response.data;
     });
 }

package/lib/service/template-service.js

@@ -0,0 +1,25 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { HttpApiRequest } from "./http-api-request.js";
+export function getTemplates() {
+    return __awaiter(this, void 0, void 0, function* () {
+        let response = yield new HttpApiRequest(`v5/templates`).setMethod('GET').fetch();
+        if (response.data == null) {
+            return [];
+        }
+        let templateListPlain = response.data;
+        let templatesJson = templateListPlain.items;
+        if (templatesJson == null) {
+            return [];
+        }
+        return templatesJson;
+    });
+}
+//# sourceMappingURL=template-service.js.map

package/lib/service/transaction-service.js

@@ -83,7 +83,7 @@ export function getTransaction(bookId, id) {
         return response.data;
     });
 }
-export function searchTransactions(bookId, query, limit, cursor) {
+export function listTransactions(bookId, query, limit, cursor) {
     return __awaiter(this, void 0, void 0, function* () {
         if (!query) {
             query = "";

package/package.json

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

package/lib/model/TransactionIterator.js

@@ -1,150 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { TransactionPage } from "./TransactionPage.js";
-/**
- *
- * An iterator that allows scripts to iterate over a potentially large collection of transactions.
- *
- * Example:
- *
- * ```js
- * var book = BkperApp.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");
- *
- * var transactionIterator = book.getTransactions("account:CreditCard after:28/01/2013 before:29/01/2013");
- *
- * while (transactionIterator.hasNext()) {
- *  var transaction = transactions.next();
- *  Logger.log(transaction.getDescription());
- * }
- * ```
- *
- * @public
- */
-export class TransactionIterator {
-    /** @internal */
-    constructor(book, query) {
-        this.book = book;
-        this.query = query;
-        if (this.query == null) {
-            this.query = "";
-        }
-        this.currentPage = undefined;
-        this.nextPage = undefined;
-        this.lastCursor = undefined;
-    }
-    /**
-     * Gets the Book that originate the iterator
-     */
-    getBook() {
-        return this.book;
-    }
-    /**
-     * Gets a token that can be used to resume this iteration at a later time.
-     *
-     * This method is useful if processing an iterator in one execution would exceed the maximum execution time.
-     *
-     * Continuation tokens are generally valid short period of time.
-     */
-    getContinuationToken() {
-        if (this.currentPage == null) {
-            return undefined;
-        }
-        var cursor = this.lastCursor;
-        if (cursor == null) {
-            cursor = "null";
-        }
-        var continuationToken = cursor + "_bkperpageindex_" + this.currentPage.getIndex();
-        return continuationToken;
-    }
-    /**
-     * Sets a continuation token from previous paused iteration
-     */
-    setContinuationToken(continuationToken) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (continuationToken == null) {
-                return;
-            }
-            var cursorIndexArray = continuationToken.split("_bkperpageindex_");
-            if (cursorIndexArray.length != 2) {
-                return;
-            }
-            var cursor = cursorIndexArray[0];
-            var index = cursorIndexArray[1];
-            if ("null" != cursor) {
-                this.lastCursor = cursor;
-            }
-            let indexNum = new Number(index).valueOf();
-            this.currentPage = yield new TransactionPage().init(this.book, this.query, this.lastCursor);
-            this.currentPage.setIndex(indexNum);
-        });
-    }
-    /**
-     * Determines whether calling next() will return a transaction.
-     */
-    hasNext() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.currentPage == null) {
-                this.currentPage = yield new TransactionPage().init(this.book, this.query, this.lastCursor);
-            }
-            if (this.currentPage.hasNext()) {
-                return true;
-            }
-            else if (!this.currentPage.hasReachEnd()) {
-                this.lastCursor = this.currentPage.getCursor();
-                if (this.nextPage == null) {
-                    this.nextPage = yield new TransactionPage().init(this.book, this.query, this.lastCursor);
-                }
-                return this.nextPage.hasNext();
-            }
-            else {
-                return false;
-            }
-        });
-    }
-    /**
-     * Gets the next transaction in the collection of transactions.
-     */
-    next() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.currentPage == null) {
-                this.currentPage = yield new TransactionPage().init(this.book, this.query, this.lastCursor);
-            }
-            if (this.currentPage.hasNext()) {
-                return this.currentPage.next();
-            }
-            else if (!this.currentPage.hasReachEnd()) {
-                this.lastCursor = this.currentPage.getCursor();
-                if (this.nextPage) {
-                    this.currentPage = this.nextPage;
-                    this.nextPage = undefined;
-                }
-                else {
-                    this.currentPage = yield new TransactionPage().init(this.book, this.query, this.lastCursor);
-                }
-                return this.currentPage.next();
-            }
-            else {
-                return undefined;
-            }
-        });
-    }
-    /**
-     * @returns The account, when filtering by a single account.
-     */
-    getAccount() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.currentPage == null) {
-                this.currentPage = yield new TransactionPage().init(this.book, this.query, this.lastCursor);
-            }
-            return this.currentPage.getAccount();
-        });
-    }
-}
-//# sourceMappingURL=TransactionIterator.js.map

package/lib/model/TransactionPage.js

@@ -1,71 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { Transaction } from "./Transaction.js";
-import * as TransactionService from '../service/transaction-service.js';
-export class TransactionPage {
-    constructor() {
-        this.transactions = [];
-    }
-    init(book, query, lastCursor) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var transactionList = yield TransactionService.searchTransactions(book.getId(), query, 1000, lastCursor);
-            if (!transactionList.items) {
-                transactionList.items = [];
-            }
-            this.transactions = transactionList.items.map(tx => new Transaction(book, tx));
-            this.cursor = transactionList.cursor;
-            if (transactionList.account) {
-                this.account = yield book.getAccount(transactionList.account);
-            }
-            this.index = 0;
-            if (this.transactions == null || this.transactions.length == 0 || this.cursor == null || this.cursor == "") {
-                this.reachEnd = true;
-            }
-            else {
-                this.reachEnd = false;
-            }
-            return this;
-        });
-    }
-    getCursor() {
-        return this.cursor;
-    }
-    hasNext() {
-        return (this.index != null && this.index < this.transactions.length) || false;
-    }
-    hasReachEnd() {
-        return this.reachEnd || false;
-    }
-    getIndex() {
-        if (this.index != null && this.index >= this.transactions.length) {
-            return 0;
-        }
-        else {
-            return this.index || 0;
-        }
-    }
-    setIndex(index) {
-        this.index = index;
-    }
-    getAccount() {
-        return this.account;
-    }
-    next() {
-        if (this.index != null && this.index < this.transactions.length) {
-            var transaction = this.transactions[this.index];
-            this.index++;
-            return transaction;
-        }
-        else {
-            return undefined;
-        }
-    }
-}
-//# sourceMappingURL=TransactionPage.js.map