conductor-node 12.5.0 → 12.5.1

package/src/resources/qbd/price-levels.ts

@@ -6,6 +6,14 @@ import * as Core from '../../core';
 export class PriceLevels extends APIResource {
   /**
    * Creates a new price level.
+   *
+   * @example
+   * ```ts
+   * const priceLevel = await client.qbd.priceLevels.create({
+   *   name: 'Wholesale 20% Discount',
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * });
+   * ```
    */
   create(params: PriceLevelCreateParams, options?: Core.RequestOptions): Core.APIPromise<PriceLevel> {
     const { conductorEndUserId, ...body } = params;
@@ -18,6 +26,14 @@ export class PriceLevels extends APIResource {
 
   /**
    * Retrieves a price level by ID.
+   *
+   * @example
+   * ```ts
+   * const priceLevel = await client.qbd.priceLevels.retrieve(
+   *   '80000001-1234567890',
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
    */
   retrieve(
     id: string,
@@ -33,6 +49,17 @@ export class PriceLevels extends APIResource {
 
   /**
    * Updates an existing price level.
+   *
+   * @example
+   * ```ts
+   * const priceLevel = await client.qbd.priceLevels.update(
+   *   '80000001-1234567890',
+   *   {
+   *     revisionNumber: '1721172183',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   },
+   * );
+   * ```
    */
   update(
     id: string,
@@ -51,6 +78,13 @@ export class PriceLevels extends APIResource {
    * Returns a list of price levels. NOTE: QuickBooks Desktop does not support
    * pagination for price levels; hence, there is no `cursor` parameter. Users
    * typically have few price levels.
+   *
+   * @example
+   * ```ts
+   * const priceLevels = await client.qbd.priceLevels.list({
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * });
+   * ```
    */
   list(params: PriceLevelListParams, options?: Core.RequestOptions): Core.APIPromise<PriceLevelListResponse> {
     const { conductorEndUserId, ...query } = params;

package/src/resources/qbd/purchase-orders.ts

@@ -7,6 +7,15 @@ import { CursorPage, type CursorPageParams } from '../../pagination';
 export class PurchaseOrders extends APIResource {
   /**
    * Creates a new purchase order.
+   *
+   * @example
+   * ```ts
+   * const purchaseOrder =
+   *   await client.qbd.purchaseOrders.create({
+   *     transactionDate: '2021-10-01',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   });
+   * ```
    */
   create(params: PurchaseOrderCreateParams, options?: Core.RequestOptions): Core.APIPromise<PurchaseOrder> {
     const { conductorEndUserId, ...body } = params;
@@ -19,6 +28,15 @@ export class PurchaseOrders extends APIResource {
 
   /**
    * Retrieves a purchase order by ID.
+   *
+   * @example
+   * ```ts
+   * const purchaseOrder =
+   *   await client.qbd.purchaseOrders.retrieve(
+   *     '123ABC-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   retrieve(
     id: string,
@@ -34,6 +52,18 @@ export class PurchaseOrders extends APIResource {
 
   /**
    * Updates an existing purchase order.
+   *
+   * @example
+   * ```ts
+   * const purchaseOrder =
+   *   await client.qbd.purchaseOrders.update(
+   *     '123ABC-1234567890',
+   *     {
+   *       revisionNumber: '1721172183',
+   *       conductorEndUserId: 'end_usr_1234567abcdefg',
+   *     },
+   *   );
+   * ```
    */
   update(
     id: string,
@@ -51,6 +81,16 @@ export class PurchaseOrders extends APIResource {
   /**
    * Returns a list of purchase orders. Use the `cursor` parameter to paginate
    * through the results.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const purchaseOrder of client.qbd.purchaseOrders.list(
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: PurchaseOrderListParams,
@@ -67,6 +107,15 @@ export class PurchaseOrders extends APIResource {
   /**
    * Permanently deletes a a purchase order. The deletion will fail if the purchase
    * order is currently in use or has any linked transactions that are in use.
+   *
+   * @example
+   * ```ts
+   * const purchaseOrder =
+   *   await client.qbd.purchaseOrders.delete(
+   *     '123ABC-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   delete(
     id: string,

package/src/resources/qbd/qbd.ts

@@ -520,6 +520,13 @@ export class Qbd extends APIResource {
    * will be returned. As with any request to QuickBooks Desktop, the health check
    * may fail if the application is not running, the wrong company file is open, or
    * if a modal dialog is open. Timeout is 60 seconds.
+   *
+   * @example
+   * ```ts
+   * const response = await client.qbd.healthCheck({
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * });
+   * ```
    */
   healthCheck(
     params: QbdHealthCheckParams,

package/src/resources/qbd/receive-payments.ts

@@ -7,6 +7,17 @@ import { CursorPage, type CursorPageParams } from '../../pagination';
 export class ReceivePayments extends APIResource {
   /**
    * Creates a new receive-payment.
+   *
+   * @example
+   * ```ts
+   * const receivePayment =
+   *   await client.qbd.receivePayments.create({
+   *     customerId: '80000001-1234567890',
+   *     totalAmount: '1000.00',
+   *     transactionDate: '2021-10-01',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   });
+   * ```
    */
   create(params: ReceivePaymentCreateParams, options?: Core.RequestOptions): Core.APIPromise<ReceivePayment> {
     const { conductorEndUserId, ...body } = params;
@@ -19,6 +30,15 @@ export class ReceivePayments extends APIResource {
 
   /**
    * Retrieves a receive-payment by ID.
+   *
+   * @example
+   * ```ts
+   * const receivePayment =
+   *   await client.qbd.receivePayments.retrieve(
+   *     '123ABC-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   retrieve(
     id: string,
@@ -34,6 +54,18 @@ export class ReceivePayments extends APIResource {
 
   /**
    * Updates an existing receive-payment.
+   *
+   * @example
+   * ```ts
+   * const receivePayment =
+   *   await client.qbd.receivePayments.update(
+   *     '123ABC-1234567890',
+   *     {
+   *       revisionNumber: '1721172183',
+   *       conductorEndUserId: 'end_usr_1234567abcdefg',
+   *     },
+   *   );
+   * ```
    */
   update(
     id: string,
@@ -51,6 +83,16 @@ export class ReceivePayments extends APIResource {
   /**
    * Returns a list of receive-payments. Use the `cursor` parameter to paginate
    * through the results.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const receivePayment of client.qbd.receivePayments.list(
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: ReceivePaymentListParams,
@@ -68,6 +110,15 @@ export class ReceivePayments extends APIResource {
    * Permanently deletes a a receive-payment. The deletion will fail if the
    * receive-payment is currently in use or has any linked transactions that are in
    * use.
+   *
+   * @example
+   * ```ts
+   * const receivePayment =
+   *   await client.qbd.receivePayments.delete(
+   *     '123ABC-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   delete(
     id: string,

package/src/resources/qbd/sales-orders.ts

@@ -7,6 +7,15 @@ import { CursorPage, type CursorPageParams } from '../../pagination';
 export class SalesOrders extends APIResource {
   /**
    * Creates a new sales order.
+   *
+   * @example
+   * ```ts
+   * const salesOrder = await client.qbd.salesOrders.create({
+   *   customerId: '80000001-1234567890',
+   *   transactionDate: '2021-10-01',
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * });
+   * ```
    */
   create(params: SalesOrderCreateParams, options?: Core.RequestOptions): Core.APIPromise<SalesOrder> {
     const { conductorEndUserId, ...body } = params;
@@ -19,6 +28,14 @@ export class SalesOrders extends APIResource {
 
   /**
    * Retrieves a sales order by ID.
+   *
+   * @example
+   * ```ts
+   * const salesOrder = await client.qbd.salesOrders.retrieve(
+   *   '123ABC-1234567890',
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
    */
   retrieve(
     id: string,
@@ -34,6 +51,17 @@ export class SalesOrders extends APIResource {
 
   /**
    * Updates an existing sales order.
+   *
+   * @example
+   * ```ts
+   * const salesOrder = await client.qbd.salesOrders.update(
+   *   '123ABC-1234567890',
+   *   {
+   *     revisionNumber: '1721172183',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   },
+   * );
+   * ```
    */
   update(
     id: string,
@@ -51,6 +79,16 @@ export class SalesOrders extends APIResource {
   /**
    * Returns a list of sales orders. Use the `cursor` parameter to paginate through
    * the results.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const salesOrder of client.qbd.salesOrders.list({
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * })) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: SalesOrderListParams,
@@ -67,6 +105,14 @@ export class SalesOrders extends APIResource {
   /**
    * Permanently deletes a a sales order. The deletion will fail if the sales order
    * is currently in use or has any linked transactions that are in use.
+   *
+   * @example
+   * ```ts
+   * const salesOrder = await client.qbd.salesOrders.delete(
+   *   '123ABC-1234567890',
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
    */
   delete(
     id: string,

package/src/resources/qbd/sales-receipts.ts

@@ -7,6 +7,15 @@ import { CursorPage, type CursorPageParams } from '../../pagination';
 export class SalesReceipts extends APIResource {
   /**
    * Creates a new sales receipt.
+   *
+   * @example
+   * ```ts
+   * const salesReceipt = await client.qbd.salesReceipts.create({
+   *   customerId: '80000001-1234567890',
+   *   transactionDate: '2021-10-01',
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * });
+   * ```
    */
   create(params: SalesReceiptCreateParams, options?: Core.RequestOptions): Core.APIPromise<SalesReceipt> {
     const { conductorEndUserId, ...body } = params;
@@ -19,6 +28,15 @@ export class SalesReceipts extends APIResource {
 
   /**
    * Retrieves a sales receipt by ID.
+   *
+   * @example
+   * ```ts
+   * const salesReceipt =
+   *   await client.qbd.salesReceipts.retrieve(
+   *     '123ABC-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   retrieve(
     id: string,
@@ -34,6 +52,17 @@ export class SalesReceipts extends APIResource {
 
   /**
    * Updates an existing sales receipt.
+   *
+   * @example
+   * ```ts
+   * const salesReceipt = await client.qbd.salesReceipts.update(
+   *   '123ABC-1234567890',
+   *   {
+   *     revisionNumber: '1721172183',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   },
+   * );
+   * ```
    */
   update(
     id: string,
@@ -51,6 +80,16 @@ export class SalesReceipts extends APIResource {
   /**
    * Returns a list of sales receipts. Use the `cursor` parameter to paginate through
    * the results.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const salesReceipt of client.qbd.salesReceipts.list(
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: SalesReceiptListParams,
@@ -67,6 +106,14 @@ export class SalesReceipts extends APIResource {
   /**
    * Permanently deletes a a sales receipt. The deletion will fail if the sales
    * receipt is currently in use or has any linked transactions that are in use.
+   *
+   * @example
+   * ```ts
+   * const salesReceipt = await client.qbd.salesReceipts.delete(
+   *   '123ABC-1234567890',
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
    */
   delete(
     id: string,

package/src/resources/qbd/sales-representatives.ts

@@ -6,6 +6,16 @@ import * as Core from '../../core';
 export class SalesRepresentatives extends APIResource {
   /**
    * Creates a new sales representative.
+   *
+   * @example
+   * ```ts
+   * const salesRepresentative =
+   *   await client.qbd.salesRepresentatives.create({
+   *     entityId: '80000001-1234567890',
+   *     initial: 'JD',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   });
+   * ```
    */
   create(
     params: SalesRepresentativeCreateParams,
@@ -21,6 +31,15 @@ export class SalesRepresentatives extends APIResource {
 
   /**
    * Retrieves a sales representative by ID.
+   *
+   * @example
+   * ```ts
+   * const salesRepresentative =
+   *   await client.qbd.salesRepresentatives.retrieve(
+   *     '80000001-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   retrieve(
     id: string,
@@ -36,6 +55,18 @@ export class SalesRepresentatives extends APIResource {
 
   /**
    * Updates an existing sales representative.
+   *
+   * @example
+   * ```ts
+   * const salesRepresentative =
+   *   await client.qbd.salesRepresentatives.update(
+   *     '80000001-1234567890',
+   *     {
+   *       revisionNumber: '1721172183',
+   *       conductorEndUserId: 'end_usr_1234567abcdefg',
+   *     },
+   *   );
+   * ```
    */
   update(
     id: string,
@@ -54,6 +85,14 @@ export class SalesRepresentatives extends APIResource {
    * Returns a list of sales representatives. NOTE: QuickBooks Desktop does not
    * support pagination for sales representatives; hence, there is no `cursor`
    * parameter. Users typically have few sales representatives.
+   *
+   * @example
+   * ```ts
+   * const salesRepresentatives =
+   *   await client.qbd.salesRepresentatives.list({
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   });
+   * ```
    */
   list(
     params: SalesRepresentativeListParams,

package/src/resources/qbd/sales-tax-codes.ts

@@ -6,6 +6,15 @@ import * as Core from '../../core';
 export class SalesTaxCodes extends APIResource {
   /**
    * Creates a new sales-tax code.
+   *
+   * @example
+   * ```ts
+   * const salesTaxCode = await client.qbd.salesTaxCodes.create({
+   *   isTaxable: true,
+   *   name: 'Tax',
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * });
+   * ```
    */
   create(params: SalesTaxCodeCreateParams, options?: Core.RequestOptions): Core.APIPromise<SalesTaxCode> {
     const { conductorEndUserId, ...body } = params;
@@ -18,6 +27,15 @@ export class SalesTaxCodes extends APIResource {
 
   /**
    * Retrieves a sales-tax code by ID.
+   *
+   * @example
+   * ```ts
+   * const salesTaxCode =
+   *   await client.qbd.salesTaxCodes.retrieve(
+   *     '80000001-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   retrieve(
     id: string,
@@ -33,6 +51,17 @@ export class SalesTaxCodes extends APIResource {
 
   /**
    * Updates an existing sales-tax code.
+   *
+   * @example
+   * ```ts
+   * const salesTaxCode = await client.qbd.salesTaxCodes.update(
+   *   '80000001-1234567890',
+   *   {
+   *     revisionNumber: '1721172183',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   },
+   * );
+   * ```
    */
   update(
     id: string,
@@ -51,6 +80,13 @@ export class SalesTaxCodes extends APIResource {
    * Returns a list of sales-tax codes. NOTE: QuickBooks Desktop does not support
    * pagination for sales-tax codes; hence, there is no `cursor` parameter. Users
    * typically have few sales-tax codes.
+   *
+   * @example
+   * ```ts
+   * const salesTaxCodes = await client.qbd.salesTaxCodes.list({
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * });
+   * ```
    */
   list(
     params: SalesTaxCodeListParams,

package/src/resources/qbd/sales-tax-items.ts

@@ -7,6 +7,14 @@ import { CursorPage, type CursorPageParams } from '../../pagination';
 export class SalesTaxItems extends APIResource {
   /**
    * Creates a new sales-tax item.
+   *
+   * @example
+   * ```ts
+   * const salesTaxItem = await client.qbd.salesTaxItems.create({
+   *   name: 'Standard Tax',
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * });
+   * ```
    */
   create(params: SalesTaxItemCreateParams, options?: Core.RequestOptions): Core.APIPromise<SalesTaxItem> {
     const { conductorEndUserId, ...body } = params;
@@ -19,6 +27,15 @@ export class SalesTaxItems extends APIResource {
 
   /**
    * Retrieves a sales-tax item by ID.
+   *
+   * @example
+   * ```ts
+   * const salesTaxItem =
+   *   await client.qbd.salesTaxItems.retrieve(
+   *     '80000001-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   retrieve(
     id: string,
@@ -34,6 +51,17 @@ export class SalesTaxItems extends APIResource {
 
   /**
    * Updates an existing sales-tax item.
+   *
+   * @example
+   * ```ts
+   * const salesTaxItem = await client.qbd.salesTaxItems.update(
+   *   '80000001-1234567890',
+   *   {
+   *     revisionNumber: '1721172183',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   },
+   * );
+   * ```
    */
   update(
     id: string,
@@ -51,6 +79,16 @@ export class SalesTaxItems extends APIResource {
   /**
    * Returns a list of sales-tax items. Use the `cursor` parameter to paginate
    * through the results.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const salesTaxItem of client.qbd.salesTaxItems.list(
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: SalesTaxItemListParams,

package/src/resources/qbd/service-items.ts

@@ -7,6 +7,14 @@ import { CursorPage, type CursorPageParams } from '../../pagination';
 export class ServiceItems extends APIResource {
   /**
    * Creates a new service item.
+   *
+   * @example
+   * ```ts
+   * const serviceItem = await client.qbd.serviceItems.create({
+   *   name: 'Web-Design',
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * });
+   * ```
    */
   create(params: ServiceItemCreateParams, options?: Core.RequestOptions): Core.APIPromise<ServiceItem> {
     const { conductorEndUserId, ...body } = params;
@@ -19,6 +27,14 @@ export class ServiceItems extends APIResource {
 
   /**
    * Retrieves a service item by ID.
+   *
+   * @example
+   * ```ts
+   * const serviceItem = await client.qbd.serviceItems.retrieve(
+   *   '80000001-1234567890',
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
    */
   retrieve(
     id: string,
@@ -34,6 +50,17 @@ export class ServiceItems extends APIResource {
 
   /**
    * Updates an existing service item.
+   *
+   * @example
+   * ```ts
+   * const serviceItem = await client.qbd.serviceItems.update(
+   *   '80000001-1234567890',
+   *   {
+   *     revisionNumber: '1721172183',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   },
+   * );
+   * ```
    */
   update(
     id: string,
@@ -51,6 +78,16 @@ export class ServiceItems extends APIResource {
   /**
    * Returns a list of service items. Use the `cursor` parameter to paginate through
    * the results.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const serviceItem of client.qbd.serviceItems.list(
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: ServiceItemListParams,

package/src/resources/qbd/standard-terms.ts

@@ -6,6 +6,14 @@ import * as Core from '../../core';
 export class StandardTerms extends APIResource {
   /**
    * Creates a new standard term.
+   *
+   * @example
+   * ```ts
+   * const standardTerm = await client.qbd.standardTerms.create({
+   *   name: 'Net 30',
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * });
+   * ```
    */
   create(params: StandardTermCreateParams, options?: Core.RequestOptions): Core.APIPromise<StandardTerm> {
     const { conductorEndUserId, ...body } = params;
@@ -18,6 +26,15 @@ export class StandardTerms extends APIResource {
 
   /**
    * Retrieves a standard term by ID.
+   *
+   * @example
+   * ```ts
+   * const standardTerm =
+   *   await client.qbd.standardTerms.retrieve(
+   *     '80000001-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   retrieve(
     id: string,
@@ -35,6 +52,13 @@ export class StandardTerms extends APIResource {
    * Returns a list of standard terms. NOTE: QuickBooks Desktop does not support
    * pagination for standard terms; hence, there is no `cursor` parameter. Users
    * typically have few standard terms.
+   *
+   * @example
+   * ```ts
+   * const standardTerms = await client.qbd.standardTerms.list({
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * });
+   * ```
    */
   list(
     params: StandardTermListParams,