@knowledge-stack/ksapi 1.136.1 → 1.137.1

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.
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @knowledge-stack/ksapi@1.136.1
1
+ # @knowledge-stack/ksapi@1.137.1
2
2
 
3
3
  A TypeScript SDK client for the localhost API.
4
4
 
@@ -654,7 +654,7 @@ and is automatically generated by the
654
654
  [OpenAPI Generator](https://openapi-generator.tech) project:
655
655
 
656
656
  - API version: `0.1.0`
657
- - Package version: `1.136.1`
657
+ - Package version: `1.137.1`
658
658
  - Generator version: `7.21.0`
659
659
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
660
660
 
@@ -100,7 +100,7 @@ export interface DocumentsApiInterface {
100
100
  */
101
101
  deleteDocumentRequestOpts(requestParameters: DeleteDocumentRequest): Promise<runtime.RequestOpts>;
102
102
  /**
103
- * Move a document and all its contents to trash.
103
+ * Move a document and all its contents to trash. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").
104
104
  * @summary Delete Document Handler
105
105
  * @param {string} documentId
106
106
  * @param {*} [options] Override http request option.
@@ -109,7 +109,7 @@ export interface DocumentsApiInterface {
109
109
  */
110
110
  deleteDocumentRaw(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
111
111
  /**
112
- * Move a document and all its contents to trash.
112
+ * Move a document and all its contents to trash. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").
113
113
  * Delete Document Handler
114
114
  */
115
115
  deleteDocument(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -320,12 +320,12 @@ export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsAp
320
320
  */
321
321
  deleteDocumentRequestOpts(requestParameters: DeleteDocumentRequest): Promise<runtime.RequestOpts>;
322
322
  /**
323
- * Move a document and all its contents to trash.
323
+ * Move a document and all its contents to trash. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").
324
324
  * Delete Document Handler
325
325
  */
326
326
  deleteDocumentRaw(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
327
327
  /**
328
- * Move a document and all its contents to trash.
328
+ * Move a document and all its contents to trash. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").
329
329
  * Delete Document Handler
330
330
  */
331
331
  deleteDocument(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -139,7 +139,7 @@ class DocumentsApi extends runtime.BaseAPI {
139
139
  });
140
140
  }
141
141
  /**
142
- * Move a document and all its contents to trash.
142
+ * Move a document and all its contents to trash. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").
143
143
  * Delete Document Handler
144
144
  */
145
145
  deleteDocumentRaw(requestParameters, initOverrides) {
@@ -150,7 +150,7 @@ class DocumentsApi extends runtime.BaseAPI {
150
150
  });
151
151
  }
152
152
  /**
153
- * Move a document and all its contents to trash.
153
+ * Move a document and all its contents to trash. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").
154
154
  * Delete Document Handler
155
155
  */
156
156
  deleteDocument(requestParameters, initOverrides) {
@@ -100,7 +100,7 @@ export interface DocumentsApiInterface {
100
100
  */
101
101
  deleteDocumentRequestOpts(requestParameters: DeleteDocumentRequest): Promise<runtime.RequestOpts>;
102
102
  /**
103
- * Move a document and all its contents to trash.
103
+ * Move a document and all its contents to trash. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").
104
104
  * @summary Delete Document Handler
105
105
  * @param {string} documentId
106
106
  * @param {*} [options] Override http request option.
@@ -109,7 +109,7 @@ export interface DocumentsApiInterface {
109
109
  */
110
110
  deleteDocumentRaw(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
111
111
  /**
112
- * Move a document and all its contents to trash.
112
+ * Move a document and all its contents to trash. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").
113
113
  * Delete Document Handler
114
114
  */
115
115
  deleteDocument(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -320,12 +320,12 @@ export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsAp
320
320
  */
321
321
  deleteDocumentRequestOpts(requestParameters: DeleteDocumentRequest): Promise<runtime.RequestOpts>;
322
322
  /**
323
- * Move a document and all its contents to trash.
323
+ * Move a document and all its contents to trash. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").
324
324
  * Delete Document Handler
325
325
  */
326
326
  deleteDocumentRaw(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
327
327
  /**
328
- * Move a document and all its contents to trash.
328
+ * Move a document and all its contents to trash. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").
329
329
  * Delete Document Handler
330
330
  */
331
331
  deleteDocument(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -103,7 +103,7 @@ export class DocumentsApi extends runtime.BaseAPI {
103
103
  });
104
104
  }
105
105
  /**
106
- * Move a document and all its contents to trash.
106
+ * Move a document and all its contents to trash. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").
107
107
  * Delete Document Handler
108
108
  */
109
109
  deleteDocumentRaw(requestParameters, initOverrides) {
@@ -114,7 +114,7 @@ export class DocumentsApi extends runtime.BaseAPI {
114
114
  });
115
115
  }
116
116
  /**
117
- * Move a document and all its contents to trash.
117
+ * Move a document and all its contents to trash. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").
118
118
  * Delete Document Handler
119
119
  */
120
120
  deleteDocument(requestParameters, initOverrides) {
@@ -45,6 +45,12 @@ export interface ConnectionConfig {
45
45
  * @memberof ConnectionConfig
46
46
  */
47
47
  password: string;
48
+ /**
49
+ * Encrypt the connection with TLS. Enable for managed cloud databases that require it (e.g. Alibaba/Tencent RDS); leave off for trusted private-network databases. Encryption only — the server certificate is not verified.
50
+ * @type {boolean}
51
+ * @memberof ConnectionConfig
52
+ */
53
+ ssl?: boolean;
48
54
  }
49
55
  export declare const ConnectionConfigPropertyValidationAttributesMap: {
50
56
  [property: string]: {
@@ -39,6 +39,7 @@ export function ConnectionConfigFromJSONTyped(json, ignoreDiscriminator) {
39
39
  'database': json['database'],
40
40
  'username': json['username'],
41
41
  'password': json['password'],
42
+ 'ssl': json['ssl'] == null ? undefined : json['ssl'],
42
43
  };
43
44
  }
44
45
  export function ConnectionConfigToJSON(json) {
@@ -54,5 +55,6 @@ export function ConnectionConfigToJSONTyped(value, ignoreDiscriminator = false)
54
55
  'database': value['database'],
55
56
  'username': value['username'],
56
57
  'password': value['password'],
58
+ 'ssl': value['ssl'],
57
59
  };
58
60
  }
@@ -45,6 +45,12 @@ export interface ConnectionConfig {
45
45
  * @memberof ConnectionConfig
46
46
  */
47
47
  password: string;
48
+ /**
49
+ * Encrypt the connection with TLS. Enable for managed cloud databases that require it (e.g. Alibaba/Tencent RDS); leave off for trusted private-network databases. Encryption only — the server certificate is not verified.
50
+ * @type {boolean}
51
+ * @memberof ConnectionConfig
52
+ */
53
+ ssl?: boolean;
48
54
  }
49
55
  export declare const ConnectionConfigPropertyValidationAttributesMap: {
50
56
  [property: string]: {
@@ -47,6 +47,7 @@ function ConnectionConfigFromJSONTyped(json, ignoreDiscriminator) {
47
47
  'database': json['database'],
48
48
  'username': json['username'],
49
49
  'password': json['password'],
50
+ 'ssl': json['ssl'] == null ? undefined : json['ssl'],
50
51
  };
51
52
  }
52
53
  function ConnectionConfigToJSON(json) {
@@ -62,5 +63,6 @@ function ConnectionConfigToJSONTyped(value, ignoreDiscriminator = false) {
62
63
  'database': value['database'],
63
64
  'username': value['username'],
64
65
  'password': value['password'],
66
+ 'ssl': value['ssl'],
65
67
  };
66
68
  }
@@ -12,6 +12,7 @@ Name | Type
12
12
  `database` | string
13
13
  `username` | string
14
14
  `password` | string
15
+ `ssl` | boolean
15
16
 
16
17
  ## Example
17
18
 
@@ -25,6 +26,7 @@ const example = {
25
26
  "database": null,
26
27
  "username": null,
27
28
  "password": null,
29
+ "ssl": null,
28
30
  } satisfies ConnectionConfig
29
31
 
30
32
  console.log(example)
@@ -96,7 +96,7 @@ example().catch(console.error);
96
96
 
97
97
  Delete Document Handler
98
98
 
99
- Move a document and all its contents to trash.
99
+ Move a document and all its contents to trash. Requires an active document checkout held by the caller. Acquire one via &#x60;&#x60;POST /v1/documents/{id}/checkout&#x60;&#x60; first; otherwise this returns 409 Conflict (\&quot;A document checkout is required to edit this document.\&quot;).
100
100
 
101
101
  ### Example
102
102
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@knowledge-stack/ksapi",
3
- "version": "1.136.1",
3
+ "version": "1.137.1",
4
4
  "description": "OpenAPI client for @knowledge-stack/ksapi",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -165,7 +165,7 @@ export interface DocumentsApiInterface {
165
165
  deleteDocumentRequestOpts(requestParameters: DeleteDocumentRequest): Promise<runtime.RequestOpts>;
166
166
 
167
167
  /**
168
- * Move a document and all its contents to trash.
168
+ * Move a document and all its contents to trash. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").
169
169
  * @summary Delete Document Handler
170
170
  * @param {string} documentId
171
171
  * @param {*} [options] Override http request option.
@@ -175,7 +175,7 @@ export interface DocumentsApiInterface {
175
175
  deleteDocumentRaw(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
176
176
 
177
177
  /**
178
- * Move a document and all its contents to trash.
178
+ * Move a document and all its contents to trash. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").
179
179
  * Delete Document Handler
180
180
  */
181
181
  deleteDocument(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -481,7 +481,7 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
481
481
  }
482
482
 
483
483
  /**
484
- * Move a document and all its contents to trash.
484
+ * Move a document and all its contents to trash. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").
485
485
  * Delete Document Handler
486
486
  */
487
487
  async deleteDocumentRaw(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -492,7 +492,7 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
492
492
  }
493
493
 
494
494
  /**
495
- * Move a document and all its contents to trash.
495
+ * Move a document and all its contents to trash. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").
496
496
  * Delete Document Handler
497
497
  */
498
498
  async deleteDocument(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
@@ -49,6 +49,12 @@ export interface ConnectionConfig {
49
49
  * @memberof ConnectionConfig
50
50
  */
51
51
  password: string;
52
+ /**
53
+ * Encrypt the connection with TLS. Enable for managed cloud databases that require it (e.g. Alibaba/Tencent RDS); leave off for trusted private-network databases. Encryption only — the server certificate is not verified.
54
+ * @type {boolean}
55
+ * @memberof ConnectionConfig
56
+ */
57
+ ssl?: boolean;
52
58
  }
53
59
  export const ConnectionConfigPropertyValidationAttributesMap: {
54
60
  [property: string]: {
@@ -94,6 +100,7 @@ export function ConnectionConfigFromJSONTyped(json: any, ignoreDiscriminator: bo
94
100
  'database': json['database'],
95
101
  'username': json['username'],
96
102
  'password': json['password'],
103
+ 'ssl': json['ssl'] == null ? undefined : json['ssl'],
97
104
  };
98
105
  }
99
106
 
@@ -113,6 +120,7 @@ export function ConnectionConfigToJSONTyped(value?: ConnectionConfig | null, ign
113
120
  'database': value['database'],
114
121
  'username': value['username'],
115
122
  'password': value['password'],
123
+ 'ssl': value['ssl'],
116
124
  };
117
125
  }
118
126