conductor-node 12.4.0 → 12.5.1

package/resources/qbd/vendors.js

@@ -7,6 +7,14 @@ const pagination_1 = require("../../pagination.js");
 class Vendors extends resource_1.APIResource {
     /**
      * Creates a new vendor.
+     *
+     * @example
+     * ```ts
+     * const vendor = await client.qbd.vendors.create({
+     *   name: 'Acme Supplies Inc.',
+     *   conductorEndUserId: 'end_usr_1234567abcdefg',
+     * });
+     * ```
      */
     create(params, options) {
         const { conductorEndUserId, ...body } = params;
@@ -18,6 +26,14 @@ class Vendors extends resource_1.APIResource {
     }
     /**
      * Retrieves a vendor by ID.
+     *
+     * @example
+     * ```ts
+     * const vendor = await client.qbd.vendors.retrieve(
+     *   '80000001-1234567890',
+     *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+     * );
+     * ```
      */
     retrieve(id, params, options) {
         const { conductorEndUserId } = params;
@@ -28,6 +44,17 @@ class Vendors extends resource_1.APIResource {
     }
     /**
      * Updates an existing vendor.
+     *
+     * @example
+     * ```ts
+     * const vendor = await client.qbd.vendors.update(
+     *   '80000001-1234567890',
+     *   {
+     *     revisionNumber: '1721172183',
+     *     conductorEndUserId: 'end_usr_1234567abcdefg',
+     *   },
+     * );
+     * ```
      */
     update(id, params, options) {
         const { conductorEndUserId, ...body } = params;
@@ -40,6 +67,16 @@ class Vendors extends resource_1.APIResource {
     /**
      * Returns a list of vendors. Use the `cursor` parameter to paginate through the
      * results.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const vendor of client.qbd.vendors.list({
+     *   conductorEndUserId: 'end_usr_1234567abcdefg',
+     * })) {
+     *   // ...
+     * }
+     * ```
      */
     list(params, options) {
         const { conductorEndUserId, ...query } = params;

package/resources/qbd/vendors.js.map

@@ -1 +1 @@
-{"version":3,"file":"vendors.js","sourceRoot":"","sources":["../../src/resources/qbd/vendors.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAE7C,oDAAqE;AAErE,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;OAEG;IACH,MAAM,CAAC,MAA0B,EAAE,OAA6B;QAC9D,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE;YACtD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,MAA4B,EAAE,OAA6B;QAC9E,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,EAAE;YAC3D,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,MAA0B,EAAE,OAA6B;QAC1E,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,EAAE;YAC5D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,MAAwB,EAAE,OAA6B;QAC1D,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,6BAA6B,EAAE,iBAAiB,EAAE;YAC/E,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;CACF;AAhDD,0BAgDC;AAED,MAAa,iBAAkB,SAAQ,uBAAkB;CAAG;AAA5D,8CAA4D;AA65D5D,OAAO,CAAC,iBAAiB,GAAG,iBAAiB,CAAC"}
+{"version":3,"file":"vendors.js","sourceRoot":"","sources":["../../src/resources/qbd/vendors.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAE7C,oDAAqE;AAErE,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAA0B,EAAE,OAA6B;QAC9D,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE;YACtD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU,EAAE,MAA4B,EAAE,OAA6B;QAC9E,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,EAAE;YAC3D,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAU,EAAE,MAA0B,EAAE,OAA6B;QAC1E,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,EAAE;YAC5D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,MAAwB,EAAE,OAA6B;QAC1D,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,6BAA6B,EAAE,iBAAiB,EAAE;YAC/E,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;CACF;AArFD,0BAqFC;AAED,MAAa,iBAAkB,SAAQ,uBAAkB;CAAG;AAA5D,8CAA4D;AA65D5D,OAAO,CAAC,iBAAiB,GAAG,iBAAiB,CAAC"}

package/resources/qbd/vendors.mjs

@@ -4,6 +4,14 @@ import { CursorPage } from "../../pagination.mjs";
 export class Vendors extends APIResource {
     /**
      * Creates a new vendor.
+     *
+     * @example
+     * ```ts
+     * const vendor = await client.qbd.vendors.create({
+     *   name: 'Acme Supplies Inc.',
+     *   conductorEndUserId: 'end_usr_1234567abcdefg',
+     * });
+     * ```
      */
     create(params, options) {
         const { conductorEndUserId, ...body } = params;
@@ -15,6 +23,14 @@ export class Vendors extends APIResource {
     }
     /**
      * Retrieves a vendor by ID.
+     *
+     * @example
+     * ```ts
+     * const vendor = await client.qbd.vendors.retrieve(
+     *   '80000001-1234567890',
+     *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+     * );
+     * ```
      */
     retrieve(id, params, options) {
         const { conductorEndUserId } = params;
@@ -25,6 +41,17 @@ export class Vendors extends APIResource {
     }
     /**
      * Updates an existing vendor.
+     *
+     * @example
+     * ```ts
+     * const vendor = await client.qbd.vendors.update(
+     *   '80000001-1234567890',
+     *   {
+     *     revisionNumber: '1721172183',
+     *     conductorEndUserId: 'end_usr_1234567abcdefg',
+     *   },
+     * );
+     * ```
      */
     update(id, params, options) {
         const { conductorEndUserId, ...body } = params;
@@ -37,6 +64,16 @@ export class Vendors extends APIResource {
     /**
      * Returns a list of vendors. Use the `cursor` parameter to paginate through the
      * results.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const vendor of client.qbd.vendors.list({
+     *   conductorEndUserId: 'end_usr_1234567abcdefg',
+     * })) {
+     *   // ...
+     * }
+     * ```
      */
     list(params, options) {
         const { conductorEndUserId, ...query } = params;

package/resources/qbd/vendors.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"vendors.mjs","sourceRoot":"","sources":["../../src/resources/qbd/vendors.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,UAAU,EAAyB;AAE5C,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,MAAM,CAAC,MAA0B,EAAE,OAA6B;QAC9D,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE;YACtD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,MAA4B,EAAE,OAA6B;QAC9E,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,EAAE;YAC3D,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,MAA0B,EAAE,OAA6B;QAC1E,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,EAAE;YAC5D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,MAAwB,EAAE,OAA6B;QAC1D,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,6BAA6B,EAAE,iBAAiB,EAAE;YAC/E,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,iBAAkB,SAAQ,UAAkB;CAAG;AA65D5D,OAAO,CAAC,iBAAiB,GAAG,iBAAiB,CAAC"}
+{"version":3,"file":"vendors.mjs","sourceRoot":"","sources":["../../src/resources/qbd/vendors.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,UAAU,EAAyB;AAE5C,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAA0B,EAAE,OAA6B;QAC9D,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE;YACtD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU,EAAE,MAA4B,EAAE,OAA6B;QAC9E,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,EAAE;YAC3D,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAU,EAAE,MAA0B,EAAE,OAA6B;QAC1E,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,EAAE;YAC5D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,MAAwB,EAAE,OAA6B;QAC1D,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,6BAA6B,EAAE,iBAAiB,EAAE;YAC/E,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,iBAAkB,SAAQ,UAAkB;CAAG;AA65D5D,OAAO,CAAC,iBAAiB,GAAG,iBAAiB,CAAC"}

package/src/resources/auth-sessions.ts

@@ -8,6 +8,14 @@ export class AuthSessions extends APIResource {
    * To launch the authentication flow, create an auth session and pass the returned
    * session's `authFlowUrl` to the client for your end-user to visit in their
    * browser. Demo: https://connect.conductor.is/qbd/demo
+   *
+   * @example
+   * ```ts
+   * const authSession = await client.authSessions.create({
+   *   endUserId: 'end_usr_1234567abcdefg',
+   *   publishableKey: '{{YOUR_PUBLISHABLE_KEY}}',
+   * });
+   * ```
    */
   create(body: AuthSessionCreateParams, options?: Core.RequestOptions): Core.APIPromise<AuthSession> {
     return this._client.post('/auth-sessions', { body, ...options });

package/src/resources/end-users.ts

@@ -7,6 +7,15 @@ import * as Core from '../core';
 export class EndUsers extends APIResource {
   /**
    * Creates an end-user.
+   *
+   * @example
+   * ```ts
+   * const endUser = await client.endUsers.create({
+   *   companyName: 'Acme Inc.',
+   *   email: 'alice@acme.com',
+   *   sourceId: '12345678-abcd-abcd-example-1234567890ab',
+   * });
+   * ```
    */
   create(body: EndUserCreateParams, options?: Core.RequestOptions): Core.APIPromise<EndUser> {
     return this._client.post('/end-users', { body, ...options });
@@ -14,6 +23,13 @@ export class EndUsers extends APIResource {
 
   /**
    * Retrieves an end-user object.
+   *
+   * @example
+   * ```ts
+   * const endUser = await client.endUsers.retrieve(
+   *   'end_usr_1234567abcdefg',
+   * );
+   * ```
    */
   retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<EndUser> {
     return this._client.get(`/end-users/${id}`, options);
@@ -21,6 +37,11 @@ export class EndUsers extends APIResource {
 
   /**
    * Returns a list of your end-users.
+   *
+   * @example
+   * ```ts
+   * const endUsers = await client.endUsers.list();
+   * ```
    */
   list(options?: Core.RequestOptions): Core.APIPromise<EndUserListResponse> {
     return this._client.get('/end-users', options);
@@ -28,6 +49,13 @@ export class EndUsers extends APIResource {
 
   /**
    * Permanently deletes an end-user object and all of its connections.
+   *
+   * @example
+   * ```ts
+   * const endUser = await client.endUsers.delete(
+   *   'end_usr_1234567abcdefg',
+   * );
+   * ```
    */
   delete(id: string, options?: Core.RequestOptions): Core.APIPromise<EndUserDeleteResponse> {
     return this._client.delete(`/end-users/${id}`, options);
@@ -36,6 +64,15 @@ export class EndUsers extends APIResource {
   /**
    * Sends a request directly to the specified integration connection (e.g.,
    * QuickBooks Desktop) on behalf of the end-user.
+   *
+   * @example
+   * ```ts
+   * const response = await client.endUsers.passthrough(
+   *   'end_usr_1234567abcdefg',
+   *   'quickbooks_desktop',
+   *   { foo: 'bar' },
+   * );
+   * ```
    */
   passthrough(
     id: string,

package/src/resources/qbd/account-tax-lines.ts

@@ -8,6 +8,14 @@ export class AccountTaxLines extends APIResource {
    * Returns a list of account tax lines. NOTE: QuickBooks Desktop does not support
    * pagination for account tax lines; hence, there is no `cursor` parameter. Users
    * typically have few account tax lines.
+   *
+   * @example
+   * ```ts
+   * const accountTaxLines =
+   *   await client.qbd.accountTaxLines.list({
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   });
+   * ```
    */
   list(
     params: AccountTaxLineListParams,

package/src/resources/qbd/accounts.ts

@@ -6,6 +6,15 @@ import * as Core from '../../core';
 export class Accounts extends APIResource {
   /**
    * Creates a new financial account.
+   *
+   * @example
+   * ```ts
+   * const account = await client.qbd.accounts.create({
+   *   accountType: 'bank',
+   *   name: 'Accounts-Payable',
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * });
+   * ```
    */
   create(params: AccountCreateParams, options?: Core.RequestOptions): Core.APIPromise<Account> {
     const { conductorEndUserId, ...body } = params;
@@ -18,6 +27,14 @@ export class Accounts extends APIResource {
 
   /**
    * Retrieves an account by ID.
+   *
+   * @example
+   * ```ts
+   * const account = await client.qbd.accounts.retrieve(
+   *   '80000001-1234567890',
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
    */
   retrieve(
     id: string,
@@ -33,6 +50,17 @@ export class Accounts extends APIResource {
 
   /**
    * Updates an existing financial account.
+   *
+   * @example
+   * ```ts
+   * const account = await client.qbd.accounts.update(
+   *   '80000001-1234567890',
+   *   {
+   *     revisionNumber: '1721172183',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   },
+   * );
+   * ```
    */
   update(id: string, params: AccountUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Account> {
     const { conductorEndUserId, ...body } = params;
@@ -47,6 +75,13 @@ export class Accounts extends APIResource {
    * Returns a list of accounts. NOTE: QuickBooks Desktop does not support pagination
    * for accounts; hence, there is no `cursor` parameter. Users typically have few
    * accounts.
+   *
+   * @example
+   * ```ts
+   * const accounts = await client.qbd.accounts.list({
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * });
+   * ```
    */
   list(params: AccountListParams, options?: Core.RequestOptions): Core.APIPromise<AccountListResponse> {
     const { conductorEndUserId, ...query } = params;

package/src/resources/qbd/bill-check-payments.ts

@@ -7,6 +7,20 @@ import { CursorPage, type CursorPageParams } from '../../pagination';
 export class BillCheckPayments extends APIResource {
   /**
    * Creates a new bill check payment.
+   *
+   * @example
+   * ```ts
+   * const billCheckPayment =
+   *   await client.qbd.billCheckPayments.create({
+   *     applyToTransactions: [
+   *       { transactionId: '123ABC-1234567890' },
+   *     ],
+   *     bankAccountId: '80000001-1234567890',
+   *     transactionDate: '2021-10-01',
+   *     vendorId: '80000001-1234567890',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   });
+   * ```
    */
   create(
     params: BillCheckPaymentCreateParams,
@@ -22,6 +36,15 @@ export class BillCheckPayments extends APIResource {
 
   /**
    * Retrieves a bill check payment by ID.
+   *
+   * @example
+   * ```ts
+   * const billCheckPayment =
+   *   await client.qbd.billCheckPayments.retrieve(
+   *     '123ABC-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   retrieve(
     id: string,
@@ -37,6 +60,18 @@ export class BillCheckPayments extends APIResource {
 
   /**
    * Updates an existing bill check payment.
+   *
+   * @example
+   * ```ts
+   * const billCheckPayment =
+   *   await client.qbd.billCheckPayments.update(
+   *     '123ABC-1234567890',
+   *     {
+   *       revisionNumber: '1721172183',
+   *       conductorEndUserId: 'end_usr_1234567abcdefg',
+   *     },
+   *   );
+   * ```
    */
   update(
     id: string,
@@ -54,6 +89,16 @@ export class BillCheckPayments extends APIResource {
   /**
    * Returns a list of bill check payments. Use the `cursor` parameter to paginate
    * through the results.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const billCheckPayment of client.qbd.billCheckPayments.list(
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: BillCheckPaymentListParams,
@@ -71,6 +116,15 @@ export class BillCheckPayments extends APIResource {
    * Permanently deletes a a bill check payment. The deletion will fail if the bill
    * check payment is currently in use or has any linked transactions that are in
    * use.
+   *
+   * @example
+   * ```ts
+   * const billCheckPayment =
+   *   await client.qbd.billCheckPayments.delete(
+   *     '123ABC-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   delete(
     id: string,

package/src/resources/qbd/bill-credit-card-payments.ts

@@ -7,6 +7,20 @@ import { CursorPage, type CursorPageParams } from '../../pagination';
 export class BillCreditCardPayments extends APIResource {
   /**
    * Creates a new bill credit card payment.
+   *
+   * @example
+   * ```ts
+   * const billCreditCardPayment =
+   *   await client.qbd.billCreditCardPayments.create({
+   *     applyToTransactions: [
+   *       { transactionId: '123ABC-1234567890' },
+   *     ],
+   *     creditCardAccountId: '80000001-1234567890',
+   *     transactionDate: '2021-10-01',
+   *     vendorId: '80000001-1234567890',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   });
+   * ```
    */
   create(
     params: BillCreditCardPaymentCreateParams,
@@ -22,6 +36,15 @@ export class BillCreditCardPayments extends APIResource {
 
   /**
    * Retrieves a bill credit card payment by ID.
+   *
+   * @example
+   * ```ts
+   * const billCreditCardPayment =
+   *   await client.qbd.billCreditCardPayments.retrieve(
+   *     '123ABC-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   retrieve(
     id: string,
@@ -38,6 +61,16 @@ export class BillCreditCardPayments extends APIResource {
   /**
    * Returns a list of bill credit card payments. Use the `cursor` parameter to
    * paginate through the results.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const billCreditCardPayment of client.qbd.billCreditCardPayments.list(
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: BillCreditCardPaymentListParams,
@@ -55,6 +88,15 @@ export class BillCreditCardPayments extends APIResource {
    * Permanently deletes a a bill credit card payment. The deletion will fail if the
    * bill credit card payment is currently in use or has any linked transactions that
    * are in use.
+   *
+   * @example
+   * ```ts
+   * const billCreditCardPayment =
+   *   await client.qbd.billCreditCardPayments.delete(
+   *     '123ABC-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   delete(
     id: string,

package/src/resources/qbd/bills.ts

@@ -7,6 +7,15 @@ import { CursorPage, type CursorPageParams } from '../../pagination';
 export class Bills extends APIResource {
   /**
    * Creates a new bill.
+   *
+   * @example
+   * ```ts
+   * const bill = await client.qbd.bills.create({
+   *   transactionDate: '2021-10-01',
+   *   vendorId: '80000001-1234567890',
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * });
+   * ```
    */
   create(params: BillCreateParams, options?: Core.RequestOptions): Core.APIPromise<Bill> {
     const { conductorEndUserId, ...body } = params;
@@ -19,6 +28,14 @@ export class Bills extends APIResource {
 
   /**
    * Retrieves a bill by ID.
+   *
+   * @example
+   * ```ts
+   * const bill = await client.qbd.bills.retrieve(
+   *   '123ABC-1234567890',
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
    */
   retrieve(id: string, params: BillRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<Bill> {
     const { conductorEndUserId } = params;
@@ -30,6 +47,17 @@ export class Bills extends APIResource {
 
   /**
    * Updates an existing bill.
+   *
+   * @example
+   * ```ts
+   * const bill = await client.qbd.bills.update(
+   *   '123ABC-1234567890',
+   *   {
+   *     revisionNumber: '1721172183',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   },
+   * );
+   * ```
    */
   update(id: string, params: BillUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Bill> {
     const { conductorEndUserId, ...body } = params;
@@ -43,6 +71,16 @@ export class Bills extends APIResource {
   /**
    * Returns a list of bills. Use the `cursor` parameter to paginate through the
    * results.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const bill of client.qbd.bills.list({
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * })) {
+   *   // ...
+   * }
+   * ```
    */
   list(params: BillListParams, options?: Core.RequestOptions): Core.PagePromise<BillsCursorPage, Bill> {
     const { conductorEndUserId, ...query } = params;
@@ -56,6 +94,14 @@ export class Bills extends APIResource {
   /**
    * Permanently deletes a a bill. The deletion will fail if the bill is currently in
    * use or has any linked transactions that are in use.
+   *
+   * @example
+   * ```ts
+   * const bill = await client.qbd.bills.delete(
+   *   '123ABC-1234567890',
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
    */
   delete(
     id: string,

package/src/resources/qbd/checks.ts

@@ -7,6 +7,15 @@ import { CursorPage, type CursorPageParams } from '../../pagination';
 export class Checks extends APIResource {
   /**
    * Creates a new check.
+   *
+   * @example
+   * ```ts
+   * const check = await client.qbd.checks.create({
+   *   bankAccountId: '80000001-1234567890',
+   *   transactionDate: '2021-10-01',
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * });
+   * ```
    */
   create(params: CheckCreateParams, options?: Core.RequestOptions): Core.APIPromise<Check> {
     const { conductorEndUserId, ...body } = params;
@@ -19,6 +28,14 @@ export class Checks extends APIResource {
 
   /**
    * Retrieves a check by ID.
+   *
+   * @example
+   * ```ts
+   * const check = await client.qbd.checks.retrieve(
+   *   '123ABC-1234567890',
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
    */
   retrieve(id: string, params: CheckRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<Check> {
     const { conductorEndUserId } = params;
@@ -30,6 +47,17 @@ export class Checks extends APIResource {
 
   /**
    * Updates an existing check.
+   *
+   * @example
+   * ```ts
+   * const check = await client.qbd.checks.update(
+   *   '123ABC-1234567890',
+   *   {
+   *     revisionNumber: '1721172183',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   },
+   * );
+   * ```
    */
   update(id: string, params: CheckUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Check> {
     const { conductorEndUserId, ...body } = params;
@@ -43,6 +71,16 @@ export class Checks extends APIResource {
   /**
    * Returns a list of checks. Use the `cursor` parameter to paginate through the
    * results.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const check of client.qbd.checks.list({
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * })) {
+   *   // ...
+   * }
+   * ```
    */
   list(params: CheckListParams, options?: Core.RequestOptions): Core.PagePromise<ChecksCursorPage, Check> {
     const { conductorEndUserId, ...query } = params;
@@ -56,6 +94,14 @@ export class Checks extends APIResource {
   /**
    * Permanently deletes a a check. The deletion will fail if the check is currently
    * in use or has any linked transactions that are in use.
+   *
+   * @example
+   * ```ts
+   * const check = await client.qbd.checks.delete(
+   *   '123ABC-1234567890',
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
    */
   delete(
     id: string,

package/src/resources/qbd/classes.ts

@@ -6,6 +6,14 @@ import * as Core from '../../core';
 export class Classes extends APIResource {
   /**
    * Creates a new class.
+   *
+   * @example
+   * ```ts
+   * const _class = await client.qbd.classes.create({
+   *   name: 'Marketing',
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * });
+   * ```
    */
   create(params: ClassCreateParams, options?: Core.RequestOptions): Core.APIPromise<Class> {
     const { conductorEndUserId, ...body } = params;
@@ -18,6 +26,14 @@ export class Classes extends APIResource {
 
   /**
    * Retrieves a class by ID.
+   *
+   * @example
+   * ```ts
+   * const _class = await client.qbd.classes.retrieve(
+   *   '80000001-1234567890',
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
    */
   retrieve(id: string, params: ClassRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<Class> {
     const { conductorEndUserId } = params;
@@ -29,6 +45,17 @@ export class Classes extends APIResource {
 
   /**
    * Updates an existing class.
+   *
+   * @example
+   * ```ts
+   * const _class = await client.qbd.classes.update(
+   *   '80000001-1234567890',
+   *   {
+   *     revisionNumber: '1721172183',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   },
+   * );
+   * ```
    */
   update(id: string, params: ClassUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Class> {
     const { conductorEndUserId, ...body } = params;
@@ -43,6 +70,13 @@ export class Classes extends APIResource {
    * Returns a list of classes. NOTE: QuickBooks Desktop does not support pagination
    * for classes; hence, there is no `cursor` parameter. Users typically have few
    * classes.
+   *
+   * @example
+   * ```ts
+   * const classes = await client.qbd.classes.list({
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * });
+   * ```
    */
   list(params: ClassListParams, options?: Core.RequestOptions): Core.APIPromise<ClassListResponse> {
     const { conductorEndUserId, ...query } = params;