conductor-node 12.4.0 → 12.5.1

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

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

package/src/resources/qbd/time-tracking-activities.ts

@@ -7,6 +7,17 @@ import { CursorPage, type CursorPageParams } from '../../pagination';
 export class TimeTrackingActivities extends APIResource {
   /**
    * Creates a new time tracking activity.
+   *
+   * @example
+   * ```ts
+   * const timeTrackingActivity =
+   *   await client.qbd.timeTrackingActivities.create({
+   *     duration: 'PT1H30M',
+   *     entityId: '80000001-1234567890',
+   *     transactionDate: '2021-10-01',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   });
+   * ```
    */
   create(
     params: TimeTrackingActivityCreateParams,
@@ -22,6 +33,15 @@ export class TimeTrackingActivities extends APIResource {
 
   /**
    * Retrieves a time tracking activity by ID.
+   *
+   * @example
+   * ```ts
+   * const timeTrackingActivity =
+   *   await client.qbd.timeTrackingActivities.retrieve(
+   *     '123ABC-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   retrieve(
     id: string,
@@ -37,6 +57,20 @@ export class TimeTrackingActivities extends APIResource {
 
   /**
    * Updates an existing time tracking activity.
+   *
+   * @example
+   * ```ts
+   * const timeTrackingActivity =
+   *   await client.qbd.timeTrackingActivities.update(
+   *     '123ABC-1234567890',
+   *     {
+   *       duration: 'PT1H30M',
+   *       entityId: '80000001-1234567890',
+   *       revisionNumber: '1721172183',
+   *       conductorEndUserId: 'end_usr_1234567abcdefg',
+   *     },
+   *   );
+   * ```
    */
   update(
     id: string,
@@ -54,6 +88,16 @@ export class TimeTrackingActivities extends APIResource {
   /**
    * Returns a list of time tracking activities. Use the `cursor` parameter to
    * paginate through the results.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const timeTrackingActivity of client.qbd.timeTrackingActivities.list(
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: TimeTrackingActivityListParams,
@@ -71,6 +115,15 @@ export class TimeTrackingActivities extends APIResource {
    * Permanently deletes a a time tracking activity. The deletion will fail if the
    * time tracking activity is currently in use or has any linked transactions that
    * are in use.
+   *
+   * @example
+   * ```ts
+   * const timeTrackingActivity =
+   *   await client.qbd.timeTrackingActivities.delete(
+   *     '123ABC-1234567890',
+   *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   *   );
+   * ```
    */
   delete(
     id: string,

package/src/resources/qbd/transactions.ts

@@ -7,6 +7,14 @@ import { CursorPage, type CursorPageParams } from '../../pagination';
 export class Transactions extends APIResource {
   /**
    * Retrieves a transaction by ID.
+   *
+   * @example
+   * ```ts
+   * const transaction = await client.qbd.transactions.retrieve(
+   *   '123ABC-1234567890',
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
    */
   retrieve(
     id: string,
@@ -27,6 +35,16 @@ export class Transactions extends APIResource {
    * transaction type, make a subsequent call to the relevant transaction-specific
    * endpoint (such as invoices, bills, etc.). NOTE: This endpoint does not support
    * time tracking activities.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const transaction of client.qbd.transactions.list(
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: TransactionListParams,

package/src/resources/qbd/transfers.ts

@@ -7,6 +7,17 @@ import { CursorPage, type CursorPageParams } from '../../pagination';
 export class Transfers extends APIResource {
   /**
    * Creates a new transfer.
+   *
+   * @example
+   * ```ts
+   * const transfer = await client.qbd.transfers.create({
+   *   amount: '1000.00',
+   *   sourceAccountId: '80000001-1234567890',
+   *   targetAccountId: '80000001-1234567890',
+   *   transactionDate: '2021-10-01',
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * });
+   * ```
    */
   create(params: TransferCreateParams, options?: Core.RequestOptions): Core.APIPromise<Transfer> {
     const { conductorEndUserId, ...body } = params;
@@ -19,6 +30,14 @@ export class Transfers extends APIResource {
 
   /**
    * Retrieves a transfer by ID.
+   *
+   * @example
+   * ```ts
+   * const transfer = await client.qbd.transfers.retrieve(
+   *   '123ABC-1234567890',
+   *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
+   * );
+   * ```
    */
   retrieve(
     id: string,
@@ -34,6 +53,17 @@ export class Transfers extends APIResource {
 
   /**
    * Updates an existing transfer.
+   *
+   * @example
+   * ```ts
+   * const transfer = await client.qbd.transfers.update(
+   *   '123ABC-1234567890',
+   *   {
+   *     revisionNumber: '1721172183',
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   },
+   * );
+   * ```
    */
   update(id: string, params: TransferUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Transfer> {
     const { conductorEndUserId, ...body } = params;
@@ -47,6 +77,16 @@ export class Transfers extends APIResource {
   /**
    * Returns a list of transfers. Use the `cursor` parameter to paginate through the
    * results.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const transfer of client.qbd.transfers.list({
+   *   conductorEndUserId: 'end_usr_1234567abcdefg',
+   * })) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: TransferListParams,

package/src/resources/qbd/vendor-credits.ts

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

package/src/resources/qbd/vendors.ts

@@ -7,6 +7,14 @@ import { CursorPage, type CursorPageParams } from '../../pagination';
 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: VendorCreateParams, options?: Core.RequestOptions): Core.APIPromise<Vendor> {
     const { conductorEndUserId, ...body } = params;
@@ -19,6 +27,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: string, params: VendorRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<Vendor> {
     const { conductorEndUserId } = params;
@@ -30,6 +46,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: string, params: VendorUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Vendor> {
     const { conductorEndUserId, ...body } = params;
@@ -43,6 +70,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: VendorListParams, options?: Core.RequestOptions): Core.PagePromise<VendorsCursorPage, Vendor> {
     const { conductorEndUserId, ...query } = params;

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '12.4.0'; // x-release-please-version
+export const VERSION = '12.5.1'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "12.4.0";
+export declare const VERSION = "12.5.1";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '12.4.0'; // x-release-please-version
+exports.VERSION = '12.5.1'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '12.4.0'; // x-release-please-version
+export const VERSION = '12.5.1'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map