conductor-node 11.0.4 → 11.0.5

package/README.md

@@ -3,7 +3,7 @@
 Execute _any_ read or write QuickBooks Desktop API through async TypeScript and receive a fully-typed response.
 
 <!-- markdownlint-disable MD033 -->
-<img src="https://user-images.githubusercontent.com/170023/213273732-83dd6881-0b36-4787-820b-bd55cdc8444f.jpg" alt="qbd" width="600"/>
+<img src="https://user-images.githubusercontent.com/170023/213273732-83dd6881-0b36-4787-820b-bd55cdc8444f.jpg" alt="QuickBooks Desktop autocomplete" width="600"/>
 
 ## Usage
 
@@ -11,12 +11,12 @@ Execute _any_ read or write QuickBooks Desktop API through async TypeScript and
 import Conductor from "conductor-node";
 
 // Instantiate `Conductor` with your account's secret key.
-const conductor = new Conductor("sk_test_...");
+const conductor = new Conductor("{{YOUR_SECRET_KEY}}");
 
-// Fetch all authorized end-users.
+// Fetch all authorized EndUsers.
 const endUsers = await conductor.endUsers.list();
 
-// Execute any QBD API against your end-user.
+// Execute any QBD API against your EndUser.
 const newAccount = await conductor.qbd.account.add(endUsers[0].id, {
   Name: "Test Account",
   AccountType: "Bank",

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "conductor-node",
-    "version": "11.0.4",
+    "version": "11.0.5",
     "description": "Easily integrate the entire QuickBooks Desktop API using fully-typed async TypeScript",
     "keywords": [
         "QuickBooks Desktop",

package/dist/src/Client.d.ts

@@ -1,17 +1,17 @@
 import QbdIntegration from "./integrations/qbd/QbdIntegration";
+import AuthSessionsResource from "./resources/AuthSessionsResource";
 import EndUsersResource from "./resources/EndUsersResource";
 import IntegrationConnectionsResource from "./resources/IntegrationConnectionsResource";
-import { getServerUrlForEnvironment } from "./utils/http";
 export interface ClientOptions {
     /**
      * Enables logging each request, response, and error.
      */
     readonly verbose?: boolean;
-    readonly serverEnvironment?: Parameters<typeof getServerUrlForEnvironment>[0];
 }
 export default class Client {
     readonly endUsers: EndUsersResource;
     readonly integrationConnections: IntegrationConnectionsResource;
+    readonly authSessions: AuthSessionsResource;
     /**
      * Executes any QuickBooks Desktop (QBD) API against the specified end-user.
      * See the official [QuickBooks Desktop API
@@ -20,7 +20,7 @@ export default class Client {
      */
     readonly qbd: QbdIntegration;
     private readonly httpClient;
-    constructor(apiKey: string, { verbose, serverEnvironment }?: ClientOptions);
+    constructor(apiKey: string, { verbose }?: ClientOptions);
     private createHttpClient;
     private createHeaders;
 }

package/dist/src/Client.js

@@ -7,6 +7,7 @@ const package_json_1 = __importDefault(require("./../package.json"));
 const QbdIntegration_1 = __importDefault(require("./integrations/qbd/QbdIntegration"));
 const errorHandling_1 = require("./interceptors/errorHandling");
 const logging_1 = require("./interceptors/logging");
+const AuthSessionsResource_1 = __importDefault(require("./resources/AuthSessionsResource"));
 const EndUsersResource_1 = __importDefault(require("./resources/EndUsersResource"));
 const IntegrationConnectionsResource_1 = __importDefault(require("./resources/IntegrationConnectionsResource"));
 const checkForUpdates_1 = require("./utils/checkForUpdates");
@@ -15,6 +16,7 @@ const axios_1 = __importDefault(require("axios"));
 class Client {
     endUsers;
     integrationConnections;
+    authSessions;
     /**
      * Executes any QuickBooks Desktop (QBD) API against the specified end-user.
      * See the official [QuickBooks Desktop API
@@ -23,16 +25,17 @@ class Client {
      */
     qbd;
     httpClient;
-    constructor(apiKey, { verbose = false, serverEnvironment = "production" } = {}) {
+    constructor(apiKey, { verbose = false } = {}) {
         (0, checkForUpdates_1.checkForUpdates)();
-        this.httpClient = this.createHttpClient(apiKey, verbose, serverEnvironment);
+        this.httpClient = this.createHttpClient(apiKey, verbose);
         this.endUsers = new EndUsersResource_1.default(this.httpClient);
         this.integrationConnections = new IntegrationConnectionsResource_1.default(this.httpClient);
+        this.authSessions = new AuthSessionsResource_1.default(this.httpClient);
         this.qbd = new QbdIntegration_1.default(this.httpClient);
     }
-    createHttpClient(apiKey, verbose, serverEnvironment) {
+    createHttpClient(apiKey, verbose) {
         const httpClient = axios_1.default.create({
-            baseURL: `${(0, http_1.getServerUrlForEnvironment)(serverEnvironment)}/v1`,
+            baseURL: `${(0, http_1.getApiServerUrlForEnvironment)()}/v1`,
             headers: this.createHeaders(apiKey),
             timeout: 0, // No timeout (default).
         });

package/dist/src/integrations/BaseIntegration.js

@@ -7,7 +7,7 @@ class BaseIntegration {
     }
     /** Not intended for public use. */
     async sendRequest(endUserId, integrationSlug, payload) {
-        const { data } = await this.httpClient.post(`/end-users/${endUserId}/send-request/${integrationSlug}`, payload);
+        const { data } = await this.httpClient.post(`/end_users/${endUserId}/request/${integrationSlug}`, payload);
         return data;
     }
 }

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

@@ -0,0 +1,52 @@
+import BaseResource from "../resources/BaseResource";
+export interface AuthSession {
+    /**
+     * The unique identifier for the object.
+     */
+    readonly id: string;
+    /**
+     * The ID of the EndUser for whom to create an IntegrationConnection in this
+     * AuthSession.
+     */
+    readonly endUserId: string;
+    /**
+     * The value that you will pass to the client to launch the authentication
+     * flow.
+     */
+    readonly clientSecret: string;
+    /**
+     * The time at which this AuthSession expires.
+     */
+    readonly expiresAt: string;
+}
+export interface AuthSessionCreateInput {
+    /**
+     * Your Conductor publishable key, which we use to create the session's
+     * `authUrl`.
+     */
+    readonly publishableKey: string;
+    /**
+     * The ID of the EndUser for whom to create the IntegrationConnection.
+     */
+    readonly endUserId: string;
+}
+export interface AuthSessionCreateOutput extends AuthSession {
+    /**
+     * The URL of the authentication flow for the specified EndUser to set up the
+     * IntegrationConnection.
+     */
+    readonly authUrl: string;
+}
+export default class AuthSessionsResource extends BaseResource {
+    protected readonly ROUTE = "/auth_sessions";
+    /**
+     * Creates an AuthSession for launching the client-side IntegrationConnection
+     * authentication flow. Use the returned session’s `clientSecret` to launch
+     * the auth flow using Conductor.js.
+     */
+    create(input: AuthSessionCreateInput): Promise<AuthSessionCreateOutput>;
+    /**
+     * Retrieves the specified AuthSession.
+     */
+    retrieve(id: AuthSession["id"]): Promise<AuthSession>;
+}

package/dist/src/resources/{IntegrationConnectionAuthSessionsResource.js → AuthSessionsResource.js}

@@ -4,23 +4,23 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const BaseResource_1 = __importDefault(require("../resources/BaseResource"));
-class IntegrationConnectionAuthSessionsResource extends BaseResource_1.default {
-    ROUTE = "/integration-connection-auth-sessions";
+class AuthSessionsResource extends BaseResource_1.default {
+    ROUTE = "/auth_sessions";
     /**
-     * Creates an auth session for launching the client-side
-     * integration-connection authentication flow. Use the returned session’s
-     * `clientSecret` to launch the auth flow using Conductor.js.
+     * Creates an AuthSession for launching the client-side IntegrationConnection
+     * authentication flow. Use the returned session’s `clientSecret` to launch
+     * the auth flow using Conductor.js.
      */
     async create(input) {
         const { data } = await this.httpClient.post(this.ROUTE, input);
         return data;
     }
     /**
-     * Retrieves the specified integration-connection-auth-session.
+     * Retrieves the specified AuthSession.
      */
     async retrieve(id) {
         const { data } = await this.httpClient.get(`${this.ROUTE}/${id}`);
         return data;
     }
 }
-exports.default = IntegrationConnectionAuthSessionsResource;
+exports.default = AuthSessionsResource;

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

@@ -31,21 +31,21 @@ export interface EndUserPingOutput {
     readonly duration: number;
 }
 export default class EndUsersResource extends BaseResource {
-    protected readonly ROUTE = "/end-users";
+    protected readonly ROUTE = "/end_users";
     /**
-     * Returns a list of your end-users.
+     * Returns a list of your EndUsers.
      */
     list(): Promise<EndUser[]>;
     /**
-     * Creates a new end-user.
+     * Creates a new EndUser.
      */
     create(input: EndUserCreateInput): Promise<EndUser>;
     /**
-     * Retrieves the specified end-user.
+     * Retrieves the specified EndUser.
      */
     retrieve(id: EndUser["id"]): Promise<EndUser>;
     /**
-     * Checks whether the specified integration-connection can connect and process
+     * Checks whether the specified IntegrationConnection can connect and process
      * requests end-to-end.
      *
      * If the connection fails, the error we encountered will be thrown as a
@@ -55,8 +55,8 @@ export default class EndUsersResource extends BaseResource {
      * your end-user in your app's UI.
      *
      * @param id The ID of the end-user to ping.
-     * @param integrationSlug The integration identifier for the
-     * integration-connection to ping.
+     * @param integrationSlug The integration identifier for the end-user's
+     * connection you want to ping (e.g. "quickbooks-desktop").
      * @returns The ping result with the duration in milliseconds.
      */
     ping(id: EndUser["id"], integrationSlug: IntegrationSlug): Promise<EndUserPingOutput>;

package/dist/src/resources/EndUsersResource.js

@@ -5,30 +5,30 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const BaseResource_1 = __importDefault(require("../resources/BaseResource"));
 class EndUsersResource extends BaseResource_1.default {
-    ROUTE = "/end-users";
+    ROUTE = "/end_users";
     /**
-     * Returns a list of your end-users.
+     * Returns a list of your EndUsers.
      */
     async list() {
         const { data } = await this.httpClient.get(this.ROUTE);
         return data;
     }
     /**
-     * Creates a new end-user.
+     * Creates a new EndUser.
      */
     async create(input) {
         const { data } = await this.httpClient.post(this.ROUTE, input);
         return data;
     }
     /**
-     * Retrieves the specified end-user.
+     * Retrieves the specified EndUser.
      */
     async retrieve(id) {
         const { data } = await this.httpClient.get(`${this.ROUTE}/${id}`);
         return data;
     }
     /**
-     * Checks whether the specified integration-connection can connect and process
+     * Checks whether the specified IntegrationConnection can connect and process
      * requests end-to-end.
      *
      * If the connection fails, the error we encountered will be thrown as a
@@ -38,8 +38,8 @@ class EndUsersResource extends BaseResource_1.default {
      * your end-user in your app's UI.
      *
      * @param id The ID of the end-user to ping.
-     * @param integrationSlug The integration identifier for the
-     * integration-connection to ping.
+     * @param integrationSlug The integration identifier for the end-user's
+     * connection you want to ping (e.g. "quickbooks-desktop").
      * @returns The ping result with the duration in milliseconds.
      */
     async ping(id, integrationSlug) {

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

@@ -1,6 +1,4 @@
 import BaseResource from "../resources/BaseResource";
-import IntegrationConnectionAuthSessionsResource from "../resources/IntegrationConnectionAuthSessionsResource";
-import type { AxiosInstance } from "axios";
 export type IntegrationSlug = "quickbooks-desktop";
 export interface IntegrationConnection {
     /**
@@ -8,7 +6,7 @@ export interface IntegrationConnection {
      */
     readonly id: string;
     /**
-     * The ID of the end-user who owns this integration-connection.
+     * The ID of the EndUser who owns this IntegrationConnection.
      */
     readonly endUserId: string;
     /**
@@ -25,15 +23,13 @@ export interface IntegrationConnectionPingOutput {
     readonly duration: number;
 }
 export default class IntegrationConnectionsResource extends BaseResource {
-    readonly authSessions: IntegrationConnectionAuthSessionsResource;
-    protected readonly ROUTE = "/integration-connections";
-    constructor(httpClient: AxiosInstance);
+    protected readonly ROUTE = "/integration_connections";
     /**
-     * Returns a list of all integration-connections of all your end-users.
+     * Returns a list of all IntegrationConnections of all your EndUsers.
      */
     list(): Promise<IntegrationConnection[]>;
     /**
-     * Retrieves the specified integration-connection.
+     * Retrieves the specified IntegrationConnection.
      */
     retrieve(id: IntegrationConnection["id"]): Promise<IntegrationConnection>;
 }

package/dist/src/resources/IntegrationConnectionsResource.js

@@ -4,23 +4,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const BaseResource_1 = __importDefault(require("../resources/BaseResource"));
-const IntegrationConnectionAuthSessionsResource_1 = __importDefault(require("../resources/IntegrationConnectionAuthSessionsResource"));
 class IntegrationConnectionsResource extends BaseResource_1.default {
-    authSessions;
-    ROUTE = "/integration-connections";
-    constructor(httpClient) {
-        super(httpClient);
-        this.authSessions = new IntegrationConnectionAuthSessionsResource_1.default(this.httpClient);
-    }
+    ROUTE = "/integration_connections";
     /**
-     * Returns a list of all integration-connections of all your end-users.
+     * Returns a list of all IntegrationConnections of all your EndUsers.
      */
     async list() {
         const { data } = await this.httpClient.get(this.ROUTE);
         return data;
     }
     /**
-     * Retrieves the specified integration-connection.
+     * Retrieves the specified IntegrationConnection.
      */
     async retrieve(id) {
         const { data } = await this.httpClient.get(`${this.ROUTE}/${id}`);

package/dist/src/utils/checkForUpdates.js

@@ -7,6 +7,9 @@ exports.checkForUpdates = void 0;
 const package_json_1 = __importDefault(require("../../package.json"));
 const node_child_process_1 = __importDefault(require("node:child_process"));
 function checkForUpdates() {
+    if (process.env.NODE_ENV === "test") {
+        return;
+    }
     // Exit early if npm is not installed.
     try {
         node_child_process_1.default.execSync("which npm");

package/dist/src/utils/error.d.ts

@@ -119,7 +119,7 @@ export declare class ConductorIntegrationError extends ConductorError {
 /**
  * Raised when a connection error occurs with the third-party integration on the
  * end-user's side. This typically indicates an issue with the end-user's
- * integration-connection or configuration, which they must resolve. In other
+ * IntegrationConnection or configuration, which they must resolve. In other
  * words, you cannot take action to fix these errors.
  *
  * E.g., QuickBooks Web Connector (QBWC) failed to connect to QuickBooks Desktop

package/dist/src/utils/error.js

@@ -139,7 +139,7 @@ exports.ConductorIntegrationError = ConductorIntegrationError;
 /**
  * Raised when a connection error occurs with the third-party integration on the
  * end-user's side. This typically indicates an issue with the end-user's
- * integration-connection or configuration, which they must resolve. In other
+ * IntegrationConnection or configuration, which they must resolve. In other
  * words, you cannot take action to fix these errors.
  *
  * E.g., QuickBooks Web Connector (QBWC) failed to connect to QuickBooks Desktop

package/dist/src/utils/http.d.ts

@@ -1 +1 @@
-export declare function getServerUrlForEnvironment(environment: "development" | "production" | "test"): string;
+export declare function getApiServerUrlForEnvironment(): string;

package/dist/src/utils/http.js

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getServerUrlForEnvironment = void 0;
-function getServerUrlForEnvironment(environment) {
-    if (environment === "production") {
-        return "https://api.conductor.is";
+exports.getApiServerUrlForEnvironment = void 0;
+function getApiServerUrlForEnvironment() {
+    // Do not check if `NODE_ENV` is "production" because that requires the
+    // developer to have set `NODE_ENV` to use `conductor` as expected.
+    if (["development", "test"].includes(process.env.NODE_ENV)) {
+        return "http://localhost:4000";
     }
-    return "http://localhost:4000";
+    return "https://api.conductor.is";
 }
-exports.getServerUrlForEnvironment = getServerUrlForEnvironment;
+exports.getApiServerUrlForEnvironment = getApiServerUrlForEnvironment;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "conductor-node",
-  "version": "11.0.4",
+  "version": "11.0.5",
   "description": "Easily integrate the entire QuickBooks Desktop API using fully-typed async TypeScript",
   "keywords": [
     "QuickBooks Desktop",

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

@@ -1,50 +0,0 @@
-import BaseResource from "../resources/BaseResource";
-export interface IntegrationConnectionAuthSession {
-    /**
-     * The unique identifier for the object.
-     */
-    readonly id: string;
-    /**
-     * The ID of the end-user for whom to create an integration-connection in this
-     * auth session.
-     */
-    readonly endUserId: string;
-    /**
-     * The value that you will pass to the client to launch the authentication flow.
-     */
-    readonly clientSecret: string;
-    /**
-     * The URL to which to redirect the end-user to return to your app after
-     * completing the authentication flow.
-     */
-    readonly returnUrl: string;
-    /**
-     * The time at which the auth-session expires.
-     */
-    readonly expiresAt: string;
-}
-export interface IntegrationConnectionAuthSessionCreateInput {
-    /**
-     * The ID of the end-user for whom to create an integration-connection in this
-     * auth session.
-     */
-    readonly endUserId: string;
-    /**
-     * The URL to which to redirect the end-user to return to your app after
-     * completing the authentication flow.
-     */
-    readonly returnUrl: string;
-}
-export default class IntegrationConnectionAuthSessionsResource extends BaseResource {
-    protected readonly ROUTE = "/integration-connection-auth-sessions";
-    /**
-     * Creates an auth session for launching the client-side
-     * integration-connection authentication flow. Use the returned session’s
-     * `clientSecret` to launch the auth flow using Conductor.js.
-     */
-    create(input: IntegrationConnectionAuthSessionCreateInput): Promise<IntegrationConnectionAuthSession>;
-    /**
-     * Retrieves the specified integration-connection-auth-session.
-     */
-    retrieve(id: IntegrationConnectionAuthSession["id"]): Promise<IntegrationConnectionAuthSession>;
-}