conductor-node 12.5.0 → 12.6.0

package/src/resources/qbd/inventory-assembly-items.ts

@@ -7,6 +7,18 @@ import { CursorPage, type CursorPageParams } from '../../pagination';
 export class InventoryAssemblyItems extends APIResource {
   /**
    * Creates a new inventory assembly item.
+   *
+   * @example
+   * ```ts
+   * const inventoryAssemblyItem =
+   *   await client.qbd.inventoryAssemblyItems.create({
+   *     assetAccountId: '80000001-1234567890',
+   *     cogsAccountId: '80000001-1234567890',
+   *     incomeAccountId: '80000001-1234567890',
+   *     name: 'Deluxe Kit',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   });
+   * ```
    */
   create(
     params: InventoryAssemblyItemCreateParams,
@@ -22,6 +34,15 @@ export class InventoryAssemblyItems extends APIResource {
 
   /**
    * Retrieves an inventory assembly item by ID.
+   *
+   * @example
+   * ```ts
+   * const inventoryAssemblyItem =
+   *   await client.qbd.inventoryAssemblyItems.retrieve(
+   *     '80000001-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   retrieve(
     id: string,
@@ -37,6 +58,18 @@ export class InventoryAssemblyItems extends APIResource {
 
   /**
    * Updates an existing inventory assembly item.
+   *
+   * @example
+   * ```ts
+   * const inventoryAssemblyItem =
+   *   await client.qbd.inventoryAssemblyItems.update(
+   *     '80000001-1234567890',
+   *     {
+   *       revisionNumber: '1721172183',
+   *       conductorEndUserId: 'end_usr_1234567abcdefg',
+   *     },
+   *   );
+   * ```
    */
   update(
     id: string,
@@ -54,6 +87,16 @@ export class InventoryAssemblyItems extends APIResource {
   /**
    * Returns a list of inventory assembly items. Use the `cursor` parameter to
    * paginate through the results.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const inventoryAssemblyItem of client.qbd.inventoryAssemblyItems.list(
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: InventoryAssemblyItemListParams,

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

@@ -7,6 +7,18 @@ import { CursorPage, type CursorPageParams } from '../../pagination';
 export class InventoryItems extends APIResource {
   /**
    * Creates a new inventory item.
+   *
+   * @example
+   * ```ts
+   * const inventoryItem =
+   *   await client.qbd.inventoryItems.create({
+   *     assetAccountId: '80000001-1234567890',
+   *     cogsAccountId: '80000001-1234567890',
+   *     incomeAccountId: '80000001-1234567890',
+   *     name: 'Cabinet',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   });
+   * ```
    */
   create(params: InventoryItemCreateParams, options?: Core.RequestOptions): Core.APIPromise<InventoryItem> {
     const { conductorEndUserId, ...body } = params;
@@ -19,6 +31,15 @@ export class InventoryItems extends APIResource {
 
   /**
    * Retrieves an inventory item by ID.
+   *
+   * @example
+   * ```ts
+   * const inventoryItem =
+   *   await client.qbd.inventoryItems.retrieve(
+   *     '80000001-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   retrieve(
     id: string,
@@ -34,6 +55,18 @@ export class InventoryItems extends APIResource {
 
   /**
    * Updates an existing inventory item.
+   *
+   * @example
+   * ```ts
+   * const inventoryItem =
+   *   await client.qbd.inventoryItems.update(
+   *     '80000001-1234567890',
+   *     {
+   *       revisionNumber: '1721172183',
+   *       conductorEndUserId: 'end_usr_1234567abcdefg',
+   *     },
+   *   );
+   * ```
    */
   update(
     id: string,
@@ -51,6 +84,16 @@ export class InventoryItems extends APIResource {
   /**
    * Returns a list of inventory items. Use the `cursor` parameter to paginate
    * through the results.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const inventoryItem of client.qbd.inventoryItems.list(
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: InventoryItemListParams,

package/src/resources/qbd/inventory-sites.ts

@@ -6,6 +6,15 @@ import * as Core from '../../core';
 export class InventorySites extends APIResource {
   /**
    * Creates a new inventory site.
+   *
+   * @example
+   * ```ts
+   * const inventorySite =
+   *   await client.qbd.inventorySites.create({
+   *     name: 'Stockroom',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   });
+   * ```
    */
   create(params: InventorySiteCreateParams, options?: Core.RequestOptions): Core.APIPromise<InventorySite> {
     const { conductorEndUserId, ...body } = params;
@@ -18,6 +27,15 @@ export class InventorySites extends APIResource {
 
   /**
    * Retrieves an inventory site by ID.
+   *
+   * @example
+   * ```ts
+   * const inventorySite =
+   *   await client.qbd.inventorySites.retrieve(
+   *     '80000001-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   retrieve(
     id: string,
@@ -33,6 +51,18 @@ export class InventorySites extends APIResource {
 
   /**
    * Updates an existing inventory site.
+   *
+   * @example
+   * ```ts
+   * const inventorySite =
+   *   await client.qbd.inventorySites.update(
+   *     '80000001-1234567890',
+   *     {
+   *       revisionNumber: '1721172183',
+   *       conductorEndUserId: 'end_usr_1234567abcdefg',
+   *     },
+   *   );
+   * ```
    */
   update(
     id: string,
@@ -51,6 +81,13 @@ export class InventorySites extends APIResource {
    * Returns a list of inventory sites. NOTE: QuickBooks Desktop does not support
    * pagination for inventory sites; hence, there is no `cursor` parameter. Users
    * typically have few inventory sites.
+   *
+   * @example
+   * ```ts
+   * const inventorySites = await client.qbd.inventorySites.list(
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
    */
   list(
     params: InventorySiteListParams,

package/src/resources/qbd/invoices.ts

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

package/src/resources/qbd/item-groups.ts

@@ -7,6 +7,15 @@ import { CursorPage, type CursorPageParams } from '../../pagination';
 export class ItemGroups extends APIResource {
   /**
    * Creates a new item group.
+   *
+   * @example
+   * ```ts
+   * const itemGroup = await client.qbd.itemGroups.create({
+   *   name: 'Office Supplies Bundle',
+   *   shouldPrintItemsInGroup: true,
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * });
+   * ```
    */
   create(params: ItemGroupCreateParams, options?: Core.RequestOptions): Core.APIPromise<ItemGroup> {
     const { conductorEndUserId, ...body } = params;
@@ -19,6 +28,14 @@ export class ItemGroups extends APIResource {
 
   /**
    * Retrieves an item group by ID.
+   *
+   * @example
+   * ```ts
+   * const itemGroup = await client.qbd.itemGroups.retrieve(
+   *   '80000001-1234567890',
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
    */
   retrieve(
     id: string,
@@ -34,6 +51,17 @@ export class ItemGroups extends APIResource {
 
   /**
    * Updates an existing item group.
+   *
+   * @example
+   * ```ts
+   * const itemGroup = await client.qbd.itemGroups.update(
+   *   '80000001-1234567890',
+   *   {
+   *     revisionNumber: '1721172183',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   },
+   * );
+   * ```
    */
   update(
     id: string,
@@ -51,6 +79,16 @@ export class ItemGroups extends APIResource {
   /**
    * Returns a list of item groups. Use the `cursor` parameter to paginate through
    * the results.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const itemGroup of client.qbd.itemGroups.list({
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * })) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: ItemGroupListParams,

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

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

package/src/resources/qbd/item-sites.ts

@@ -7,6 +7,14 @@ import { CursorPage, type CursorPageParams } from '../../pagination';
 export class ItemSites extends APIResource {
   /**
    * Retrieves an item site by ID.
+   *
+   * @example
+   * ```ts
+   * const itemSite = await client.qbd.itemSites.retrieve(
+   *   '80000001-1234567890',
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
    */
   retrieve(
     id: string,
@@ -23,6 +31,16 @@ export class ItemSites extends APIResource {
   /**
    * Returns a list of item sites. Use the `cursor` parameter to paginate through the
    * results.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const itemSite of client.qbd.itemSites.list({
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * })) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: ItemSiteListParams,

package/src/resources/qbd/journal-entries.ts

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

package/src/resources/qbd/non-inventory-items.ts

@@ -7,6 +7,15 @@ import { CursorPage, type CursorPageParams } from '../../pagination';
 export class NonInventoryItems extends APIResource {
   /**
    * Creates a new non-inventory item.
+   *
+   * @example
+   * ```ts
+   * const nonInventoryItem =
+   *   await client.qbd.nonInventoryItems.create({
+   *     name: 'Printer Ink Cartridge',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   });
+   * ```
    */
   create(
     params: NonInventoryItemCreateParams,
@@ -22,6 +31,15 @@ export class NonInventoryItems extends APIResource {
 
   /**
    * Retrieves a non-inventory item by ID.
+   *
+   * @example
+   * ```ts
+   * const nonInventoryItem =
+   *   await client.qbd.nonInventoryItems.retrieve(
+   *     '80000001-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   retrieve(
     id: string,
@@ -37,6 +55,18 @@ export class NonInventoryItems extends APIResource {
 
   /**
    * Updates an existing non-inventory item.
+   *
+   * @example
+   * ```ts
+   * const nonInventoryItem =
+   *   await client.qbd.nonInventoryItems.update(
+   *     '80000001-1234567890',
+   *     {
+   *       revisionNumber: '1721172183',
+   *       conductorEndUserId: 'end_usr_1234567abcdefg',
+   *     },
+   *   );
+   * ```
    */
   update(
     id: string,
@@ -54,6 +84,16 @@ export class NonInventoryItems extends APIResource {
   /**
    * Returns a list of non-inventory items. Use the `cursor` parameter to paginate
    * through the results.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const nonInventoryItem of client.qbd.nonInventoryItems.list(
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: NonInventoryItemListParams,

package/src/resources/qbd/payroll-wage-items.ts

@@ -7,6 +7,17 @@ import { CursorPage, type CursorPageParams } from '../../pagination';
 export class PayrollWageItems extends APIResource {
   /**
    * Creates a new payroll wage item.
+   *
+   * @example
+   * ```ts
+   * const payrollWageItem =
+   *   await client.qbd.payrollWageItems.create({
+   *     expenseAccountId: '80000001-1234567890',
+   *     name: 'Regular Pay',
+   *     wageType: 'hourly_regular',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   });
+   * ```
    */
   create(
     params: PayrollWageItemCreateParams,
@@ -22,6 +33,15 @@ export class PayrollWageItems extends APIResource {
 
   /**
    * Retrieves a payroll wage item by ID.
+   *
+   * @example
+   * ```ts
+   * const payrollWageItem =
+   *   await client.qbd.payrollWageItems.retrieve(
+   *     '80000001-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   retrieve(
     id: string,
@@ -38,6 +58,16 @@ export class PayrollWageItems extends APIResource {
   /**
    * Returns a list of payroll wage items. Use the `cursor` parameter to paginate
    * through the results.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const payrollWageItem of client.qbd.payrollWageItems.list(
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: PayrollWageItemListParams,

package/src/resources/qbd/preferences.ts

@@ -8,6 +8,13 @@ export class Preferences extends APIResource {
    * Returns the preferences that the QuickBooks administrator has set for all users
    * of the connected company file. Note that preferences cannot be modified through
    * the API, only through the QuickBooks Desktop user interface.
+   *
+   * @example
+   * ```ts
+   * const preferences = await client.qbd.preferences.retrieve({
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * });
+   * ```
    */
   retrieve(params: PreferenceRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<Preferences> {
     const { conductorEndUserId } = params;