conductor-node 10.5.4 → 11.0.0

package/dist/package.json

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

package/dist/src/Client.js

@@ -22,7 +22,7 @@ class Client {
         (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);
+        this.integrationConnections = new IntegrationConnectionsResource_1.default(this.httpClient);
         this.qbd = new QbdIntegration_1.default(this.httpClient);
     }
     createHttpClient(apiKey, verbose, serverEnvironment) {

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

@@ -1,14 +1,9 @@
 import type { EndUser } from "../resources/EndUsersResource";
-import type { IntegrationConnection, IntegrationSlug } from "../resources/IntegrationConnectionsResource";
+import type { IntegrationSlug } from "../resources/IntegrationConnectionsResource";
 import type { AxiosInstance } from "axios";
 export default abstract class BaseIntegration {
     protected readonly httpClient: AxiosInstance;
     constructor(httpClient: AxiosInstance);
-    /**
-     * @deprecated Instead use `sendRequest` after migrating to the end-user
-     * model.
-     */
-    protected sendRequestDeprecated(id: IntegrationConnection["id"], payload: Record<string, unknown>): Promise<object>;
     /** Not intended for public use. */
     protected sendRequest(endUserId: EndUser["id"], integrationSlug: IntegrationSlug, payload: Record<string, unknown>): Promise<object>;
 }

package/dist/src/integrations/BaseIntegration.js

@@ -5,14 +5,6 @@ class BaseIntegration {
     constructor(httpClient) {
         this.httpClient = httpClient;
     }
-    /**
-     * @deprecated Instead use `sendRequest` after migrating to the 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, integrationSlug, payload) {
         const { data } = await this.httpClient.post(`/end-users/${endUserId}/send-request/${integrationSlug}`, payload);

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

@@ -2443,9 +2443,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 = (endUserId.startsWith("int_conn")
-            ? await this.sendRequestDeprecated(endUserId, params)
-            : 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/resources/EndUsersResource.d.ts

@@ -4,28 +4,28 @@ export interface EndUser {
     /**
      * The unique identifier for the object.
      */
-    id: string;
+    readonly id: string;
     /**
      * Your end-user's unique ID in your database. Must be distinct from your
      * other end-users.
      */
-    sourceId: string;
+    readonly sourceId: string;
     /**
      * Your end-user's email address.
      */
-    email: string;
+    readonly email: string;
     /**
      * Your end-user's company name that will be shown elsewhere in Conductor.
      */
-    name: string;
+    readonly name: string;
     /**
      * The time at which the object was created.
      */
-    createdAt: string;
+    readonly createdAt: string;
 }
 export type EndUserCreateInput = Pick<EndUser, "email" | "name" | "sourceId">;
 export interface EndUserPingOutput {
-    duration: number;
+    readonly duration: number;
 }
 export default class EndUsersResource extends BaseResource {
     protected readonly ROUTE = "/end-users";
@@ -51,10 +51,10 @@ export default class EndUsersResource extends BaseResource {
      * strongly recommend displaying the property `error.userFacingMessage` to
      * your end-user in your app's UI.
      *
-     * @param endUserId The ID of the end-user to ping.
+     * @param id The ID of the end-user to ping.
      * @param integrationSlug The integration identifier for the
      * integration-connection to ping.
      * @returns The ping result with the duration in milliseconds.
      */
-    ping(endUserId: EndUser["id"], integrationSlug: IntegrationSlug): Promise<EndUserPingOutput>;
+    ping(id: EndUser["id"], integrationSlug: IntegrationSlug): Promise<EndUserPingOutput>;
 }

package/dist/src/resources/EndUsersResource.js

@@ -37,13 +37,13 @@ class EndUsersResource extends BaseResource_1.default {
      * strongly recommend displaying the property `error.userFacingMessage` to
      * your end-user in your app's UI.
      *
-     * @param endUserId The ID of the end-user to ping.
+     * @param id The ID of the end-user to ping.
      * @param integrationSlug The integration identifier for the
      * integration-connection to ping.
      * @returns The ping result with the duration in milliseconds.
      */
-    async ping(endUserId, integrationSlug) {
-        const { data } = await this.httpClient.get(`${this.ROUTE}/${endUserId}/ping/${integrationSlug}`);
+    async ping(id, integrationSlug) {
+        const { data } = await this.httpClient.get(`${this.ROUTE}/${id}/ping/${integrationSlug}`);
         return data;
     }
 }

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

@@ -3,37 +3,37 @@ export interface IntegrationConnectionAuthSession {
     /**
      * The unique identifier for the object.
      */
-    id: string;
+    readonly id: string;
     /**
      * The ID of the end-user for whom to create an integration-connection in this
      * auth session.
      */
-    endUserId: string;
+    readonly endUserId: string;
     /**
      * The value that you will pass to the client to launch the authentication flow.
      */
-    clientSecret: string;
+    readonly clientSecret: string;
     /**
      * The URL to which to redirect the end-user to return to your app after
      * completing the authentication flow.
      */
-    returnUrl: string;
+    readonly returnUrl: string;
     /**
      * The time at which the auth-session expires.
      */
-    expiresAt: string;
+    readonly expiresAt: string;
 }
 export interface IntegrationConnectionAuthSessionCreateInput {
     /**
      * The ID of the end-user for whom to create an integration-connection in this
      * auth session.
      */
-    endUserId: string;
+    readonly endUserId: string;
     /**
      * The URL to which to redirect the end-user to return to your app after
      * completing the authentication flow.
      */
-    returnUrl: string;
+    readonly returnUrl: string;
 }
 export default class IntegrationConnectionAuthSessionsResource extends BaseResource {
     protected readonly ROUTE = "/integration-connection-auth-sessions";

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

@@ -1,71 +1,39 @@
-import type Client from "../Client";
 import BaseResource from "../resources/BaseResource";
 import IntegrationConnectionAuthSessionsResource from "../resources/IntegrationConnectionAuthSessionsResource";
+import type { AxiosInstance } from "axios";
 export type IntegrationSlug = "quickbooks-desktop";
 export interface IntegrationConnection {
     /**
      * The unique identifier for the object.
      */
-    id: string;
+    readonly id: string;
     /**
      * The ID of the end-user who owns this integration-connection.
      */
-    endUserId: string;
+    readonly endUserId: string;
     /**
      * The identifier of the third-party platform to integrate (e.g.,
      * "quickbooks-desktop").
      */
-    integrationSlug: IntegrationSlug;
+    readonly integrationSlug: IntegrationSlug;
     /**
      * The time at which the object was created.
      */
-    createdAt: string;
-}
-/**
- * @deprecated Use `conductor.endUsers.create()` instead.
- */
-export interface IntegrationConnectionCreateOldInput {
-    /**
-     * The identifier of the third-party platform to integrate (e.g.,
-     * "quickbooks-desktop").
-     */
-    integrationSlug: IntegrationSlug;
-    /**
-     * Your end-user's unique ID in your product's database. Must be distinct from
-     * your other connections for the same integration.
-     */
-    endUserSourceId: string;
-    /**
-     * Your end-user's email address.
-     */
-    endUserEmail: string;
-    /**
-     * Your end-user's company name that will be shown elsewhere in Conductor.
-     */
-    endUserCompanyName: string;
+    readonly createdAt: string;
 }
 export interface IntegrationConnectionPingOutput {
-    duration: number;
+    readonly duration: number;
 }
 export default class IntegrationConnectionsResource extends BaseResource {
     readonly authSessions: IntegrationConnectionAuthSessionsResource;
     protected readonly ROUTE = "/integration-connections";
-    private readonly client;
-    constructor(client: Client);
+    constructor(httpClient: AxiosInstance);
     /**
      * Returns a list of all integration-connections of all your end-users.
      */
     list(): Promise<IntegrationConnection[]>;
-    /**
-     * @deprecated Use `conductor.endUsers.create({ ... })` instead.
-     */
-    create(input: IntegrationConnectionCreateOldInput): Promise<IntegrationConnection>;
     /**
      * Retrieves the specified integration-connection.
      */
     retrieve(id: IntegrationConnection["id"]): Promise<IntegrationConnection>;
-    /**
-     * @deprecated Use `conductor.endUsers.ping(id, "quickbooks-desktop")` instead.
-     */
-    ping(id: IntegrationConnection["id"]): Promise<IntegrationConnectionPingOutput>;
 }

package/dist/src/resources/IntegrationConnectionsResource.js

@@ -8,11 +8,8 @@ const IntegrationConnectionAuthSessionsResource_1 = __importDefault(require("../
 class IntegrationConnectionsResource extends BaseResource_1.default {
     authSessions;
     ROUTE = "/integration-connections";
-    client;
-    constructor(client) {
-        // @ts-expect-error -- Temporary hack.
-        super(client.httpClient);
-        this.client = client;
+    constructor(httpClient) {
+        super(httpClient);
         this.authSessions = new IntegrationConnectionAuthSessionsResource_1.default(this.httpClient);
     }
     /**
@@ -22,22 +19,6 @@ class IntegrationConnectionsResource extends BaseResource_1.default {
         const { data } = await this.httpClient.get(this.ROUTE);
         return data;
     }
-    /**
-     * @deprecated Use `conductor.endUsers.create({ ... })` instead.
-     */
-    async create(input) {
-        const endUser = await this.client.endUsers.create({
-            sourceId: input.endUserSourceId,
-            email: input.endUserEmail,
-            name: input.endUserCompanyName,
-        });
-        return {
-            id: endUser.id,
-            endUserId: endUser.id,
-            integrationSlug: input.integrationSlug,
-            createdAt: endUser.createdAt,
-        };
-    }
     /**
      * Retrieves the specified integration-connection.
      */
@@ -45,15 +26,5 @@ class IntegrationConnectionsResource extends BaseResource_1.default {
         const { data } = await this.httpClient.get(`${this.ROUTE}/${id}`);
         return data;
     }
-    /**
-     * @deprecated Use `conductor.endUsers.ping(id, "quickbooks-desktop")` instead.
-     */
-    async ping(id) {
-        if (id.startsWith("int_conn")) {
-            const { data } = await this.httpClient.get(`${this.ROUTE}/${id}/ping`);
-            return data;
-        }
-        return this.client.endUsers.ping(id, "quickbooks-desktop");
-    }
 }
 exports.default = IntegrationConnectionsResource;

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

@@ -1,10 +1,6 @@
 export declare const DEFAULT_USER_FACING_MESSAGE = "An internal server error occurred. Please try again later.";
 export interface ConductorErrorOptions {
     readonly message: string;
-    /**
-     * @deprecated Use `userFacingMessage` instead.
-     */
-    readonly endUserMessage?: string;
     readonly userFacingMessage?: string;
     readonly type: string;
     readonly code: string;
@@ -19,10 +15,6 @@ export interface ConductorErrorOptions {
 export interface ConductorServerError {
     readonly error: {
         readonly message: string;
-        /**
-         * @deprecated Use `userFacingMessage` instead.
-         */
-        readonly endUserMessage?: string;
         readonly userFacingMessage: string;
         readonly type: string;
         readonly code: string;
@@ -41,10 +33,6 @@ export declare abstract class ConductorError extends Error {
      * The developer error message for your logs.
      */
     readonly message: string;
-    /**
-     * @deprecated Use `userFacingMessage` instead.
-     */
-    readonly endUserMessage: string;
     /**
      * The user-friendly error message, written specifically for displaying to
      * your end-users in your app's UI.

package/dist/src/utils/error.js

@@ -8,9 +8,8 @@ function isWellFormedConductorServerError(error) {
     return (error instanceof Object &&
         typeof error.error === "object" &&
         typeof error.error.message === "string" &&
-        (typeof error.error.endUserMessage === "string" ||
-            typeof error.error.userFacingMessage ===
-                "string") &&
+        typeof error.error.userFacingMessage ===
+            "string" &&
         typeof error.error.type === "string" &&
         typeof error.error.code === "string" &&
         typeof error.error.httpStatusCode === "number");
@@ -25,10 +24,6 @@ class ConductorError extends Error {
      * The developer error message for your logs.
      */
     message;
-    /**
-     * @deprecated Use `userFacingMessage` instead.
-     */
-    endUserMessage;
     /**
      * The user-friendly error message, written specifically for displaying to
      * your end-users in your app's UI.
@@ -103,14 +98,8 @@ class ConductorError extends Error {
         //    instantiated with the wrong options.
         this.type = this.constructor.name;
         this.message = options.message;
-        this.endUserMessage =
-            options.endUserMessage ??
-                options.userFacingMessage ??
-                exports.DEFAULT_USER_FACING_MESSAGE;
         this.userFacingMessage =
-            options.userFacingMessage ??
-                options.endUserMessage ??
-                exports.DEFAULT_USER_FACING_MESSAGE;
+            options.userFacingMessage ?? exports.DEFAULT_USER_FACING_MESSAGE;
         this.code = options.code;
         this.httpStatusCode = options.httpStatusCode;
         this.integrationCode = options.integrationCode;

package/package.json

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