qubesync 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +38 -2
- package/README.md +188 -5
- package/client.js +660 -0
- package/index.d.ts +211 -1
- package/index.js +5 -1
- package/index.mjs +2 -0
- package/operations/account.d.ts +263 -0
- package/operations/account.js +50 -0
- package/operations/account_tax_line_info.d.ts +31 -0
- package/operations/account_tax_line_info.js +26 -0
- package/operations/aging_report.d.ts +100 -0
- package/operations/aging_report.js +26 -0
- package/operations/alert.d.ts +118 -0
- package/operations/alert.js +50 -0
- package/operations/ar_refund_credit_card.d.ts +201 -0
- package/operations/ar_refund_credit_card.js +38 -0
- package/operations/bar_code.d.ts +40 -0
- package/operations/bar_code.js +26 -0
- package/operations/bill.d.ts +612 -0
- package/operations/bill.js +50 -0
- package/operations/bill_payment_check.d.ts +276 -0
- package/operations/bill_payment_check.js +50 -0
- package/operations/bill_payment_credit_card.d.ts +178 -0
- package/operations/bill_payment_credit_card.js +38 -0
- package/operations/bill_to_pay.d.ts +54 -0
- package/operations/bill_to_pay.js +26 -0
- package/operations/billing_rate.d.ts +159 -0
- package/operations/billing_rate.js +38 -0
- package/operations/budget_summary_report.d.ts +71 -0
- package/operations/budget_summary_report.js +26 -0
- package/operations/build_assembly.d.ts +264 -0
- package/operations/build_assembly.js +50 -0
- package/operations/charge.d.ts +330 -0
- package/operations/charge.js +50 -0
- package/operations/check.d.ts +394 -0
- package/operations/check.js +50 -0
- package/operations/class.d.ts +170 -0
- package/operations/class.js +50 -0
- package/operations/cleared_status.d.ts +43 -0
- package/operations/cleared_status.js +26 -0
- package/operations/client.d.ts +254 -0
- package/operations/company.d.ts +36 -0
- package/operations/company.js +26 -0
- package/operations/company_activity.d.ts +32 -0
- package/operations/company_activity.js +26 -0
- package/operations/credit_card_charge.d.ts +280 -0
- package/operations/credit_card_charge.js +50 -0
- package/operations/credit_card_credit.d.ts +280 -0
- package/operations/credit_card_credit.js +50 -0
- package/operations/credit_memo.d.ts +642 -0
- package/operations/credit_memo.js +50 -0
- package/operations/currency.d.ts +195 -0
- package/operations/currency.js +50 -0
- package/operations/custom_detail_report.d.ts +108 -0
- package/operations/custom_detail_report.js +26 -0
- package/operations/custom_summary_report.d.ts +119 -0
- package/operations/custom_summary_report.js +26 -0
- package/operations/customer.d.ts +639 -0
- package/operations/customer.js +50 -0
- package/operations/customer_msg.d.ts +121 -0
- package/operations/customer_msg.js +38 -0
- package/operations/customer_type.d.ts +127 -0
- package/operations/customer_type.js +38 -0
- package/operations/data_event_recovery_info.d.ts +61 -0
- package/operations/data_event_recovery_info.js +38 -0
- package/operations/data_ext.d.ts +197 -0
- package/operations/data_ext.js +50 -0
- package/operations/data_ext_def.d.ts +173 -0
- package/operations/data_ext_def.js +62 -0
- package/operations/date_driven_terms.d.ts +141 -0
- package/operations/date_driven_terms.js +38 -0
- package/operations/deposit.d.ts +402 -0
- package/operations/deposit.js +50 -0
- package/operations/employee.d.ts +683 -0
- package/operations/employee.js +50 -0
- package/operations/employee_default.d.ts +133 -0
- package/operations/employee_default.js +38 -0
- package/operations/entity.d.ts +96 -0
- package/operations/entity.js +26 -0
- package/operations/estimate.d.ts +590 -0
- package/operations/estimate.js +50 -0
- package/operations/form1099_category_account_mapping.d.ts +89 -0
- package/operations/form1099_category_account_mapping.js +38 -0
- package/operations/general_detail_report.d.ts +108 -0
- package/operations/general_detail_report.js +26 -0
- package/operations/general_summary_report.d.ts +115 -0
- package/operations/general_summary_report.js +26 -0
- package/operations/host.d.ts +43 -0
- package/operations/host.js +26 -0
- package/operations/index.js +397 -0
- package/operations/inventory_adjustment.d.ts +389 -0
- package/operations/inventory_adjustment.js +50 -0
- package/operations/inventory_site.d.ts +247 -0
- package/operations/inventory_site.js +50 -0
- package/operations/invoice.d.ts +682 -0
- package/operations/invoice.js +50 -0
- package/operations/item.d.ts +100 -0
- package/operations/item.js +26 -0
- package/operations/item_assemblies_can_build.d.ts +41 -0
- package/operations/item_assemblies_can_build.js +26 -0
- package/operations/item_discount.d.ts +256 -0
- package/operations/item_discount.js +50 -0
- package/operations/item_fixed_asset.d.ts +382 -0
- package/operations/item_fixed_asset.js +50 -0
- package/operations/item_group.d.ts +236 -0
- package/operations/item_group.js +50 -0
- package/operations/item_inventory.d.ts +350 -0
- package/operations/item_inventory.js +50 -0
- package/operations/item_inventory_assembly.d.ts +368 -0
- package/operations/item_inventory_assembly.js +50 -0
- package/operations/item_non_inventory.d.ts +264 -0
- package/operations/item_non_inventory.js +50 -0
- package/operations/item_other_charge.d.ts +244 -0
- package/operations/item_other_charge.js +50 -0
- package/operations/item_payment.d.ts +220 -0
- package/operations/item_payment.js +50 -0
- package/operations/item_receipt.d.ts +362 -0
- package/operations/item_receipt.js +50 -0
- package/operations/item_sales_tax.d.ts +228 -0
- package/operations/item_sales_tax.js +50 -0
- package/operations/item_sales_tax_group.d.ts +192 -0
- package/operations/item_sales_tax_group.js +50 -0
- package/operations/item_service.d.ts +256 -0
- package/operations/item_service.js +50 -0
- package/operations/item_sites.d.ts +81 -0
- package/operations/item_sites.js +26 -0
- package/operations/item_subtotal.d.ts +188 -0
- package/operations/item_subtotal.js +50 -0
- package/operations/job_report.d.ts +99 -0
- package/operations/job_report.js +26 -0
- package/operations/job_type.d.ts +127 -0
- package/operations/job_type.js +38 -0
- package/operations/journal_entry.d.ts +339 -0
- package/operations/journal_entry.js +50 -0
- package/operations/lead.d.ts +291 -0
- package/operations/lead.js +50 -0
- package/operations/list.d.ts +39 -0
- package/operations/list.js +26 -0
- package/operations/list_deleted.d.ts +44 -0
- package/operations/list_deleted.js +26 -0
- package/operations/list_display.d.ts +65 -0
- package/operations/list_display.js +38 -0
- package/operations/list_merge.d.ts +58 -0
- package/operations/list_merge.js +26 -0
- package/operations/other_name.d.ts +280 -0
- package/operations/other_name.js +50 -0
- package/operations/paycheck.d.ts +82 -0
- package/operations/paycheck.js +26 -0
- package/operations/payment_method.d.ts +131 -0
- package/operations/payment_method.js +38 -0
- package/operations/payroll_detail_report.d.ts +97 -0
- package/operations/payroll_detail_report.js +26 -0
- package/operations/payroll_item.d.ts +83 -0
- package/operations/payroll_item.js +26 -0
- package/operations/payroll_item_addition.d.ts +95 -0
- package/operations/payroll_item_addition.js +38 -0
- package/operations/payroll_item_company_contribution.d.ts +105 -0
- package/operations/payroll_item_company_contribution.js +38 -0
- package/operations/payroll_item_deduction.d.ts +101 -0
- package/operations/payroll_item_deduction.js +38 -0
- package/operations/payroll_item_direct_deposit.d.ts +65 -0
- package/operations/payroll_item_direct_deposit.js +38 -0
- package/operations/payroll_item_non_wage.d.ts +92 -0
- package/operations/payroll_item_non_wage.js +26 -0
- package/operations/payroll_item_tax.d.ts +108 -0
- package/operations/payroll_item_tax.js +38 -0
- package/operations/payroll_item_wage.d.ts +169 -0
- package/operations/payroll_item_wage.js +50 -0
- package/operations/payroll_item_workers_compensation.d.ts +77 -0
- package/operations/payroll_item_workers_compensation.js +38 -0
- package/operations/payroll_last_period.d.ts +31 -0
- package/operations/payroll_last_period.js +26 -0
- package/operations/payroll_liability_adjustment.d.ts +137 -0
- package/operations/payroll_liability_adjustment.js +38 -0
- package/operations/payroll_liability_check.d.ts +82 -0
- package/operations/payroll_liability_check.js +26 -0
- package/operations/payroll_prior_payment.d.ts +126 -0
- package/operations/payroll_prior_payment.js +38 -0
- package/operations/payroll_summary_report.d.ts +107 -0
- package/operations/payroll_summary_report.js +26 -0
- package/operations/payroll_year_to_date_adjustment.d.ts +156 -0
- package/operations/payroll_year_to_date_adjustment.js +38 -0
- package/operations/preferences.d.ts +64 -0
- package/operations/preferences.js +38 -0
- package/operations/price_level.d.ts +234 -0
- package/operations/price_level.js +50 -0
- package/operations/purchase_order.d.ts +620 -0
- package/operations/purchase_order.js +50 -0
- package/operations/qb_command_exec.d.ts +49 -0
- package/operations/qb_command_exec.js +26 -0
- package/operations/receive_payment.d.ts +450 -0
- package/operations/receive_payment.js +50 -0
- package/operations/receive_payment_to_deposit.d.ts +36 -0
- package/operations/receive_payment_to_deposit.js +26 -0
- package/operations/sales_order.d.ts +612 -0
- package/operations/sales_order.js +50 -0
- package/operations/sales_receipt.d.ts +650 -0
- package/operations/sales_receipt.js +50 -0
- package/operations/sales_rep.d.ts +170 -0
- package/operations/sales_rep.js +50 -0
- package/operations/sales_tax_code.d.ts +194 -0
- package/operations/sales_tax_code.js +50 -0
- package/operations/sales_tax_payable.d.ts +42 -0
- package/operations/sales_tax_payable.js +26 -0
- package/operations/sales_tax_payment_check.d.ts +254 -0
- package/operations/sales_tax_payment_check.js +50 -0
- package/operations/sales_tax_return.d.ts +35 -0
- package/operations/sales_tax_return.js +26 -0
- package/operations/sales_tax_return_line.d.ts +36 -0
- package/operations/sales_tax_return_line.js +26 -0
- package/operations/ship_method.d.ts +121 -0
- package/operations/ship_method.js +38 -0
- package/operations/special_account.d.ts +40 -0
- package/operations/special_account.js +26 -0
- package/operations/special_item.d.ts +44 -0
- package/operations/special_item.js +26 -0
- package/operations/standard_terms.d.ts +133 -0
- package/operations/standard_terms.js +38 -0
- package/operations/template.d.ts +36 -0
- package/operations/template.js +26 -0
- package/operations/terms.d.ts +90 -0
- package/operations/terms.js +26 -0
- package/operations/time_report.d.ts +84 -0
- package/operations/time_report.js +26 -0
- package/operations/time_tracking.d.ts +214 -0
- package/operations/time_tracking.js +50 -0
- package/operations/to_do.d.ts +254 -0
- package/operations/to_do.js +50 -0
- package/operations/transaction.d.ts +244 -0
- package/operations/transaction.js +26 -0
- package/operations/transfer.d.ts +178 -0
- package/operations/transfer.js +50 -0
- package/operations/transfer_inventory.d.ts +290 -0
- package/operations/transfer_inventory.js +50 -0
- package/operations/txn.d.ts +39 -0
- package/operations/txn.js +26 -0
- package/operations/txn_deleted.d.ts +44 -0
- package/operations/txn_deleted.js +26 -0
- package/operations/txn_display.d.ts +69 -0
- package/operations/txn_display.js +38 -0
- package/operations/txn_void.d.ts +39 -0
- package/operations/txn_void.js +26 -0
- package/operations/types.d.ts +1259 -0
- package/operations/unit_of_measure_set.d.ts +168 -0
- package/operations/unit_of_measure_set.js +38 -0
- package/operations/vehicle.d.ts +168 -0
- package/operations/vehicle.js +50 -0
- package/operations/vehicle_mileage.d.ts +147 -0
- package/operations/vehicle_mileage.js +38 -0
- package/operations/vendor.d.ts +541 -0
- package/operations/vendor.js +50 -0
- package/operations/vendor_credit.d.ts +365 -0
- package/operations/vendor_credit.js +50 -0
- package/operations/vendor_type.d.ts +127 -0
- package/operations/vendor_type.js +38 -0
- package/operations/workers_comp_code.d.ts +199 -0
- package/operations/workers_comp_code.js +50 -0
- package/package.json +14 -4
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks journal entry operations. Types: journal_entry.d.ts. */
|
|
5
|
+
class JournalEntry {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Create journal entry.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./journal_entry").JournalEntryCreateParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/journal-entries/create-journal-entry
|
|
20
|
+
*/
|
|
21
|
+
create(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("journal_entry.create", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* List journal entries (answers in pages, one webhook each).
|
|
27
|
+
* @param {string} connectionId
|
|
28
|
+
* @param {import("./journal_entry").JournalEntryQueryParams} params
|
|
29
|
+
* @param {import("./types").OperationOptions} options
|
|
30
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
31
|
+
* @see https://docs.qubesync.com/api-reference/v2/journal-entries/list-journal-entries
|
|
32
|
+
*/
|
|
33
|
+
query(connectionId, params, options) {
|
|
34
|
+
return this.#client.queue("journal_entry.query", connectionId, params, options);
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Update journal entry.
|
|
39
|
+
* @param {string} connectionId
|
|
40
|
+
* @param {import("./journal_entry").JournalEntryUpdateParams} params
|
|
41
|
+
* @param {import("./types").OperationOptions} options
|
|
42
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
43
|
+
* @see https://docs.qubesync.com/api-reference/v2/journal-entries/update-journal-entry
|
|
44
|
+
*/
|
|
45
|
+
update(connectionId, params, options) {
|
|
46
|
+
return this.#client.queue("journal_entry.update", connectionId, params, options);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
module.exports = { JournalEntry };
|
|
@@ -0,0 +1,291 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
|
|
3
|
+
import type { Client } from "../index";
|
|
4
|
+
import type { OperationOptions, QueuedRequest, AdditionalContactRef, NameFilter, NameRangeFilter } from "./types";
|
|
5
|
+
|
|
6
|
+
/** QuickBooks lead operations: `qube.lead.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class Lead {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* Create lead: `POST /connections/{connection_id}/leads`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the JSON body.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `additional_contact_ref`, `company_name`, `full_name` (required), `include_ret_element`, `lead_contacts`, `locations`, `main_phone`, `request_id`, `status`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/leads/create-lead
|
|
19
|
+
*/
|
|
20
|
+
create(connectionId: string, params: LeadCreateParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
/**
|
|
22
|
+
* List leads: `GET /connections/{connection_id}/leads`, queued for QuickBooks.
|
|
23
|
+
*
|
|
24
|
+
* QuickBooks answers in pages: each page comes to `webhookUrl` as its own webhook.
|
|
25
|
+
* Params go in the query string.
|
|
26
|
+
*
|
|
27
|
+
* Fields: `from_modified_date`, `include_ret_element`, `iterator`, `list_id`, `max_returned`, `meta_data`, `name`, `name_filter`, `name_range_filter`, `request_id`, `to_modified_date`.
|
|
28
|
+
*
|
|
29
|
+
* Resolves to the queued request.
|
|
30
|
+
* @see https://docs.qubesync.com/api-reference/v2/leads/list-leads
|
|
31
|
+
*/
|
|
32
|
+
query(connectionId: string, params: LeadQueryParams | undefined, options: OperationOptions): Promise<QueuedRequest>;
|
|
33
|
+
/**
|
|
34
|
+
* Update lead: `PUT /connections/{connection_id}/leads`, queued for QuickBooks.
|
|
35
|
+
*
|
|
36
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
37
|
+
* Params go in the JSON body.
|
|
38
|
+
*
|
|
39
|
+
* Fields: `additional_contact_ref`, `company_name`, `edit_sequence` (required), `full_name` (required), `include_ret_element`, `lead_contacts_mod`, `list_id` (required), `locations_mod`, `main_phone`, `request_id`, `status`.
|
|
40
|
+
*
|
|
41
|
+
* Resolves to the queued request.
|
|
42
|
+
* @see https://docs.qubesync.com/api-reference/v2/leads/update-lead
|
|
43
|
+
*/
|
|
44
|
+
update(connectionId: string, params: LeadUpdateParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* The params of `lead.create`: Create lead.
|
|
49
|
+
*/
|
|
50
|
+
export interface LeadCreateParams {
|
|
51
|
+
additional_contact_ref?: AdditionalContactRef[];
|
|
52
|
+
/**
|
|
53
|
+
* The name of the QuickBooks user’s business, as specified in QuickBooks. `company_name` and Address are used on invoices, checks, and other forms. (LegalCompanyName and LegalAddress, on the other hand, are used on a company’s tax forms and pay stubs.)
|
|
54
|
+
*/
|
|
55
|
+
company_name?: string;
|
|
56
|
+
/**
|
|
57
|
+
* `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.
|
|
58
|
+
*/
|
|
59
|
+
full_name: string;
|
|
60
|
+
include_ret_element?: Array<"AdditionalContactRef" | "CompanyName" | "EditSequence" | "ExternalGUID" | "FullName" | "LeadContactsRet" | "ListID" | "LocationsRet" | "MainPhone" | "OwnerID" | "Status" | "TimeCreated" | "TimeModified" | "TxnID" | "TxnNumber">;
|
|
61
|
+
lead_contacts?: LeadContacts[];
|
|
62
|
+
locations?: Locations[];
|
|
63
|
+
/**
|
|
64
|
+
* The main phone number.
|
|
65
|
+
*/
|
|
66
|
+
main_phone?: string;
|
|
67
|
+
/**
|
|
68
|
+
* 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`.
|
|
69
|
+
*/
|
|
70
|
+
request_id?: string;
|
|
71
|
+
/**
|
|
72
|
+
* The status of the lead.
|
|
73
|
+
*/
|
|
74
|
+
status?: "Cold" | "Hot" | "Warm";
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
/**
|
|
78
|
+
* The params of `lead.query`: List leads.
|
|
79
|
+
*/
|
|
80
|
+
export interface LeadQueryParams {
|
|
81
|
+
/**
|
|
82
|
+
* 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.
|
|
83
|
+
*
|
|
84
|
+
* Choose at most one of: `list_id`, or `name`, or the set (`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.
|
|
85
|
+
*
|
|
86
|
+
* Format: date-time.
|
|
87
|
+
*/
|
|
88
|
+
from_modified_date?: string;
|
|
89
|
+
include_ret_element?: Array<"AdditionalContactRef" | "CompanyName" | "EditSequence" | "FullName" | "LeadContactsRet" | "ListID" | "LocationsRet" | "MainPhone" | "Status" | "TimeCreated" | "TimeModified">;
|
|
90
|
+
/**
|
|
91
|
+
* 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 `list_id` or `name` every match comes back in one answer, so leave `iterator` out.
|
|
92
|
+
*/
|
|
93
|
+
iterator?: boolean;
|
|
94
|
+
/**
|
|
95
|
+
* `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`.
|
|
96
|
+
*
|
|
97
|
+
* Choose at most one of: `list_id`, or `name`, or the set (`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.
|
|
98
|
+
*/
|
|
99
|
+
list_id?: string[];
|
|
100
|
+
/**
|
|
101
|
+
* 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.
|
|
102
|
+
*
|
|
103
|
+
* 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.
|
|
104
|
+
*
|
|
105
|
+
* Choose at most one of: `list_id`, or `name`, or the set (`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.
|
|
106
|
+
*
|
|
107
|
+
* Minimum 1.
|
|
108
|
+
*/
|
|
109
|
+
max_returned?: number;
|
|
110
|
+
/**
|
|
111
|
+
* 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.
|
|
112
|
+
*/
|
|
113
|
+
meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
|
|
114
|
+
/**
|
|
115
|
+
* The string to match.
|
|
116
|
+
*
|
|
117
|
+
* Choose at most one of: `list_id`, or `name`, or the set (`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.
|
|
118
|
+
*/
|
|
119
|
+
name?: string[];
|
|
120
|
+
/**
|
|
121
|
+
* Filters according to the object’s Name.
|
|
122
|
+
*
|
|
123
|
+
* Choose at most one of: `list_id`, or `name`, or the set (`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.
|
|
124
|
+
*/
|
|
125
|
+
name_filter?: NameFilter;
|
|
126
|
+
/**
|
|
127
|
+
* Filters according to the object’s Name.
|
|
128
|
+
*
|
|
129
|
+
* Choose at most one of: `list_id`, or `name`, or the set (`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.
|
|
130
|
+
*/
|
|
131
|
+
name_range_filter?: NameRangeFilter;
|
|
132
|
+
/**
|
|
133
|
+
* 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`.
|
|
134
|
+
*/
|
|
135
|
+
request_id?: string;
|
|
136
|
+
/**
|
|
137
|
+
* 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).
|
|
138
|
+
*
|
|
139
|
+
* Choose at most one of: `list_id`, or `name`, or the set (`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.
|
|
140
|
+
*
|
|
141
|
+
* Format: date-time.
|
|
142
|
+
*/
|
|
143
|
+
to_modified_date?: string;
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
/**
|
|
147
|
+
* The params of `lead.update`: Update lead.
|
|
148
|
+
*/
|
|
149
|
+
export interface LeadUpdateParams {
|
|
150
|
+
additional_contact_ref?: AdditionalContactRef[];
|
|
151
|
+
/**
|
|
152
|
+
* The name of the QuickBooks user’s business, as specified in QuickBooks. `company_name` and Address are used on invoices, checks, and other forms. (LegalCompanyName and LegalAddress, on the other hand, are used on a company’s tax forms and pay stubs.)
|
|
153
|
+
*/
|
|
154
|
+
company_name?: string;
|
|
155
|
+
/**
|
|
156
|
+
* `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.
|
|
157
|
+
*/
|
|
158
|
+
edit_sequence: string;
|
|
159
|
+
/**
|
|
160
|
+
* `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.
|
|
161
|
+
*/
|
|
162
|
+
full_name: string;
|
|
163
|
+
include_ret_element?: Array<"AdditionalContactRef" | "CompanyName" | "EditSequence" | "ExternalGUID" | "FullName" | "LeadContactsRet" | "ListID" | "LocationsRet" | "MainPhone" | "OwnerID" | "Status" | "TimeCreated" | "TimeModified" | "TxnID" | "TxnNumber">;
|
|
164
|
+
lead_contacts_mod?: LeadContactsMod[];
|
|
165
|
+
/**
|
|
166
|
+
* `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`.
|
|
167
|
+
*/
|
|
168
|
+
list_id: string;
|
|
169
|
+
locations_mod?: LocationsMod[];
|
|
170
|
+
/**
|
|
171
|
+
* The main phone number.
|
|
172
|
+
*/
|
|
173
|
+
main_phone?: string;
|
|
174
|
+
/**
|
|
175
|
+
* 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`.
|
|
176
|
+
*/
|
|
177
|
+
request_id?: string;
|
|
178
|
+
/**
|
|
179
|
+
* The status of the lead.
|
|
180
|
+
*/
|
|
181
|
+
status?: "Cold" | "Hot" | "Warm";
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
export interface LeadAddress {
|
|
185
|
+
/**
|
|
186
|
+
* The first line of an address.
|
|
187
|
+
*/
|
|
188
|
+
addr1?: string;
|
|
189
|
+
/**
|
|
190
|
+
* The second line of an address (if a second line is needed).
|
|
191
|
+
*/
|
|
192
|
+
addr2?: string;
|
|
193
|
+
/**
|
|
194
|
+
* The third line of an address (if a third line is needed).
|
|
195
|
+
*/
|
|
196
|
+
addr3?: string;
|
|
197
|
+
/**
|
|
198
|
+
* The fourth line of an address (if a fourth line is needed).
|
|
199
|
+
*/
|
|
200
|
+
addr4?: string;
|
|
201
|
+
/**
|
|
202
|
+
* The fifth line of an address (if a fifth line is needed).
|
|
203
|
+
*/
|
|
204
|
+
addr5?: string;
|
|
205
|
+
}
|
|
206
|
+
|
|
207
|
+
export interface LeadContacts {
|
|
208
|
+
additional_contact_ref?: AdditionalContactRef[];
|
|
209
|
+
/**
|
|
210
|
+
* The first name of a customer, vendor, employee, or person on the “other names” list.
|
|
211
|
+
*/
|
|
212
|
+
first_name: string;
|
|
213
|
+
/**
|
|
214
|
+
* Flag for if this is a primary contact on a lead.
|
|
215
|
+
*/
|
|
216
|
+
is_primary_contact?: boolean;
|
|
217
|
+
/**
|
|
218
|
+
* The job title of a customer, vendor, employee, or person on the “other names” list.
|
|
219
|
+
*/
|
|
220
|
+
job_title?: string;
|
|
221
|
+
/**
|
|
222
|
+
* The last name of a customer, vendor, employee, or person on the “other names” list.
|
|
223
|
+
*/
|
|
224
|
+
last_name?: string;
|
|
225
|
+
/**
|
|
226
|
+
* The middle name of a customer, vendor, employee, or person on the “other names” list.
|
|
227
|
+
*/
|
|
228
|
+
middle_name?: string;
|
|
229
|
+
/**
|
|
230
|
+
* A formal reference, such as Mr. or Dr., that precedes a name.
|
|
231
|
+
*/
|
|
232
|
+
salutation?: string;
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
export interface LeadContactsMod {
|
|
236
|
+
additional_contact_ref?: AdditionalContactRef[];
|
|
237
|
+
/**
|
|
238
|
+
* The first name of a customer, vendor, employee, or person on the “other names” list.
|
|
239
|
+
*/
|
|
240
|
+
first_name: string;
|
|
241
|
+
/**
|
|
242
|
+
* Flag for if this is a primary contact on a lead.
|
|
243
|
+
*/
|
|
244
|
+
is_primary_contact?: boolean;
|
|
245
|
+
/**
|
|
246
|
+
* The job title of a customer, vendor, employee, or person on the “other names” list.
|
|
247
|
+
*/
|
|
248
|
+
job_title?: string;
|
|
249
|
+
/**
|
|
250
|
+
* The last name of a customer, vendor, employee, or person on the “other names” list.
|
|
251
|
+
*/
|
|
252
|
+
last_name?: string;
|
|
253
|
+
/**
|
|
254
|
+
* `lead_contact_id` is a way to identify a lead contact object. When a lead contact object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `lead_contact_id`.
|
|
255
|
+
*/
|
|
256
|
+
lead_contact_id?: number;
|
|
257
|
+
/**
|
|
258
|
+
* The middle name of a customer, vendor, employee, or person on the “other names” list.
|
|
259
|
+
*/
|
|
260
|
+
middle_name?: string;
|
|
261
|
+
/**
|
|
262
|
+
* A formal reference, such as Mr. or Dr., that precedes a name.
|
|
263
|
+
*/
|
|
264
|
+
salutation?: string;
|
|
265
|
+
}
|
|
266
|
+
|
|
267
|
+
export interface Locations {
|
|
268
|
+
/**
|
|
269
|
+
* Address for the lead.
|
|
270
|
+
*/
|
|
271
|
+
lead_address?: LeadAddress;
|
|
272
|
+
/**
|
|
273
|
+
* Where the asset is located or has been placed into service.
|
|
274
|
+
*/
|
|
275
|
+
location: string;
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
export interface LocationsMod {
|
|
279
|
+
/**
|
|
280
|
+
* Address for the lead.
|
|
281
|
+
*/
|
|
282
|
+
lead_address?: LeadAddress;
|
|
283
|
+
/**
|
|
284
|
+
* Where the asset is located or has been placed into service.
|
|
285
|
+
*/
|
|
286
|
+
location: string;
|
|
287
|
+
/**
|
|
288
|
+
* `location_id` is a way to identify a location object. When a location object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `location_id`.
|
|
289
|
+
*/
|
|
290
|
+
location_id: number;
|
|
291
|
+
}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks lead operations. Types: lead.d.ts. */
|
|
5
|
+
class Lead {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Create lead.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./lead").LeadCreateParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/leads/create-lead
|
|
20
|
+
*/
|
|
21
|
+
create(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("lead.create", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* List leads (answers in pages, one webhook each).
|
|
27
|
+
* @param {string} connectionId
|
|
28
|
+
* @param {import("./lead").LeadQueryParams} params
|
|
29
|
+
* @param {import("./types").OperationOptions} options
|
|
30
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
31
|
+
* @see https://docs.qubesync.com/api-reference/v2/leads/list-leads
|
|
32
|
+
*/
|
|
33
|
+
query(connectionId, params, options) {
|
|
34
|
+
return this.#client.queue("lead.query", connectionId, params, options);
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Update lead.
|
|
39
|
+
* @param {string} connectionId
|
|
40
|
+
* @param {import("./lead").LeadUpdateParams} params
|
|
41
|
+
* @param {import("./types").OperationOptions} options
|
|
42
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
43
|
+
* @see https://docs.qubesync.com/api-reference/v2/leads/update-lead
|
|
44
|
+
*/
|
|
45
|
+
update(connectionId, params, options) {
|
|
46
|
+
return this.#client.queue("lead.update", connectionId, params, options);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
module.exports = { Lead };
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
|
|
3
|
+
import type { Client } from "../index";
|
|
4
|
+
import type { OperationOptions, QueuedRequest } from "./types";
|
|
5
|
+
|
|
6
|
+
/** QuickBooks list operations: `qube.list.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class List {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* Delete list: `DELETE /connections/{connection_id}/lists`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the JSON body.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `list_del_type` (required), `list_id` (required), `request_id`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/lists/delete-list
|
|
19
|
+
*/
|
|
20
|
+
delete(connectionId: string, params: ListDeleteParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* The params of `list.delete`: Delete list.
|
|
25
|
+
*/
|
|
26
|
+
export interface ListDeleteParams {
|
|
27
|
+
/**
|
|
28
|
+
* The type of list from which a list member is being deleted.
|
|
29
|
+
*/
|
|
30
|
+
list_del_type: "Account" | "BillingRate" | "Class" | "Currency" | "Customer" | "CustomerMsg" | "CustomerType" | "DateDrivenTerms" | "Employee" | "InventorySite" | "ItemDiscount" | "ItemFixedAsset" | "ItemGroup" | "ItemInventory" | "ItemInventoryAssembly" | "ItemNonInventory" | "ItemOtherCharge" | "ItemPayment" | "ItemSalesTax" | "ItemSalesTaxGroup" | "ItemService" | "ItemSubtotal" | "JobType" | "OtherName" | "PaymentMethod" | "PayrollItemNonWage" | "PayrollItemWage" | "PriceLevel" | "SalesRep" | "SalesTaxCode" | "ShipMethod" | "StandardTerms" | "ToDo" | "UnitOfMeasureSet" | "Vehicle" | "Vendor" | "VendorType" | "WorkersCompCode";
|
|
31
|
+
/**
|
|
32
|
+
* `list_id` and FullName 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 FullName and `list_id` are supplied in a request, QuickBooks uses `list_id` and ignores FullName.
|
|
33
|
+
*/
|
|
34
|
+
list_id: string;
|
|
35
|
+
/**
|
|
36
|
+
* 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`.
|
|
37
|
+
*/
|
|
38
|
+
request_id?: string;
|
|
39
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks list operations. Types: list.d.ts. */
|
|
5
|
+
class List {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Delete list.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./list").ListDeleteParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/lists/delete-list
|
|
20
|
+
*/
|
|
21
|
+
delete(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("list.delete", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
module.exports = { List };
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
|
|
3
|
+
import type { Client } from "../index";
|
|
4
|
+
import type { OperationOptions, QueuedRequest, DeletedDateRangeFilter } from "./types";
|
|
5
|
+
|
|
6
|
+
/** QuickBooks list deleted operations: `qube.listDeleted.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class ListDeleted {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* List list deleteds: `GET /connections/{connection_id}/list-deleteds`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the query string.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `deleted_date_range_filter`, `include_ret_element`, `list_del_type` (required), `meta_data`, `request_id`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/list-deleteds/list-list-deleteds
|
|
19
|
+
*/
|
|
20
|
+
query(connectionId: string, params: ListDeletedQueryParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* The params of `list_deleted.query`: List list deleteds.
|
|
25
|
+
*/
|
|
26
|
+
export interface ListDeletedQueryParams {
|
|
27
|
+
/**
|
|
28
|
+
* Filters according to delete dates (within the last 90 days).
|
|
29
|
+
*/
|
|
30
|
+
deleted_date_range_filter?: DeletedDateRangeFilter;
|
|
31
|
+
include_ret_element?: Array<"FullName" | "ListDelType" | "ListID" | "TimeCreated" | "TimeDeleted">;
|
|
32
|
+
/**
|
|
33
|
+
* The type of list from which a list member is being deleted.
|
|
34
|
+
*/
|
|
35
|
+
list_del_type: Array<"Account" | "BillingRate" | "Class" | "Currency" | "Customer" | "CustomerMsg" | "CustomerType" | "DateDrivenTerms" | "Employee" | "InventorySite" | "ItemDiscount" | "ItemFixedAsset" | "ItemGroup" | "ItemInventory" | "ItemInventoryAssembly" | "ItemNonInventory" | "ItemOtherCharge" | "ItemPayment" | "ItemSalesTax" | "ItemSalesTaxGroup" | "ItemService" | "ItemSubtotal" | "JobType" | "OtherName" | "PaymentMethod" | "PayrollItemNonWage" | "PayrollItemWage" | "PriceLevel" | "SalesRep" | "SalesTaxCode" | "ShipMethod" | "StandardTerms" | "ToDo" | "UnitOfMeasureSet" | "Vehicle" | "Vendor" | "VendorType" | "WorkersCompCode">;
|
|
36
|
+
/**
|
|
37
|
+
* 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.
|
|
38
|
+
*/
|
|
39
|
+
meta_data?: "MetaDataAndResponseData" | "MetaDataOnly" | "NoMetaData";
|
|
40
|
+
/**
|
|
41
|
+
* 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`.
|
|
42
|
+
*/
|
|
43
|
+
request_id?: string;
|
|
44
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks list deleted operations. Types: list_deleted.d.ts. */
|
|
5
|
+
class ListDeleted {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* List list deleteds.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./list_deleted").ListDeletedQueryParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/list-deleteds/list-list-deleteds
|
|
20
|
+
*/
|
|
21
|
+
query(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("list_deleted.query", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
module.exports = { ListDeleted };
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
|
|
3
|
+
import type { Client } from "../index";
|
|
4
|
+
import type { OperationOptions, QueuedRequest } from "./types";
|
|
5
|
+
|
|
6
|
+
/** QuickBooks list display operations: `qube.listDisplay.<action>(connectionId, params, { webhookUrl })`. */
|
|
7
|
+
export declare class ListDisplay {
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
/**
|
|
10
|
+
* Create list display: `POST /connections/{connection_id}/list-displays`, queued for QuickBooks.
|
|
11
|
+
*
|
|
12
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
13
|
+
* Params go in the JSON body.
|
|
14
|
+
*
|
|
15
|
+
* Fields: `list_display_add_type` (required), `request_id`.
|
|
16
|
+
*
|
|
17
|
+
* Resolves to the queued request.
|
|
18
|
+
* @see https://docs.qubesync.com/api-reference/v2/list-displays/create-list-display
|
|
19
|
+
*/
|
|
20
|
+
create(connectionId: string, params: ListDisplayCreateParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
21
|
+
/**
|
|
22
|
+
* Update list display: `PUT /connections/{connection_id}/list-displays`, queued for QuickBooks.
|
|
23
|
+
*
|
|
24
|
+
* The answer comes to `webhookUrl` as one webhook.
|
|
25
|
+
* Params go in the JSON body.
|
|
26
|
+
*
|
|
27
|
+
* Fields: `list_display_mod_type` (required), `list_id` (required), `request_id`.
|
|
28
|
+
*
|
|
29
|
+
* Resolves to the queued request.
|
|
30
|
+
* @see https://docs.qubesync.com/api-reference/v2/list-displays/update-list-display
|
|
31
|
+
*/
|
|
32
|
+
update(connectionId: string, params: ListDisplayUpdateParams, options: OperationOptions): Promise<QueuedRequest>;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* The params of `list_display.create`: Create list display.
|
|
37
|
+
*/
|
|
38
|
+
export interface ListDisplayCreateParams {
|
|
39
|
+
/**
|
|
40
|
+
* Specifies the type of QuickBooks list for which to open an “add” form in the QuickBooks UI.
|
|
41
|
+
*/
|
|
42
|
+
list_display_add_type: "Account" | "Customer" | "Employee" | "Item" | "OtherName" | "Vendor";
|
|
43
|
+
/**
|
|
44
|
+
* 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`.
|
|
45
|
+
*/
|
|
46
|
+
request_id?: string;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* The params of `list_display.update`: Update list display.
|
|
51
|
+
*/
|
|
52
|
+
export interface ListDisplayUpdateParams {
|
|
53
|
+
/**
|
|
54
|
+
* The type of QuickBooks list element to open for modification in the QuickBooks UI. (`list_id` specifies the particular list element.)
|
|
55
|
+
*/
|
|
56
|
+
list_display_mod_type: "Account" | "Customer" | "Employee" | "Item" | "OtherName" | "Vendor";
|
|
57
|
+
/**
|
|
58
|
+
* `list_id` and FullName 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 FullName and `list_id` are supplied in a request, QuickBooks uses `list_id` and ignores FullName.
|
|
59
|
+
*/
|
|
60
|
+
list_id: string;
|
|
61
|
+
/**
|
|
62
|
+
* 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`.
|
|
63
|
+
*/
|
|
64
|
+
request_id?: string;
|
|
65
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
// Generated from operations.json by scripts/generate-operations.js: don't edit.
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
/** QuickBooks list display operations. Types: list_display.d.ts. */
|
|
5
|
+
class ListDisplay {
|
|
6
|
+
#client;
|
|
7
|
+
|
|
8
|
+
/** @param {import("../index").Client} client */
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.#client = client;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Create list display.
|
|
15
|
+
* @param {string} connectionId
|
|
16
|
+
* @param {import("./list_display").ListDisplayCreateParams} params
|
|
17
|
+
* @param {import("./types").OperationOptions} options
|
|
18
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
19
|
+
* @see https://docs.qubesync.com/api-reference/v2/list-displays/create-list-display
|
|
20
|
+
*/
|
|
21
|
+
create(connectionId, params, options) {
|
|
22
|
+
return this.#client.queue("list_display.create", connectionId, params, options);
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* Update list display.
|
|
27
|
+
* @param {string} connectionId
|
|
28
|
+
* @param {import("./list_display").ListDisplayUpdateParams} params
|
|
29
|
+
* @param {import("./types").OperationOptions} options
|
|
30
|
+
* @returns {Promise<import("./types").QueuedRequest>}
|
|
31
|
+
* @see https://docs.qubesync.com/api-reference/v2/list-displays/update-list-display
|
|
32
|
+
*/
|
|
33
|
+
update(connectionId, params, options) {
|
|
34
|
+
return this.#client.queue("list_display.update", connectionId, params, options);
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
module.exports = { ListDisplay };
|