conductor-node 12.23.1 → 12.25.0

package/resources/qbd/unit-of-measure-sets.js

@@ -0,0 +1,80 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnitOfMeasureSets = void 0;
+const resource_1 = require("../../resource.js");
+class UnitOfMeasureSets extends resource_1.APIResource {
+    /**
+     * Creates a new unit-of-measure set.
+     *
+     * NOTE: The QuickBooks company file must have unit-of-measure enabled (either a
+     * single unit per item or multiple units per item). To support both
+     * configurations, prefix all UOM set names with "By the" (for example, "By the
+     * Barrel"); otherwise, the set may not appear in the QuickBooks UI when the
+     * company file is configured for a single unit per item.
+     *
+     * @example
+     * ```ts
+     * const unitOfMeasureSet =
+     *   await conductor.qbd.unitOfMeasureSets.create({
+     *     baseUnit: { abbreviation: 'ea', name: 'Each' },
+     *     name: 'Weight Units',
+     *     unitOfMeasureType: 'count',
+     *     conductorEndUserId: 'end_usr_1234567abcdefg',
+     *   });
+     * ```
+     */
+    create(params, options) {
+        const { conductorEndUserId, ...body } = params;
+        return this._client.post('/quickbooks-desktop/unit-of-measure-sets', {
+            body,
+            ...options,
+            headers: { 'Conductor-End-User-Id': conductorEndUserId, ...options?.headers },
+        });
+    }
+    /**
+     * Retrieves an unit-of-measure set by ID.
+     *
+     * @example
+     * ```ts
+     * const unitOfMeasureSet =
+     *   await conductor.qbd.unitOfMeasureSets.retrieve(
+     *     '80000001-1234567890',
+     *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+     *   );
+     * ```
+     */
+    retrieve(id, params, options) {
+        const { conductorEndUserId } = params;
+        return this._client.get(`/quickbooks-desktop/unit-of-measure-sets/${id}`, {
+            ...options,
+            headers: { 'Conductor-End-User-Id': conductorEndUserId, ...options?.headers },
+        });
+    }
+    /**
+     * Lists all unit-of-measure sets. NOTE: QuickBooks Desktop does not support
+     * pagination for unit-of-measure sets; hence, there is no cursor parameter. Users
+     * typically have few unit-of-measure sets.
+     *
+     * NOTE: The QuickBooks company file must have unit-of-measure enabled (either a
+     * single unit per item or multiple units per item).
+     *
+     * @example
+     * ```ts
+     * const unitOfMeasureSets =
+     *   await conductor.qbd.unitOfMeasureSets.list({
+     *     conductorEndUserId: 'end_usr_1234567abcdefg',
+     *   });
+     * ```
+     */
+    list(params, options) {
+        const { conductorEndUserId, ...query } = params;
+        return this._client.get('/quickbooks-desktop/unit-of-measure-sets', {
+            query,
+            ...options,
+            headers: { 'Conductor-End-User-Id': conductorEndUserId, ...options?.headers },
+        });
+    }
+}
+exports.UnitOfMeasureSets = UnitOfMeasureSets;
+//# sourceMappingURL=unit-of-measure-sets.js.map

package/resources/qbd/unit-of-measure-sets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unit-of-measure-sets.js","sourceRoot":"","sources":["../../src/resources/qbd/unit-of-measure-sets.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,MAAa,iBAAkB,SAAQ,sBAAW;IAChD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,MAAoC,EACpC,OAA6B;QAE7B,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0CAA0C,EAAE;YACnE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAU,EACV,MAAsC,EACtC,OAA6B;QAE7B,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4CAA4C,EAAE,EAAE,EAAE;YACxE,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,MAAkC,EAClC,OAA6B;QAE7B,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0CAA0C,EAAE;YAClE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;CACF;AApFD,8CAoFC"}

package/resources/qbd/unit-of-measure-sets.mjs

@@ -0,0 +1,76 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../resource.mjs";
+export class UnitOfMeasureSets extends APIResource {
+    /**
+     * Creates a new unit-of-measure set.
+     *
+     * NOTE: The QuickBooks company file must have unit-of-measure enabled (either a
+     * single unit per item or multiple units per item). To support both
+     * configurations, prefix all UOM set names with "By the" (for example, "By the
+     * Barrel"); otherwise, the set may not appear in the QuickBooks UI when the
+     * company file is configured for a single unit per item.
+     *
+     * @example
+     * ```ts
+     * const unitOfMeasureSet =
+     *   await conductor.qbd.unitOfMeasureSets.create({
+     *     baseUnit: { abbreviation: 'ea', name: 'Each' },
+     *     name: 'Weight Units',
+     *     unitOfMeasureType: 'count',
+     *     conductorEndUserId: 'end_usr_1234567abcdefg',
+     *   });
+     * ```
+     */
+    create(params, options) {
+        const { conductorEndUserId, ...body } = params;
+        return this._client.post('/quickbooks-desktop/unit-of-measure-sets', {
+            body,
+            ...options,
+            headers: { 'Conductor-End-User-Id': conductorEndUserId, ...options?.headers },
+        });
+    }
+    /**
+     * Retrieves an unit-of-measure set by ID.
+     *
+     * @example
+     * ```ts
+     * const unitOfMeasureSet =
+     *   await conductor.qbd.unitOfMeasureSets.retrieve(
+     *     '80000001-1234567890',
+     *     { conductorEndUserId: 'end_usr_1234567abcdefg' },
+     *   );
+     * ```
+     */
+    retrieve(id, params, options) {
+        const { conductorEndUserId } = params;
+        return this._client.get(`/quickbooks-desktop/unit-of-measure-sets/${id}`, {
+            ...options,
+            headers: { 'Conductor-End-User-Id': conductorEndUserId, ...options?.headers },
+        });
+    }
+    /**
+     * Lists all unit-of-measure sets. NOTE: QuickBooks Desktop does not support
+     * pagination for unit-of-measure sets; hence, there is no cursor parameter. Users
+     * typically have few unit-of-measure sets.
+     *
+     * NOTE: The QuickBooks company file must have unit-of-measure enabled (either a
+     * single unit per item or multiple units per item).
+     *
+     * @example
+     * ```ts
+     * const unitOfMeasureSets =
+     *   await conductor.qbd.unitOfMeasureSets.list({
+     *     conductorEndUserId: 'end_usr_1234567abcdefg',
+     *   });
+     * ```
+     */
+    list(params, options) {
+        const { conductorEndUserId, ...query } = params;
+        return this._client.get('/quickbooks-desktop/unit-of-measure-sets', {
+            query,
+            ...options,
+            headers: { 'Conductor-End-User-Id': conductorEndUserId, ...options?.headers },
+        });
+    }
+}
+//# sourceMappingURL=unit-of-measure-sets.mjs.map

package/resources/qbd/unit-of-measure-sets.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"unit-of-measure-sets.mjs","sourceRoot":"","sources":["../../src/resources/qbd/unit-of-measure-sets.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,iBAAkB,SAAQ,WAAW;IAChD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,MAAoC,EACpC,OAA6B;QAE7B,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0CAA0C,EAAE;YACnE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAU,EACV,MAAsC,EACtC,OAA6B;QAE7B,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4CAA4C,EAAE,EAAE,EAAE;YACxE,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,MAAkC,EAClC,OAA6B;QAE7B,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0CAA0C,EAAE;YAClE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;CACF"}

package/src/index.ts

@@ -112,7 +112,7 @@ export class Conductor extends Core.APIClient {
   }: ClientOptions = {}) {
     if (apiKey === undefined) {
       throw new Errors.ConductorError(
-        "The CONDUCTOR_SECRET_KEY environment variable is missing or empty; either provide it, or instantiate the Conductor client with an apiKey option, like new Conductor({ apiKey: 'My API Key' }).",
+        "The CONDUCTOR_SECRET_KEY environment variable is missing or empty; either provide it, or instantiate the Conductor client with an apiKey option, like new Conductor({ apiKey: 'sk_conductor_...' }).",
       );
     }
 
@@ -190,6 +190,7 @@ export class Conductor extends Core.APIClient {
 Conductor.AuthSessions = AuthSessions;
 Conductor.EndUsers = EndUsers;
 Conductor.Qbd = Qbd;
+
 export declare namespace Conductor {
   export type RequestOptions = Core.RequestOptions;
 

package/src/resources/qbd/index.ts

@@ -436,6 +436,14 @@ export {
   type TransferUpdateParams,
   type TransferListParams,
 } from "./transfers.js";
+export {
+  UnitOfMeasureSets,
+  type UnitOfMeasureSet,
+  type UnitOfMeasureSetListResponse,
+  type UnitOfMeasureSetCreateParams,
+  type UnitOfMeasureSetRetrieveParams,
+  type UnitOfMeasureSetListParams,
+} from "./unit-of-measure-sets.js";
 export {
   VendorCreditsCursorPage,
   VendorCredits,

package/src/resources/qbd/qbd.ts

@@ -486,6 +486,15 @@ import {
   Transfers,
   TransfersCursorPage,
 } from "./transfers.js";
+import * as UnitOfMeasureSetsAPI from "./unit-of-measure-sets.js";
+import {
+  UnitOfMeasureSet,
+  UnitOfMeasureSetCreateParams,
+  UnitOfMeasureSetListParams,
+  UnitOfMeasureSetListResponse,
+  UnitOfMeasureSetRetrieveParams,
+  UnitOfMeasureSets,
+} from "./unit-of-measure-sets.js";
 import * as VendorCreditsAPI from "./vendor-credits.js";
 import {
   VendorCredit,
@@ -579,6 +588,9 @@ export class Qbd extends APIResource {
     new TimeTrackingActivitiesAPI.TimeTrackingActivities(this._client);
   transactions: TransactionsAPI.Transactions = new TransactionsAPI.Transactions(this._client);
   transfers: TransfersAPI.Transfers = new TransfersAPI.Transfers(this._client);
+  unitOfMeasureSets: UnitOfMeasureSetsAPI.UnitOfMeasureSets = new UnitOfMeasureSetsAPI.UnitOfMeasureSets(
+    this._client,
+  );
   vendorCredits: VendorCreditsAPI.VendorCredits = new VendorCreditsAPI.VendorCredits(this._client);
   vendors: VendorsAPI.Vendors = new VendorsAPI.Vendors(this._client);
 
@@ -708,6 +720,7 @@ Qbd.Transactions = Transactions;
 Qbd.TransactionsCursorPage = TransactionsCursorPage;
 Qbd.Transfers = Transfers;
 Qbd.TransfersCursorPage = TransfersCursorPage;
+Qbd.UnitOfMeasureSets = UnitOfMeasureSets;
 Qbd.VendorCredits = VendorCredits;
 Qbd.VendorCreditsCursorPage = VendorCreditsCursorPage;
 Qbd.Vendors = Vendors;
@@ -1212,6 +1225,15 @@ export declare namespace Qbd {
     type TransferListParams as TransferListParams,
   };
 
+  export {
+    UnitOfMeasureSets as UnitOfMeasureSets,
+    type UnitOfMeasureSet as UnitOfMeasureSet,
+    type UnitOfMeasureSetListResponse as UnitOfMeasureSetListResponse,
+    type UnitOfMeasureSetCreateParams as UnitOfMeasureSetCreateParams,
+    type UnitOfMeasureSetRetrieveParams as UnitOfMeasureSetRetrieveParams,
+    type UnitOfMeasureSetListParams as UnitOfMeasureSetListParams,
+  };
+
   export {
     VendorCredits as VendorCredits,
     type VendorCredit as VendorCredit,

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

@@ -12,7 +12,6 @@ export class SalesReceipts extends APIResource {
    * ```ts
    * const salesReceipt =
    *   await conductor.qbd.salesReceipts.create({
-   *     customerId: '80000001-1234567890',
    *     transactionDate: '2021-10-01',
    *     conductorEndUserId: 'end_usr_1234567abcdefg',
    *   });
@@ -183,7 +182,7 @@ export interface SalesReceipt {
    * The customer or customer-job to which the payment for this sales receipt is
    * credited.
    */
-  customer: SalesReceipt.Customer;
+  customer: SalesReceipt.Customer | null;
 
   /**
    * The message to display to the customer on the sales receipt.
@@ -2163,12 +2162,6 @@ export interface SalesReceiptDeleteResponse {
 }
 
 export interface SalesReceiptCreateParams {
-  /**
-   * Body param: The customer or customer-job to which the payment for this sales
-   * receipt is credited.
-   */
-  customerId: string;
-
   /**
    * Body param: The date of this sales receipt, in ISO 8601 format (YYYY-MM-DD).
    */
@@ -2206,6 +2199,12 @@ export interface SalesReceiptCreateParams {
    */
   creditCardTransaction?: SalesReceiptCreateParams.CreditCardTransaction;
 
+  /**
+   * Body param: The customer or customer-job to which the payment for this sales
+   * receipt is credited.
+   */
+  customerId?: string;
+
   /**
    * Body param: The message to display to the customer on the sales receipt.
    */