conductor-node 0.0.11 → 0.0.14

package/src/qb/qbXMLTypes/Employee.ts

@@ -1,501 +0,0 @@
-import type {
-  ActiveStatus,
-  AdditionalContactRef,
-  AdditionalNotesRet,
-  BillingRateRef,
-  ClassRef,
-  DataExtRet,
-  NameFilter,
-  NameRangeFilter,
-} from "@conductor/client/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 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 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;
-}
-
-type PayPeriod =
-  | "Biweekly"
-  | "Daily"
-  | "Monthly"
-  | "Quarterly"
-  | "Semimonthly"
-  | "Weekly"
-  | "Yearly";
-
-interface Earnings {
-  PayrollItemWageRef?: PayrollItemWageRef;
-  Rate?: string;
-  RatePercent?: string;
-}
-
-interface PayrollItemWageRef {
-  ListID?: string;
-  FullName?: string;
-}
-
-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;
-}
-
-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/Vendor.ts

@@ -1,192 +0,0 @@
-import type {
-  ActiveStatus,
-  AdditionalContactRef,
-  AdditionalNotesRet,
-  BillingRateRef,
-  ClassFilter,
-  ClassRef,
-  ContactsRet,
-  CurrencyFilter,
-  CurrencyRef,
-  DataExtRet,
-  NameFilter,
-  NameRangeFilter,
-  SalesTaxCodeRef,
-  SalesTaxCountry,
-  ShipAddress,
-  TermsRef,
-  TotalBalanceFilter,
-} from "@conductor/client/qb/qbXMLTypes/shared";
-
-export interface VendorQueryRq {
-  ListID?: string;
-  FullName?: string;
-  MaxReturned?: number;
-  ActiveStatus?: ActiveStatus;
-  FromModifiedDate?: Date;
-  ToModifiedDate?: Date;
-  NameFilter?: NameFilter;
-  NameRangeFilter?: NameRangeFilter;
-  TotalBalanceFilter?: TotalBalanceFilter;
-  CurrencyFilter?: CurrencyFilter;
-  ClassFilter?: ClassFilter;
-  IncludeRetElement?: string;
-  OwnerID?: string;
-}
-
-export interface VendorQueryRs {
-  VendorRet?: VendorRet;
-}
-
-export interface VendorRet {
-  ListID: string;
-  TimeCreated: Date;
-  TimeModified: Date;
-  EditSequence: string;
-  Name: string;
-  /**
-   * If `IsActive` is `true`, this object is currently enabled for use by
-   * QuickBooks. The default value is `true`.
-   */
-  IsActive?: boolean;
-  /**
-   * Classes can be used to separate transactions into meaningful categories.
-   * (For example, transactions could be classified according to department,
-   * business location, or type of work.) In QuickBooks, class tracking is off
-   * by default. A `ClassRef` aggregate refers to one of these named classes.
-   * For example, in a `TimeTracking` message, `ClassRef` refers to the
-   * QuickBooks class into which the timed activity falls. If a `ClassRef`
-   * aggregate includes both `FullName` and `ListID`, `FullName` will be
-   * ignored. In an `InvoiceAdd` request, if you specify a `ClassRef` for the
-   * whole invoice, that same `ClassRef` is automatically used in the line
-   * items. If you want to clear that (that is, have NO `ClassRef` for the line
-   * item, you can clear it in the line item by simply not specifying it in the
-   * line item.
-   */
-  ClassRef?: ClassRef;
-  /**
-   * Is the current entity a tax agency.
-   */
-  IsTaxAgency?: boolean;
-  /**
-   * The name of the QuickBooks user’s business, as specified in QuickBooks.
-   * `CompanyName` 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.)
-   */
-  CompanyName?: string;
-  /**
-   * 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;
-  /**
-   * If an address request fails, some combination of address fields might be
-   * too long.
-   */
-  VendorAddress?: VendorAddress;
-  VendorAddressBlock?: VendorAddressBlock;
-  ShipAddress?: ShipAddress;
-  Phone?: string;
-  AltPhone?: string;
-  Fax?: string;
-  Email?: string;
-  Cc?: string;
-  Contact?: string;
-  AltContact?: string;
-  AdditionalContactRef?: AdditionalContactRef;
-  ContactsRet?: ContactsRet;
-  NameOnCheck?: string;
-  AccountNumber?: string;
-  Notes?: string;
-  AdditionalNotesRet?: AdditionalNotesRet;
-  VendorTypeRef?: VendorTypeRef;
-  TermsRef?: TermsRef;
-  CreditLimit?: string;
-  VendorTaxIdent?: string;
-  IsVendorEligibleFor1099?: boolean;
-  Balance?: string;
-  BillingRateRef?: BillingRateRef;
-  ExternalGUID?: string;
-  SalesTaxCodeRef?: SalesTaxCodeRef;
-  SalesTaxCountry?: SalesTaxCountry;
-  IsSalesTaxAgency?: boolean;
-  SalesTaxReturnRef?: SalesTaxReturnRef;
-  TaxRegistrationNumber?: string;
-  ResaleNumber?: ReportingPeriod;
-  IsTaxTrackedOnPurchases?: boolean;
-  TaxOnPurchasesAccountRef?: TaxOnPurchasesAccountRef;
-  IsTaxTrackedOnSales?: boolean;
-  TaxOnSalesAccountRef?: TaxOnSalesAccountRef;
-  IsTaxOnTax?: boolean;
-  PrefillAccountRef?: PrefillAccountRef;
-  CurrencyRef?: CurrencyRef;
-  DataExtRet?: DataExtRet;
-}
-
-interface VendorAddress {
-  Addr1?: string;
-  Addr2?: string;
-  Addr3?: string;
-  Addr4?: string;
-  Addr5?: string;
-  City?: string;
-  State?: string;
-  PostalCode?: string;
-  Country?: string;
-  Note?: string;
-}
-
-interface VendorAddressBlock {
-  Addr1?: string;
-  Addr2?: string;
-  Addr3?: string;
-  Addr4?: string;
-  Addr5?: string;
-}
-
-interface VendorTypeRef {
-  ListID?: string;
-  FullName?: string;
-}
-
-interface SalesTaxReturnRef {
-  ListID?: string;
-  FullNam?: string;
-}
-
-// Default is Quarterly
-type ReportingPeriod = "Monthly" | "Quarterly";
-
-interface TaxOnPurchasesAccountRef {
-  ListID?: string;
-  FullName?: string;
-}
-
-interface TaxOnSalesAccountRef {
-  ListID?: string;
-}
-
-interface PrefillAccountRef {
-  ListID?: string;
-  FullName?: string;
-}