conductor-node 11.2.4 → 11.2.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Conductor Labs Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,14 +1,88 @@
-# [Conductor](https://conductor.is/) - The best QuickBooks Desktop integration on the planet
+<!-- markdownlint-disable MD033 MD041 -->
+<div align="center">
+  <h1><a href="https://conductor.is">Conductor</a></h1>
+  <h3>QuickBooks Desktop API for Node.js and TypeScript</h3>
+  <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>
+  <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>
+  <img src="https://img.shields.io/badge/coverage-100%25-brightgreen" alt="Code coverage">
+  <img src="https://img.shields.io/badge/CI-passing-brightgreen?logo=github" alt="CI status">
+  <a href="LICENSE"><img src="https://img.shields.io/npm/l/conductor-node.svg?color=blue&logo=github" alt="License" /></a>
+  <br />
+  <br />
+  <a href="https://docs.conductor.is/overview/quickstart">Quickstart</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://conductor.is">Website</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://docs.conductor.is">Docs</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://docs.conductor.is/qbd/examples">Examples</a>
+  <br />
+  <hr />
+</div>
 
-Execute _any_ read or write QuickBooks Desktop API through async TypeScript and receive a fully-typed response.
+## What is Conductor?
+
+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.
 
 <!-- markdownlint-disable MD033 -->
-<img src="https://user-images.githubusercontent.com/170023/213273732-83dd6881-0b36-4787-820b-bd55cdc8444f.jpg" alt="QuickBooks Desktop autocomplete" width="700"/>
+<div align="center">
+  <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>
+</div>
 
-## [Documentation 🚀](https://docs.conductor.is)
+## Documentation
 
 1. [Get Started](https://docs.conductor.is/overview/get-started)
 2. [Quickstart](https://docs.conductor.is/overview/quickstart)
 3. [QuickBooks Desktop APIs](https://docs.conductor.is/qbd/api)
 4. [API Reference](https://docs.conductor.is/apis)
 5. [Error Handling](https://docs.conductor.is/usage/error-handling)
+
+## Requirements
+
+1. A Conductor API key pair: one secret key, one publishable key. Please [email us](mailto:hello@conductor.is?subject=Conductor%20Beta) to join the private beta.
+2. Node.js v16 or later.
+
+## Installation
+
+```sh
+npm install conductor-node
+# or
+yarn add conductor-node
+```
+
+## Usage
+
+The full API documentation is available [here](https://docs.conductor.is) along with many code examples. The code below is a quickstart example.
+
+```ts
+import Conductor from "conductor-node";
+
+const conductor = new Conductor("{{YOUR_SECRET_KEY}}");
+
+async function main() {
+  // 1. Create a new EndUser.
+  const endUser = await conductor.endUsers.create({
+    sourceId: "{{UNIQUE_ID_FROM_YOUR_DB}}",
+    email: "{{END_USER_EMAIL}}",
+    name: "{{END_USER_NAME}}",
+  });
+  console.log("Save this EndUser ID to auth future requests:", endUser.id);
+
+  // 2. Create an AuthSession to establish the QuickBooks Desktop connection.
+  const authSession = await conductor.authSessions.create({
+    publishableKey: "{{YOUR_PUBLISHABLE_KEY}}",
+    endUserId: endUser.id,
+  });
+  console.log("Complete the QuickBooks Desktop auth:", authSession.authFlowUrl);
+
+  // 3. Get a list of all Customers from QuickBooks Desktop for this EndUser.
+  const qbdCustomers = await conductor.qbd.customers.query(endUser.id);
+  console.log("QuickBooks Desktop customers:", qbdCustomers);
+}
+
+main();
+```
+
+## More Documentation
+
+Please see our full documentation with guides and code examples [available here](https://docs.conductor.is).

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "conductor-node",
-    "version": "11.2.4",
+    "version": "11.2.6",
     "description": "Easily integrate the entire QuickBooks Desktop API using fully-typed async TypeScript",
     "keywords": [
         "QuickBooks Desktop",
@@ -14,6 +14,8 @@
         "QBD"
     ],
     "homepage": "https://conductor.is",
+    "repository": "github:conductor-is/conductor-node",
+    "author": "Conductor <support@conductor.is>",
     "license": "MIT",
     "type": "commonjs",
     "main": "dist/src/index.js",

package/dist/src/index.d.ts

@@ -1,6 +1,6 @@
 import Client from "./Client";
 /**
- * ESM usage:
+ * ESM support:
  *   import Conductor from "conductor-node";
  *   import { ConductorIntegrationError } from "conductor-node";
  *   import type { QbdTypes } from "conductor-node";

package/dist/src/index.js

@@ -34,7 +34,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const Client_1 = __importDefault(require("./Client"));
 const ErrorModule = __importStar(require("./utils/error"));
 /**
- * CommonJS usage:
+ * CommonJS support:
  *   const Conductor = require("conductor-node");
  *   const { ConductorIntegrationError } = require("conductor-node");
  */
@@ -44,7 +44,7 @@ if (module.exports !== undefined) {
     Object.assign(module.exports, ErrorModule);
 }
 /**
- * ESM usage:
+ * ESM support:
  *   import Conductor from "conductor-node";
  *   import { ConductorIntegrationError } from "conductor-node";
  *   import type { QbdTypes } from "conductor-node";

package/dist/src/resources/AuthSessionsResource.d.ts

@@ -19,7 +19,9 @@ export interface AuthSession {
      */
     readonly authFlowUrl: string;
     /**
-     * The time at which the AuthSession expires.
+     * The time at which the AuthSession expires. By default, this value is 30
+     * minutes from creation. You can extend this time by setting `linkExpiryMins`
+     * when creating the AuthSession.
      */
     readonly expiresAt: string;
     /**
@@ -40,8 +42,9 @@ export interface AuthSessionCreateInput {
      */
     readonly endUserId: string;
     /**
-     * The number of minutes after which the AuthSession will expire. If not
-     * provided, defaults to 30 minutes.
+     * The number of minutes after which the AuthSession will expire. Must be at
+     * least 15 minutes and no more than 7 days. If not provided, defaults to 30
+     * minutes.
      */
     readonly linkExpiryMins?: number;
     /**

package/dist/src/resources/EndUsersResource.d.ts

@@ -6,7 +6,7 @@ export interface EndUser {
      */
     readonly id: string;
     /**
-     * Your end-user's unique ID in *your* database. Must be distinct from your
+     * Your end-user's unique ID in _your_ database. Must be distinct from your
      * other end-users.
      */
     readonly sourceId: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "conductor-node",
-  "version": "11.2.4",
+  "version": "11.2.6",
   "description": "Easily integrate the entire QuickBooks Desktop API using fully-typed async TypeScript",
   "keywords": [
     "QuickBooks Desktop",
@@ -14,6 +14,8 @@
     "QBD"
   ],
   "homepage": "https://conductor.is",
+  "repository": "github:conductor-is/conductor-node",
+  "author": "Conductor <support@conductor.is>",
   "license": "MIT",
   "type": "commonjs",
   "main": "dist/src/index.js",