qubesync 0.1.0 → 0.2.0

package/operations/transaction.d.ts

@@ -0,0 +1,244 @@
+// Generated from operations.json by scripts/generate-operations.js: don't edit.
+
+import type { Client } from "../index";
+import type { OperationOptions, QueuedRequest, AccountFilter, CurrencyFilter, RefNumberFilter, RefNumberRangeFilter, ReportTxnTypeFilter, TxnDateRangeFilterBill } from "./types";
+
+/** QuickBooks transaction operations: `qube.transaction.<action>(connectionId, params, { webhookUrl })`. */
+export declare class Transaction {
+  constructor(client: Client);
+  /**
+   * List transactions: `GET /connections/{connection_id}/transactions`, queued for QuickBooks.
+   *
+   * QuickBooks answers in pages: each page comes to `webhookUrl` as its own webhook.
+   * Params go in the query string.
+   *
+   * Fields: `currency_filter`, `include_ret_element`, `iterator`, `max_returned`, `meta_data`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `request_id`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`, `txn_id`.
+   *
+   * Resolves to the queued request.
+   * @see https://docs.qubesync.com/api-reference/v2/transactions/list-transactions
+   */
+  query(connectionId: string, params: TransactionQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
+}
+
+/**
+ * The params of `transaction.query`: List transactions.
+ */
+export interface TransactionQueryParams {
+  /**
+   * Filters by the specified currency.
+   *
+   * Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  currency_filter?: CurrencyFilter;
+  include_ret_element?: Array<"AccountRef" | "Amount" | "AmountInHomeCurrency" | "CurrencyRef" | "EntityRef" | "ExchangeRate" | "Memo" | "RefNumber" | "TimeCreated" | "TimeModified" | "TxnDate" | "TxnID" | "TxnLineID" | "TxnType">;
+  /**
+   * 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 (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_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";
+  /**
+   * `ref_number` is a user-managed transaction reference (for example, a check number). It can be edited and is not guaranteed to be globally unique. Some transaction types auto-populate `ref_number` when omitted, based on QuickBooks preferences and numbering state.
+   *
+   * Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  ref_number?: string[];
+  /**
+   * Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  ref_number_case_sensitive?: string[];
+  /**
+   * Filters by `ref_number` range. Numeric-only bounds are compared numerically; otherwise comparison is lexicographic.
+   *
+   * Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  ref_number_filter?: RefNumberFilter;
+  /**
+   * Filters by `ref_number` range. Numeric-only bounds are compared numerically; otherwise comparison is lexicographic.
+   *
+   * Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  ref_number_range_filter?: RefNumberRangeFilter;
+  /**
+   * 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 the transactions based on the `account_ref` in the transaction or transaction line using an account type filter or a specific `list_id`, or a `full_name`, or a `list_id_with_children`, or a `full_name_with_children`. To filter on transaction lines, you must specify the `transaction_detail_level_filter` with a value of either “All” or “AllExceptSummary”.
+   *
+   * Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  transaction_account_filter?: TransactionAccountFilter;
+  /**
+   * Filters the transactions based on the ClassRef in the transaction or transaction line by using a specific `list_id`, or a `full_name`, or a `list_id_with_children`, or a `full_name_with_children`. To filter on transaction lines, you must specify the `transaction_detail_level_filter` with a value of either “All” or “AllExceptSummary”.
+   *
+   * Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  transaction_class_filter?: AccountFilter;
+  /**
+   * Filters the transactions based on the transaction’s date either by specifying a “from” and/or “to” date, or by using a `date_macro`.
+   *
+   * Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  transaction_date_range_filter?: TxnDateRangeFilterBill;
+  /**
+   * Allows you to specify the detail level of the query results. You can specify all, summary only (the default), or all except summary. Summary only refers to the transaction as a whole, whereas all except summary refers to the transaction lines.
+   *
+   * Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  transaction_detail_level_filter?: "All" | "AllExceptSummary" | "SummaryOnly";
+  /**
+   * Filters the transactions based on the `entity_ref` used in the transaction or transaction line by specifying an entity type filter, a `list_id`, a `full_name`, a `list_id_with_children`, or a `full_name_with_children`. If you want to filter on transaction lines you must specify the `transaction_detail_level_filter` with a value of either “All” or “AllExceptSummary”.
+   *
+   * Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  transaction_entity_filter?: TransactionEntityFilter;
+  /**
+   * Filters the transactions based on the ItemRef used in the transaction line using an item type filter, or a specific `list_id`, or a `full_name`, or a `list_id_with_children`, or a `full_name_with_children`. To filter on transaction lines, you must specify the `transaction_detail_level_filter` with a value of either “All” or “AllExceptSummary”.
+   *
+   * Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  transaction_item_filter?: TransactionItemFilter;
+  /**
+   * Filters the transactions based on the transaction’s modified datetime, either by specifying a “from” and/or “to” date or by using a `date_macro`.
+   *
+   * Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  transaction_modified_date_range_filter?: TransactionModifiedDateRangeFilter;
+  /**
+   * This filter allows you to search for “open” transactions, i.e. transactions with a remaining balance (for example, credits not fully applied or invoices not fully paid). Valid values are closed, open, or either, which is the default.
+   *
+   * Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  transaction_paid_status_filter?: "Closed" | "Either" | "Open";
+  /**
+   * Allows you to filter transactions based on posting status. Valid values are posting, non-posting, or either. The default is “either.” (Posting status refers to whether QuickBooks records a transaction in one of your account registers.)
+   *
+   * Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  transaction_posting_status_filter?: "Either" | "NonPosting" | "Posting";
+  /**
+   * Filters the transactions based on the transaction’s type. You can specify one or more transaction types in the filter. Notice that TimeTracking transactions aren’t supported. If you set the transaction type filter to “All” (or if you don’t set it at all), the query will be searching only those transaction types that are permissible types for the user currently logged in.
+   *
+   * Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  transaction_type_filter?: ReportTxnTypeFilter;
+  /**
+   * `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 (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices.
+   */
+  txn_id?: string[];
+}
+
+/**
+ * Give exactly one of: `account_type_filter`, or `list_id`, or `full_name`, or `list_id_with_children`, or `full_name_with_children`.
+ */
+export interface TransactionAccountFilter {
+  /**
+   * Allows you to report on a specific account type.
+   */
+  account_type_filter?: "APAndSalesTax" | "APOrCreditCard" | "ARAndAP" | "AccountsPayable" | "AccountsReceivable" | "AllowedFor1099" | "Asset" | "BalanceSheet" | "Bank" | "BankAndARAndAPAndUF" | "BankAndUF" | "CostOfSales" | "CreditCard" | "CurrentAsset" | "CurrentAssetAndExpense" | "CurrentLiability" | "Equity" | "EquityAndIncomeAndExpense" | "ExpenseAndOtherExpense" | "FixedAsset" | "IncomeAndExpense" | "IncomeAndOtherIncome" | "Liability" | "LiabilityAndEquity" | "LongTermLiability" | "NonPosting" | "OrdinaryExpense" | "OrdinaryIncome" | "OrdinaryIncomeAndCOGS" | "OrdinaryIncomeAndExpense" | "OtherAsset" | "OtherCurrentAsset" | "OtherCurrentLiability" | "OtherExpense" | "OtherIncome" | "OtherIncomeOrExpense";
+  /**
+   * `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.
+   */
+  full_name?: string[];
+  /**
+   * Allows you to filter for data that relates to the specified object and its descendants. For names that don’t have children, `full_name_with_children` is exactly the same as `full_name`.
+   */
+  full_name_with_children?: 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[];
+  /**
+   * Allows you to filter for data that relates to the specified object and its descendants.
+   */
+  list_id_with_children?: string;
+}
+
+/**
+ * Give exactly one of: `entity_type_filter`, or `list_id`, or `full_name`, or `list_id_with_children`, or `full_name_with_children`.
+ */
+export interface TransactionEntityFilter {
+  /**
+   * Allows you to report on a specific name type.
+   */
+  entity_type_filter?: "Customer" | "Employee" | "OtherName" | "Vendor";
+  /**
+   * `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.
+   */
+  full_name?: string[];
+  /**
+   * Allows you to filter for data that relates to the specified object and its descendants. For names that don’t have children, `full_name_with_children` is exactly the same as `full_name`.
+   */
+  full_name_with_children?: 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[];
+  /**
+   * Allows you to filter for data that relates to the specified object and its descendants.
+   */
+  list_id_with_children?: string;
+}
+
+/**
+ * Give exactly one of: `item_type_filter`, or `list_id`, or `full_name`, or `list_id_with_children`, or `full_name_with_children`.
+ */
+export interface TransactionItemFilter {
+  /**
+   * `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.
+   */
+  full_name?: string[];
+  /**
+   * Allows you to filter for data that relates to the specified object and its descendants. For names that don’t have children, `full_name_with_children` is exactly the same as `full_name`.
+   */
+  full_name_with_children?: string;
+  /**
+   * Allows you to report on a specific item type.
+   */
+  item_type_filter?: "AllExceptFixedAsset" | "Assembly" | "Discount" | "FixedAsset" | "Inventory" | "InventoryAndAssembly" | "NonInventory" | "OtherCharge" | "Payment" | "Sales" | "SalesTax" | "Service";
+  /**
+   * `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[];
+  /**
+   * Allows you to filter for data that relates to the specified object and its descendants.
+   */
+  list_id_with_children?: string;
+}
+
+/**
+ * Give exactly one of: (`from_modified_date`, `to_modified_date`), or `date_macro`.
+ */
+export interface TransactionModifiedDateRangeFilter {
+  /**
+   * `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.
+   */
+  date_macro?: "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";
+  /**
+   * 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.
+   *
+   * Format: date-time.
+   */
+  from_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).
+   *
+   * Format: date-time.
+   */
+  to_modified_date?: string;
+}

package/operations/transaction.js

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

package/operations/transfer.d.ts

@@ -0,0 +1,178 @@
+// 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 transfer operations: `qube.transfer.<action>(connectionId, params, { webhookUrl })`. */
+export declare class Transfer {
+  constructor(client: Client);
+  /**
+   * Create transfer: `POST /connections/{connection_id}/transfers`, queued for QuickBooks.
+   *
+   * The answer comes to `webhookUrl` as one webhook.
+   * Params go in the JSON body.
+   *
+   * Fields: `amount`, `class_ref`, `def_macro`, `include_ret_element`, `memo`, `request_id`, `transfer_from_account_ref`, `transfer_to_account_ref`, `txn_date`.
+   *
+   * Resolves to the queued request.
+   * @see https://docs.qubesync.com/api-reference/v2/transfers/create-transfer
+   */
+  create(connectionId: string, params: TransferCreateParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
+  /**
+   * List transfers: `GET /connections/{connection_id}/transfers`, 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/transfers/list-transfers
+   */
+  query(connectionId: string, params: TransferQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
+  /**
+   * Update transfer: `PUT /connections/{connection_id}/transfers`, queued for QuickBooks.
+   *
+   * The answer comes to `webhookUrl` as one webhook.
+   * Params go in the JSON body.
+   *
+   * Fields: `amount`, `class_ref`, `edit_sequence` (required), `include_ret_element`, `memo`, `request_id`, `transfer_from_account_ref`, `transfer_to_account_ref`, `txn_date`, `txn_id` (required).
+   *
+   * Resolves to the queued request.
+   * @see https://docs.qubesync.com/api-reference/v2/transfers/update-transfer
+   */
+  update(connectionId: string, params: TransferUpdateParams, options: OperationOptions): Promise<QueuedRequest>;
+}
+
+/**
+ * The params of `transfer.create`: Create transfer.
+ */
+export interface TransferCreateParams {
+  /**
+   * A monetary amount.
+   */
+  amount?: number;
+  /**
+   * 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;
+  /**
+   * `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<"Amount" | "ClassRef" | "EditSequence" | "FromAccountBalance" | "Memo" | "TimeCreated" | "TimeModified" | "ToAccountBalance" | "TransferFromAccountRef" | "TransferToAccountRef" | "TxnDate" | "TxnID" | "TxnNumber">;
+  /**
+   * Additional information.
+   */
+  memo?: 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;
+  /**
+   * Account that money will be transferred from.
+   */
+  transfer_from_account_ref?: CurrencyRef;
+  /**
+   * Account that money will be transferred to.
+   */
+  transfer_to_account_ref?: CurrencyRef;
+  /**
+   * 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.
+   *
+   * Format: date.
+   */
+  txn_date?: string;
+}
+
+/**
+ * The params of `transfer.query`: List transfers.
+ */
+export interface TransferQueryParams {
+  include_ret_element?: Array<"Amount" | "ClassRef" | "EditSequence" | "FromAccountBalance" | "Memo" | "TimeCreated" | "TimeModified" | "ToAccountBalance" | "TransferFromAccountRef" | "TransferToAccountRef" | "TxnDate" | "TxnID" | "TxnNumber">;
+  /**
+   * 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[];
+}
+
+/**
+ * The params of `transfer.update`: Update transfer.
+ */
+export interface TransferUpdateParams {
+  /**
+   * A monetary amount.
+   */
+  amount?: number;
+  /**
+   * 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;
+  /**
+   * `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<"Amount" | "ClassRef" | "EditSequence" | "FromAccountBalance" | "Memo" | "TimeCreated" | "TimeModified" | "ToAccountBalance" | "TransferFromAccountRef" | "TransferToAccountRef" | "TxnDate" | "TxnID" | "TxnNumber">;
+  /**
+   * Additional information.
+   */
+  memo?: 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;
+  /**
+   * Account that money will be transferred from.
+   */
+  transfer_from_account_ref?: CurrencyRef;
+  /**
+   * Account that money will be transferred to.
+   */
+  transfer_to_account_ref?: CurrencyRef;
+  /**
+   * 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.
+   *
+   * Format: date.
+   */
+  txn_date?: 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.
+   */
+  txn_id: string;
+}

package/operations/transfer.js

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