conductor-node 12.18.2 → 12.20.0

package/resources/qbd/templates.d.ts

@@ -0,0 +1,107 @@
+import { APIResource } from "../../resource.js";
+import * as Core from "../../core.js";
+export declare class Templates extends APIResource {
+    /**
+     * Returns a list of templates. Use the `cursor` parameter to paginate through the
+     * results.
+     *
+     * @example
+     * ```ts
+     * const templates = await conductor.qbd.templates.list({
+     *   conductorEndUserId: 'end_usr_1234567abcdefg',
+     * });
+     * ```
+     */
+    list(params: TemplateListParams, options?: Core.RequestOptions): Core.APIPromise<TemplateListResponse>;
+}
+export interface Template {
+    /**
+     * The unique identifier assigned by QuickBooks to this template. This ID is unique
+     * across all templates but not across different QuickBooks object types.
+     */
+    id: string;
+    /**
+     * The date and time when this template was created, in ISO 8601 format
+     * (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone
+     * in QuickBooks.
+     */
+    createdAt: string;
+    /**
+     * Indicates whether this template is active. Inactive objects are typically hidden
+     * from views and reports in QuickBooks. Defaults to `true`.
+     */
+    isActive: boolean;
+    /**
+     * The case-insensitive unique name of this template, unique across all templates.
+     *
+     * **NOTE**: Templates do not have a `fullName` field because they are not
+     * hierarchical objects, which is why `name` is unique for them but not for objects
+     * that have parents.
+     */
+    name: string;
+    /**
+     * The type of object. This value is always `"qbd_template"`.
+     */
+    objectType: 'qbd_template';
+    /**
+     * The current QuickBooks-assigned revision number of this template object, which
+     * changes each time the object is modified. When updating this object, you must
+     * provide the most recent `revisionNumber` to ensure you're working with the
+     * latest data; otherwise, the update will return an error.
+     */
+    revisionNumber: string;
+    /**
+     * The type of transaction that this template is used for.
+     */
+    templateType: 'bill_payment' | 'build_assembly' | 'credit_memo' | 'estimate' | 'invoice' | 'payment_receipt' | 'purchase_order' | 'sales_order' | 'sales_receipt';
+    /**
+     * The date and time when this template was last updated, in ISO 8601 format
+     * (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone
+     * in QuickBooks.
+     */
+    updatedAt: string;
+}
+export interface TemplateListResponse {
+    /**
+     * The array of templates.
+     */
+    data: Array<Template>;
+    /**
+     * Indicates whether there are more objects to be fetched.
+     */
+    hasMore: boolean;
+    /**
+     * The `nextCursor` is a pagination token returned in the response when you use the
+     * `limit` parameter in your request. To retrieve subsequent pages of results,
+     * include this token as the value of the `cursor` request parameter in your
+     * following API calls.
+     *
+     * **NOTE**: The `nextCursor` value remains constant throughout the pagination
+     * process for a specific list instance; continue to use the same `nextCursor`
+     * token in each request to fetch additional pages.
+     */
+    nextCursor: string | null;
+    /**
+     * The type of object. This value is always `"list"`.
+     */
+    objectType: 'list';
+    /**
+     * The number of objects remaining to be fetched.
+     */
+    remainingCount: number | null;
+    /**
+     * The endpoint URL where this list can be accessed.
+     */
+    url: string;
+}
+export interface TemplateListParams {
+    /**
+     * The ID of the EndUser to receive this request (e.g.,
+     * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
+     */
+    conductorEndUserId: string;
+}
+export declare namespace Templates {
+    export { type Template as Template, type TemplateListResponse as TemplateListResponse, type TemplateListParams as TemplateListParams, };
+}
+//# sourceMappingURL=templates.d.ts.map

package/resources/qbd/templates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../../src/resources/qbd/templates.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;OAUG;IACH,IAAI,CAAC,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;CAOvG;AAED,MAAM,WAAW,QAAQ;IACvB;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,cAAc,CAAC;IAE3B;;;;;OAKG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,EACR,cAAc,GACd,gBAAgB,GAChB,aAAa,GACb,UAAU,GACV,SAAS,GACT,iBAAiB,GACjB,gBAAgB,GAChB,aAAa,GACb,eAAe,CAAC;IAEpB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAEtB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;;;;;;;;OASG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}

package/resources/qbd/templates.js

@@ -0,0 +1,27 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Templates = void 0;
+const resource_1 = require("../../resource.js");
+class Templates extends resource_1.APIResource {
+    /**
+     * Returns a list of templates. Use the `cursor` parameter to paginate through the
+     * results.
+     *
+     * @example
+     * ```ts
+     * const templates = await conductor.qbd.templates.list({
+     *   conductorEndUserId: 'end_usr_1234567abcdefg',
+     * });
+     * ```
+     */
+    list(params, options) {
+        const { conductorEndUserId } = params;
+        return this._client.get('/quickbooks-desktop/templates', {
+            ...options,
+            headers: { 'Conductor-End-User-Id': conductorEndUserId, ...options?.headers },
+        });
+    }
+}
+exports.Templates = Templates;
+//# sourceMappingURL=templates.js.map

package/resources/qbd/templates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.js","sourceRoot":"","sources":["../../src/resources/qbd/templates.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;OAUG;IACH,IAAI,CAAC,MAA0B,EAAE,OAA6B;QAC5D,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE;YACvD,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;CACF;AAnBD,8BAmBC"}

package/resources/qbd/templates.mjs

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../resource.mjs";
+export class Templates extends APIResource {
+    /**
+     * Returns a list of templates. Use the `cursor` parameter to paginate through the
+     * results.
+     *
+     * @example
+     * ```ts
+     * const templates = await conductor.qbd.templates.list({
+     *   conductorEndUserId: 'end_usr_1234567abcdefg',
+     * });
+     * ```
+     */
+    list(params, options) {
+        const { conductorEndUserId } = params;
+        return this._client.get('/quickbooks-desktop/templates', {
+            ...options,
+            headers: { 'Conductor-End-User-Id': conductorEndUserId, ...options?.headers },
+        });
+    }
+}
+//# sourceMappingURL=templates.mjs.map

package/resources/qbd/templates.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.mjs","sourceRoot":"","sources":["../../src/resources/qbd/templates.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;OAUG;IACH,IAAI,CAAC,MAA0B,EAAE,OAA6B;QAC5D,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE;YACvD,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;CACF"}

package/src/resources/qbd/index.ts

@@ -254,6 +254,15 @@ export {
   type NonInventoryItemUpdateParams,
   type NonInventoryItemListParams,
 } from "./non-inventory-items.js";
+export {
+  OtherChargeItemsCursorPage,
+  OtherChargeItems,
+  type OtherChargeItem,
+  type OtherChargeItemCreateParams,
+  type OtherChargeItemRetrieveParams,
+  type OtherChargeItemUpdateParams,
+  type OtherChargeItemListParams,
+} from "./other-charge-items.js";
 export {
   OtherNames,
   type OtherName,
@@ -387,6 +396,7 @@ export {
   type SubtotalItemUpdateParams,
   type SubtotalItemListParams,
 } from "./subtotal-items.js";
+export { Templates, type Template, type TemplateListResponse, type TemplateListParams } from "./templates.js";
 export {
   TimeTrackingActivitiesCursorPage,
   TimeTrackingActivities,

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

@@ -171,9 +171,8 @@ export interface InventoryItem {
   /**
    * The case-insensitive fully-qualified unique name of this inventory item, formed
    * by combining the names of its hierarchical parent objects with its own `name`,
-   * separated by colons. For example, if an inventory item is under
-   * "Products:Electronics" and has the `name` "Widgets", its `fullName` would be
-   * "Products:Electronics:Widgets".
+   * separated by colons. For example, if an inventory item is under "Kitchen" and
+   * has the `name` "Cabinet", its `fullName` would be "Kitchen:Cabinet".
    *
    * **NOTE**: Unlike `name`, `fullName` is guaranteed to be unique across all
    * inventory item objects. However, `fullName` can still be arbitrarily changed by