conductor-node 11.1.0 → 11.2.1
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 +3 -22
- package/dist/package.json +1 -1
- package/dist/src/resources/AuthSessionsResource.d.ts +13 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,31 +3,12 @@
|
|
|
3
3
|
Execute _any_ read or write QuickBooks Desktop API through async TypeScript and receive a fully-typed response.
|
|
4
4
|
|
|
5
5
|
<!-- markdownlint-disable MD033 -->
|
|
6
|
-
<img src="https://
|
|
7
|
-
|
|
8
|
-
## Usage
|
|
9
|
-
|
|
10
|
-
```ts
|
|
11
|
-
import Conductor from "conductor-node";
|
|
12
|
-
|
|
13
|
-
// Instantiate `Conductor` with your account's secret key.
|
|
14
|
-
const conductor = new Conductor("{{YOUR_SECRET_KEY}}");
|
|
15
|
-
|
|
16
|
-
// Fetch all authorized EndUsers.
|
|
17
|
-
const endUsers = await conductor.endUsers.list();
|
|
18
|
-
|
|
19
|
-
// Execute any QBD API against your EndUser.
|
|
20
|
-
const newAccount = await conductor.qbd.account.add(endUsers[0].id, {
|
|
21
|
-
Name: "Test Account",
|
|
22
|
-
AccountType: "Bank",
|
|
23
|
-
OpenBalance: "100",
|
|
24
|
-
});
|
|
25
|
-
```
|
|
6
|
+
<img src="https://github-production-user-asset-6210df.s3.amazonaws.com/170023/280856180-d5162b2c-bacb-42a0-821d-1cb9a11475fe.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIWNJYAX4CSVEH53A%2F20231106%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20231106T215349Z&X-Amz-Expires=300&X-Amz-Signature=eff038985ac7b5546c2bbf0eb9d475b2ebc82cd1a521ad42cc0e9a0e9d95e911&X-Amz-SignedHeaders=host&actor_id=170023&key_id=0&repo_id=522709303" alt="QuickBooks Desktop autocomplete" width="600"/>
|
|
26
7
|
|
|
27
8
|
## Documentation
|
|
28
9
|
|
|
29
|
-
1. [
|
|
10
|
+
1. [Get Started](https://docs.conductor.is/overview/get-started)
|
|
30
11
|
2. [Quickstart](https://docs.conductor.is/overview/quickstart)
|
|
31
|
-
3. [QuickBooks Desktop APIs](https://docs.conductor.is/
|
|
12
|
+
3. [QuickBooks Desktop APIs](https://docs.conductor.is/qbd/api)
|
|
32
13
|
4. [API Reference](https://docs.conductor.is/apis)
|
|
33
14
|
5. [Error Handling](https://docs.conductor.is/usage/error-handling)
|
package/dist/package.json
CHANGED
|
@@ -5,8 +5,7 @@ export interface AuthSession {
|
|
|
5
5
|
*/
|
|
6
6
|
readonly id: string;
|
|
7
7
|
/**
|
|
8
|
-
* The ID of the EndUser for whom to create an IntegrationConnection
|
|
9
|
-
* AuthSession.
|
|
8
|
+
* The ID of the EndUser for whom to create an IntegrationConnection.
|
|
10
9
|
*/
|
|
11
10
|
readonly endUserId: string;
|
|
12
11
|
/**
|
|
@@ -23,6 +22,12 @@ export interface AuthSession {
|
|
|
23
22
|
* The time at which the AuthSession expires.
|
|
24
23
|
*/
|
|
25
24
|
readonly expiresAt: string;
|
|
25
|
+
/**
|
|
26
|
+
* The URL to which Conductor will redirect the end-user to return to your app
|
|
27
|
+
* after they complete the authentication flow. If `null`, their browser tab
|
|
28
|
+
* will close instead.
|
|
29
|
+
*/
|
|
30
|
+
readonly returnUrl: string | undefined;
|
|
26
31
|
}
|
|
27
32
|
export interface AuthSessionCreateInput {
|
|
28
33
|
/**
|
|
@@ -39,6 +44,12 @@ export interface AuthSessionCreateInput {
|
|
|
39
44
|
* provided, defaults to 30 minutes.
|
|
40
45
|
*/
|
|
41
46
|
readonly linkExpiryMins?: number;
|
|
47
|
+
/**
|
|
48
|
+
* The URL to which Conductor will redirect the end-user to return to your app
|
|
49
|
+
* after they complete the authentication flow. If not provided, their browser
|
|
50
|
+
* tab will close instead.
|
|
51
|
+
*/
|
|
52
|
+
readonly returnUrl?: string;
|
|
42
53
|
}
|
|
43
54
|
export default class AuthSessionsResource extends BaseResource {
|
|
44
55
|
protected readonly ROUTE = "/auth_sessions";
|