conductor-node 10.4.0 → 10.4.1

package/README.md

@@ -60,7 +60,7 @@ Creates a new integration-connection.
 ```ts
 const newQbdConnection = await conductor.integrationConnections.create({
   // The identifier of the third-party platform to integrate.
-  integrationKey: "quickbooks-desktop",
+  integrationSlug: "quickbooks-desktop",
   // Your end-user's unique ID in your product's database. Must be
   // distinct from your other connections for the same integration.
   endUserSourceId: "1234-abcd",
@@ -78,7 +78,7 @@ The response looks like the following:
   // ❗ Save this `id` to your database for executing requests to this
   // end-user's integration in the future.
   id: 'int_conn_1234abcd',
-  integrationKey: 'quickbooks-desktop',
+  integrationSlug: 'quickbooks-desktop',
   endUserSourceId: "1234-abcd",
   endUserEmail: 'danny@constructionco.com',
   endUserCompanyName: 'Construction Corp',

package/dist/package.json

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

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

@@ -1,5 +1,5 @@
 import type { EndUser } from "../resources/EndUsersResource";
-import type { IntegrationConnection, IntegrationKey } from "../resources/IntegrationConnectionsResource";
+import type { IntegrationConnection, IntegrationSlug } from "../resources/IntegrationConnectionsResource";
 import type { AxiosInstance } from "axios";
 export default abstract class BaseIntegration {
     protected readonly httpClient: AxiosInstance;
@@ -10,5 +10,5 @@ export default abstract class BaseIntegration {
      */
     protected sendRequestDeprecated(id: IntegrationConnection["id"], payload: Record<string, unknown>): Promise<object>;
     /** Not intended for public use. */
-    protected sendRequest(endUserId: EndUser["id"], integrationKey: IntegrationKey, payload: Record<string, unknown>): Promise<object>;
+    protected sendRequest(endUserId: EndUser["id"], integrationSlug: IntegrationSlug, payload: Record<string, unknown>): Promise<object>;
 }

package/dist/src/integrations/BaseIntegration.js

@@ -14,8 +14,8 @@ class BaseIntegration {
         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);
+    async sendRequest(endUserId, integrationSlug, payload) {
+        const { data } = await this.httpClient.post(`/end-users/${endUserId}/send-request/${integrationSlug}`, payload);
         return data;
     }
 }

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

@@ -1,5 +1,5 @@
 import BaseResource from "../resources/BaseResource";
-import type { IntegrationKey } from "../resources/IntegrationConnectionsResource";
+import type { IntegrationSlug } from "../resources/IntegrationConnectionsResource";
 export interface EndUser {
     /**
      * The unique identifier for the object.
@@ -52,9 +52,9 @@ export default class EndUsersResource extends BaseResource {
      * in your app's UI.
      *
      * @param endUserId The ID of the end-user to ping.
-     * @param integrationKey The integration key for the integration-connection 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"], integrationKey: IntegrationKey): Promise<EndUserPingOutput>;
+    ping(endUserId: EndUser["id"], integrationSlug: IntegrationSlug): Promise<EndUserPingOutput>;
 }

package/dist/src/resources/EndUsersResource.js

@@ -38,12 +38,12 @@ class EndUsersResource extends BaseResource_1.default {
      * in your app's UI.
      *
      * @param endUserId The ID of the end-user to ping.
-     * @param integrationKey The integration key for the integration-connection 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, integrationKey) {
-        const { data } = await this.httpClient.get(`${this.ROUTE}/${endUserId}/ping/${integrationKey}`);
+    async ping(endUserId, integrationSlug) {
+        const { data } = await this.httpClient.get(`${this.ROUTE}/${endUserId}/ping/${integrationSlug}`);
         return data;
     }
 }

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

@@ -1,7 +1,7 @@
 import BaseResource from "../resources/BaseResource";
 import IntegrationConnectionAuthSessionsResource from "../resources/IntegrationConnectionAuthSessionsResource";
 import type { AxiosInstance } from "axios";
-export type IntegrationKey = "quickbooks-desktop";
+export type IntegrationSlug = "quickbooks-desktop";
 export interface IntegrationConnection {
     /**
      * The unique identifier for the object.
@@ -15,7 +15,7 @@ export interface IntegrationConnection {
      * The identifier of the third-party platform to integrate (e.g.,
      * "quickbooks-desktop").
      */
-    integrationKey: IntegrationKey;
+    integrationSlug: IntegrationSlug;
     /**
      * The time at which the object was created.
      */
@@ -30,7 +30,7 @@ export interface IntegrationConnectionCreateOldInput {
      * The identifier of the third-party platform to integrate (e.g.,
      * "quickbooks-desktop").
      */
-    integrationKey: IntegrationKey;
+    integrationSlug: IntegrationSlug;
     /**
      * Your end-user's unique ID in your product's database. Must be distinct from
      * your other connections for the same integration.

package/package.json

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