@knowledge-stack/ksapi 1.62.1 → 1.63.0

package/src/apis/FeedbackApi.ts

@@ -0,0 +1,334 @@
+/* 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.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  FeedbackEventResponse,
+  FeedbackRating,
+  FeedbackTargetType,
+  HTTPValidationError,
+  PaginatedResponseFeedbackEventResponse,
+  SubmitFeedbackRequest,
+} from '../models/index';
+import {
+    FeedbackEventResponseFromJSON,
+    FeedbackEventResponseToJSON,
+    FeedbackRatingFromJSON,
+    FeedbackRatingToJSON,
+    FeedbackTargetTypeFromJSON,
+    FeedbackTargetTypeToJSON,
+    HTTPValidationErrorFromJSON,
+    HTTPValidationErrorToJSON,
+    PaginatedResponseFeedbackEventResponseFromJSON,
+    PaginatedResponseFeedbackEventResponseToJSON,
+    SubmitFeedbackRequestFromJSON,
+    SubmitFeedbackRequestToJSON,
+} 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 class FeedbackApi extends runtime.BaseAPI implements FeedbackApiInterface {
+
+    /**
+     * Creates request options for deleteFeedback without sending the request
+     */
+    async deleteFeedbackRequestOpts(requestParameters: DeleteFeedbackRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['feedbackId'] == null) {
+            throw new runtime.RequiredError(
+                'feedbackId',
+                'Required parameter "feedbackId" was null or undefined when calling deleteFeedback().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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
+     */
+    async deleteFeedbackRaw(requestParameters: DeleteFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteFeedbackRequestOpts(requestParameters);
+        const response = await 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
+     */
+    async deleteFeedback(requestParameters: DeleteFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteFeedbackRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for listFeedback without sending the request
+     */
+    async listFeedbackRequestOpts(requestParameters: ListFeedbackRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        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: runtime.HTTPHeaders = {};
+
+        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
+     */
+    async listFeedbackRaw(requestParameters: ListFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFeedbackEventResponse>> {
+        const requestOptions = await this.listFeedbackRequestOpts(requestParameters);
+        const response = await 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
+     */
+    async listFeedback(requestParameters: ListFeedbackRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFeedbackEventResponse> {
+        const response = await this.listFeedbackRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for submitFeedback without sending the request
+     */
+    async submitFeedbackRequestOpts(requestParameters: SubmitFeedbackOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['submitFeedbackRequest'] == null) {
+            throw new runtime.RequiredError(
+                'submitFeedbackRequest',
+                'Required parameter "submitFeedbackRequest" was null or undefined when calling submitFeedback().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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
+     */
+    async submitFeedbackRaw(requestParameters: SubmitFeedbackOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FeedbackEventResponse>> {
+        const requestOptions = await this.submitFeedbackRequestOpts(requestParameters);
+        const response = await 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
+     */
+    async submitFeedback(requestParameters: SubmitFeedbackOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FeedbackEventResponse> {
+        const response = await this.submitFeedbackRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}