qubesync 0.1.0 → 0.2.0

package/operations/class.js

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

package/operations/cleared_status.d.ts

@@ -0,0 +1,43 @@
+// Generated from operations.json by scripts/generate-operations.js: don't edit.
+
+import type { Client } from "../index";
+import type { OperationOptions, QueuedRequest } from "./types";
+
+/** QuickBooks cleared status operations: `qube.clearedStatus.<action>(connectionId, params, { webhookUrl })`. */
+export declare class ClearedStatus {
+  constructor(client: Client);
+  /**
+   * Update cleared status: `PUT /connections/{connection_id}/cleared-statuses`, queued for QuickBooks.
+   *
+   * The answer comes to `webhookUrl` as one webhook.
+   * Params go in the JSON body.
+   *
+   * Fields: `cleared_status` (required), `request_id`, `txn_id` (required), `txn_line_id`.
+   *
+   * Resolves to the queued request.
+   * @see https://docs.qubesync.com/api-reference/v2/cleared-statuses/update-cleared-status
+   */
+  update(connectionId: string, params: ClearedStatusUpdateParams, options: OperationOptions): Promise<QueuedRequest>;
+}
+
+/**
+ * The params of `cleared_status.update`: Update cleared status.
+ */
+export interface ClearedStatusUpdateParams {
+  /**
+   * Indicates whether a transaction or transaction line has been cleared.
+   */
+  cleared_status: "Cleared" | "NotCleared" | "Pending";
+  /**
+   * 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;
+  /**
+   * `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;
+  /**
+   * Identification number of the transaction line. (`txn_line_id` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `txn_line_id` is always returned as zero.) G/p>If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `txn_line_id` to -1.
+   */
+  txn_line_id?: string;
+}

package/operations/cleared_status.js

@@ -0,0 +1,26 @@
+// Generated from operations.json by scripts/generate-operations.js: don't edit.
+"use strict";
+
+/** QuickBooks cleared status operations. Types: cleared_status.d.ts. */
+class ClearedStatus {
+  #client;
+
+  /** @param {import("../index").Client} client */
+  constructor(client) {
+    this.#client = client;
+  }
+
+  /**
+   * Update cleared status.
+   * @param {string} connectionId
+   * @param {import("./cleared_status").ClearedStatusUpdateParams} params
+   * @param {import("./types").OperationOptions} options
+   * @returns {Promise<import("./types").QueuedRequest>}
+   * @see https://docs.qubesync.com/api-reference/v2/cleared-statuses/update-cleared-status
+   */
+  update(connectionId, params, options) {
+    return this.#client.queue("cleared_status.update", connectionId, params, options);
+  }
+}
+
+module.exports = { ClearedStatus };

package/operations/client.d.ts

@@ -0,0 +1,254 @@
+// Generated from operations.json by scripts/generate-operations.js: don't edit.
+
+import type { Account } from "./account";
+import type { AccountTaxLineInfo } from "./account_tax_line_info";
+import type { AgingReport } from "./aging_report";
+import type { Alert } from "./alert";
+import type { ArRefundCreditCard } from "./ar_refund_credit_card";
+import type { BarCode } from "./bar_code";
+import type { Bill } from "./bill";
+import type { BillPaymentCheck } from "./bill_payment_check";
+import type { BillPaymentCreditCard } from "./bill_payment_credit_card";
+import type { BillToPay } from "./bill_to_pay";
+import type { BillingRate } from "./billing_rate";
+import type { BudgetSummaryReport } from "./budget_summary_report";
+import type { BuildAssembly } from "./build_assembly";
+import type { Charge } from "./charge";
+import type { Check } from "./check";
+import type { Class } from "./class";
+import type { ClearedStatus } from "./cleared_status";
+import type { Company } from "./company";
+import type { CompanyActivity } from "./company_activity";
+import type { CreditCardCharge } from "./credit_card_charge";
+import type { CreditCardCredit } from "./credit_card_credit";
+import type { CreditMemo } from "./credit_memo";
+import type { Currency } from "./currency";
+import type { CustomDetailReport } from "./custom_detail_report";
+import type { CustomSummaryReport } from "./custom_summary_report";
+import type { Customer } from "./customer";
+import type { CustomerMsg } from "./customer_msg";
+import type { CustomerType } from "./customer_type";
+import type { DataEventRecoveryInfo } from "./data_event_recovery_info";
+import type { DataExt } from "./data_ext";
+import type { DataExtDef } from "./data_ext_def";
+import type { DateDrivenTerms } from "./date_driven_terms";
+import type { Deposit } from "./deposit";
+import type { Employee } from "./employee";
+import type { EmployeeDefault } from "./employee_default";
+import type { Entity } from "./entity";
+import type { Estimate } from "./estimate";
+import type { Form1099CategoryAccountMapping } from "./form1099_category_account_mapping";
+import type { GeneralDetailReport } from "./general_detail_report";
+import type { GeneralSummaryReport } from "./general_summary_report";
+import type { Host } from "./host";
+import type { InventoryAdjustment } from "./inventory_adjustment";
+import type { InventorySite } from "./inventory_site";
+import type { Invoice } from "./invoice";
+import type { Item } from "./item";
+import type { ItemAssembliesCanBuild } from "./item_assemblies_can_build";
+import type { ItemDiscount } from "./item_discount";
+import type { ItemFixedAsset } from "./item_fixed_asset";
+import type { ItemGroup } from "./item_group";
+import type { ItemInventory } from "./item_inventory";
+import type { ItemInventoryAssembly } from "./item_inventory_assembly";
+import type { ItemNonInventory } from "./item_non_inventory";
+import type { ItemOtherCharge } from "./item_other_charge";
+import type { ItemPayment } from "./item_payment";
+import type { ItemReceipt } from "./item_receipt";
+import type { ItemSalesTax } from "./item_sales_tax";
+import type { ItemSalesTaxGroup } from "./item_sales_tax_group";
+import type { ItemService } from "./item_service";
+import type { ItemSites } from "./item_sites";
+import type { ItemSubtotal } from "./item_subtotal";
+import type { JobReport } from "./job_report";
+import type { JobType } from "./job_type";
+import type { JournalEntry } from "./journal_entry";
+import type { Lead } from "./lead";
+import type { List } from "./list";
+import type { ListDeleted } from "./list_deleted";
+import type { ListDisplay } from "./list_display";
+import type { ListMerge } from "./list_merge";
+import type { OtherName } from "./other_name";
+import type { Paycheck } from "./paycheck";
+import type { PaymentMethod } from "./payment_method";
+import type { PayrollDetailReport } from "./payroll_detail_report";
+import type { PayrollItem } from "./payroll_item";
+import type { PayrollItemAddition } from "./payroll_item_addition";
+import type { PayrollItemCompanyContribution } from "./payroll_item_company_contribution";
+import type { PayrollItemDeduction } from "./payroll_item_deduction";
+import type { PayrollItemDirectDeposit } from "./payroll_item_direct_deposit";
+import type { PayrollItemNonWage } from "./payroll_item_non_wage";
+import type { PayrollItemTax } from "./payroll_item_tax";
+import type { PayrollItemWage } from "./payroll_item_wage";
+import type { PayrollItemWorkersCompensation } from "./payroll_item_workers_compensation";
+import type { PayrollLastPeriod } from "./payroll_last_period";
+import type { PayrollLiabilityAdjustment } from "./payroll_liability_adjustment";
+import type { PayrollLiabilityCheck } from "./payroll_liability_check";
+import type { PayrollPriorPayment } from "./payroll_prior_payment";
+import type { PayrollSummaryReport } from "./payroll_summary_report";
+import type { PayrollYearToDateAdjustment } from "./payroll_year_to_date_adjustment";
+import type { Preferences } from "./preferences";
+import type { PriceLevel } from "./price_level";
+import type { PurchaseOrder } from "./purchase_order";
+import type { QbCommandExec } from "./qb_command_exec";
+import type { ReceivePayment } from "./receive_payment";
+import type { ReceivePaymentToDeposit } from "./receive_payment_to_deposit";
+import type { SalesOrder } from "./sales_order";
+import type { SalesReceipt } from "./sales_receipt";
+import type { SalesRep } from "./sales_rep";
+import type { SalesTaxCode } from "./sales_tax_code";
+import type { SalesTaxPayable } from "./sales_tax_payable";
+import type { SalesTaxPaymentCheck } from "./sales_tax_payment_check";
+import type { SalesTaxReturn } from "./sales_tax_return";
+import type { SalesTaxReturnLine } from "./sales_tax_return_line";
+import type { ShipMethod } from "./ship_method";
+import type { SpecialAccount } from "./special_account";
+import type { SpecialItem } from "./special_item";
+import type { StandardTerms } from "./standard_terms";
+import type { Template } from "./template";
+import type { Terms } from "./terms";
+import type { TimeReport } from "./time_report";
+import type { TimeTracking } from "./time_tracking";
+import type { ToDo } from "./to_do";
+import type { Transaction } from "./transaction";
+import type { Transfer } from "./transfer";
+import type { TransferInventory } from "./transfer_inventory";
+import type { Txn } from "./txn";
+import type { TxnDeleted } from "./txn_deleted";
+import type { TxnDisplay } from "./txn_display";
+import type { TxnVoid } from "./txn_void";
+import type { UnitOfMeasureSet } from "./unit_of_measure_set";
+import type { Vehicle } from "./vehicle";
+import type { VehicleMileage } from "./vehicle_mileage";
+import type { Vendor } from "./vendor";
+import type { VendorCredit } from "./vendor_credit";
+import type { VendorType } from "./vendor_type";
+import type { WorkersCompCode } from "./workers_comp_code";
+
+/** The Client's entity accessors: `qube.customer.create(...)`. Each loads its module on first use. */
+export interface ClientOperations {
+  readonly account: Account;
+  readonly accountTaxLineInfo: AccountTaxLineInfo;
+  readonly agingReport: AgingReport;
+  readonly alert: Alert;
+  readonly arRefundCreditCard: ArRefundCreditCard;
+  readonly barCode: BarCode;
+  readonly bill: Bill;
+  readonly billPaymentCheck: BillPaymentCheck;
+  readonly billPaymentCreditCard: BillPaymentCreditCard;
+  readonly billToPay: BillToPay;
+  readonly billingRate: BillingRate;
+  readonly budgetSummaryReport: BudgetSummaryReport;
+  readonly buildAssembly: BuildAssembly;
+  readonly charge: Charge;
+  readonly check: Check;
+  readonly class: Class;
+  readonly clearedStatus: ClearedStatus;
+  readonly company: Company;
+  readonly companyActivity: CompanyActivity;
+  readonly creditCardCharge: CreditCardCharge;
+  readonly creditCardCredit: CreditCardCredit;
+  readonly creditMemo: CreditMemo;
+  readonly currency: Currency;
+  readonly customDetailReport: CustomDetailReport;
+  readonly customSummaryReport: CustomSummaryReport;
+  readonly customer: Customer;
+  readonly customerMsg: CustomerMsg;
+  readonly customerType: CustomerType;
+  readonly dataEventRecoveryInfo: DataEventRecoveryInfo;
+  readonly dataExt: DataExt;
+  readonly dataExtDef: DataExtDef;
+  readonly dateDrivenTerms: DateDrivenTerms;
+  readonly deposit: Deposit;
+  readonly employee: Employee;
+  readonly employeeDefault: EmployeeDefault;
+  readonly entity: Entity;
+  readonly estimate: Estimate;
+  readonly form1099CategoryAccountMapping: Form1099CategoryAccountMapping;
+  readonly generalDetailReport: GeneralDetailReport;
+  readonly generalSummaryReport: GeneralSummaryReport;
+  readonly host: Host;
+  readonly inventoryAdjustment: InventoryAdjustment;
+  readonly inventorySite: InventorySite;
+  readonly invoice: Invoice;
+  readonly item: Item;
+  readonly itemAssembliesCanBuild: ItemAssembliesCanBuild;
+  readonly itemDiscount: ItemDiscount;
+  readonly itemFixedAsset: ItemFixedAsset;
+  readonly itemGroup: ItemGroup;
+  readonly itemInventory: ItemInventory;
+  readonly itemInventoryAssembly: ItemInventoryAssembly;
+  readonly itemNonInventory: ItemNonInventory;
+  readonly itemOtherCharge: ItemOtherCharge;
+  readonly itemPayment: ItemPayment;
+  readonly itemReceipt: ItemReceipt;
+  readonly itemSalesTax: ItemSalesTax;
+  readonly itemSalesTaxGroup: ItemSalesTaxGroup;
+  readonly itemService: ItemService;
+  readonly itemSites: ItemSites;
+  readonly itemSubtotal: ItemSubtotal;
+  readonly jobReport: JobReport;
+  readonly jobType: JobType;
+  readonly journalEntry: JournalEntry;
+  readonly lead: Lead;
+  readonly list: List;
+  readonly listDeleted: ListDeleted;
+  readonly listDisplay: ListDisplay;
+  readonly listMerge: ListMerge;
+  readonly otherName: OtherName;
+  readonly paycheck: Paycheck;
+  readonly paymentMethod: PaymentMethod;
+  readonly payrollDetailReport: PayrollDetailReport;
+  readonly payrollItem: PayrollItem;
+  readonly payrollItemAddition: PayrollItemAddition;
+  readonly payrollItemCompanyContribution: PayrollItemCompanyContribution;
+  readonly payrollItemDeduction: PayrollItemDeduction;
+  readonly payrollItemDirectDeposit: PayrollItemDirectDeposit;
+  readonly payrollItemNonWage: PayrollItemNonWage;
+  readonly payrollItemTax: PayrollItemTax;
+  readonly payrollItemWage: PayrollItemWage;
+  readonly payrollItemWorkersCompensation: PayrollItemWorkersCompensation;
+  readonly payrollLastPeriod: PayrollLastPeriod;
+  readonly payrollLiabilityAdjustment: PayrollLiabilityAdjustment;
+  readonly payrollLiabilityCheck: PayrollLiabilityCheck;
+  readonly payrollPriorPayment: PayrollPriorPayment;
+  readonly payrollSummaryReport: PayrollSummaryReport;
+  readonly payrollYearToDateAdjustment: PayrollYearToDateAdjustment;
+  readonly preferences: Preferences;
+  readonly priceLevel: PriceLevel;
+  readonly purchaseOrder: PurchaseOrder;
+  readonly qbCommandExec: QbCommandExec;
+  readonly receivePayment: ReceivePayment;
+  readonly receivePaymentToDeposit: ReceivePaymentToDeposit;
+  readonly salesOrder: SalesOrder;
+  readonly salesReceipt: SalesReceipt;
+  readonly salesRep: SalesRep;
+  readonly salesTaxCode: SalesTaxCode;
+  readonly salesTaxPayable: SalesTaxPayable;
+  readonly salesTaxPaymentCheck: SalesTaxPaymentCheck;
+  readonly salesTaxReturn: SalesTaxReturn;
+  readonly salesTaxReturnLine: SalesTaxReturnLine;
+  readonly shipMethod: ShipMethod;
+  readonly specialAccount: SpecialAccount;
+  readonly specialItem: SpecialItem;
+  readonly standardTerms: StandardTerms;
+  readonly template: Template;
+  readonly terms: Terms;
+  readonly timeReport: TimeReport;
+  readonly timeTracking: TimeTracking;
+  readonly toDo: ToDo;
+  readonly transaction: Transaction;
+  readonly transfer: Transfer;
+  readonly transferInventory: TransferInventory;
+  readonly txn: Txn;
+  readonly txnDeleted: TxnDeleted;
+  readonly txnDisplay: TxnDisplay;
+  readonly txnVoid: TxnVoid;
+  readonly unitOfMeasureSet: UnitOfMeasureSet;
+  readonly vehicle: Vehicle;
+  readonly vehicleMileage: VehicleMileage;
+  readonly vendor: Vendor;
+  readonly vendorCredit: VendorCredit;
+  readonly vendorType: VendorType;
+  readonly workersCompCode: WorkersCompCode;
+}

package/operations/company.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 company operations: `qube.company.<action>(connectionId, params, { webhookUrl })`. */
+export declare class Company {
+  constructor(client: Client);
+  /**
+   * List companies: `GET /connections/{connection_id}/companies`, queued for QuickBooks.
+   *
+   * The answer comes to `webhookUrl` as one webhook.
+   * Params go in the query string.
+   *
+   * Fields: `include_ret_element`, `owner_id`, `request_id`.
+   *
+   * Resolves to the queued request.
+   * @see https://docs.qubesync.com/api-reference/v2/companies/list-companies
+   */
+  query(connectionId: string, params: CompanyQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
+}
+
+/**
+ * The params of `company.query`: List companies.
+ */
+export interface CompanyQueryParams {
+  include_ret_element?: Array<"AccountantCopy" | "Address" | "AddressBlock" | "CompanyAddressBlockForCustomer" | "CompanyAddressForCustomer" | "CompanyEmailForCustomer" | "CompanyName" | "CompanyType" | "CompanyWebSite" | "DataExtRet" | "EIN" | "Email" | "Fax" | "FirstMonthFiscalYear" | "FirstMonthIncomeTaxYear" | "IsSampleCompany" | "LegalAddress" | "LegalCompanyName" | "Phone" | "SSN" | "SubscribedServices" | "TaxForm">;
+  /**
+   * `owner_id` identifies who owns the data extension. Use 0 for QuickBooks custom fields that appear in the UI, or use a GUID for private extensions owned by an app. Keep private GUIDs confidential unless you intentionally share extensions across apps. If you do share them, both apps must use the same `owner_id` and `data_ext_name`, because that pair uniquely identifies the extension.
+   */
+  owner_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`.
+   */
+  request_id?: string;
+}

package/operations/company.js

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

package/operations/company_activity.d.ts

@@ -0,0 +1,32 @@
+// Generated from operations.json by scripts/generate-operations.js: don't edit.
+
+import type { Client } from "../index";
+import type { OperationOptions, QueuedRequest } from "./types";
+
+/** QuickBooks company activity operations: `qube.companyActivity.<action>(connectionId, params, { webhookUrl })`. */
+export declare class CompanyActivity {
+  constructor(client: Client);
+  /**
+   * List company activities: `GET /connections/{connection_id}/company-activities`, 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/company-activities/list-company-activities
+   */
+  query(connectionId: string, params: CompanyActivityQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
+}
+
+/**
+ * The params of `company_activity.query`: List company activities.
+ */
+export interface CompanyActivityQueryParams {
+  include_ret_element?: Array<"LastCondenseTime" | "LastRestoreTime">;
+  /**
+   * 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/company_activity.js

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