qubesync 0.1.0 → 0.2.0

package/operations/customer.js

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

package/operations/customer_msg.d.ts

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

package/operations/customer_msg.js

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

package/operations/customer_type.d.ts

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

package/operations/customer_type.js

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

package/operations/data_event_recovery_info.d.ts

@@ -0,0 +1,61 @@
+// Generated from operations.json by scripts/generate-operations.js: don't edit.
+
+import type { Client } from "../index";
+import type { OperationOptions, QueuedRequest } from "./types";
+
+/** QuickBooks data event recovery info operations: `qube.dataEventRecoveryInfo.<action>(connectionId, params, { webhookUrl })`. */
+export declare class DataEventRecoveryInfo {
+  constructor(client: Client);
+  /**
+   * Delete data event recovery info: `DELETE /connections/{connection_id}/data-event-recovery-infos`, queued for QuickBooks.
+   *
+   * The answer comes to `webhookUrl` as one webhook.
+   * Params go in the JSON body.
+   *
+   * Fields: `request_id`, `subscriber_id` (required).
+   *
+   * Resolves to the queued request.
+   * @see https://docs.qubesync.com/api-reference/v2/data-event-recovery-infos/delete-data-event-recovery-info
+   */
+  delete(connectionId: string, params: DataEventRecoveryInfoDeleteParams, options: OperationOptions): Promise<QueuedRequest>;
+  /**
+   * List data event recovery infos: `GET /connections/{connection_id}/data-event-recovery-infos`, queued for QuickBooks.
+   *
+   * The answer comes to `webhookUrl` as one webhook.
+   * Params go in the query string.
+   *
+   * Fields: `request_id`, `subscriber_id` (required).
+   *
+   * Resolves to the queued request.
+   * @see https://docs.qubesync.com/api-reference/v2/data-event-recovery-infos/list-data-event-recovery-infos
+   */
+  query(connectionId: string, params: DataEventRecoveryInfoQueryParams, options: OperationOptions): Promise<QueuedRequest>;
+}
+
+/**
+ * The params of `data_event_recovery_info.delete`: Delete data event recovery info.
+ */
+export interface DataEventRecoveryInfoDeleteParams {
+  /**
+   * 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;
+  /**
+   * A unique identifier that an application sets when it adds a subscription so that the application can later query or delete the subscription.
+   */
+  subscriber_id: string;
+}
+
+/**
+ * The params of `data_event_recovery_info.query`: List data event recovery infos.
+ */
+export interface DataEventRecoveryInfoQueryParams {
+  /**
+   * 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;
+  /**
+   * A unique identifier that an application sets when it adds a subscription so that the application can later query or delete the subscription.
+   */
+  subscriber_id: string;
+}

package/operations/data_event_recovery_info.js

@@ -0,0 +1,38 @@
+// Generated from operations.json by scripts/generate-operations.js: don't edit.
+"use strict";
+
+/** QuickBooks data event recovery info operations. Types: data_event_recovery_info.d.ts. */
+class DataEventRecoveryInfo {
+  #client;
+
+  /** @param {import("../index").Client} client */
+  constructor(client) {
+    this.#client = client;
+  }
+
+  /**
+   * Delete data event recovery info.
+   * @param {string} connectionId
+   * @param {import("./data_event_recovery_info").DataEventRecoveryInfoDeleteParams} params
+   * @param {import("./types").OperationOptions} options
+   * @returns {Promise<import("./types").QueuedRequest>}
+   * @see https://docs.qubesync.com/api-reference/v2/data-event-recovery-infos/delete-data-event-recovery-info
+   */
+  delete(connectionId, params, options) {
+    return this.#client.queue("data_event_recovery_info.delete", connectionId, params, options);
+  }
+
+  /**
+   * List data event recovery infos.
+   * @param {string} connectionId
+   * @param {import("./data_event_recovery_info").DataEventRecoveryInfoQueryParams} params
+   * @param {import("./types").OperationOptions} options
+   * @returns {Promise<import("./types").QueuedRequest>}
+   * @see https://docs.qubesync.com/api-reference/v2/data-event-recovery-infos/list-data-event-recovery-infos
+   */
+  query(connectionId, params, options) {
+    return this.#client.queue("data_event_recovery_info.query", connectionId, params, options);
+  }
+}
+
+module.exports = { DataEventRecoveryInfo };