conductor-node 12.0.2 → 12.2.0

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

@@ -134,7 +134,7 @@ export interface ItemReceipt {
    * bundled together because they are commonly purchased together or grouped for
    * faster entry.
    */
-  itemLineGroups: Array<ItemReceipt.ItemLineGroup>;
+  itemGroupLines: Array<ItemReceipt.ItemGroupLine>;
 
   /**
    * The item receipt's item lines, each representing the purchase of a specific item
@@ -523,54 +523,54 @@ export namespace ItemReceipt {
     }
   }
 
-  export interface ItemLineGroup {
+  export interface ItemGroupLine {
     /**
-     * The unique identifier assigned by QuickBooks to this item line group. This ID is
+     * The unique identifier assigned by QuickBooks to this item group line. This ID is
      * unique across all transaction line types.
      */
     id: string;
 
     /**
-     * The custom fields for the item line group object, added as user-defined data
+     * The custom fields for the item group line object, added as user-defined data
      * extensions, not included in the standard QuickBooks object.
      */
-    customFields: Array<ItemLineGroup.CustomField>;
+    customFields: Array<ItemGroupLine.CustomField>;
 
     /**
-     * A description of this item line group.
+     * A description of this item group line.
      */
     description: string | null;
 
     /**
-     * The item line group's item group, representing a predefined set of items bundled
+     * The item group line's item group, representing a predefined set of items bundled
      * because they are commonly purchased together or grouped for faster entry.
      */
-    itemGroup: ItemLineGroup.ItemGroup;
+    itemGroup: ItemGroupLine.ItemGroup;
 
     /**
-     * The item line group's item lines, each representing the purchase of a specific
+     * The item group line's item lines, each representing the purchase of a specific
      * item or service.
      */
-    itemLines: Array<ItemLineGroup.ItemLine>;
+    itemLines: Array<ItemGroupLine.ItemLine>;
 
     /**
-     * The type of object. This value is always `"qbd_item_line_group"`.
+     * The type of object. This value is always `"qbd_item_group_line"`.
      */
-    objectType: 'qbd_item_line_group';
+    objectType: 'qbd_item_group_line';
 
     /**
-     * Specifies an alternative unit-of-measure set when updating this item line
-     * group's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
+     * Specifies an alternative unit-of-measure set when updating this item group
+     * line's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
      * select units from a different set than the item's default unit-of-measure set,
      * which remains unchanged on the item itself. The override applies only to this
      * specific line. For example, you can sell an item typically measured in volume
      * units using weight units in a specific transaction by specifying a different
      * unit-of-measure set with this field.
      */
-    overrideUnitOfMeasureSet: ItemLineGroup.OverrideUnitOfMeasureSet | null;
+    overrideUnitOfMeasureSet: ItemGroupLine.OverrideUnitOfMeasureSet | null;
 
     /**
-     * The quantity of the item group associated with this item line group. This field
+     * The quantity of the item group associated with this item group line. This field
      * cannot be cleared.
      *
      * **NOTE**: Do not use this field if the associated item group is a discount item
@@ -579,19 +579,19 @@ export namespace ItemReceipt {
     quantity: number | null;
 
     /**
-     * The total monetary amount of this item line group, equivalent to the sum of the
+     * The total monetary amount of this item group line, equivalent to the sum of the
      * amounts in `lines`, represented as a decimal string.
      */
     totalAmount: string;
 
     /**
-     * The unit-of-measure used for the `quantity` in this item line group. Must be a
+     * The unit-of-measure used for the `quantity` in this item group line. Must be a
      * valid unit within the item's available units of measure.
      */
     unitOfMeasure: string | null;
   }
 
-  export namespace ItemLineGroup {
+  export namespace ItemGroupLine {
     export interface CustomField {
       /**
        * The name of the custom field, unique for the specified `ownerId`. For public
@@ -631,7 +631,7 @@ export namespace ItemReceipt {
     }
 
     /**
-     * The item line group's item group, representing a predefined set of items bundled
+     * The item group line's item group, representing a predefined set of items bundled
      * because they are commonly purchased together or grouped for faster entry.
      */
     export interface ItemGroup {
@@ -1008,8 +1008,8 @@ export namespace ItemReceipt {
     }
 
     /**
-     * Specifies an alternative unit-of-measure set when updating this item line
-     * group's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
+     * Specifies an alternative unit-of-measure set when updating this item group
+     * line's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
      * select units from a different set than the item's default unit-of-measure set,
      * which remains unchanged on the item itself. The override applies only to this
      * specific line. For example, you can sell an item typically measured in volume
@@ -1618,7 +1618,7 @@ export interface ItemReceiptCreateParams {
    * set of items bundled together because they are commonly purchased together or
    * grouped for faster entry.
    */
-  itemLineGroups?: Array<ItemReceiptCreateParams.ItemLineGroup>;
+  itemGroupLines?: Array<ItemReceiptCreateParams.ItemGroupLine>;
 
   /**
    * Body param: The item receipt's item lines, each representing the purchase of a
@@ -1780,33 +1780,33 @@ export namespace ItemReceiptCreateParams {
     }
   }
 
-  export interface ItemLineGroup {
+  export interface ItemGroupLine {
     /**
-     * The item line group's item group, representing a predefined set of items bundled
+     * The item group line's item group, representing a predefined set of items bundled
      * because they are commonly purchased together or grouped for faster entry.
      */
     itemGroupId: string;
 
     /**
-     * The custom fields for the item line group object, added as user-defined data
+     * The custom fields for the item group line object, added as user-defined data
      * extensions, not included in the standard QuickBooks object.
      */
-    customFields?: Array<ItemLineGroup.CustomField>;
+    customFields?: Array<ItemGroupLine.CustomField>;
 
     /**
      * The site location where inventory for the item group associated with this item
-     * line group is stored.
+     * group line is stored.
      */
     inventorySiteId?: string;
 
     /**
      * The specific location (e.g., bin or shelf) within the inventory site where the
-     * item group associated with this item line group is stored.
+     * item group associated with this item group line is stored.
      */
     inventorySiteLocationId?: string;
 
     /**
-     * The quantity of the item group associated with this item line group. This field
+     * The quantity of the item group associated with this item group line. This field
      * cannot be cleared.
      *
      * **NOTE**: Do not use this field if the associated item group is a discount item
@@ -1815,13 +1815,13 @@ export namespace ItemReceiptCreateParams {
     quantity?: number;
 
     /**
-     * The unit-of-measure used for the `quantity` in this item line group. Must be a
+     * The unit-of-measure used for the `quantity` in this item group line. Must be a
      * valid unit within the item's available units of measure.
      */
     unitOfMeasure?: string;
   }
 
-  export namespace ItemLineGroup {
+  export namespace ItemGroupLine {
     export interface CustomField {
       /**
        * The name of the custom field, unique for the specified `ownerId`. For public
@@ -2161,7 +2161,7 @@ export interface ItemReceiptUpdateParams {
    * 3. If you do not wish to modify any item group lines, omit this field entirely
    *    to keep them unchanged.
    */
-  itemLineGroups?: Array<ItemReceiptUpdateParams.ItemLineGroup>;
+  itemGroupLines?: Array<ItemReceiptUpdateParams.ItemGroupLine>;
 
   /**
    * Body param: The item receipt's item lines, each representing the purchase of a
@@ -2296,29 +2296,29 @@ export namespace ItemReceiptUpdateParams {
     salesTaxCodeId?: string;
   }
 
-  export interface ItemLineGroup {
+  export interface ItemGroupLine {
     /**
-     * The QuickBooks-assigned unique identifier of an existing item line group you
+     * The QuickBooks-assigned unique identifier of an existing item group line you
      * wish to retain or update.
      *
-     * **IMPORTANT**: Set this field to `-1` for new item line groups you wish to add.
+     * **IMPORTANT**: Set this field to `-1` for new item group lines you wish to add.
      */
     id: string;
 
     /**
-     * The item line group's item group, representing a predefined set of items bundled
+     * The item group line's item group, representing a predefined set of items bundled
      * because they are commonly purchased together or grouped for faster entry.
      */
     itemGroupId?: string;
 
     /**
-     * The item line group's item lines, each representing the purchase of a specific
+     * The item group line's item lines, each representing the purchase of a specific
      * item or service.
      *
      * **IMPORTANT**:
      *
      * 1. Including this array in your update request will **REPLACE** all existing
-     *    item lines for the item line group with this array. To keep any existing item
+     *    item lines for the item group line with this array. To keep any existing item
      *    lines, you must include them in this array even if they have not changed.
      *    **Any item lines not included will be removed.**
      *
@@ -2327,11 +2327,11 @@ export namespace ItemReceiptUpdateParams {
      * 3. If you do not wish to modify any item lines, omit this field entirely to keep
      *    them unchanged.
      */
-    itemLines?: Array<ItemLineGroup.ItemLine>;
+    itemLines?: Array<ItemGroupLine.ItemLine>;
 
     /**
-     * Specifies an alternative unit-of-measure set when updating this item line
-     * group's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
+     * Specifies an alternative unit-of-measure set when updating this item group
+     * line's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
      * select units from a different set than the item's default unit-of-measure set,
      * which remains unchanged on the item itself. The override applies only to this
      * specific line. For example, you can sell an item typically measured in volume
@@ -2341,7 +2341,7 @@ export namespace ItemReceiptUpdateParams {
     overrideUnitOfMeasureSetId?: string;
 
     /**
-     * The quantity of the item group associated with this item line group. This field
+     * The quantity of the item group associated with this item group line. This field
      * cannot be cleared.
      *
      * **NOTE**: Do not use this field if the associated item group is a discount item
@@ -2350,13 +2350,13 @@ export namespace ItemReceiptUpdateParams {
     quantity?: number;
 
     /**
-     * The unit-of-measure used for the `quantity` in this item line group. Must be a
+     * The unit-of-measure used for the `quantity` in this item group line. Must be a
      * valid unit within the item's available units of measure.
      */
     unitOfMeasure?: string;
   }
 
-  export namespace ItemLineGroup {
+  export namespace ItemGroupLine {
     export interface ItemLine {
       /**
        * The QuickBooks-assigned unique identifier of an existing item line you wish to

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

@@ -219,6 +219,16 @@ import {
   Invoices,
   InvoicesCursorPage,
 } from './invoices';
+import * as ItemGroupsAPI from './item-groups';
+import {
+  ItemGroup,
+  ItemGroupCreateParams,
+  ItemGroupListParams,
+  ItemGroupRetrieveParams,
+  ItemGroupUpdateParams,
+  ItemGroups,
+  ItemGroupsCursorPage,
+} from './item-groups';
 import * as ItemReceiptsAPI from './item-receipts';
 import {
   ItemReceipt,
@@ -231,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,
@@ -465,7 +483,9 @@ export class Qbd extends APIResource {
   inventoryItems: InventoryItemsAPI.InventoryItems = new InventoryItemsAPI.InventoryItems(this._client);
   inventorySites: InventorySitesAPI.InventorySites = new InventorySitesAPI.InventorySites(this._client);
   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,
@@ -568,8 +588,12 @@ Qbd.InventoryItemsCursorPage = InventoryItemsCursorPage;
 Qbd.InventorySites = InventorySites;
 Qbd.Invoices = Invoices;
 Qbd.InvoicesCursorPage = InvoicesCursorPage;
+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;
@@ -832,6 +856,16 @@ export declare namespace Qbd {
     type InvoiceDeleteParams as InvoiceDeleteParams,
   };
 
+  export {
+    ItemGroups as ItemGroups,
+    type ItemGroup as ItemGroup,
+    ItemGroupsCursorPage as ItemGroupsCursorPage,
+    type ItemGroupCreateParams as ItemGroupCreateParams,
+    type ItemGroupRetrieveParams as ItemGroupRetrieveParams,
+    type ItemGroupUpdateParams as ItemGroupUpdateParams,
+    type ItemGroupListParams as ItemGroupListParams,
+  };
+
   export {
     ItemReceipts as ItemReceipts,
     type ItemReceipt as ItemReceipt,
@@ -844,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,