qubesync 0.1.0 → 0.2.0

package/operations/employee.js

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

package/operations/employee_default.d.ts

@@ -0,0 +1,133 @@
+// Generated from operations.json by scripts/generate-operations.js: don't edit.
+
+import type { Client } from "../index";
+import type { OperationOptions, QueuedRequest, ClassRef } from "./types";
+
+/** QuickBooks employee default operations: `qube.employeeDefault.<action>(connectionId, params, { webhookUrl })`. */
+export declare class EmployeeDefault {
+  constructor(client: Client);
+  /**
+   * List employee defaults: `GET /connections/{connection_id}/employee-defaults`, queued for QuickBooks.
+   *
+   * The answer comes to `webhookUrl` as one webhook.
+   * Params go in the query string.
+   *
+   * Fields: `include_ret_element`, `request_id`.
+   *
+   * Resolves to the queued request.
+   * @see https://docs.qubesync.com/api-reference/v2/employee-defaults/list-employee-defaults
+   */
+  query(connectionId: string, params: EmployeeDefaultQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
+  /**
+   * Update employee default: `PUT /connections/{connection_id}/employee-defaults`, queued for QuickBooks.
+   *
+   * The answer comes to `webhookUrl` as one webhook.
+   * Params go in the JSON body.
+   *
+   * Fields: `employee_default_payroll_info_mod`, `include_ret_element`, `request_id`.
+   *
+   * Resolves to the queued request.
+   * @see https://docs.qubesync.com/api-reference/v2/employee-defaults/update-employee-default
+   */
+  update(connectionId: string, params: EmployeeDefaultUpdateParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
+}
+
+/**
+ * The params of `employee_default.query`: List employee defaults.
+ */
+export interface EmployeeDefaultQueryParams {
+  include_ret_element?: "EmployeeDefaultPayrollInfo"[];
+  /**
+   * 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 `employee_default.update`: Update employee default.
+ */
+export interface EmployeeDefaultUpdateParams {
+  employee_default_payroll_info_mod?: EmployeeDefaultPayrollInfoMod;
+  include_ret_element?: "EmployeeDefaultPayrollInfo"[];
+  /**
+   * 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;
+}
+
+export interface EarningsEmployeeDefault {
+  payroll_item_wage_ref: ClassRef;
+  /**
+   * Choose at most one of: `rate`, or `rate_percent`.
+   */
+  rate?: number;
+  /**
+   * Choose at most one of: `rate`, or `rate_percent`.
+   */
+  rate_percent?: number;
+}
+
+export interface EmployeeDefaultPayrollInfoMod {
+  class_ref?: ClassRef;
+  /**
+   * Choose at most one of: `clear_earnings`, or `earnings`.
+   */
+  clear_earnings?: boolean;
+  /**
+   * Choose at most one of: `clear_non_earnings`, or `non_earnings`.
+   */
+  clear_non_earnings?: boolean;
+  /**
+   * Choose at most one of: `clear_earnings`, or `earnings`.
+   */
+  earnings?: EarningsEmployeeDefault[];
+  employee_tax_info?: EmployeeTaxInfo;
+  is_covered_by_qualified_pension_plan?: boolean;
+  /**
+   * Choose at most one of: `clear_non_earnings`, or `non_earnings`.
+   */
+  non_earnings?: NonEarnings[];
+  pay_period?: "Biweekly" | "Daily" | "Monthly" | "Quarterly" | "Semimonthly" | "Weekly" | "Yearly";
+  sick_hours_default?: SickHoursDefault;
+  use_time_data_to_create_paychecks?: "DoNotUseTimeData" | "NotSet" | "UseTimeData";
+  vacation_hours_default?: SickHoursDefault;
+}
+
+export interface EmployeeTax {
+  is_subject_to_tax?: boolean;
+  payroll_item_tax_ref: ClassRef;
+  tax_info?: TaxInfo[];
+  tax_law_version?: number;
+}
+
+export interface EmployeeTaxInfo {
+  employee_tax?: EmployeeTax[];
+  is_standard_taxation_required?: boolean;
+  state_lived?: string;
+  state_worked?: string;
+}
+
+export interface NonEarnings {
+  /**
+   * Choose at most one of: `amount`, or `rate_percent`.
+   */
+  amount?: number;
+  limit?: number;
+  payroll_item_non_wage_ref: ClassRef;
+  /**
+   * Choose at most one of: `amount`, or `rate_percent`.
+   */
+  rate_percent?: number;
+}
+
+export interface SickHoursDefault {
+  accrual_period?: "BeginningOfYear" | "EveryHourOnPaycheck" | "EveryPaycheck";
+  hours_accrued?: string;
+  is_resetting_hours_each_new_year?: boolean;
+  maximum_hours?: string;
+}
+
+export interface TaxInfo {
+  tax_info_category: string;
+  tax_info_value: string;
+}

package/operations/employee_default.js

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

package/operations/entity.d.ts

@@ -0,0 +1,96 @@
+// 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 entity operations: `qube.entity.<action>(connectionId, params, { webhookUrl })`. */
+export declare class Entity {
+  constructor(client: Client);
+  /**
+   * List entities: `GET /connections/{connection_id}/entities`, queued for QuickBooks.
+   *
+   * QuickBooks answers in pages: each page comes to `webhookUrl` as its own webhook.
+   * Params go in the query string.
+   *
+   * Fields: `active_status`, `from_modified_date`, `full_name`, `include_ret_element`, `iterator`, `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/entities/list-entities
+   */
+  query(connectionId: string, params: EntityQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
+}
+
+/**
+ * The params of `entity.query`: List entities.
+ */
+export interface EntityQueryParams {
+  /**
+   * 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<"AccountNumber" | "AdditionalContactRef" | "AdditionalNotesRet" | "AdjustedServiceDate" | "AltContact" | "AltPhone" | "Balance" | "BillAddress" | "BillAddressBlock" | "BillingRateRef" | "BirthDate" | "Cc" | "ClassRef" | "CompanyName" | "Contact" | "ContactsRet" | "CreditCardInfo" | "CreditLimit" | "CurrencyRef" | "CustomerTypeRef" | "DataExtRet" | "DeliveryMethod" | "Department" | "Description" | "DisabilityDesc" | "Disabled" | "EditSequence" | "Email" | "EmergencyContacts" | "EmployeeAddress" | "EmployeePayrollInfo" | "EmployeeType" | "Ethnicity" | "Exempt" | "ExternalGUID" | "Fax" | "FirstName" | "FullName" | "Gender" | "HiredDate" | "IsActive" | "IsSalesTaxAgency" | "IsStatementWithParent" | "IsTaxAgency" | "IsTaxOnTax" | "IsTaxTrackedOnPurchases" | "IsTaxTrackedOnSales" | "IsVendorEligibleFor1099" | "ItemSalesTaxRef" | "JobDesc" | "JobEndDate" | "JobProjectedEndDate" | "JobStartDate" | "JobStatus" | "JobTitle" | "JobTypeRef" | "KeyEmployee" | "LastName" | "ListID" | "MiddleName" | "MilitaryStatus" | "Mobile" | "Name" | "NameOnCheck" | "Notes" | "OnFile" | "OriginalHireDate" | "OtherNameAddress" | "OtherNameAddressBlock" | "Pager" | "PagerPIN" | "ParentRef" | "PartOrFullTime" | "Phone" | "PreferredDeliveryMethod" | "PreferredPaymentMethodRef" | "PrefillAccountRef" | "PriceLevelRef" | "PrintAs" | "ReleasedDate" | "ReportingPeriod" | "ResaleNumber" | "SSN" | "SalesRepRef" | "SalesTaxCodeRef" | "SalesTaxCountry" | "SalesTaxReturnRef" | "Salutation" | "ShipAddress" | "ShipAddressBlock" | "ShipToAddress" | "Sublevel" | "Suffix" | "SupervisorRef" | "TargetBonus" | "TaxOnPurchasesAccountRef" | "TaxOnSalesAccountRef" | "TaxRegistrationNumber" | "TermsRef" | "TimeCreated" | "TimeModified" | "TotalBalance" | "USCitizen" | "USVeteran" | "VendorAddress" | "VendorAddressBlock" | "VendorTaxIdent" | "VendorTypeRef" | "WorkAuthExpireDate">;
+  /**
+   * 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 `full_name` or `list_id` every match comes back in one answer, so leave `iterator` out.
+   */
+  iterator?: boolean;
+  /**
+   * `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.
+   *
+   * 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: `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/entity.js

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