conductor-node 12.5.0 → 12.6.0

package/src/resources/qbd/company.ts

@@ -9,6 +9,13 @@ export class CompanyResource extends APIResource {
    * including company address, legal name, preferences, and subscribed services.
    * Note that company information cannot be modified through the API, only through
    * the QuickBooks Desktop user interface.
+   *
+   * @example
+   * ```ts
+   * const company = await client.qbd.company.retrieve({
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * });
+   * ```
    */
   retrieve(params: CompanyRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<Company> {
     const { conductorEndUserId } = params;

package/src/resources/qbd/credit-card-charges.ts

@@ -7,6 +7,16 @@ import { CursorPage, type CursorPageParams } from '../../pagination';
 export class CreditCardCharges extends APIResource {
   /**
    * Creates a new credit card charge for the specified account.
+   *
+   * @example
+   * ```ts
+   * const creditCardCharge =
+   *   await client.qbd.creditCardCharges.create({
+   *     accountId: '80000001-1234567890',
+   *     transactionDate: '2021-10-01',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   });
+   * ```
    */
   create(
     params: CreditCardChargeCreateParams,
@@ -22,6 +32,15 @@ export class CreditCardCharges extends APIResource {
 
   /**
    * Retrieves a credit card charge by ID.
+   *
+   * @example
+   * ```ts
+   * const creditCardCharge =
+   *   await client.qbd.creditCardCharges.retrieve(
+   *     '123ABC-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   retrieve(
     id: string,
@@ -37,6 +56,18 @@ export class CreditCardCharges extends APIResource {
 
   /**
    * Updates an existing credit card charge.
+   *
+   * @example
+   * ```ts
+   * const creditCardCharge =
+   *   await client.qbd.creditCardCharges.update(
+   *     '123ABC-1234567890',
+   *     {
+   *       revisionNumber: '1721172183',
+   *       conductorEndUserId: 'end_usr_1234567abcdefg',
+   *     },
+   *   );
+   * ```
    */
   update(
     id: string,
@@ -54,6 +85,16 @@ export class CreditCardCharges extends APIResource {
   /**
    * Returns a list of credit card charges. Use the `cursor` parameter to paginate
    * through the results.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const creditCardCharge of client.qbd.creditCardCharges.list(
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: CreditCardChargeListParams,
@@ -70,6 +111,15 @@ export class CreditCardCharges extends APIResource {
   /**
    * Permanently deletes a a credit card charge. The deletion will fail if the credit
    * card charge is currently in use or has any linked transactions that are in use.
+   *
+   * @example
+   * ```ts
+   * const creditCardCharge =
+   *   await client.qbd.creditCardCharges.delete(
+   *     '123ABC-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   delete(
     id: string,

package/src/resources/qbd/credit-card-credits.ts

@@ -7,6 +7,16 @@ import { CursorPage, type CursorPageParams } from '../../pagination';
 export class CreditCardCredits extends APIResource {
   /**
    * Creates a new credit card credit for the specified account.
+   *
+   * @example
+   * ```ts
+   * const creditCardCredit =
+   *   await client.qbd.creditCardCredits.create({
+   *     accountId: '80000001-1234567890',
+   *     transactionDate: '2021-10-01',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   });
+   * ```
    */
   create(
     params: CreditCardCreditCreateParams,
@@ -22,6 +32,15 @@ export class CreditCardCredits extends APIResource {
 
   /**
    * Retrieves a credit card credit by ID.
+   *
+   * @example
+   * ```ts
+   * const creditCardCredit =
+   *   await client.qbd.creditCardCredits.retrieve(
+   *     '123ABC-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   retrieve(
     id: string,
@@ -37,6 +56,18 @@ export class CreditCardCredits extends APIResource {
 
   /**
    * Updates an existing credit card credit.
+   *
+   * @example
+   * ```ts
+   * const creditCardCredit =
+   *   await client.qbd.creditCardCredits.update(
+   *     '123ABC-1234567890',
+   *     {
+   *       revisionNumber: '1721172183',
+   *       conductorEndUserId: 'end_usr_1234567abcdefg',
+   *     },
+   *   );
+   * ```
    */
   update(
     id: string,
@@ -54,6 +85,16 @@ export class CreditCardCredits extends APIResource {
   /**
    * Returns a list of credit card credits. Use the `cursor` parameter to paginate
    * through the results.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const creditCardCredit of client.qbd.creditCardCredits.list(
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: CreditCardCreditListParams,
@@ -70,6 +111,15 @@ export class CreditCardCredits extends APIResource {
   /**
    * Permanently deletes a a credit card credit. The deletion will fail if the credit
    * card credit is currently in use or has any linked transactions that are in use.
+   *
+   * @example
+   * ```ts
+   * const creditCardCredit =
+   *   await client.qbd.creditCardCredits.delete(
+   *     '123ABC-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   delete(
     id: string,

package/src/resources/qbd/credit-memos.ts

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

package/src/resources/qbd/customers.ts

@@ -7,6 +7,14 @@ import { CursorPage, type CursorPageParams } from '../../pagination';
 export class Customers extends APIResource {
   /**
    * Creates a new customer.
+   *
+   * @example
+   * ```ts
+   * const customer = await client.qbd.customers.create({
+   *   name: 'Website Redesign Project',
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * });
+   * ```
    */
   create(params: CustomerCreateParams, options?: Core.RequestOptions): Core.APIPromise<Customer> {
     const { conductorEndUserId, ...body } = params;
@@ -19,6 +27,14 @@ export class Customers extends APIResource {
 
   /**
    * Retrieves a customer by ID.
+   *
+   * @example
+   * ```ts
+   * const customer = await client.qbd.customers.retrieve(
+   *   '80000001-1234567890',
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
    */
   retrieve(
     id: string,
@@ -34,6 +50,17 @@ export class Customers extends APIResource {
 
   /**
    * Updates an existing customer.
+   *
+   * @example
+   * ```ts
+   * const customer = await client.qbd.customers.update(
+   *   '80000001-1234567890',
+   *   {
+   *     revisionNumber: '1721172183',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   },
+   * );
+   * ```
    */
   update(id: string, params: CustomerUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Customer> {
     const { conductorEndUserId, ...body } = params;
@@ -47,6 +74,16 @@ export class Customers extends APIResource {
   /**
    * Returns a list of customers. Use the `cursor` parameter to paginate through the
    * results.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const customer of client.qbd.customers.list({
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * })) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: CustomerListParams,
@@ -509,7 +546,7 @@ export namespace Customer {
       /**
        * The value of the contact field.
        */
-      value: string;
+      value: string | null;
     }
   }
 
@@ -742,7 +779,7 @@ export namespace Customer {
     /**
      * The value of the contact field.
      */
-    value: string;
+    value: string | null;
   }
 
   /**

package/src/resources/qbd/date-driven-terms.ts

@@ -6,6 +6,16 @@ import * as Core from '../../core';
 export class DateDrivenTerms extends APIResource {
   /**
    * Creates a new date-driven term.
+   *
+   * @example
+   * ```ts
+   * const dateDrivenTerm =
+   *   await client.qbd.dateDrivenTerms.create({
+   *     dueDayOfMonth: 15,
+   *     name: '2% 5th Net 25th',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   });
+   * ```
    */
   create(params: DateDrivenTermCreateParams, options?: Core.RequestOptions): Core.APIPromise<DateDrivenTerm> {
     const { conductorEndUserId, ...body } = params;
@@ -18,6 +28,15 @@ export class DateDrivenTerms extends APIResource {
 
   /**
    * Retrieves a date-driven term by ID.
+   *
+   * @example
+   * ```ts
+   * const dateDrivenTerm =
+   *   await client.qbd.dateDrivenTerms.retrieve(
+   *     '80000001-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   retrieve(
     id: string,
@@ -35,6 +54,14 @@ export class DateDrivenTerms extends APIResource {
    * Returns a list of date-driven terms. NOTE: QuickBooks Desktop does not support
    * pagination for date-driven terms; hence, there is no `cursor` parameter. Users
    * typically have few date-driven terms.
+   *
+   * @example
+   * ```ts
+   * const dateDrivenTerms =
+   *   await client.qbd.dateDrivenTerms.list({
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   });
+   * ```
    */
   list(
     params: DateDrivenTermListParams,

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

@@ -7,6 +7,15 @@ import { CursorPage, type CursorPageParams } from '../../pagination';
 export class DiscountItems extends APIResource {
   /**
    * Creates a new discount item.
+   *
+   * @example
+   * ```ts
+   * const discountItem = await client.qbd.discountItems.create({
+   *   accountId: '80000001-1234567890',
+   *   name: '10% labor discount',
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * });
+   * ```
    */
   create(params: DiscountItemCreateParams, options?: Core.RequestOptions): Core.APIPromise<DiscountItem> {
     const { conductorEndUserId, ...body } = params;
@@ -19,6 +28,15 @@ export class DiscountItems extends APIResource {
 
   /**
    * Retrieves a discount item by ID.
+   *
+   * @example
+   * ```ts
+   * const discountItem =
+   *   await client.qbd.discountItems.retrieve(
+   *     '80000001-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   retrieve(
     id: string,
@@ -34,6 +52,17 @@ export class DiscountItems extends APIResource {
 
   /**
    * Updates an existing discount item.
+   *
+   * @example
+   * ```ts
+   * const discountItem = await client.qbd.discountItems.update(
+   *   '80000001-1234567890',
+   *   {
+   *     revisionNumber: '1721172183',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   },
+   * );
+   * ```
    */
   update(
     id: string,
@@ -51,6 +80,16 @@ export class DiscountItems extends APIResource {
   /**
    * Returns a list of discount items. Use the `cursor` parameter to paginate through
    * the results.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const discountItem of client.qbd.discountItems.list(
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: DiscountItemListParams,

package/src/resources/qbd/employees.ts

@@ -7,6 +7,13 @@ import { CursorPage, type CursorPageParams } from '../../pagination';
 export class Employees extends APIResource {
   /**
    * Creates a new employee.
+   *
+   * @example
+   * ```ts
+   * const employee = await client.qbd.employees.create({
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * });
+   * ```
    */
   create(params: EmployeeCreateParams, options?: Core.RequestOptions): Core.APIPromise<Employee> {
     const { conductorEndUserId, ...body } = params;
@@ -19,6 +26,14 @@ export class Employees extends APIResource {
 
   /**
    * Retrieves an employee by ID.
+   *
+   * @example
+   * ```ts
+   * const employee = await client.qbd.employees.retrieve(
+   *   '80000001-1234567890',
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
    */
   retrieve(
     id: string,
@@ -34,6 +49,17 @@ export class Employees extends APIResource {
 
   /**
    * Updates an existing employee.
+   *
+   * @example
+   * ```ts
+   * const employee = await client.qbd.employees.update(
+   *   '80000001-1234567890',
+   *   {
+   *     revisionNumber: '1721172183',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   },
+   * );
+   * ```
    */
   update(id: string, params: EmployeeUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Employee> {
     const { conductorEndUserId, ...body } = params;
@@ -47,6 +73,16 @@ export class Employees extends APIResource {
   /**
    * Returns a list of employees. Use the `cursor` parameter to paginate through the
    * results.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const employee of client.qbd.employees.list({
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * })) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: EmployeeListParams,
@@ -487,7 +523,7 @@ export namespace Employee {
     /**
      * The value of the contact field.
      */
-    value: string;
+    value: string | null;
   }
 
   export interface CustomField {
@@ -572,7 +608,7 @@ export namespace Employee {
       /**
        * The value of the contact field.
        */
-      value: string;
+      value: string | null;
     }
 
     /**
@@ -603,7 +639,7 @@ export namespace Employee {
       /**
        * The value of the contact field.
        */
-      value: string;
+      value: string | null;
     }
   }
 

package/src/resources/qbd/estimates.ts

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

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

@@ -6,6 +6,16 @@ import * as Core from '../../core';
 export class InventoryAdjustments extends APIResource {
   /**
    * Creates a new inventory adjustment.
+   *
+   * @example
+   * ```ts
+   * const inventoryAdjustment =
+   *   await client.qbd.inventoryAdjustments.create({
+   *     accountId: '80000001-1234567890',
+   *     transactionDate: '2021-10-01',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   });
+   * ```
    */
   create(
     params: InventoryAdjustmentCreateParams,
@@ -21,6 +31,15 @@ export class InventoryAdjustments extends APIResource {
 
   /**
    * Retrieves an inventory adjustment by ID.
+   *
+   * @example
+   * ```ts
+   * const inventoryAdjustment =
+   *   await client.qbd.inventoryAdjustments.retrieve(
+   *     '123ABC-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   retrieve(
     id: string,
@@ -36,6 +55,18 @@ export class InventoryAdjustments extends APIResource {
 
   /**
    * Updates an existing inventory adjustment.
+   *
+   * @example
+   * ```ts
+   * const inventoryAdjustment =
+   *   await client.qbd.inventoryAdjustments.update(
+   *     '123ABC-1234567890',
+   *     {
+   *       revisionNumber: '1721172183',
+   *       conductorEndUserId: 'end_usr_1234567abcdefg',
+   *     },
+   *   );
+   * ```
    */
   update(
     id: string,
@@ -54,6 +85,14 @@ export class InventoryAdjustments extends APIResource {
    * Returns a list of inventory adjustments. NOTE: QuickBooks Desktop does not
    * support pagination for inventory adjustments; hence, there is no `cursor`
    * parameter. Users typically have few inventory adjustments.
+   *
+   * @example
+   * ```ts
+   * const inventoryAdjustments =
+   *   await client.qbd.inventoryAdjustments.list({
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   });
+   * ```
    */
   list(
     params: InventoryAdjustmentListParams,
@@ -71,6 +110,15 @@ export class InventoryAdjustments extends APIResource {
    * Permanently deletes a an inventory adjustment. The deletion will fail if the
    * inventory adjustment is currently in use or has any linked transactions that are
    * in use.
+   *
+   * @example
+   * ```ts
+   * const inventoryAdjustment =
+   *   await client.qbd.inventoryAdjustments.delete(
+   *     '123ABC-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   delete(
     id: string,