@knowledge-stack/ksapi 1.58.0 → 1.59.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/.openapi-generator/FILES +8 -0
- package/README.md +9 -2
- package/dist/apis/FoldersApi.d.ts +63 -4
- package/dist/apis/FoldersApi.js +64 -3
- package/dist/apis/PathPartsApi.d.ts +45 -1
- package/dist/apis/PathPartsApi.js +44 -0
- package/dist/apis/SectionsApi.d.ts +44 -0
- package/dist/apis/SectionsApi.js +43 -0
- package/dist/apis/TenantsApi.d.ts +4 -4
- package/dist/apis/TenantsApi.js +2 -2
- package/dist/esm/apis/FoldersApi.d.ts +63 -4
- package/dist/esm/apis/FoldersApi.js +64 -3
- package/dist/esm/apis/PathPartsApi.d.ts +45 -1
- package/dist/esm/apis/PathPartsApi.js +45 -1
- package/dist/esm/apis/SectionsApi.d.ts +44 -0
- package/dist/esm/apis/SectionsApi.js +43 -0
- package/dist/esm/apis/TenantsApi.d.ts +4 -4
- package/dist/esm/apis/TenantsApi.js +2 -2
- package/dist/esm/models/AncestryResponse.d.ts +48 -0
- package/dist/esm/models/AncestryResponse.js +45 -0
- package/dist/esm/models/PathPartAncestorItem.d.ts +96 -0
- package/dist/esm/models/PathPartAncestorItem.js +77 -0
- package/dist/esm/models/SearchSortOrder.d.ts +26 -0
- package/dist/esm/models/SearchSortOrder.js +44 -0
- package/dist/esm/models/SearchablePartType.d.ts +25 -0
- package/dist/esm/models/SearchablePartType.js +43 -0
- package/dist/esm/models/index.d.ts +4 -0
- package/dist/esm/models/index.js +4 -0
- package/dist/models/AncestryResponse.d.ts +48 -0
- package/dist/models/AncestryResponse.js +53 -0
- package/dist/models/PathPartAncestorItem.d.ts +96 -0
- package/dist/models/PathPartAncestorItem.js +85 -0
- package/dist/models/SearchSortOrder.d.ts +26 -0
- package/dist/models/SearchSortOrder.js +52 -0
- package/dist/models/SearchablePartType.d.ts +25 -0
- package/dist/models/SearchablePartType.js +51 -0
- package/dist/models/index.d.ts +4 -0
- package/dist/models/index.js +4 -0
- package/docs/AncestryResponse.md +35 -0
- package/docs/FoldersApi.md +94 -4
- package/docs/PathPartAncestorItem.md +51 -0
- package/docs/PathPartsApi.md +75 -0
- package/docs/SearchSortOrder.md +33 -0
- package/docs/SearchablePartType.md +33 -0
- package/docs/SectionsApi.md +75 -0
- package/docs/TenantsApi.md +1 -1
- package/package.json +1 -1
- package/src/apis/FoldersApi.ts +136 -7
- package/src/apis/PathPartsApi.ts +88 -0
- package/src/apis/SectionsApi.ts +81 -0
- package/src/apis/TenantsApi.ts +4 -4
- package/src/models/AncestryResponse.ts +91 -0
- package/src/models/PathPartAncestorItem.ts +165 -0
- package/src/models/SearchSortOrder.ts +54 -0
- package/src/models/SearchablePartType.ts +53 -0
- package/src/models/index.ts +4 -0
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Knowledge Stack API
|
|
5
|
+
* Knowledge Stack backend API for authentication and knowledge management
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 0.1.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
import type { PartType } from './PartType';
|
|
17
|
+
import {
|
|
18
|
+
PartTypeFromJSON,
|
|
19
|
+
PartTypeFromJSONTyped,
|
|
20
|
+
PartTypeToJSON,
|
|
21
|
+
PartTypeToJSONTyped,
|
|
22
|
+
} from './PartType';
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* Single ancestor item in an ancestry chain.
|
|
26
|
+
* @export
|
|
27
|
+
* @interface PathPartAncestorItem
|
|
28
|
+
*/
|
|
29
|
+
export interface PathPartAncestorItem {
|
|
30
|
+
/**
|
|
31
|
+
* PathPart ID
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof PathPartAncestorItem
|
|
34
|
+
*/
|
|
35
|
+
pathPartId: string;
|
|
36
|
+
/**
|
|
37
|
+
* Item name
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof PathPartAncestorItem
|
|
40
|
+
*/
|
|
41
|
+
name: string;
|
|
42
|
+
/**
|
|
43
|
+
*
|
|
44
|
+
* @type {PartType}
|
|
45
|
+
* @memberof PathPartAncestorItem
|
|
46
|
+
*/
|
|
47
|
+
partType: PartType;
|
|
48
|
+
/**
|
|
49
|
+
* Parent PathPart ID
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof PathPartAncestorItem
|
|
52
|
+
*/
|
|
53
|
+
parentPathId: string | null;
|
|
54
|
+
/**
|
|
55
|
+
* ID of the underlying object
|
|
56
|
+
* @type {string}
|
|
57
|
+
* @memberof PathPartAncestorItem
|
|
58
|
+
*/
|
|
59
|
+
metadataObjId: string | null;
|
|
60
|
+
/**
|
|
61
|
+
* Full materialized path from root
|
|
62
|
+
* @type {string}
|
|
63
|
+
* @memberof PathPartAncestorItem
|
|
64
|
+
*/
|
|
65
|
+
materializedPath: string;
|
|
66
|
+
/**
|
|
67
|
+
* Whether this path part is system-managed
|
|
68
|
+
* @type {boolean}
|
|
69
|
+
* @memberof PathPartAncestorItem
|
|
70
|
+
*/
|
|
71
|
+
systemManaged: boolean;
|
|
72
|
+
/**
|
|
73
|
+
* Creation timestamp
|
|
74
|
+
* @type {Date}
|
|
75
|
+
* @memberof PathPartAncestorItem
|
|
76
|
+
*/
|
|
77
|
+
createdAt: Date;
|
|
78
|
+
/**
|
|
79
|
+
* Last update timestamp
|
|
80
|
+
* @type {Date}
|
|
81
|
+
* @memberof PathPartAncestorItem
|
|
82
|
+
*/
|
|
83
|
+
updatedAt: Date;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
/**
|
|
89
|
+
* Check if a given object implements the PathPartAncestorItem interface.
|
|
90
|
+
*/
|
|
91
|
+
export function instanceOfPathPartAncestorItem(value: object): value is PathPartAncestorItem {
|
|
92
|
+
if (!('pathPartId' in value) || value['pathPartId'] === undefined) return false;
|
|
93
|
+
if (!('name' in value) || value['name'] === undefined) return false;
|
|
94
|
+
if (!('partType' in value) || value['partType'] === undefined) return false;
|
|
95
|
+
if (!('parentPathId' in value) || value['parentPathId'] === undefined) return false;
|
|
96
|
+
if (!('metadataObjId' in value) || value['metadataObjId'] === undefined) return false;
|
|
97
|
+
if (!('materializedPath' in value) || value['materializedPath'] === undefined) return false;
|
|
98
|
+
if (!('systemManaged' in value) || value['systemManaged'] === undefined) return false;
|
|
99
|
+
if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
|
|
100
|
+
if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
|
|
101
|
+
return true;
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
export function PathPartAncestorItemFromJSON(json: any): PathPartAncestorItem {
|
|
105
|
+
return PathPartAncestorItemFromJSONTyped(json, false);
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
export function PathPartAncestorItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): PathPartAncestorItem {
|
|
109
|
+
if (json == null) {
|
|
110
|
+
return json;
|
|
111
|
+
}
|
|
112
|
+
return {
|
|
113
|
+
|
|
114
|
+
'pathPartId': json['path_part_id'],
|
|
115
|
+
'name': json['name'],
|
|
116
|
+
'partType': PartTypeFromJSON(json['part_type']),
|
|
117
|
+
'parentPathId': json['parent_path_id'],
|
|
118
|
+
'metadataObjId': json['metadata_obj_id'],
|
|
119
|
+
'materializedPath': json['materialized_path'],
|
|
120
|
+
'systemManaged': json['system_managed'],
|
|
121
|
+
'createdAt': (new Date(json['created_at'])),
|
|
122
|
+
'updatedAt': (new Date(json['updated_at'])),
|
|
123
|
+
};
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
export function PathPartAncestorItemToJSON(json: any): PathPartAncestorItem {
|
|
127
|
+
return PathPartAncestorItemToJSONTyped(json, false);
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
export function PathPartAncestorItemToJSONTyped(value?: PathPartAncestorItem | null, ignoreDiscriminator: boolean = false): any {
|
|
131
|
+
if (value == null) {
|
|
132
|
+
return value;
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
return {
|
|
136
|
+
|
|
137
|
+
'path_part_id': value['pathPartId'],
|
|
138
|
+
'name': value['name'],
|
|
139
|
+
'part_type': PartTypeToJSON(value['partType']),
|
|
140
|
+
'parent_path_id': value['parentPathId'],
|
|
141
|
+
'metadata_obj_id': value['metadataObjId'],
|
|
142
|
+
'materialized_path': value['materializedPath'],
|
|
143
|
+
'system_managed': value['systemManaged'],
|
|
144
|
+
'created_at': value['createdAt'].toISOString(),
|
|
145
|
+
'updated_at': value['updatedAt'].toISOString(),
|
|
146
|
+
};
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
export const PathPartAncestorItemPropertyValidationAttributesMap: {
|
|
150
|
+
[property: string]: {
|
|
151
|
+
maxLength?: number,
|
|
152
|
+
minLength?: number,
|
|
153
|
+
pattern?: string,
|
|
154
|
+
maximum?: number,
|
|
155
|
+
exclusiveMaximum?: boolean,
|
|
156
|
+
minimum?: number,
|
|
157
|
+
exclusiveMinimum?: boolean,
|
|
158
|
+
multipleOf?: number,
|
|
159
|
+
maxItems?: number,
|
|
160
|
+
minItems?: number,
|
|
161
|
+
uniqueItems?: boolean
|
|
162
|
+
}
|
|
163
|
+
} = {
|
|
164
|
+
}
|
|
165
|
+
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Knowledge Stack API
|
|
5
|
+
* Knowledge Stack backend API for authentication and knowledge management
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 0.1.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* Sort order options for search results.
|
|
18
|
+
* @export
|
|
19
|
+
*/
|
|
20
|
+
export const SearchSortOrder = {
|
|
21
|
+
Name: 'NAME',
|
|
22
|
+
UpdatedAt: 'UPDATED_AT',
|
|
23
|
+
CreatedAt: 'CREATED_AT'
|
|
24
|
+
} as const;
|
|
25
|
+
export type SearchSortOrder = typeof SearchSortOrder[keyof typeof SearchSortOrder];
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
export function instanceOfSearchSortOrder(value: any): boolean {
|
|
29
|
+
for (const key in SearchSortOrder) {
|
|
30
|
+
if (Object.prototype.hasOwnProperty.call(SearchSortOrder, key)) {
|
|
31
|
+
if (SearchSortOrder[key as keyof typeof SearchSortOrder] === value) {
|
|
32
|
+
return true;
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
return false;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
export function SearchSortOrderFromJSON(json: any): SearchSortOrder {
|
|
40
|
+
return SearchSortOrderFromJSONTyped(json, false);
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
export function SearchSortOrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): SearchSortOrder {
|
|
44
|
+
return json as SearchSortOrder;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
export function SearchSortOrderToJSON(value?: SearchSortOrder | null): any {
|
|
48
|
+
return value as any;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
export function SearchSortOrderToJSONTyped(value: any, ignoreDiscriminator: boolean): SearchSortOrder {
|
|
52
|
+
return value as SearchSortOrder;
|
|
53
|
+
}
|
|
54
|
+
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Knowledge Stack API
|
|
5
|
+
* Knowledge Stack backend API for authentication and knowledge management
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 0.1.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* Part types that can be searched.
|
|
18
|
+
* @export
|
|
19
|
+
*/
|
|
20
|
+
export const SearchablePartType = {
|
|
21
|
+
Folder: 'FOLDER',
|
|
22
|
+
Document: 'DOCUMENT'
|
|
23
|
+
} as const;
|
|
24
|
+
export type SearchablePartType = typeof SearchablePartType[keyof typeof SearchablePartType];
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
export function instanceOfSearchablePartType(value: any): boolean {
|
|
28
|
+
for (const key in SearchablePartType) {
|
|
29
|
+
if (Object.prototype.hasOwnProperty.call(SearchablePartType, key)) {
|
|
30
|
+
if (SearchablePartType[key as keyof typeof SearchablePartType] === value) {
|
|
31
|
+
return true;
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
return false;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
export function SearchablePartTypeFromJSON(json: any): SearchablePartType {
|
|
39
|
+
return SearchablePartTypeFromJSONTyped(json, false);
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
export function SearchablePartTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): SearchablePartType {
|
|
43
|
+
return json as SearchablePartType;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
export function SearchablePartTypeToJSON(value?: SearchablePartType | null): any {
|
|
47
|
+
return value as any;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
export function SearchablePartTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): SearchablePartType {
|
|
51
|
+
return value as SearchablePartType;
|
|
52
|
+
}
|
|
53
|
+
|
package/src/models/index.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
/* tslint:disable */
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
export * from './AcceptInviteResponse';
|
|
4
|
+
export * from './AncestryResponse';
|
|
4
5
|
export * from './ApiKeyResponse';
|
|
5
6
|
export * from './Args';
|
|
6
7
|
export * from './BrandingLogoType';
|
|
@@ -83,6 +84,7 @@ export * from './PartType';
|
|
|
83
84
|
export * from './PasswordResetRequest';
|
|
84
85
|
export * from './PasswordResetWithTokenRequest';
|
|
85
86
|
export * from './PathOrder';
|
|
87
|
+
export * from './PathPartAncestorItem';
|
|
86
88
|
export * from './PathPartResponse';
|
|
87
89
|
export * from './PathPartTagsResponse';
|
|
88
90
|
export * from './PermissionCapability';
|
|
@@ -97,7 +99,9 @@ export * from './ResolvedReferenceOutput';
|
|
|
97
99
|
export * from './RootResponse';
|
|
98
100
|
export * from './SSOInitiateResponse';
|
|
99
101
|
export * from './ScoredChunkResponse';
|
|
102
|
+
export * from './SearchSortOrder';
|
|
100
103
|
export * from './SearchType';
|
|
104
|
+
export * from './SearchablePartType';
|
|
101
105
|
export * from './SectionContentItem';
|
|
102
106
|
export * from './SectionContentItemOrChunkContentItem';
|
|
103
107
|
export * from './SectionResponse';
|