conductor-node 0.1.2 → 0.1.5

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

@@ -1,590 +0,0 @@
-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 {
-    EmployeeRet?: EmployeeRet;
-}
-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 {
-    EmployeeRet?: EmployeeRet;
-}
-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;
-}
-export interface EmployeeAdd {
-    /**
-     * If `IsActive` is true, this object is currently enabled for use by
-     * QuickBooks. The default value is `true`.
-     */
-    IsActive?: boolean;
-    /**
-     * A formal reference, such as Mr. or Dr., that precedes a name.
-     */
-    Salutation?: string;
-    /**
-     * The first name of a customer, vendor, employee, or person on the “other
-     * names” list.
-     */
-    FirstName?: string;
-    /**
-     * The middle name of a customer, vendor, employee, or person on the “other
-     * names” list.
-     */
-    MiddleName?: string;
-    /**
-     * The last name of a customer, vendor, employee, or person on the “other
-     * names” list.
-     */
-    LastName?: string;
-    /**
-     * The job title of a customer, vendor, employee, or person on the “other
-     * names” list.
-     */
-    JobTitle?: string;
-    /**
-     * The name of a customer, vendor, employee, or person on the “other names”
-     * list in the employment job details section.
-     */
-    SupervisorRef?: SupervisorRef;
-    /**
-     * The name of the department in the employment job details section.
-     */
-    Department?: string;
-    /**
-     * The description details in the employment job details section.
-     */
-    Description?: string;
-    /**
-     * The target bonus amount in the employment job details section.
-     */
-    TargetBonus?: string;
-    /**
-     * If an address request fails, some combination of address fields might be
-     * too long. If you use payroll, you must specify the employee’s city, state
-     * (or province), ZIP (or postal) code, and at least one line of the street
-     * address. (Note that the State element has restrictions when it’s used in
-     * the `EmployeeAddress` aggregate. For more information, click State in the
-     * table.)
-     */
-    EmployeeAddress?: EmployeeAddress;
-    /**
-     * By default within QuickBooks, the `PrintAs` element is the same as the
-     * `Name` element.
-     */
-    PrintAs?: string;
-    /**
-     * The telephone number.
-     */
-    Phone?: string;
-    /**
-     * Mobile telephone number.
-     */
-    Mobile?: string;
-    /**
-     * The pager number.
-     */
-    Pager?: string;
-    /**
-     * A personal identification number for this employee’s pager.
-     */
-    PagerPIN?: string;
-    /**
-     * A telephone number given as an alternative to `Phone`.
-     */
-    AltPhone?: string;
-    /**
-     * Fax number.
-     */
-    Fax?: string;
-    /**
-     * Social security number. When you add an SSN value to an employee record, it
-     * does not have to include dashes; for example, either 123-45-6789 or
-     * 123456789 would be valid.
-     */
-    SSN?: string;
-    /**
-     * E-mail address.
-     */
-    Email?: string;
-    /**
-     * List of additional contacts.
-     */
-    AdditionalContactRef?: AdditionalContactRef;
-    /**
-     * Emergency Contact information for the employee.
-     */
-    EmergencyContacts?: EmergencyContacts;
-    /**
-     * `EmployeeType` can affect payroll taxes for an employee. A statutory
-     * employee is a person who is defined as an employee by statute. Usually an
-     * owner or partner will be on the `Other Names` list, but if they are on the
-     * `Employee` list, their `EmployeeType` will be `Owner`.
-     */
-    EmployeeType?: EmployeeType;
-    /**
-     * 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 {
-    ListID: string;
-    TimeCreated: Date;
-    TimeModified: Date;
-    EditSequence: string;
-    Name: string;
-    IsActive?: boolean;
-    Salutation?: string;
-    FirstName?: string;
-    MiddleName?: string;
-    LastName?: string;
-    JobTitle?: string;
-    SupervisorRef?: SupervisorRef;
-    Department?: string;
-    Description?: string;
-    TargetBonus?: string;
-    EmployeeAddress?: EmployeeAddress;
-    PrintAs?: string;
-    Phone?: string;
-    Mobile?: string;
-    Pager?: string;
-    PagerPIN?: string;
-    AltPhone?: string;
-    Fax?: string;
-    SSN?: string;
-    Email?: string;
-    AdditionalContactRef?: AdditionalContactRef;
-    EmergencyContacts?: EmergencyContacts;
-    EmployeeType?: EmployeeType;
-    PartOrFullTime?: PartOrFullTime;
-    Exempt?: Exempt;
-    KeyEmployee?: KeyEmployee;
-    Gender?: Gender;
-    HiredDate?: Date;
-    OriginalHireDate?: Date;
-    AdjustedServiceDate?: Date;
-    ReleasedDate?: Date;
-    BirthDate?: Date;
-    USCitizen?: USCitizen;
-    Ethnicity?: Ethnicity;
-    Disabled?: Disabled;
-    DisabilityDesc?: string;
-    OnFile?: OnFile;
-    WorkAuthExpireDate?: Date;
-    USVeteran?: USVeteran;
-    MilitaryStatus?: MilitaryStatus;
-    AccountNumber?: string;
-    Notes?: string;
-    AdditionalNotesRet?: AdditionalNotesRet;
-    BillingRateRef?: BillingRateRef;
-    EmployeePayrollInfo?: EmployeePayrollInfo;
-    ExternalGUID?: string;
-    DataExtRet?: DataExtRet;
-}
-export interface EmployeeMod {
-    ListID: string;
-    EditSequence: string;
-    IsActive?: boolean;
-    Salutation?: string;
-    FirstName?: string;
-    MiddleName?: string;
-    LastName?: string;
-    JobTitle?: string;
-    SupervisorRef?: SupervisorRef;
-    Department?: string;
-    Description?: string;
-    TargetBonus?: string;
-    EmployeeAddress?: EmployeeAddress;
-    PrintAs?: string;
-    Phone?: string;
-    Mobile?: string;
-    Pager?: string;
-    PagerPIN?: string;
-    AltPhone?: string;
-    Fax?: string;
-    Email?: string;
-    AdditionalContactRef?: AdditionalContactRef;
-    EmergencyContacts?: EmergencyContacts;
-    EmployeeType?: EmployeeType;
-    PartOrFullTime?: PartOrFullTime;
-    Exempt?: Exempt;
-    KeyEmployee?: KeyEmployee;
-    HiredDate?: Date;
-    OriginalHireDate?: Date;
-    AdjustedServiceDate?: Date;
-    ReleasedDate?: Date;
-    BirthDate?: Date;
-    USCitizen?: USCitizen;
-    Ethnicity?: Ethnicity;
-    Disabled?: Disabled;
-    DisabilityDesc?: string;
-    OnFile?: OnFile;
-    WorkAuthExpireDate?: Date;
-    USVeteran?: USVeteran;
-    MilitaryStatus?: MilitaryStatus;
-    AccountNumber?: string;
-    Notes?: string;
-    AdditionalNotesMod?: AdditionalNotesMod;
-    BillingRateRef?: BillingRateRef;
-    EmployeePayrollInfoMod?: EmployeePayrollInfoMod;
-}
-interface SupervisorRef {
-    ListID?: string;
-    FullName?: string;
-}
-interface EmployeeAddress {
-    /**
-     * The first line of an address.
-     */
-    Addr1?: string;
-    /**
-     * The second line of an address (if a second line is needed).
-     */
-    Addr2?: string;
-    /**
-     * The city name in an address.
-     */
-    City?: string;
-    /**
-     * When it appears in the `EmployeeAddress` aggregate, the State element acts
-     * like an `ENUMTYPE` with the following possible values: None, AA (military),
-     * AE (military), AK, AL, AP (military), AR, AZ, CA, CO, CT, DC, DE, FL, GA,
-     * HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MI, MN, MO, MS, MT, NC, ND, NE,
-     * NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, RI, SC, SD, TN, TX, UT, VA, VT, WA,
-     * WI, WV, and WY.
-     */
-    State?: State;
-    /**
-     * The postal code in an address.
-     */
-    PostalCode?: string;
-}
-declare type State = "AA" | "AE" | "AK" | "AL" | "AP" | "AR" | "AZ" | "CA" | "CO" | "CT" | "DC" | "DE" | "FL" | "GA" | "HI" | "IA" | "ID" | "IL" | "IN" | "KS" | "KY" | "LA" | "MA" | "MD" | "ME" | "MI" | "MN" | "MO" | "MS" | "MT" | "NC" | "ND" | "NE" | "NH" | "NJ" | "NM" | "None" | "NV" | "NY" | "OH" | "OK" | "OR" | "PA" | "PR" | "RI" | "SC" | "SD" | "TN" | "TX" | "UT" | "VA" | "VT" | "WA" | "WI" | "WV" | "WY";
-interface EmergencyContacts {
-    PrimaryContact?: {
-        ContactName: string;
-        ContactValue: string;
-        Relation?: Relation;
-    };
-    SecondaryContact?: {
-        ContactName: string;
-        ContactValue: string;
-        Relation?: Relation;
-    };
-}
-declare type Relation = "Brother" | "Daughter" | "Father" | "Friend" | "Mother" | "Other" | "Partner" | "Sister" | "Son" | "Spouse";
-declare type EmployeeType = "Officer" | "Owner" | "Regular" | "Statutory";
-declare type PartOrFullTime = "FullTime" | "PartTime";
-declare type Exempt = "Exempt" | "NonExempt";
-declare type KeyEmployee = "No" | "Yes";
-declare type Gender = "Female" | "Male";
-declare type USCitizen = "No" | "Yes";
-declare type Ethnicity = "AmericianIndian" | "Asian" | "Black" | "Hawaiian" | "Hispanic" | "TwoOrMoreRaces" | "White";
-declare type Disabled = "No" | "Yes";
-declare type OnFile = "No" | "Yes";
-declare type USVeteran = "No" | "Yes";
-declare type MilitaryStatus = "Active" | "Reserve";
-interface AdditionalNotes {
-    Note: string;
-}
-interface AdditionalNotesMod {
-    NoteID: number;
-    Note: string;
-}
-interface EmployeePayrollInfo {
-    PayPeriod?: PayPeriod;
-    ClassRef?: ClassRef;
-    ClearEarnings?: boolean;
-    Earnings?: Earnings;
-    /**
-     * Indicates whether or not paychecks are generated from time-tracking data.
-     * If you include a blank `IsUsingTimeDataToCreatePaychecks` element in an
-     * `EmployeeMod` message, you’ll receive an error.
-     */
-    IsUsingTimeDataToCreatePaychecks?: boolean;
-    /**
-     * Indicates whether time data is used to create paychecks for this employee.
-     */
-    UseTimeDataToCreatePaychecks?: UseTimeDataToCreatePaychecks;
-    /**
-     * Describes how “sick time” is accrued for this employee, along with how many
-     * sick hours the employee has accrued.
-     */
-    SickHours?: SickHours;
-    VacationHours?: VacationHours;
-}
-interface EmployeePayrollInfoMod {
-    PayPeriod?: PayPeriod;
-    ClassRef?: ClassRef;
-    ClearEarnings?: boolean;
-    Earnings?: Earnings;
-    IsUsingTimeDataToCreatePaychecks?: boolean;
-    UseTimeDataToCreatePaychecks?: UseTimeDataToCreatePaychecks;
-    SickHours?: SickHours;
-    VacationHours?: VacationHours;
-}
-declare type PayPeriod = "Biweekly" | "Daily" | "Monthly" | "Quarterly" | "Semimonthly" | "Weekly" | "Yearly";
-interface Earnings {
-    PayrollItemWageRef?: PayrollItemWageRef;
-    Rate?: string;
-    RatePercent?: string;
-}
-interface PayrollItemWageRef {
-    ListID?: string;
-    FullName?: string;
-}
-declare type UseTimeDataToCreatePaychecks = "DoNotUseTimeData" | "NotSet" | "UseTimeData";
-interface SickHours {
-    /**
-     * The total number of hours currently available for the employee to use. If
-     * this value is empty, it will default to 0.
-     */
-    HoursAvailable?: string;
-    /**
-     * Indicates how an employee accrues time off. If you include a blank
-     * `AccrualPeriod` element in an `EmployeeMod` message, you’ll receive an
-     * error. The default value is whatever the QuickBooks user has set in the
-     * QuickBooks Employee Preferences.
-     */
-    AccrualPeriod?: AccrualPeriod;
-    /**
-     * The number of hours that the employee will accrue per accrual period. The
-     * default value is whatever the QuickBooks user has set in the QuickBooks
-     * Employee Preferences.
-     */
-    HoursAccrued?: string;
-    /**
-     * The maximum number of hours that the employee can accrue. (QuickBooks
-     * itself does not enforce this limit, however. HoursAvailable can be greater
-     * than MaximumHours.) The default value is whatever the QuickBooks user has
-     * set in the QuickBooks Employee Preferences.
-     */
-    MaximumHours?: string;
-    /**
-     * Indicates whether or not the hours accrued resets to zero at the beginning
-     * of the new year. If you include a blank `IsResettingHoursEachNewYear`
-     * element in an `EmployeeMod` message, you’ll receive an error.
-     */
-    IsResettingHoursEachNewYear?: boolean;
-    /**
-     * When used in the `SickHours` or `VacationHours` aggregates, refers to the
-     * number of sick leave or vacation hours used in the current year.
-     */
-    HoursUsed?: string;
-    /**
-     * When used in the `SickHours` or `VacationHours` aggregates, refers to the
-     * date on which sick leave or vacation hours in the current year began to
-     * accrue.
-     */
-    AccrualStartDate?: Date;
-}
-declare type AccrualPeriod = "BeginningOfYear" | "EveryHourOnPaycheck" | "EveryPaycheck";
-interface VacationHours {
-    HoursAvailable?: string;
-    AccrualPeriod?: AccrualPeriod;
-    HoursAccrued?: string;
-    MaximumHours?: string;
-    IsResettingHoursEachNewYear?: boolean;
-    HoursUsed?: string;
-    AccrualStartDate?: Date;
-}
-export {};

package/dist/src/qb/qbXMLTypes/Employee.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });