conductor-node 10.1.0 → 10.3.0

package/README.md

@@ -92,9 +92,8 @@ The response looks like the following:
 Retrieves the specified integration-connection.
 
 ```ts
-const qbdConnection = await conductor.integrationConnections.retrieve(
-  qbdConnectionId,
-);
+const qbdConnection =
+  await conductor.integrationConnections.retrieve(qbdConnectionId);
 ```
 
 ### `integrationConnections.ping(id: string)`
@@ -179,9 +178,10 @@ The error object you receive will have one of the following error types:
 | Name                                  | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 | ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `ConductorIntegrationError`           | Raised when the third-party integration encounters an error while processing the end-user's request. This often results from an issue with the request or data handling that requires your attention to resolve.<br><br>E.g., a `ListID` you provided was not found in QuickBooks Desktop, or an accounting value you supplied did not adhere to the integration's accounting rules.<br><br>Refer to `error.integrationCode` for the error code returned by the integration, if available.                                                                                                                                                                                                               |
-| `ConductorIntegrationConnectionError` | 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 words, you cannot take action to fix these errors.<br><br>E.g., QuickBooks Web Connector (QBWC) failed to connect to QuickBooks Desktop on the end-user's computer.<br><br>Refer to `error.integrationCode` for the error code returned by the integration connector, if available.<br><br>❗ We recommend _not_ alerting your team for these errors because only the end-user can fix them. See [Global Error Handling](#global-error-handling) for an example of this. |
+| `ConductorIntegrationConnectionError` | 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 words, you cannot take action to fix these errors.<br><br>E.g., QuickBooks Web Connector (QBWC) failed to connect to QuickBooks Desktop on the end-user's computer.<br><br>Refer to `error.integrationCode` for the error code returned by the integration connector, if available.<br><br>❗ We recommend _not_ alerting your team for these errors because only the end-user can fix them. See [Global Error Handling](#global-error-handling) for an example of this. |
 | `ConductorInvalidRequestError`        | Raised when you make an API call with the wrong parameters, in the wrong state, or in an invalid way.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
 | `ConductorAuthenticationError`        | Raised when Conductor cannot authenticate you with the credentials you provided. E.g., an incorrect API key.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| `ConductorPermissionError`            | Raised when you attempt to access a resource that is not allowed.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 | `ConductorConnectionError`            | Raised when there was a network problem between the client (on your server) and Conductor's servers. E.g., a downed network or a bad TLS certificate.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
 | `ConductorInternalError`              | Raised when something went wrong on Conductor's end. (These are rare.)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "conductor-node",
-    "version": "10.1.0",
+    "version": "10.3.0",
     "description": "Easily integrate the entire QuickBooks Desktop API using fully-typed async TypeScript",
     "license": "MIT",
     "type": "commonjs",

package/dist/src/Client.d.ts

@@ -1,12 +1,16 @@
 import QbdIntegration from "./integrations/qbd/QbdIntegration";
+import EndUsersResource from "./resources/EndUsersResource";
 import IntegrationConnectionsResource from "./resources/IntegrationConnectionsResource";
 import { getServerUrlForEnvironment } from "./utils/http";
 export interface ClientOptions {
-    /** Logs each request, response, and error. */
+    /**
+     * 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;
     /** QuickBooks Desktop integration. */
     readonly qbd: QbdIntegration;

package/dist/src/Client.js

@@ -7,11 +7,13 @@ 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 EndUsersResource_1 = __importDefault(require("./resources/EndUsersResource"));
 const IntegrationConnectionsResource_1 = __importDefault(require("./resources/IntegrationConnectionsResource"));
 const checkForUpdates_1 = require("./utils/checkForUpdates");
 const http_1 = require("./utils/http");
 const axios_1 = __importDefault(require("axios"));
 class Client {
+    endUsers;
     integrationConnections;
     /** QuickBooks Desktop integration. */
     qbd;
@@ -19,6 +21,7 @@ class Client {
     constructor(apiKey, { verbose = false, serverEnvironment = "production" } = {}) {
         (0, checkForUpdates_1.checkForUpdates)();
         this.httpClient = this.createHttpClient(apiKey, verbose, serverEnvironment);
+        this.endUsers = new EndUsersResource_1.default(this.httpClient);
         this.integrationConnections = new IntegrationConnectionsResource_1.default(this.httpClient);
         this.qbd = new QbdIntegration_1.default(this.httpClient);
     }

package/dist/src/integrations/BaseIntegration.d.ts

@@ -3,6 +3,11 @@ import type { AxiosInstance } from "axios";
 export default abstract class BaseIntegration {
     protected readonly httpClient: AxiosInstance;
     constructor(httpClient: AxiosInstance);
+    /**
+     * @deprecated Use `sendRequestByEndUserIdAndIntegrationKey` after migrating
+     * to end-user model.
+     */
+    protected sendRequestDeprecated(id: IntegrationConnection["id"], payload: Record<string, unknown>): Promise<object>;
     /** Not intended for public use. */
-    protected sendRequest(id: IntegrationConnection["id"], payload: Record<string, unknown>): Promise<object>;
+    protected sendRequest(endUserId: IntegrationConnection["endUserId"], integrationKey: IntegrationConnection["integrationKey"], payload: Record<string, unknown>): Promise<object>;
 }

package/dist/src/integrations/BaseIntegration.js

@@ -5,10 +5,18 @@ class BaseIntegration {
     constructor(httpClient) {
         this.httpClient = httpClient;
     }
-    /** Not intended for public use. */
-    async sendRequest(id, payload) {
+    /**
+     * @deprecated Use `sendRequestByEndUserIdAndIntegrationKey` after migrating
+     * to end-user model.
+     */
+    async sendRequestDeprecated(id, payload) {
         const { data } = await this.httpClient.post(`/integration-connections/${id}/send-request`, payload);
         return data;
     }
+    /** Not intended for public use. */
+    async sendRequest(endUserId, integrationKey, payload) {
+        const { data } = await this.httpClient.post(`/end-users/${endUserId}/send-request/${integrationKey}`, payload);
+        return data;
+    }
 }
 exports.default = BaseIntegration;