conductor-node 12.7.0 → 12.8.0

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.
@@ -2,7 +2,6 @@
2
2
 
3
3
  import { APIResource } from '../../resource';
4
4
  import * as Core from '../../core';
5
- import { CursorPage, type CursorPageParams } from '../../pagination';
6
5
 
7
6
  export class PaymentMethods extends APIResource {
8
7
  /**
@@ -52,25 +51,23 @@ export class PaymentMethods extends APIResource {
52
51
  }
53
52
 
54
53
  /**
55
- * Returns a list of payment methods. Use the `cursor` parameter to paginate
56
- * through the results.
54
+ * Returns a list of payment methods. NOTE: QuickBooks Desktop does not support
55
+ * pagination for payment methods; hence, there is no `cursor` parameter. Users
56
+ * typically have few payment methods.
57
57
  *
58
58
  * @example
59
59
  * ```ts
60
- * // Automatically fetches more pages as needed.
61
- * for await (const paymentMethod of client.qbd.paymentMethods.list(
60
+ * const paymentMethods = await client.qbd.paymentMethods.list(
62
61
  * { conductorEndUserId: 'end_usr_1234567abcdefg' },
63
- * )) {
64
- * // ...
65
- * }
62
+ * );
66
63
  * ```
67
64
  */
68
65
  list(
69
66
  params: PaymentMethodListParams,
70
67
  options?: Core.RequestOptions,
71
- ): Core.PagePromise<PaymentMethodsCursorPage, PaymentMethod> {
68
+ ): Core.APIPromise<PaymentMethodListResponse> {
72
69
  const { conductorEndUserId, ...query } = params;
73
- return this._client.getAPIList('/quickbooks-desktop/payment-methods', PaymentMethodsCursorPage, {
70
+ return this._client.get('/quickbooks-desktop/payment-methods', {
74
71
  query,
75
72
  ...options,
76
73
  headers: { 'Conductor-End-User-Id': conductorEndUserId, ...options?.headers },
@@ -78,8 +75,6 @@ export class PaymentMethods extends APIResource {
78
75
  }
79
76
  }
80
77
 
81
- export class PaymentMethodsCursorPage extends CursorPage<PaymentMethod> {}
82
-
83
78
  export interface PaymentMethod {
84
79
  /**
85
80
  * The unique identifier assigned by QuickBooks to this payment method. This ID is
@@ -148,6 +143,23 @@ export interface PaymentMethod {
148
143
  updatedAt: string;
149
144
  }
150
145
 
146
+ export interface PaymentMethodListResponse {
147
+ /**
148
+ * The array of payment methods.
149
+ */
150
+ data: Array<PaymentMethod>;
151
+
152
+ /**
153
+ * The type of object. This value is always `"list"`.
154
+ */
155
+ objectType: 'list';
156
+
157
+ /**
158
+ * The endpoint URL where this list can be accessed.
159
+ */
160
+ url: string;
161
+ }
162
+
151
163
  export interface PaymentMethodCreateParams {
152
164
  /**
153
165
  * Body param: The case-insensitive unique name of this payment method, unique
@@ -198,7 +210,7 @@ export interface PaymentMethodRetrieveParams {
198
210
  conductorEndUserId: string;
199
211
  }
200
212
 
201
- export interface PaymentMethodListParams extends CursorPageParams {
213
+ export interface PaymentMethodListParams {
202
214
  /**
203
215
  * Header param: The ID of the EndUser to receive this request (e.g.,
204
216
  * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
@@ -217,6 +229,20 @@ export interface PaymentMethodListParams extends CursorPageParams {
217
229
  */
218
230
  ids?: Array<string>;
219
231
 
232
+ /**
233
+ * Query param: The maximum number of objects to return.
234
+ *
235
+ * **IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for
236
+ * payment methods. This parameter will limit the response size, but you cannot
237
+ * fetch subsequent results using a cursor. For pagination, use the name-range
238
+ * parameters instead (e.g., `nameFrom=A&nameTo=B`).
239
+ *
240
+ * When this parameter is omitted, the endpoint returns all payment methods without
241
+ * limit, unlike paginated endpoints which default to 150 records. This is
242
+ * acceptable because payment methods typically have low record counts.
243
+ */
244
+ limit?: number;
245
+
220
246
  /**
221
247
  * Query param: Filter for payment methods whose `name` contains this substring,
222
248
  * case-insensitive. NOTE: If you use this parameter, you cannot also use
@@ -298,12 +324,10 @@ export interface PaymentMethodListParams extends CursorPageParams {
298
324
  updatedBefore?: string;
299
325
  }
300
326
 
301
- PaymentMethods.PaymentMethodsCursorPage = PaymentMethodsCursorPage;
302
-
303
327
  export declare namespace PaymentMethods {
304
328
  export {
305
329
  type PaymentMethod as PaymentMethod,
306
- PaymentMethodsCursorPage as PaymentMethodsCursorPage,
330
+ type PaymentMethodListResponse as PaymentMethodListResponse,
307
331
  type PaymentMethodCreateParams as PaymentMethodCreateParams,
308
332
  type PaymentMethodRetrieveParams as PaymentMethodRetrieveParams,
309
333
  type PaymentMethodListParams as PaymentMethodListParams,
@@ -271,14 +271,24 @@ import {
271
271
  NonInventoryItems,
272
272
  NonInventoryItemsCursorPage,
273
273
  } from './non-inventory-items';
274
+ import * as OtherNamesAPI from './other-names';
275
+ import {
276
+ OtherName,
277
+ OtherNameCreateParams,
278
+ OtherNameListParams,
279
+ OtherNameListResponse,
280
+ OtherNameRetrieveParams,
281
+ OtherNameUpdateParams,
282
+ OtherNames,
283
+ } from './other-names';
274
284
  import * as PaymentMethodsAPI from './payment-methods';
275
285
  import {
276
286
  PaymentMethod,
277
287
  PaymentMethodCreateParams,
278
288
  PaymentMethodListParams,
289
+ PaymentMethodListResponse,
279
290
  PaymentMethodRetrieveParams,
280
291
  PaymentMethods,
281
- PaymentMethodsCursorPage,
282
292
  } from './payment-methods';
283
293
  import * as PayrollWageItemsAPI from './payroll-wage-items';
284
294
  import {
@@ -499,6 +509,7 @@ export class Qbd extends APIResource {
499
509
  nonInventoryItems: NonInventoryItemsAPI.NonInventoryItems = new NonInventoryItemsAPI.NonInventoryItems(
500
510
  this._client,
501
511
  );
512
+ otherNames: OtherNamesAPI.OtherNames = new OtherNamesAPI.OtherNames(this._client);
502
513
  paymentMethods: PaymentMethodsAPI.PaymentMethods = new PaymentMethodsAPI.PaymentMethods(this._client);
503
514
  payrollWageItems: PayrollWageItemsAPI.PayrollWageItems = new PayrollWageItemsAPI.PayrollWageItems(
504
515
  this._client,
@@ -615,8 +626,8 @@ Qbd.JournalEntries = JournalEntries;
615
626
  Qbd.JournalEntriesCursorPage = JournalEntriesCursorPage;
616
627
  Qbd.NonInventoryItems = NonInventoryItems;
617
628
  Qbd.NonInventoryItemsCursorPage = NonInventoryItemsCursorPage;
629
+ Qbd.OtherNames = OtherNames;
618
630
  Qbd.PaymentMethods = PaymentMethods;
619
- Qbd.PaymentMethodsCursorPage = PaymentMethodsCursorPage;
620
631
  Qbd.PayrollWageItems = PayrollWageItems;
621
632
  Qbd.PayrollWageItemsCursorPage = PayrollWageItemsCursorPage;
622
633
  Qbd.PriceLevels = PriceLevels;
@@ -927,10 +938,20 @@ export declare namespace Qbd {
927
938
  type NonInventoryItemListParams as NonInventoryItemListParams,
928
939
  };
929
940
 
941
+ export {
942
+ OtherNames as OtherNames,
943
+ type OtherName as OtherName,
944
+ type OtherNameListResponse as OtherNameListResponse,
945
+ type OtherNameCreateParams as OtherNameCreateParams,
946
+ type OtherNameRetrieveParams as OtherNameRetrieveParams,
947
+ type OtherNameUpdateParams as OtherNameUpdateParams,
948
+ type OtherNameListParams as OtherNameListParams,
949
+ };
950
+
930
951
  export {
931
952
  PaymentMethods as PaymentMethods,
932
953
  type PaymentMethod as PaymentMethod,
933
- PaymentMethodsCursorPage as PaymentMethodsCursorPage,
954
+ type PaymentMethodListResponse as PaymentMethodListResponse,
934
955
  type PaymentMethodCreateParams as PaymentMethodCreateParams,
935
956
  type PaymentMethodRetrieveParams as PaymentMethodRetrieveParams,
936
957
  type PaymentMethodListParams as PaymentMethodListParams,
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '12.7.0'; // x-release-please-version
1
+ export const VERSION = '12.8.0'; // x-release-please-version
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "12.7.0";
1
+ export declare const VERSION = "12.8.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '12.7.0'; // x-release-please-version
4
+ exports.VERSION = '12.8.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '12.7.0'; // x-release-please-version
1
+ export const VERSION = '12.8.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map