conductor-node 6.2.4 → 6.2.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.
- package/README.md +8 -8
- package/dist/package.json +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@ Execute _any_ read or write [QuickBooks Desktop API](https://developer.intuit.co
|
|
|
5
5
|
## Requirements
|
|
6
6
|
|
|
7
7
|
1. A Conductor API key from Danny.
|
|
8
|
-
2. A running version of QuickBooks Desktop connected to Conductor. See our guide to
|
|
8
|
+
2. A running version of QuickBooks Desktop connected to Conductor. See our [guide to connecting QuickBooks Desktop to Conductor](https://www.notion.so/conductor-io/QBWC-Setup-Connect-QBD-to-Conductor-with-QB-Web-Connector-fb01b86f938e445ead178e3a1a994d78).
|
|
9
9
|
|
|
10
10
|
## Installation
|
|
11
11
|
|
|
@@ -44,7 +44,7 @@ const qbdConnections = await conductor.getIntegrationConnections();
|
|
|
44
44
|
|
|
45
45
|
### `qbd.*`
|
|
46
46
|
|
|
47
|
-
Execute any QuickBooks Desktop (QBD) API against a specific integration
|
|
47
|
+
Execute any QuickBooks Desktop (QBD) API against a specific integration-connection id. See the official [QuickBooks Desktop API Reference](https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop) for a full list of available APIs.
|
|
48
48
|
|
|
49
49
|
```ts
|
|
50
50
|
const newAccount = await conductor.qbd.account.add(qbdConnections[0].id, {
|
|
@@ -56,9 +56,9 @@ const newAccount = await conductor.qbd.account.add(qbdConnections[0].id, {
|
|
|
56
56
|
|
|
57
57
|
### `createIntegrationConnection(qbwcUsername: string)`
|
|
58
58
|
|
|
59
|
-
|
|
59
|
+
**🚧 Not yet enabled.**
|
|
60
60
|
|
|
61
|
-
Create a new integration
|
|
61
|
+
Create a new integration-connection.
|
|
62
62
|
|
|
63
63
|
```ts
|
|
64
64
|
const newQbdConnection = await conductor.createIntegrationConnection(
|
|
@@ -68,7 +68,7 @@ const newQbdConnection = await conductor.createIntegrationConnection(
|
|
|
68
68
|
|
|
69
69
|
### `getIntegrationConnectionById(id: string)`
|
|
70
70
|
|
|
71
|
-
Fetch a single integration
|
|
71
|
+
Fetch a single integration-connection by id.
|
|
72
72
|
|
|
73
73
|
```ts
|
|
74
74
|
const qbdConnection = await conductor.getIntegrationConnectionById(
|
|
@@ -76,9 +76,9 @@ const qbdConnection = await conductor.getIntegrationConnectionById(
|
|
|
76
76
|
);
|
|
77
77
|
```
|
|
78
78
|
|
|
79
|
-
### `isIntegrationConnectionActive(id: string, secondsSinceLastActive: number =
|
|
79
|
+
### `isIntegrationConnectionActive(id: string, secondsSinceLastActive: number = 60)`
|
|
80
80
|
|
|
81
|
-
Check if an integration
|
|
81
|
+
Check if an integration-connection is active within the last `secondsSinceLastActive` seconds (defaults to 60 seconds).
|
|
82
82
|
|
|
83
83
|
```ts
|
|
84
84
|
const isActive = await conductor.isIntegrationConnectionActive(
|
|
@@ -88,7 +88,7 @@ const isActive = await conductor.isIntegrationConnectionActive(
|
|
|
88
88
|
|
|
89
89
|
### `logConnectionStatuses()`
|
|
90
90
|
|
|
91
|
-
Log the time since Conductor has heard from each authorized integration
|
|
91
|
+
Log the time since Conductor has heard from each authorized integration-connection.
|
|
92
92
|
|
|
93
93
|
```ts
|
|
94
94
|
conductor.logConnectionStatuses(); // Outputs to logs
|
package/dist/package.json
CHANGED