@knowledge-stack/ksapi 1.62.1 → 1.63.0

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.
Files changed (61) hide show
  1. package/.openapi-generator/FILES +14 -0
  2. package/README.md +12 -3
  3. package/dist/apis/FeedbackApi.d.ts +170 -0
  4. package/dist/apis/FeedbackApi.js +176 -0
  5. package/dist/apis/TenantGroupsApi.d.ts +1 -37
  6. package/dist/apis/TenantGroupsApi.js +3 -75
  7. package/dist/apis/index.d.ts +1 -0
  8. package/dist/apis/index.js +1 -0
  9. package/dist/esm/apis/FeedbackApi.d.ts +170 -0
  10. package/dist/esm/apis/FeedbackApi.js +172 -0
  11. package/dist/esm/apis/TenantGroupsApi.d.ts +1 -37
  12. package/dist/esm/apis/TenantGroupsApi.js +3 -75
  13. package/dist/esm/apis/index.d.ts +1 -0
  14. package/dist/esm/apis/index.js +1 -0
  15. package/dist/esm/models/FeedbackEventResponse.d.ts +106 -0
  16. package/dist/esm/models/FeedbackEventResponse.js +83 -0
  17. package/dist/esm/models/FeedbackRating.d.ts +25 -0
  18. package/dist/esm/models/FeedbackRating.js +43 -0
  19. package/dist/esm/models/FeedbackReason.d.ts +34 -0
  20. package/dist/esm/models/FeedbackReason.js +52 -0
  21. package/dist/esm/models/FeedbackTargetType.d.ts +28 -0
  22. package/dist/esm/models/FeedbackTargetType.js +46 -0
  23. package/dist/esm/models/PaginatedResponseFeedbackEventResponse.d.ts +66 -0
  24. package/dist/esm/models/PaginatedResponseFeedbackEventResponse.js +70 -0
  25. package/dist/esm/models/SubmitFeedbackRequest.d.ts +82 -0
  26. package/dist/esm/models/SubmitFeedbackRequest.js +65 -0
  27. package/dist/esm/models/index.d.ts +6 -0
  28. package/dist/esm/models/index.js +6 -0
  29. package/dist/models/FeedbackEventResponse.d.ts +106 -0
  30. package/dist/models/FeedbackEventResponse.js +91 -0
  31. package/dist/models/FeedbackRating.d.ts +25 -0
  32. package/dist/models/FeedbackRating.js +51 -0
  33. package/dist/models/FeedbackReason.d.ts +34 -0
  34. package/dist/models/FeedbackReason.js +60 -0
  35. package/dist/models/FeedbackTargetType.d.ts +28 -0
  36. package/dist/models/FeedbackTargetType.js +54 -0
  37. package/dist/models/PaginatedResponseFeedbackEventResponse.d.ts +66 -0
  38. package/dist/models/PaginatedResponseFeedbackEventResponse.js +78 -0
  39. package/dist/models/SubmitFeedbackRequest.d.ts +82 -0
  40. package/dist/models/SubmitFeedbackRequest.js +73 -0
  41. package/dist/models/index.d.ts +6 -0
  42. package/dist/models/index.js +6 -0
  43. package/docs/FeedbackApi.md +245 -0
  44. package/docs/FeedbackEventResponse.md +53 -0
  45. package/docs/FeedbackRating.md +32 -0
  46. package/docs/FeedbackReason.md +32 -0
  47. package/docs/FeedbackTargetType.md +32 -0
  48. package/docs/PaginatedResponseFeedbackEventResponse.md +40 -0
  49. package/docs/SubmitFeedbackRequest.md +45 -0
  50. package/docs/TenantGroupsApi.md +13 -49
  51. package/package.json +1 -1
  52. package/src/apis/FeedbackApi.ts +334 -0
  53. package/src/apis/TenantGroupsApi.ts +2 -170
  54. package/src/apis/index.ts +1 -0
  55. package/src/models/FeedbackEventResponse.ts +188 -0
  56. package/src/models/FeedbackRating.ts +53 -0
  57. package/src/models/FeedbackReason.ts +62 -0
  58. package/src/models/FeedbackTargetType.ts +56 -0
  59. package/src/models/PaginatedResponseFeedbackEventResponse.ts +130 -0
  60. package/src/models/SubmitFeedbackRequest.ts +152 -0
  61. package/src/models/index.ts +6 -0
@@ -0,0 +1,78 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Knowledge Stack API
6
+ * Knowledge Stack backend API for authentication and knowledge management
7
+ *
8
+ * The version of the OpenAPI document: 0.1.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.PaginatedResponseFeedbackEventResponsePropertyValidationAttributesMap = void 0;
17
+ exports.instanceOfPaginatedResponseFeedbackEventResponse = instanceOfPaginatedResponseFeedbackEventResponse;
18
+ exports.PaginatedResponseFeedbackEventResponseFromJSON = PaginatedResponseFeedbackEventResponseFromJSON;
19
+ exports.PaginatedResponseFeedbackEventResponseFromJSONTyped = PaginatedResponseFeedbackEventResponseFromJSONTyped;
20
+ exports.PaginatedResponseFeedbackEventResponseToJSON = PaginatedResponseFeedbackEventResponseToJSON;
21
+ exports.PaginatedResponseFeedbackEventResponseToJSONTyped = PaginatedResponseFeedbackEventResponseToJSONTyped;
22
+ const FeedbackEventResponse_1 = require("./FeedbackEventResponse");
23
+ /**
24
+ * Check if a given object implements the PaginatedResponseFeedbackEventResponse interface.
25
+ */
26
+ function instanceOfPaginatedResponseFeedbackEventResponse(value) {
27
+ if (!('items' in value) || value['items'] === undefined)
28
+ return false;
29
+ if (!('total' in value) || value['total'] === undefined)
30
+ return false;
31
+ if (!('limit' in value) || value['limit'] === undefined)
32
+ return false;
33
+ if (!('offset' in value) || value['offset'] === undefined)
34
+ return false;
35
+ return true;
36
+ }
37
+ function PaginatedResponseFeedbackEventResponseFromJSON(json) {
38
+ return PaginatedResponseFeedbackEventResponseFromJSONTyped(json, false);
39
+ }
40
+ function PaginatedResponseFeedbackEventResponseFromJSONTyped(json, ignoreDiscriminator) {
41
+ if (json == null) {
42
+ return json;
43
+ }
44
+ return {
45
+ 'items': (json['items'].map(FeedbackEventResponse_1.FeedbackEventResponseFromJSON)),
46
+ 'total': json['total'],
47
+ 'limit': json['limit'],
48
+ 'offset': json['offset'],
49
+ };
50
+ }
51
+ function PaginatedResponseFeedbackEventResponseToJSON(json) {
52
+ return PaginatedResponseFeedbackEventResponseToJSONTyped(json, false);
53
+ }
54
+ function PaginatedResponseFeedbackEventResponseToJSONTyped(value, ignoreDiscriminator = false) {
55
+ if (value == null) {
56
+ return value;
57
+ }
58
+ return {
59
+ 'items': (value['items'].map(FeedbackEventResponse_1.FeedbackEventResponseToJSON)),
60
+ 'total': value['total'],
61
+ 'limit': value['limit'],
62
+ 'offset': value['offset'],
63
+ };
64
+ }
65
+ exports.PaginatedResponseFeedbackEventResponsePropertyValidationAttributesMap = {
66
+ total: {
67
+ minimum: 0,
68
+ exclusiveMinimum: false,
69
+ },
70
+ limit: {
71
+ minimum: 1,
72
+ exclusiveMinimum: false,
73
+ },
74
+ offset: {
75
+ minimum: 0,
76
+ exclusiveMinimum: false,
77
+ },
78
+ };
@@ -0,0 +1,82 @@
1
+ /**
2
+ * Knowledge Stack API
3
+ * Knowledge Stack backend API for authentication and knowledge management
4
+ *
5
+ * The version of the OpenAPI document: 0.1.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { FeedbackTargetType } from './FeedbackTargetType';
13
+ import type { FeedbackRating } from './FeedbackRating';
14
+ import type { FeedbackReason } from './FeedbackReason';
15
+ /**
16
+ * Request to create or update feedback on a knowledge entity.
17
+ * @export
18
+ * @interface SubmitFeedbackRequest
19
+ */
20
+ export interface SubmitFeedbackRequest {
21
+ /**
22
+ *
23
+ * @type {FeedbackTargetType}
24
+ * @memberof SubmitFeedbackRequest
25
+ */
26
+ targetType: FeedbackTargetType;
27
+ /**
28
+ *
29
+ * @type {string}
30
+ * @memberof SubmitFeedbackRequest
31
+ */
32
+ targetId: string;
33
+ /**
34
+ *
35
+ * @type {FeedbackRating}
36
+ * @memberof SubmitFeedbackRequest
37
+ */
38
+ rating: FeedbackRating;
39
+ /**
40
+ *
41
+ * @type {FeedbackReason}
42
+ * @memberof SubmitFeedbackRequest
43
+ */
44
+ reason?: FeedbackReason;
45
+ /**
46
+ *
47
+ * @type {string}
48
+ * @memberof SubmitFeedbackRequest
49
+ */
50
+ comment?: string | null;
51
+ /**
52
+ *
53
+ * @type {{ [key: string]: any; }}
54
+ * @memberof SubmitFeedbackRequest
55
+ */
56
+ extraMetadata?: {
57
+ [key: string]: any;
58
+ } | null;
59
+ }
60
+ /**
61
+ * Check if a given object implements the SubmitFeedbackRequest interface.
62
+ */
63
+ export declare function instanceOfSubmitFeedbackRequest(value: object): value is SubmitFeedbackRequest;
64
+ export declare function SubmitFeedbackRequestFromJSON(json: any): SubmitFeedbackRequest;
65
+ export declare function SubmitFeedbackRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubmitFeedbackRequest;
66
+ export declare function SubmitFeedbackRequestToJSON(json: any): SubmitFeedbackRequest;
67
+ export declare function SubmitFeedbackRequestToJSONTyped(value?: SubmitFeedbackRequest | null, ignoreDiscriminator?: boolean): any;
68
+ export declare const SubmitFeedbackRequestPropertyValidationAttributesMap: {
69
+ [property: string]: {
70
+ maxLength?: number;
71
+ minLength?: number;
72
+ pattern?: string;
73
+ maximum?: number;
74
+ exclusiveMaximum?: boolean;
75
+ minimum?: number;
76
+ exclusiveMinimum?: boolean;
77
+ multipleOf?: number;
78
+ maxItems?: number;
79
+ minItems?: number;
80
+ uniqueItems?: boolean;
81
+ };
82
+ };
@@ -0,0 +1,73 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Knowledge Stack API
6
+ * Knowledge Stack backend API for authentication and knowledge management
7
+ *
8
+ * The version of the OpenAPI document: 0.1.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.SubmitFeedbackRequestPropertyValidationAttributesMap = void 0;
17
+ exports.instanceOfSubmitFeedbackRequest = instanceOfSubmitFeedbackRequest;
18
+ exports.SubmitFeedbackRequestFromJSON = SubmitFeedbackRequestFromJSON;
19
+ exports.SubmitFeedbackRequestFromJSONTyped = SubmitFeedbackRequestFromJSONTyped;
20
+ exports.SubmitFeedbackRequestToJSON = SubmitFeedbackRequestToJSON;
21
+ exports.SubmitFeedbackRequestToJSONTyped = SubmitFeedbackRequestToJSONTyped;
22
+ const FeedbackTargetType_1 = require("./FeedbackTargetType");
23
+ const FeedbackRating_1 = require("./FeedbackRating");
24
+ const FeedbackReason_1 = require("./FeedbackReason");
25
+ /**
26
+ * Check if a given object implements the SubmitFeedbackRequest interface.
27
+ */
28
+ function instanceOfSubmitFeedbackRequest(value) {
29
+ if (!('targetType' in value) || value['targetType'] === undefined)
30
+ return false;
31
+ if (!('targetId' in value) || value['targetId'] === undefined)
32
+ return false;
33
+ if (!('rating' in value) || value['rating'] === undefined)
34
+ return false;
35
+ return true;
36
+ }
37
+ function SubmitFeedbackRequestFromJSON(json) {
38
+ return SubmitFeedbackRequestFromJSONTyped(json, false);
39
+ }
40
+ function SubmitFeedbackRequestFromJSONTyped(json, ignoreDiscriminator) {
41
+ if (json == null) {
42
+ return json;
43
+ }
44
+ return {
45
+ 'targetType': (0, FeedbackTargetType_1.FeedbackTargetTypeFromJSON)(json['target_type']),
46
+ 'targetId': json['target_id'],
47
+ 'rating': (0, FeedbackRating_1.FeedbackRatingFromJSON)(json['rating']),
48
+ 'reason': json['reason'] == null ? undefined : (0, FeedbackReason_1.FeedbackReasonFromJSON)(json['reason']),
49
+ 'comment': json['comment'] == null ? undefined : json['comment'],
50
+ 'extraMetadata': json['extra_metadata'] == null ? undefined : json['extra_metadata'],
51
+ };
52
+ }
53
+ function SubmitFeedbackRequestToJSON(json) {
54
+ return SubmitFeedbackRequestToJSONTyped(json, false);
55
+ }
56
+ function SubmitFeedbackRequestToJSONTyped(value, ignoreDiscriminator = false) {
57
+ if (value == null) {
58
+ return value;
59
+ }
60
+ return {
61
+ 'target_type': (0, FeedbackTargetType_1.FeedbackTargetTypeToJSON)(value['targetType']),
62
+ 'target_id': value['targetId'],
63
+ 'rating': (0, FeedbackRating_1.FeedbackRatingToJSON)(value['rating']),
64
+ 'reason': (0, FeedbackReason_1.FeedbackReasonToJSON)(value['reason']),
65
+ 'comment': value['comment'],
66
+ 'extra_metadata': value['extraMetadata'],
67
+ };
68
+ }
69
+ exports.SubmitFeedbackRequestPropertyValidationAttributesMap = {
70
+ comment: {
71
+ maxLength: 4000,
72
+ },
73
+ };
@@ -48,6 +48,10 @@ export * from './EmailVerificationRequest';
48
48
  export * from './EnrichedCitation';
49
49
  export * from './EnrichedThreadMessageContent';
50
50
  export * from './FeaturesResponse';
51
+ export * from './FeedbackEventResponse';
52
+ export * from './FeedbackRating';
53
+ export * from './FeedbackReason';
54
+ export * from './FeedbackTargetType';
51
55
  export * from './FolderAction';
52
56
  export * from './FolderActionResponse';
53
57
  export * from './FolderResponse';
@@ -76,6 +80,7 @@ export * from './PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDi
76
80
  export * from './PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator';
77
81
  export * from './PaginatedResponseDocumentResponse';
78
82
  export * from './PaginatedResponseDocumentVersionResponse';
83
+ export * from './PaginatedResponseFeedbackEventResponse';
79
84
  export * from './PaginatedResponseFolderResponse';
80
85
  export * from './PaginatedResponseGroupPermissionResponse';
81
86
  export * from './PaginatedResponseGroupResponse';
@@ -119,6 +124,7 @@ export * from './SignInRequest';
119
124
  export * from './StepInput';
120
125
  export * from './StepKind';
121
126
  export * from './StepOutput';
127
+ export * from './SubmitFeedbackRequest';
122
128
  export * from './SubtreeChunkGroup';
123
129
  export * from './SubtreeChunksResponse';
124
130
  export * from './SupportedLanguage';
@@ -66,6 +66,10 @@ __exportStar(require("./EmailVerificationRequest"), exports);
66
66
  __exportStar(require("./EnrichedCitation"), exports);
67
67
  __exportStar(require("./EnrichedThreadMessageContent"), exports);
68
68
  __exportStar(require("./FeaturesResponse"), exports);
69
+ __exportStar(require("./FeedbackEventResponse"), exports);
70
+ __exportStar(require("./FeedbackRating"), exports);
71
+ __exportStar(require("./FeedbackReason"), exports);
72
+ __exportStar(require("./FeedbackTargetType"), exports);
69
73
  __exportStar(require("./FolderAction"), exports);
70
74
  __exportStar(require("./FolderActionResponse"), exports);
71
75
  __exportStar(require("./FolderResponse"), exports);
@@ -94,6 +98,7 @@ __exportStar(require("./PaginatedResponseAnnotatedUnionFolderResponseDocumentRes
94
98
  __exportStar(require("./PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator"), exports);
95
99
  __exportStar(require("./PaginatedResponseDocumentResponse"), exports);
96
100
  __exportStar(require("./PaginatedResponseDocumentVersionResponse"), exports);
101
+ __exportStar(require("./PaginatedResponseFeedbackEventResponse"), exports);
97
102
  __exportStar(require("./PaginatedResponseFolderResponse"), exports);
98
103
  __exportStar(require("./PaginatedResponseGroupPermissionResponse"), exports);
99
104
  __exportStar(require("./PaginatedResponseGroupResponse"), exports);
@@ -137,6 +142,7 @@ __exportStar(require("./SignInRequest"), exports);
137
142
  __exportStar(require("./StepInput"), exports);
138
143
  __exportStar(require("./StepKind"), exports);
139
144
  __exportStar(require("./StepOutput"), exports);
145
+ __exportStar(require("./SubmitFeedbackRequest"), exports);
140
146
  __exportStar(require("./SubtreeChunkGroup"), exports);
141
147
  __exportStar(require("./SubtreeChunksResponse"), exports);
142
148
  __exportStar(require("./SupportedLanguage"), exports);
@@ -0,0 +1,245 @@
1
+ # FeedbackApi
2
+
3
+ All URIs are relative to *http://localhost:8000*
4
+
5
+ | Method | HTTP request | Description |
6
+ |------------- | ------------- | -------------|
7
+ | [**deleteFeedback**](FeedbackApi.md#deletefeedback) | **DELETE** /v1/feedback/{feedback_id} | Delete Feedback Handler |
8
+ | [**listFeedback**](FeedbackApi.md#listfeedback) | **GET** /v1/feedback | List Feedback Handler |
9
+ | [**submitFeedback**](FeedbackApi.md#submitfeedbackoperation) | **POST** /v1/feedback | Submit Feedback Handler |
10
+
11
+
12
+
13
+ ## deleteFeedback
14
+
15
+ > deleteFeedback(feedbackId, authorization, ksUat)
16
+
17
+ Delete Feedback Handler
18
+
19
+ Delete a feedback entry. USER role: can only delete their own feedback. OWNER/ADMIN role: can delete any feedback. Returns 404 if the feedback does not exist. Returns 403 if the user does not own the feedback and is not OWNER/ADMIN.
20
+
21
+ ### Example
22
+
23
+ ```ts
24
+ import {
25
+ Configuration,
26
+ FeedbackApi,
27
+ } from '@knowledge-stack/ksapi';
28
+ import type { DeleteFeedbackRequest } from '@knowledge-stack/ksapi';
29
+
30
+ async function example() {
31
+ console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
32
+ const api = new FeedbackApi();
33
+
34
+ const body = {
35
+ // string
36
+ feedbackId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
37
+ // string (optional)
38
+ authorization: authorization_example,
39
+ // string (optional)
40
+ ksUat: ksUat_example,
41
+ } satisfies DeleteFeedbackRequest;
42
+
43
+ try {
44
+ const data = await api.deleteFeedback(body);
45
+ console.log(data);
46
+ } catch (error) {
47
+ console.error(error);
48
+ }
49
+ }
50
+
51
+ // Run the test
52
+ example().catch(console.error);
53
+ ```
54
+
55
+ ### Parameters
56
+
57
+
58
+ | Name | Type | Description | Notes |
59
+ |------------- | ------------- | ------------- | -------------|
60
+ | **feedbackId** | `string` | | [Defaults to `undefined`] |
61
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
62
+ | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
63
+
64
+ ### Return type
65
+
66
+ `void` (Empty response body)
67
+
68
+ ### Authorization
69
+
70
+ No authorization required
71
+
72
+ ### HTTP request headers
73
+
74
+ - **Content-Type**: Not defined
75
+ - **Accept**: `application/json`
76
+
77
+
78
+ ### HTTP response details
79
+ | Status code | Description | Response headers |
80
+ |-------------|-------------|------------------|
81
+ | **204** | Successful Response | - |
82
+ | **422** | Validation Error | - |
83
+
84
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
85
+
86
+
87
+ ## listFeedback
88
+
89
+ > PaginatedResponseFeedbackEventResponse listFeedback(targetType, targetId, rating, limit, offset, authorization, ksUat)
90
+
91
+ List Feedback Handler
92
+
93
+ List feedback entries with optional filters. USER role: only returns their own feedback. OWNER/ADMIN role: returns feedback from all users.
94
+
95
+ ### Example
96
+
97
+ ```ts
98
+ import {
99
+ Configuration,
100
+ FeedbackApi,
101
+ } from '@knowledge-stack/ksapi';
102
+ import type { ListFeedbackRequest } from '@knowledge-stack/ksapi';
103
+
104
+ async function example() {
105
+ console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
106
+ const api = new FeedbackApi();
107
+
108
+ const body = {
109
+ // FeedbackTargetType (optional)
110
+ targetType: ...,
111
+ // string (optional)
112
+ targetId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
113
+ // FeedbackRating (optional)
114
+ rating: ...,
115
+ // number | Number of items per page (optional)
116
+ limit: 56,
117
+ // number | Number of items to skip (optional)
118
+ offset: 56,
119
+ // string (optional)
120
+ authorization: authorization_example,
121
+ // string (optional)
122
+ ksUat: ksUat_example,
123
+ } satisfies ListFeedbackRequest;
124
+
125
+ try {
126
+ const data = await api.listFeedback(body);
127
+ console.log(data);
128
+ } catch (error) {
129
+ console.error(error);
130
+ }
131
+ }
132
+
133
+ // Run the test
134
+ example().catch(console.error);
135
+ ```
136
+
137
+ ### Parameters
138
+
139
+
140
+ | Name | Type | Description | Notes |
141
+ |------------- | ------------- | ------------- | -------------|
142
+ | **targetType** | `FeedbackTargetType` | | [Optional] [Defaults to `undefined`] [Enum: THREAD, MESSAGE, DOCUMENT, DOCUMENT_VERSION, CHUNK] |
143
+ | **targetId** | `string` | | [Optional] [Defaults to `undefined`] |
144
+ | **rating** | `FeedbackRating` | | [Optional] [Defaults to `undefined`] [Enum: UP, DOWN] |
145
+ | **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
146
+ | **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
147
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
148
+ | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
149
+
150
+ ### Return type
151
+
152
+ [**PaginatedResponseFeedbackEventResponse**](PaginatedResponseFeedbackEventResponse.md)
153
+
154
+ ### Authorization
155
+
156
+ No authorization required
157
+
158
+ ### HTTP request headers
159
+
160
+ - **Content-Type**: Not defined
161
+ - **Accept**: `application/json`
162
+
163
+
164
+ ### HTTP response details
165
+ | Status code | Description | Response headers |
166
+ |-------------|-------------|------------------|
167
+ | **200** | Successful Response | - |
168
+ | **422** | Validation Error | - |
169
+
170
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
171
+
172
+
173
+ ## submitFeedback
174
+
175
+ > FeedbackEventResponse submitFeedback(submitFeedbackRequest, authorization, ksUat)
176
+
177
+ Submit Feedback Handler
178
+
179
+ Create or update feedback on a knowledge entity (upsert). Returns 201 when feedback is newly created, 200 when updated. Validates that the target entity exists and the user can read it.
180
+
181
+ ### Example
182
+
183
+ ```ts
184
+ import {
185
+ Configuration,
186
+ FeedbackApi,
187
+ } from '@knowledge-stack/ksapi';
188
+ import type { SubmitFeedbackOperationRequest } from '@knowledge-stack/ksapi';
189
+
190
+ async function example() {
191
+ console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
192
+ const api = new FeedbackApi();
193
+
194
+ const body = {
195
+ // SubmitFeedbackRequest
196
+ submitFeedbackRequest: ...,
197
+ // string (optional)
198
+ authorization: authorization_example,
199
+ // string (optional)
200
+ ksUat: ksUat_example,
201
+ } satisfies SubmitFeedbackOperationRequest;
202
+
203
+ try {
204
+ const data = await api.submitFeedback(body);
205
+ console.log(data);
206
+ } catch (error) {
207
+ console.error(error);
208
+ }
209
+ }
210
+
211
+ // Run the test
212
+ example().catch(console.error);
213
+ ```
214
+
215
+ ### Parameters
216
+
217
+
218
+ | Name | Type | Description | Notes |
219
+ |------------- | ------------- | ------------- | -------------|
220
+ | **submitFeedbackRequest** | [SubmitFeedbackRequest](SubmitFeedbackRequest.md) | | |
221
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
222
+ | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
223
+
224
+ ### Return type
225
+
226
+ [**FeedbackEventResponse**](FeedbackEventResponse.md)
227
+
228
+ ### Authorization
229
+
230
+ No authorization required
231
+
232
+ ### HTTP request headers
233
+
234
+ - **Content-Type**: `application/json`
235
+ - **Accept**: `application/json`
236
+
237
+
238
+ ### HTTP response details
239
+ | Status code | Description | Response headers |
240
+ |-------------|-------------|------------------|
241
+ | **201** | Successful Response | - |
242
+ | **422** | Validation Error | - |
243
+
244
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
245
+
@@ -0,0 +1,53 @@
1
+
2
+ # FeedbackEventResponse
3
+
4
+ Response schema for a single FeedbackEvent.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `id` | string
11
+ `targetType` | [FeedbackTargetType](FeedbackTargetType.md)
12
+ `targetId` | string
13
+ `userId` | string
14
+ `rating` | [FeedbackRating](FeedbackRating.md)
15
+ `reason` | [FeedbackReason](FeedbackReason.md)
16
+ `comment` | string
17
+ `extraMetadata` | { [key: string]: any; }
18
+ `createdAt` | Date
19
+ `updatedAt` | Date
20
+
21
+ ## Example
22
+
23
+ ```typescript
24
+ import type { FeedbackEventResponse } from '@knowledge-stack/ksapi'
25
+
26
+ // TODO: Update the object below with actual values
27
+ const example = {
28
+ "id": null,
29
+ "targetType": null,
30
+ "targetId": null,
31
+ "userId": null,
32
+ "rating": null,
33
+ "reason": null,
34
+ "comment": null,
35
+ "extraMetadata": null,
36
+ "createdAt": null,
37
+ "updatedAt": null,
38
+ } satisfies FeedbackEventResponse
39
+
40
+ console.log(example)
41
+
42
+ // Convert the instance to a JSON string
43
+ const exampleJSON: string = JSON.stringify(example)
44
+ console.log(exampleJSON)
45
+
46
+ // Parse the JSON string back to an object
47
+ const exampleParsed = JSON.parse(exampleJSON) as FeedbackEventResponse
48
+ console.log(exampleParsed)
49
+ ```
50
+
51
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
52
+
53
+
@@ -0,0 +1,32 @@
1
+
2
+ # FeedbackRating
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import type { FeedbackRating } from '@knowledge-stack/ksapi'
14
+
15
+ // TODO: Update the object below with actual values
16
+ const example = {
17
+ } satisfies FeedbackRating
18
+
19
+ console.log(example)
20
+
21
+ // Convert the instance to a JSON string
22
+ const exampleJSON: string = JSON.stringify(example)
23
+ console.log(exampleJSON)
24
+
25
+ // Parse the JSON string back to an object
26
+ const exampleParsed = JSON.parse(exampleJSON) as FeedbackRating
27
+ console.log(exampleParsed)
28
+ ```
29
+
30
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
31
+
32
+
@@ -0,0 +1,32 @@
1
+
2
+ # FeedbackReason
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import type { FeedbackReason } from '@knowledge-stack/ksapi'
14
+
15
+ // TODO: Update the object below with actual values
16
+ const example = {
17
+ } satisfies FeedbackReason
18
+
19
+ console.log(example)
20
+
21
+ // Convert the instance to a JSON string
22
+ const exampleJSON: string = JSON.stringify(example)
23
+ console.log(exampleJSON)
24
+
25
+ // Parse the JSON string back to an object
26
+ const exampleParsed = JSON.parse(exampleJSON) as FeedbackReason
27
+ console.log(exampleParsed)
28
+ ```
29
+
30
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
31
+
32
+
@@ -0,0 +1,32 @@
1
+
2
+ # FeedbackTargetType
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import type { FeedbackTargetType } from '@knowledge-stack/ksapi'
14
+
15
+ // TODO: Update the object below with actual values
16
+ const example = {
17
+ } satisfies FeedbackTargetType
18
+
19
+ console.log(example)
20
+
21
+ // Convert the instance to a JSON string
22
+ const exampleJSON: string = JSON.stringify(example)
23
+ console.log(exampleJSON)
24
+
25
+ // Parse the JSON string back to an object
26
+ const exampleParsed = JSON.parse(exampleJSON) as FeedbackTargetType
27
+ console.log(exampleParsed)
28
+ ```
29
+
30
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
31
+
32
+