qubesync 0.1.0 → 0.2.0

package/operations/receive_payment_to_deposit.d.ts

@@ -0,0 +1,36 @@
+// Generated from operations.json by scripts/generate-operations.js: don't edit.
+
+import type { Client } from "../index";
+import type { OperationOptions, QueuedRequest } from "./types";
+
+/** QuickBooks receive payment to deposit operations: `qube.receivePaymentToDeposit.<action>(connectionId, params, { webhookUrl })`. */
+export declare class ReceivePaymentToDeposit {
+  constructor(client: Client);
+  /**
+   * List receive payment to deposits: `GET /connections/{connection_id}/receive-payment-to-deposits`, queued for QuickBooks.
+   *
+   * The answer comes to `webhookUrl` as one webhook.
+   * Params go in the query string.
+   *
+   * Fields: `include_ret_element`, `meta_data`, `request_id`.
+   *
+   * Resolves to the queued request.
+   * @see https://docs.qubesync.com/api-reference/v2/receive-payment-to-deposits/list-receive-payment-to-deposits
+   */
+  query(connectionId: string, params: ReceivePaymentToDepositQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
+}
+
+/**
+ * The params of `receive_payment_to_deposit.query`: List receive payment to deposits.
+ */
+export interface ReceivePaymentToDepositQueryParams {
+  include_ret_element?: Array<"Amount" | "AmountInHomeCurrency" | "CurrencyRef" | "CustomerRef" | "ExchangeRate" | "RefNumber" | "TxnDate" | "TxnID" | "TxnLineID" | "TxnType">;
+  /**
+   * 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";
+  /**
+   * Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
+   */
+  request_id?: string;
+}

package/operations/receive_payment_to_deposit.js

@@ -0,0 +1,26 @@
+// Generated from operations.json by scripts/generate-operations.js: don't edit.
+"use strict";
+
+/** QuickBooks receive payment to deposit operations. Types: receive_payment_to_deposit.d.ts. */
+class ReceivePaymentToDeposit {
+  #client;
+
+  /** @param {import("../index").Client} client */
+  constructor(client) {
+    this.#client = client;
+  }
+
+  /**
+   * List receive payment to deposits.
+   * @param {string} connectionId
+   * @param {import("./receive_payment_to_deposit").ReceivePaymentToDepositQueryParams} params
+   * @param {import("./types").OperationOptions} options
+   * @returns {Promise<import("./types").QueuedRequest>}
+   * @see https://docs.qubesync.com/api-reference/v2/receive-payment-to-deposits/list-receive-payment-to-deposits
+   */
+  query(connectionId, params, options) {
+    return this.#client.queue("receive_payment_to_deposit.query", connectionId, params, options);
+  }
+}
+
+module.exports = { ReceivePaymentToDeposit };