academe-kit 0.2.2 → 0.2.4
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 +108 -9
- package/dist/index.esm.js +0 -1
- package/dist/index.esm.js.map +1 -1
- package/dist/index.js +0 -1
- package/dist/index.js.map +1 -1
- package/dist/types/services/ShiftService.d.ts +2 -2
- package/dist/types/types/academe-api.d.ts +106 -7
- package/package.json +1 -1
|
@@ -124,7 +124,7 @@ export declare function createShiftService(apiClient: AcademeApiClient): {
|
|
|
124
124
|
};
|
|
125
125
|
}, {
|
|
126
126
|
body: {
|
|
127
|
-
name: "
|
|
127
|
+
name: "manh\u00E3" | "tarde" | "noite";
|
|
128
128
|
};
|
|
129
129
|
}, `${string}/${string}`>>;
|
|
130
130
|
/**
|
|
@@ -169,7 +169,7 @@ export declare function createShiftService(apiClient: AcademeApiClient): {
|
|
|
169
169
|
};
|
|
170
170
|
};
|
|
171
171
|
body: {
|
|
172
|
-
name?: "
|
|
172
|
+
name?: "manh\u00E3" | "tarde" | "noite";
|
|
173
173
|
};
|
|
174
174
|
}, `${string}/${string}`>>;
|
|
175
175
|
/**
|
|
@@ -2942,6 +2942,105 @@ export interface paths {
|
|
|
2942
2942
|
};
|
|
2943
2943
|
trace?: never;
|
|
2944
2944
|
};
|
|
2945
|
+
"/institutions/{institutionId}/groups/users": {
|
|
2946
|
+
parameters: {
|
|
2947
|
+
query?: never;
|
|
2948
|
+
header?: never;
|
|
2949
|
+
path?: never;
|
|
2950
|
+
cookie?: never;
|
|
2951
|
+
};
|
|
2952
|
+
/**
|
|
2953
|
+
* Get all users of all groups in an institution
|
|
2954
|
+
* @description Retrieve all users from all groups associated with a specific institution.
|
|
2955
|
+
* Returns a map where keys are group IDs and values are arrays of users in each group.
|
|
2956
|
+
* This is more efficient than calling /groups/{id}/users multiple times.
|
|
2957
|
+
*/
|
|
2958
|
+
get: {
|
|
2959
|
+
parameters: {
|
|
2960
|
+
query?: never;
|
|
2961
|
+
header?: never;
|
|
2962
|
+
path: {
|
|
2963
|
+
/** @description Institution ID */
|
|
2964
|
+
institutionId: string;
|
|
2965
|
+
};
|
|
2966
|
+
cookie?: never;
|
|
2967
|
+
};
|
|
2968
|
+
requestBody?: never;
|
|
2969
|
+
responses: {
|
|
2970
|
+
/** @description Users grouped by group ID */
|
|
2971
|
+
200: {
|
|
2972
|
+
headers: {
|
|
2973
|
+
[name: string]: unknown;
|
|
2974
|
+
};
|
|
2975
|
+
content: {
|
|
2976
|
+
/**
|
|
2977
|
+
* @example {
|
|
2978
|
+
* "status": "success",
|
|
2979
|
+
* "data": {
|
|
2980
|
+
* "group-uuid-1": [
|
|
2981
|
+
* {
|
|
2982
|
+
* "id": "user-uuid-1",
|
|
2983
|
+
* "firstName": "John",
|
|
2984
|
+
* "lastName": "Doe",
|
|
2985
|
+
* "email": "john@example.com",
|
|
2986
|
+
* "assignedAt": "2024-01-15T10:30:00Z"
|
|
2987
|
+
* },
|
|
2988
|
+
* {
|
|
2989
|
+
* "id": "user-uuid-2",
|
|
2990
|
+
* "firstName": "Jane",
|
|
2991
|
+
* "lastName": "Smith",
|
|
2992
|
+
* "email": "jane@example.com",
|
|
2993
|
+
* "assignedAt": "2024-01-16T14:20:00Z"
|
|
2994
|
+
* }
|
|
2995
|
+
* ],
|
|
2996
|
+
* "group-uuid-2": [
|
|
2997
|
+
* {
|
|
2998
|
+
* "id": "user-uuid-3",
|
|
2999
|
+
* "firstName": "Bob",
|
|
3000
|
+
* "lastName": "Wilson",
|
|
3001
|
+
* "email": "bob@example.com",
|
|
3002
|
+
* "assignedAt": "2024-01-17T09:15:00Z"
|
|
3003
|
+
* }
|
|
3004
|
+
* ]
|
|
3005
|
+
* }
|
|
3006
|
+
* }
|
|
3007
|
+
*/
|
|
3008
|
+
"application/json": {
|
|
3009
|
+
/** @example success */
|
|
3010
|
+
status?: string;
|
|
3011
|
+
/** @description Map of group IDs to arrays of users */
|
|
3012
|
+
data?: {
|
|
3013
|
+
[key: string]: {
|
|
3014
|
+
/** Format: uuid */
|
|
3015
|
+
id?: string;
|
|
3016
|
+
firstName?: string;
|
|
3017
|
+
lastName?: string;
|
|
3018
|
+
email?: string;
|
|
3019
|
+
document?: string;
|
|
3020
|
+
phone?: string;
|
|
3021
|
+
isActive?: boolean;
|
|
3022
|
+
/** Format: date-time */
|
|
3023
|
+
assignedAt?: string;
|
|
3024
|
+
/** Format: uuid */
|
|
3025
|
+
assignedBy?: string;
|
|
3026
|
+
}[];
|
|
3027
|
+
};
|
|
3028
|
+
};
|
|
3029
|
+
};
|
|
3030
|
+
};
|
|
3031
|
+
401: components["responses"]["Unauthorized"];
|
|
3032
|
+
404: components["responses"]["NotFound"];
|
|
3033
|
+
500: components["responses"]["ServerError"];
|
|
3034
|
+
};
|
|
3035
|
+
};
|
|
3036
|
+
put?: never;
|
|
3037
|
+
post?: never;
|
|
3038
|
+
delete?: never;
|
|
3039
|
+
options?: never;
|
|
3040
|
+
head?: never;
|
|
3041
|
+
patch?: never;
|
|
3042
|
+
trace?: never;
|
|
3043
|
+
};
|
|
2945
3044
|
"/institutions/{institutionId}/registrations": {
|
|
2946
3045
|
parameters: {
|
|
2947
3046
|
query?: never;
|
|
@@ -4945,7 +5044,7 @@ export interface paths {
|
|
|
4945
5044
|
};
|
|
4946
5045
|
/**
|
|
4947
5046
|
* List all shifts
|
|
4948
|
-
* @description Retrieve a list of all institution shifts (
|
|
5047
|
+
* @description Retrieve a list of all institution shifts (manhã, tarde, noite)
|
|
4949
5048
|
*/
|
|
4950
5049
|
get: {
|
|
4951
5050
|
parameters: {
|
|
@@ -6011,7 +6110,7 @@ export interface components {
|
|
|
6011
6110
|
*/
|
|
6012
6111
|
value?: number;
|
|
6013
6112
|
} | null;
|
|
6014
|
-
/** @description Shift information (
|
|
6113
|
+
/** @description Shift information (manhã, tarde, noite) */
|
|
6015
6114
|
shift?: {
|
|
6016
6115
|
/** Format: uuid */
|
|
6017
6116
|
id?: string;
|
|
@@ -6327,7 +6426,7 @@ export interface components {
|
|
|
6327
6426
|
createdAt?: string;
|
|
6328
6427
|
/** Format: date-time */
|
|
6329
6428
|
updatedAt?: string;
|
|
6330
|
-
/** @description Shift information (
|
|
6429
|
+
/** @description Shift information (manhã, tarde, noite) */
|
|
6331
6430
|
shift?: components["schemas"]["Shift"];
|
|
6332
6431
|
/** @description Serie/grade level information */
|
|
6333
6432
|
serie?: components["schemas"]["Serie"];
|
|
@@ -6842,17 +6941,17 @@ export interface components {
|
|
|
6842
6941
|
};
|
|
6843
6942
|
CreateShiftDto: {
|
|
6844
6943
|
/**
|
|
6845
|
-
* @example
|
|
6944
|
+
* @example manhã
|
|
6846
6945
|
* @enum {string}
|
|
6847
6946
|
*/
|
|
6848
|
-
name: "
|
|
6947
|
+
name: "manhã" | "tarde" | "noite";
|
|
6849
6948
|
};
|
|
6850
6949
|
UpdateShiftDto: {
|
|
6851
6950
|
/**
|
|
6852
|
-
* @example
|
|
6951
|
+
* @example manhã
|
|
6853
6952
|
* @enum {string}
|
|
6854
6953
|
*/
|
|
6855
|
-
name?: "
|
|
6954
|
+
name?: "manhã" | "tarde" | "noite";
|
|
6856
6955
|
};
|
|
6857
6956
|
AssignGuardianToUserDto: {
|
|
6858
6957
|
/** Format: uuid */
|