OurCampus-Types

To install, run:

npm install @ourcampuswes/types

Types

Department

  displayName: string  
  id: string  
  colors: string[]  

Section

  instructorName: string
  instructorUserName: string
  seatsAvail: number

Course

  crosslistings: string[]
  displayName: string
  link: string
  sections:  [key: string]: Section 

Dish

  subscribers: string[]
  isVegetarian: boolean
  isGlutenFree: boolean
  isVegan: boolean
  uid: number
  title: string
  lastSeen: string
  description: string

Hour

  isBreak: boolean
  monday?: HourData
  tuesday?: HourData
  wednesday?: HourData
  thursday?: HourData
  friday?: HourData
  satutday?: HourData
  sunday?: HourData
  weekday: HourData
  weekend: HourData

HourData

  allDay: number | undefined | null;
  breakfast: number | undefined | null;
  brunch: number | undefined | null;
  lunch: number | undefined | null;
  dinner: number | undefined | null;

Event

  imageURL: string
  invited: string[]
  endDateTime: string
  joined: string[]
  title: string
  location: string
  description: string
  startDateTime: string
  public: boolean
  category: number
  dateTimePosted: string
  author: string
  flagged: string[]
  dateTimeEdited: string

Menu

  displayName: string
  fixedMenu: FixedDish[]
  snippet: string
  shortDisplayName: string
  imageURL: string
  menu: Dish[]
  fallbackURL: string
  hours: Hours

Fixed Dish

 imageUrls: string[]
  snippet: string 
  title: string

Organization

  contact: string
  dateTimePosted: string
  author: string
  description: string
  link: string
  displayName: string
  label: string
  events: string[]
  subscribers: string[]
  media: string[]
  imageURL: string
  dateTimeEdited: string

Review

  quality: number
  grade: string
  course: string
  comment: string
  string: string
  recommended: boolean
  difficulty: number
  likes: string[]
  author: string
  tags: number[]

Professor

  displayName: string
  averageDifficulty: number
  imageURL: string
  departments: string[]
  averageQuality: number
  totalReviews: number
  reviews:  [key: string]: Review 

User

  token: string
  incognito: boolean
  email: string
  os: string
  group: string
  directory: string
  imageURL: string
  blocked: boolean
  displayName: string
  menuSubscriptions: string[]
  orgSubscriptions: {id:string, type:string}[]

TruncatedUser

  incognito: boolean
  email: string
  group: string
  imageURL: string
  displayName: string

Notifications

  data: NotificationData
  viewed: boolean
  sender: string
  string: string
  type: number

NotificationData

  body: string
  restaurantId: string
  title: string