conductor-node 0.0.17 → 0.0.18

package/dist/src/qb/qbXMLTypes/Account.d.ts

@@ -1,6 +1,19 @@
 import type { ActiveStatus, CurrencyFilter, CurrencyRef, DataExtRet, NameFilter, NameRangeFilter, ParentRef, SalesTaxCodeRef } from "../../qb/qbXMLTypes/shared";
 export interface AccountAddRq {
     AccountAdd: AccountAdd;
+    /**
+     * You use this if you want to limit the data that will be returned in the
+     * response. In this list, you specify the name of each top-level element or
+     * aggregate that you want to be returned in the response to the request. You
+     * cannot specify fields within an aggregate, for example, you cannot specify
+     * a `City` within an `Address`: you must specify Address and will get the
+     * entire address. The names specified in the list are not parsed, so you must
+     * be especially careful to supply valid names, properly cased. No error is
+     * returned in the status code if you specify an invalid name. Notice that if
+     * you want to return custom data or private data extensions, you must specify
+     * the DataExtRet element and you must supply the `OwnerID` set to either a
+     * value of 0 (custom data) or the `GUID` for the private data.
+     */
     IncludeRetElement?: string;
 }
 export interface AccountAddRs {
@@ -104,6 +117,11 @@ export interface AccountAdd {
 export interface AccountQueryRq {
     ListID?: string;
     FullName?: string;
+    /**
+     * Limits the number of objects that a query returns. (To get a count of how
+     * many objects could possibly be returned, use the metaData query attribute.)
+     * If you include a `MaxReturned` value, it must be at least 1.
+     */
     /**
      * Limits the number of objects that a query returns. (To get a count of how
      * many objects could possibly be returned, use the metaData query attribute.)
@@ -116,7 +134,31 @@ export interface AccountQueryRq {
      * which selects only list objects that are active.
      */
     ActiveStatus?: ActiveStatus;
+    /**
+     * Selects objects modified on or after this date.
+     *
+     * `FromModifiedDate` and `ToModifiedDate` must be between 1970-01-01 and
+     * 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). (The time portion of
+     * the field was not supported in qbXML version 1.0 or 1.1.)
+     *
+     * If `FromModifiedDate` includes a date but not a time (for example, if you
+     * set `FromModifiedDate` to 2003-02-14), the time is assumed to be zero
+     * (2003-02-14T00:00:00). If you omit `FromModifiedDate`, it will be set to
+     * 1970-01-01T00:00:00 (1969-12-31T16:00:00-08:00 PST).
+     */
     FromModifiedDate?: Date;
+    /**
+     * Selects objects modified on or before this date.
+     *
+     * `ToModifiedDate` and `FromModifiedDate` must be between 1970-01-01 and
+     * 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). (Note that the time
+     * portion of the field was not supported in qbXML version 1.0 or 1.1.)
+     *
+     * If `ToModifiedDate` includes a date but not a time (for example, if you set
+     * `ToModifiedDate` to 2003-02-14), the time is assumed to be the end of the
+     * day (2003-02-14T23:59:59). If you omit `ToModifiedDate` altogether, it will
+     * be set to 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST).
+     */
     ToModifiedDate?: Date;
     /**
      * Filters according to the object’s `Name`.
@@ -126,8 +168,47 @@ export interface AccountQueryRq {
      * Filters according to the object’s `Name`.
      */
     NameRangeFilter?: NameRangeFilter;
+    /**
+     * A list of QuickBooks account types.
+     */
     AccountType?: AccountType;
+    /**
+     * Filters by the specified currency.
+     */
     CurrencyFilter?: CurrencyFilter;
+    /**
+     * You use this if you want to limit the data that will be returned in the
+     * response. In this list, you specify the name of each top-level element or
+     * aggregate that you want to be returned in the response to the request. You
+     * cannot specify fields within an aggregate, for example, you cannot specify
+     * a `City` within an `Address`: you must specify Address and will get the
+     * entire address. The names specified in the list are not parsed, so you must
+     * be especially careful to supply valid names, properly cased. No error is
+     * returned in the status code if you specify an invalid name. Notice that if
+     * you want to return custom data or private data extensions, you must specify
+     * the DataExtRet element and you must supply the `OwnerID` set to either a
+     * value of 0 (custom data) or the `GUID` for the private data.
+     */
+    IncludeRetElement?: string;
+    /**
+     * Zero or more `OwnerID` values. `OwnerID` refers to the owner of a data
+     * extension: If `OwnerID` is 0, this is a public data extension, also known
+     * as a custom field. Custom fields appear in the QuickBooks UI.
+     *
+     * If `OwnerID` is a GUID, for example
+     * `{6B063959-81B0-4622-85D6-F548C8CCB517}`, this field is a private data
+     * extension defined by an integrated application. Private data extensions do
+     * not appear in the QuickBooks UI.
+     *
+     * Note that `OwnerID` values are not case-sensitive, meaning that if you
+     * enter an `OwnerID` value with lower-case letters, the value will be saved
+     * and returned with upper-case letters.
+     *
+     * When you share a private data extension with another application, the other
+     * application must know both the `OwnerID` and the `DataExtName`, as these
+     * together form a data extension’s unique name.
+     */
+    OwnerID?: string;
 }
 export interface AccountQueryRs {
     AccountRet?: AccountRet;

package/dist/src/qb/qbXMLTypes/Customer.d.ts

@@ -2,16 +2,90 @@ import type { ActiveStatus, AdditionalContactRef, AdditionalNotesRet, ClassFilte
 export interface CustomerQueryRq {
     ListID?: string;
     FullName?: string;
+    /**
+     * Limits the number of objects that a query returns. (To get a count of how
+     * many objects could possibly be returned, use the metaData query attribute.)
+     * If you include a `MaxReturned` value, it must be at least 1.
+     */
     MaxReturned?: number;
+    /**
+     * 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.
+     */
     ActiveStatus?: ActiveStatus;
+    /**
+     * Selects objects modified on or after this date.
+     *
+     * `FromModifiedDate` and `ToModifiedDate` must be between 1970-01-01 and
+     * 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). (The time portion of
+     * the field was not supported in qbXML version 1.0 or 1.1.)
+     *
+     * If `FromModifiedDate` includes a date but not a time (for example, if you
+     * set `FromModifiedDate` to 2003-02-14), the time is assumed to be zero
+     * (2003-02-14T00:00:00). If you omit `FromModifiedDate`, it will be set to
+     * 1970-01-01T00:00:00 (1969-12-31T16:00:00-08:00 PST).
+     */
     FromModifiedDate?: Date;
+    /**
+     * Selects objects modified on or before this date.
+     *
+     * `ToModifiedDate` and `FromModifiedDate` must be between 1970-01-01 and
+     * 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). (Note that the time
+     * portion of the field was not supported in qbXML version 1.0 or 1.1.)
+     *
+     * If `ToModifiedDate` includes a date but not a time (for example, if you set
+     * `ToModifiedDate` to 2003-02-14), the time is assumed to be the end of the
+     * day (2003-02-14T23:59:59). If you omit `ToModifiedDate` altogether, it will
+     * be set to 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST).
+     */
     ToModifiedDate?: Date;
+    /**
+     * Filters according to the object’s `Name`.
+     */
     NameFilter?: NameFilter;
+    /**
+     * Filters according to the object’s `Name`.
+     */
     NameRangeFilter?: NameRangeFilter;
     TotalBalanceFilter?: TotalBalanceFilter;
+    /**
+     * Filters by the specified currency.
+     */
     CurrencyFilter?: CurrencyFilter;
     ClassFilter?: ClassFilter;
+    /**
+     * You use this if you want to limit the data that will be returned in the
+     * response. In this list, you specify the name of each top-level element or
+     * aggregate that you want to be returned in the response to the request. You
+     * cannot specify fields within an aggregate, for example, you cannot specify
+     * a `City` within an `Address`: you must specify Address and will get the
+     * entire address. The names specified in the list are not parsed, so you must
+     * be especially careful to supply valid names, properly cased. No error is
+     * returned in the status code if you specify an invalid name. Notice that if
+     * you want to return custom data or private data extensions, you must specify
+     * the DataExtRet element and you must supply the `OwnerID` set to either a
+     * value of 0 (custom data) or the `GUID` for the private data.
+     */
     IncludeRetElement?: string;
+    /**
+     * Zero or more `OwnerID` values. `OwnerID` refers to the owner of a data
+     * extension: If `OwnerID` is 0, this is a public data extension, also known
+     * as a custom field. Custom fields appear in the QuickBooks UI.
+     *
+     * If `OwnerID` is a GUID, for example
+     * `{6B063959-81B0-4622-85D6-F548C8CCB517}`, this field is a private data
+     * extension defined by an integrated application. Private data extensions do
+     * not appear in the QuickBooks UI.
+     *
+     * Note that `OwnerID` values are not case-sensitive, meaning that if you
+     * enter an `OwnerID` value with lower-case letters, the value will be saved
+     * and returned with upper-case letters.
+     *
+     * When you share a private data extension with another application, the other
+     * application must know both the `OwnerID` and the `DataExtName`, as these
+     * together form a data extension’s unique name.
+     */
     OwnerID?: string;
 }
 export interface CustomerQueryRs {

package/dist/src/qb/qbXMLTypes/Employee.d.ts

@@ -1,6 +1,19 @@
 import type { ActiveStatus, AdditionalContactRef, AdditionalNotesRet, BillingRateRef, ClassRef, DataExtRet, NameFilter, NameRangeFilter } from "../../qb/qbXMLTypes/shared";
 export interface EmployeeAddRq {
     EmployeeAdd: EmployeeAdd;
+    /**
+     * You use this if you want to limit the data that will be returned in the
+     * response. In this list, you specify the name of each top-level element or
+     * aggregate that you want to be returned in the response to the request. You
+     * cannot specify fields within an aggregate, for example, you cannot specify
+     * a `City` within an `Address`: you must specify Address and will get the
+     * entire address. The names specified in the list are not parsed, so you must
+     * be especially careful to supply valid names, properly cased. No error is
+     * returned in the status code if you specify an invalid name. Notice that if
+     * you want to return custom data or private data extensions, you must specify
+     * the DataExtRet element and you must supply the `OwnerID` set to either a
+     * value of 0 (custom data) or the `GUID` for the private data.
+     */
     IncludeRetElement?: string;
 }
 export interface EmployeeAddRs {
@@ -8,6 +21,19 @@ export interface EmployeeAddRs {
 }
 export interface EmployeeModRq {
     EmployeeMod: EmployeeMod;
+    /**
+     * You use this if you want to limit the data that will be returned in the
+     * response. In this list, you specify the name of each top-level element or
+     * aggregate that you want to be returned in the response to the request. You
+     * cannot specify fields within an aggregate, for example, you cannot specify
+     * a `City` within an `Address`: you must specify Address and will get the
+     * entire address. The names specified in the list are not parsed, so you must
+     * be especially careful to supply valid names, properly cased. No error is
+     * returned in the status code if you specify an invalid name. Notice that if
+     * you want to return custom data or private data extensions, you must specify
+     * the DataExtRet element and you must supply the `OwnerID` set to either a
+     * value of 0 (custom data) or the `GUID` for the private data.
+     */
     IncludeRetElement?: string;
 }
 export interface EmployeeModRs {
@@ -16,12 +42,85 @@ export interface EmployeeModRs {
 export interface EmployeeQueryRq {
     ListID?: string;
     FullName?: string;
+    /**
+     * Limits the number of objects that a query returns. (To get a count of how
+     * many objects could possibly be returned, use the metaData query attribute.)
+     * If you include a `MaxReturned` value, it must be at least 1.
+     */
     MaxReturned?: number;
+    /**
+     * 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.
+     */
     ActiveStatus?: ActiveStatus;
+    /**
+     * Selects objects modified on or after this date.
+     *
+     * `FromModifiedDate` and `ToModifiedDate` must be between 1970-01-01 and
+     * 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). (The time portion of
+     * the field was not supported in qbXML version 1.0 or 1.1.)
+     *
+     * If `FromModifiedDate` includes a date but not a time (for example, if you
+     * set `FromModifiedDate` to 2003-02-14), the time is assumed to be zero
+     * (2003-02-14T00:00:00). If you omit `FromModifiedDate`, it will be set to
+     * 1970-01-01T00:00:00 (1969-12-31T16:00:00-08:00 PST).
+     */
     FromModifiedDate?: Date;
+    /**
+     * Selects objects modified on or before this date.
+     *
+     * `ToModifiedDate` and `FromModifiedDate` must be between 1970-01-01 and
+     * 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). (Note that the time
+     * portion of the field was not supported in qbXML version 1.0 or 1.1.)
+     *
+     * If `ToModifiedDate` includes a date but not a time (for example, if you set
+     * `ToModifiedDate` to 2003-02-14), the time is assumed to be the end of the
+     * day (2003-02-14T23:59:59). If you omit `ToModifiedDate` altogether, it will
+     * be set to 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST).
+     */
     ToModifiedDate?: Date;
+    /**
+     * Filters according to the object’s `Name`.
+     */
     NameFilter?: NameFilter;
+    /**
+     * Filters according to the object’s `Name`.
+     */
     NameRangeFilter?: NameRangeFilter;
+    /**
+     * You use this if you want to limit the data that will be returned in the
+     * response. In this list, you specify the name of each top-level element or
+     * aggregate that you want to be returned in the response to the request. You
+     * cannot specify fields within an aggregate, for example, you cannot specify
+     * a `City` within an `Address`: you must specify Address and will get the
+     * entire address. The names specified in the list are not parsed, so you must
+     * be especially careful to supply valid names, properly cased. No error is
+     * returned in the status code if you specify an invalid name. Notice that if
+     * you want to return custom data or private data extensions, you must specify
+     * the DataExtRet element and you must supply the `OwnerID` set to either a
+     * value of 0 (custom data) or the `GUID` for the private data.
+     */
+    IncludeRetElement?: string;
+    /**
+     * Zero or more `OwnerID` values. `OwnerID` refers to the owner of a data
+     * extension: If `OwnerID` is 0, this is a public data extension, also known
+     * as a custom field. Custom fields appear in the QuickBooks UI.
+     *
+     * If `OwnerID` is a GUID, for example
+     * `{6B063959-81B0-4622-85D6-F548C8CCB517}`, this field is a private data
+     * extension defined by an integrated application. Private data extensions do
+     * not appear in the QuickBooks UI.
+     *
+     * Note that `OwnerID` values are not case-sensitive, meaning that if you
+     * enter an `OwnerID` value with lower-case letters, the value will be saved
+     * and returned with upper-case letters.
+     *
+     * When you share a private data extension with another application, the other
+     * application must know both the `OwnerID` and the `DataExtName`, as these
+     * together form a data extension’s unique name.
+     */
+    OwnerID?: string;
 }
 export interface EmployeeQueryRs {
     EmployeeRet?: EmployeeRet;
@@ -140,27 +239,91 @@ export interface EmployeeAdd {
      * Full or Part time status of the employee.
      */
     PartOrFullTime?: PartOrFullTime;
+    /**
+     * Exempt or non-exempt status of the employee.
+     */
     Exempt?: Exempt;
+    /**
+     * Is employee a key or critical employee.
+     */
     KeyEmployee?: KeyEmployee;
+    /**
+     * The gender of this employee.
+     */
     Gender?: Gender;
+    /**
+     * An employee’s date of hire.
+     */
     HiredDate?: Date;
+    /**
+     * Original hire date the employee was hired.
+     */
     OriginalHireDate?: Date;
+    /**
+     * Adjusted service date for the employee.
+     */
     AdjustedServiceDate?: Date;
+    /**
+     * The date on which this person’s employment with the company ended.
+     */
     ReleasedDate?: Date;
+    /**
+     * Date of birth.
+     */
     BirthDate?: Date;
+    /**
+     * Is employee a US citizen?
+     */
     USCitizen?: USCitizen;
+    /**
+     * Ethnicity of employee from AmericianIndian, Asian, Black, Hawaiian, Hispanic, White, TwoOrMoreRaces
+     */
     Ethnicity?: Ethnicity;
+    /**
+     * Is employee disabled?
+     */
     Disabled?: Disabled;
+    /**
+     * Description of employee’s disability.
+     */
     DisabilityDesc?: string;
+    /**
+     * Is the employee’s I-9 on file?
+     */
     OnFile?: OnFile;
+    /**
+     * Date the employee’s work authorization expires.
+     */
     WorkAuthExpireDate?: Date;
+    /**
+     * Is employee a US veteran?
+     */
     USVeteran?: USVeteran;
+    /**
+     * Military status if the employee is a US veteran.
+     */
     MilitaryStatus?: MilitaryStatus;
+    /**
+     * Account numbers appear in the QuickBooks chart of accounts, Account fields,
+     * and reports and graphs. If the `IsUsingAccountNumber` preference is false
+     * (that is, if the QuickBooks user has the account numbers Preference turned
+     * off), you can still set account numbers through the SDK, but the numbers
+     * will not be visible in the user interface.
+     */
     AccountNumber?: string;
+    /**
+     * Additional information.
+     */
     Notes?: string;
+    /**
+     * List of notes.
+     */
     AdditionalNotes?: AdditionalNotes;
     BillingRateRef?: BillingRateRef;
     EmployeePayrollInfo?: EmployeePayrollInfo;
+    /**
+     * Allows for the attachment of a user defined GUID value.
+     */
     ExternalGUID?: string;
 }
 export interface EmployeeRet {

package/dist/src/qb/qbXMLTypes/Vendor.d.ts

@@ -2,16 +2,98 @@ import type { ActiveStatus, AdditionalContactRef, AdditionalNotesRet, BillingRat
 export interface VendorQueryRq {
     ListID?: string;
     FullName?: string;
+    /**
+     * Limits the number of objects that a query returns. (To get a count of how
+     * many objects could possibly be returned, use the metaData query attribute.)
+     * If you include a `MaxReturned` value, it must be at least 1.
+     */
     MaxReturned?: number;
+    /**
+     * 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.
+     */
     ActiveStatus?: ActiveStatus;
+    /**
+     * Selects objects modified on or after this date.
+     *
+     * `FromModifiedDate` and `ToModifiedDate` must be between 1970-01-01 and
+     * 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). (The time portion of
+     * the field was not supported in qbXML version 1.0 or 1.1.)
+     *
+     * If `FromModifiedDate` includes a date but not a time (for example, if you
+     * set `FromModifiedDate` to 2003-02-14), the time is assumed to be zero
+     * (2003-02-14T00:00:00). If you omit `FromModifiedDate`, it will be set to
+     * 1970-01-01T00:00:00 (1969-12-31T16:00:00-08:00 PST).
+     */
     FromModifiedDate?: Date;
+    /**
+     * Selects objects modified on or before this date.
+     *
+     * `ToModifiedDate` and `FromModifiedDate` must be between 1970-01-01 and
+     * 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). (Note that the time
+     * portion of the field was not supported in qbXML version 1.0 or 1.1.)
+     *
+     * If `ToModifiedDate` includes a date but not a time (for example, if you set
+     * `ToModifiedDate` to 2003-02-14), the time is assumed to be the end of the
+     * day (2003-02-14T23:59:59). If you omit `ToModifiedDate` altogether, it will
+     * be set to 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST).
+     */
     ToModifiedDate?: Date;
+    /**
+     * Filters according to the object’s `Name`.
+     */
     NameFilter?: NameFilter;
+    /**
+     * Filters according to the object’s `Name`.
+     */
     NameRangeFilter?: NameRangeFilter;
+    /**
+     * Filters according to total balance. Total balance includes the balance for
+     * all subaccounts; for example, a customer’s TotalBalance would include all
+     * the jobs for that customer.
+     */
     TotalBalanceFilter?: TotalBalanceFilter;
+    /**
+     * Filters by the specified currency.
+     */
     CurrencyFilter?: CurrencyFilter;
+    /**
+     * Filter according to class.
+     */
     ClassFilter?: ClassFilter;
+    /**
+     * You use this if you want to limit the data that will be returned in the
+     * response. In this list, you specify the name of each top-level element or
+     * aggregate that you want to be returned in the response to the request. You
+     * cannot specify fields within an aggregate, for example, you cannot specify
+     * a `City` within an `Address`: you must specify Address and will get the
+     * entire address. The names specified in the list are not parsed, so you must
+     * be especially careful to supply valid names, properly cased. No error is
+     * returned in the status code if you specify an invalid name. Notice that if
+     * you want to return custom data or private data extensions, you must specify
+     * the DataExtRet element and you must supply the `OwnerID` set to either a
+     * value of 0 (custom data) or the `GUID` for the private data.
+     */
     IncludeRetElement?: string;
+    /**
+     * Zero or more `OwnerID` values. `OwnerID` refers to the owner of a data
+     * extension: If `OwnerID` is 0, this is a public data extension, also known
+     * as a custom field. Custom fields appear in the QuickBooks UI.
+     *
+     * If `OwnerID` is a GUID, for example
+     * `{6B063959-81B0-4622-85D6-F548C8CCB517}`, this field is a private data
+     * extension defined by an integrated application. Private data extensions do
+     * not appear in the QuickBooks UI.
+     *
+     * Note that `OwnerID` values are not case-sensitive, meaning that if you
+     * enter an `OwnerID` value with lower-case letters, the value will be saved
+     * and returned with upper-case letters.
+     *
+     * When you share a private data extension with another application, the other
+     * application must know both the `OwnerID` and the `DataExtName`, as these
+     * together form a data extension’s unique name.
+     */
     OwnerID?: string;
 }
 export interface VendorQueryRs {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "conductor-node",
-  "version": "0.0.17",
+  "version": "0.0.18",
   "description": "Conductor API wrapper",
   "author": "Danny Nemer <hi@DannyNemer.com>",
   "license": "MIT",