@incomy/platform-sdk 0.6.1-beta.2501 → 0.6.1-beta.2532
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/dist/services/hub/index.d.ts +3 -0
- package/dist/services/hub/models/Document.d.ts +6 -0
- package/dist/services/hub/models/DocumentEdit.d.ts +6 -0
- package/dist/services/hub/models/DocumentEdit.js +1 -0
- package/dist/services/hub/models/DocumentLinkTarget.d.ts +10 -0
- package/dist/services/hub/models/DocumentLinkTarget.js +1 -0
- package/dist/services/hub/models/DocumentPaginatedList.d.ts +15 -0
- package/dist/services/hub/models/DocumentPaginatedList.js +1 -0
- package/dist/services/hub/services/ProjectDocumentsService.d.ts +35 -5
- package/dist/services/hub/services/ProjectDocumentsService.js +46 -4
- package/meta.json +5 -5
- package/package.json +1 -1
|
@@ -24,7 +24,10 @@ export type { CompanyInsert } from './models/CompanyInsert';
|
|
|
24
24
|
export type { CompanyPaginatedList } from './models/CompanyPaginatedList';
|
|
25
25
|
export type { CurrencyInfo } from './models/CurrencyInfo';
|
|
26
26
|
export type { Document } from './models/Document';
|
|
27
|
+
export type { DocumentEdit } from './models/DocumentEdit';
|
|
27
28
|
export type { DocumentLinkRequest } from './models/DocumentLinkRequest';
|
|
29
|
+
export type { DocumentLinkTarget } from './models/DocumentLinkTarget';
|
|
30
|
+
export type { DocumentPaginatedList } from './models/DocumentPaginatedList';
|
|
28
31
|
export type { DocumentUploadRequest } from './models/DocumentUploadRequest';
|
|
29
32
|
export type { DocumentUploadTicket } from './models/DocumentUploadTicket';
|
|
30
33
|
export type { Icon } from './models/Icon';
|
|
@@ -17,6 +17,12 @@ export type Document = {
|
|
|
17
17
|
downloadUrl?: string | null;
|
|
18
18
|
fileName: string;
|
|
19
19
|
id: string;
|
|
20
|
+
/**
|
|
21
|
+
* Number of events (operations/accruals) this document is currently linked to. Populated on the project
|
|
22
|
+
* documents-library read so the UI can distinguish a linked document (> 0) from an unlinked library member
|
|
23
|
+
* (0). Not populated on the per-event list (it is always this event, so it stays 0 there).
|
|
24
|
+
*/
|
|
25
|
+
linkedEventCount?: number;
|
|
20
26
|
/**
|
|
21
27
|
* Size of the binary in bytes.
|
|
22
28
|
*/
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* One live event a document is linked to — for showing / navigating to a document's attachments. Exactly
|
|
3
|
+
* one of the two ids is set (operation XOR accrual); Incomy.Platform.Hub.Models.DocumentLinkTarget.Name is that event's display name. Trashed
|
|
4
|
+
* events are excluded (you cannot navigate to them in the logbook).
|
|
5
|
+
*/
|
|
6
|
+
export type DocumentLinkTarget = {
|
|
7
|
+
accrualId?: string | null;
|
|
8
|
+
name: string;
|
|
9
|
+
operationId?: string | null;
|
|
10
|
+
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { Document } from './Document';
|
|
2
|
+
export type DocumentPaginatedList = {
|
|
3
|
+
/**
|
|
4
|
+
* Results for the current query
|
|
5
|
+
*/
|
|
6
|
+
items: Array<Document>;
|
|
7
|
+
/**
|
|
8
|
+
* Token item to start the next query from; Empty start from the beginning
|
|
9
|
+
*/
|
|
10
|
+
next: string;
|
|
11
|
+
/**
|
|
12
|
+
* Estimated total count over all pages. -1 means the total count could not be determined.
|
|
13
|
+
*/
|
|
14
|
+
totalCount?: number;
|
|
15
|
+
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -1,19 +1,28 @@
|
|
|
1
1
|
import type { Document } from '../models/Document';
|
|
2
|
+
import type { DocumentEdit } from '../models/DocumentEdit';
|
|
2
3
|
import type { DocumentLinkRequest } from '../models/DocumentLinkRequest';
|
|
4
|
+
import type { DocumentLinkTarget } from '../models/DocumentLinkTarget';
|
|
5
|
+
import type { DocumentPaginatedList } from '../models/DocumentPaginatedList';
|
|
3
6
|
import type { DocumentUploadRequest } from '../models/DocumentUploadRequest';
|
|
4
7
|
import type { DocumentUploadTicket } from '../models/DocumentUploadTicket';
|
|
5
8
|
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
6
9
|
export declare class ProjectDocumentsService {
|
|
7
10
|
/**
|
|
8
|
-
*
|
|
9
|
-
*
|
|
11
|
+
* List documents. With `operationId` OR `accrualId`: the documents attached to that event (returned as a
|
|
12
|
+
* single page). With neither: the whole project documents library, paginated and optionally filtered by a filename
|
|
13
|
+
* `query` (each item carries its `linkedEventCount`). Supplying both event ids is a 400.
|
|
14
|
+
* @returns DocumentPaginatedList OK
|
|
10
15
|
* @throws ApiError
|
|
11
16
|
*/
|
|
12
|
-
static getProjectsDocuments({ projectId, operationId, accrualId, }: {
|
|
17
|
+
static getProjectsDocuments({ projectId, operationId, accrualId, query, orderByName, limit, next, }: {
|
|
13
18
|
projectId: string;
|
|
14
19
|
operationId?: string;
|
|
15
20
|
accrualId?: string;
|
|
16
|
-
|
|
21
|
+
query?: string;
|
|
22
|
+
orderByName?: 'Desc' | 'Asc';
|
|
23
|
+
limit?: number;
|
|
24
|
+
next?: string;
|
|
25
|
+
}): CancelablePromise<DocumentPaginatedList>;
|
|
17
26
|
/**
|
|
18
27
|
* @returns DocumentUploadTicket OK
|
|
19
28
|
* @throws ApiError
|
|
@@ -40,12 +49,23 @@ export declare class ProjectDocumentsService {
|
|
|
40
49
|
documentId: string;
|
|
41
50
|
}): CancelablePromise<Document>;
|
|
42
51
|
/**
|
|
52
|
+
* Rename a document (its display file name).
|
|
43
53
|
* @returns Document OK
|
|
44
54
|
* @throws ApiError
|
|
45
55
|
*/
|
|
46
|
-
static
|
|
56
|
+
static patchProjectsDocuments({ projectId, documentId, requestBody, }: {
|
|
47
57
|
projectId: string;
|
|
48
58
|
documentId: string;
|
|
59
|
+
requestBody?: DocumentEdit;
|
|
60
|
+
}): CancelablePromise<Document>;
|
|
61
|
+
/**
|
|
62
|
+
* @returns Document OK
|
|
63
|
+
* @throws ApiError
|
|
64
|
+
*/
|
|
65
|
+
static postProjectsDocumentsComplete({ projectId, documentId, finalize, }: {
|
|
66
|
+
projectId: string;
|
|
67
|
+
documentId: string;
|
|
68
|
+
finalize?: boolean;
|
|
49
69
|
}): CancelablePromise<Document>;
|
|
50
70
|
/**
|
|
51
71
|
* Detach a document from one event — supply exactly one of `operationId`/`accrualId`.
|
|
@@ -58,6 +78,16 @@ export declare class ProjectDocumentsService {
|
|
|
58
78
|
operationId?: string;
|
|
59
79
|
accrualId?: string;
|
|
60
80
|
}): CancelablePromise<any>;
|
|
81
|
+
/**
|
|
82
|
+
* The live events (operations/accruals) this document is linked to, with their names — for showing and
|
|
83
|
+
* navigating to a document's attachments. Trashed events are excluded.
|
|
84
|
+
* @returns DocumentLinkTarget OK
|
|
85
|
+
* @throws ApiError
|
|
86
|
+
*/
|
|
87
|
+
static getProjectsDocumentsLinks({ projectId, documentId, }: {
|
|
88
|
+
projectId: string;
|
|
89
|
+
documentId: string;
|
|
90
|
+
}): CancelablePromise<Array<DocumentLinkTarget>>;
|
|
61
91
|
/**
|
|
62
92
|
* Attach a document to an event (many-to-many) — the body sets exactly one of the two event ids.
|
|
63
93
|
* @returns any OK
|
|
@@ -2,11 +2,13 @@ import { OpenAPI } from '../core/OpenAPI';
|
|
|
2
2
|
import { request as __request } from '../core/request';
|
|
3
3
|
export class ProjectDocumentsService {
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
6
|
-
*
|
|
5
|
+
* List documents. With `operationId` OR `accrualId`: the documents attached to that event (returned as a
|
|
6
|
+
* single page). With neither: the whole project documents library, paginated and optionally filtered by a filename
|
|
7
|
+
* `query` (each item carries its `linkedEventCount`). Supplying both event ids is a 400.
|
|
8
|
+
* @returns DocumentPaginatedList OK
|
|
7
9
|
* @throws ApiError
|
|
8
10
|
*/
|
|
9
|
-
static getProjectsDocuments({ projectId, operationId, accrualId, }) {
|
|
11
|
+
static getProjectsDocuments({ projectId, operationId, accrualId, query, orderByName, limit = 50, next, }) {
|
|
10
12
|
return __request(OpenAPI, {
|
|
11
13
|
method: 'GET',
|
|
12
14
|
url: '/projects/{projectId}/documents',
|
|
@@ -16,6 +18,10 @@ export class ProjectDocumentsService {
|
|
|
16
18
|
query: {
|
|
17
19
|
'operationId': operationId,
|
|
18
20
|
'accrualId': accrualId,
|
|
21
|
+
'query': query,
|
|
22
|
+
'orderByName': orderByName,
|
|
23
|
+
'limit': limit,
|
|
24
|
+
'next': next,
|
|
19
25
|
},
|
|
20
26
|
});
|
|
21
27
|
}
|
|
@@ -63,11 +69,28 @@ export class ProjectDocumentsService {
|
|
|
63
69
|
},
|
|
64
70
|
});
|
|
65
71
|
}
|
|
72
|
+
/**
|
|
73
|
+
* Rename a document (its display file name).
|
|
74
|
+
* @returns Document OK
|
|
75
|
+
* @throws ApiError
|
|
76
|
+
*/
|
|
77
|
+
static patchProjectsDocuments({ projectId, documentId, requestBody, }) {
|
|
78
|
+
return __request(OpenAPI, {
|
|
79
|
+
method: 'PATCH',
|
|
80
|
+
url: '/projects/{projectId}/documents/{documentId}',
|
|
81
|
+
path: {
|
|
82
|
+
'projectId': projectId,
|
|
83
|
+
'documentId': documentId,
|
|
84
|
+
},
|
|
85
|
+
body: requestBody,
|
|
86
|
+
mediaType: 'application/json',
|
|
87
|
+
});
|
|
88
|
+
}
|
|
66
89
|
/**
|
|
67
90
|
* @returns Document OK
|
|
68
91
|
* @throws ApiError
|
|
69
92
|
*/
|
|
70
|
-
static postProjectsDocumentsComplete({ projectId, documentId, }) {
|
|
93
|
+
static postProjectsDocumentsComplete({ projectId, documentId, finalize, }) {
|
|
71
94
|
return __request(OpenAPI, {
|
|
72
95
|
method: 'POST',
|
|
73
96
|
url: '/projects/{projectId}/documents/{documentId}/complete',
|
|
@@ -75,6 +98,9 @@ export class ProjectDocumentsService {
|
|
|
75
98
|
'projectId': projectId,
|
|
76
99
|
'documentId': documentId,
|
|
77
100
|
},
|
|
101
|
+
query: {
|
|
102
|
+
'finalize': finalize,
|
|
103
|
+
},
|
|
78
104
|
});
|
|
79
105
|
}
|
|
80
106
|
/**
|
|
@@ -96,6 +122,22 @@ export class ProjectDocumentsService {
|
|
|
96
122
|
},
|
|
97
123
|
});
|
|
98
124
|
}
|
|
125
|
+
/**
|
|
126
|
+
* The live events (operations/accruals) this document is linked to, with their names — for showing and
|
|
127
|
+
* navigating to a document's attachments. Trashed events are excluded.
|
|
128
|
+
* @returns DocumentLinkTarget OK
|
|
129
|
+
* @throws ApiError
|
|
130
|
+
*/
|
|
131
|
+
static getProjectsDocumentsLinks({ projectId, documentId, }) {
|
|
132
|
+
return __request(OpenAPI, {
|
|
133
|
+
method: 'GET',
|
|
134
|
+
url: '/projects/{projectId}/documents/{documentId}/links',
|
|
135
|
+
path: {
|
|
136
|
+
'projectId': projectId,
|
|
137
|
+
'documentId': documentId,
|
|
138
|
+
},
|
|
139
|
+
});
|
|
140
|
+
}
|
|
99
141
|
/**
|
|
100
142
|
* Attach a document to an event (many-to-many) — the body sets exactly one of the two event ids.
|
|
101
143
|
* @returns any OK
|
package/meta.json
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
{
|
|
2
|
-
"sdkVersion": "0.6.1-beta.
|
|
3
|
-
"generatedAt": "2026-07-
|
|
4
|
-
"apiCommit": "
|
|
5
|
-
"pipelineUrl": "https://gitlab.com/incomy/platform/-/pipelines/
|
|
2
|
+
"sdkVersion": "0.6.1-beta.2532",
|
|
3
|
+
"generatedAt": "2026-07-21T12:41:51.827Z",
|
|
4
|
+
"apiCommit": "9cbd57c2",
|
|
5
|
+
"pipelineUrl": "https://gitlab.com/incomy/platform/-/pipelines/2693811066",
|
|
6
6
|
"sources": {
|
|
7
7
|
"hub": {
|
|
8
|
-
"sha256": "
|
|
8
|
+
"sha256": "4b3b23e757d102c2cf60c44d7cc1adbc6aa9a6446fd57ed8559d7d2b696fad0e"
|
|
9
9
|
}
|
|
10
10
|
}
|
|
11
11
|
}
|