Skip to content

Commit

Permalink
chore: remove redundant Subject interface
Browse files Browse the repository at this point in the history
  • Loading branch information
maelgangloff committed Mar 4, 2024
1 parent d1afd8f commit 96d80c5
Show file tree
Hide file tree
Showing 7 changed files with 41 additions and 47 deletions.
72 changes: 36 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,42 +60,42 @@ Un wiki est disponible, celui-ci rassemble davantage d'informations sur le fonct
## Skolengo
**Kind**: global class

- [scolengo-api](#scolengo-api)
- [Liste des ENT utilisant Skolengo :](#liste-des-ent-utilisant-skolengo-)
- [Skolengo](#skolengo)
- [new Skolengo(oidClient, school, tokenSet, config)](#new-skolengooidclient-school-tokenset-config)
- [skolengo.getUserInfo(userId, params, includes)](#skolengogetuserinfouserid-params-includes)
- [skolengo.downloadAttachment(attachment)](#skolengodownloadattachmentattachment)
- [skolengo.getSchoolInfos(params, includes)](#skolengogetschoolinfosparams-includes)
- [skolengo.getSchoolInfo(schoolInfoId, params, includes)](#skolengogetschoolinfoschoolinfoid-params-includes)
- [skolengo.getEvaluationSettings(studentId, limit, offset, params, includes)](#skolengogetevaluationsettingsstudentid-limit-offset-params-includes)
- [skolengo.getEvaluation(studentId, periodId, limit, offset, params, includes)](#skolengogetevaluationstudentid-periodid-limit-offset-params-includes)
- [skolengo.getEvaluationDetail(studentId, evaluationId, params, includes)](#skolengogetevaluationdetailstudentid-evaluationid-params-includes)
- [skolengo.getPeriodicReportsFiles(studentId, limit, offset, params, includes)](#skolengogetperiodicreportsfilesstudentid-limit-offset-params-includes)
- [skolengo.getAgenda(studentId, startDate, endDate, limit, offset, params, includes)](#skolengogetagendastudentid-startdate-enddate-limit-offset-params-includes)
- [skolengo.getLesson(studentId, lessonId, params, includes)](#skolengogetlessonstudentid-lessonid-params-includes)
- [skolengo.getHomeworkAssignments(studentId, startDate, endDate, limit, offset, params, includes)](#skolengogethomeworkassignmentsstudentid-startdate-enddate-limit-offset-params-includes)
- [skolengo.getHomeworkAssignment(studentId, homeworkId, params, includes)](#skolengogethomeworkassignmentstudentid-homeworkid-params-includes)
- [skolengo.patchHomeworkAssignment(studentId, homeworkId, attributes, params, includes)](#skolengopatchhomeworkassignmentstudentid-homeworkid-attributes-params-includes)
- [skolengo.getUsersMailSettings(userId, params, includes)](#skolengogetusersmailsettingsuserid-params-includes)
- [skolengo.getCommunicationsFolder(folderId, limit, offset, params, includes)](#skolengogetcommunicationsfolderfolderid-limit-offset-params-includes)
- [skolengo.getCommunication(communicationId, params)](#skolengogetcommunicationcommunicationid-params)
- [skolengo.getCommunicationParticipations(communicationId, params, includes)](#skolengogetcommunicationparticipationscommunicationid-params-includes)
- [skolengo.getCommunicationParticipants(communicationId, fromGroup, params, includes)](#skolengogetcommunicationparticipantscommunicationid-fromgroup-params-includes)
- [skolengo.patchCommunicationFolders(communicationId, folders, userId, params)](#skolengopatchcommunicationfolderscommunicationid-folders-userid-params)
- [skolengo.postCommunication(newCommunication, params)](#skolengopostcommunicationnewcommunication-params)
- [skolengo.postParticipation(participation, params)](#skolengopostparticipationparticipation-params)
- [skolengo.getAbsenceFiles(studentId, limit, offset, params, includes)](#skolengogetabsencefilesstudentid-limit-offset-params-includes)
- [skolengo.getAbsenceFile(folderId, params, includes)](#skolengogetabsencefilefolderid-params-includes)
- [skolengo.postAbsenceFileState(folderId, reasonId, comment, params)](#skolengopostabsencefilestatefolderid-reasonid-comment-params)
- [skolengo.getAbsenceReasons(limit, offset, params)](#skolengogetabsencereasonslimit-offset-params)
- [skolengo.refreshToken(triggerListener)](#skolengorefreshtokentriggerlistener)
- [skolengo.getTokenClaims()](#skolengogettokenclaims)
- [Skolengo.revokeToken(oidClient, token)](#skolengorevoketokenoidclient-token)
- [Skolengo.getAppCurrentConfig(httpConfig)](#skolengogetappcurrentconfighttpconfig)
- [Skolengo.searchSchool(filter, limit, offset, httpConfig)](#skolengosearchschoolfilter-limit-offset-httpconfig)
- [Skolengo.getOIDClient(school, redirectUri)](#skolengogetoidclientschool-redirecturi)
- [Skolengo.fromConfigObject(config, skolengoConfig)](#skolengofromconfigobjectconfig-skolengoconfig)
* [Skolengo](#Skolengo)
* [new Skolengo(oidClient, school, tokenSet, config)](#new_Skolengo_new)
* _instance_
* [.getUserInfo(userId, params, includes)](#Skolengo+getUserInfo)
* [.downloadAttachment(attachment)](#Skolengo+downloadAttachment)
* [.getSchoolInfos(params, includes)](#Skolengo+getSchoolInfos)
* [.getSchoolInfo(schoolInfoId, params, includes)](#Skolengo+getSchoolInfo)
* [.getEvaluationSettings(studentId, limit, offset, params, includes)](#Skolengo+getEvaluationSettings)
* [.getEvaluation(studentId, periodId, limit, offset, params, includes)](#Skolengo+getEvaluation)
* [.getEvaluationDetail(studentId, evaluationId, params, includes)](#Skolengo+getEvaluationDetail)
* [.getPeriodicReportsFiles(studentId, limit, offset, params, includes)](#Skolengo+getPeriodicReportsFiles)
* [.getAgenda(studentId, startDate, endDate, limit, offset, params, includes)](#Skolengo+getAgenda)
* [.getLesson(studentId, lessonId, params, includes)](#Skolengo+getLesson)
* [.getHomeworkAssignments(studentId, startDate, endDate, limit, offset, params, includes)](#Skolengo+getHomeworkAssignments)
* [.getHomeworkAssignment(studentId, homeworkId, params, includes)](#Skolengo+getHomeworkAssignment)
* [.patchHomeworkAssignment(studentId, homeworkId, attributes, params, includes)](#Skolengo+patchHomeworkAssignment)
* [.getUsersMailSettings(userId, params, includes)](#Skolengo+getUsersMailSettings)
* [.getCommunicationsFolder(folderId, limit, offset, params, includes)](#Skolengo+getCommunicationsFolder)
* [.getCommunication(communicationId, params)](#Skolengo+getCommunication)
* [.getCommunicationParticipations(communicationId, params, includes)](#Skolengo+getCommunicationParticipations)
* [.getCommunicationParticipants(communicationId, fromGroup, params, includes)](#Skolengo+getCommunicationParticipants)
* [.patchCommunicationFolders(communicationId, folders, userId, params)](#Skolengo+patchCommunicationFolders)
* [.postCommunication(newCommunication, params)](#Skolengo+postCommunication)
* [.postParticipation(participation, params)](#Skolengo+postParticipation)
* [.getAbsenceFiles(studentId, limit, offset, params, includes)](#Skolengo+getAbsenceFiles)
* [.getAbsenceFile(folderId, params, includes)](#Skolengo+getAbsenceFile)
* [.postAbsenceFileState(folderId, reasonId, comment, params)](#Skolengo+postAbsenceFileState)
* [.getAbsenceReasons(limit, offset, params)](#Skolengo+getAbsenceReasons)
* [.refreshToken(triggerListener)](#Skolengo+refreshToken)
* [.getTokenClaims()](#Skolengo+getTokenClaims)
* _static_
* [.revokeToken(oidClient, token)](#Skolengo.revokeToken)
* [.getAppCurrentConfig(httpConfig)](#Skolengo.getAppCurrentConfig)
* [.searchSchool(filter, limit, offset, httpConfig)](#Skolengo.searchSchool)
* [.getOIDClient(school, redirectUri)](#Skolengo.getOIDClient)
* [.fromConfigObject(config, skolengoConfig)](#Skolengo.fromConfigObject)

<a name="new_Skolengo_new"></a>

Expand Down
3 changes: 1 addition & 2 deletions src/models/Calendar/HomeworkAssignment.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import type { Subject } from './Lesson'
import type { Attachment } from '../School'
import type { User } from '../Common'
import type { User, Subject } from '../Common'

export interface HomeworkAssignment {
id: string
Expand Down
8 changes: 1 addition & 7 deletions src/models/Calendar/Lesson.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
import type { User } from '../Common'
import type { User, Subject } from '../Common'
import type { HomeworkAssignment } from './HomeworkAssignment'
import type { Attachment } from '../School'

export interface Subject {
id: string
label: string
color: string
}

export interface Lesson {
id: string
startDateTime: string
Expand Down
File renamed without changes.
1 change: 1 addition & 0 deletions src/models/Common/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ export interface BaseObject<Type = string> {

export type { AppCurrentConfig } from './CurrentConfig'
export type { User } from './User'
export type { Subject } from './Subject'
2 changes: 1 addition & 1 deletion src/models/Results/Evaluation.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import type { User } from '../Common'
import type { EvaluationDetail } from './EvaluationDetail'
import type { Subject } from './Subject'
import type { Subject } from '../Common/Subject'

export interface Evaluation {
id: string
Expand Down
2 changes: 1 addition & 1 deletion src/models/Results/EvaluationService.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { Subject } from './Subject'
import type { Subject } from '../Common/Subject'
import type { User } from '../Common'

export interface EvaluationService {
Expand Down

0 comments on commit 96d80c5

Please sign in to comment.