conductor-node 0.0.4 → 0.0.7

package/src/qb/qbXMLTypes/Employee.ts

@@ -0,0 +1,471 @@
+import type {
+  ActiveStatus,
+  DataExtRet,
+  NameFilter,
+  NameRangeFilter,
+} from "conductor-node/qb/qbXMLTypes/shared";
+
+export interface EmployeeAddRq {
+  EmployeeAdd: EmployeeAdd;
+  IncludeRetElement?: string;
+}
+
+export interface EmployeeAddRs {
+  EmployeeRet?: EmployeeRet;
+}
+
+export interface EmployeeModRq {
+  EmployeeMod: EmployeeMod;
+  IncludeRetElement?: string;
+}
+
+export interface EmployeeModRs {
+  EmployeeRet?: EmployeeRet;
+}
+
+export interface EmployeeQueryRq {
+  // TODO: Look into use of "OR" and "may repeat" in the XMLOps.
+  ListID?: string;
+  FullName?: string;
+  MaxReturned?: number;
+  ActiveStatus?: ActiveStatus;
+  FromModifiedDate?: Date;
+  ToModifiedDate?: Date;
+  NameFilter?: NameFilter;
+  NameRangeFilter?: NameRangeFilter;
+}
+
+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?: 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;
+  AdditionalNotes?: AdditionalNotes;
+  BillingRateRef?: BillingRateRef;
+  EmployeePayrollInfo?: EmployeePayrollInfo;
+  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?: string;
+  /**
+   * The postal code in an address.
+   */
+  PostalCode?: string;
+}
+
+interface AdditionalContactRef {
+  ContactName: string;
+  ContactValue: string;
+}
+
+interface EmergencyContacts {
+  PrimaryContact?: {
+    ContactName: string;
+    ContactValue: string;
+    Relation?: Relation;
+  };
+  SecondaryContact?: {
+    ContactName: string;
+    ContactValue: string;
+    Relation?: Relation;
+  };
+}
+
+type Relation =
+  | "Brother"
+  | "Daughter"
+  | "Father"
+  | "Friend"
+  | "Mother"
+  | "Other"
+  | "Partner"
+  | "Sister"
+  | "Son"
+  | "Spouse";
+
+// Default is Regular
+type EmployeeType = "Officer" | "Owner" | "Regular" | "Statutory";
+
+type PartOrFullTime = "FullTime" | "PartTime";
+
+type Exempt = "Exempt" | "NonExempt";
+
+type KeyEmployee = "No" | "Yes";
+
+type Gender = "Female" | "Male";
+
+type USCitizen = "No" | "Yes";
+
+type Ethnicity =
+  | "AmericianIndian"
+  | "Asian"
+  | "Black"
+  | "Hawaiian"
+  | "Hispanic"
+  | "TwoOrMoreRaces"
+  | "White";
+
+type Disabled = "No" | "Yes";
+
+type OnFile = "No" | "Yes";
+
+type USVeteran = "No" | "Yes";
+
+type MilitaryStatus = "Active" | "Reserve";
+
+interface AdditionalNotes {
+  Note: string;
+}
+
+interface AdditionalNotesRet {
+  NoteID: number;
+  Date: Date;
+  Note: string;
+}
+
+interface AdditionalNotesMod {
+  NoteID: number;
+  Note: string;
+}
+
+interface BillingRateRef {
+  ListID?: string;
+  FullName?: string;
+}
+
+interface EmployeePayrollInfo {
+  PayPeriod?: PayPeriod;
+  ClassRef?: ClassRef;
+  ClearEarnings?: boolean;
+  Earnings?: Earnings;
+  IsUsingTimeDataToCreatePaychecks?: boolean;
+  UseTimeDataToCreatePaychecks?: UseTimeDataToCreatePaychecks;
+  SickHours?: SickHours;
+  VacationHours?: VacationHours;
+}
+
+interface EmployeePayrollInfoMod {
+  PayPeriod?: PayPeriod;
+  ClassRef?: ClassRef;
+  ClearEarnings?: boolean;
+  Earnings?: Earnings;
+  IsUsingTimeDataToCreatePaychecks?: boolean;
+  UseTimeDataToCreatePaychecks?: UseTimeDataToCreatePaychecks;
+  SickHours?: SickHours;
+  VacationHours?: VacationHours;
+}
+
+type PayPeriod =
+  | "Biweekly"
+  | "Daily"
+  | "Monthly"
+  | "Quarterly"
+  | "Semimonthly"
+  | "Weekly"
+  | "Yearly";
+
+interface ClassRef {
+  ListID?: string;
+  FullName?: string;
+}
+
+interface Earnings {
+  PayrollItemWageRef?: PayrollItemWageRef;
+  Rate?: string;
+  RatePercent?: string;
+}
+
+interface PayrollItemWageRef {
+  ListID?: string;
+  FullName?: string;
+}
+
+type UseTimeDataToCreatePaychecks =
+  | "DoNotUseTimeData"
+  | "NotSet"
+  | "UseTimeData";
+
+interface SickHours {
+  HoursAvailable?: string;
+  AccrualPeriod?: AccrualPeriod;
+  HoursAccrued?: string;
+  MaximumHours?: string;
+  IsResettingHoursEachNewYear?: boolean;
+  HoursUsed?: string;
+  AccrualStartDate?: Date;
+}
+
+type AccrualPeriod =
+  | "BeginningOfYear"
+  | "EveryHourOnPaycheck"
+  | "EveryPaycheck";
+
+interface VacationHours {
+  HoursAvailable?: string;
+  AccrualPeriod?: AccrualPeriod;
+  HoursAccrued?: string;
+  MaximumHours?: string;
+  IsResettingHoursEachNewYear?: boolean;
+  HoursUsed?: string;
+  AccrualStartDate?: Date;
+}

package/src/qb/qbXMLTypes/shared.ts

@@ -0,0 +1,48 @@
+/**
+ * Filters according to the object’s `Name`.
+ */
+export interface NameFilter {
+  /**
+   * The criterion to match.
+   */
+  MatchCriterion: MatchCriterion;
+  /**
+   * The string to match.
+   */
+  Name: string;
+}
+
+type MatchCriterion = "Contains" | "EndsWith" | "StartsWith";
+
+export interface NameRangeFilter {
+  /**
+   * The first name or item in the search range. If `FromName` is omitted, the
+   * range will begin with first name on the list.
+   */
+  FromName?: string;
+  /**
+   * The final name or item in the search range. If `ToName` is omitted, the
+   * range will end with last name on the list.
+   */
+  ToName?: string;
+}
+
+// Default is `ActiveOnly`
+export type ActiveStatus = "ActiveOnly" | "All" | "InactiveOnly";
+
+export interface DataExtRet {
+  OwnerID?: string;
+  DataExtName: string;
+  DataExtType: DataExtType;
+  DataExtValue: string;
+}
+
+type DataExtType =
+  | "AMTTYPE"
+  | "Date"
+  | "number"
+  | "PERCENTTYPE"
+  | "PRICETYPE"
+  | "QUANTYPE"
+  | "STR255TYPE"
+  | "STR1024TYPE";

package/dist/qbXMLTypes/Account.d.ts

@@ -1,98 +0,0 @@
-export interface AccountAddRq {
-    AccountAdd: AccountAdd;
-}
-export interface AccountAddRs {
-    AccountRet?: AccountRet;
-}
-interface AccountAdd {
-    Name: string;
-    IsActive?: boolean;
-    ParentRef?: ParentRef;
-    AccountType: AccountType;
-    AccountNumber?: string;
-    BankNumber?: string;
-    Desc?: string;
-    OpenBalance?: string;
-    OpenBalanceDate?: Date;
-    SalesTaxCodeRef?: SalesTaxCodeRef;
-    TaxLineID?: number;
-    CurrencyRef?: CurrencyRef;
-}
-export interface AccountQueryRq {
-    ListID?: string;
-    FullName?: string;
-    MaxReturned?: number;
-    ActiveStatus?: ActiveStatus;
-    FromModifiedDate?: Date;
-    ToModifiedDate?: Date;
-    NameFilter?: NameFilter;
-    NameRangeFilter?: NameRangeFilter;
-    AccountType?: AccountType;
-    CurrencyFilter?: CurrencyFilter;
-}
-export interface AccountQueryRs {
-    AccountRet?: AccountRet;
-}
-interface AccountRet {
-    ListID: string;
-    TimeCreated: string;
-    TimeModified: string;
-    EditSequence: string;
-    Name: string;
-    FullName: string;
-    IsActive?: boolean;
-    ParentRef?: ParentRef;
-    Sublevel: number;
-    AccountType: AccountType;
-    SpecialAccountType?: SpecialAccountType;
-    IsTaxAccount?: boolean;
-    AccountNumber?: string;
-    BankNumber?: string;
-    Desc?: string;
-    Balance?: string;
-    TotalBalance?: string;
-    SalesTaxCodeRef?: SalesTaxCodeRef;
-    TaxLineInfoRet?: {
-        TaxLineID: number;
-        TaxLineName?: string;
-    };
-    CashFlowClassification?: CashFlowClassification;
-    CurrencyRef?: CurrencyRef;
-    DataExtRet?: {
-        OwnerID?: string;
-        DataExtName: string;
-        DataExtType: DataExtType;
-        DataExtValue: string;
-    };
-}
-interface NameFilter {
-    MatchCriterion: MatchCriterion;
-    Name: string;
-}
-interface NameRangeFilter {
-    FromName?: string;
-    ToName?: string;
-}
-interface CurrencyFilter {
-    ListID?: string;
-    FullName?: string;
-}
-declare type MatchCriterion = "Contains" | "EndsWith" | "StartsWith";
-declare type ActiveStatus = "ActiveOnly" | "All" | "InactiveOnly";
-interface ParentRef {
-    ListID?: string;
-    FullName?: string;
-}
-interface SalesTaxCodeRef {
-    ListID?: string;
-    FullName?: string;
-}
-interface CurrencyRef {
-    ListID?: string;
-    FullName?: string;
-}
-declare type AccountType = "AccountsPayable" | "AccountsReceivable" | "Bank" | "CostOfGoodsSold" | "CreditCard" | "Equity" | "Expense" | "FixedAsset" | "Income" | "LongTermLiability" | "NonPosting" | "OtherAsset" | "OtherCurrentAsset" | "OtherCurrentLiability" | "OtherExpense" | "OtherIncome";
-declare type SpecialAccountType = "AccountsPayable" | "AccountsReceivable" | "CondenseItemAdjustmentExpenses" | "CostOfGoodsSold" | "DirectDepositLiabilities" | "Estimates" | "ExchangeGainLoss" | "InventoryAssets" | "ItemReceiptAccount" | "OpeningBalanceEquity" | "PayrollExpenses" | "PayrollLiabilities" | "PettyCash" | "PurchaseOrders" | "ReconciliationDifferences" | "RetainedEarnings" | "SalesOrders" | "SalesTaxPayable" | "UncategorizedExpenses" | "UncategorizedIncome" | "UndepositedFunds";
-declare type CashFlowClassification = "Financing" | "Investing" | "None" | "NotApplicable" | "Operating";
-declare type DataExtType = "AMTTYPE" | "Date" | "number" | "PERCENTTYPE" | "PRICETYPE" | "QUANTYPE" | "STR255TYPE" | "STR1024TYPE";
-export {};

package/dist/qbXMLTypes/index.d.ts

@@ -1,15 +0,0 @@
-import type { AccountAddRq, AccountAddRs, AccountQueryRq, AccountQueryRs } from "@client/qbXMLTypes/Account";
-export declare type QBXMLRequest = {
-    AccountAddRq: AccountAddRq;
-} | {
-    AccountQueryRq: AccountQueryRq;
-};
-declare type GetSubtype<T> = T extends {
-    [key: string]: infer U;
-} ? U : never;
-export declare type QBXMLResponse<T extends QBXMLRequest> = GetSubtype<T> extends AccountAddRq ? {
-    AccountAddRs: AccountAddRs;
-} : GetSubtype<T> extends AccountQueryRq ? {
-    AccountQueryRs: AccountQueryRs;
-} : unknown;
-export {};