@knowledge-stack/ksapi 1.84.0 → 1.85.0

package/docs/DocumentCheckoutApi.md

@@ -0,0 +1,233 @@
+# DocumentCheckoutApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**acquireDocumentCheckout**](DocumentCheckoutApi.md#acquiredocumentcheckout) | **POST** /v1/documents/{path_part_id}/checkout | Acquire Document Checkout Handler |
+| [**getDocumentCheckout**](DocumentCheckoutApi.md#getdocumentcheckout) | **GET** /v1/documents/{path_part_id}/checkout | Get Document Checkout Handler |
+| [**releaseDocumentCheckout**](DocumentCheckoutApi.md#releasedocumentcheckout) | **DELETE** /v1/documents/{path_part_id}/checkout | Release Document Checkout Handler |
+
+
+
+## acquireDocumentCheckout
+
+> DocumentCheckoutResponse acquireDocumentCheckout(pathPartId, authorization, ksUat)
+
+Acquire Document Checkout Handler
+
+Acquire a write lock on the document.  If the caller already holds the lock, re-acquire refreshes ``acquired_at``; the response is 200 in both cases. If another user holds the lock, returns 409. Locks have no TTL — they persist until released by the holder.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentCheckoutApi,
+} from '@knowledge-stack/ksapi';
+import type { AcquireDocumentCheckoutRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new DocumentCheckoutApi();
+
+  const body = {
+    // string | Document\'s PathPart ID
+    pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies AcquireDocumentCheckoutRequest;
+
+  try {
+    const data = await api.acquireDocumentCheckout(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pathPartId** | `string` | Document\'s PathPart ID | [Defaults to `undefined`] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**DocumentCheckoutResponse**](DocumentCheckoutResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getDocumentCheckout
+
+> DocumentCheckoutResponse getDocumentCheckout(pathPartId, authorization, ksUat)
+
+Get Document Checkout Handler
+
+Get the active checkout for the document.  404 if no active checkout exists. The holder can always GET their own lock regardless of current path permissions (parallel to the release holder-bypass).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentCheckoutApi,
+} from '@knowledge-stack/ksapi';
+import type { GetDocumentCheckoutRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new DocumentCheckoutApi();
+
+  const body = {
+    // string | Document\'s PathPart ID
+    pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies GetDocumentCheckoutRequest;
+
+  try {
+    const data = await api.getDocumentCheckout(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pathPartId** | `string` | Document\'s PathPart ID | [Defaults to `undefined`] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**DocumentCheckoutResponse**](DocumentCheckoutResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## releaseDocumentCheckout
+
+> releaseDocumentCheckout(pathPartId, authorization, ksUat)
+
+Release Document Checkout Handler
+
+Release the write lock on the document.  Only the holder may release the lock; others receive 403. The holder can always release regardless of current path permissions (in case a folder move relocated the doc to a path the holder can no longer write to).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentCheckoutApi,
+} from '@knowledge-stack/ksapi';
+import type { ReleaseDocumentCheckoutRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new DocumentCheckoutApi();
+
+  const body = {
+    // string | Document\'s PathPart ID
+    pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies ReleaseDocumentCheckoutRequest;
+
+  try {
+    const data = await api.releaseDocumentCheckout(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pathPartId** | `string` | Document\'s PathPart ID | [Defaults to `undefined`] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/DocumentCheckoutResponse.md

@@ -0,0 +1,41 @@
+
+# DocumentCheckoutResponse
+
+Active checkout state on a document.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`tenantId` | string
+`pathPartId` | string
+`userId` | string
+`acquiredAt` | Date
+
+## Example
+
+```typescript
+import type { DocumentCheckoutResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "tenantId": null,
+  "pathPartId": null,
+  "userId": null,
+  "acquiredAt": null,
+} satisfies DocumentCheckoutResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as DocumentCheckoutResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/DocumentResponse.md

@@ -25,6 +25,7 @@ Name | Type
 `updatedAt` | Date
 `tags` | [Array<TagResponse>](TagResponse.md)
 `canWrite` | boolean
+`checkout` | [DocumentCheckoutResponse](DocumentCheckoutResponse.md)
 
 ## Example
 
@@ -51,6 +52,7 @@ const example = {
   "updatedAt": null,
   "tags": null,
   "canWrite": null,
+  "checkout": null,
 } satisfies DocumentResponse
 
 console.log(example)

package/docs/FolderResponseOrDocumentResponse.md

@@ -24,6 +24,7 @@ Name | Type
 `activeVersionId` | string
 `activeVersion` | [DocumentVersionResponse](DocumentVersionResponse.md)
 `ownerTenantUserId` | string
+`checkout` | [DocumentCheckoutResponse](DocumentCheckoutResponse.md)
 
 ## Example
 
@@ -50,6 +51,7 @@ const example = {
   "activeVersionId": null,
   "activeVersion": null,
   "ownerTenantUserId": null,
+  "checkout": null,
 } satisfies FolderResponseOrDocumentResponse
 
 console.log(example)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowledge-stack/ksapi",
-  "version": "1.84.0",
+  "version": "1.85.0",
   "description": "OpenAPI client for @knowledge-stack/ksapi",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/DocumentCheckoutApi.ts

@@ -0,0 +1,296 @@
+/* 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 {
+  DocumentCheckoutResponse,
+  HTTPValidationError,
+} from '../models/index';
+import {
+    DocumentCheckoutResponseFromJSON,
+    DocumentCheckoutResponseToJSON,
+    HTTPValidationErrorFromJSON,
+    HTTPValidationErrorToJSON,
+} from '../models/index';
+
+export interface AcquireDocumentCheckoutRequest {
+    pathPartId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+
+export interface GetDocumentCheckoutRequest {
+    pathPartId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+
+export interface ReleaseDocumentCheckoutRequest {
+    pathPartId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+
+/**
+ * DocumentCheckoutApi - interface
+ * 
+ * @export
+ * @interface DocumentCheckoutApiInterface
+ */
+export interface DocumentCheckoutApiInterface {
+    /**
+     * Creates request options for acquireDocumentCheckout without sending the request
+     * @param {string} pathPartId Document\'s PathPart ID
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof DocumentCheckoutApiInterface
+     */
+    acquireDocumentCheckoutRequestOpts(requestParameters: AcquireDocumentCheckoutRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Acquire a write lock on the document.  If the caller already holds the lock, re-acquire refreshes ``acquired_at``; the response is 200 in both cases. If another user holds the lock, returns 409. Locks have no TTL — they persist until released by the holder.
+     * @summary Acquire Document Checkout Handler
+     * @param {string} pathPartId Document\&#39;s PathPart ID
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentCheckoutApiInterface
+     */
+    acquireDocumentCheckoutRaw(requestParameters: AcquireDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentCheckoutResponse>>;
+
+    /**
+     * Acquire a write lock on the document.  If the caller already holds the lock, re-acquire refreshes ``acquired_at``; the response is 200 in both cases. If another user holds the lock, returns 409. Locks have no TTL — they persist until released by the holder.
+     * Acquire Document Checkout Handler
+     */
+    acquireDocumentCheckout(requestParameters: AcquireDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentCheckoutResponse>;
+
+    /**
+     * Creates request options for getDocumentCheckout without sending the request
+     * @param {string} pathPartId Document\&#39;s PathPart ID
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof DocumentCheckoutApiInterface
+     */
+    getDocumentCheckoutRequestOpts(requestParameters: GetDocumentCheckoutRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Get the active checkout for the document.  404 if no active checkout exists. The holder can always GET their own lock regardless of current path permissions (parallel to the release holder-bypass).
+     * @summary Get Document Checkout Handler
+     * @param {string} pathPartId Document\&#39;s PathPart ID
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentCheckoutApiInterface
+     */
+    getDocumentCheckoutRaw(requestParameters: GetDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentCheckoutResponse>>;
+
+    /**
+     * Get the active checkout for the document.  404 if no active checkout exists. The holder can always GET their own lock regardless of current path permissions (parallel to the release holder-bypass).
+     * Get Document Checkout Handler
+     */
+    getDocumentCheckout(requestParameters: GetDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentCheckoutResponse>;
+
+    /**
+     * Creates request options for releaseDocumentCheckout without sending the request
+     * @param {string} pathPartId Document\&#39;s PathPart ID
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof DocumentCheckoutApiInterface
+     */
+    releaseDocumentCheckoutRequestOpts(requestParameters: ReleaseDocumentCheckoutRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Release the write lock on the document.  Only the holder may release the lock; others receive 403. The holder can always release regardless of current path permissions (in case a folder move relocated the doc to a path the holder can no longer write to).
+     * @summary Release Document Checkout Handler
+     * @param {string} pathPartId Document\&#39;s PathPart ID
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentCheckoutApiInterface
+     */
+    releaseDocumentCheckoutRaw(requestParameters: ReleaseDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Release the write lock on the document.  Only the holder may release the lock; others receive 403. The holder can always release regardless of current path permissions (in case a folder move relocated the doc to a path the holder can no longer write to).
+     * Release Document Checkout Handler
+     */
+    releaseDocumentCheckout(requestParameters: ReleaseDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+}
+
+/**
+ * 
+ */
+export class DocumentCheckoutApi extends runtime.BaseAPI implements DocumentCheckoutApiInterface {
+
+    /**
+     * Creates request options for acquireDocumentCheckout without sending the request
+     */
+    async acquireDocumentCheckoutRequestOpts(requestParameters: AcquireDocumentCheckoutRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['pathPartId'] == null) {
+            throw new runtime.RequiredError(
+                'pathPartId',
+                'Required parameter "pathPartId" was null or undefined when calling acquireDocumentCheckout().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['authorization'] != null) {
+            headerParameters['authorization'] = String(requestParameters['authorization']);
+        }
+
+
+        let urlPath = `/v1/documents/{path_part_id}/checkout`;
+        urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Acquire a write lock on the document.  If the caller already holds the lock, re-acquire refreshes ``acquired_at``; the response is 200 in both cases. If another user holds the lock, returns 409. Locks have no TTL — they persist until released by the holder.
+     * Acquire Document Checkout Handler
+     */
+    async acquireDocumentCheckoutRaw(requestParameters: AcquireDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentCheckoutResponse>> {
+        const requestOptions = await this.acquireDocumentCheckoutRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DocumentCheckoutResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Acquire a write lock on the document.  If the caller already holds the lock, re-acquire refreshes ``acquired_at``; the response is 200 in both cases. If another user holds the lock, returns 409. Locks have no TTL — they persist until released by the holder.
+     * Acquire Document Checkout Handler
+     */
+    async acquireDocumentCheckout(requestParameters: AcquireDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentCheckoutResponse> {
+        const response = await this.acquireDocumentCheckoutRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getDocumentCheckout without sending the request
+     */
+    async getDocumentCheckoutRequestOpts(requestParameters: GetDocumentCheckoutRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['pathPartId'] == null) {
+            throw new runtime.RequiredError(
+                'pathPartId',
+                'Required parameter "pathPartId" was null or undefined when calling getDocumentCheckout().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['authorization'] != null) {
+            headerParameters['authorization'] = String(requestParameters['authorization']);
+        }
+
+
+        let urlPath = `/v1/documents/{path_part_id}/checkout`;
+        urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get the active checkout for the document.  404 if no active checkout exists. The holder can always GET their own lock regardless of current path permissions (parallel to the release holder-bypass).
+     * Get Document Checkout Handler
+     */
+    async getDocumentCheckoutRaw(requestParameters: GetDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentCheckoutResponse>> {
+        const requestOptions = await this.getDocumentCheckoutRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DocumentCheckoutResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Get the active checkout for the document.  404 if no active checkout exists. The holder can always GET their own lock regardless of current path permissions (parallel to the release holder-bypass).
+     * Get Document Checkout Handler
+     */
+    async getDocumentCheckout(requestParameters: GetDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentCheckoutResponse> {
+        const response = await this.getDocumentCheckoutRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for releaseDocumentCheckout without sending the request
+     */
+    async releaseDocumentCheckoutRequestOpts(requestParameters: ReleaseDocumentCheckoutRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['pathPartId'] == null) {
+            throw new runtime.RequiredError(
+                'pathPartId',
+                'Required parameter "pathPartId" was null or undefined when calling releaseDocumentCheckout().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['authorization'] != null) {
+            headerParameters['authorization'] = String(requestParameters['authorization']);
+        }
+
+
+        let urlPath = `/v1/documents/{path_part_id}/checkout`;
+        urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Release the write lock on the document.  Only the holder may release the lock; others receive 403. The holder can always release regardless of current path permissions (in case a folder move relocated the doc to a path the holder can no longer write to).
+     * Release Document Checkout Handler
+     */
+    async releaseDocumentCheckoutRaw(requestParameters: ReleaseDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.releaseDocumentCheckoutRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Release the write lock on the document.  Only the holder may release the lock; others receive 403. The holder can always release regardless of current path permissions (in case a folder move relocated the doc to a path the holder can no longer write to).
+     * Release Document Checkout Handler
+     */
+    async releaseDocumentCheckout(requestParameters: ReleaseDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.releaseDocumentCheckoutRaw(requestParameters, initOverrides);
+    }
+
+}

package/src/apis/index.ts

@@ -6,6 +6,7 @@ export * from './AuthApi';
 export * from './ChunkLineagesApi';
 export * from './ChunksApi';
 export * from './DefaultApi';
+export * from './DocumentCheckoutApi';
 export * from './DocumentVersionsApi';
 export * from './DocumentsApi';
 export * from './FeaturesApi';