conductor-node 2.0.3 → 2.0.5

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.
Files changed (2) hide show
  1. package/README.md +8 -14
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -15,24 +15,18 @@ yarn add conductor-node
15
15
 
16
16
  ## Usage
17
17
 
18
- The package must be configured with your account's secret key, which is available from Danny.
18
+ Instantiate `Conductor` with your account's secret key, which is available from Danny.
19
19
 
20
- Currently supports executing any [QuickBooks Desktop API](https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop) via JSON and receiving the response in JSON. In the future, Conductor will incorporate extensive typings for these APIs.
21
-
22
- To send a request to a specific QuickBooks Desktop user, you must also supply their user id.
20
+ The `Conductor` instance can execute _any_ read or write [QuickBooks Desktop API](https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop) through TypeScript and receive a fully-typed response. Each request requires the user-id of a specific QuickBooks Desktop user.
23
21
 
24
22
  ```ts
25
23
  import Conductor from "conductor-node";
26
24
  const conductor = new Conductor("sk_test_...");
27
25
 
28
- const mock_qbwc_user_id = "1";
29
- conductor.qbd.account
30
- .add(mock_qbwc_user_id, {
31
- Name: "Test Account",
32
- AccountType: "Bank",
33
- OpenBalance: "100",
34
- })
35
- .then((account) => {
36
- console.log("Response:", account);
37
- });
26
+ const mockQBWCUserId = "1";
27
+ const newAccount = await conductor.qbd.account.add(mockQBWCUserId, {
28
+ Name: "Test Account",
29
+ AccountType: "Bank",
30
+ OpenBalance: "100",
31
+ });
38
32
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "conductor-node",
3
- "version": "2.0.3",
3
+ "version": "2.0.5",
4
4
  "description": "Conductor API wrapper",
5
5
  "author": "Danny Nemer <hi@DannyNemer.com>",
6
6
  "license": "MIT",