qubesync 0.1.0 → 0.2.0

package/operations/unit_of_measure_set.d.ts

@@ -0,0 +1,168 @@
+// Generated from operations.json by scripts/generate-operations.js: don't edit.
+
+import type { Client } from "../index";
+import type { OperationOptions, QueuedRequest, NameFilter, NameRangeFilter } from "./types";
+
+/** QuickBooks unit of measure set operations: `qube.unitOfMeasureSet.<action>(connectionId, params, { webhookUrl })`. */
+export declare class UnitOfMeasureSet {
+  constructor(client: Client);
+  /**
+   * Create unit of measure set: `POST /connections/{connection_id}/unit-of-measure-sets`, queued for QuickBooks.
+   *
+   * The answer comes to `webhookUrl` as one webhook.
+   * Params go in the JSON body.
+   *
+   * Fields: `base_unit` (required), `default_unit`, `include_ret_element`, `is_active`, `name` (required), `related_unit`, `request_id`, `unit_of_measure_type` (required).
+   *
+   * Resolves to the queued request.
+   * @see https://docs.qubesync.com/api-reference/v2/unit-of-measure-sets/create-unit-of-measure-set
+   */
+  create(connectionId: string, params: UnitOfMeasureSetCreateParams, options: OperationOptions): Promise<QueuedRequest>;
+  /**
+   * List unit of measure sets: `GET /connections/{connection_id}/unit-of-measure-sets`, queued for QuickBooks.
+   *
+   * The answer comes to `webhookUrl` as one webhook.
+   * Params go in the query string.
+   *
+   * Fields: `active_status`, `from_modified_date`, `full_name`, `include_ret_element`, `list_id`, `max_returned`, `meta_data`, `name_filter`, `name_range_filter`, `request_id`, `to_modified_date`.
+   *
+   * Resolves to the queued request.
+   * @see https://docs.qubesync.com/api-reference/v2/unit-of-measure-sets/list-unit-of-measure-sets
+   */
+  query(connectionId: string, params: UnitOfMeasureSetQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
+}
+
+/**
+ * The params of `unit_of_measure_set.create`: Create unit of measure set.
+ */
+export interface UnitOfMeasureSetCreateParams {
+  /**
+   * The unit of measure in a unit of measure set by which quantities of an item are tracked, priced, etc. If the company file is enabled for single unit of measure per item, the base unit is the only unit that is available for transaction line items.
+   */
+  base_unit: BaseUnit;
+  default_unit?: DefaultUnit[];
+  include_ret_element?: Array<"BaseUnit" | "DefaultUnit" | "EditSequence" | "ExternalGUID" | "IsActive" | "ListID" | "Name" | "OwnerID" | "RelatedUnit" | "TimeCreated" | "TimeModified" | "TxnID" | "TxnNumber" | "UnitOfMeasureType">;
+  /**
+   * If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
+   */
+  is_active?: boolean;
+  /**
+   * Name is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope. Hierarchical lists can reuse the same Name in different branches because FullName remains distinct.
+   */
+  name: string;
+  related_unit?: RelatedUnit[];
+  /**
+   * Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
+   */
+  request_id?: string;
+  /**
+   * The type of the unit of measure. This can be one of the values you see in the QuickBooks UI when you create a new UOM set, such as Count, or it can be your own value, which in the UI you can specify by selecting “Other” then defining it.
+   */
+  unit_of_measure_type: "Area" | "Count" | "Length" | "Other" | "Time" | "Volume" | "Weight";
+}
+
+/**
+ * The params of `unit_of_measure_set.query`: List unit of measure sets.
+ */
+export interface UnitOfMeasureSetQueryParams {
+  /**
+   * Used in filters to select list objects based on whether or not they are currently enabled for use by QuickBooks. The default value is asActiveOnly, which selects only list objects that are active.
+   *
+   * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
+   */
+  active_status?: "ActiveOnly" | "All" | "InactiveOnly";
+  /**
+   * Filters results to objects modified on or after this timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a date is provided, time defaults to 00:00:00.
+   *
+   * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
+   *
+   * Format: date-time.
+   */
+  from_modified_date?: string;
+  /**
+   * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
+   */
+  full_name?: string[];
+  include_ret_element?: Array<"BaseUnit" | "DefaultUnit" | "EditSequence" | "IsActive" | "ListID" | "Name" | "RelatedUnit" | "TimeCreated" | "TimeModified" | "UnitOfMeasureType">;
+  /**
+   * `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list type, not globally across all lists. If both `full_name` and `list_id` are supplied in a request, QuickBooks uses `list_id` and ignores `full_name`.
+   *
+   * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
+   */
+  list_id?: string[];
+  /**
+   * Limits the number of objects that a query returns. (To get a count of how many objects could possibly be returned, use the `meta_data` query attribute.) If you include a `max_returned` value, it must be at least 1.
+   *
+   * QuickBooks doesn't page this query: at most this many records come back, in one answer, with no sign of whether more matched. Leave it out for every match, in one answer; one over 4 MB as the Web Connector sends it, about 3 MB of qbXML isn't kept (`error_type` `response_too_large`), so narrow a large one with its filters.
+   *
+   * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
+   *
+   * Minimum 1.
+   */
+  max_returned?: number;
+  /**
+   * Use the `meta_data` attribute to control whether query responses include counts. Options are NoMetaData (default), MetaDataOnly (count only), and MetaDataAndResponseData (count plus objects). Counts are approximate and may vary slightly if records are created or deleted during processing.
+   */
+  meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
+  /**
+   * Filters according to the object’s Name.
+   *
+   * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
+   */
+  name_filter?: NameFilter;
+  /**
+   * Filters according to the object’s Name.
+   *
+   * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
+   */
+  name_range_filter?: NameRangeFilter;
+  /**
+   * Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
+   */
+  request_id?: string;
+  /**
+   * Filters results to objects modified on or before this timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a date is provided, time defaults to end-of-day (23:59:59).
+   *
+   * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
+   *
+   * Format: date-time.
+   */
+  to_modified_date?: string;
+}
+
+export interface BaseUnit {
+  /**
+   * The is the short “identifier” for a unit of measure that shows up in transaction line items in the U/M field in the QuickBooks UI.
+   */
+  abbreviation: string;
+  /**
+   * Name is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope. Hierarchical lists can reuse the same Name in different branches because FullName remains distinct.
+   */
+  name: string;
+}
+
+export interface DefaultUnit {
+  /**
+   * In a related unit within a unit of measure set, the name you want the unit to have. This name is displayed in the QuickBooks as an available unit for the item, if the company is enabled for multiple units of measure per item.
+   */
+  unit: string;
+  /**
+   * In a default unit of measure, this specifies whether the default is to be used for purchase line items, sales line items, or shipping lines.
+   */
+  unit_used_for: "Purchase" | "Sales" | "Shipping";
+}
+
+export interface RelatedUnit {
+  /**
+   * The is the short “identifier” for a unit of measure that shows up in transaction line items in the U/M field in the QuickBooks UI.
+   */
+  abbreviation: string;
+  /**
+   * Within a unit of measure set, in any of the related units in that set, this indicates how many base units are in the related unit. That is, if the base unit is “box”, and the related unit is “case” with a conversion ratio of 10, that means there are 10 boxes in a case.
+   */
+  conversion_ratio: number;
+  /**
+   * Name is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope. Hierarchical lists can reuse the same Name in different branches because FullName remains distinct.
+   */
+  name: string;
+}

package/operations/unit_of_measure_set.js

@@ -0,0 +1,38 @@
+// Generated from operations.json by scripts/generate-operations.js: don't edit.
+"use strict";
+
+/** QuickBooks unit of measure set operations. Types: unit_of_measure_set.d.ts. */
+class UnitOfMeasureSet {
+  #client;
+
+  /** @param {import("../index").Client} client */
+  constructor(client) {
+    this.#client = client;
+  }
+
+  /**
+   * Create unit of measure set.
+   * @param {string} connectionId
+   * @param {import("./unit_of_measure_set").UnitOfMeasureSetCreateParams} params
+   * @param {import("./types").OperationOptions} options
+   * @returns {Promise<import("./types").QueuedRequest>}
+   * @see https://docs.qubesync.com/api-reference/v2/unit-of-measure-sets/create-unit-of-measure-set
+   */
+  create(connectionId, params, options) {
+    return this.#client.queue("unit_of_measure_set.create", connectionId, params, options);
+  }
+
+  /**
+   * List unit of measure sets.
+   * @param {string} connectionId
+   * @param {import("./unit_of_measure_set").UnitOfMeasureSetQueryParams} params
+   * @param {import("./types").OperationOptions} options
+   * @returns {Promise<import("./types").QueuedRequest>}
+   * @see https://docs.qubesync.com/api-reference/v2/unit-of-measure-sets/list-unit-of-measure-sets
+   */
+  query(connectionId, params, options) {
+    return this.#client.queue("unit_of_measure_set.query", connectionId, params, options);
+  }
+}
+
+module.exports = { UnitOfMeasureSet };

package/operations/vehicle.d.ts

@@ -0,0 +1,168 @@
+// Generated from operations.json by scripts/generate-operations.js: don't edit.
+
+import type { Client } from "../index";
+import type { OperationOptions, QueuedRequest, NameFilter, NameRangeFilter } from "./types";
+
+/** QuickBooks vehicle operations: `qube.vehicle.<action>(connectionId, params, { webhookUrl })`. */
+export declare class Vehicle {
+  constructor(client: Client);
+  /**
+   * Create vehicle: `POST /connections/{connection_id}/vehicles`, queued for QuickBooks.
+   *
+   * The answer comes to `webhookUrl` as one webhook.
+   * Params go in the JSON body.
+   *
+   * Fields: `desc`, `include_ret_element`, `is_active`, `name` (required), `request_id`.
+   *
+   * Resolves to the queued request.
+   * @see https://docs.qubesync.com/api-reference/v2/vehicles/create-vehicle
+   */
+  create(connectionId: string, params: VehicleCreateParams, options: OperationOptions): Promise<QueuedRequest>;
+  /**
+   * List vehicles: `GET /connections/{connection_id}/vehicles`, queued for QuickBooks.
+   *
+   * The answer comes to `webhookUrl` as one webhook.
+   * Params go in the query string.
+   *
+   * Fields: `active_status`, `from_modified_date`, `full_name`, `include_ret_element`, `list_id`, `max_returned`, `meta_data`, `name_filter`, `name_range_filter`, `request_id`, `to_modified_date`.
+   *
+   * Resolves to the queued request.
+   * @see https://docs.qubesync.com/api-reference/v2/vehicles/list-vehicles
+   */
+  query(connectionId: string, params: VehicleQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
+  /**
+   * Update vehicle: `PUT /connections/{connection_id}/vehicles`, queued for QuickBooks.
+   *
+   * The answer comes to `webhookUrl` as one webhook.
+   * Params go in the JSON body.
+   *
+   * Fields: `desc`, `edit_sequence` (required), `include_ret_element`, `is_active`, `list_id` (required), `name`, `request_id`.
+   *
+   * Resolves to the queued request.
+   * @see https://docs.qubesync.com/api-reference/v2/vehicles/update-vehicle
+   */
+  update(connectionId: string, params: VehicleUpdateParams, options: OperationOptions): Promise<QueuedRequest>;
+}
+
+/**
+ * The params of `vehicle.create`: Create vehicle.
+ */
+export interface VehicleCreateParams {
+  /**
+   * A descriptive text field.
+   */
+  desc?: string;
+  include_ret_element?: Array<"Desc" | "EditSequence" | "ExternalGUID" | "IsActive" | "ListID" | "Name" | "OwnerID" | "TimeCreated" | "TimeModified" | "TxnID" | "TxnNumber">;
+  /**
+   * If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
+   */
+  is_active?: boolean;
+  /**
+   * Name is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope. Hierarchical lists can reuse the same Name in different branches because FullName remains distinct.
+   */
+  name: string;
+  /**
+   * Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
+   */
+  request_id?: string;
+}
+
+/**
+ * The params of `vehicle.query`: List vehicles.
+ */
+export interface VehicleQueryParams {
+  /**
+   * Used in filters to select list objects based on whether or not they are currently enabled for use by QuickBooks. The default value is asActiveOnly, which selects only list objects that are active.
+   *
+   * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
+   */
+  active_status?: "ActiveOnly" | "All" | "InactiveOnly";
+  /**
+   * Filters results to objects modified on or after this timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a date is provided, time defaults to 00:00:00.
+   *
+   * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
+   *
+   * Format: date-time.
+   */
+  from_modified_date?: string;
+  /**
+   * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
+   */
+  full_name?: string[];
+  include_ret_element?: Array<"Desc" | "EditSequence" | "IsActive" | "ListID" | "Name" | "TimeCreated" | "TimeModified">;
+  /**
+   * `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list type, not globally across all lists. If both `full_name` and `list_id` are supplied in a request, QuickBooks uses `list_id` and ignores `full_name`.
+   *
+   * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
+   */
+  list_id?: string[];
+  /**
+   * Limits the number of objects that a query returns. (To get a count of how many objects could possibly be returned, use the `meta_data` query attribute.) If you include a `max_returned` value, it must be at least 1.
+   *
+   * QuickBooks doesn't page this query: at most this many records come back, in one answer, with no sign of whether more matched. Leave it out for every match, in one answer; one over 4 MB as the Web Connector sends it, about 3 MB of qbXML isn't kept (`error_type` `response_too_large`), so narrow a large one with its filters.
+   *
+   * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
+   *
+   * Minimum 1.
+   */
+  max_returned?: number;
+  /**
+   * Use the `meta_data` attribute to control whether query responses include counts. Options are NoMetaData (default), MetaDataOnly (count only), and MetaDataAndResponseData (count plus objects). Counts are approximate and may vary slightly if records are created or deleted during processing.
+   */
+  meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
+  /**
+   * Filters according to the object’s Name.
+   *
+   * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
+   */
+  name_filter?: NameFilter;
+  /**
+   * Filters according to the object’s Name.
+   *
+   * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
+   */
+  name_range_filter?: NameRangeFilter;
+  /**
+   * Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
+   */
+  request_id?: string;
+  /**
+   * Filters results to objects modified on or before this timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a date is provided, time defaults to end-of-day (23:59:59).
+   *
+   * Choose at most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not with the other choices.
+   *
+   * Format: date-time.
+   */
+  to_modified_date?: string;
+}
+
+/**
+ * The params of `vehicle.update`: Update vehicle.
+ */
+export interface VehicleUpdateParams {
+  /**
+   * A descriptive text field.
+   */
+  desc?: string;
+  /**
+   * `edit_sequence` is a server-generated revision token. It changes each time the object is updated. To modify an existing object, you must send the current `edit_sequence`. If your value is stale, the update is rejected to prevent overwriting newer changes.
+   */
+  edit_sequence: string;
+  include_ret_element?: Array<"Desc" | "EditSequence" | "ExternalGUID" | "IsActive" | "ListID" | "Name" | "OwnerID" | "TimeCreated" | "TimeModified" | "TxnID" | "TxnNumber">;
+  /**
+   * If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
+   */
+  is_active?: boolean;
+  /**
+   * `list_id` and FullName both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list type, not globally across all lists. If both FullName and `list_id` are supplied in a request, QuickBooks uses `list_id` and ignores FullName.
+   */
+  list_id: string;
+  /**
+   * Name is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope. Hierarchical lists can reuse the same Name in different branches because FullName remains distinct.
+   */
+  name?: string;
+  /**
+   * Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
+   */
+  request_id?: string;
+}

package/operations/vehicle.js

@@ -0,0 +1,50 @@
+// Generated from operations.json by scripts/generate-operations.js: don't edit.
+"use strict";
+
+/** QuickBooks vehicle operations. Types: vehicle.d.ts. */
+class Vehicle {
+  #client;
+
+  /** @param {import("../index").Client} client */
+  constructor(client) {
+    this.#client = client;
+  }
+
+  /**
+   * Create vehicle.
+   * @param {string} connectionId
+   * @param {import("./vehicle").VehicleCreateParams} params
+   * @param {import("./types").OperationOptions} options
+   * @returns {Promise<import("./types").QueuedRequest>}
+   * @see https://docs.qubesync.com/api-reference/v2/vehicles/create-vehicle
+   */
+  create(connectionId, params, options) {
+    return this.#client.queue("vehicle.create", connectionId, params, options);
+  }
+
+  /**
+   * List vehicles.
+   * @param {string} connectionId
+   * @param {import("./vehicle").VehicleQueryParams} params
+   * @param {import("./types").OperationOptions} options
+   * @returns {Promise<import("./types").QueuedRequest>}
+   * @see https://docs.qubesync.com/api-reference/v2/vehicles/list-vehicles
+   */
+  query(connectionId, params, options) {
+    return this.#client.queue("vehicle.query", connectionId, params, options);
+  }
+
+  /**
+   * Update vehicle.
+   * @param {string} connectionId
+   * @param {import("./vehicle").VehicleUpdateParams} params
+   * @param {import("./types").OperationOptions} options
+   * @returns {Promise<import("./types").QueuedRequest>}
+   * @see https://docs.qubesync.com/api-reference/v2/vehicles/update-vehicle
+   */
+  update(connectionId, params, options) {
+    return this.#client.queue("vehicle.update", connectionId, params, options);
+  }
+}
+
+module.exports = { Vehicle };

package/operations/vehicle_mileage.d.ts

@@ -0,0 +1,147 @@
+// Generated from operations.json by scripts/generate-operations.js: don't edit.
+
+import type { Client } from "../index";
+import type { OperationOptions, QueuedRequest, CurrencyRef, ModifiedDateRangeFilter, TxnDateRangeFilter } from "./types";
+
+/** QuickBooks vehicle mileage operations: `qube.vehicleMileage.<action>(connectionId, params, { webhookUrl })`. */
+export declare class VehicleMileage {
+  constructor(client: Client);
+  /**
+   * Create vehicle mileage: `POST /connections/{connection_id}/vehicle-mileages`, queued for QuickBooks.
+   *
+   * The answer comes to `webhookUrl` as one webhook.
+   * Params go in the JSON body.
+   *
+   * Fields: `billable_status`, `class_ref`, `customer_ref`, `def_macro`, `include_ret_element`, `item_ref`, `notes`, `odometer_end`, `odometer_start`, `request_id`, `total_miles`, `trip_end_date`, `trip_start_date`, `vehicle_ref` (required).
+   *
+   * Give exactly one of: (`odometer_end`, `odometer_start`), or `total_miles`.
+   *
+   * Resolves to the queued request.
+   * @see https://docs.qubesync.com/api-reference/v2/vehicle-mileages/create-vehicle-mileage
+   */
+  create(connectionId: string, params: VehicleMileageCreateParams, options: OperationOptions): Promise<QueuedRequest>;
+  /**
+   * List vehicle mileages: `GET /connections/{connection_id}/vehicle-mileages`, queued for QuickBooks.
+   *
+   * QuickBooks answers in pages: each page comes to `webhookUrl` as its own webhook.
+   * Params go in the query string.
+   *
+   * Fields: `include_ret_element`, `iterator`, `max_returned`, `meta_data`, `modified_date_range_filter`, `request_id`, `txn_date_range_filter`, `txn_id`.
+   *
+   * Resolves to the queued request.
+   * @see https://docs.qubesync.com/api-reference/v2/vehicle-mileages/list-vehicle-mileages
+   */
+  query(connectionId: string, params: VehicleMileageQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
+}
+
+/**
+ * The params of `vehicle_mileage.create`: Create vehicle mileage.
+ *
+ * Give exactly one of: (`odometer_end`, `odometer_start`), or `total_miles`.
+ */
+export interface VehicleMileageCreateParams {
+  /**
+   * The billing status of this item line or expense line.
+   */
+  billable_status?: "Billable" | "HasBeenBilled" | "NotBillable";
+  /**
+   * Use classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks. A `class_ref` points to one class; if both `full_name` and `list_id` are provided, `full_name` is ignored. In InvoiceAdd, a header-level `class_ref` is applied to line items unless you override or clear it on individual lines.
+   */
+  class_ref?: CurrencyRef;
+  /**
+   * `customer_ref` identifies a customer or customer job. If both `full_name` and `list_id` are provided, `full_name` is ignored. In SalesReceipt and ReceivePayment, it identifies who receives credit. In TimeTracking, it identifies who the time can be billed to and is required in TimeTrackingAdd when IsBillable is true.
+   */
+  customer_ref?: CurrencyRef;
+  /**
+   * `def_macro` lets you assign a reusable name to a returned `txn_id` or TxnLineID so later requests can reference it with `useMacro`. This feature requires SDK 2.0+.
+   */
+  def_macro?: string;
+  include_ret_element?: Array<"BillableAmount" | "BillableRate" | "BillableStatus" | "ClassRef" | "CustomerRef" | "EditSequence" | "ExternalGUID" | "ItemRef" | "ListID" | "Notes" | "OdometerEnd" | "OdometerStart" | "OwnerID" | "StandardMileageRate" | "StandardMileageTotalAmount" | "TimeCreated" | "TimeModified" | "TotalMiles" | "TripEndDate" | "TripStartDate" | "TxnID" | "TxnNumber" | "VehicleRef">;
+  /**
+   * `item_ref` may accept all item types or a restricted subset, depending on the request. Examples: PurchaseOrder and Bill do not allow discount or sales-tax items; VehicleMileageAdd requires a service or other-charge item; BillingRateAdd requires a service item. If both `full_name` and `list_id` are provided, `full_name` is ignored.
+   */
+  item_ref?: CurrencyRef;
+  /**
+   * Additional information.
+   */
+  notes?: string;
+  /**
+   * Odometer reading at the end of the trip. `odometer_start` and `odometer_end` must both be specified if `total_miles` isn’t specified. QuickBooks will calculate the total trip miles from these two values. If `total_miles` is specified, you can’t specify `odometer_start` and `odometer_end`.
+   */
+  odometer_end?: number;
+  /**
+   * Odometer reading at the start of the trip. `odometer_start` and `odometer_end` must both be specified if `total_miles` isn’t specified. QuickBooks will calculate the total trip miles from these two values. If `total_miles` is specified, you can’t specify `odometer_start` and `odometer_end`.
+   */
+  odometer_start?: number;
+  /**
+   * Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
+   */
+  request_id?: string;
+  /**
+   * Total trip miles. If `total_miles` is specified, you can’t specify `odometer_start` and `odometer_end`. If you use `odometer_start` and `odometer_end` instead of `total_miles`, QuickBooks will calculate the total trip miles from these two values.
+   */
+  total_miles?: number;
+  /**
+   * Date the trip ended. If left blank, the current date at the time of transaction will be used. Notice that only dates are supported for vehicle mileage, so make sure you enter any datetime values with dates only, no time values. That is, 2002-02-02 will work for trip end date or start date, but 2002-02-02T12:20:20 won’t work.
+   *
+   * Format: date.
+   */
+  trip_end_date?: string;
+  /**
+   * Date the trip began. If left blank, the current date at the time of transaction will be used. Notice that only dates are supported for vehicle mileage, so make sure you enter any datetime values with dates only, no time values. That is, 2002-02-02 will work for trip end date or start date, but 2002-02-02T12:20:20 won’t work.
+   *
+   * Format: date.
+   */
+  trip_start_date?: string;
+  /**
+   * A vehicle for use in VehicleMileage transactions. Each vehicle name must be unique.
+   */
+  vehicle_ref: CurrencyRef;
+}
+
+/**
+ * The params of `vehicle_mileage.query`: List vehicle mileages.
+ */
+export interface VehicleMileageQueryParams {
+  include_ret_element?: Array<"BillableAmount" | "BillableRate" | "BillableStatus" | "ClassRef" | "CustomerRef" | "EditSequence" | "ItemRef" | "Notes" | "OdometerEnd" | "OdometerStart" | "StandardMileageRate" | "StandardMileageTotalAmount" | "TimeCreated" | "TimeModified" | "TotalMiles" | "TripEndDate" | "TripStartDate" | "TxnID" | "VehicleRef">;
+  /**
+   * Page through every match: QuBe Sync asks QuickBooks for each page in turn and sends each to your `webhook_url` as it arrives, all with the same `id`. On by default, with pages of 100 records; send `iterator=true` with `max_returned` for another size. Off when you send `iterator=false` (every match in one answer) or `max_returned` alone (at most that many, in one answer). It pages a filtered query only: with `txn_id` every match comes back in one answer, so leave `iterator` out.
+   */
+  iterator?: boolean;
+  /**
+   * Limits the number of objects that a query returns. (To get a count of how many objects could possibly be returned, use the `meta_data` query attribute.) If you include a `max_returned` value, it must be at least 1.
+   *
+   * The page size, with `iterator=true`. Sent without `iterator`, or with `iterator=false`, it's a cap instead: at most this many records come back, in one answer, and QuickBooks doesn't say whether more matched.
+   *
+   * Choose at most one of: `txn_id`, or the set (`max_returned`, `modified_date_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
+   *
+   * Minimum 1.
+   */
+  max_returned?: number;
+  /**
+   * Use the `meta_data` attribute to control whether query responses include counts. Options are NoMetaData (default), MetaDataOnly (count only), and MetaDataAndResponseData (count plus objects). Counts are approximate and may vary slightly if records are created or deleted during processing.
+   */
+  meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
+  /**
+   * Filters according to the dates when transactions were last modified. The `modified_date_range_filter` aggregate isn’t required to contain any elements, but if it is empty, we recommend that you leave it out altogether. Note that the time portion of the `from_modified_date` and `to_modified_date` fields wasn’t supported in qbXML version 1.0 or 1.1.
+   *
+   * Choose at most one of: `txn_id`, or the set (`max_returned`, `modified_date_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  modified_date_range_filter?: ModifiedDateRangeFilter;
+  /**
+   * Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
+   */
+  request_id?: string;
+  /**
+   * Filters according to the original transaction dates.
+   *
+   * Choose at most one of: `txn_id`, or the set (`max_returned`, `modified_date_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  txn_date_range_filter?: TxnDateRangeFilter;
+  /**
+   * `txn_id` is the unique QuickBooks identifier for a transaction. Use it to reference that transaction in later requests. `txn_id` values are transaction-specific and should not be reused across unrelated transaction types.
+   *
+   * Choose at most one of: `txn_id`, or the set (`max_returned`, `modified_date_range_filter`, `txn_date_range_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  txn_id?: string[];
+}

package/operations/vehicle_mileage.js

@@ -0,0 +1,38 @@
+// Generated from operations.json by scripts/generate-operations.js: don't edit.
+"use strict";
+
+/** QuickBooks vehicle mileage operations. Types: vehicle_mileage.d.ts. */
+class VehicleMileage {
+  #client;
+
+  /** @param {import("../index").Client} client */
+  constructor(client) {
+    this.#client = client;
+  }
+
+  /**
+   * Create vehicle mileage.
+   * @param {string} connectionId
+   * @param {import("./vehicle_mileage").VehicleMileageCreateParams} params
+   * @param {import("./types").OperationOptions} options
+   * @returns {Promise<import("./types").QueuedRequest>}
+   * @see https://docs.qubesync.com/api-reference/v2/vehicle-mileages/create-vehicle-mileage
+   */
+  create(connectionId, params, options) {
+    return this.#client.queue("vehicle_mileage.create", connectionId, params, options);
+  }
+
+  /**
+   * List vehicle mileages (answers in pages, one webhook each).
+   * @param {string} connectionId
+   * @param {import("./vehicle_mileage").VehicleMileageQueryParams} params
+   * @param {import("./types").OperationOptions} options
+   * @returns {Promise<import("./types").QueuedRequest>}
+   * @see https://docs.qubesync.com/api-reference/v2/vehicle-mileages/list-vehicle-mileages
+   */
+  query(connectionId, params, options) {
+    return this.#client.queue("vehicle_mileage.query", connectionId, params, options);
+  }
+}
+
+module.exports = { VehicleMileage };