conductor-node 12.1.0 → 12.2.0

package/src/resources/qbd/item-sites.ts

@@ -0,0 +1,302 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import { CursorPage, type CursorPageParams } from '../../pagination';
+
+export class ItemSites extends APIResource {
+  /**
+   * Retrieves an item site by ID.
+   */
+  retrieve(
+    id: string,
+    params: ItemSiteRetrieveParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ItemSite> {
+    const { conductorEndUserId } = params;
+    return this._client.get(`/quickbooks-desktop/item-sites/${id}`, {
+      ...options,
+      headers: { 'Conductor-End-User-Id': conductorEndUserId, ...options?.headers },
+    });
+  }
+
+  /**
+   * Returns a list of item sites. Use the `cursor` parameter to paginate through the
+   * results.
+   */
+  list(
+    params: ItemSiteListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<ItemSitesCursorPage, ItemSite> {
+    const { conductorEndUserId, ...query } = params;
+    return this._client.getAPIList('/quickbooks-desktop/item-sites', ItemSitesCursorPage, {
+      query,
+      ...options,
+      headers: { 'Conductor-End-User-Id': conductorEndUserId, ...options?.headers },
+    });
+  }
+}
+
+export class ItemSitesCursorPage extends CursorPage<ItemSite> {}
+
+export interface ItemSite {
+  /**
+   * The unique identifier assigned by QuickBooks to this item site. This ID is
+   * unique across all item sites but not across different QuickBooks object types.
+   */
+  id: string;
+
+  /**
+   * The inventory level of this item site at which a new build assembly should
+   * begin. When the combined `quantityOnHand` and `quantityOnPurchaseOrders` drops
+   * below this point, QuickBooks flags the need to build additional units.
+   */
+  assemblyBuildPoint: number | null;
+
+  /**
+   * The date and time when this item site 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;
+
+  /**
+   * The inventory assembly item associated with this item site. An inventory
+   * assembly item is assembled or manufactured from other inventory items, and the
+   * items and/or assemblies that make up the assembly are called components.
+   */
+  inventoryAssemblyItem: ItemSite.InventoryAssemblyItem | null;
+
+  /**
+   * The inventory item associated with this item site.
+   */
+  inventoryItem: ItemSite.InventoryItem | null;
+
+  /**
+   * The site location where inventory for the item associated with this item site is
+   * stored.
+   */
+  inventorySite: ItemSite.InventorySite | null;
+
+  /**
+   * The specific location (e.g., bin or shelf) within the inventory site where the
+   * item associated with this item site is stored.
+   */
+  inventorySiteLocation: ItemSite.InventorySiteLocation | null;
+
+  /**
+   * The type of object. This value is always `"qbd_item_site"`.
+   */
+  objectType: 'qbd_item_site';
+
+  /**
+   * The number of units of this item site currently in inventory. `quantityOnHand`
+   * multiplied by `averageCost` equals `totalValue` for inventory item lists. To
+   * change the `quantityOnHand` for an item site, you must use an
+   * inventory-adjustment instead of updating the item site directly.
+   */
+  quantityOnHand: number | null;
+
+  /**
+   * The number of units of this item site that are currently on pending inventory
+   * transfer transactions.
+   */
+  quantityOnPendingTransfers: number | null;
+
+  /**
+   * The number of units of this item site that are currently listed on outstanding
+   * purchase orders and have not yet been received.
+   */
+  quantityOnPurchaseOrders: number | null;
+
+  /**
+   * The number of units of this item site that are currently listed on outstanding
+   * sales orders and have not yet been fulfilled or delivered to customers.
+   */
+  quantityOnSalesOrders: number | null;
+
+  /**
+   * The number of units of this item site required by pending build transactions.
+   */
+  quantityRequiredByPendingBuildTransactions: number | null;
+
+  /**
+   * The number of units of this item site that are scheduled to be built on pending
+   * build transactions.
+   */
+  quantityToBeBuiltByPendingBuildTransactions: number | null;
+
+  /**
+   * The inventory level at which QuickBooks prompts you to reorder this item site.
+   */
+  reorderLevel: number | null;
+
+  /**
+   * The current QuickBooks-assigned revision number of this item site 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 date and time when this item site 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 namespace ItemSite {
+  /**
+   * The inventory assembly item associated with this item site. An inventory
+   * assembly item is assembled or manufactured from other inventory items, and the
+   * items and/or assemblies that make up the assembly are called components.
+   */
+  export interface InventoryAssemblyItem {
+    /**
+     * The unique identifier assigned by QuickBooks to this object. This ID is unique
+     * across all objects of the same type, but not across different QuickBooks object
+     * types.
+     */
+    id: string | null;
+
+    /**
+     * The fully-qualified unique name for this object, formed by combining the names
+     * of its parent objects with its own `name`, separated by colons. Not
+     * case-sensitive.
+     */
+    fullName: string | null;
+  }
+
+  /**
+   * The inventory item associated with this item site.
+   */
+  export interface InventoryItem {
+    /**
+     * The unique identifier assigned by QuickBooks to this object. This ID is unique
+     * across all objects of the same type, but not across different QuickBooks object
+     * types.
+     */
+    id: string | null;
+
+    /**
+     * The fully-qualified unique name for this object, formed by combining the names
+     * of its parent objects with its own `name`, separated by colons. Not
+     * case-sensitive.
+     */
+    fullName: string | null;
+  }
+
+  /**
+   * The site location where inventory for the item associated with this item site is
+   * stored.
+   */
+  export interface InventorySite {
+    /**
+     * The unique identifier assigned by QuickBooks to this object. This ID is unique
+     * across all objects of the same type, but not across different QuickBooks object
+     * types.
+     */
+    id: string | null;
+
+    /**
+     * The fully-qualified unique name for this object, formed by combining the names
+     * of its parent objects with its own `name`, separated by colons. Not
+     * case-sensitive.
+     */
+    fullName: string | null;
+  }
+
+  /**
+   * The specific location (e.g., bin or shelf) within the inventory site where the
+   * item associated with this item site is stored.
+   */
+  export interface InventorySiteLocation {
+    /**
+     * The unique identifier assigned by QuickBooks to this object. This ID is unique
+     * across all objects of the same type, but not across different QuickBooks object
+     * types.
+     */
+    id: string | null;
+
+    /**
+     * The fully-qualified unique name for this object, formed by combining the names
+     * of its parent objects with its own `name`, separated by colons. Not
+     * case-sensitive.
+     */
+    fullName: string | null;
+  }
+}
+
+export interface ItemSiteRetrieveParams {
+  /**
+   * The ID of the EndUser to receive this request (e.g.,
+   * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
+   */
+  conductorEndUserId: string;
+}
+
+export interface ItemSiteListParams extends CursorPageParams {
+  /**
+   * Header param: The ID of the EndUser to receive this request (e.g.,
+   * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
+   */
+  conductorEndUserId: string;
+
+  /**
+   * Query param: Filter for specific item sites by their QuickBooks-assigned unique
+   * identifier(s).
+   *
+   * **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
+   * query parameters for this request.
+   *
+   * **NOTE**: If any of the values you specify in this parameter are not found, the
+   * request will return an error.
+   */
+  ids?: Array<string>;
+
+  /**
+   * Query param: Filter for item sites for these items.
+   */
+  itemIds?: Array<string>;
+
+  /**
+   * Query param: Filter for item sites that match this item type.
+   */
+  itemType?:
+    | 'all_except_fixed_asset'
+    | 'assembly'
+    | 'discount'
+    | 'fixed_asset'
+    | 'inventory'
+    | 'inventory_and_assembly'
+    | 'non_inventory'
+    | 'other_charge'
+    | 'payment'
+    | 'sales'
+    | 'sales_tax'
+    | 'service';
+
+  /**
+   * Query param: Filter for item sites at these sites. A site represents a physical
+   * location, such as a warehouse or store.
+   */
+  siteIds?: Array<string>;
+
+  /**
+   * Query param: Filter for item sites that are active, inactive, or both.
+   */
+  status?: 'active' | 'all' | 'inactive';
+}
+
+ItemSites.ItemSitesCursorPage = ItemSitesCursorPage;
+
+export declare namespace ItemSites {
+  export {
+    type ItemSite as ItemSite,
+    ItemSitesCursorPage as ItemSitesCursorPage,
+    type ItemSiteRetrieveParams as ItemSiteRetrieveParams,
+    type ItemSiteListParams as ItemSiteListParams,
+  };
+}

package/src/resources/qbd/qbd.ts

@@ -241,6 +241,14 @@ import {
   ItemReceipts,
   ItemReceiptsCursorPage,
 } from './item-receipts';
+import * as ItemSitesAPI from './item-sites';
+import {
+  ItemSite,
+  ItemSiteListParams,
+  ItemSiteRetrieveParams,
+  ItemSites,
+  ItemSitesCursorPage,
+} from './item-sites';
 import * as JournalEntriesAPI from './journal-entries';
 import {
   JournalEntries,
@@ -477,6 +485,7 @@ export class Qbd extends APIResource {
   invoices: InvoicesAPI.Invoices = new InvoicesAPI.Invoices(this._client);
   itemGroups: ItemGroupsAPI.ItemGroups = new ItemGroupsAPI.ItemGroups(this._client);
   itemReceipts: ItemReceiptsAPI.ItemReceipts = new ItemReceiptsAPI.ItemReceipts(this._client);
+  itemSites: ItemSitesAPI.ItemSites = new ItemSitesAPI.ItemSites(this._client);
   journalEntries: JournalEntriesAPI.JournalEntries = new JournalEntriesAPI.JournalEntries(this._client);
   nonInventoryItems: NonInventoryItemsAPI.NonInventoryItems = new NonInventoryItemsAPI.NonInventoryItems(
     this._client,
@@ -583,6 +592,8 @@ Qbd.ItemGroups = ItemGroups;
 Qbd.ItemGroupsCursorPage = ItemGroupsCursorPage;
 Qbd.ItemReceipts = ItemReceipts;
 Qbd.ItemReceiptsCursorPage = ItemReceiptsCursorPage;
+Qbd.ItemSites = ItemSites;
+Qbd.ItemSitesCursorPage = ItemSitesCursorPage;
 Qbd.JournalEntries = JournalEntries;
 Qbd.JournalEntriesCursorPage = JournalEntriesCursorPage;
 Qbd.NonInventoryItems = NonInventoryItems;
@@ -867,6 +878,14 @@ export declare namespace Qbd {
     type ItemReceiptDeleteParams as ItemReceiptDeleteParams,
   };
 
+  export {
+    ItemSites as ItemSites,
+    type ItemSite as ItemSite,
+    ItemSitesCursorPage as ItemSitesCursorPage,
+    type ItemSiteRetrieveParams as ItemSiteRetrieveParams,
+    type ItemSiteListParams as ItemSiteListParams,
+  };
+
   export {
     JournalEntries as JournalEntries,
     type JournalEntry as JournalEntry,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '12.1.0'; // x-release-please-version
+export const VERSION = '12.2.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "12.1.0";
+export declare const VERSION = "12.2.0";
 //# 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.1.0'; // x-release-please-version
+exports.VERSION = '12.2.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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