conductor-node 11.2.5 → 11.2.6
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/LICENSE +21 -0
- package/README.md +39 -11
- package/dist/package.json +1 -1
- package/package.json +1 -1
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023 Conductor Labs Inc.
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,9 +1,41 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
<!-- markdownlint-disable MD033 MD041 -->
|
|
2
|
+
<div align="center">
|
|
3
|
+
<h1><a href="https://conductor.is">Conductor</a></h1>
|
|
4
|
+
<h3>QuickBooks Desktop API for Node.js and TypeScript</h3>
|
|
5
|
+
<a href="https://npmjs.com/package/conductor-node"><img src="https://img.shields.io/npm/dm/conductor-node.svg?logo=npm" alt="NPM download count"></a>
|
|
6
|
+
<a href="https://npmjs.org/package/conductor-node"><img src="https://img.shields.io/npm/v/conductor-node.svg?logo=npm" alt="Package version"></a>
|
|
7
|
+
<img src="https://img.shields.io/badge/coverage-100%25-brightgreen" alt="Code coverage">
|
|
8
|
+
<img src="https://img.shields.io/badge/CI-passing-brightgreen?logo=github" alt="CI status">
|
|
9
|
+
<a href="LICENSE"><img src="https://img.shields.io/npm/l/conductor-node.svg?color=blue&logo=github" alt="License" /></a>
|
|
10
|
+
<br />
|
|
11
|
+
<br />
|
|
12
|
+
<a href="https://docs.conductor.is/overview/quickstart">Quickstart</a>
|
|
13
|
+
<span> • </span>
|
|
14
|
+
<a href="https://conductor.is">Website</a>
|
|
15
|
+
<span> • </span>
|
|
16
|
+
<a href="https://docs.conductor.is">Docs</a>
|
|
17
|
+
<span> • </span>
|
|
18
|
+
<a href="https://docs.conductor.is/qbd/examples">Examples</a>
|
|
19
|
+
<br />
|
|
20
|
+
<hr />
|
|
21
|
+
</div>
|
|
22
|
+
|
|
23
|
+
## What is Conductor?
|
|
24
|
+
|
|
25
|
+
Conductor is a TypeScript-first Node.js API for **QuickBooks Desktop** (also known as QuickBooks Enterprise). In just a few lines, get real-time access to fetch, create, or update [_any_ QuickBooks Desktop object type](https://docs.conductor.is/qbd/api#supported-object-types) and receive a fully-typed response. Check out [the documentation](https://docs.conductor.is) to get started.
|
|
4
26
|
|
|
5
27
|
<!-- markdownlint-disable MD033 -->
|
|
6
|
-
<
|
|
28
|
+
<div align="center">
|
|
29
|
+
<a href="https://docs.conductor.is"><img src="https://user-images.githubusercontent.com/170023/213273732-83dd6881-0b36-4787-820b-bd55cdc8444f.jpg" alt="QuickBooks Desktop autocomplete" width="600" /></a>
|
|
30
|
+
</div>
|
|
31
|
+
|
|
32
|
+
## Documentation
|
|
33
|
+
|
|
34
|
+
1. [Get Started](https://docs.conductor.is/overview/get-started)
|
|
35
|
+
2. [Quickstart](https://docs.conductor.is/overview/quickstart)
|
|
36
|
+
3. [QuickBooks Desktop APIs](https://docs.conductor.is/qbd/api)
|
|
37
|
+
4. [API Reference](https://docs.conductor.is/apis)
|
|
38
|
+
5. [Error Handling](https://docs.conductor.is/usage/error-handling)
|
|
7
39
|
|
|
8
40
|
## Requirements
|
|
9
41
|
|
|
@@ -20,7 +52,7 @@ yarn add conductor-node
|
|
|
20
52
|
|
|
21
53
|
## Usage
|
|
22
54
|
|
|
23
|
-
The full API
|
|
55
|
+
The full API documentation is available [here](https://docs.conductor.is) along with many code examples. The code below is a quickstart example.
|
|
24
56
|
|
|
25
57
|
```ts
|
|
26
58
|
import Conductor from "conductor-node";
|
|
@@ -51,10 +83,6 @@ async function main() {
|
|
|
51
83
|
main();
|
|
52
84
|
```
|
|
53
85
|
|
|
54
|
-
##
|
|
86
|
+
## More Documentation
|
|
55
87
|
|
|
56
|
-
|
|
57
|
-
2. [Quickstart](https://docs.conductor.is/overview/quickstart)
|
|
58
|
-
3. [QuickBooks Desktop APIs](https://docs.conductor.is/qbd/api)
|
|
59
|
-
4. [API Reference](https://docs.conductor.is/apis)
|
|
60
|
-
5. [Error Handling](https://docs.conductor.is/usage/error-handling)
|
|
88
|
+
Please see our full documentation with guides and code examples [available here](https://docs.conductor.is).
|
package/dist/package.json
CHANGED