@knowledge-stack/ksapi 1.23.4 → 1.24.0

package/src/apis/TagsApi.ts

@@ -68,6 +68,15 @@ export interface UpdateTagOperationRequest {
  * @interface TagsApiInterface
  */
 export interface TagsApiInterface {
+    /**
+     * Creates request options for createTag without sending the request
+     * @param {CreateTagRequest} createTagRequest 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    createTagRequestOpts(requestParameters: CreateTagOperationRequest): Promise<runtime.RequestOpts>;
+
     /**
      * Create a new tag for the current tenant. Requires ADMIN or OWNER role.
      * @summary Create Tag Handler
@@ -85,6 +94,15 @@ export interface TagsApiInterface {
      */
     createTag(requestParameters: CreateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TagResponse>;
 
+    /**
+     * Creates request options for deleteTag without sending the request
+     * @param {string} tagId 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    deleteTagRequestOpts(requestParameters: DeleteTagRequest): Promise<runtime.RequestOpts>;
+
     /**
      * Delete a tag and all its path_part associations. Requires ADMIN or OWNER role.
      * @summary Delete Tag Handler
@@ -102,6 +120,15 @@ export interface TagsApiInterface {
      */
     deleteTag(requestParameters: DeleteTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
+    /**
+     * Creates request options for getTag without sending the request
+     * @param {string} tagId 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    getTagRequestOpts(requestParameters: GetTagRequest): Promise<runtime.RequestOpts>;
+
     /**
      * Get a tag by its ID.
      * @summary Get Tag Handler
@@ -119,6 +146,16 @@ export interface TagsApiInterface {
      */
     getTag(requestParameters: GetTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TagResponse>;
 
+    /**
+     * Creates request options for listTags without sending the request
+     * @param {number} [limit] Number of items per page
+     * @param {number} [offset] Number of items to skip
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    listTagsRequestOpts(requestParameters: ListTagsRequest): Promise<runtime.RequestOpts>;
+
     /**
      * List all tags for the current tenant.
      * @summary List Tags Handler
@@ -137,6 +174,16 @@ export interface TagsApiInterface {
      */
     listTags(requestParameters: ListTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseTagResponse>;
 
+    /**
+     * Creates request options for updateTag without sending the request
+     * @param {string} tagId 
+     * @param {UpdateTagRequest} updateTagRequest 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    updateTagRequestOpts(requestParameters: UpdateTagOperationRequest): Promise<runtime.RequestOpts>;
+
     /**
      * Update a tag (name, color, and/or description). Requires ADMIN or OWNER role.
      * @summary Update Tag Handler
@@ -163,10 +210,9 @@ export interface TagsApiInterface {
 export class TagsApi extends runtime.BaseAPI implements TagsApiInterface {
 
     /**
-     * Create a new tag for the current tenant. Requires ADMIN or OWNER role.
-     * Create Tag Handler
+     * Creates request options for createTag without sending the request
      */
-    async createTagRaw(requestParameters: CreateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TagResponse>> {
+    async createTagRequestOpts(requestParameters: CreateTagOperationRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['createTagRequest'] == null) {
             throw new runtime.RequiredError(
                 'createTagRequest',
@@ -183,13 +229,22 @@ export class TagsApi extends runtime.BaseAPI implements TagsApiInterface {
 
         let urlPath = `/v1/tags`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
             body: CreateTagRequestToJSON(requestParameters['createTagRequest']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Create a new tag for the current tenant. Requires ADMIN or OWNER role.
+     * Create Tag Handler
+     */
+    async createTagRaw(requestParameters: CreateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TagResponse>> {
+        const requestOptions = await this.createTagRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => TagResponseFromJSON(jsonValue));
     }
@@ -204,10 +259,9 @@ export class TagsApi extends runtime.BaseAPI implements TagsApiInterface {
     }
 
     /**
-     * Delete a tag and all its path_part associations. Requires ADMIN or OWNER role.
-     * Delete Tag Handler
+     * Creates request options for deleteTag without sending the request
      */
-    async deleteTagRaw(requestParameters: DeleteTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+    async deleteTagRequestOpts(requestParameters: DeleteTagRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['tagId'] == null) {
             throw new runtime.RequiredError(
                 'tagId',
@@ -223,12 +277,21 @@ export class TagsApi extends runtime.BaseAPI implements TagsApiInterface {
         let urlPath = `/v1/tags/{tag_id}`;
         urlPath = urlPath.replace(`{${"tag_id"}}`, encodeURIComponent(String(requestParameters['tagId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'DELETE',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Delete a tag and all its path_part associations. Requires ADMIN or OWNER role.
+     * Delete Tag Handler
+     */
+    async deleteTagRaw(requestParameters: DeleteTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteTagRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.VoidApiResponse(response);
     }
@@ -242,10 +305,9 @@ export class TagsApi extends runtime.BaseAPI implements TagsApiInterface {
     }
 
     /**
-     * Get a tag by its ID.
-     * Get Tag Handler
+     * Creates request options for getTag without sending the request
      */
-    async getTagRaw(requestParameters: GetTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TagResponse>> {
+    async getTagRequestOpts(requestParameters: GetTagRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['tagId'] == null) {
             throw new runtime.RequiredError(
                 'tagId',
@@ -261,12 +323,21 @@ export class TagsApi extends runtime.BaseAPI implements TagsApiInterface {
         let urlPath = `/v1/tags/{tag_id}`;
         urlPath = urlPath.replace(`{${"tag_id"}}`, encodeURIComponent(String(requestParameters['tagId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Get a tag by its ID.
+     * Get Tag Handler
+     */
+    async getTagRaw(requestParameters: GetTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TagResponse>> {
+        const requestOptions = await this.getTagRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => TagResponseFromJSON(jsonValue));
     }
@@ -281,10 +352,9 @@ export class TagsApi extends runtime.BaseAPI implements TagsApiInterface {
     }
 
     /**
-     * List all tags for the current tenant.
-     * List Tags Handler
+     * Creates request options for listTags without sending the request
      */
-    async listTagsRaw(requestParameters: ListTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseTagResponse>> {
+    async listTagsRequestOpts(requestParameters: ListTagsRequest): Promise<runtime.RequestOpts> {
         const queryParameters: any = {};
 
         if (requestParameters['limit'] != null) {
@@ -300,12 +370,21 @@ export class TagsApi extends runtime.BaseAPI implements TagsApiInterface {
 
         let urlPath = `/v1/tags`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * List all tags for the current tenant.
+     * List Tags Handler
+     */
+    async listTagsRaw(requestParameters: ListTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseTagResponse>> {
+        const requestOptions = await this.listTagsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseTagResponseFromJSON(jsonValue));
     }
@@ -320,10 +399,9 @@ export class TagsApi extends runtime.BaseAPI implements TagsApiInterface {
     }
 
     /**
-     * Update a tag (name, color, and/or description). Requires ADMIN or OWNER role.
-     * Update Tag Handler
+     * Creates request options for updateTag without sending the request
      */
-    async updateTagRaw(requestParameters: UpdateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TagResponse>> {
+    async updateTagRequestOpts(requestParameters: UpdateTagOperationRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['tagId'] == null) {
             throw new runtime.RequiredError(
                 'tagId',
@@ -348,13 +426,22 @@ export class TagsApi extends runtime.BaseAPI implements TagsApiInterface {
         let urlPath = `/v1/tags/{tag_id}`;
         urlPath = urlPath.replace(`{${"tag_id"}}`, encodeURIComponent(String(requestParameters['tagId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'PATCH',
             headers: headerParameters,
             query: queryParameters,
             body: UpdateTagRequestToJSON(requestParameters['updateTagRequest']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Update a tag (name, color, and/or description). Requires ADMIN or OWNER role.
+     * Update Tag Handler
+     */
+    async updateTagRaw(requestParameters: UpdateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TagResponse>> {
+        const requestOptions = await this.updateTagRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => TagResponseFromJSON(jsonValue));
     }