bkper 2.6.2 → 2.6.3

package/lib/index.d.ts

@@ -310,7 +310,7 @@ export declare class Amount {
 /**
  * Defines an App on Bkper.
  *
- * Apps can be installed on Books by users.s
+ * Apps can be installed on Books by users.
  *
  * @public
  */
@@ -349,21 +349,34 @@ export declare class Bkper {
      *
      * @param id - The universal book id - The same bookId param of URL you access at app.bkper.com
      *
+     * @returns The retrieved Book, for chaining
      */
     static getBook(id: string): Promise<Book>;
     /**
      * Gets the current logged [[User]].
+     *
+     * @returns The retrieved User, for chaining
      */
     static getUser(): Promise<User>;
     /**
      * Sets the API [[Config]] object.
+     *
+     * @param config - The Config object
      */
     static setConfig(config: Config): void;
     /**
+     * Sets the API key to identify the agent.
+     *
+     * @param key - The API key
+     *
+     * @returns The defined [[App]] object
+     *
      * @deprecated Use `setConfig()` instead
      */
     static setApiKey(key: string): App;
     /**
+     * Sets the provider of the valid OAuth2 access token
+     *
      * @deprecated Use `setConfig()` instead
      */
     static setOAuthTokenProvider(oauthTokenProvider: () => Promise<string>): Promise<void>;
@@ -600,8 +613,27 @@ export declare class Book {
      * Trigger [Balances Audit](https://help.bkper.com/en/articles/4412038-balances-audit) async process.
      */
     audit(): void;
+    /**
+     * Gets the existing [[Integrations]] in the Book.
+     *
+     * @returns The existing Integration objects
+     */
     getIntegrations(): Promise<Integration[]>;
+    /**
+     * Creates a new [[Integration]] in the Book.
+     *
+     * @param integration - The Integration object or wrapped plain json
+     *
+     * @returns The created Integration object
+     */
     createIntegration(integration: bkper.Integration | Integration): Promise<Integration>;
+    /**
+     * Updates an existing [[Integration]] in the Book.
+     *
+     * @param integration - The Integration wrapped plain json
+     *
+     * @returns The updated Integration object
+     */
     updateIntegration(integration: bkper.Integration): Promise<Integration>;
     /**
      * Resumes a transaction iteration using a continuation token from a previous iterator.
@@ -761,7 +793,12 @@ export declare class Collection {
     getBooks(): Book[];
 }
 
-declare interface Config {
+/**
+ * This class defines the [[Bkper]] API Config.
+ *
+ * @public
+ */
+export declare interface Config {
     /**
      * The API key to identify the agent.
      *
@@ -770,6 +807,9 @@ declare interface Config {
      * See how to create your api key [here](https://cloud.google.com/docs/authentication/api-keys).
      */
     apiKeyProvider?: () => Promise<string>;
+    /**
+     * Issue a valid OAuth2 access token with **https://www.googleapis.com/auth/userinfo.email** scope authorized.
+     */
     oauthTokenProvider?: () => Promise<string>;
     /**
      * Provides additional headers to append to the API request
@@ -777,6 +817,9 @@ declare interface Config {
     requestHeadersProvider?: () => Promise<{
         [key: string]: string;
     }>;
+    /**
+     * Custom request error handler
+     */
     requestErrorHandler?: (error: any) => any;
     /**
      * Sets the base api url. Default to https://app.bkper.com/_ah/api/bkper
@@ -785,7 +828,7 @@ declare interface Config {
 }
 
 /**
- * This class defines a Connection from an User to an external service.
+ * This class defines a Connection from an [[User]] to an external service.
  *
  * @public
  */
@@ -793,77 +836,103 @@ export declare class Connection {
     
     constructor(json?: bkper.Connection);
     /**
-     * @returns The wrapped plain json object
+     * Gets the wrapped plain json object of the Connection.
+     *
+     * @returns The Connection wrapped plain json object
      */
     json(): bkper.Connection;
     /**
-     * @returns The id of this User
+     * Gets the id of the Connection.
+     *
+     * @returns The Connection's id
      */
     getId(): string;
     /**
-     * @returns The Connection agentId
+     * Gets the agentId of the Connection.
+     *
+     * @returns The Connection's agentId
      */
     getAgentId(): string;
     /**
-     * Sets the Connection agentId
+     * Sets the Connection agentId.
+     *
+     * @param agentId - The Connection agentId
      *
-     * @returns This Connection, for chainning.
+     * @returns The Connection, for chainning
      */
     setAgentId(agentId: string): Connection;
     /**
-     * @returns The name of this Connection
+     * Gets the name of the Connection.
+     *
+     * @returns The Connection name
      */
     getName(): string;
     /**
-     * @returns The email of the owner of this Connection
+     * Gets the email of the owner of the Connection.
+     *
+     * @returns The Connection owner's email
      */
     getEmail(): string;
     /**
      * Sets the name of the Connection.
      *
-     * @returns This Connection, for chainning.
+     * @param name - The name of the Connection
+     *
+     * @returns The Connection, for chainning
      */
     setName(name: string): Connection;
     /**
-     * Sets the universal unique identifier of this connection.
+     * Sets the universal unique identifier of the Connection.
+     *
+     * @param uuid - The universal unique identifier of the Connection
      *
-     * @returns This Connection, for chainning.
+     * @returns The Connection, for chainning
      */
     setUUID(uuid: string): Connection;
     /**
-     * @returns The name of universal unique identifier of the connection
+     * Gets the universal unique identifier of this Connection.
+     *
+     * @returns The Connection's universal unique identifier name
      */
     getUUID(): string;
     /**
-     * @returns The connection type
+     * Gets the type of the Connection.
+     *
+     * @returns The Connection type
      */
     getType(): "APP" | "BANK";
     /**
-     * Sets the connection type.
+     * Sets the Connection type.
+     *
+     * @param type - The Connection type
      *
-     * @returns This Connection, for chainning.
+     * @returns The Connection, for chainning
      */
     setType(type: "APP" | "BANK"): Connection;
     /**
-     * Gets the custom properties stored in this Connection
+     * Gets the custom properties stored in the Connection
+     *
+     * @returns Object with key/value pair properties
      */
     getProperties(): {
         [key: string]: string;
     };
     /**
-     * Sets the custom properties of the Connection
+     * Sets the custom properties of the Connection.
      *
      * @param properties - Object with key/value pair properties
      *
-     * @returns This Connection, for chainning.
+     * @returns The Connection, for chainning
      */
     setProperties(properties: {
         [key: string]: string;
     }): Connection;
     /**
-     * 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 retrieved property value
      */
     getProperty(...keys: string[]): string;
     /**
@@ -871,27 +940,38 @@ export declare class Connection {
      *
      * @param key - The property key
      * @param value - The property value
+     *
+     * @returns The Connection, for chaining
      */
     setProperty(key: string, value: string): Connection;
     /**
-     * Delete a custom property
+     * Deletes a custom property stored in the Connection.
      *
      * @param key - The property key
      *
-     * @returns This Connection, for chainning.
+     * @returns The Connection, for chainning
      */
     deleteProperty(key: string): Connection;
     /**
-     * Clean any token property
+     * Cleans any token property stored in the Connection.
      */
     clearTokenProperties(): void;
     /**
      * Gets the custom properties keys stored in the Connection.
+     *
+     * @returns The retrieved property keys
      */
     getPropertyKeys(): string[];
+    /**
+     * Gets the existing [[Integrations]] on the Connection.
+     *
+     * @returns The existing Integration objects
+     */
     getIntegrations(): Promise<Integration[]>;
     /**
-     * Perform create new connection.
+     * Performs create new Connection.
+     *
+     * @returns The Connection, for chaining
      */
     create(): Promise<Connection>;
 }
@@ -1092,7 +1172,7 @@ export declare class Group {
 }
 
 /**
- * This class defines a Integration from an User to an external service.
+ * This class defines a Integration from an [[User]] to an external service.
  *
  * @public
  */
@@ -1100,38 +1180,53 @@ export declare class Integration {
     
     constructor(json: bkper.Integration);
     /**
-     * @returns The wrapped plain json object
+     * Gets the wrapped plain json object of the Integration.
+     *
+     * @returns The Integration wrapped plain json object
      */
     json(): bkper.Integration;
+    /**
+     * Gets the [[Book]] id of the Integration.
+     *
+     * @returns The Integration's Book id
+     */
     getBookId(): string;
     /**
-     * @returns The id of this User
+     * Gets the id of the Integration.
+     *
+     * @returns This Integration's id
      */
     getId(): string;
     /**
-     * @returns The name of this Integration
+     * Gets the name of the Integration.
+     *
+     * @returns The Integration's name
      */
     getName(): string;
     /**
-     * Gets the custom properties stored in this Integration
+     * Gets the custom properties stored in the Integration.
+     *
+     * @returns Object with key/value pair properties
      */
     getProperties(): {
         [key: string]: string;
     };
     /**
-     * Sets the custom properties of the Integration
+     * Sets the custom properties of the Integration.
      *
      * @param properties - Object with key/value pair properties
      *
-     * @returns This Integration, for chainning.
+     * @returns The Integration, for chainning
      */
     setProperties(properties: {
         [key: string]: string;
     }): Integration;
     /**
-     * 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 retrieved property value
      */
     getProperty(...keys: string[]): string;
     /**
@@ -1139,14 +1234,16 @@ export declare class Integration {
      *
      * @param key - The property key
      * @param value - The property value
+     *
+     * @returns The Integration, for chaining
      */
     setProperty(key: string, value: string): Integration;
     /**
-     * Delete a custom property
+     * Deletes a custom property stored in the Integration.
      *
      * @param key - The property key
      *
-     * @returns This Integration, for chainning.
+     * @returns The Integration, for chainning
      */
     deleteProperty(key: string): Integration;
 }
@@ -1634,21 +1731,36 @@ export declare class User {
     
     constructor(wrapped: bkper.User);
     /**
-     * @returns The id of the User
+     * Gets the id of the User.
+     *
+     * @returns The User's id
      */
     getId(): string;
     /**
-     * @returns The name of the User
+     * Gets the name of the User.
+     *
+     * @returns The User's name
      */
     getName(): string;
     /**
-     * @returns The full name of the User
+     * Gets the full name of the User.
+     *
+     * @returns The User's full name
      */
     getFullName(): string;
     /**
-     * @returns The User connections
+     * Gets the [[Connections]] of the User.
+     *
+     * @returns The retrieved Connection objects
      */
     getConnections(): Promise<Connection[]>;
+    /**
+     * Gets a [[Connection]] of the User.
+     *
+     * @param id - The Connection's id
+     *
+     * @returns The retrieved Connection object
+     */
     getConnection(id: string): Promise<Connection>;
 }
 

package/lib/model/App.js

@@ -14,7 +14,7 @@ const app_service_1 = require("../service/app-service");
 /**
  * Defines an App on Bkper.
  *
- * Apps can be installed on Books by users.s
+ * Apps can be installed on Books by users.
  *
  * @public
  */

package/lib/model/Bkper.js

@@ -46,6 +46,7 @@ class Bkper {
      *
      * @param id - The universal book id - The same bookId param of URL you access at app.bkper.com
      *
+     * @returns The retrieved Book, for chaining
      */
     static getBook(id) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -55,6 +56,8 @@ class Bkper {
     }
     /**
      * Gets the current logged [[User]].
+     *
+     * @returns The retrieved User, for chaining
      */
     static getUser() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -64,11 +67,19 @@ class Bkper {
     }
     /**
      * Sets the API [[Config]] object.
+     *
+     * @param config - The Config object
      */
     static setConfig(config) {
         HttpApiRequest_1.HttpApiRequest.config = config;
     }
     /**
+     * Sets the API key to identify the agent.
+     *
+     * @param key - The API key
+     *
+     * @returns The defined [[App]] object
+     *
      * @deprecated Use `setConfig()` instead
      */
     static setApiKey(key) {
@@ -76,6 +87,8 @@ class Bkper {
         return new App_1.App();
     }
     /**
+     * Sets the provider of the valid OAuth2 access token
+     *
      * @deprecated Use `setConfig()` instead
      */
     static setOAuthTokenProvider(oauthTokenProvider) {

package/lib/model/Book.js

@@ -400,6 +400,11 @@ class Book {
     audit() {
         BookService.audit(this.getId());
     }
+    /**
+     * Gets the existing [[Integrations]] in the Book.
+     *
+     * @returns The existing Integration objects
+     */
     getIntegrations() {
         return __awaiter(this, void 0, void 0, function* () {
             const integrationsPlain = yield IntegrationService.listIntegrations(this.getId());
@@ -407,6 +412,13 @@ class Book {
             return integrations;
         });
     }
+    /**
+     * Creates a new [[Integration]] in the Book.
+     *
+     * @param integration - The Integration object or wrapped plain json
+     *
+     * @returns The created Integration object
+     */
     createIntegration(integration) {
         return __awaiter(this, void 0, void 0, function* () {
             if (integration instanceof Integration_1.Integration) {
@@ -418,6 +430,13 @@ class Book {
             return new Integration_1.Integration(integration);
         });
     }
+    /**
+     * Updates an existing [[Integration]] in the Book.
+     *
+     * @param integration - The Integration wrapped plain json
+     *
+     * @returns The updated Integration object
+     */
     updateIntegration(integration) {
         return __awaiter(this, void 0, void 0, function* () {
             if (integration instanceof Integration_1.Integration) {

package/lib/model/Connection.js

@@ -32,7 +32,7 @@ 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.
+ * This class defines a Connection from an [[User]] to an external service.
  *
  * @public
  */
@@ -41,40 +41,52 @@ class Connection {
         this.wrapped = json || {};
     }
     /**
-     * @returns The wrapped plain json object
+     * Gets the wrapped plain json object of the Connection.
+     *
+     * @returns The Connection wrapped plain json object
      */
     json() {
         return this.wrapped;
     }
     /**
-     * @returns The id of this User
+     * Gets the id of the Connection.
+     *
+     * @returns The Connection's id
      */
     getId() {
         return this.wrapped.id;
     }
     /**
-     * @returns The Connection agentId
+     * Gets the agentId of the Connection.
+     *
+     * @returns The Connection's agentId
      */
     getAgentId() {
         return this.wrapped.agentId;
     }
     /**
-     * Sets the Connection agentId
+     * Sets the Connection agentId.
      *
-     * @returns This Connection, for chainning.
+     * @param agentId - The Connection agentId
+     *
+     * @returns The Connection, for chainning
      */
     setAgentId(agentId) {
         this.wrapped.agentId = agentId;
         return this;
     }
     /**
-     * @returns The name of this Connection
+     * Gets the name of the Connection.
+     *
+     * @returns The Connection name
      */
     getName() {
         return this.wrapped.name;
     }
     /**
-     * @returns The email of the owner of this Connection
+     * Gets the email of the owner of the Connection.
+     *
+     * @returns The Connection owner's email
      */
     getEmail() {
         return this.wrapped.email;
@@ -82,63 +94,77 @@ class Connection {
     /**
      * Sets the name of the Connection.
      *
-     * @returns This Connection, for chainning.
+     * @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 this connection.
+     * Sets the universal unique identifier of the Connection.
+     *
+     * @param uuid - The universal unique identifier of the Connection
      *
-     * @returns This Connection, for chainning.
+     * @returns The Connection, for chainning
      */
     setUUID(uuid) {
         this.wrapped.uuid = uuid;
         return this;
     }
     /**
-     * @returns The name of universal unique identifier of the connection
+     * Gets the universal unique identifier of this Connection.
+     *
+     * @returns The Connection's universal unique identifier name
      */
     getUUID() {
         return this.wrapped.uuid;
     }
     /**
-     * @returns The connection type
+     * Gets the type of the Connection.
+     *
+     * @returns The Connection type
      */
     getType() {
         return this.wrapped.type;
     }
     /**
-     * Sets the connection type.
+     * Sets the Connection type.
      *
-     * @returns This Connection, for chainning.
+     * @param type - The Connection type
+     *
+     * @returns The Connection, for chainning
      */
     setType(type) {
         this.wrapped.type = type;
         return this;
     }
     /**
-     * Gets the custom properties stored in this Connection
+     * 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
+     * Sets the custom properties of the Connection.
      *
      * @param properties - Object with key/value pair properties
      *
-     * @returns This Connection, for chainning.
+     * @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
+     * 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++) {
@@ -155,6 +181,8 @@ class Connection {
      *
      * @param key - The property key
      * @param value - The property value
+     *
+     * @returns The Connection, for chaining
      */
     setProperty(key, value) {
         if (key == null || key.trim() == '') {
@@ -167,24 +195,26 @@ class Connection {
         return this;
     }
     /**
-     * Delete a custom property
+     * Deletes a custom property stored in the Connection.
      *
      * @param key - The property key
      *
-     * @returns This Connection, for chainning.
+     * @returns The Connection, for chainning
      */
     deleteProperty(key) {
         this.setProperty(key, null);
         return this;
     }
     /**
-     * Clean any token property
+     * 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();
@@ -199,6 +229,11 @@ class Connection {
         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());
@@ -207,7 +242,9 @@ class Connection {
         });
     }
     /**
-     * Perform create new connection.
+     * Performs create new Connection.
+     *
+     * @returns The Connection, for chaining
      */
     create() {
         return __awaiter(this, void 0, void 0, function* () {

package/lib/model/Integration.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Integration = void 0;
 /**
- * This class defines a Integration from an User to an external service.
+ * This class defines a Integration from an [[User]] to an external service.
  *
  * @public
  */
@@ -11,47 +11,62 @@ class Integration {
         this.wrapped = json;
     }
     /**
-     * @returns The wrapped plain json object
+     * Gets the wrapped plain json object of the Integration.
+     *
+     * @returns The Integration wrapped plain json object
      */
     json() {
         return this.wrapped;
     }
+    /**
+     * Gets the [[Book]] id of the Integration.
+     *
+     * @returns The Integration's Book id
+     */
     getBookId() {
         return this.wrapped.bookId;
     }
     /**
-     * @returns The id of this User
+     * Gets the id of the Integration.
+     *
+     * @returns This Integration's id
      */
     getId() {
         return this.wrapped.id;
     }
     /**
-     * @returns The name of this Integration
+     * Gets the name of the Integration.
+     *
+     * @returns The Integration's name
      */
     getName() {
         return this.wrapped.name;
     }
     /**
-     * Gets the custom properties stored in this Integration
+     * Gets the custom properties stored in the Integration.
+     *
+     * @returns Object with key/value pair properties
      */
     getProperties() {
         return this.wrapped.properties != null ? Object.assign({}, this.wrapped.properties) : {};
     }
     /**
-     * Sets the custom properties of the Integration
+     * Sets the custom properties of the Integration.
      *
      * @param properties - Object with key/value pair properties
      *
-     * @returns This Integration, for chainning.
+     * @returns The Integration, 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
+     * 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++) {
@@ -68,6 +83,8 @@ class Integration {
      *
      * @param key - The property key
      * @param value - The property value
+     *
+     * @returns The Integration, for chaining
      */
     setProperty(key, value) {
         if (key == null || key.trim() == '') {
@@ -80,11 +97,11 @@ class Integration {
         return this;
     }
     /**
-     * Delete a custom property
+     * Deletes a custom property stored in the Integration.
      *
      * @param key - The property key
      *
-     * @returns This Integration, for chainning.
+     * @returns The Integration, for chainning
      */
     deleteProperty(key) {
         this.setProperty(key, null);

package/lib/model/User.js

@@ -41,25 +41,33 @@ class User {
         this.wrapped = wrapped;
     }
     /**
-     * @returns The id of the User
+     * Gets the id of the User.
+     *
+     * @returns The User's id
      */
     getId() {
         return this.wrapped.id;
     }
     /**
-     * @returns The name of the User
+     * Gets the name of the User.
+     *
+     * @returns The User's name
      */
     getName() {
         return this.wrapped.name;
     }
     /**
-     * @returns The full name of the User
+     * Gets the full name of the User.
+     *
+     * @returns The User's full name
      */
     getFullName() {
         return this.wrapped.fullName;
     }
     /**
-     * @returns The User connections
+     * Gets the [[Connections]] of the User.
+     *
+     * @returns The retrieved Connection objects
      */
     getConnections() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -67,6 +75,13 @@ class User {
             return json.map(c => new Connection_1.Connection(c));
         });
     }
+    /**
+     * Gets a [[Connection]] of the User.
+     *
+     * @param id - The Connection's id
+     *
+     * @returns The retrieved Connection object
+     */
     getConnection(id) {
         return __awaiter(this, void 0, void 0, function* () {
             const json = yield ConnectionService.getConnection(id);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bkper",
-  "version": "2.6.2",
+  "version": "2.6.3",
   "description": "Node.js client for Bkper REST API",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -46,7 +46,7 @@
     "open": "^7.3.1"
   },
   "devDependencies": {
-    "@bkper/bkper-api-types": "^5.4.0",
+    "@bkper/bkper-api-types": "^5.5.0",
     "@microsoft/api-extractor": "^7.12.1",
     "@types/big.js": "^6.0.2",
     "@types/chai": "^4.2.14",