bkper-js 1.6.0 → 1.7.0

package/lib/index.d.ts

@@ -424,6 +424,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]].
      *
@@ -1367,7 +1373,7 @@ export declare class Integration {
  *
  * @public
  */
-declare enum Month {
+export declare enum Month {
     JANUARY = "JANUARY",
     FEBRUARY = "FEBRUARY",
     MARCH = "MARCH",
@@ -1387,7 +1393,7 @@ declare enum Month {
  *
  * @public
  */
-declare enum Period {
+export declare enum Period {
     /**
      *  Monthly period
      */
@@ -1456,6 +1462,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]].
@@ -1932,7 +2004,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 { 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.
  *
@@ -83,6 +85,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/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/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/package.json

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