academe-kit 0.2.2 → 0.2.3
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
|
@@ -2979,6 +2979,105 @@ interface paths {
|
|
|
2979
2979
|
};
|
|
2980
2980
|
trace?: never;
|
|
2981
2981
|
};
|
|
2982
|
+
"/institutions/{institutionId}/groups/users": {
|
|
2983
|
+
parameters: {
|
|
2984
|
+
query?: never;
|
|
2985
|
+
header?: never;
|
|
2986
|
+
path?: never;
|
|
2987
|
+
cookie?: never;
|
|
2988
|
+
};
|
|
2989
|
+
/**
|
|
2990
|
+
* Get all users of all groups in an institution
|
|
2991
|
+
* @description Retrieve all users from all groups associated with a specific institution.
|
|
2992
|
+
* Returns a map where keys are group IDs and values are arrays of users in each group.
|
|
2993
|
+
* This is more efficient than calling /groups/{id}/users multiple times.
|
|
2994
|
+
*/
|
|
2995
|
+
get: {
|
|
2996
|
+
parameters: {
|
|
2997
|
+
query?: never;
|
|
2998
|
+
header?: never;
|
|
2999
|
+
path: {
|
|
3000
|
+
/** @description Institution ID */
|
|
3001
|
+
institutionId: string;
|
|
3002
|
+
};
|
|
3003
|
+
cookie?: never;
|
|
3004
|
+
};
|
|
3005
|
+
requestBody?: never;
|
|
3006
|
+
responses: {
|
|
3007
|
+
/** @description Users grouped by group ID */
|
|
3008
|
+
200: {
|
|
3009
|
+
headers: {
|
|
3010
|
+
[name: string]: unknown;
|
|
3011
|
+
};
|
|
3012
|
+
content: {
|
|
3013
|
+
/**
|
|
3014
|
+
* @example {
|
|
3015
|
+
* "status": "success",
|
|
3016
|
+
* "data": {
|
|
3017
|
+
* "group-uuid-1": [
|
|
3018
|
+
* {
|
|
3019
|
+
* "id": "user-uuid-1",
|
|
3020
|
+
* "firstName": "John",
|
|
3021
|
+
* "lastName": "Doe",
|
|
3022
|
+
* "email": "john@example.com",
|
|
3023
|
+
* "assignedAt": "2024-01-15T10:30:00Z"
|
|
3024
|
+
* },
|
|
3025
|
+
* {
|
|
3026
|
+
* "id": "user-uuid-2",
|
|
3027
|
+
* "firstName": "Jane",
|
|
3028
|
+
* "lastName": "Smith",
|
|
3029
|
+
* "email": "jane@example.com",
|
|
3030
|
+
* "assignedAt": "2024-01-16T14:20:00Z"
|
|
3031
|
+
* }
|
|
3032
|
+
* ],
|
|
3033
|
+
* "group-uuid-2": [
|
|
3034
|
+
* {
|
|
3035
|
+
* "id": "user-uuid-3",
|
|
3036
|
+
* "firstName": "Bob",
|
|
3037
|
+
* "lastName": "Wilson",
|
|
3038
|
+
* "email": "bob@example.com",
|
|
3039
|
+
* "assignedAt": "2024-01-17T09:15:00Z"
|
|
3040
|
+
* }
|
|
3041
|
+
* ]
|
|
3042
|
+
* }
|
|
3043
|
+
* }
|
|
3044
|
+
*/
|
|
3045
|
+
"application/json": {
|
|
3046
|
+
/** @example success */
|
|
3047
|
+
status?: string;
|
|
3048
|
+
/** @description Map of group IDs to arrays of users */
|
|
3049
|
+
data?: {
|
|
3050
|
+
[key: string]: {
|
|
3051
|
+
/** Format: uuid */
|
|
3052
|
+
id?: string;
|
|
3053
|
+
firstName?: string;
|
|
3054
|
+
lastName?: string;
|
|
3055
|
+
email?: string;
|
|
3056
|
+
document?: string;
|
|
3057
|
+
phone?: string;
|
|
3058
|
+
isActive?: boolean;
|
|
3059
|
+
/** Format: date-time */
|
|
3060
|
+
assignedAt?: string;
|
|
3061
|
+
/** Format: uuid */
|
|
3062
|
+
assignedBy?: string;
|
|
3063
|
+
}[];
|
|
3064
|
+
};
|
|
3065
|
+
};
|
|
3066
|
+
};
|
|
3067
|
+
};
|
|
3068
|
+
401: components["responses"]["Unauthorized"];
|
|
3069
|
+
404: components["responses"]["NotFound"];
|
|
3070
|
+
500: components["responses"]["ServerError"];
|
|
3071
|
+
};
|
|
3072
|
+
};
|
|
3073
|
+
put?: never;
|
|
3074
|
+
post?: never;
|
|
3075
|
+
delete?: never;
|
|
3076
|
+
options?: never;
|
|
3077
|
+
head?: never;
|
|
3078
|
+
patch?: never;
|
|
3079
|
+
trace?: never;
|
|
3080
|
+
};
|
|
2982
3081
|
"/institutions/{institutionId}/registrations": {
|
|
2983
3082
|
parameters: {
|
|
2984
3083
|
query?: never;
|
|
@@ -4982,7 +5081,7 @@ interface paths {
|
|
|
4982
5081
|
};
|
|
4983
5082
|
/**
|
|
4984
5083
|
* List all shifts
|
|
4985
|
-
* @description Retrieve a list of all institution shifts (
|
|
5084
|
+
* @description Retrieve a list of all institution shifts (manhã, tarde, noite)
|
|
4986
5085
|
*/
|
|
4987
5086
|
get: {
|
|
4988
5087
|
parameters: {
|
|
@@ -6048,7 +6147,7 @@ interface components {
|
|
|
6048
6147
|
*/
|
|
6049
6148
|
value?: number;
|
|
6050
6149
|
} | null;
|
|
6051
|
-
/** @description Shift information (
|
|
6150
|
+
/** @description Shift information (manhã, tarde, noite) */
|
|
6052
6151
|
shift?: {
|
|
6053
6152
|
/** Format: uuid */
|
|
6054
6153
|
id?: string;
|
|
@@ -6364,7 +6463,7 @@ interface components {
|
|
|
6364
6463
|
createdAt?: string;
|
|
6365
6464
|
/** Format: date-time */
|
|
6366
6465
|
updatedAt?: string;
|
|
6367
|
-
/** @description Shift information (
|
|
6466
|
+
/** @description Shift information (manhã, tarde, noite) */
|
|
6368
6467
|
shift?: components["schemas"]["Shift"];
|
|
6369
6468
|
/** @description Serie/grade level information */
|
|
6370
6469
|
serie?: components["schemas"]["Serie"];
|
|
@@ -6879,17 +6978,17 @@ interface components {
|
|
|
6879
6978
|
};
|
|
6880
6979
|
CreateShiftDto: {
|
|
6881
6980
|
/**
|
|
6882
|
-
* @example
|
|
6981
|
+
* @example manhã
|
|
6883
6982
|
* @enum {string}
|
|
6884
6983
|
*/
|
|
6885
|
-
name: "
|
|
6984
|
+
name: "manhã" | "tarde" | "noite";
|
|
6886
6985
|
};
|
|
6887
6986
|
UpdateShiftDto: {
|
|
6888
6987
|
/**
|
|
6889
|
-
* @example
|
|
6988
|
+
* @example manhã
|
|
6890
6989
|
* @enum {string}
|
|
6891
6990
|
*/
|
|
6892
|
-
name?: "
|
|
6991
|
+
name?: "manhã" | "tarde" | "noite";
|
|
6893
6992
|
};
|
|
6894
6993
|
AssignGuardianToUserDto: {
|
|
6895
6994
|
/** Format: uuid */
|
|
@@ -9625,7 +9724,7 @@ declare function createShiftService(apiClient: AcademeApiClient): {
|
|
|
9625
9724
|
};
|
|
9626
9725
|
}, {
|
|
9627
9726
|
body: {
|
|
9628
|
-
name: "
|
|
9727
|
+
name: "manh\u00E3" | "tarde" | "noite";
|
|
9629
9728
|
};
|
|
9630
9729
|
}, `${string}/${string}`>>;
|
|
9631
9730
|
/**
|
|
@@ -9670,7 +9769,7 @@ declare function createShiftService(apiClient: AcademeApiClient): {
|
|
|
9670
9769
|
};
|
|
9671
9770
|
};
|
|
9672
9771
|
body: {
|
|
9673
|
-
name?: "
|
|
9772
|
+
name?: "manh\u00E3" | "tarde" | "noite";
|
|
9674
9773
|
};
|
|
9675
9774
|
}, `${string}/${string}`>>;
|
|
9676
9775
|
/**
|