conductor-node 12.0.0-beta.1 → 12.0.0-beta.11

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.
Files changed (110) hide show
  1. package/CHANGELOG.md +108 -0
  2. package/README.md +32 -27
  3. package/index.d.mts +4 -4
  4. package/index.d.ts +4 -4
  5. package/index.d.ts.map +1 -1
  6. package/index.js.map +1 -1
  7. package/index.mjs.map +1 -1
  8. package/package.json +1 -1
  9. package/resources/auth-sessions.d.ts +11 -15
  10. package/resources/auth-sessions.d.ts.map +1 -1
  11. package/resources/auth-sessions.js +2 -8
  12. package/resources/auth-sessions.js.map +1 -1
  13. package/resources/auth-sessions.mjs +2 -8
  14. package/resources/auth-sessions.mjs.map +1 -1
  15. package/resources/end-users.d.ts +20 -32
  16. package/resources/end-users.d.ts.map +1 -1
  17. package/resources/end-users.js +4 -12
  18. package/resources/end-users.js.map +1 -1
  19. package/resources/end-users.mjs +4 -12
  20. package/resources/end-users.mjs.map +1 -1
  21. package/resources/index.d.ts +2 -2
  22. package/resources/index.d.ts.map +1 -1
  23. package/resources/index.js.map +1 -1
  24. package/resources/index.mjs.map +1 -1
  25. package/resources/qbd/bill-check-payments.d.ts +4 -4
  26. package/resources/qbd/bill-credit-card-payments.d.ts +4 -4
  27. package/resources/qbd/bills.d.ts +4 -4
  28. package/resources/qbd/checks.d.ts +4 -4
  29. package/resources/qbd/credit-card-charges.d.ts +4 -4
  30. package/resources/qbd/credit-card-credits.d.ts +4 -4
  31. package/resources/qbd/credit-memos.d.ts +4 -4
  32. package/resources/qbd/employees.d.ts +76 -34
  33. package/resources/qbd/employees.d.ts.map +1 -1
  34. package/resources/qbd/employees.js.map +1 -1
  35. package/resources/qbd/employees.mjs.map +1 -1
  36. package/resources/qbd/estimates.d.ts +4 -4
  37. package/resources/qbd/index.d.ts +3 -1
  38. package/resources/qbd/index.d.ts.map +1 -1
  39. package/resources/qbd/index.js +7 -1
  40. package/resources/qbd/index.js.map +1 -1
  41. package/resources/qbd/index.mjs +2 -0
  42. package/resources/qbd/index.mjs.map +1 -1
  43. package/resources/qbd/inventory-adjustments.d.ts +4 -4
  44. package/resources/qbd/inventory-assembly-items.d.ts +1 -1
  45. package/resources/qbd/inventory-assembly-items.d.ts.map +1 -1
  46. package/resources/qbd/inventory-items.d.ts +1 -1
  47. package/resources/qbd/inventory-items.d.ts.map +1 -1
  48. package/resources/qbd/invoices.d.ts +4 -4
  49. package/resources/qbd/journal-entries.d.ts +4 -4
  50. package/resources/qbd/purchase-orders.d.ts +4 -4
  51. package/resources/qbd/qbd.d.ts +36 -0
  52. package/resources/qbd/qbd.d.ts.map +1 -1
  53. package/resources/qbd/qbd.js +25 -0
  54. package/resources/qbd/qbd.js.map +1 -1
  55. package/resources/qbd/qbd.mjs +25 -0
  56. package/resources/qbd/qbd.mjs.map +1 -1
  57. package/resources/qbd/receive-payments.d.ts +4 -4
  58. package/resources/qbd/sales-orders.d.ts +4 -4
  59. package/resources/qbd/sales-receipts.d.ts +4 -4
  60. package/resources/qbd/time-tracking-activities.d.ts +485 -0
  61. package/resources/qbd/time-tracking-activities.d.ts.map +1 -0
  62. package/resources/qbd/time-tracking-activities.js +66 -0
  63. package/resources/qbd/time-tracking-activities.js.map +1 -0
  64. package/resources/qbd/time-tracking-activities.mjs +61 -0
  65. package/resources/qbd/time-tracking-activities.mjs.map +1 -0
  66. package/resources/qbd/transactions.d.ts +312 -0
  67. package/resources/qbd/transactions.d.ts.map +1 -0
  68. package/resources/qbd/transactions.js +41 -0
  69. package/resources/qbd/transactions.js.map +1 -0
  70. package/resources/qbd/transactions.mjs +36 -0
  71. package/resources/qbd/transactions.mjs.map +1 -0
  72. package/resources/qbd/transfers.d.ts +4 -4
  73. package/resources/qbd/vendor-credits.d.ts +4 -4
  74. package/resources/qbd/vendors.d.ts +4 -4
  75. package/src/index.ts +6 -4
  76. package/src/resources/auth-sessions.ts +11 -18
  77. package/src/resources/end-users.ts +19 -40
  78. package/src/resources/index.ts +1 -2
  79. package/src/resources/qbd/bill-check-payments.ts +4 -4
  80. package/src/resources/qbd/bill-credit-card-payments.ts +4 -4
  81. package/src/resources/qbd/bills.ts +4 -4
  82. package/src/resources/qbd/checks.ts +4 -4
  83. package/src/resources/qbd/credit-card-charges.ts +4 -4
  84. package/src/resources/qbd/credit-card-credits.ts +4 -4
  85. package/src/resources/qbd/credit-memos.ts +4 -4
  86. package/src/resources/qbd/employees.ts +76 -34
  87. package/src/resources/qbd/estimates.ts +4 -4
  88. package/src/resources/qbd/index.ts +19 -1
  89. package/src/resources/qbd/inventory-adjustments.ts +4 -4
  90. package/src/resources/qbd/inventory-assembly-items.ts +1 -1
  91. package/src/resources/qbd/inventory-items.ts +1 -1
  92. package/src/resources/qbd/invoices.ts +4 -4
  93. package/src/resources/qbd/journal-entries.ts +4 -4
  94. package/src/resources/qbd/purchase-orders.ts +4 -4
  95. package/src/resources/qbd/qbd.ts +92 -0
  96. package/src/resources/qbd/receive-payments.ts +4 -4
  97. package/src/resources/qbd/sales-orders.ts +4 -4
  98. package/src/resources/qbd/sales-receipts.ts +4 -4
  99. package/src/resources/qbd/time-tracking-activities.ts +615 -0
  100. package/src/resources/qbd/transactions.ts +441 -0
  101. package/src/resources/qbd/transfers.ts +4 -4
  102. package/src/resources/qbd/vendor-credits.ts +4 -4
  103. package/src/resources/qbd/vendors.ts +4 -4
  104. package/src/version.ts +1 -1
  105. package/version.d.ts +1 -1
  106. package/version.d.ts.map +1 -1
  107. package/version.js +1 -1
  108. package/version.js.map +1 -1
  109. package/version.mjs +1 -1
  110. package/version.mjs.map +1 -1
@@ -0,0 +1,312 @@
1
+ import { APIResource } from "../../resource.js";
2
+ import * as Core from "../../core.js";
3
+ import { CursorPage, type CursorPageParams } from "../../pagination.js";
4
+ export declare class Transactions extends APIResource {
5
+ /**
6
+ * Retrieves a transaction by ID.
7
+ */
8
+ retrieve(id: string, params: TransactionRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<Transaction>;
9
+ /**
10
+ * Searches across all transaction types. Unlike transaction-specific queries, this
11
+ * endpoint only returns fields common to all transaction types, such as ID, type,
12
+ * dates, account, and reference numbers. For more details specific to that
13
+ * transaction type, make a subsequent call to the relevant transaction-specific
14
+ * endpoint (such as invoices, bills, etc.)
15
+ *
16
+ * NOTE: This endpoint does not support time tracking activities.
17
+ */
18
+ list(params: TransactionListParams, options?: Core.RequestOptions): Core.PagePromise<TransactionsCursorPage, Transaction>;
19
+ }
20
+ export declare class TransactionsCursorPage extends CursorPage<Transaction> {
21
+ }
22
+ export interface Transaction {
23
+ /**
24
+ * The account associated with this transaction.
25
+ */
26
+ account: Transaction.Account | null;
27
+ /**
28
+ * The monetary amount of this transaction, represented as a decimal string.
29
+ */
30
+ amount: string | null;
31
+ /**
32
+ * The monetary amount of this transaction converted to the home currency of the
33
+ * QuickBooks company file. Represented as a decimal string.
34
+ */
35
+ amountInHomeCurrency: string | null;
36
+ /**
37
+ * The date and time when this transaction was created, in ISO 8601 format
38
+ * (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone
39
+ * in QuickBooks.
40
+ */
41
+ createdAt: string;
42
+ /**
43
+ * The transaction's currency. For built-in currencies, the name and code are
44
+ * standard international values. For user-defined currencies, all values are
45
+ * editable.
46
+ */
47
+ currency: Transaction.Currency | null;
48
+ /**
49
+ * The customer, vendor, employee, or person on QuickBooks's "Other Names" list
50
+ * associated with this transaction.
51
+ */
52
+ entity: Transaction.Entity | null;
53
+ /**
54
+ * The market exchange rate between this transaction's currency and the home
55
+ * currency in QuickBooks at the time of this transaction. Represented as a decimal
56
+ * value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).
57
+ */
58
+ exchangeRate: number | null;
59
+ /**
60
+ * A memo or note for this transaction.
61
+ */
62
+ memo: string | null;
63
+ /**
64
+ * The case-sensitive user-defined reference number for this transaction, which can
65
+ * be used to identify the transaction in QuickBooks. This value is not required to
66
+ * be unique and can be arbitrarily changed by the QuickBooks user.
67
+ */
68
+ refNumber: string | null;
69
+ /**
70
+ * The date of this transaction, in ISO 8601 format (YYYY-MM-DD).
71
+ */
72
+ transactionDate: string;
73
+ /**
74
+ * The QuickBooks-assigned unique identifier of this transaction. **NOTE:** If
75
+ * `null`, this is a transaction line object and `transactionLineId` will be
76
+ * defined instead.
77
+ */
78
+ transactionId: string | null;
79
+ /**
80
+ * The QuickBooks-assigned unique identifier of this transaction line. **NOTE:** If
81
+ * `null`, this is a transaction object and `transactionId` will be defined
82
+ * instead.
83
+ */
84
+ transactionLineId: string | null;
85
+ /**
86
+ * The type of transaction.
87
+ */
88
+ transactionType: 'ar_refund_credit_card' | 'bill' | 'bill_payment_check' | 'bill_payment_credit_card' | 'build_assembly' | 'charge' | 'check' | 'credit_card_charge' | 'credit_card_credit' | 'credit_memo' | 'deposit' | 'estimate' | 'inventory_adjustment' | 'invoice' | 'item_receipt' | 'journal_entry' | 'liability_adjustment' | 'paycheck' | 'payroll_liability_check' | 'purchase_order' | 'receive_payment' | 'sales_order' | 'sales_receipt' | 'sales_tax_payment_check' | 'transfer' | 'vendor_credit' | 'ytd_adjustment';
89
+ /**
90
+ * The date and time when this transaction was last updated, in ISO 8601 format
91
+ * (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone
92
+ * in QuickBooks.
93
+ */
94
+ updatedAt: string;
95
+ }
96
+ export declare namespace Transaction {
97
+ /**
98
+ * The account associated with this transaction.
99
+ */
100
+ interface Account {
101
+ /**
102
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
103
+ * across all objects of the same type, but not across different QuickBooks object
104
+ * types.
105
+ */
106
+ id: string | null;
107
+ /**
108
+ * The fully-qualified unique name for this object, formed by combining the names
109
+ * of its parent objects with its own `name`, separated by colons. Not
110
+ * case-sensitive.
111
+ */
112
+ fullName: string | null;
113
+ }
114
+ /**
115
+ * The transaction's currency. For built-in currencies, the name and code are
116
+ * standard international values. For user-defined currencies, all values are
117
+ * editable.
118
+ */
119
+ interface Currency {
120
+ /**
121
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
122
+ * across all objects of the same type, but not across different QuickBooks object
123
+ * types.
124
+ */
125
+ id: string | null;
126
+ /**
127
+ * The fully-qualified unique name for this object, formed by combining the names
128
+ * of its parent objects with its own `name`, separated by colons. Not
129
+ * case-sensitive.
130
+ */
131
+ fullName: string | null;
132
+ }
133
+ /**
134
+ * The customer, vendor, employee, or person on QuickBooks's "Other Names" list
135
+ * associated with this transaction.
136
+ */
137
+ interface Entity {
138
+ /**
139
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
140
+ * across all objects of the same type, but not across different QuickBooks object
141
+ * types.
142
+ */
143
+ id: string | null;
144
+ /**
145
+ * The fully-qualified unique name for this object, formed by combining the names
146
+ * of its parent objects with its own `name`, separated by colons. Not
147
+ * case-sensitive.
148
+ */
149
+ fullName: string | null;
150
+ }
151
+ }
152
+ export interface TransactionRetrieveParams {
153
+ /**
154
+ * The ID of the EndUser to receive this request (e.g.,
155
+ * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
156
+ */
157
+ conductorEndUserId: string;
158
+ }
159
+ export interface TransactionListParams extends CursorPageParams {
160
+ /**
161
+ * Header param: The ID of the EndUser to receive this request (e.g.,
162
+ * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
163
+ */
164
+ conductorEndUserId: string;
165
+ /**
166
+ * Query param: Filter for transactions associated with these accounts.
167
+ *
168
+ * **NOTE**: To filter on transaction lines, you must specify the
169
+ * `transactionDetailLevel` parameter as `all` or `transaction_lines_only`.
170
+ */
171
+ accountIds?: Array<string>;
172
+ /**
173
+ * Query param: Filter for transactions of these classes. A class is a way
174
+ * end-users can categorize transactions in QuickBooks.
175
+ *
176
+ * **NOTE**: To filter on transaction lines, you must specify the
177
+ * `transactionDetailLevel` parameter as `all` or `transaction_lines_only`.
178
+ */
179
+ classIds?: Array<string>;
180
+ /**
181
+ * Query param: Filter for transactions in these currencies.
182
+ */
183
+ currencyIds?: Array<string>;
184
+ /**
185
+ * Query param: Specify whether to return all matching transaction and
186
+ * transaction-line objects (`all`), only transaction objects
187
+ * (`transactions_without_lines`, the default), or only transaction-line objects
188
+ * (`transaction_lines_only`.
189
+ */
190
+ detailLevel?: 'all' | 'transaction_lines_only' | 'transactions_without_lines';
191
+ /**
192
+ * Query param: Filter for transactions associated with these entities (customers,
193
+ * vendors, employees, etc.).
194
+ *
195
+ * **NOTE**: To filter on transaction lines, you must specify the
196
+ * `transactionDetailLevel` parameter as `all` or `transaction_lines_only`.
197
+ */
198
+ entityIds?: Array<string>;
199
+ /**
200
+ * Query param: Filter for specific transactions by their QuickBooks-assigned
201
+ * unique identifier(s).
202
+ *
203
+ * **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
204
+ * query parameters for this request.
205
+ *
206
+ * **NOTE**: If any of the values you specify in this parameter are not found, the
207
+ * request will return an error.
208
+ *
209
+ * **NOTE**: You cannot supply the ID of a time tracking activity to this request.
210
+ * If you do, you get an error stating that no such record could be found, even
211
+ * though the transaction is in QuickBooks. This limitation is enforced by
212
+ * QuickBooks.
213
+ */
214
+ ids?: Array<string>;
215
+ /**
216
+ * Query param: Filter for transactions associated with these items.
217
+ *
218
+ * **NOTE**: To filter on transaction lines, you must specify the
219
+ * `transactionDetailLevel` parameter as `all` or `transaction_lines_only`.
220
+ */
221
+ itemIds?: Array<string>;
222
+ /**
223
+ * Query param: Filter for transactions that are open, closed, or either. Open
224
+ * transactions have a remaining balance, such as credits not fully applied or
225
+ * invoices not fully paid.
226
+ */
227
+ paymentStatus?: 'closed' | 'either' | 'open';
228
+ /**
229
+ * Query param: Filter for transactions that are posting, non-posting, or either.
230
+ * Posting status refers to whether QuickBooks records the transaction in an
231
+ * account register.
232
+ */
233
+ postingStatus?: 'either' | 'non_posting' | 'posting';
234
+ /**
235
+ * Query param: Filter for transactions whose `refNumber` contains this substring.
236
+ * NOTE: If you use this parameter, you cannot also use `refNumberStartsWith` or
237
+ * `refNumberEndsWith`.
238
+ */
239
+ refNumberContains?: string;
240
+ /**
241
+ * Query param: Filter for transactions whose `refNumber` ends with this substring.
242
+ * NOTE: If you use this parameter, you cannot also use `refNumberContains` or
243
+ * `refNumberStartsWith`.
244
+ */
245
+ refNumberEndsWith?: string;
246
+ /**
247
+ * Query param: Filter for transactions whose `refNumber` is greater than or equal
248
+ * to this value. If omitted, the range will begin with the first number of the
249
+ * list. Uses a numerical comparison for values that contain only digits;
250
+ * otherwise, uses a lexicographical comparison.
251
+ */
252
+ refNumberFrom?: string;
253
+ /**
254
+ * Query param: Filter for specific transactions by their ref-number(s),
255
+ * case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can
256
+ * be arbitrarily changed by the QuickBooks user.
257
+ *
258
+ * **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
259
+ * query parameters for this request.
260
+ *
261
+ * **NOTE**: If any of the values you specify in this parameter are not found, the
262
+ * request will return an error.
263
+ */
264
+ refNumbers?: Array<string>;
265
+ /**
266
+ * Query param: Filter for transactions whose `refNumber` starts with this
267
+ * substring. NOTE: If you use this parameter, you cannot also use
268
+ * `refNumberContains` or `refNumberEndsWith`.
269
+ */
270
+ refNumberStartsWith?: string;
271
+ /**
272
+ * Query param: Filter for transactions whose `refNumber` is less than or equal to
273
+ * this value. If omitted, the range will end with the last number of the list.
274
+ * Uses a numerical comparison for values that contain only digits; otherwise, uses
275
+ * a lexicographical comparison.
276
+ */
277
+ refNumberTo?: string;
278
+ /**
279
+ * Query param: Filter for transactions whose `date` field is on or after this
280
+ * date, in ISO 8601 format (YYYY-MM-DD).
281
+ */
282
+ transactionDateFrom?: string;
283
+ /**
284
+ * Query param: Filter for transactions whose `date` field is on or before this
285
+ * date, in ISO 8601 format (YYYY-MM-DD).
286
+ */
287
+ transactionDateTo?: string;
288
+ /**
289
+ * Query param: Filter for transactions by their type. You can specify one or more
290
+ * transaction types.
291
+ *
292
+ * **NOTE**: Filtering for time tracking activities is not supported by QuickBooks
293
+ * for this endpoint.
294
+ */
295
+ transactionType?: Array<'all' | 'ar_refund_credit_card' | 'bill' | 'bill_payment_check' | 'bill_payment_credit_card' | 'build_assembly' | 'charge' | 'check' | 'credit_card_charge' | 'credit_card_credit' | 'credit_memo' | 'deposit' | 'estimate' | 'inventory_adjustment' | 'invoice' | 'item_receipt' | 'journal_entry' | 'liability_adjustment' | 'paycheck' | 'payroll_liability_check' | 'purchase_order' | 'receive_payment' | 'sales_order' | 'sales_receipt' | 'sales_tax_payment_check' | 'transfer' | 'vendor_credit' | 'ytd_adjustment'>;
296
+ /**
297
+ * Query param: Filter for transactions updated on or after this date and time, in
298
+ * ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD),
299
+ * the time is assumed to be 00:00:00 of that day.
300
+ */
301
+ updatedAfter?: string;
302
+ /**
303
+ * Query param: Filter for transactions updated on or before this date and time, in
304
+ * ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD),
305
+ * the time is assumed to be 23:59:59 of that day.
306
+ */
307
+ updatedBefore?: string;
308
+ }
309
+ export declare namespace Transactions {
310
+ export { type Transaction as Transaction, TransactionsCursorPage as TransactionsCursorPage, type TransactionRetrieveParams as TransactionRetrieveParams, type TransactionListParams as TransactionListParams, };
311
+ }
312
+ //# sourceMappingURL=transactions.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"transactions.d.ts","sourceRoot":"","sources":["../../src/resources/qbd/transactions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAErE,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;IAQ/B;;;;;;;;OAQG;IACH,IAAI,CACF,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,sBAAsB,EAAE,WAAW,CAAC;CAQzD;AAED,qBAAa,sBAAuB,SAAQ,UAAU,CAAC,WAAW,CAAC;CAAG;AAEtE,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,OAAO,EAAE,WAAW,CAAC,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,QAAQ,EAAE,WAAW,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,MAAM,EAAE,WAAW,CAAC,MAAM,GAAG,IAAI,CAAC;IAElC;;;;OAIG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;;OAIG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;;OAIG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,eAAe,EACX,uBAAuB,GACvB,MAAM,GACN,oBAAoB,GACpB,0BAA0B,GAC1B,gBAAgB,GAChB,QAAQ,GACR,OAAO,GACP,oBAAoB,GACpB,oBAAoB,GACpB,aAAa,GACb,SAAS,GACT,UAAU,GACV,sBAAsB,GACtB,SAAS,GACT,cAAc,GACd,eAAe,GACf,sBAAsB,GACtB,UAAU,GACV,yBAAyB,GACzB,gBAAgB,GAChB,iBAAiB,GACjB,aAAa,GACb,eAAe,GACf,yBAAyB,GACzB,UAAU,GACV,eAAe,GACf,gBAAgB,CAAC;IAErB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,WAAW,CAAC;IAC3B;;OAEG;IACH,UAAiB,OAAO;QACtB;;;;WAIG;QACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;QAElB;;;;WAIG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;IAED;;;;OAIG;IACH,UAAiB,QAAQ;QACvB;;;;WAIG;QACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;QAElB;;;;WAIG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;IAED;;;OAGG;IACH,UAAiB,MAAM;QACrB;;;;WAIG;QACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;QAElB;;;;WAIG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B;;;;;OAKG;IACH,WAAW,CAAC,EAAE,KAAK,GAAG,wBAAwB,GAAG,4BAA4B,CAAC;IAE9E;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE1B;;;;;;;;;;;;;;OAcG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;;;OAIG;IACH,aAAa,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC;IAE7C;;;;OAIG;IACH,aAAa,CAAC,EAAE,QAAQ,GAAG,aAAa,GAAG,SAAS,CAAC;IAErD;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;;;;;;OAUG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,KAAK,CACnB,KAAK,GACL,uBAAuB,GACvB,MAAM,GACN,oBAAoB,GACpB,0BAA0B,GAC1B,gBAAgB,GAChB,QAAQ,GACR,OAAO,GACP,oBAAoB,GACpB,oBAAoB,GACpB,aAAa,GACb,SAAS,GACT,UAAU,GACV,sBAAsB,GACtB,SAAS,GACT,cAAc,GACd,eAAe,GACf,sBAAsB,GACtB,UAAU,GACV,yBAAyB,GACzB,gBAAgB,GAChB,iBAAiB,GACjB,aAAa,GACb,eAAe,GACf,yBAAyB,GACzB,UAAU,GACV,eAAe,GACf,gBAAgB,CACnB,CAAC;IAEF;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAID,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,sBAAsB,IAAI,sBAAsB,EAChD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
@@ -0,0 +1,41 @@
1
+ "use strict";
2
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.TransactionsCursorPage = exports.Transactions = void 0;
5
+ const resource_1 = require("../../resource.js");
6
+ const pagination_1 = require("../../pagination.js");
7
+ class Transactions extends resource_1.APIResource {
8
+ /**
9
+ * Retrieves a transaction by ID.
10
+ */
11
+ retrieve(id, params, options) {
12
+ const { conductorEndUserId } = params;
13
+ return this._client.get(`/quickbooks-desktop/transactions/${id}`, {
14
+ ...options,
15
+ headers: { 'Conductor-End-User-Id': conductorEndUserId, ...options?.headers },
16
+ });
17
+ }
18
+ /**
19
+ * Searches across all transaction types. Unlike transaction-specific queries, this
20
+ * endpoint only returns fields common to all transaction types, such as ID, type,
21
+ * dates, account, and reference numbers. For more details specific to that
22
+ * transaction type, make a subsequent call to the relevant transaction-specific
23
+ * endpoint (such as invoices, bills, etc.)
24
+ *
25
+ * NOTE: This endpoint does not support time tracking activities.
26
+ */
27
+ list(params, options) {
28
+ const { conductorEndUserId, ...query } = params;
29
+ return this._client.getAPIList('/quickbooks-desktop/transactions', TransactionsCursorPage, {
30
+ query,
31
+ ...options,
32
+ headers: { 'Conductor-End-User-Id': conductorEndUserId, ...options?.headers },
33
+ });
34
+ }
35
+ }
36
+ exports.Transactions = Transactions;
37
+ class TransactionsCursorPage extends pagination_1.CursorPage {
38
+ }
39
+ exports.TransactionsCursorPage = TransactionsCursorPage;
40
+ Transactions.TransactionsCursorPage = TransactionsCursorPage;
41
+ //# sourceMappingURL=transactions.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"transactions.js","sourceRoot":"","sources":["../../src/resources/qbd/transactions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAE7C,oDAAqE;AAErE,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAiC,EACjC,OAA6B;QAE7B,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oCAAoC,EAAE,EAAE,EAAE;YAChE,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,MAA6B,EAC7B,OAA6B;QAE7B,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,kCAAkC,EAAE,sBAAsB,EAAE;YACzF,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;CACF;AApCD,oCAoCC;AAED,MAAa,sBAAuB,SAAQ,uBAAuB;CAAG;AAAtE,wDAAsE;AAmYtE,YAAY,CAAC,sBAAsB,GAAG,sBAAsB,CAAC"}
@@ -0,0 +1,36 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ import { APIResource } from "../../resource.mjs";
3
+ import { CursorPage } from "../../pagination.mjs";
4
+ export class Transactions extends APIResource {
5
+ /**
6
+ * Retrieves a transaction by ID.
7
+ */
8
+ retrieve(id, params, options) {
9
+ const { conductorEndUserId } = params;
10
+ return this._client.get(`/quickbooks-desktop/transactions/${id}`, {
11
+ ...options,
12
+ headers: { 'Conductor-End-User-Id': conductorEndUserId, ...options?.headers },
13
+ });
14
+ }
15
+ /**
16
+ * Searches across all transaction types. Unlike transaction-specific queries, this
17
+ * endpoint only returns fields common to all transaction types, such as ID, type,
18
+ * dates, account, and reference numbers. For more details specific to that
19
+ * transaction type, make a subsequent call to the relevant transaction-specific
20
+ * endpoint (such as invoices, bills, etc.)
21
+ *
22
+ * NOTE: This endpoint does not support time tracking activities.
23
+ */
24
+ list(params, options) {
25
+ const { conductorEndUserId, ...query } = params;
26
+ return this._client.getAPIList('/quickbooks-desktop/transactions', TransactionsCursorPage, {
27
+ query,
28
+ ...options,
29
+ headers: { 'Conductor-End-User-Id': conductorEndUserId, ...options?.headers },
30
+ });
31
+ }
32
+ }
33
+ export class TransactionsCursorPage extends CursorPage {
34
+ }
35
+ Transactions.TransactionsCursorPage = TransactionsCursorPage;
36
+ //# sourceMappingURL=transactions.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"transactions.mjs","sourceRoot":"","sources":["../../src/resources/qbd/transactions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,UAAU,EAAyB;AAE5C,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAiC,EACjC,OAA6B;QAE7B,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oCAAoC,EAAE,EAAE,EAAE;YAChE,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,MAA6B,EAC7B,OAA6B;QAE7B,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,kCAAkC,EAAE,sBAAsB,EAAE;YACzF,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,OAAO,sBAAuB,SAAQ,UAAuB;CAAG;AAmYtE,YAAY,CAAC,sBAAsB,GAAG,sBAAsB,CAAC"}
@@ -241,13 +241,13 @@ export interface TransferListParams extends CursorPageParams {
241
241
  */
242
242
  ids?: Array<string>;
243
243
  /**
244
- * Query param: Filter for transfers created on or after this date, in ISO 8601
245
- * format (YYYY-MM-DD).
244
+ * Query param: Filter for transfers whose `date` field is on or after this date,
245
+ * in ISO 8601 format (YYYY-MM-DD).
246
246
  */
247
247
  transactionDateFrom?: string;
248
248
  /**
249
- * Query param: Filter for transfers created on or before this date, in ISO 8601
250
- * format (YYYY-MM-DD).
249
+ * Query param: Filter for transfers whose `date` field is on or before this date,
250
+ * in ISO 8601 format (YYYY-MM-DD).
251
251
  */
252
252
  transactionDateTo?: string;
253
253
  /**
@@ -2258,13 +2258,13 @@ export interface VendorCreditListParams extends CursorPageParams {
2258
2258
  */
2259
2259
  refNumberTo?: string;
2260
2260
  /**
2261
- * Query param: Filter for vendor credits created on or after this date, in ISO
2262
- * 8601 format (YYYY-MM-DD).
2261
+ * Query param: Filter for vendor credits whose `date` field is on or after this
2262
+ * date, in ISO 8601 format (YYYY-MM-DD).
2263
2263
  */
2264
2264
  transactionDateFrom?: string;
2265
2265
  /**
2266
- * Query param: Filter for vendor credits created on or before this date, in ISO
2267
- * 8601 format (YYYY-MM-DD).
2266
+ * Query param: Filter for vendor credits whose `date` field is on or before this
2267
+ * date, in ISO 8601 format (YYYY-MM-DD).
2268
2268
  */
2269
2269
  transactionDateTo?: string;
2270
2270
  /**
@@ -64,7 +64,7 @@ export interface Vendor {
64
64
  billingAddress: Vendor.BillingAddress | null;
65
65
  /**
66
66
  * The vendor's billing rate, used to override service item rates in time tracking
67
- * transactions.
67
+ * activities.
68
68
  */
69
69
  billingRate: Vendor.BillingRate | null;
70
70
  /**
@@ -412,7 +412,7 @@ export declare namespace Vendor {
412
412
  }
413
413
  /**
414
414
  * The vendor's billing rate, used to override service item rates in time tracking
415
- * transactions.
415
+ * activities.
416
416
  */
417
417
  interface BillingRate {
418
418
  /**
@@ -725,7 +725,7 @@ export interface VendorCreateParams {
725
725
  billingAddress?: VendorCreateParams.BillingAddress;
726
726
  /**
727
727
  * Body param: The vendor's billing rate, used to override service item rates in
728
- * time tracking transactions.
728
+ * time tracking activities.
729
729
  */
730
730
  billingRateId?: string;
731
731
  /**
@@ -1164,7 +1164,7 @@ export interface VendorUpdateParams {
1164
1164
  billingAddress?: VendorUpdateParams.BillingAddress;
1165
1165
  /**
1166
1166
  * Body param: The vendor's billing rate, used to override service item rates in
1167
- * time tracking transactions.
1167
+ * time tracking activities.
1168
1168
  */
1169
1169
  billingRateId?: string;
1170
1170
  /**
package/src/index.ts CHANGED
@@ -16,10 +16,9 @@ import {
16
16
  EndUserListResponse,
17
17
  EndUserPassthroughParams,
18
18
  EndUserPassthroughResponse,
19
- EndUserPingResponse,
20
19
  EndUsers,
21
20
  } from './resources/end-users';
22
- import { Qbd } from './resources/qbd/qbd';
21
+ import { Qbd, QbdHealthCheckParams, QbdHealthCheckResponse } from './resources/qbd/qbd';
23
22
 
24
23
  export interface ClientOptions {
25
24
  /**
@@ -199,12 +198,15 @@ export declare namespace Conductor {
199
198
  type EndUserListResponse as EndUserListResponse,
200
199
  type EndUserDeleteResponse as EndUserDeleteResponse,
201
200
  type EndUserPassthroughResponse as EndUserPassthroughResponse,
202
- type EndUserPingResponse as EndUserPingResponse,
203
201
  type EndUserCreateParams as EndUserCreateParams,
204
202
  type EndUserPassthroughParams as EndUserPassthroughParams,
205
203
  };
206
204
 
207
- export { Qbd as Qbd };
205
+ export {
206
+ Qbd as Qbd,
207
+ type QbdHealthCheckResponse as QbdHealthCheckResponse,
208
+ type QbdHealthCheckParams as QbdHealthCheckParams,
209
+ };
208
210
  }
209
211
 
210
212
  export { toFile, fileFromPath } from './uploads';
@@ -5,31 +5,24 @@ import * as Core from '../core';
5
5
 
6
6
  export class AuthSessions extends APIResource {
7
7
  /**
8
- * To launch the authentication flow, create an AuthSession and pass the returned
9
- * sessions `authFlowUrl` to the client for your end-user to visit in their
8
+ * To launch the authentication flow, create an auth session and pass the returned
9
+ * session's `authFlowUrl` to the client for your end-user to visit in their
10
10
  * browser.
11
11
  */
12
12
  create(body: AuthSessionCreateParams, options?: Core.RequestOptions): Core.APIPromise<AuthSession> {
13
13
  return this._client.post('/auth-sessions', { body, ...options });
14
14
  }
15
-
16
- /**
17
- * Retrieves the details of an AuthSession that has previously been created.
18
- */
19
- retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<AuthSession> {
20
- return this._client.get(`/auth-sessions/${id}`, options);
21
- }
22
15
  }
23
16
 
24
17
  export interface AuthSession {
25
18
  /**
26
- * The unique identifier for this AuthSession.
19
+ * The unique identifier for this auth session.
27
20
  */
28
21
  id: string;
29
22
 
30
23
  /**
31
24
  * The URL of the authentication flow that you will pass to your client for your
32
- * user to set up their IntegrationConnection.
25
+ * user to set up their integration connection.
33
26
  */
34
27
  authFlowUrl: string;
35
28
 
@@ -39,19 +32,19 @@ export interface AuthSession {
39
32
  clientSecret: string;
40
33
 
41
34
  /**
42
- * The date and time when this AuthSession record was created.
35
+ * The date and time when this auth session record was created.
43
36
  */
44
37
  createdAt: string;
45
38
 
46
39
  /**
47
- * The ID of the EndUser for whom to create an IntegrationConnection.
40
+ * The ID of the end-user for whom to create an integration connection.
48
41
  */
49
42
  endUserId: string;
50
43
 
51
44
  /**
52
- * The date and time when this AuthSession expires. By default, this value is 30
45
+ * The date and time when this auth session expires. By default, this value is 30
53
46
  * minutes from creation. You can extend this time by setting `linkExpiryMins` when
54
- * [creating the AuthSession](/apis/auth-sessions/create).
47
+ * creating the auth session.
55
48
  */
56
49
  expiresAt: string;
57
50
 
@@ -70,18 +63,18 @@ export interface AuthSession {
70
63
 
71
64
  export interface AuthSessionCreateParams {
72
65
  /**
73
- * The ID of the EndUser for whom to create the IntegrationConnection.
66
+ * The ID of the end-user for whom to create the integration connection.
74
67
  */
75
68
  endUserId: string;
76
69
 
77
70
  /**
78
- * Your Conductor publishable key, which we use to create the sessions
71
+ * Your Conductor publishable key, which we use to create the auth session's
79
72
  * `authFlowUrl`.
80
73
  */
81
74
  publishableKey: string;
82
75
 
83
76
  /**
84
- * The number of minutes after which the AuthSession will expire. Must be at least
77
+ * The number of minutes after which the auth session will expire. Must be at least
85
78
  * 15 minutes and no more than 7 days. If not provided, defaults to 30 minutes.
86
79
  */
87
80
  linkExpiryMins?: number;