qube_sync 0.3.0 → 0.4.0

data/lib/qube_sync/operations/time_tracking.rb

@@ -0,0 +1,303 @@
+# Generated from operations.json by bin/generate-operations: don't edit.
+# frozen_string_literal: true
+
+module QubeSync
+  module Operations
+    # QuickBooks time tracking operations, reached as `client.time_tracking`. Each queues a request and
+    # returns it (the response's `data`); the answer comes to `webhook_url`.
+    class TimeTracking < Base
+      # Create time tracking: POST /connections/{connection_id}/time-trackings
+      # (`time_tracking.create`).
+      #
+      # QuickBooks answers in one webhook.
+      #
+      # Params, sent as the JSON body:
+      # - `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+.
+      # - `duration` (String, required): Time spent doing the work. In a TimeTrackAdd request,
+      #   notice that although you can specify seconds, seconds aren’t returned in the response
+      #   because the UI doesn’t use seconds.
+      # - `entity_ref` (Hash, required): A QuickBooks “entity” is a customer, vendor, employee, or
+      #   person on the QuickBooks “other names” list. Special cases to note: In a BillToPayQuery
+      #   message, `entity_ref` refers to the vendor name. In JournalCreditLine and JournalDebitLine
+      #   messages for A/R accounts, `entity_ref` must refer to a customer, or else the transaction
+      #   won’t be recorded.
+      #   - `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`.
+      # - `external_guid` (String): Allows for the attachment of a user defined GUID value.
+      # - `include_ret_element` (Array<one of "BillableStatus", "ClassRef", "CustomerRef",
+      #   "Duration", "EditSequence", "EntityRef", "ExternalGUID", "ItemServiceRef", "ListID",
+      #   "Notes", "OwnerID", "PayrollItemWageRef", "Rate", "TimeCreated", "TimeModified",
+      #   "TxnDate", "TxnID", "TxnNumber">)
+      # - `item_service_ref` (Hash): A service item refers to services that a business charges for
+      #   or purchases. Examples include specialized labor, consulting hours, and professional fees.
+      #   An `item_service_ref` aggregate refers to an item on the ItemService list. In a request,
+      #   if an `item_service_ref` aggregate includes both `full_name` and `list_id`, `full_name`
+      #   will be 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.
+      # - `payroll_item_wage_ref` (Hash): Each payroll wage item describes and names a payment
+      #   scheme, for example, Regular Pay or Overtime Pay. A `payroll_item_wage_ref` aggregate
+      #   refers to one of these wage items. In a request, if a `payroll_item_wage_ref` aggregate
+      #   includes both `full_name` and `list_id`, `full_name` will be 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`.
+      # - `rate` (Numeric)
+      # - `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` (String): The date of the transaction. In some cases, if you leave `txn_date`
+      #   out of an -Add message, QuickBooks will prefill `txn_date` with the date of the last-saved
+      #   transaction of the same type.
+      #
+      # @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/time-trackings/create-time-tracking
+      def create(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("time_tracking.create", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+
+      # List time trackings: GET /connections/{connection_id}/time-trackings
+      # (`time_tracking.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 "BillableStatus", "ClassRef", "CustomerRef",
+      #   "Duration", "EditSequence", "EntityRef", "ExternalGUID", "ItemServiceRef", "Notes",
+      #   "PayrollItemWageRef", "Rate", "TimeCreated", "TimeModified", "TxnDate", "TxnID",
+      #   "TxnNumber">)
+      # - `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`, `time_tracking_entity_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`, `time_tracking_entity_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`.
+      # - `time_tracking_entity_filter` (Hash): Allows you to query for one or more names on the
+      #   QuickBooks Vendor list, Employee list, or Other Names list. Choose at most one of:
+      #   `txn_id`, or the set (`max_returned`, `modified_date_range_filter`,
+      #   `time_tracking_entity_filter`, `txn_date_range_filter`). Members of a set combine with
+      #   each other, not with the other choices.
+      #   Give at most one of: `list_id`, or `full_name`.
+      #   - `full_name` (Array<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` (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`.
+      # - `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`,
+      #   `time_tracking_entity_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`,
+      #   `time_tracking_entity_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/time-trackings/list-time-trackings
+      def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("time_tracking.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+
+      # Update time tracking: PUT /connections/{connection_id}/time-trackings
+      # (`time_tracking.update`).
+      #
+      # QuickBooks answers in one webhook.
+      #
+      # Params, sent as the JSON body:
+      # - `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`.
+      # - `duration` (String, required): Time spent doing the work. In a TimeTrackAdd request,
+      #   notice that although you can specify seconds, seconds aren’t returned in the response
+      #   because the UI doesn’t use seconds.
+      # - `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.
+      # - `entity_ref` (Hash, required): A QuickBooks “entity” is a customer, vendor, employee, or
+      #   person on the QuickBooks “other names” list. Special cases to note: In a BillToPayQuery
+      #   message, `entity_ref` refers to the vendor name. In JournalCreditLine and JournalDebitLine
+      #   messages for A/R accounts, `entity_ref` must refer to a customer, or else the transaction
+      #   won’t be recorded.
+      #   - `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`.
+      # - `include_ret_element` (Array<one of "BillableStatus", "ClassRef", "CustomerRef",
+      #   "Duration", "EditSequence", "EntityRef", "ExternalGUID", "ItemServiceRef", "ListID",
+      #   "Notes", "OwnerID", "PayrollItemWageRef", "Rate", "TimeCreated", "TimeModified",
+      #   "TxnDate", "TxnID", "TxnNumber">)
+      # - `item_service_ref` (Hash): A service item refers to services that a business charges for
+      #   or purchases. Examples include specialized labor, consulting hours, and professional fees.
+      #   An `item_service_ref` aggregate refers to an item on the ItemService list. In a request,
+      #   if an `item_service_ref` aggregate includes both `full_name` and `list_id`, `full_name`
+      #   will be 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.
+      # - `payroll_item_wage_ref` (Hash): Each payroll wage item describes and names a payment
+      #   scheme, for example, Regular Pay or Overtime Pay. A `payroll_item_wage_ref` aggregate
+      #   refers to one of these wage items. In a request, if a `payroll_item_wage_ref` aggregate
+      #   includes both `full_name` and `list_id`, `full_name` will be 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`.
+      # - `rate` (Numeric)
+      # - `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` (String): The date of the transaction. In some cases, if you leave `txn_date`
+      #   out of an -Add message, QuickBooks will prefill `txn_date` with the date of the last-saved
+      #   transaction of the same type.
+      # - `txn_id` (String, required): `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.
+      #
+      # @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/time-trackings/update-time-tracking
+      def update(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("time_tracking.update", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+    end
+  end
+end

data/lib/qube_sync/operations/to_do.rb

@@ -0,0 +1,260 @@
+# Generated from operations.json by bin/generate-operations: don't edit.
+# frozen_string_literal: true
+
+module QubeSync
+  module Operations
+    # QuickBooks to do operations, reached as `client.to_do`. Each queues a request and
+    # returns it (the response's `data`); the answer comes to `webhook_url`.
+    class ToDo < Base
+      # Create to do: POST /connections/{connection_id}/to-dos (`to_do.create`).
+      #
+      # QuickBooks answers in one webhook.
+      #
+      # Params, sent as the JSON body:
+      # - `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. Choose
+      #   at most one of: `customer_ref`, or `employee_ref`, or `lead_ref`, or `vendor_ref`.
+      #   - `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`.
+      # - `employee_ref` (Hash): The employee list contains payroll information about each of the
+      #   company’s employees. Choose at most one of: `customer_ref`, or `employee_ref`, or
+      #   `lead_ref`, or `vendor_ref`.
+      #   - `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`.
+      # - `include_ret_element` (Array<one of "CustomerRef", "EditSequence", "EmployeeRef",
+      #   "ExternalGUID", "IsActive", "IsDone", "LeadRef", "ListID", "Notes", "OwnerID", "Priority",
+      #   "ReminderDate", "ReminderTime", "TimeCreated", "TimeModified", "TxnID", "TxnNumber",
+      #   "Type", "VendorRef">)
+      # - `is_active` (Boolean): If `is_active` is true, this object is currently enabled for use by
+      #   QuickBooks. The default value is true.
+      # - `is_done` (Boolean): If `is_done` is true, this “to do” task has been completed. The
+      #   default value of `is_done` is false.
+      # - `lead_ref` (Hash): The lead list contains information about leads for a company. Choose at
+      #   most one of: `customer_ref`, or `employee_ref`, or `lead_ref`, or `vendor_ref`.
+      #   - `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, required): Additional information.
+      # - `priority` (one of "High", "Low", "Medium"): Priority may have one of the following
+      #   values: Low [DEFAULT], Medium, High
+      # - `reminder_date` (String): The date on which the contents of the Notes string will appear
+      #   on the Reminder list within QuickBooks.
+      # - `reminder_time` (String): The time on which the contents of the Notes string will appear
+      #   on the Reminder list within QuickBooks.
+      # - `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`.
+      # - `type` (one of "Appointment", "Call", "Email", "Fax", "Meeting", "Task"): Type may have
+      #   one of the following values: Task [DEFAULT], Call, Fax, Email, Meeting, Appointment
+      # - `vendor_ref` (Hash): A vendor is any person or company from whom a small business owner
+      #   buys goods and services. (Banks and tax agencies usually are included on the vendor list.)
+      #   A company’s vendor list contains information such as account balance and contact
+      #   information about each vendor. A `vendor_ref` aggregate refers to one of the vendors on
+      #   the list. Choose at most one of: `customer_ref`, or `employee_ref`, or `lead_ref`, or
+      #   `vendor_ref`.
+      #   - `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/to-dos/create-to-do
+      def create(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("to_do.create", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+
+      # List to dos: GET /connections/{connection_id}/to-dos (`to_do.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 the set (`active_status`, `done_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.
+      # - `done_status` (one of "All", "DoneOnly", "NotDoneOnly"): Selects all the relevant “to do”
+      #   notes (dsAll), only those that are done (dsDoneOnly), or only those that aren’t done
+      #   (dsNotDoneOnly). Choose at most one of: `list_id`, or the set (`active_status`,
+      #   `done_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 the set
+      #   (`active_status`, `done_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 "CustomerRef", "EditSequence", "EmployeeRef",
+      #   "IsActive", "IsDone", "LeadRef", "ListID", "Notes", "Priority", "ReminderDate",
+      #   "ReminderTime", "TimeCreated", "TimeModified", "Type", "VendorRef">)
+      # - `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 the set (`active_status`, `done_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 the set (`active_status`, `done_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 the set (`active_status`, `done_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 the set (`active_status`, `done_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 the set (`active_status`, `done_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/to-dos/list-to-dos
+      def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("to_do.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+
+      # Update to do: PUT /connections/{connection_id}/to-dos (`to_do.update`).
+      #
+      # QuickBooks answers in one webhook.
+      #
+      # Params, sent as the JSON body:
+      # - `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. Choose
+      #   at most one of: `customer_ref`, or `employee_ref`, or `lead_ref`, or `vendor_ref`.
+      #   - `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`.
+      # - `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.
+      # - `employee_ref` (Hash): The employee list contains payroll information about each of the
+      #   company’s employees. Choose at most one of: `customer_ref`, or `employee_ref`, or
+      #   `lead_ref`, or `vendor_ref`.
+      #   - `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`.
+      # - `include_ret_element` (Array<one of "CustomerRef", "EditSequence", "EmployeeRef",
+      #   "ExternalGUID", "IsActive", "IsDone", "LeadRef", "ListID", "Notes", "OwnerID", "Priority",
+      #   "ReminderDate", "ReminderTime", "TimeCreated", "TimeModified", "TxnID", "TxnNumber",
+      #   "Type", "VendorRef">)
+      # - `is_active` (Boolean): If `is_active` is true, this object is currently enabled for use by
+      #   QuickBooks. The default value is true.
+      # - `is_done` (Boolean): If `is_done` is true, this “to do” task has been completed. The
+      #   default value of `is_done` is false.
+      # - `lead_ref` (Hash): The lead list contains information about leads for a company. Choose at
+      #   most one of: `customer_ref`, or `employee_ref`, or `lead_ref`, or `vendor_ref`.
+      #   - `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`.
+      # - `list_id` (String, required): `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.
+      # - `priority` (one of "High", "Low", "Medium"): Priority may have one of the following
+      #   values: Low [DEFAULT], Medium, High
+      # - `reminder_date` (String): The date on which the contents of the Notes string will appear
+      #   on the Reminder list within QuickBooks.
+      # - `reminder_time` (String): The time on which the contents of the Notes string will appear
+      #   on the Reminder list within QuickBooks.
+      # - `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`.
+      # - `type` (one of "Appointment", "Call", "Email", "Fax", "Meeting", "Task"): Type may have
+      #   one of the following values: Task [DEFAULT], Call, Fax, Email, Meeting, Appointment
+      # - `vendor_ref` (Hash): A vendor is any person or company from whom a small business owner
+      #   buys goods and services. (Banks and tax agencies usually are included on the vendor list.)
+      #   A company’s vendor list contains information such as account balance and contact
+      #   information about each vendor. A `vendor_ref` aggregate refers to one of the vendors on
+      #   the list. Choose at most one of: `customer_ref`, or `employee_ref`, or `lead_ref`, or
+      #   `vendor_ref`.
+      #   - `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/to-dos/update-to-do
+      def update(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("to_do.update", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+    end
+  end
+end