@knowledge-stack/ksapi 1.66.2 → 1.67.0

package/dist/esm/apis/FeedbackApi.d.ts

@@ -0,0 +1,170 @@
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { FeedbackEventResponse, FeedbackRating, FeedbackTargetType, PaginatedResponseFeedbackEventResponse, SubmitFeedbackRequest } from '../models/index';
+export interface DeleteFeedbackRequest {
+    feedbackId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+export interface ListFeedbackRequest {
+    targetType?: FeedbackTargetType;
+    targetId?: string | null;
+    rating?: FeedbackRating;
+    limit?: number;
+    offset?: number;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+export interface SubmitFeedbackOperationRequest {
+    submitFeedbackRequest: SubmitFeedbackRequest;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+/**
+ * FeedbackApi - interface
+ *
+ * @export
+ * @interface FeedbackApiInterface
+ */
+export interface FeedbackApiInterface {
+    /**
+     * Creates request options for deleteFeedback without sending the request
+     * @param {string} feedbackId
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof FeedbackApiInterface
+     */
+    deleteFeedbackRequestOpts(requestParameters: DeleteFeedbackRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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.
+     * @summary Delete Feedback Handler
+     * @param {string} feedbackId
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FeedbackApiInterface
+     */
+    deleteFeedbackRaw(requestParameters: DeleteFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * 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.
+     * Delete Feedback Handler
+     */
+    deleteFeedback(requestParameters: DeleteFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listFeedback without sending the request
+     * @param {FeedbackTargetType} [targetType]
+     * @param {string} [targetId]
+     * @param {FeedbackRating} [rating]
+     * @param {number} [limit] Number of items per page
+     * @param {number} [offset] Number of items to skip
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof FeedbackApiInterface
+     */
+    listFeedbackRequestOpts(requestParameters: ListFeedbackRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List feedback entries with optional filters.  USER role: only returns their own feedback. OWNER/ADMIN role: returns feedback from all users.
+     * @summary List Feedback Handler
+     * @param {FeedbackTargetType} [targetType]
+     * @param {string} [targetId]
+     * @param {FeedbackRating} [rating]
+     * @param {number} [limit] Number of items per page
+     * @param {number} [offset] Number of items to skip
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FeedbackApiInterface
+     */
+    listFeedbackRaw(requestParameters: ListFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFeedbackEventResponse>>;
+    /**
+     * List feedback entries with optional filters.  USER role: only returns their own feedback. OWNER/ADMIN role: returns feedback from all users.
+     * List Feedback Handler
+     */
+    listFeedback(requestParameters: ListFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFeedbackEventResponse>;
+    /**
+     * Creates request options for submitFeedback without sending the request
+     * @param {SubmitFeedbackRequest} submitFeedbackRequest
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof FeedbackApiInterface
+     */
+    submitFeedbackRequestOpts(requestParameters: SubmitFeedbackOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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.
+     * @summary Submit Feedback Handler
+     * @param {SubmitFeedbackRequest} submitFeedbackRequest
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FeedbackApiInterface
+     */
+    submitFeedbackRaw(requestParameters: SubmitFeedbackOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FeedbackEventResponse>>;
+    /**
+     * 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.
+     * Submit Feedback Handler
+     */
+    submitFeedback(requestParameters: SubmitFeedbackOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FeedbackEventResponse>;
+}
+/**
+ *
+ */
+export declare class FeedbackApi extends runtime.BaseAPI implements FeedbackApiInterface {
+    /**
+     * Creates request options for deleteFeedback without sending the request
+     */
+    deleteFeedbackRequestOpts(requestParameters: DeleteFeedbackRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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.
+     * Delete Feedback Handler
+     */
+    deleteFeedbackRaw(requestParameters: DeleteFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * 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.
+     * Delete Feedback Handler
+     */
+    deleteFeedback(requestParameters: DeleteFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listFeedback without sending the request
+     */
+    listFeedbackRequestOpts(requestParameters: ListFeedbackRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List feedback entries with optional filters.  USER role: only returns their own feedback. OWNER/ADMIN role: returns feedback from all users.
+     * List Feedback Handler
+     */
+    listFeedbackRaw(requestParameters: ListFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFeedbackEventResponse>>;
+    /**
+     * List feedback entries with optional filters.  USER role: only returns their own feedback. OWNER/ADMIN role: returns feedback from all users.
+     * List Feedback Handler
+     */
+    listFeedback(requestParameters?: ListFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFeedbackEventResponse>;
+    /**
+     * Creates request options for submitFeedback without sending the request
+     */
+    submitFeedbackRequestOpts(requestParameters: SubmitFeedbackOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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.
+     * Submit Feedback Handler
+     */
+    submitFeedbackRaw(requestParameters: SubmitFeedbackOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FeedbackEventResponse>>;
+    /**
+     * 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.
+     * Submit Feedback Handler
+     */
+    submitFeedback(requestParameters: SubmitFeedbackOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FeedbackEventResponse>;
+}

package/dist/esm/apis/FeedbackApi.js

@@ -0,0 +1,172 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { FeedbackEventResponseFromJSON, PaginatedResponseFeedbackEventResponseFromJSON, SubmitFeedbackRequestToJSON, } from '../models/index';
+/**
+ *
+ */
+export class FeedbackApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for deleteFeedback without sending the request
+     */
+    deleteFeedbackRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['feedbackId'] == null) {
+                throw new runtime.RequiredError('feedbackId', 'Required parameter "feedbackId" was null or undefined when calling deleteFeedback().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/feedback/{feedback_id}`;
+            urlPath = urlPath.replace(`{${"feedback_id"}}`, encodeURIComponent(String(requestParameters['feedbackId'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * 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.
+     * Delete Feedback Handler
+     */
+    deleteFeedbackRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deleteFeedbackRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * 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.
+     * Delete Feedback Handler
+     */
+    deleteFeedback(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteFeedbackRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for listFeedback without sending the request
+     */
+    listFeedbackRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['targetType'] != null) {
+                queryParameters['target_type'] = requestParameters['targetType'];
+            }
+            if (requestParameters['targetId'] != null) {
+                queryParameters['target_id'] = requestParameters['targetId'];
+            }
+            if (requestParameters['rating'] != null) {
+                queryParameters['rating'] = requestParameters['rating'];
+            }
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['offset'] != null) {
+                queryParameters['offset'] = requestParameters['offset'];
+            }
+            const headerParameters = {};
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/feedback`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List feedback entries with optional filters.  USER role: only returns their own feedback. OWNER/ADMIN role: returns feedback from all users.
+     * List Feedback Handler
+     */
+    listFeedbackRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listFeedbackRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseFeedbackEventResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * List feedback entries with optional filters.  USER role: only returns their own feedback. OWNER/ADMIN role: returns feedback from all users.
+     * List Feedback Handler
+     */
+    listFeedback() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.listFeedbackRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for submitFeedback without sending the request
+     */
+    submitFeedbackRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['submitFeedbackRequest'] == null) {
+                throw new runtime.RequiredError('submitFeedbackRequest', 'Required parameter "submitFeedbackRequest" was null or undefined when calling submitFeedback().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/feedback`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: SubmitFeedbackRequestToJSON(requestParameters['submitFeedbackRequest']),
+            };
+        });
+    }
+    /**
+     * 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.
+     * Submit Feedback Handler
+     */
+    submitFeedbackRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.submitFeedbackRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => FeedbackEventResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * 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.
+     * Submit Feedback Handler
+     */
+    submitFeedback(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.submitFeedbackRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}