@@ -7,44 +7,55 @@ import type { Status } from "./Status";
7
7
export interface IMessageResponse {
8
8
/**
9
9
* A descriptive message related to the response.
10
- * This could be a success message or any relevant information .
10
+ * This could indicate success, provide information, or describe a result .
11
11
*/
12
12
message : string ;
13
13
14
14
/**
15
15
* The status of the response, indicating success or failure.
16
- * It should conform to the Status type defined elsewhere.
16
+ * This should conform to the Status type defined elsewhere in the codebase .
17
17
*/
18
18
status : Status ;
19
19
}
20
20
21
21
/**
22
22
* Interface representing an error response.
23
- * This extends IMessageResponse to include additional error- related information .
23
+ * This extends IMessageResponse to include additional information related to errors .
24
24
*/
25
25
export interface IErrorResponse extends IMessageResponse {
26
26
/**
27
- * Optional stack trace string for debugging purposes.
28
- * This is included only in development environments to help trace errors.
27
+ * An optional stack trace string for debugging purposes.
28
+ * This is included only in development environments to assist in tracing errors.
29
29
*/
30
30
stack ?: string ;
31
31
}
32
32
33
33
/**
34
34
* Interface representing a data response, which extends IMessageResponse.
35
- * This includes an additional data property to return requested data.
35
+ * This includes an additional ` data` property to return requested data to the client .
36
36
*
37
37
* @template T - The type of data being returned in the response.
38
38
*/
39
39
export interface IDataResponse < T > extends IMessageResponse {
40
40
/**
41
41
* The data associated with the response.
42
- * This could be any type of data, depending on the context.
42
+ * This could be any type of data, depending on the specific context of the response .
43
43
*/
44
44
data : T ;
45
45
}
46
46
47
+ /**
48
+ * Interface representing a token response.
49
+ * This extends IMessageResponse to include information about the generated access token.
50
+ */
47
51
export interface ITokenResponse extends IMessageResponse {
52
+ /**
53
+ * The generated access token for authentication.
54
+ */
48
55
access_token : string ;
56
+
57
+ /**
58
+ * The duration in seconds until the access token expires.
59
+ */
49
60
expires_in : number ;
50
61
}
0 commit comments