bkper-js 1.2.0 → 1.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -6
- package/lib/index.d.ts +14 -1
- package/lib/model/Bkper.js +14 -1
- package/lib/service/http-api-request.js +0 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,9 +2,16 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/bkper)
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
bkper-js library is a simple and secure way to access the [Bkper REST API] on Node.js and modern browsers.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
It provides a set of classes and functions to interact with the Bkper API, including authentication, authorization, and data manipulation.
|
|
8
|
+
|
|
9
|
+
## Documentation
|
|
10
|
+
|
|
11
|
+
- [Developer Docs](https://bkper.com/docs)
|
|
12
|
+
- [API Reference](https://bkper.com/docs/bkper-js/)
|
|
13
|
+
|
|
14
|
+
## Installation
|
|
8
15
|
|
|
9
16
|
### Add the package:
|
|
10
17
|
|
|
@@ -20,8 +27,4 @@ or
|
|
|
20
27
|
bun add bkper-js
|
|
21
28
|
```
|
|
22
29
|
|
|
23
|
-
## Documentation
|
|
24
|
-
|
|
25
|
-
- [Developer Docs](https://bkper.com/docs)
|
|
26
|
-
- [API Reference](https://bkper.com/docs/bkper-js/)
|
|
27
30
|
|
package/lib/index.d.ts
CHANGED
|
@@ -369,7 +369,20 @@ export declare class App {
|
|
|
369
369
|
}
|
|
370
370
|
|
|
371
371
|
/**
|
|
372
|
-
* This is the main
|
|
372
|
+
* This is the main entry point of the [bkper-js](https://www.npmjs.com/package/bkper-js) library.
|
|
373
|
+
*
|
|
374
|
+
* You start by setting the API [[Config]] object.
|
|
375
|
+
*
|
|
376
|
+
* Example:
|
|
377
|
+
*
|
|
378
|
+
* ```javascript
|
|
379
|
+
* Bkper.setConfig({
|
|
380
|
+
* apiKeyProvider: () => process.env.BKPER_API_KEY,
|
|
381
|
+
* oauthTokenProvider: () => process.env.BKPER_OAUTH_TOKEN
|
|
382
|
+
* })
|
|
383
|
+
* ```
|
|
384
|
+
*
|
|
385
|
+
* Once the config is set, you can start using the library.
|
|
373
386
|
*
|
|
374
387
|
* @public
|
|
375
388
|
*/
|
package/lib/model/Bkper.js
CHANGED
|
@@ -14,7 +14,20 @@ import * as UserService from '../service/user-service.js';
|
|
|
14
14
|
import { HttpApiRequest } from '../service/http-api-request.js';
|
|
15
15
|
import { User } from "./User.js";
|
|
16
16
|
/**
|
|
17
|
-
* This is the main
|
|
17
|
+
* This is the main entry point of the [bkper-js](https://www.npmjs.com/package/bkper-js) library.
|
|
18
|
+
*
|
|
19
|
+
* You start by setting the API [[Config]] object.
|
|
20
|
+
*
|
|
21
|
+
* Example:
|
|
22
|
+
*
|
|
23
|
+
* ```javascript
|
|
24
|
+
* Bkper.setConfig({
|
|
25
|
+
* apiKeyProvider: () => process.env.BKPER_API_KEY,
|
|
26
|
+
* oauthTokenProvider: () => process.env.BKPER_OAUTH_TOKEN
|
|
27
|
+
* })
|
|
28
|
+
* ```
|
|
29
|
+
*
|
|
30
|
+
* Once the config is set, you can start using the library.
|
|
18
31
|
*
|
|
19
32
|
* @public
|
|
20
33
|
*/
|