bkper-js 1.0.0

package/lib/model/Collection.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Collection = void 0;
+const Book_1 = require("./Book");
+/**
+ * This class defines a Collection of [[Books]].
+ *
+ * @public
+ */
+class Collection {
+    /** @internal */
+    constructor(wrapped) {
+        this.wrapped = wrapped;
+    }
+    /**
+     * @returns The id of this Collection
+     */
+    getId() {
+        return this.wrapped.id;
+    }
+    /**
+     * @returns The name of this Collection
+     */
+    getName() {
+        return this.wrapped.name;
+    }
+    /**
+     * @returns All Books of this collection.
+     */
+    getBooks() {
+        let books = [];
+        if (this.wrapped.books == null) {
+            return books;
+        }
+        for (const bookPayload of this.wrapped.books) {
+            let book = new Book_1.Book(bookPayload);
+            books.push(book);
+        }
+        return books;
+    }
+}
+exports.Collection = Collection;
+//# sourceMappingURL=Collection.js.map

package/lib/model/Config.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Config.js.map

package/lib/model/Connection.js

@@ -0,0 +1,261 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Connection = void 0;
+const ConnectionService = __importStar(require("../service/connection-service"));
+const Integration_1 = require("./Integration");
+/**
+ * This class defines a Connection from an [[User]] to an external service.
+ *
+ * @public
+ */
+class Connection {
+    constructor(json) {
+        this.wrapped = json || {};
+    }
+    /**
+     * Gets the wrapped plain json object of the Connection.
+     *
+     * @returns The Connection wrapped plain json object
+     */
+    json() {
+        return this.wrapped;
+    }
+    /**
+     * Gets the id of the Connection.
+     *
+     * @returns The Connection's id
+     */
+    getId() {
+        return this.wrapped.id;
+    }
+    /**
+     * Gets the agentId of the Connection.
+     *
+     * @returns The Connection's agentId
+     */
+    getAgentId() {
+        return this.wrapped.agentId;
+    }
+    /**
+     * Sets the Connection agentId.
+     *
+     * @param agentId - The Connection agentId
+     *
+     * @returns The Connection, for chainning
+     */
+    setAgentId(agentId) {
+        this.wrapped.agentId = agentId;
+        return this;
+    }
+    /**
+     * Gets the name of the Connection.
+     *
+     * @returns The Connection name
+     */
+    getName() {
+        return this.wrapped.name;
+    }
+    /**
+     * Gets the email of the owner of the Connection.
+     *
+     * @returns The Connection owner's email
+     */
+    getEmail() {
+        return this.wrapped.email;
+    }
+    /**
+     * Sets the name of the Connection.
+     *
+     * @param name - The name of the Connection
+     *
+     * @returns The Connection, for chainning
+     */
+    setName(name) {
+        this.wrapped.name = name;
+        return this;
+    }
+    /**
+     * Sets the universal unique identifier of the Connection.
+     *
+     * @param uuid - The universal unique identifier of the Connection
+     *
+     * @returns The Connection, for chainning
+     */
+    setUUID(uuid) {
+        this.wrapped.uuid = uuid;
+        return this;
+    }
+    /**
+     * Gets the universal unique identifier of this Connection.
+     *
+     * @returns The Connection's universal unique identifier name
+     */
+    getUUID() {
+        return this.wrapped.uuid;
+    }
+    /**
+     * Gets the type of the Connection.
+     *
+     * @returns The Connection type
+     */
+    getType() {
+        return this.wrapped.type;
+    }
+    /**
+     * Sets the Connection type.
+     *
+     * @param type - The Connection type
+     *
+     * @returns The Connection, for chainning
+     */
+    setType(type) {
+        this.wrapped.type = type;
+        return this;
+    }
+    /**
+     * Gets the custom properties stored in the Connection
+     *
+     * @returns Object with key/value pair properties
+     */
+    getProperties() {
+        return this.wrapped.properties != null ? Object.assign({}, this.wrapped.properties) : {};
+    }
+    /**
+     * Sets the custom properties of the Connection.
+     *
+     * @param properties - Object with key/value pair properties
+     *
+     * @returns The Connection, for chainning
+     */
+    setProperties(properties) {
+        this.wrapped.properties = Object.assign({}, properties);
+        return this;
+    }
+    /**
+     * Gets the property value for given keys. First property found will be retrieved.
+     *
+     * @param keys - The property key
+     *
+     * @returns The retrieved property value
+     */
+    getProperty(...keys) {
+        for (let index = 0; index < keys.length; index++) {
+            const key = keys[index];
+            let value = this.wrapped.properties != null ? this.wrapped.properties[key] : null;
+            if (value != null && value.trim() != '') {
+                return value;
+            }
+        }
+        return null;
+    }
+    /**
+     * Sets a custom property in the Connection.
+     *
+     * @param key - The property key
+     * @param value - The property value
+     *
+     * @returns The Connection, for chaining
+     */
+    setProperty(key, value) {
+        if (key == null || key.trim() == '') {
+            return this;
+        }
+        if (this.wrapped.properties == null) {
+            this.wrapped.properties = {};
+        }
+        this.wrapped.properties[key] = value;
+        return this;
+    }
+    /**
+     * Deletes a custom property stored in the Connection.
+     *
+     * @param key - The property key
+     *
+     * @returns The Connection, for chainning
+     */
+    deleteProperty(key) {
+        this.setProperty(key, null);
+        return this;
+    }
+    /**
+     * Cleans any token property stored in the Connection.
+     */
+    clearTokenProperties() {
+        this.getPropertyKeys().filter(key => key.includes("token")).forEach(key => this.deleteProperty(key));
+    }
+    /**
+     * Gets the custom properties keys stored in the Connection.
+     *
+     * @returns The retrieved property keys
+     */
+    getPropertyKeys() {
+        let properties = this.getProperties();
+        let propertyKeys = [];
+        if (properties) {
+            for (var key in properties) {
+                if (Object.prototype.hasOwnProperty.call(properties, key)) {
+                    propertyKeys.push(key);
+                }
+            }
+        }
+        propertyKeys = propertyKeys.sort();
+        return propertyKeys;
+    }
+    /**
+     * Gets the existing [[Integrations]] on the Connection.
+     *
+     * @returns The existing Integration objects
+     */
+    getIntegrations() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const integrationsPlain = yield ConnectionService.listIntegrations(this.getId());
+            const integrations = integrationsPlain.map(i => new Integration_1.Integration(i));
+            return integrations;
+        });
+    }
+    /**
+     * Performs create new Connection.
+     *
+     * @returns The Connection, for chaining
+     */
+    create() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.wrapped = yield ConnectionService.createConnection(this.wrapped);
+            return this;
+        });
+    }
+}
+exports.Connection = Connection;
+//# sourceMappingURL=Connection.js.map

package/lib/model/Enums.js

@@ -0,0 +1,138 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Month = exports.Period = exports.AccountType = exports.Permission = exports.DecimalSeparator = exports.Periodicity = void 0;
+/**
+ * The Periodicity of the query. It may depend on the level of granularity you write the range params.
+ *
+ * @public
+ */
+var Periodicity;
+(function (Periodicity) {
+    /**
+     * Example: after:25/01/1983, before:04/03/2013, after:$d-30, before:$d, after:$d-15/$m
+     */
+    Periodicity["DAILY"] = "DAILY";
+    /**
+     * Example: after:jan/2013, before:mar/2013, after:$m-1, before:$m
+     */
+    Periodicity["MONTHLY"] = "MONTHLY";
+    /**
+     * Example: on:2013, after:2013, $y
+     */
+    Periodicity["YEARLY"] = "YEARLY";
+})(Periodicity || (exports.Periodicity = Periodicity = {}));
+/**
+ * Decimal separator of numbers on book
+ *
+ * @public
+ */
+var DecimalSeparator;
+(function (DecimalSeparator) {
+    /**
+     * ,
+     */
+    DecimalSeparator["COMMA"] = "COMMA";
+    /**
+     * .
+     */
+    DecimalSeparator["DOT"] = "DOT";
+})(DecimalSeparator || (exports.DecimalSeparator = DecimalSeparator = {}));
+/**
+ * Enum representing permissions of user in the Book
+ *
+ * Learn more at [share article](https://help.bkper.com/en/articles/2569153-share-your-book-with-your-peers).
+ *
+ * @public
+ */
+var Permission;
+(function (Permission) {
+    /**
+     * No permission
+     */
+    Permission["NONE"] = "NONE";
+    /**
+     * View transactions, accounts and balances.
+     */
+    Permission["VIEWER"] = "VIEWER";
+    /**
+     * Record and delete drafts only. Useful to collect data only
+     */
+    Permission["RECORDER"] = "RECORDER";
+    /**
+     * View transactions, accounts, record and delete drafts
+     */
+    Permission["POSTER"] = "POSTER";
+    /**
+     * Manage accounts, transactions, book configuration and sharing
+     */
+    Permission["EDITOR"] = "EDITOR";
+    /**
+     * Manage everything, including book visibility and deletion. Only one owner per book.
+     */
+    Permission["OWNER"] = "OWNER";
+})(Permission || (exports.Permission = Permission = {}));
+/**
+ * Enum that represents account types.
+ *
+ * @public
+ */
+var AccountType;
+(function (AccountType) {
+    /**
+     * Asset account type
+     */
+    AccountType["ASSET"] = "ASSET";
+    /**
+     * Liability account type
+     */
+    AccountType["LIABILITY"] = "LIABILITY";
+    /**
+     * Incoming account type
+     */
+    AccountType["INCOMING"] = "INCOMING";
+    /**
+     * Outgoing account type
+     */
+    AccountType["OUTGOING"] = "OUTGOING";
+})(AccountType || (exports.AccountType = AccountType = {}));
+/**
+ * Enum that represents a period slice.
+ *
+ * @public
+ */
+var Period;
+(function (Period) {
+    /**
+     *  Monthly period
+     */
+    Period["MONTH"] = "MONTH";
+    /**
+     * Quarterly period
+     */
+    Period["QUARTER"] = "QUARTER";
+    /**
+     * Yearly period
+     */
+    Period["YEAR"] = "YEAR";
+})(Period || (exports.Period = Period = {}));
+/**
+ * Enum that represents a Month.
+ *
+ * @public
+ */
+var Month;
+(function (Month) {
+    Month["JANUARY"] = "JANUARY";
+    Month["FEBRUARY"] = "FEBRUARY";
+    Month["MARCH"] = "MARCH";
+    Month["APRIL"] = "APRIL";
+    Month["MAY"] = "MAY";
+    Month["JUNE"] = "JUNE";
+    Month["JULY"] = "JULY";
+    Month["AUGUST"] = "AUGUST";
+    Month["SEPTEMBER"] = "SEPTEMBER";
+    Month["OCTOBER"] = "OCTOBER";
+    Month["NOVEMBER"] = "NOVEMBER";
+    Month["DECEMBER"] = "DECEMBER";
+})(Month || (exports.Month = Month = {}));
+//# sourceMappingURL=Enums.js.map

package/lib/model/File.js

@@ -0,0 +1,128 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.File = void 0;
+const FileService = __importStar(require("../service/file-service"));
+/**
+ *
+ * This class defines a File uploaded to a [[Book]].
+ *
+ * A File can be attached to a [[Transaction]] or used to import data.
+ *
+ * @public
+ */
+class File {
+    /**
+     * Gets the File id
+     */
+    getId() {
+        return this.wrapped.id;
+    }
+    /**
+     * Gets the File name
+     */
+    getName() {
+        return this.wrapped.name;
+    }
+    /**
+     *
+     * Sets the name of the File.
+     *
+     * @returns This File, for chainning.
+     */
+    setName(name) {
+        this.wrapped.name = name;
+        return this;
+    }
+    /**
+     * Gets the File content type
+     */
+    getContentType() {
+        return this.wrapped.contentType;
+    }
+    /**
+     *
+     * Sets the File content type.
+     *
+     * @returns This File, for chainning.
+     */
+    setContentType(contentType) {
+        this.wrapped.contentType = contentType;
+        return this;
+    }
+    /**
+     * Gets the file content Base64 encoded
+     */
+    getContent() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.getId() != null && (this.wrapped == null || this.wrapped.content == null)) {
+                this.wrapped = yield FileService.getFile(this.book.getId(), this.getId());
+            }
+            return this.wrapped.content;
+        });
+    }
+    /**
+     *
+     * Sets the File content Base64 encoded.
+     *
+     * @returns This File, for chainning.
+     */
+    setContent(content) {
+        this.wrapped.content = content;
+        return this;
+    }
+    /**
+     * Gets the file serving url for accessing via browser
+     */
+    getUrl() {
+        return this.wrapped.url;
+    }
+    /**
+     * Gets the file size in bytes
+     */
+    getSize() {
+        return this.wrapped.size;
+    }
+    /**
+     * Perform create new File.
+     */
+    create() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.wrapped = yield FileService.createFile(this.book.getId(), this.wrapped);
+            return this;
+        });
+    }
+}
+exports.File = File;
+//# sourceMappingURL=File.js.map