From 6c38f3c3ea616f1057bb02ed4f75726ba7a12404 Mon Sep 17 00:00:00 2001
From: James Cook <james@jaminit.co.uk>
Date: Sun, 6 Feb 2022 12:09:37 +0000
Subject: [PATCH] chore: document arguments

---
 src/types.ts | 29 ++++++++++++++++++++++++++++-
 1 file changed, 28 insertions(+), 1 deletion(-)

diff --git a/src/types.ts b/src/types.ts
index 78e4408..bdf40bb 100644
--- a/src/types.ts
+++ b/src/types.ts
@@ -38,7 +38,13 @@ export interface Student {
   detention_alias_plural_uc: string;
 }
 export interface GetBehaviourOptions {
+  /**
+   * From date, in format YYYY-MM-DD
+   */
   from?: string;
+  /**
+   * To date, in format YYYY-MM-DD
+   */
   to?: string;
 }
 export interface BehaviourTimelinePoint {
@@ -58,8 +64,17 @@ export interface BehaviourResponse {
   other_negative_count: Array<Record<string, number>>;
 }
 export interface GetActivityOptions {
+  /**
+   * From date, in format YYYY-MM-DD
+   */
   from?: string;
+  /**
+   * To date, in format YYYY-MM-DD
+   */
   to?: string;
+  /**
+   *  ID of the last activityPoint (used in pagination)
+   */
   last_id?: string;
 }
 export interface ActivityPoint {
@@ -89,8 +104,17 @@ export interface ActivityPoint {
 export type ActivityResponse = Array<ActivityPoint>;
 export type DisplayDate = "due_date" | "issue_date";
 export interface GetHomeworkOptions {
+  /**
+   * Way to sort homeworks
+   */
   displayDate?: DisplayDate;
+  /**
+   * From date, in format YYYY-MM-DD
+   */
   fromDate?: string;
+  /**
+   * To date, in format YYYY-MM-DD
+   */
   toDate?: string;
 }
 export interface ValidatedHomeworkAttachment {
@@ -108,7 +132,7 @@ export interface Homework {
   title: string;
   meta_title: string;
   description: string;
-  description_raw: string,
+  description_raw: string;
   issue_date: string;
   due_date: string;
   completion_time_unit: string;
@@ -131,6 +155,9 @@ export interface Homework {
 }
 export type HomeworksResponse = Array<Homework>;
 export interface GetLessonsOptions {
+  /**
+   * Date to get lessons for, in format YYYY-MM-DD
+   */
   date: string;
 }
 export interface Lesson {