Skip to main content

Enums

Complete reference for all enum types in the GraphQL API.

HandbookFormat​

Output format options for handbook generation.

enum HandbookFormat {
  HTML
  DOCX
  TXT
}

Values​

ValueDescription
HTMLReturns HTML content as a string (default)
DOCXReturns base64-encoded DOCX file content
TXTReturns plain text version (strips HTML tags)

HandbookType​

Type of handbook.

enum HandbookType {
  BASIC
  COMPREHENSIVE
}

Values​

ValueDescription
BASICBasic handbook with essential policies
COMPREHENSIVEComprehensive handbook with all available policies

SubscriptionType​

Classification for handbook purchases.

enum SubscriptionType {
  SUBSCRIPTION
  ONE_TIME
}

Values​

ValueDescription
SUBSCRIPTIONThe handbook purchase is a subscription
ONE_TIMEThe handbook purchase is a one-time purchase

SubscriptionStatus​

Status of a handbook subscription.

enum SubscriptionStatus {
  SUBSCRIPTION
  ONE_TIME
  UNSUBSCRIBED
}

Values​

ValueDescription
SUBSCRIPTIONActive subscription
ONE_TIMEOne-time purchase
UNSUBSCRIBEDSubscription has been ended

CountryList​

Country codes supported by the API.

enum CountryList {
  US
}

Values​

ValueDescription
USUnited States

Note: Currently only US is supported. This enum is reserved for future international expansion.

ScopeList​

US state abbreviations used for policy feed scope filtering. This enum is identical to StateList and contains all US states and territories.

enum ScopeList {
  AL  # Alabama
  AK  # Alaska
  AS  # American Samoa
  AZ  # Arizona
  AR  # Arkansas
  CA  # California
  CO  # Colorado
  CT  # Connecticut
  DE  # Delaware
  DC  # District of Columbia
  FL  # Florida
  FM  # Federated States of Micronesia
  GA  # Georgia
  GU  # Guam
  HI  # Hawaii
  ID  # Idaho
  IL  # Illinois
  IN  # Indiana
  IA  # Iowa
  KS  # Kansas
  KY  # Kentucky
  LA  # Louisiana
  ME  # Maine
  MH  # Marshall Islands
  MD  # Maryland
  MA  # Massachusetts
  MI  # Michigan
  MN  # Minnesota
  MS  # Mississippi
  MO  # Missouri
  MT  # Montana
  NE  # Nebraska
  NV  # Nevada
  NH  # New Hampshire
  NJ  # New Jersey
  NM  # New Mexico
  NY  # New York
  NC  # North Carolina
  ND  # North Dakota
  MP  # Northern Mariana Islands
  OH  # Ohio
  OK  # Oklahoma
  OR  # Oregon
  PW  # Palau
  PA  # Pennsylvania
  PR  # Puerto Rico
  RI  # Rhode Island
  SC  # South Carolina
  SD  # South Dakota
  TN  # Tennessee
  TX  # Texas
  UM  # U.S. Minor Outlying Islands
  UT  # Utah
  VT  # Vermont
  VA  # Virginia
  VI  # U.S. Virgin Islands
  WA  # Washington
  WV  # West Virginia
  WI  # Wisconsin
  WY  # Wyoming
}

Usage​

The ScopeList enum is used internally for policy feed filtering. For handbook generation, use StateList instead.

StateList​

US state abbreviations. Use these values for myState and multiStateSelectedStates.

enum StateList {
  AL  # Alabama
  AK  # Alaska
  AS  # American Samoa
  AZ  # Arizona
  AR  # Arkansas
  CA  # California
  CO  # Colorado
  CT  # Connecticut
  DE  # Delaware
  DC  # District of Columbia
  FL  # Florida
  FM  # Federated States of Micronesia
  GA  # Georgia
  GU  # Guam
  HI  # Hawaii
  ID  # Idaho
  IL  # Illinois
  IN  # Indiana
  IA  # Iowa
  KS  # Kansas
  KY  # Kentucky
  LA  # Louisiana
  ME  # Maine
  MH  # Marshall Islands
  MD  # Maryland
  MA  # Massachusetts
  MI  # Michigan
  MN  # Minnesota
  MS  # Mississippi
  MO  # Missouri
  MT  # Montana
  NE  # Nebraska
  NV  # Nevada
  NH  # New Hampshire
  NJ  # New Jersey
  NM  # New Mexico
  NY  # New York
  NC  # North Carolina
  ND  # North Dakota
  MP  # Northern Mariana Islands
  OH  # Ohio
  OK  # Oklahoma
  OR  # Oregon
  PW  # Palau
  PA  # Pennsylvania
  PR  # Puerto Rico
  RI  # Rhode Island
  SC  # South Carolina
  SD  # South Dakota
  TN  # Tennessee
  TX  # Texas
  UM  # U.S. Minor Outlying Islands
  UT  # Utah
  VT  # Vermont
  VA  # Virginia
  VI  # U.S. Virgin Islands
  WA  # Washington
  WV  # West Virginia
  WI  # Wisconsin
  WY  # Wyoming
}

Usage Example​

mutation {
  generateHandbook(
    input: {
      companyName: "Acme Corp"
      myState: CA
      numberOfEmployees: 50
      multiState: true
      multiStateSelectedStates: [CA, NY, TX, FL]
    }
  ) {
    content
  }
}

Industry​

Industry classification for company-specific policy guidance.

enum Industry {
  EDUCATION
  CONSTRUCTION
  HOSPITALITY
  MEDICAL
  MANUFACTURING
  NONPROFIT
  PROFESSIONAL
  RETAIL
  TRANSPORTATION
  OTHER
}

Values​

ValueDescription
EDUCATIONEducation and Childcare
CONSTRUCTIONConstruction and Home Services
HOSPITALITYHospitality and Food Service
MEDICALHealthcare and Medical
MANUFACTURINGManufacturing
NONPROFITNonprofit
PROFESSIONALProfessional Services
RETAILShopping and Retail
TRANSPORTATIONTransportation and Logistics
OTHEROther Industry

PayPeriodFrequency​

Frequency of payroll payments.

enum PayPeriodFrequency {
  WEEKLY
  EVERY_TWO_WEEKS
  TWICE_A_MONTH
  MONTHLY
}

Values​

ValueDescription
WEEKLYWeekly payroll
EVERY_TWO_WEEKSEvery two weeks (bi-weekly)
TWICE_A_MONTHTwice a month (semi-monthly)
MONTHLYMonthly payroll

PerformanceReviewPeriod​

Frequency of formal performance reviews.

enum PerformanceReviewPeriod {
  EVERY_YEAR
  EVERY_6_MONTHS
  NEVER
}

Values​

ValueDescription
EVERY_YEARAnnual performance reviews
EVERY_6_MONTHSSemi-annual performance reviews
NEVERNo formal performance review process

VacationBenefitType​

Type of paid time off (PTO) or vacation benefit program.

enum VacationBenefitType {
  ACCRUED_PTO
  ACCRUED_VACATION_AND_SICK_LEAVE
  ACCRUED_VACATION_ONLY
  ACCRUED_SICK_TIME_ONLY
  FLEXIBLE_PTO
}

Values​

ValueDescription
ACCRUED_PTOAccrued PTO (for vacation and sick time combined)
ACCRUED_VACATION_AND_SICK_LEAVESeparate accrued vacation and accrued sick leave
ACCRUED_VACATION_ONLYAccrued vacation only
ACCRUED_SICK_TIME_ONLYAccrued sick time only
FLEXIBLE_PTOFlexible vacation with accrued sick time

Usage Notes​

  • When using ACCRUED_PTO, ACCRUED_VACATION_ONLY, or ACCRUED_VACATION_AND_SICK_LEAVE, you must also provide vacationHoursEarned.
  • When using ACCRUED_VACATION_AND_SICK_LEAVE, ACCRUED_SICK_TIME_ONLY, or FLEXIBLE_PTO, you must also provide sickHoursEarned and maximumSickLeave.

AppendixConditionQuestion​

Enum for all possible appendix condition questions. These questions determine which city-specific content should be included in the handbook based on where the company has employees.

enum AppendixConditionQuestion {
  # California (CA)
  BERKELEY_CA
  EMERYVILLE_CA
  LOS_ANGELES_CA
  OAKLAND_CA
  SAN_DIEGO_CA
  SAN_FRANCISCO_CA
  SANTA_MONICA_CA
  WEST_HOLLYWOOD_CA
  SANTA_CRUZ_CA
  # Florida (FL)
  MIAMI_DADE_COUNTY_FL
  BROWARD_COUNTY_FL
  MIAMI_BEACH_FL
  # Illinois (IL)
  COOK_COUNTY_CHICAGO_IL
  URBANA_IL
  # Kansas (KS)
  KANSAS_CITY_KS
  # Maryland (MD)
  BALTIMORE_MD
  MONTGOMERY_COUNTY_MD
  # Minnesota (MN)
  BLOOMINGTON_MN
  MINNEAPOLIS_MN
  ST_PAUL_MN
  # New Mexico (NM)
  BERNALILLO_COUNTY_NM
  # New York (NY)
  NEW_YORK_CITY_NY
  BINGHAMTON_NY
  WESTCHESTER_COUNTY_NY
  # Pennsylvania (PA)
  PHILADELPHIA_PA
  PITTSBURGH_PA
  ALLEGHENY_COUNTY_PA
  # Washington (WA)
  TACOMA_WA
  SEATTLE_WA
  # Wisconsin (WI)
  MADISON_WI
}

Values by State​

California (CA)​

ValueQuestion
BERKELEY_CADo you have employees in Berkeley, CA?
EMERYVILLE_CADo you have employees in Emeryville, CA?
LOS_ANGELES_CADo you have employees in Los Angeles, CA?
OAKLAND_CADo you have employees in Oakland, CA?
SAN_DIEGO_CADo you have employees in San Diego, CA?
SAN_FRANCISCO_CADo you have employees in San Francisco, CA?
SANTA_MONICA_CADo you have employees in Santa Monica, CA?
WEST_HOLLYWOOD_CADo you have employees in West Hollywood, CA?
SANTA_CRUZ_CADo you have employees in Santa Cruz, CA?

Florida (FL)​

ValueQuestion
MIAMI_DADE_COUNTY_FLDo you have employees in Miami-Dade County, FL?
BROWARD_COUNTY_FLDo you have employees in Broward County, FL?
MIAMI_BEACH_FLDo you have employees in Miami Beach, FL?

Illinois (IL)​

ValueQuestion
COOK_COUNTY_CHICAGO_ILDo you have employees in Cook County / Chicago, IL?
URBANA_ILDo you have employees in Urbana, IL?

Kansas (KS)​

ValueQuestion
KANSAS_CITY_KSDo you have employees in Kansas City, KS?

Maryland (MD)​

ValueQuestion
BALTIMORE_MDDo you have employees in Baltimore, MD?
MONTGOMERY_COUNTY_MDDo you have employees in Montgomery County, MD?

Minnesota (MN)​

ValueQuestion
BLOOMINGTON_MNDo you have employees in Bloomington, MN?
MINNEAPOLIS_MNDo you have employees in Minneapolis, MN?
ST_PAUL_MNDo you have employees in St. Paul, MN?

New Mexico (NM)​

ValueQuestion
BERNALILLO_COUNTY_NMDo you have employees in Bernalillo County, NM?

New York (NY)​

ValueQuestion
NEW_YORK_CITY_NYDo you have employees in New York City, NY?
BINGHAMTON_NYDo you have employees in Binghamton, NY?
WESTCHESTER_COUNTY_NYDo you have employees in Westchester County, NY?

Pennsylvania (PA)​

ValueQuestion
PHILADELPHIA_PADo you have employees in Philadelphia, PA?
PITTSBURGH_PADo you have employees in Pittsburgh, PA?
ALLEGHENY_COUNTY_PADo you have employees in Allegheny County, PA?

Washington (WA)​

ValueQuestion
TACOMA_WADo you have employees in Tacomoa, WA?
SEATTLE_WADo you have employees in Seattle, WA?

Wisconsin (WI)​

ValueQuestion
MADISON_WIDo you have employees in Madison, WI?

Usage​

Optional Field: Use these enum values in the optional appendixConditions field of HandbookRequest to specify which city-specific content should be included in the handbook. You can omit this field entirely if you don't need city-specific content. Only include entries where your company has employees (set answer: true).

Example:

mutation {
  generateHandbook(
    input: {
      companyName: "Acme Corp"
      myState: CA
      numberOfEmployees: 50
      multiState: true
      multiStateSelectedStates: [CA, NY]
      appendixConditions: [
        { question: BERKELEY_CA, answer: true }
        { question: SAN_FRANCISCO_CA, answer: true }
        { question: NEW_YORK_CITY_NY, answer: true }
        { question: LOS_ANGELES_CA, answer: false }
      ]
    }
  ) {
    content
  }
}

Notes:

  • The appendixConditions field is optional - you can omit it entirely if you don't need city-specific content
  • Only include entries in appendixConditions where answer is true
  • The system will automatically include the appropriate city-specific content based on your selections