conductor-node 11.6.15 → 11.7.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/package.json +2 -2
- package/dist/src/integrations/qbd/qbdTypes.d.ts +12 -5
- package/dist/src/resources/AuthSessionsResource.d.ts +5 -1
- package/dist/src/resources/EndUsersResource.d.ts +13 -9
- package/dist/src/resources/IntegrationConnectionsResource.d.ts +6 -6
- package/dist/src/resources/IntegrationConnectionsResource.js +0 -7
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
<img alt="Conductor logo" src="https://github.com/conductor-is/quickbooks-desktop-api/assets/170023/d67464b8-53a7-4d33-afeb-05a2efde1fa8" width="325">
|
|
7
7
|
</picture>
|
|
8
8
|
</a>
|
|
9
|
-
<h3>QuickBooks Desktop API for Node.js,
|
|
9
|
+
<h3>QuickBooks Desktop API for Node.js/TypeScript, Python, and REST</h3>
|
|
10
10
|
<a href="https://docs.conductor.is/overview/quickstart">Quickstart</a>
|
|
11
11
|
<span> • </span>
|
|
12
12
|
<a href="https://conductor.is">Website</a>
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
|
|
28
28
|
## What is Conductor?
|
|
29
29
|
|
|
30
|
-
Conductor is a real-time, fully-typed API for **QuickBooks Desktop** (sometimes called QuickBooks Enterprise), available via
|
|
30
|
+
Conductor is a real-time, fully-typed API for **QuickBooks Desktop** (sometimes called QuickBooks Enterprise), available via Node.js/TypeScript, Python, and REST. In just a few lines, get real-time access to fetch, create, or update [_any_ QuickBooks Desktop object type](https://docs.conductor.is/qbd/api#supported-object-types) and receive a fully-typed response. Check out [the documentation](https://docs.conductor.is) to get started.
|
|
31
31
|
|
|
32
32
|
Conductor, the company, is building a data integration platform for vertical SaaS companies, starting with QuickBooks Desktop. Our team has spent over a decade building companies, scaling vast software systems, and obsessing over quality.
|
|
33
33
|
|
package/dist/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "conductor-node",
|
|
3
|
-
"version": "11.
|
|
3
|
+
"version": "11.7.1",
|
|
4
4
|
"description": "QuickBooks Desktop API for Node.js and TypeScript",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"QuickBooks",
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"prepublishOnly": "pnpm jest"
|
|
37
37
|
},
|
|
38
38
|
"dependencies": {
|
|
39
|
-
"axios": "^1.7.
|
|
39
|
+
"axios": "^1.7.7"
|
|
40
40
|
},
|
|
41
41
|
"devDependencies": {
|
|
42
42
|
"axios-mock-adapter": "^1.22.0",
|
|
@@ -3830,9 +3830,10 @@ export interface DepositAddRs {
|
|
|
3830
3830
|
DepositRet?: DepositRet;
|
|
3831
3831
|
ErrorRecovery?: ErrorRecovery;
|
|
3832
3832
|
}
|
|
3833
|
-
export
|
|
3833
|
+
export type DepositLineAdd = {
|
|
3834
3834
|
/** For the `PaymentTxnID`, use either of these two values:A `TxnID` value exactly as it is returned by the `ReceivePaymentToDepositQuery` request, or A `TxnID` value exactly as it is returned in a `ReceivePaymentAdd` response. If you do not include a `PaymentTxnLineID` and include a `PaymentTxnID` for a transaction that includes payment lines, only the first payment line from that transaction will be deposited. */
|
|
3835
3835
|
PaymentTxnID: string;
|
|
3836
|
+
AccountRef?: never;
|
|
3836
3837
|
/** For the `PaymentTxnLineID`, use a `TxnLineID` value exactly as it has been returned by the `ReceivePaymentToDepositQuery` request. If you do not include a `PaymentTxnLineID` and include a `PaymentTxnID` for a transaction that includes payment lines, only the first payment line from that transaction will be deposited. */
|
|
3837
3838
|
PaymentTxnLineID?: string;
|
|
3838
3839
|
/** Depost line memo additional information. */
|
|
@@ -3841,10 +3842,12 @@ export interface DepositLineAdd {
|
|
|
3841
3842
|
OverrideCheckNumber?: string;
|
|
3842
3843
|
/** Deposit line class reference. */
|
|
3843
3844
|
OverrideClassRef?: OverrideClassRef;
|
|
3845
|
+
} | {
|
|
3844
3846
|
/** A QuickBooks “entity” is a customer, vendor, employee, or person on the QuickBooks “other names” list. Special cases to note: In a `BillToPayQuery` message, `EntityRef` refers to the vendor name.In `JournalCreditLine` and `JournalDebitLine` messages for A/R accounts, `EntityRef` must refer to a customer, or else the transaction will not be recorded. For A/P accounts the `EntityRef` must refer to a vendor, or else the transaction will not be recorded.In a `TimeTracking` message, `EntityRef` cannot refer to a customer, only to an employee, vendor, or person on the “other names” list whose time is being tracked. */
|
|
3845
3847
|
EntityRef?: EntityRef;
|
|
3846
3848
|
/** The Account list is the company file’s list of accounts. An `AccountRef` aggregate refers to one of these accounts. (If an `AccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored.) Special cases to note:In a Check message, `AccountRef` refers to the account from which the funds are being drawn for this check, for example, Checking or Savings.In an `ExpenseLineAdd` message, you must include `AccountRef` if the “Require accounts” check box is selected in the QuickBooks Accounting preferences. (It is selected by default.) In a `CreditCardCredit` message, `AccountRef` refers to the bank account or credit card account to which the credit is applied.In a `CreditCardCharge` message, `AccountRef` refers to the bank or credit card company to whom money is owed. How do you increase and decrease amounts in bank accounts? The following requests increase the balance in a bank account: Deposit Add `ReceivePaymentAdd` Journal Entry Add Sales `ReceiptAdd` The following requests decrease the balance in a bank account: `CheckAdd` Bill `PaymentCheckAdd` `JournalEntryAdd` */
|
|
3847
3849
|
AccountRef: AccountRef;
|
|
3850
|
+
PaymentTxnID?: never;
|
|
3848
3851
|
/** Additional information about this deposit line. */
|
|
3849
3852
|
Memo?: string;
|
|
3850
3853
|
/** The check number of a check that a QuickBooks user writes or receives from someone else. */
|
|
@@ -3855,12 +3858,14 @@ export interface DepositLineAdd {
|
|
|
3855
3858
|
ClassRef?: ClassRef;
|
|
3856
3859
|
/** A monetary amount. */
|
|
3857
3860
|
Amount?: string;
|
|
3858
|
-
}
|
|
3859
|
-
export
|
|
3861
|
+
};
|
|
3862
|
+
export type DepositLineMod = {
|
|
3860
3863
|
/** Identification number of the transaction line. (`TxnLineID` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `TxnLineID` is always returned as zero.) If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `TxnLineID` to -1. */
|
|
3861
3864
|
TxnLineID: string;
|
|
3865
|
+
} & ({
|
|
3862
3866
|
/** For the `PaymentTxnID`, use either of these two values:A `TxnID` value exactly as it is returned by the `ReceivePaymentToDepositQuery` request, or A `TxnID` value exactly as it is returned in a `ReceivePaymentAdd` response. If you do not include a `PaymentTxnLineID` and include a `PaymentTxnID` for a transaction that includes payment lines, only the first payment line from that transaction will be deposited. */
|
|
3863
|
-
PaymentTxnID
|
|
3867
|
+
PaymentTxnID?: string;
|
|
3868
|
+
AccountRef?: never;
|
|
3864
3869
|
/** For the `PaymentTxnLineID`, use a `TxnLineID` value exactly as it has been returned by the `ReceivePaymentToDepositQuery` request. If you do not include a `PaymentTxnLineID` and include a `PaymentTxnID` for a transaction that includes payment lines, only the first payment line from that transaction will be deposited. */
|
|
3865
3870
|
PaymentTxnLineID?: string;
|
|
3866
3871
|
/** Depost line memo additional information. */
|
|
@@ -3869,10 +3874,12 @@ export interface DepositLineMod {
|
|
|
3869
3874
|
OverrideCheckNumber?: string;
|
|
3870
3875
|
/** Deposit line class reference. */
|
|
3871
3876
|
OverrideClassRef?: OverrideClassRef;
|
|
3877
|
+
} | {
|
|
3872
3878
|
/** A QuickBooks “entity” is a customer, vendor, employee, or person on the QuickBooks “other names” list. Special cases to note: In a `BillToPayQuery` message, `EntityRef` refers to the vendor name.In `JournalCreditLine` and `JournalDebitLine` messages for A/R accounts, `EntityRef` must refer to a customer, or else the transaction will not be recorded. For A/P accounts the `EntityRef` must refer to a vendor, or else the transaction will not be recorded.In a `TimeTracking` message, `EntityRef` cannot refer to a customer, only to an employee, vendor, or person on the “other names” list whose time is being tracked. */
|
|
3873
3879
|
EntityRef?: EntityRef;
|
|
3874
3880
|
/** The Account list is the company file’s list of accounts. An `AccountRef` aggregate refers to one of these accounts. (If an `AccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored.) Special cases to note:In a Check message, `AccountRef` refers to the account from which the funds are being drawn for this check, for example, Checking or Savings.In an `ExpenseLineAdd` message, you must include `AccountRef` if the “Require accounts” check box is selected in the QuickBooks Accounting preferences. (It is selected by default.) In a `CreditCardCredit` message, `AccountRef` refers to the bank account or credit card account to which the credit is applied.In a `CreditCardCharge` message, `AccountRef` refers to the bank or credit card company to whom money is owed. How do you increase and decrease amounts in bank accounts? The following requests increase the balance in a bank account: Deposit Add `ReceivePaymentAdd` Journal Entry Add Sales `ReceiptAdd` The following requests decrease the balance in a bank account: `CheckAdd` Bill `PaymentCheckAdd` `JournalEntryAdd` */
|
|
3875
3881
|
AccountRef?: AccountRef;
|
|
3882
|
+
PaymentTxnID?: never;
|
|
3876
3883
|
/** Additional information about this deposit line. */
|
|
3877
3884
|
Memo?: string;
|
|
3878
3885
|
/** The check number of a check that a QuickBooks user writes or receives from someone else. */
|
|
@@ -3883,7 +3890,7 @@ export interface DepositLineMod {
|
|
|
3883
3890
|
ClassRef?: ClassRef;
|
|
3884
3891
|
/** A monetary amount. */
|
|
3885
3892
|
Amount?: string;
|
|
3886
|
-
}
|
|
3893
|
+
});
|
|
3887
3894
|
export interface DepositLineRet {
|
|
3888
3895
|
/** The type of transaction. */
|
|
3889
3896
|
TxnType?: TxnType;
|
|
@@ -8,6 +8,10 @@ export interface AuthSession {
|
|
|
8
8
|
* The object's type. This will always be "auth_session".
|
|
9
9
|
*/
|
|
10
10
|
readonly objectType: "auth_session";
|
|
11
|
+
/**
|
|
12
|
+
* The date and time when this object was created.
|
|
13
|
+
*/
|
|
14
|
+
readonly createdAt: string;
|
|
11
15
|
/**
|
|
12
16
|
* The ID of the EndUser for whom to create an IntegrationConnection.
|
|
13
17
|
*/
|
|
@@ -29,7 +33,7 @@ export interface AuthSession {
|
|
|
29
33
|
*/
|
|
30
34
|
readonly expiresAt: string;
|
|
31
35
|
/**
|
|
32
|
-
* The URL to which Conductor will redirect the
|
|
36
|
+
* The URL to which Conductor will redirect the user to return to your app
|
|
33
37
|
* after they complete the authentication flow. If `undefined`, their browser
|
|
34
38
|
* tab will close instead.
|
|
35
39
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import BaseResource from "../resources/BaseResource";
|
|
2
|
-
import type { IntegrationSlug } from "../resources/IntegrationConnectionsResource";
|
|
2
|
+
import type { IntegrationConnection, IntegrationSlug } from "../resources/IntegrationConnectionsResource";
|
|
3
3
|
import type { ApiListResponse } from "../resources/base";
|
|
4
4
|
export interface EndUser {
|
|
5
5
|
/**
|
|
@@ -13,24 +13,28 @@ export interface EndUser {
|
|
|
13
13
|
*/
|
|
14
14
|
readonly objectType: "end_user";
|
|
15
15
|
/**
|
|
16
|
-
*
|
|
16
|
+
* The time at which the object was created.
|
|
17
|
+
*/
|
|
18
|
+
readonly createdAt: string;
|
|
19
|
+
/**
|
|
20
|
+
* The EndUser's company name that will be shown elsewhere in Conductor.
|
|
17
21
|
*/
|
|
18
22
|
readonly companyName: string;
|
|
19
23
|
/**
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
24
|
+
* The EndUser's unique identifier from your system. Maps users between your
|
|
25
|
+
* database and Conductor. Must be unique for each user. If you have only one
|
|
26
|
+
* user, you may use any string value.
|
|
23
27
|
*/
|
|
24
28
|
readonly sourceId: string;
|
|
25
29
|
/**
|
|
26
|
-
*
|
|
27
|
-
*
|
|
30
|
+
* The EndUser's email address for identification purposes. Setting this field
|
|
31
|
+
* will not cause any emails to be sent.
|
|
28
32
|
*/
|
|
29
33
|
readonly email: string;
|
|
30
34
|
/**
|
|
31
|
-
* The
|
|
35
|
+
* The EndUser's IntegrationConnections.
|
|
32
36
|
*/
|
|
33
|
-
readonly
|
|
37
|
+
readonly integrationConnections: IntegrationConnection[];
|
|
34
38
|
}
|
|
35
39
|
export type EndUserCreateInput = Pick<EndUser, "companyName" | "email" | "sourceId">;
|
|
36
40
|
export interface EndUserPingOutput {
|
|
@@ -10,6 +10,10 @@ export interface IntegrationConnection {
|
|
|
10
10
|
* The object's type. This will always be "integration_connection".
|
|
11
11
|
*/
|
|
12
12
|
readonly objectType: "integration_connection";
|
|
13
|
+
/**
|
|
14
|
+
* The time at which the object was created.
|
|
15
|
+
*/
|
|
16
|
+
readonly createdAt: string;
|
|
13
17
|
/**
|
|
14
18
|
* The ID of the EndUser who owns this IntegrationConnection.
|
|
15
19
|
*/
|
|
@@ -20,9 +24,9 @@ export interface IntegrationConnection {
|
|
|
20
24
|
*/
|
|
21
25
|
readonly integrationSlug: IntegrationSlug;
|
|
22
26
|
/**
|
|
23
|
-
* The time
|
|
27
|
+
* The date and time of your last API request to this IntegrationConnection.
|
|
24
28
|
*/
|
|
25
|
-
readonly
|
|
29
|
+
readonly lastRequestAt: string | null;
|
|
26
30
|
}
|
|
27
31
|
export interface IntegrationConnectionPingOutput {
|
|
28
32
|
readonly duration: number;
|
|
@@ -33,8 +37,4 @@ export default class IntegrationConnectionsResource extends BaseResource {
|
|
|
33
37
|
* Returns a list of all IntegrationConnections of all your EndUsers.
|
|
34
38
|
*/
|
|
35
39
|
list(): Promise<ApiListResponse<IntegrationConnection>>;
|
|
36
|
-
/**
|
|
37
|
-
* Retrieves the specified IntegrationConnection.
|
|
38
|
-
*/
|
|
39
|
-
retrieve(id: IntegrationConnection["id"]): Promise<IntegrationConnection>;
|
|
40
40
|
}
|
|
@@ -13,12 +13,5 @@ class IntegrationConnectionsResource extends BaseResource_1.default {
|
|
|
13
13
|
const { data } = await this.httpClient.get(this.ROUTE);
|
|
14
14
|
return data;
|
|
15
15
|
}
|
|
16
|
-
/**
|
|
17
|
-
* Retrieves the specified IntegrationConnection.
|
|
18
|
-
*/
|
|
19
|
-
async retrieve(id) {
|
|
20
|
-
const { data } = await this.httpClient.get(`${this.ROUTE}/${id}`);
|
|
21
|
-
return data;
|
|
22
|
-
}
|
|
23
16
|
}
|
|
24
17
|
exports.default = IntegrationConnectionsResource;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "conductor-node",
|
|
3
|
-
"version": "11.
|
|
3
|
+
"version": "11.7.1",
|
|
4
4
|
"description": "QuickBooks Desktop API for Node.js and TypeScript",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"QuickBooks",
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"prepublishOnly": "pnpm jest"
|
|
37
37
|
},
|
|
38
38
|
"dependencies": {
|
|
39
|
-
"axios": "^1.7.
|
|
39
|
+
"axios": "^1.7.7"
|
|
40
40
|
},
|
|
41
41
|
"devDependencies": {
|
|
42
42
|
"axios-mock-adapter": "^1.22.0",
|