Class EsAPI

Class which represents the enriching students api.

Hierarchy

EsAPI

Index

Constructors

constructor

new EsAPI(): EsAPI
Returns EsAPI
- Defined in work/es-api/es-api/src/client.ts:21

Properties

`Private` baseUrl

baseUrl: string

`Private` headers

headers: HeadersInit

ready

ready: boolean

Determines if the program is ready to precess requests

status

status: EventEmitter

token

token: string

userAgent

userAgent: string

Methods

changePassword

changePassword(password: string): Promise<boolean>
Parameters
- password: string
Returns Promise<boolean>
- Defined in work/es-api/es-api/src/client.ts:287

`Private` checkStatus

checkStatus(res: Response, txt: string): void
Parameters
- res: Response
- txt: string
Returns void
- Defined in work/es-api/es-api/src/client.ts:74

forStudentScheduling

forStudentScheduling(periodId: number, startDate: string): Promise<forStudentSchedulingData>
get all courses that the student can schedule

Returns
forStudentSchedulingData
Parameters
- periodId: number
- startDate: string
Returns Promise<forStudentSchedulingData>
- Defined in work/es-api/es-api/src/client.ts:251

generalInformation

generalInformation(): Promise<generalInformation>
General information endpoint

Returns
generalInformation

Returns Promise<generalInformation>
- Defined in work/es-api/es-api/src/client.ts:140

login

login(options: EsAPIOptions): Promise<unknown>
Parameters
- options: EsAPIOptions
Returns Promise<unknown>
- Defined in work/es-api/es-api/src/client.ts:28

periodInformation

periodInformation(): Promise<periodInformationData>
Get information about each period you can schedule

Returns
periodInformationData

Returns Promise<periodInformationData>
- Defined in work/es-api/es-api/src/client.ts:269

scheduleCourse

scheduleCourse(courseId: number, date: string, comment: string): Promise<scheduledData>
Parameters
- courseId: number
- date: string
- comment: string
Returns Promise<scheduledData>
- Defined in work/es-api/es-api/src/client.ts:152

schoolMessage

schoolMessage(): Promise<string>
Function that gets the pinned message

Returns
string

Returns Promise<string>
- Defined in work/es-api/es-api/src/client.ts:102

selfSchedulingInfo

selfSchedulingInfo(): Promise<selfSchedulingInfo>
Returns Promise<selfSchedulingInfo>
- Defined in work/es-api/es-api/src/client.ts:278

`Private` testAuthorization

testAuthorization(): Promise<unknown>
Returns Promise<unknown>
- Defined in work/es-api/es-api/src/client.ts:80

`Private` validateCredentials

validateCredentials(email: string, pass: string): Promise<validateCredentials>
Checks if certain credentials are valid.

Returns
validateCredentials
Parameters
- email: string
  
  Email for enriching students
- pass: string
  
  Password for enriching students
Returns Promise<validateCredentials>
- Defined in work/es-api/es-api/src/client.ts:184

`Private` viaTokens

viaTokens(token1: string, token2: string): Promise<string>
Not exactly sure what this does, but it's required to login.

Returns
Promise
Parameters
- token1: string
  
  string
- token2: string
  
  string
Returns Promise<string>
- Defined in work/es-api/es-api/src/client.ts:228

viewSchedule

viewSchedule(date: string): Promise<course>
Function that fetches a class scheduled on one day
Parameters
- date: string
Returns Promise<course>
- Defined in work/es-api/es-api/src/client.ts:121

Generated using TypeDoc