conductor-node 11.0.5 → 11.1.0

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="QuickBooks Desktop autocomplete" width="600"/>
+<img src="https://mintlify.s3-us-west-1.amazonaws.com/conductor/images/autocomplete.jpg" alt="QuickBooks Desktop autocomplete" width="600"/>
 
 ## Usage
 
@@ -26,7 +26,8 @@ const newAccount = await conductor.qbd.account.add(endUsers[0].id, {
 
 ## Documentation
 
-1. [Getting Started](https://docs.conductor.is/getting-started)
-2. [API Reference](https://docs.conductor.is/apis)
-3. [QuickBooks Desktop](https://docs.conductor.is/quickbooks-desktop)
-4. [Error Handling](https://docs.conductor.is/error-handling)
+1. [Getting Started](https://docs.conductor.is/overview/get-started)
+2. [Quickstart](https://docs.conductor.is/overview/quickstart)
+3. [QuickBooks Desktop APIs](https://docs.conductor.is/usage/quickbooks-desktop)
+4. [API Reference](https://docs.conductor.is/apis)
+5. [Error Handling](https://docs.conductor.is/usage/error-handling)

package/dist/package.json

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

package/dist/src/integrations/qbd/QbdIntegration.js

@@ -2728,7 +2728,7 @@ class QbdIntegration extends BaseIntegration_1.default {
         query: async (endUserId, params = {}) => this.sendRequestWrapper(endUserId, { WorkersCompCodeQueryRq: params }, "WorkersCompCodeQueryRs", "WorkersCompCodeRet"),
     };
     async sendRequestWrapper(endUserId, params, responseWrapperKey, responseBodyKey) {
-        const response = (await this.sendRequest(endUserId, "quickbooks-desktop", params));
+        const response = (await this.sendRequest(endUserId, "quickbooks_desktop", params));
         const responseBody = response[responseWrapperKey]?.[responseBodyKey];
         if (responseBody === undefined) {
             throw new error_1.ConductorIntegrationError({

package/dist/src/interceptors/errorHandling.js

@@ -46,7 +46,7 @@ function addErrorHandlingInterceptors(httpClient) {
         // Conductor API is offline) or an error ocurred when setting up the
         // request (e.g., no network connection).
         throw new error_1.ConductorConnectionError({
-            message: `An error occurred with our connection to Conductor: ${error.message}`,
+            message: `An error occurred with our connection to Conductor: ${error.message === "" ? error.code : error.message}`,
             code: error.code ?? "NETWORK_ERROR",
             httpStatusCode: error.status,
         });

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

@@ -10,41 +10,44 @@ export interface AuthSession {
      */
     readonly endUserId: string;
     /**
-     * The value that you will pass to the client to launch the authentication
+     * The secret used in `authFlowUrl` to securely access the authentication
      * flow.
      */
     readonly clientSecret: string;
     /**
-     * The time at which this AuthSession expires.
+     * The URL of the authentication flow that you will pass to your client for
+     * your end-user to set up their IntegrationConnection.
+     */
+    readonly authFlowUrl: string;
+    /**
+     * The time at which the AuthSession expires.
      */
     readonly expiresAt: string;
 }
 export interface AuthSessionCreateInput {
     /**
      * Your Conductor publishable key, which we use to create the session's
-     * `authUrl`.
+     * `authFlowUrl`.
      */
     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.
+     * The number of minutes after which the AuthSession will expire. If not
+     * provided, defaults to 30 minutes.
      */
-    readonly authUrl: string;
+    readonly linkExpiryMins?: number;
 }
 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.
+     * Creates an AuthSession. Pass the returned session’s `authFlowUrl` to the
+     * client for your end-user to launch the IntegrationConnection authentication
+     * flow.
      */
-    create(input: AuthSessionCreateInput): Promise<AuthSessionCreateOutput>;
+    create(input: AuthSessionCreateInput): Promise<AuthSession>;
     /**
      * Retrieves the specified AuthSession.
      */

package/dist/src/resources/AuthSessionsResource.js

@@ -7,9 +7,9 @@ const BaseResource_1 = __importDefault(require("../resources/BaseResource"));
 class AuthSessionsResource extends BaseResource_1.default {
     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.
+     * Creates an AuthSession. Pass the returned session’s `authFlowUrl` to the
+     * client for your end-user to launch the IntegrationConnection authentication
+     * flow.
      */
     async create(input) {
         const { data } = await this.httpClient.post(this.ROUTE, input);

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

@@ -56,7 +56,7 @@ export default class EndUsersResource extends BaseResource {
      *
      * @param id The ID of the end-user to ping.
      * @param integrationSlug The integration identifier for the end-user's
-     * connection you want to ping (e.g. "quickbooks-desktop").
+     * 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

@@ -39,7 +39,7 @@ class EndUsersResource extends BaseResource_1.default {
      *
      * @param id The ID of the end-user to ping.
      * @param integrationSlug The integration identifier for the end-user's
-     * connection you want to ping (e.g. "quickbooks-desktop").
+     * 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,5 +1,5 @@
 import BaseResource from "../resources/BaseResource";
-export type IntegrationSlug = "quickbooks-desktop";
+export type IntegrationSlug = "quickbooks_desktop";
 export interface IntegrationConnection {
     /**
      * The unique identifier for the object.
@@ -11,7 +11,7 @@ export interface IntegrationConnection {
     readonly endUserId: string;
     /**
      * The identifier of the third-party platform to integrate (e.g.,
-     * "quickbooks-desktop").
+     * "quickbooks_desktop").
      */
     readonly integrationSlug: IntegrationSlug;
     /**

package/package.json

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