@knowledge-stack/ksapi 1.8.0 → 1.9.0
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 +4 -0
- package/README.md +2 -2
- package/dist/apis/DocumentVersionsApi.d.ts +36 -1
- package/dist/apis/DocumentVersionsApi.js +41 -0
- package/dist/apis/FoldersApi.d.ts +38 -1
- package/dist/apis/FoldersApi.js +44 -0
- package/dist/apis/PathPartsApi.d.ts +4 -6
- package/dist/apis/PathPartsApi.js +2 -5
- package/dist/esm/apis/DocumentVersionsApi.d.ts +36 -1
- package/dist/esm/apis/DocumentVersionsApi.js +42 -1
- package/dist/esm/apis/FoldersApi.d.ts +38 -1
- package/dist/esm/apis/FoldersApi.js +45 -1
- package/dist/esm/apis/PathPartsApi.d.ts +4 -6
- package/dist/esm/apis/PathPartsApi.js +2 -5
- package/dist/esm/models/DocumentContentPathPart.d.ts +119 -0
- package/dist/esm/models/DocumentContentPathPart.js +83 -0
- package/dist/esm/models/FolderDocumentResponse.d.ts +138 -0
- package/dist/esm/models/FolderDocumentResponse.js +88 -0
- package/dist/esm/models/PaginatedResponseDocumentContentPathPart.d.ts +66 -0
- package/dist/esm/models/PaginatedResponseDocumentContentPathPart.js +70 -0
- package/dist/esm/models/PaginatedResponseFolderDocumentResponse.d.ts +66 -0
- package/dist/esm/models/PaginatedResponseFolderDocumentResponse.js +70 -0
- package/dist/esm/models/index.d.ts +4 -0
- package/dist/esm/models/index.js +4 -0
- package/dist/models/DocumentContentPathPart.d.ts +119 -0
- package/dist/models/DocumentContentPathPart.js +91 -0
- package/dist/models/FolderDocumentResponse.d.ts +138 -0
- package/dist/models/FolderDocumentResponse.js +96 -0
- package/dist/models/PaginatedResponseDocumentContentPathPart.d.ts +66 -0
- package/dist/models/PaginatedResponseDocumentContentPathPart.js +78 -0
- package/dist/models/PaginatedResponseFolderDocumentResponse.d.ts +66 -0
- package/dist/models/PaginatedResponseFolderDocumentResponse.js +78 -0
- package/dist/models/index.d.ts +4 -0
- package/dist/models/index.js +4 -0
- package/package.json +1 -1
- package/src/apis/DocumentVersionsApi.ts +82 -0
- package/src/apis/FoldersApi.ts +88 -0
- package/src/apis/PathPartsApi.ts +4 -10
- package/src/models/DocumentContentPathPart.ts +205 -0
- package/src/models/FolderDocumentResponse.ts +234 -0
- package/src/models/PaginatedResponseDocumentContentPathPart.ts +130 -0
- package/src/models/PaginatedResponseFolderDocumentResponse.ts +130 -0
- package/src/models/index.ts +4 -0
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Knowledge Stack API
|
|
3
|
+
* Knowledge Stack backend API for authentication and knowledge management
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.1.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { DocumentContentPathPart } from './DocumentContentPathPart';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface PaginatedResponseDocumentContentPathPart
|
|
17
|
+
*/
|
|
18
|
+
export interface PaginatedResponseDocumentContentPathPart {
|
|
19
|
+
/**
|
|
20
|
+
* List of items
|
|
21
|
+
* @type {Array<DocumentContentPathPart>}
|
|
22
|
+
* @memberof PaginatedResponseDocumentContentPathPart
|
|
23
|
+
*/
|
|
24
|
+
items: Array<DocumentContentPathPart>;
|
|
25
|
+
/**
|
|
26
|
+
* Total number of items
|
|
27
|
+
* @type {number}
|
|
28
|
+
* @memberof PaginatedResponseDocumentContentPathPart
|
|
29
|
+
*/
|
|
30
|
+
total: number;
|
|
31
|
+
/**
|
|
32
|
+
* Number of items per page
|
|
33
|
+
* @type {number}
|
|
34
|
+
* @memberof PaginatedResponseDocumentContentPathPart
|
|
35
|
+
*/
|
|
36
|
+
limit: number;
|
|
37
|
+
/**
|
|
38
|
+
* Number of items to skip
|
|
39
|
+
* @type {number}
|
|
40
|
+
* @memberof PaginatedResponseDocumentContentPathPart
|
|
41
|
+
*/
|
|
42
|
+
offset: number;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Check if a given object implements the PaginatedResponseDocumentContentPathPart interface.
|
|
46
|
+
*/
|
|
47
|
+
export declare function instanceOfPaginatedResponseDocumentContentPathPart(value: object): value is PaginatedResponseDocumentContentPathPart;
|
|
48
|
+
export declare function PaginatedResponseDocumentContentPathPartFromJSON(json: any): PaginatedResponseDocumentContentPathPart;
|
|
49
|
+
export declare function PaginatedResponseDocumentContentPathPartFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedResponseDocumentContentPathPart;
|
|
50
|
+
export declare function PaginatedResponseDocumentContentPathPartToJSON(json: any): PaginatedResponseDocumentContentPathPart;
|
|
51
|
+
export declare function PaginatedResponseDocumentContentPathPartToJSONTyped(value?: PaginatedResponseDocumentContentPathPart | null, ignoreDiscriminator?: boolean): any;
|
|
52
|
+
export declare const PaginatedResponseDocumentContentPathPartPropertyValidationAttributesMap: {
|
|
53
|
+
[property: string]: {
|
|
54
|
+
maxLength?: number;
|
|
55
|
+
minLength?: number;
|
|
56
|
+
pattern?: string;
|
|
57
|
+
maximum?: number;
|
|
58
|
+
exclusiveMaximum?: boolean;
|
|
59
|
+
minimum?: number;
|
|
60
|
+
exclusiveMinimum?: boolean;
|
|
61
|
+
multipleOf?: number;
|
|
62
|
+
maxItems?: number;
|
|
63
|
+
minItems?: number;
|
|
64
|
+
uniqueItems?: boolean;
|
|
65
|
+
};
|
|
66
|
+
};
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Knowledge Stack API
|
|
6
|
+
* Knowledge Stack backend API for authentication and knowledge management
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.1.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.PaginatedResponseDocumentContentPathPartPropertyValidationAttributesMap = void 0;
|
|
17
|
+
exports.instanceOfPaginatedResponseDocumentContentPathPart = instanceOfPaginatedResponseDocumentContentPathPart;
|
|
18
|
+
exports.PaginatedResponseDocumentContentPathPartFromJSON = PaginatedResponseDocumentContentPathPartFromJSON;
|
|
19
|
+
exports.PaginatedResponseDocumentContentPathPartFromJSONTyped = PaginatedResponseDocumentContentPathPartFromJSONTyped;
|
|
20
|
+
exports.PaginatedResponseDocumentContentPathPartToJSON = PaginatedResponseDocumentContentPathPartToJSON;
|
|
21
|
+
exports.PaginatedResponseDocumentContentPathPartToJSONTyped = PaginatedResponseDocumentContentPathPartToJSONTyped;
|
|
22
|
+
const DocumentContentPathPart_1 = require("./DocumentContentPathPart");
|
|
23
|
+
/**
|
|
24
|
+
* Check if a given object implements the PaginatedResponseDocumentContentPathPart interface.
|
|
25
|
+
*/
|
|
26
|
+
function instanceOfPaginatedResponseDocumentContentPathPart(value) {
|
|
27
|
+
if (!('items' in value) || value['items'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('total' in value) || value['total'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('limit' in value) || value['limit'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('offset' in value) || value['offset'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
function PaginatedResponseDocumentContentPathPartFromJSON(json) {
|
|
38
|
+
return PaginatedResponseDocumentContentPathPartFromJSONTyped(json, false);
|
|
39
|
+
}
|
|
40
|
+
function PaginatedResponseDocumentContentPathPartFromJSONTyped(json, ignoreDiscriminator) {
|
|
41
|
+
if (json == null) {
|
|
42
|
+
return json;
|
|
43
|
+
}
|
|
44
|
+
return {
|
|
45
|
+
'items': (json['items'].map(DocumentContentPathPart_1.DocumentContentPathPartFromJSON)),
|
|
46
|
+
'total': json['total'],
|
|
47
|
+
'limit': json['limit'],
|
|
48
|
+
'offset': json['offset'],
|
|
49
|
+
};
|
|
50
|
+
}
|
|
51
|
+
function PaginatedResponseDocumentContentPathPartToJSON(json) {
|
|
52
|
+
return PaginatedResponseDocumentContentPathPartToJSONTyped(json, false);
|
|
53
|
+
}
|
|
54
|
+
function PaginatedResponseDocumentContentPathPartToJSONTyped(value, ignoreDiscriminator = false) {
|
|
55
|
+
if (value == null) {
|
|
56
|
+
return value;
|
|
57
|
+
}
|
|
58
|
+
return {
|
|
59
|
+
'items': (value['items'].map(DocumentContentPathPart_1.DocumentContentPathPartToJSON)),
|
|
60
|
+
'total': value['total'],
|
|
61
|
+
'limit': value['limit'],
|
|
62
|
+
'offset': value['offset'],
|
|
63
|
+
};
|
|
64
|
+
}
|
|
65
|
+
exports.PaginatedResponseDocumentContentPathPartPropertyValidationAttributesMap = {
|
|
66
|
+
total: {
|
|
67
|
+
minimum: 0,
|
|
68
|
+
exclusiveMinimum: false,
|
|
69
|
+
},
|
|
70
|
+
limit: {
|
|
71
|
+
minimum: 1,
|
|
72
|
+
exclusiveMinimum: false,
|
|
73
|
+
},
|
|
74
|
+
offset: {
|
|
75
|
+
minimum: 0,
|
|
76
|
+
exclusiveMinimum: false,
|
|
77
|
+
},
|
|
78
|
+
};
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Knowledge Stack API
|
|
3
|
+
* Knowledge Stack backend API for authentication and knowledge management
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.1.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { FolderDocumentResponse } from './FolderDocumentResponse';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface PaginatedResponseFolderDocumentResponse
|
|
17
|
+
*/
|
|
18
|
+
export interface PaginatedResponseFolderDocumentResponse {
|
|
19
|
+
/**
|
|
20
|
+
* List of items
|
|
21
|
+
* @type {Array<FolderDocumentResponse>}
|
|
22
|
+
* @memberof PaginatedResponseFolderDocumentResponse
|
|
23
|
+
*/
|
|
24
|
+
items: Array<FolderDocumentResponse>;
|
|
25
|
+
/**
|
|
26
|
+
* Total number of items
|
|
27
|
+
* @type {number}
|
|
28
|
+
* @memberof PaginatedResponseFolderDocumentResponse
|
|
29
|
+
*/
|
|
30
|
+
total: number;
|
|
31
|
+
/**
|
|
32
|
+
* Number of items per page
|
|
33
|
+
* @type {number}
|
|
34
|
+
* @memberof PaginatedResponseFolderDocumentResponse
|
|
35
|
+
*/
|
|
36
|
+
limit: number;
|
|
37
|
+
/**
|
|
38
|
+
* Number of items to skip
|
|
39
|
+
* @type {number}
|
|
40
|
+
* @memberof PaginatedResponseFolderDocumentResponse
|
|
41
|
+
*/
|
|
42
|
+
offset: number;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Check if a given object implements the PaginatedResponseFolderDocumentResponse interface.
|
|
46
|
+
*/
|
|
47
|
+
export declare function instanceOfPaginatedResponseFolderDocumentResponse(value: object): value is PaginatedResponseFolderDocumentResponse;
|
|
48
|
+
export declare function PaginatedResponseFolderDocumentResponseFromJSON(json: any): PaginatedResponseFolderDocumentResponse;
|
|
49
|
+
export declare function PaginatedResponseFolderDocumentResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedResponseFolderDocumentResponse;
|
|
50
|
+
export declare function PaginatedResponseFolderDocumentResponseToJSON(json: any): PaginatedResponseFolderDocumentResponse;
|
|
51
|
+
export declare function PaginatedResponseFolderDocumentResponseToJSONTyped(value?: PaginatedResponseFolderDocumentResponse | null, ignoreDiscriminator?: boolean): any;
|
|
52
|
+
export declare const PaginatedResponseFolderDocumentResponsePropertyValidationAttributesMap: {
|
|
53
|
+
[property: string]: {
|
|
54
|
+
maxLength?: number;
|
|
55
|
+
minLength?: number;
|
|
56
|
+
pattern?: string;
|
|
57
|
+
maximum?: number;
|
|
58
|
+
exclusiveMaximum?: boolean;
|
|
59
|
+
minimum?: number;
|
|
60
|
+
exclusiveMinimum?: boolean;
|
|
61
|
+
multipleOf?: number;
|
|
62
|
+
maxItems?: number;
|
|
63
|
+
minItems?: number;
|
|
64
|
+
uniqueItems?: boolean;
|
|
65
|
+
};
|
|
66
|
+
};
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Knowledge Stack API
|
|
6
|
+
* Knowledge Stack backend API for authentication and knowledge management
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.1.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.PaginatedResponseFolderDocumentResponsePropertyValidationAttributesMap = void 0;
|
|
17
|
+
exports.instanceOfPaginatedResponseFolderDocumentResponse = instanceOfPaginatedResponseFolderDocumentResponse;
|
|
18
|
+
exports.PaginatedResponseFolderDocumentResponseFromJSON = PaginatedResponseFolderDocumentResponseFromJSON;
|
|
19
|
+
exports.PaginatedResponseFolderDocumentResponseFromJSONTyped = PaginatedResponseFolderDocumentResponseFromJSONTyped;
|
|
20
|
+
exports.PaginatedResponseFolderDocumentResponseToJSON = PaginatedResponseFolderDocumentResponseToJSON;
|
|
21
|
+
exports.PaginatedResponseFolderDocumentResponseToJSONTyped = PaginatedResponseFolderDocumentResponseToJSONTyped;
|
|
22
|
+
const FolderDocumentResponse_1 = require("./FolderDocumentResponse");
|
|
23
|
+
/**
|
|
24
|
+
* Check if a given object implements the PaginatedResponseFolderDocumentResponse interface.
|
|
25
|
+
*/
|
|
26
|
+
function instanceOfPaginatedResponseFolderDocumentResponse(value) {
|
|
27
|
+
if (!('items' in value) || value['items'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('total' in value) || value['total'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('limit' in value) || value['limit'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('offset' in value) || value['offset'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
function PaginatedResponseFolderDocumentResponseFromJSON(json) {
|
|
38
|
+
return PaginatedResponseFolderDocumentResponseFromJSONTyped(json, false);
|
|
39
|
+
}
|
|
40
|
+
function PaginatedResponseFolderDocumentResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
41
|
+
if (json == null) {
|
|
42
|
+
return json;
|
|
43
|
+
}
|
|
44
|
+
return {
|
|
45
|
+
'items': (json['items'].map(FolderDocumentResponse_1.FolderDocumentResponseFromJSON)),
|
|
46
|
+
'total': json['total'],
|
|
47
|
+
'limit': json['limit'],
|
|
48
|
+
'offset': json['offset'],
|
|
49
|
+
};
|
|
50
|
+
}
|
|
51
|
+
function PaginatedResponseFolderDocumentResponseToJSON(json) {
|
|
52
|
+
return PaginatedResponseFolderDocumentResponseToJSONTyped(json, false);
|
|
53
|
+
}
|
|
54
|
+
function PaginatedResponseFolderDocumentResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
55
|
+
if (value == null) {
|
|
56
|
+
return value;
|
|
57
|
+
}
|
|
58
|
+
return {
|
|
59
|
+
'items': (value['items'].map(FolderDocumentResponse_1.FolderDocumentResponseToJSON)),
|
|
60
|
+
'total': value['total'],
|
|
61
|
+
'limit': value['limit'],
|
|
62
|
+
'offset': value['offset'],
|
|
63
|
+
};
|
|
64
|
+
}
|
|
65
|
+
exports.PaginatedResponseFolderDocumentResponsePropertyValidationAttributesMap = {
|
|
66
|
+
total: {
|
|
67
|
+
minimum: 0,
|
|
68
|
+
exclusiveMinimum: false,
|
|
69
|
+
},
|
|
70
|
+
limit: {
|
|
71
|
+
minimum: 1,
|
|
72
|
+
exclusiveMinimum: false,
|
|
73
|
+
},
|
|
74
|
+
offset: {
|
|
75
|
+
minimum: 0,
|
|
76
|
+
exclusiveMinimum: false,
|
|
77
|
+
},
|
|
78
|
+
};
|
package/dist/models/index.d.ts
CHANGED
|
@@ -8,12 +8,14 @@ export * from './CreateFolderRequest';
|
|
|
8
8
|
export * from './CreatePasswordUserRequest';
|
|
9
9
|
export * from './CreateSectionRequest';
|
|
10
10
|
export * from './CreateTenantRequest';
|
|
11
|
+
export * from './DocumentContentPathPart';
|
|
11
12
|
export * from './DocumentOrigin';
|
|
12
13
|
export * from './DocumentResponse';
|
|
13
14
|
export * from './DocumentType';
|
|
14
15
|
export * from './DocumentVersionResponse';
|
|
15
16
|
export * from './EmailSentResponse';
|
|
16
17
|
export * from './EmailVerificationRequest';
|
|
18
|
+
export * from './FolderDocumentResponse';
|
|
17
19
|
export * from './FolderResponse';
|
|
18
20
|
export * from './HTTPValidationError';
|
|
19
21
|
export * from './HealthCheckResponse';
|
|
@@ -22,8 +24,10 @@ export * from './InviteResponse';
|
|
|
22
24
|
export * from './InviteStatus';
|
|
23
25
|
export * from './InviteUserRequest';
|
|
24
26
|
export * from './OAuth2Config';
|
|
27
|
+
export * from './PaginatedResponseDocumentContentPathPart';
|
|
25
28
|
export * from './PaginatedResponseDocumentResponse';
|
|
26
29
|
export * from './PaginatedResponseDocumentVersionResponse';
|
|
30
|
+
export * from './PaginatedResponseFolderDocumentResponse';
|
|
27
31
|
export * from './PaginatedResponseFolderResponse';
|
|
28
32
|
export * from './PaginatedResponseInviteResponse';
|
|
29
33
|
export * from './PaginatedResponsePathPartResponse';
|
package/dist/models/index.js
CHANGED
|
@@ -26,12 +26,14 @@ __exportStar(require("./CreateFolderRequest"), exports);
|
|
|
26
26
|
__exportStar(require("./CreatePasswordUserRequest"), exports);
|
|
27
27
|
__exportStar(require("./CreateSectionRequest"), exports);
|
|
28
28
|
__exportStar(require("./CreateTenantRequest"), exports);
|
|
29
|
+
__exportStar(require("./DocumentContentPathPart"), exports);
|
|
29
30
|
__exportStar(require("./DocumentOrigin"), exports);
|
|
30
31
|
__exportStar(require("./DocumentResponse"), exports);
|
|
31
32
|
__exportStar(require("./DocumentType"), exports);
|
|
32
33
|
__exportStar(require("./DocumentVersionResponse"), exports);
|
|
33
34
|
__exportStar(require("./EmailSentResponse"), exports);
|
|
34
35
|
__exportStar(require("./EmailVerificationRequest"), exports);
|
|
36
|
+
__exportStar(require("./FolderDocumentResponse"), exports);
|
|
35
37
|
__exportStar(require("./FolderResponse"), exports);
|
|
36
38
|
__exportStar(require("./HTTPValidationError"), exports);
|
|
37
39
|
__exportStar(require("./HealthCheckResponse"), exports);
|
|
@@ -40,8 +42,10 @@ __exportStar(require("./InviteResponse"), exports);
|
|
|
40
42
|
__exportStar(require("./InviteStatus"), exports);
|
|
41
43
|
__exportStar(require("./InviteUserRequest"), exports);
|
|
42
44
|
__exportStar(require("./OAuth2Config"), exports);
|
|
45
|
+
__exportStar(require("./PaginatedResponseDocumentContentPathPart"), exports);
|
|
43
46
|
__exportStar(require("./PaginatedResponseDocumentResponse"), exports);
|
|
44
47
|
__exportStar(require("./PaginatedResponseDocumentVersionResponse"), exports);
|
|
48
|
+
__exportStar(require("./PaginatedResponseFolderDocumentResponse"), exports);
|
|
45
49
|
__exportStar(require("./PaginatedResponseFolderResponse"), exports);
|
|
46
50
|
__exportStar(require("./PaginatedResponseInviteResponse"), exports);
|
|
47
51
|
__exportStar(require("./PaginatedResponsePathPartResponse"), exports);
|
package/package.json
CHANGED
|
@@ -17,6 +17,7 @@ import * as runtime from '../runtime';
|
|
|
17
17
|
import type {
|
|
18
18
|
DocumentVersionResponse,
|
|
19
19
|
HTTPValidationError,
|
|
20
|
+
PaginatedResponseDocumentContentPathPart,
|
|
20
21
|
PaginatedResponseDocumentVersionResponse,
|
|
21
22
|
} from '../models/index';
|
|
22
23
|
import {
|
|
@@ -24,6 +25,8 @@ import {
|
|
|
24
25
|
DocumentVersionResponseToJSON,
|
|
25
26
|
HTTPValidationErrorFromJSON,
|
|
26
27
|
HTTPValidationErrorToJSON,
|
|
28
|
+
PaginatedResponseDocumentContentPathPartFromJSON,
|
|
29
|
+
PaginatedResponseDocumentContentPathPartToJSON,
|
|
27
30
|
PaginatedResponseDocumentVersionResponseFromJSON,
|
|
28
31
|
PaginatedResponseDocumentVersionResponseToJSON,
|
|
29
32
|
} from '../models/index';
|
|
@@ -43,6 +46,14 @@ export interface GetDocumentVersionRequest {
|
|
|
43
46
|
ksUat?: string;
|
|
44
47
|
}
|
|
45
48
|
|
|
49
|
+
export interface GetDocumentVersionContentsRequest {
|
|
50
|
+
versionId: string;
|
|
51
|
+
sectionId?: string;
|
|
52
|
+
limit?: number;
|
|
53
|
+
offset?: number;
|
|
54
|
+
ksUat?: string;
|
|
55
|
+
}
|
|
56
|
+
|
|
46
57
|
export interface ListDocumentVersionsRequest {
|
|
47
58
|
documentId: string;
|
|
48
59
|
limit?: number;
|
|
@@ -108,6 +119,26 @@ export interface DocumentVersionsApiInterface {
|
|
|
108
119
|
*/
|
|
109
120
|
getDocumentVersion(requestParameters: GetDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
|
|
110
121
|
|
|
122
|
+
/**
|
|
123
|
+
* List all sections and chunks for a document version in depth-first logical order. Returns a flat paginated list that can be used to reconstruct the section/chunk hierarchy with content. Sections include page_number; chunks include content, chunk_type, and chunk_metadata.
|
|
124
|
+
* @summary Get Document Version Contents Handler
|
|
125
|
+
* @param {string} versionId DocumentVersion ID
|
|
126
|
+
* @param {string} [sectionId] Optional section ID to scope traversal to a subtree
|
|
127
|
+
* @param {number} [limit] Number of items per page
|
|
128
|
+
* @param {number} [offset] Number of items to skip
|
|
129
|
+
* @param {string} [ksUat]
|
|
130
|
+
* @param {*} [options] Override http request option.
|
|
131
|
+
* @throws {RequiredError}
|
|
132
|
+
* @memberof DocumentVersionsApiInterface
|
|
133
|
+
*/
|
|
134
|
+
getDocumentVersionContentsRaw(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentContentPathPart>>;
|
|
135
|
+
|
|
136
|
+
/**
|
|
137
|
+
* List all sections and chunks for a document version in depth-first logical order. Returns a flat paginated list that can be used to reconstruct the section/chunk hierarchy with content. Sections include page_number; chunks include content, chunk_type, and chunk_metadata.
|
|
138
|
+
* Get Document Version Contents Handler
|
|
139
|
+
*/
|
|
140
|
+
getDocumentVersionContents(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentContentPathPart>;
|
|
141
|
+
|
|
111
142
|
/**
|
|
112
143
|
* List all versions for a document. Returns versions ordered by version number ascending (v0, v1, v2...).
|
|
113
144
|
* @summary List Document Versions Handler
|
|
@@ -250,6 +281,57 @@ export class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVers
|
|
|
250
281
|
return await response.value();
|
|
251
282
|
}
|
|
252
283
|
|
|
284
|
+
/**
|
|
285
|
+
* List all sections and chunks for a document version in depth-first logical order. Returns a flat paginated list that can be used to reconstruct the section/chunk hierarchy with content. Sections include page_number; chunks include content, chunk_type, and chunk_metadata.
|
|
286
|
+
* Get Document Version Contents Handler
|
|
287
|
+
*/
|
|
288
|
+
async getDocumentVersionContentsRaw(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentContentPathPart>> {
|
|
289
|
+
if (requestParameters['versionId'] == null) {
|
|
290
|
+
throw new runtime.RequiredError(
|
|
291
|
+
'versionId',
|
|
292
|
+
'Required parameter "versionId" was null or undefined when calling getDocumentVersionContents().'
|
|
293
|
+
);
|
|
294
|
+
}
|
|
295
|
+
|
|
296
|
+
const queryParameters: any = {};
|
|
297
|
+
|
|
298
|
+
if (requestParameters['sectionId'] != null) {
|
|
299
|
+
queryParameters['section_id'] = requestParameters['sectionId'];
|
|
300
|
+
}
|
|
301
|
+
|
|
302
|
+
if (requestParameters['limit'] != null) {
|
|
303
|
+
queryParameters['limit'] = requestParameters['limit'];
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
if (requestParameters['offset'] != null) {
|
|
307
|
+
queryParameters['offset'] = requestParameters['offset'];
|
|
308
|
+
}
|
|
309
|
+
|
|
310
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
let urlPath = `/v1/document_versions/{version_id}/contents`;
|
|
314
|
+
urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
|
|
315
|
+
|
|
316
|
+
const response = await this.request({
|
|
317
|
+
path: urlPath,
|
|
318
|
+
method: 'GET',
|
|
319
|
+
headers: headerParameters,
|
|
320
|
+
query: queryParameters,
|
|
321
|
+
}, initOverrides);
|
|
322
|
+
|
|
323
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseDocumentContentPathPartFromJSON(jsonValue));
|
|
324
|
+
}
|
|
325
|
+
|
|
326
|
+
/**
|
|
327
|
+
* List all sections and chunks for a document version in depth-first logical order. Returns a flat paginated list that can be used to reconstruct the section/chunk hierarchy with content. Sections include page_number; chunks include content, chunk_type, and chunk_metadata.
|
|
328
|
+
* Get Document Version Contents Handler
|
|
329
|
+
*/
|
|
330
|
+
async getDocumentVersionContents(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentContentPathPart> {
|
|
331
|
+
const response = await this.getDocumentVersionContentsRaw(requestParameters, initOverrides);
|
|
332
|
+
return await response.value();
|
|
333
|
+
}
|
|
334
|
+
|
|
253
335
|
/**
|
|
254
336
|
* List all versions for a document. Returns versions ordered by version number ascending (v0, v1, v2...).
|
|
255
337
|
* List Document Versions Handler
|
package/src/apis/FoldersApi.ts
CHANGED
|
@@ -18,6 +18,7 @@ import type {
|
|
|
18
18
|
CreateFolderRequest,
|
|
19
19
|
FolderResponse,
|
|
20
20
|
HTTPValidationError,
|
|
21
|
+
PaginatedResponseFolderDocumentResponse,
|
|
21
22
|
PaginatedResponseFolderResponse,
|
|
22
23
|
PathOrder,
|
|
23
24
|
UpdateFolderRequest,
|
|
@@ -29,6 +30,8 @@ import {
|
|
|
29
30
|
FolderResponseToJSON,
|
|
30
31
|
HTTPValidationErrorFromJSON,
|
|
31
32
|
HTTPValidationErrorToJSON,
|
|
33
|
+
PaginatedResponseFolderDocumentResponseFromJSON,
|
|
34
|
+
PaginatedResponseFolderDocumentResponseToJSON,
|
|
32
35
|
PaginatedResponseFolderResponseFromJSON,
|
|
33
36
|
PaginatedResponseFolderResponseToJSON,
|
|
34
37
|
PathOrderFromJSON,
|
|
@@ -52,6 +55,15 @@ export interface GetFolderRequest {
|
|
|
52
55
|
ksUat?: string;
|
|
53
56
|
}
|
|
54
57
|
|
|
58
|
+
export interface ListFolderContentsRequest {
|
|
59
|
+
folderId: string;
|
|
60
|
+
maxDepth?: number;
|
|
61
|
+
sortOrder?: PathOrder;
|
|
62
|
+
limit?: number;
|
|
63
|
+
offset?: number;
|
|
64
|
+
ksUat?: string;
|
|
65
|
+
}
|
|
66
|
+
|
|
55
67
|
export interface ListFoldersRequest {
|
|
56
68
|
parentId?: string;
|
|
57
69
|
sortOrder?: PathOrder;
|
|
@@ -124,6 +136,27 @@ export interface FoldersApiInterface {
|
|
|
124
136
|
*/
|
|
125
137
|
getFolder(requestParameters: GetFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
|
|
126
138
|
|
|
139
|
+
/**
|
|
140
|
+
* List all contents (folders and documents) under a folder. Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
141
|
+
* @summary List Folder Contents Handler
|
|
142
|
+
* @param {string} folderId
|
|
143
|
+
* @param {number} [maxDepth] Maximum depth to traverse (1=direct children, default: 1)
|
|
144
|
+
* @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
|
|
145
|
+
* @param {number} [limit] Number of items per page
|
|
146
|
+
* @param {number} [offset] Number of items to skip
|
|
147
|
+
* @param {string} [ksUat]
|
|
148
|
+
* @param {*} [options] Override http request option.
|
|
149
|
+
* @throws {RequiredError}
|
|
150
|
+
* @memberof FoldersApiInterface
|
|
151
|
+
*/
|
|
152
|
+
listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFolderDocumentResponse>>;
|
|
153
|
+
|
|
154
|
+
/**
|
|
155
|
+
* List all contents (folders and documents) under a folder. Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
156
|
+
* List Folder Contents Handler
|
|
157
|
+
*/
|
|
158
|
+
listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderDocumentResponse>;
|
|
159
|
+
|
|
127
160
|
/**
|
|
128
161
|
* List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_id is not provided, lists folders in the root folder.
|
|
129
162
|
* @summary List Folders Handler
|
|
@@ -287,6 +320,61 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
|
287
320
|
return await response.value();
|
|
288
321
|
}
|
|
289
322
|
|
|
323
|
+
/**
|
|
324
|
+
* List all contents (folders and documents) under a folder. Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
325
|
+
* List Folder Contents Handler
|
|
326
|
+
*/
|
|
327
|
+
async listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFolderDocumentResponse>> {
|
|
328
|
+
if (requestParameters['folderId'] == null) {
|
|
329
|
+
throw new runtime.RequiredError(
|
|
330
|
+
'folderId',
|
|
331
|
+
'Required parameter "folderId" was null or undefined when calling listFolderContents().'
|
|
332
|
+
);
|
|
333
|
+
}
|
|
334
|
+
|
|
335
|
+
const queryParameters: any = {};
|
|
336
|
+
|
|
337
|
+
if (requestParameters['maxDepth'] != null) {
|
|
338
|
+
queryParameters['max_depth'] = requestParameters['maxDepth'];
|
|
339
|
+
}
|
|
340
|
+
|
|
341
|
+
if (requestParameters['sortOrder'] != null) {
|
|
342
|
+
queryParameters['sort_order'] = requestParameters['sortOrder'];
|
|
343
|
+
}
|
|
344
|
+
|
|
345
|
+
if (requestParameters['limit'] != null) {
|
|
346
|
+
queryParameters['limit'] = requestParameters['limit'];
|
|
347
|
+
}
|
|
348
|
+
|
|
349
|
+
if (requestParameters['offset'] != null) {
|
|
350
|
+
queryParameters['offset'] = requestParameters['offset'];
|
|
351
|
+
}
|
|
352
|
+
|
|
353
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
let urlPath = `/v1/folders/{folder_id}/contents`;
|
|
357
|
+
urlPath = urlPath.replace(`{${"folder_id"}}`, encodeURIComponent(String(requestParameters['folderId'])));
|
|
358
|
+
|
|
359
|
+
const response = await this.request({
|
|
360
|
+
path: urlPath,
|
|
361
|
+
method: 'GET',
|
|
362
|
+
headers: headerParameters,
|
|
363
|
+
query: queryParameters,
|
|
364
|
+
}, initOverrides);
|
|
365
|
+
|
|
366
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseFolderDocumentResponseFromJSON(jsonValue));
|
|
367
|
+
}
|
|
368
|
+
|
|
369
|
+
/**
|
|
370
|
+
* List all contents (folders and documents) under a folder. Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
371
|
+
* List Folder Contents Handler
|
|
372
|
+
*/
|
|
373
|
+
async listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderDocumentResponse> {
|
|
374
|
+
const response = await this.listFolderContentsRaw(requestParameters, initOverrides);
|
|
375
|
+
return await response.value();
|
|
376
|
+
}
|
|
377
|
+
|
|
290
378
|
/**
|
|
291
379
|
* List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_id is not provided, lists folders in the root folder.
|
|
292
380
|
* List Folders Handler
|
package/src/apis/PathPartsApi.ts
CHANGED
|
@@ -38,7 +38,6 @@ export interface GetPathPartRequest {
|
|
|
38
38
|
|
|
39
39
|
export interface ListPathPartsRequest {
|
|
40
40
|
parentId?: string;
|
|
41
|
-
includeDocuments?: boolean;
|
|
42
41
|
maxDepth?: number;
|
|
43
42
|
sortOrder?: PathOrder;
|
|
44
43
|
limit?: number;
|
|
@@ -71,10 +70,9 @@ export interface PathPartsApiInterface {
|
|
|
71
70
|
getPathPart(requestParameters: GetPathPartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartResponse>;
|
|
72
71
|
|
|
73
72
|
/**
|
|
74
|
-
* List path parts under a parent with
|
|
73
|
+
* List path parts (folders) under a parent with traversal. This is a generic endpoint for traversing the folder hierarchy. It returns only FOLDER type path parts. - If parent_id is not provided, lists contents of the root folder. - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT. For listing folder contents that includes documents with enriched metadata, use GET /folders/{folder_id}/contents instead.
|
|
75
74
|
* @summary List Path Parts Handler
|
|
76
75
|
* @param {string} [parentId] Parent PathPart ID (defaults to root)
|
|
77
|
-
* @param {boolean} [includeDocuments] Include documents in results (default: False, folders only)
|
|
78
76
|
* @param {number} [maxDepth] Maximum depth to traverse (1 = direct children, default: 1)
|
|
79
77
|
* @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
|
|
80
78
|
* @param {number} [limit] Number of items per page
|
|
@@ -87,7 +85,7 @@ export interface PathPartsApiInterface {
|
|
|
87
85
|
listPathPartsRaw(requestParameters: ListPathPartsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponsePathPartResponse>>;
|
|
88
86
|
|
|
89
87
|
/**
|
|
90
|
-
* List path parts under a parent with
|
|
88
|
+
* List path parts (folders) under a parent with traversal. This is a generic endpoint for traversing the folder hierarchy. It returns only FOLDER type path parts. - If parent_id is not provided, lists contents of the root folder. - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT. For listing folder contents that includes documents with enriched metadata, use GET /folders/{folder_id}/contents instead.
|
|
91
89
|
* List Path Parts Handler
|
|
92
90
|
*/
|
|
93
91
|
listPathParts(requestParameters: ListPathPartsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponsePathPartResponse>;
|
|
@@ -139,7 +137,7 @@ export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterfa
|
|
|
139
137
|
}
|
|
140
138
|
|
|
141
139
|
/**
|
|
142
|
-
* List path parts under a parent with
|
|
140
|
+
* List path parts (folders) under a parent with traversal. This is a generic endpoint for traversing the folder hierarchy. It returns only FOLDER type path parts. - If parent_id is not provided, lists contents of the root folder. - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT. For listing folder contents that includes documents with enriched metadata, use GET /folders/{folder_id}/contents instead.
|
|
143
141
|
* List Path Parts Handler
|
|
144
142
|
*/
|
|
145
143
|
async listPathPartsRaw(requestParameters: ListPathPartsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponsePathPartResponse>> {
|
|
@@ -149,10 +147,6 @@ export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterfa
|
|
|
149
147
|
queryParameters['parent_id'] = requestParameters['parentId'];
|
|
150
148
|
}
|
|
151
149
|
|
|
152
|
-
if (requestParameters['includeDocuments'] != null) {
|
|
153
|
-
queryParameters['include_documents'] = requestParameters['includeDocuments'];
|
|
154
|
-
}
|
|
155
|
-
|
|
156
150
|
if (requestParameters['maxDepth'] != null) {
|
|
157
151
|
queryParameters['max_depth'] = requestParameters['maxDepth'];
|
|
158
152
|
}
|
|
@@ -185,7 +179,7 @@ export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterfa
|
|
|
185
179
|
}
|
|
186
180
|
|
|
187
181
|
/**
|
|
188
|
-
* List path parts under a parent with
|
|
182
|
+
* List path parts (folders) under a parent with traversal. This is a generic endpoint for traversing the folder hierarchy. It returns only FOLDER type path parts. - If parent_id is not provided, lists contents of the root folder. - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT. For listing folder contents that includes documents with enriched metadata, use GET /folders/{folder_id}/contents instead.
|
|
189
183
|
* List Path Parts Handler
|
|
190
184
|
*/
|
|
191
185
|
async listPathParts(requestParameters: ListPathPartsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponsePathPartResponse> {
|