qube_sync 0.3.0 → 0.4.0

data/lib/qube_sync/operations/unit_of_measure_set.rb

@@ -0,0 +1,149 @@
+# Generated from operations.json by bin/generate-operations: don't edit.
+# frozen_string_literal: true
+
+module QubeSync
+  module Operations
+    # QuickBooks unit of measure set operations, reached as `client.unit_of_measure_set`. Each queues a request and
+    # returns it (the response's `data`); the answer comes to `webhook_url`.
+    class UnitOfMeasureSet < Base
+      # Create unit of measure set: POST /connections/{connection_id}/unit-of-measure-sets
+      # (`unit_of_measure_set.create`).
+      #
+      # QuickBooks answers in one webhook.
+      #
+      # Params, sent as the JSON body:
+      # - `base_unit` (Hash, required): 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.
+      #   - `abbreviation` (String, required): 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.
+      #   - `name` (String, required): 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.
+      # - `default_unit` (Array<Hash>)
+      #   - `unit` (String, required): 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_used_for` (one of "Purchase", "Sales", "Shipping", required): 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.
+      # - `include_ret_element` (Array<one of "BaseUnit", "DefaultUnit", "EditSequence",
+      #   "ExternalGUID", "IsActive", "ListID", "Name", "OwnerID", "RelatedUnit", "TimeCreated",
+      #   "TimeModified", "TxnID", "TxnNumber", "UnitOfMeasureType">)
+      # - `is_active` (Boolean): If `is_active` is true, this object is currently enabled for use by
+      #   QuickBooks. The default value is true.
+      # - `name` (String, required): 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.
+      # - `related_unit` (Array<Hash>)
+      #   - `abbreviation` (String, required): 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.
+      #   - `conversion_ratio` (Numeric, required): 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.
+      #   - `name` (String, required): 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.
+      # - `request_id` (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`.
+      # - `unit_of_measure_type` (one of "Area", "Count", "Length", "Other", "Time", "Volume",
+      #   "Weight", required): 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.
+      #
+      # @param connection_id [String]
+      # @param params [Hash] the fields above
+      # @param webhook_url [String] where QuBe Sync sends the answer
+      # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
+      # @return [Hash] the queued request
+      # @see https://docs.qubesync.com/api-reference/v2/unit-of-measure-sets/create-unit-of-measure-set
+      def create(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("unit_of_measure_set.create", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+
+      # List unit of measure sets: GET /connections/{connection_id}/unit-of-measure-sets
+      # (`unit_of_measure_set.query`).
+      #
+      # QuickBooks answers in one webhook.
+      #
+      # Params, sent as the query string:
+      # - `active_status` (one of "ActiveOnly", "All", "InactiveOnly"): 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.
+      # - `from_modified_date` (String): 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.
+      # - `full_name` (Array<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.
+      # - `include_ret_element` (Array<one of "BaseUnit", "DefaultUnit", "EditSequence", "IsActive",
+      #   "ListID", "Name", "RelatedUnit", "TimeCreated", "TimeModified", "UnitOfMeasureType">)
+      # - `list_id` (Array<String>): `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.
+      # - `max_returned` (Integer): 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.
+      # - `meta_data` (one of "MetaDataAndResponseData", "MetaDataOnly", "NoMetaData"): 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.
+      # - `name_filter` (Hash): 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.
+      #   - `match_criterion` (one of "Contains", "EndsWith", "StartsWith", required): The criterion
+      #     to match.
+      #   - `name` (String, required): The string to match.
+      # - `name_range_filter` (Hash): 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.
+      #   - `from_name` (String): The first name or item in the search range. If `from_name` is
+      #     omitted, the range will begin with first name on the list.
+      #   - `to_name` (String): The final name or item in the search range. If `to_name` is omitted,
+      #     the range will end with last name on the list.
+      # - `request_id` (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`.
+      # - `to_modified_date` (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.
+      #
+      # @param connection_id [String]
+      # @param params [Hash] the fields above
+      # @param webhook_url [String] where QuBe Sync sends the answer
+      # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
+      # @return [Hash] the queued request
+      # @see https://docs.qubesync.com/api-reference/v2/unit-of-measure-sets/list-unit-of-measure-sets
+      def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("unit_of_measure_set.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+    end
+  end
+end

data/lib/qube_sync/operations/vehicle.rb

@@ -0,0 +1,152 @@
+# Generated from operations.json by bin/generate-operations: don't edit.
+# frozen_string_literal: true
+
+module QubeSync
+  module Operations
+    # QuickBooks vehicle operations, reached as `client.vehicle`. Each queues a request and
+    # returns it (the response's `data`); the answer comes to `webhook_url`.
+    class Vehicle < Base
+      # Create vehicle: POST /connections/{connection_id}/vehicles (`vehicle.create`).
+      #
+      # QuickBooks answers in one webhook.
+      #
+      # Params, sent as the JSON body:
+      # - `desc` (String): A descriptive text field.
+      # - `include_ret_element` (Array<one of "Desc", "EditSequence", "ExternalGUID", "IsActive",
+      #   "ListID", "Name", "OwnerID", "TimeCreated", "TimeModified", "TxnID", "TxnNumber">)
+      # - `is_active` (Boolean): If `is_active` is true, this object is currently enabled for use by
+      #   QuickBooks. The default value is true.
+      # - `name` (String, required): 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.
+      # - `request_id` (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`.
+      #
+      # @param connection_id [String]
+      # @param params [Hash] the fields above
+      # @param webhook_url [String] where QuBe Sync sends the answer
+      # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
+      # @return [Hash] the queued request
+      # @see https://docs.qubesync.com/api-reference/v2/vehicles/create-vehicle
+      def create(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("vehicle.create", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+
+      # List vehicles: GET /connections/{connection_id}/vehicles (`vehicle.query`).
+      #
+      # QuickBooks answers in one webhook.
+      #
+      # Params, sent as the query string:
+      # - `active_status` (one of "ActiveOnly", "All", "InactiveOnly"): 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.
+      # - `from_modified_date` (String): 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.
+      # - `full_name` (Array<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.
+      # - `include_ret_element` (Array<one of "Desc", "EditSequence", "IsActive", "ListID", "Name",
+      #   "TimeCreated", "TimeModified">)
+      # - `list_id` (Array<String>): `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.
+      # - `max_returned` (Integer): 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.
+      # - `meta_data` (one of "MetaDataAndResponseData", "MetaDataOnly", "NoMetaData"): 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.
+      # - `name_filter` (Hash): 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.
+      #   - `match_criterion` (one of "Contains", "EndsWith", "StartsWith", required): The criterion
+      #     to match.
+      #   - `name` (String, required): The string to match.
+      # - `name_range_filter` (Hash): 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.
+      #   - `from_name` (String): The first name or item in the search range. If `from_name` is
+      #     omitted, the range will begin with first name on the list.
+      #   - `to_name` (String): The final name or item in the search range. If `to_name` is omitted,
+      #     the range will end with last name on the list.
+      # - `request_id` (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`.
+      # - `to_modified_date` (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.
+      #
+      # @param connection_id [String]
+      # @param params [Hash] the fields above
+      # @param webhook_url [String] where QuBe Sync sends the answer
+      # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
+      # @return [Hash] the queued request
+      # @see https://docs.qubesync.com/api-reference/v2/vehicles/list-vehicles
+      def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("vehicle.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+
+      # Update vehicle: PUT /connections/{connection_id}/vehicles (`vehicle.update`).
+      #
+      # QuickBooks answers in one webhook.
+      #
+      # Params, sent as the JSON body:
+      # - `desc` (String): A descriptive text field.
+      # - `edit_sequence` (String, required): `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.
+      # - `include_ret_element` (Array<one of "Desc", "EditSequence", "ExternalGUID", "IsActive",
+      #   "ListID", "Name", "OwnerID", "TimeCreated", "TimeModified", "TxnID", "TxnNumber">)
+      # - `is_active` (Boolean): If `is_active` is true, this object is currently enabled for use by
+      #   QuickBooks. The default value is true.
+      # - `list_id` (String, required): `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.
+      # - `name` (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.
+      # - `request_id` (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`.
+      #
+      # @param connection_id [String]
+      # @param params [Hash] the fields above
+      # @param webhook_url [String] where QuBe Sync sends the answer
+      # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
+      # @return [Hash] the queued request
+      # @see https://docs.qubesync.com/api-reference/v2/vehicles/update-vehicle
+      def update(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("vehicle.update", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+    end
+  end
+end

data/lib/qube_sync/operations/vehicle_mileage.rb

@@ -0,0 +1,191 @@
+# Generated from operations.json by bin/generate-operations: don't edit.
+# frozen_string_literal: true
+
+module QubeSync
+  module Operations
+    # QuickBooks vehicle mileage operations, reached as `client.vehicle_mileage`. Each queues a request and
+    # returns it (the response's `data`); the answer comes to `webhook_url`.
+    class VehicleMileage < Base
+      # Create vehicle mileage: POST /connections/{connection_id}/vehicle-mileages
+      # (`vehicle_mileage.create`).
+      #
+      # QuickBooks answers in one webhook.
+      #
+      # Params, sent as the JSON body:
+      # Give at most one of: `odometer_end` with `odometer_start`, or `total_miles`.
+      # - `billable_status` (one of "Billable", "HasBeenBilled", "NotBillable"): The billing status
+      #   of this item line or expense line.
+      # - `class_ref` (Hash): 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.
+      #   - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
+      #     object. The `full_name` is the name prefixed by the names of each ancestor, for example
+      #     Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
+      #   - `list_id` (String): `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`.
+      # - `customer_ref` (Hash): `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.
+      #   - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
+      #     object. The `full_name` is the name prefixed by the names of each ancestor, for example
+      #     Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
+      #   - `list_id` (String): `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`.
+      # - `def_macro` (String): `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+.
+      # - `include_ret_element` (Array<one of "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` (Hash): `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.
+      #   - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
+      #     object. The `full_name` is the name prefixed by the names of each ancestor, for example
+      #     Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
+      #   - `list_id` (String): `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`.
+      # - `notes` (String): Additional information.
+      # - `odometer_end` (Numeric): 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_start` (Numeric): 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`.
+      # - `request_id` (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`.
+      # - `total_miles` (Numeric): 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.
+      # - `trip_end_date` (String): 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.
+      # - `trip_start_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.
+      # - `vehicle_ref` (Hash, required): A vehicle for use in VehicleMileage transactions. Each
+      #   vehicle name must be unique.
+      #   - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
+      #     object. The `full_name` is the name prefixed by the names of each ancestor, for example
+      #     Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
+      #   - `list_id` (String): `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`.
+      #
+      # @param connection_id [String]
+      # @param params [Hash] the fields above
+      # @param webhook_url [String] where QuBe Sync sends the answer
+      # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
+      # @return [Hash] the queued request
+      # @see https://docs.qubesync.com/api-reference/v2/vehicle-mileages/create-vehicle-mileage
+      def create(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("vehicle_mileage.create", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+
+      # List vehicle mileages: GET /connections/{connection_id}/vehicle-mileages
+      # (`vehicle_mileage.query`).
+      #
+      # QuickBooks answers in pages: one webhook per page, each with its `page`, the last with
+      # `iteration_state` `done`.
+      #
+      # Params, sent as the query string:
+      # - `include_ret_element` (Array<one of "BillableAmount", "BillableRate", "BillableStatus",
+      #   "ClassRef", "CustomerRef", "EditSequence", "ItemRef", "Notes", "OdometerEnd",
+      #   "OdometerStart", "StandardMileageRate", "StandardMileageTotalAmount", "TimeCreated",
+      #   "TimeModified", "TotalMiles", "TripEndDate", "TripStartDate", "TxnID", "VehicleRef">)
+      # - `iterator` (Boolean): 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.
+      # - `max_returned` (Integer): 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.
+      # - `meta_data` (one of "MetaDataAndResponseData", "MetaDataOnly", "NoMetaData"): 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.
+      # - `modified_date_range_filter` (Hash): 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.
+      #   - `from_modified_date` (String): 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.
+      #   - `to_modified_date` (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).
+      # - `request_id` (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`.
+      # - `txn_date_range_filter` (Hash): 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.
+      #   Give at most one of: `from_txn_date` with `to_txn_date`, or `date_macro`.
+      #   - `date_macro` (one of "All", "LastCalendarQuarter", "LastCalendarQuarterToDate",
+      #     "LastCalendarYear", "LastCalendarYearToDate", "LastFiscalQuarter",
+      #     "LastFiscalQuarterToDate", "LastFiscalYear", "LastFiscalYearToDate", "LastMonth",
+      #     "LastMonthToDate", "LastWeek", "LastWeekToDate", "NextCalendarQuarter",
+      #     "NextCalendarYear", "NextFiscalQuarter", "NextFiscalYear", "NextFourWeeks", "NextMonth",
+      #     "NextWeek", "ThisCalendarQuarter", "ThisCalendarQuarterToDate", "ThisCalendarYear",
+      #     "ThisCalendarYearToDate", "ThisFiscalQuarter", "ThisFiscalQuarterToDate",
+      #     "ThisFiscalYear", "ThisFiscalYearToDate", "ThisMonth", "ThisMonthToDate", "ThisWeek",
+      #     "ThisWeekToDate", "Today", "Yesterday"): `date_macro` filters by transaction date (not
+      #     last-modified date). Do not combine `date_macro` with
+      #     `from_modified_date`/`to_modified_date` in the same query filter set.
+      #   - `from_txn_date` (String): Selects transactions created on or after this date. Both
+      #     `from_txn_date` and `to_txn_date` must be between 01/01/1901 and 12/31/9999.If you omit
+      #     `from_txn_date`, it will be set to 1970-01-01 (1969-12-31 PST).
+      #   - `to_txn_date` (String): Selects transactions created on or before this date. Both
+      #     `to_txn_date` and `from_txn_date` must be between 01/01/1901 and 12/31/9999. If you omit
+      #     `to_txn_date`, it will be set to 2038-01-19 (2038-01-18 PST).
+      # - `txn_id` (Array<String>): `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.
+      #
+      # @param connection_id [String]
+      # @param params [Hash] the fields above
+      # @param webhook_url [String] where QuBe Sync sends the answer
+      # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
+      # @return [Hash] the queued request
+      # @see https://docs.qubesync.com/api-reference/v2/vehicle-mileages/list-vehicle-mileages
+      def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("vehicle_mileage.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+    end
+  end
+end