academe-kit 0.2.6 → 0.2.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1695,6 +1695,12 @@ interface paths {
1695
1695
  * @default false
1696
1696
  */
1697
1697
  isDefault?: boolean;
1698
+ /**
1699
+ * @description Type of the group
1700
+ * @default other
1701
+ * @enum {string}
1702
+ */
1703
+ type?: "student" | "teacher" | "school-director" | "other";
1698
1704
  };
1699
1705
  };
1700
1706
  };
@@ -1837,6 +1843,11 @@ interface paths {
1837
1843
  name?: string;
1838
1844
  /** @description If true, group is automatically associated when creating institutions */
1839
1845
  isDefault?: boolean;
1846
+ /**
1847
+ * @description Type of the group
1848
+ * @enum {string}
1849
+ */
1850
+ type?: "student" | "teacher" | "school-director" | "other";
1840
1851
  };
1841
1852
  };
1842
1853
  };
@@ -3628,10 +3639,10 @@ interface paths {
3628
3639
  query?: {
3629
3640
  /** @description Filter by classroom (institution_classroom_id) */
3630
3641
  classroomId?: string;
3631
- /** @description Filter by student status (true = students only, false = non-students only) */
3632
- isStudent?: boolean;
3633
3642
  /** @description Filter by user active status */
3634
3643
  isActive?: boolean;
3644
+ /** @description Filter users by group type (e.g., student, teacher, school-director, other) */
3645
+ type?: "student" | "teacher" | "school-director" | "other";
3635
3646
  /** @description Filter users with certificates (true) or without (false) */
3636
3647
  hasCertificates?: boolean;
3637
3648
  /** @description Filter users with guardian (true) or without (false) */
@@ -5574,7 +5585,6 @@ interface paths {
5574
5585
  * - Classroom name
5575
5586
  * - Shift (manhã, tarde, noite)
5576
5587
  * - Serie (grade level)
5577
- * - Student status (isStudent)
5578
5588
  */
5579
5589
  get: {
5580
5590
  parameters: {
@@ -6000,6 +6010,12 @@ interface components {
6000
6010
  * @example false
6001
6011
  */
6002
6012
  isDefault?: boolean;
6013
+ /**
6014
+ * @description Type of the group
6015
+ * @example student
6016
+ * @enum {string}
6017
+ */
6018
+ type?: "student" | "teacher" | "school-director" | "other";
6003
6019
  /** Format: date-time */
6004
6020
  createdAt?: string;
6005
6021
  /** Format: date-time */
@@ -6013,12 +6029,23 @@ interface components {
6013
6029
  * @default false
6014
6030
  */
6015
6031
  isDefault: boolean;
6032
+ /**
6033
+ * @description Type of the group
6034
+ * @default other
6035
+ * @enum {string}
6036
+ */
6037
+ type: "student" | "teacher" | "school-director" | "other";
6016
6038
  };
6017
6039
  UpdateGroupDto: {
6018
6040
  /** @example students */
6019
6041
  name?: string;
6020
6042
  /** @description If true, group is automatically associated when creating institutions */
6021
6043
  isDefault?: boolean;
6044
+ /**
6045
+ * @description Type of the group
6046
+ * @enum {string}
6047
+ */
6048
+ type?: "student" | "teacher" | "school-director" | "other";
6022
6049
  };
6023
6050
  AssignUserToGroupDto: {
6024
6051
  /** Format: uuid */
@@ -6118,11 +6145,6 @@ interface components {
6118
6145
  institutionRegistration?: {
6119
6146
  /** Format: uuid */
6120
6147
  id?: string;
6121
- /**
6122
- * @description Indicates if the user is registered as a student
6123
- * @example true
6124
- */
6125
- isStudent?: boolean;
6126
6148
  /**
6127
6149
  * @description Indicates if the registration is active
6128
6150
  * @example true
@@ -6179,11 +6201,6 @@ interface components {
6179
6201
  * @description ID of the institution classroom assignment
6180
6202
  */
6181
6203
  institutionClassroomId?: string | null;
6182
- /**
6183
- * @description Indicates if the user is registered as a student
6184
- * @example true
6185
- */
6186
- isStudent?: boolean;
6187
6204
  /**
6188
6205
  * @description Indicates if the user is active in the institution
6189
6206
  * @example true
@@ -6624,11 +6641,6 @@ interface components {
6624
6641
  * @description Optional classroom ID to assign the user to
6625
6642
  */
6626
6643
  institutionClassroomId?: string | null;
6627
- /**
6628
- * @description Whether the user is a student
6629
- * @default true
6630
- */
6631
- isStudent: boolean;
6632
6644
  /**
6633
6645
  * @description Whether the registration is active
6634
6646
  * @default true
@@ -6641,8 +6653,6 @@ interface components {
6641
6653
  * @description Classroom ID to assign the user to (null to remove)
6642
6654
  */
6643
6655
  institutionClassroomId?: string | null;
6644
- /** @description Whether the user is a student */
6645
- isStudent?: boolean;
6646
6656
  /** @description Whether the registration is active */
6647
6657
  isActive?: boolean;
6648
6658
  };
@@ -8022,8 +8032,8 @@ declare function createInstitutionService(apiClient: AcademeApiClient): {
8022
8032
  parameters: {
8023
8033
  query?: {
8024
8034
  classroomId?: string;
8025
- isStudent?: boolean;
8026
8035
  isActive?: boolean;
8036
+ type?: "student" | "teacher" | "school-director" | "other";
8027
8037
  hasCertificates?: boolean;
8028
8038
  hasGuardian?: boolean;
8029
8039
  search?: string;
@@ -8212,7 +8222,6 @@ declare function createInstitutionService(apiClient: AcademeApiClient): {
8212
8222
  body: {
8213
8223
  userId: string;
8214
8224
  institutionClassroomId?: string | null;
8215
- isStudent: boolean;
8216
8225
  isActive: boolean;
8217
8226
  };
8218
8227
  }, `${string}/${string}`>>;
@@ -8257,7 +8266,6 @@ declare function createInstitutionService(apiClient: AcademeApiClient): {
8257
8266
  };
8258
8267
  body: {
8259
8268
  institutionClassroomId?: string | null;
8260
- isStudent?: boolean;
8261
8269
  isActive?: boolean;
8262
8270
  };
8263
8271
  }, `${string}/${string}`>>;