conductor-node 7.1.1 → 7.1.3
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 +16 -13
- package/dist/package.json +1 -1
- package/dist/src/Client.d.ts +4 -3
- package/dist/src/Client.js +4 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -40,9 +40,14 @@ Create a new integration-connection.
|
|
|
40
40
|
|
|
41
41
|
```ts
|
|
42
42
|
const newQbdConnection = await conductor.createIntegrationConnection({
|
|
43
|
+
// The identifier of the third-party platform to integrate.
|
|
43
44
|
integrationKey: "quickbooks-desktop",
|
|
45
|
+
// Your end-user's email address for identification only. No emails
|
|
46
|
+
// will be sent. Must be distinct from your other connections for the
|
|
47
|
+
// same `integrationKey`.
|
|
44
48
|
endUserEmail: "danny@constructionco.com",
|
|
45
|
-
|
|
49
|
+
// Your end-user's name that will be shown elsewhere in Conductor.
|
|
50
|
+
endUserName: "Construction Corp",
|
|
46
51
|
});
|
|
47
52
|
```
|
|
48
53
|
|
|
@@ -50,22 +55,22 @@ The response includes the following:
|
|
|
50
55
|
|
|
51
56
|
```ts
|
|
52
57
|
{
|
|
53
|
-
// ❗
|
|
58
|
+
// ❗ Display this URL to your end-user: The URL for the QWC config file
|
|
54
59
|
// that your end-user must download and open on their computer to
|
|
55
60
|
// connect their QBD instance to Conductor.
|
|
56
|
-
qwcFileDownloadUrl: 'https://production.api.conductor.is/qwc/
|
|
57
|
-
// ❗
|
|
61
|
+
qwcFileDownloadUrl: 'https://production.api.conductor.is/qwc/{UUID}'
|
|
62
|
+
// ❗ Display this password/access-code to your end-user: The unique
|
|
58
63
|
// password that your end-user must enter into QuickBooks Web
|
|
59
64
|
// Connector after loading the config file. This value will never be
|
|
60
65
|
// shown again.
|
|
61
|
-
qbwcPassword: '
|
|
66
|
+
qbwcPassword: '{unique-password}',
|
|
62
67
|
integrationConnection: {
|
|
63
|
-
// ❗
|
|
68
|
+
// ❗ Save this `id` to your database for executing requests to
|
|
64
69
|
// this end-user's integration in the future.
|
|
65
|
-
id: '
|
|
70
|
+
id: '{UUID}',
|
|
66
71
|
integrationKey: 'quickbooks-desktop',
|
|
67
72
|
endUserEmail: 'danny@constructionco.com',
|
|
68
|
-
endUserName: 'Construction Corp
|
|
73
|
+
endUserName: 'Construction Corp',
|
|
69
74
|
lastHeartbeatAt: null
|
|
70
75
|
}
|
|
71
76
|
}
|
|
@@ -76,7 +81,7 @@ The response includes the following:
|
|
|
76
81
|
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.
|
|
77
82
|
|
|
78
83
|
```ts
|
|
79
|
-
const newAccount = await conductor.qbd.account.add(
|
|
84
|
+
const newAccount = await conductor.qbd.account.add(qbdConnectionId, {
|
|
80
85
|
Name: "Test Account",
|
|
81
86
|
AccountType: "Bank",
|
|
82
87
|
OpenBalance: "100",
|
|
@@ -97,7 +102,7 @@ Fetch a single integration-connection by id.
|
|
|
97
102
|
|
|
98
103
|
```ts
|
|
99
104
|
const qbdConnection = await conductor.getIntegrationConnectionById(
|
|
100
|
-
|
|
105
|
+
qbdConnectionId
|
|
101
106
|
);
|
|
102
107
|
```
|
|
103
108
|
|
|
@@ -106,7 +111,5 @@ const qbdConnection = await conductor.getIntegrationConnectionById(
|
|
|
106
111
|
Check if an integration-connection is active within the last `secondsSinceLastActive` seconds (defaults to 60 seconds).
|
|
107
112
|
|
|
108
113
|
```ts
|
|
109
|
-
const isActive = await conductor.isIntegrationConnectionActive(
|
|
110
|
-
qbdConnections[0].id
|
|
111
|
-
);
|
|
114
|
+
const isActive = await conductor.isIntegrationConnectionActive(qbdConnectionId);
|
|
112
115
|
```
|
package/dist/package.json
CHANGED
package/dist/src/Client.d.ts
CHANGED
|
@@ -23,9 +23,10 @@ export default class Client {
|
|
|
23
23
|
* @param input.integrationKey The identifier of the third-party platform to
|
|
24
24
|
* integrate.
|
|
25
25
|
* @param input.endUserEmail Your end-user's email address for identification
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
* @param input.endUserName Your end-user's name
|
|
26
|
+
* only. No emails will be sent. Must be distinct from your other connections
|
|
27
|
+
* for the same integration.
|
|
28
|
+
* @param input.endUserName Your end-user's name that will be shown elsewhere
|
|
29
|
+
* in Conductor.
|
|
29
30
|
* @returns The newly created integration connection.
|
|
30
31
|
*/
|
|
31
32
|
createIntegrationConnection(input: GraphqlCreateIntegrationConnectionInput & {
|
package/dist/src/Client.js
CHANGED
|
@@ -54,9 +54,10 @@ class Client {
|
|
|
54
54
|
* @param input.integrationKey The identifier of the third-party platform to
|
|
55
55
|
* integrate.
|
|
56
56
|
* @param input.endUserEmail Your end-user's email address for identification
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
* @param input.endUserName Your end-user's name
|
|
57
|
+
* only. No emails will be sent. Must be distinct from your other connections
|
|
58
|
+
* for the same integration.
|
|
59
|
+
* @param input.endUserName Your end-user's name that will be shown elsewhere
|
|
60
|
+
* in Conductor.
|
|
60
61
|
* @returns The newly created integration connection.
|
|
61
62
|
*/
|
|
62
63
|
async createIntegrationConnection(input) {
|
package/package.json
CHANGED