bkper 2.6.3 → 2.7.0

package/README.md

@@ -8,7 +8,7 @@ It also provide a **command line** utility to create and update [Bkper Apps and
 
 ## Instalation
 
-### 1) Add the package:
+### Add the package:
 
 ```
 npm i -S bkper
@@ -22,21 +22,33 @@ yarn add bkper
 
 - ```login```   - Logs the user in. Saves the client credentials to a ```~/.bkper-credentials.json``` file.
 - ```logout```  - Logs out the user by deleting client credentials.
-- ```app -c```  - Create a new App based on ```./bkperapp.json``` file
-- ```app -u```  - Update an existing App based on ```./bkperapp.json``` file 
+- ```app -c```  - Create a new App based on ```./bkperapp.json``` file.
+- ```app -u```  - Update an existing App based on ```./bkperapp.json``` file.
 
-### Environment Variables
+### Examples
+```
+npm bkper login
+```
+```
+yarn bkper login
+```
 
-The ```app``` command uses the following environment variables in order to perform App create/update operations:
+### Environment Variables
+The following environment variable is necessary in order to communicate with the Bkper REST API:
 
 ```
 BKPER_API_KEY=XXXX
+```
+
+The ```app``` command also uses the following variables in order to perform App create/update operations:
+
+```
 BKPER_CLIENT_SECRET=YYYY
 BKPER_USER_EMAILS="someone@gmail.com anotherone@altrostat.com"
 BKPER_DEVELOPER_EMAIL=somedeveloer@mycompany.com
 ```
 
-You can add a ```.env``` file at the root of your project with those variables and bkper will automatically load from it. 
+You can add a ```.env``` file at the root of your project with those variables and bkper will automatically load from it. Follow [these](https://bkper.com/docs/#rest-api-enabling) steps in order to configure a valid Bkper API key.
 
 > WARNING: Never upload variables to the source code repository.
 
@@ -45,6 +57,3 @@ You can add a ```.env``` file at the root of your project with those variables a
 - [Developer Docs](https://bkper.com/docs)
 - [API Reference](https://bkper.com/docs/bkper-node/)
 
-
-
-

package/lib/index.d.ts

@@ -1388,6 +1388,14 @@ export declare class Transaction {
      * @returns True if transaction is checked.
      */
     isChecked(): boolean;
+    /**
+      * Set the check state of the Transaction.
+      *
+      * @param checked - The check state.
+      *
+      * @returns This Transaction, for chainning.
+    */
+    setChecked(checked: boolean): Transaction;
     /**
      * @returns True if transaction is in trash.
      */

package/lib/model/Transaction.js

@@ -98,6 +98,17 @@ class Transaction {
     isChecked() {
         return this.wrapped.checked;
     }
+    /**
+      * Set the check state of the Transaction.
+      *
+      * @param checked - The check state.
+      *
+      * @returns This Transaction, for chainning.
+    */
+    setChecked(checked) {
+        this.wrapped.checked = checked;
+        return this;
+    }
     /**
      * @returns True if transaction is in trash.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bkper",
-  "version": "2.6.3",
+  "version": "2.7.0",
   "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.5.0",
+    "@bkper/bkper-api-types": "^5.9.0",
     "@microsoft/api-extractor": "^7.12.1",
     "@types/big.js": "^6.0.2",
     "@types/chai": "^4.2.14",