visualvault-api 2.0.0-beta.3 → 2.1.0-beta.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 +2 -4
- package/dist/VVRestApi.cjs +1400 -93
- package/dist/VVRestApi.cjs.map +1 -1
- package/dist/VVRestApi.d.cts +2234 -173
- package/dist/VVRestApi.d.ts +2234 -173
- package/dist/VVRestApi.js +1400 -93
- package/dist/VVRestApi.js.map +1 -1
- package/dist/index.cjs +1400 -93
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1400 -93
- package/dist/index.js.map +1 -1
- package/package.json +9 -1
package/dist/VVRestApi.d.cts
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import fs from 'fs';
|
|
2
|
+
|
|
1
3
|
declare class HttpHelper {
|
|
2
4
|
constructor(sessionToken: any, yamlConfig: any);
|
|
3
5
|
_sessionToken: any;
|
|
@@ -8,7 +10,7 @@ declare class HttpHelper {
|
|
|
8
10
|
__makeRequest(url: any, options: any): Promise<string>;
|
|
9
11
|
__makePostStreamRequest(url: any, options: any, buffer: any): Promise<string>;
|
|
10
12
|
httpGet(url: any, params: any): Promise<string>;
|
|
11
|
-
httpGetStream(url: any, params: any): Promise<
|
|
13
|
+
httpGetStream(url: any, params: any): Promise<Buffer<ArrayBuffer>>;
|
|
12
14
|
httpPost(url: any, params: any, data: any): Promise<string>;
|
|
13
15
|
httpPostStream(url: any, params: any, data: any, buffer: any): Promise<string>;
|
|
14
16
|
httpPut(url: any, params: any, data: any): Promise<string>;
|
|
@@ -43,7 +45,7 @@ declare class SessionToken {
|
|
|
43
45
|
|
|
44
46
|
declare class Authorize$1 {
|
|
45
47
|
jsyaml: any;
|
|
46
|
-
fs:
|
|
48
|
+
fs: typeof fs;
|
|
47
49
|
acquireSecurityToken(clientId: any, clientSecret: any, userId: any, password: any, audience: any, baseUrl: any, apiUrl: any, customerAlias: any, databaseAlias: any, authenticationUrl: any): Promise<SessionToken>;
|
|
48
50
|
acquireJwt(jwt: any, baseUrl: any, apiUrl: any, authenticationUrl: any, customerAlias: any, databaseAlias: any): Promise<SessionToken>;
|
|
49
51
|
reacquireSecurityToken(sessionToken: any): Promise<SessionToken>;
|
|
@@ -53,191 +55,451 @@ declare class Authorize$1 {
|
|
|
53
55
|
endsWith(source: any, suffix: any): boolean;
|
|
54
56
|
}
|
|
55
57
|
|
|
56
|
-
declare class
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
documents: DocumentManager;
|
|
58
|
+
declare class Constants {
|
|
59
|
+
alertEventIds: {
|
|
60
|
+
folderSecurityModified: string;
|
|
61
|
+
childFolderSecurityModified: string;
|
|
62
|
+
folderDocumentAdded: string;
|
|
63
|
+
childFolderDocumentAdded: string;
|
|
64
|
+
documentCheckedIn: string;
|
|
65
|
+
documentCheckedOut: string;
|
|
66
|
+
documentDetailsModified: string;
|
|
67
|
+
documentSecurityModified: string;
|
|
68
|
+
documentViewed: string;
|
|
69
|
+
projectDocumentAddedOrRemoved: string;
|
|
70
|
+
projectViewed: string;
|
|
71
|
+
};
|
|
72
|
+
securityRoles: {
|
|
73
|
+
Owner: string;
|
|
74
|
+
Editor: string;
|
|
75
|
+
Viewer: string;
|
|
76
|
+
};
|
|
77
|
+
securityMemberType: {
|
|
78
|
+
User: string;
|
|
79
|
+
Group: string;
|
|
80
|
+
};
|
|
81
|
+
relationType: {
|
|
82
|
+
Parent: string;
|
|
83
|
+
Child: string;
|
|
84
|
+
Peer: string;
|
|
85
|
+
};
|
|
85
86
|
}
|
|
86
87
|
|
|
87
|
-
|
|
88
|
-
|
|
88
|
+
/**
|
|
89
|
+
* Manages API configuration retrieval for each VisualVault service.
|
|
90
|
+
*/
|
|
91
|
+
declare class ConfigurationManager {
|
|
92
|
+
/**
|
|
93
|
+
* @param {object} httpHelper - The HTTP helper instance used to make API requests.
|
|
94
|
+
*/
|
|
95
|
+
constructor(httpHelper: object);
|
|
89
96
|
_httpHelper: any;
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
}
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
97
|
+
/**
|
|
98
|
+
* Retrieves the configuration settings for the DocApi service.
|
|
99
|
+
* @returns {Promise<string>} JSON string containing the DocApi configuration.
|
|
100
|
+
*/
|
|
101
|
+
getDocApiConfig(): Promise<string>;
|
|
102
|
+
/**
|
|
103
|
+
* Retrieves the configuration settings for the FormsApi service.
|
|
104
|
+
* @returns {Promise<string>} JSON string containing the FormsApi configuration.
|
|
105
|
+
*/
|
|
106
|
+
getFormsApiConfig(): Promise<string>;
|
|
107
|
+
/**
|
|
108
|
+
* Retrieves the configuration settings for the ObjectsApi service.
|
|
109
|
+
* @returns {Promise<string>} JSON string containing the ObjectsApi configuration.
|
|
110
|
+
*/
|
|
111
|
+
getObjectsApiConfig(): Promise<string>;
|
|
112
|
+
/**
|
|
113
|
+
* Retrieves the configuration settings for the StudioApi service.
|
|
114
|
+
* @returns {Promise<string>} JSON string containing the StudioApi configuration.
|
|
115
|
+
*/
|
|
116
|
+
getStudioApiConfig(): Promise<string>;
|
|
117
|
+
/**
|
|
118
|
+
* Retrieves the configuration settings for the NotificationsApi service.
|
|
119
|
+
* @returns {Promise<string>} JSON string containing the NotificationsApi configuration.
|
|
120
|
+
*/
|
|
121
|
+
getNotificationsApiConfig(): Promise<string>;
|
|
100
122
|
}
|
|
101
123
|
|
|
102
|
-
|
|
103
|
-
|
|
124
|
+
/**
|
|
125
|
+
* Manages custom query execution via the VVRestApi.
|
|
126
|
+
*/
|
|
127
|
+
declare class CustomQueryManager {
|
|
128
|
+
/**
|
|
129
|
+
* @param {object} httpHelper - The HTTP helper instance used to make API requests.
|
|
130
|
+
*/
|
|
131
|
+
constructor(httpHelper: object);
|
|
104
132
|
_httpHelper: any;
|
|
105
133
|
/**
|
|
106
|
-
* Retrieves
|
|
107
|
-
* @param {
|
|
134
|
+
* Retrieves the results of a custom query by its name.
|
|
135
|
+
* @param {string} queryName - The name of the custom query to execute.
|
|
136
|
+
* @param {object} [params] - Optional URL parameters to include in the request.
|
|
137
|
+
* @returns {Promise<string>} JSON string containing the custom query results.
|
|
108
138
|
*/
|
|
109
|
-
|
|
139
|
+
getCustomQueryResultsByName(queryName: string, params?: object): Promise<string>;
|
|
110
140
|
/**
|
|
111
|
-
* Retrieves a
|
|
112
|
-
* @param {string}
|
|
113
|
-
* @param {object} params - Optional URL parameters to include in the request
|
|
141
|
+
* Retrieves the results of a custom query by its ID.
|
|
142
|
+
* @param {string} id - The ID (Guid) of the custom query to execute.
|
|
143
|
+
* @param {object} [params] - Optional URL parameters to include in the request.
|
|
144
|
+
* @returns {Promise<string>} JSON string containing the custom query results.
|
|
114
145
|
*/
|
|
115
|
-
|
|
146
|
+
getCustomQueryResultsById(id: string, params?: object): Promise<string>;
|
|
116
147
|
}
|
|
117
148
|
|
|
118
|
-
|
|
119
|
-
|
|
149
|
+
/**
|
|
150
|
+
* Manager class for document API operations.
|
|
151
|
+
*
|
|
152
|
+
* All methods return a `Promise<string>` containing a JSON-encoded API response.
|
|
153
|
+
* When parsed, the response has the shape:
|
|
154
|
+
* ```json
|
|
155
|
+
* {
|
|
156
|
+
* "meta": { "status": 200, "statusMsg": "OK", "errors": [] },
|
|
157
|
+
* "data": { ... }
|
|
158
|
+
* }
|
|
159
|
+
* ```
|
|
160
|
+
* Check `meta.status` to determine success or failure before consuming `data`.
|
|
161
|
+
*/
|
|
162
|
+
declare class DocumentsManager {
|
|
163
|
+
/**
|
|
164
|
+
* @param {object} httpHelper - HTTP helper instance
|
|
165
|
+
*/
|
|
166
|
+
constructor(httpHelper: object);
|
|
120
167
|
_httpHelper: any;
|
|
121
168
|
/**
|
|
122
|
-
*
|
|
123
|
-
* @param {
|
|
124
|
-
* @param {
|
|
169
|
+
* Creates a new document record.
|
|
170
|
+
* @param {object} data - Document metadata.
|
|
171
|
+
* @param {string} data.folderId - The Guid of the destination folder.
|
|
172
|
+
* @param {string} [data.name] - Display name for the document.
|
|
173
|
+
* @param {string} [data.description] - Document description.
|
|
174
|
+
* @param {string} [data.revision] - Revision label (e.g. "0").
|
|
175
|
+
* @param {string} [data.documentState] - Check-in state (e.g. "Released", "Checked In").
|
|
176
|
+
* @param {string} [data.filename] - File name for the document.
|
|
177
|
+
* @param {number} [data.fileLength] - File size in bytes.
|
|
178
|
+
* @param {string} [data.indexFields] - JSON-serialized index field key-value pairs.
|
|
179
|
+
* @param {string} [data.allowNoFile] - Set to "true" to create without a file.
|
|
180
|
+
* @returns {Promise<string>} The API response containing the created document.
|
|
125
181
|
*/
|
|
126
|
-
|
|
182
|
+
postDoc(data: {
|
|
183
|
+
folderId: string;
|
|
184
|
+
name?: string;
|
|
185
|
+
description?: string;
|
|
186
|
+
revision?: string;
|
|
187
|
+
documentState?: string;
|
|
188
|
+
filename?: string;
|
|
189
|
+
fileLength?: number;
|
|
190
|
+
indexFields?: string;
|
|
191
|
+
allowNoFile?: string;
|
|
192
|
+
}): Promise<string>;
|
|
127
193
|
/**
|
|
128
|
-
*
|
|
129
|
-
* @param {
|
|
130
|
-
* @param {
|
|
131
|
-
* @param {
|
|
194
|
+
* Creates a new document record with an attached file.
|
|
195
|
+
* @param {object} data - Document metadata to create.
|
|
196
|
+
* @param {string} data.folderId - The Guid of the destination folder.
|
|
197
|
+
* @param {string} [data.name] - Display name for the document.
|
|
198
|
+
* @param {string} [data.description] - Document description.
|
|
199
|
+
* @param {string} [data.revision] - Revision label (e.g. "0").
|
|
200
|
+
* @param {string} [data.documentState] - Check-in state (e.g. "Released", "Checked In").
|
|
201
|
+
* @param {string} [data.filename] - File name for the document.
|
|
202
|
+
* @param {number} [data.fileLength] - File size in bytes.
|
|
203
|
+
* @param {string} [data.indexFields] - JSON-serialized index field key-value pairs.
|
|
204
|
+
* @param {Uint8Array} fileData - The file content to upload.
|
|
205
|
+
* @returns {Promise<string>} The API response containing the created document.
|
|
132
206
|
*/
|
|
133
|
-
|
|
207
|
+
postDocWithFile(data: {
|
|
208
|
+
folderId: string;
|
|
209
|
+
name?: string;
|
|
210
|
+
description?: string;
|
|
211
|
+
revision?: string;
|
|
212
|
+
documentState?: string;
|
|
213
|
+
filename?: string;
|
|
214
|
+
fileLength?: number;
|
|
215
|
+
indexFields?: string;
|
|
216
|
+
}, fileData: Uint8Array): Promise<string>;
|
|
134
217
|
/**
|
|
135
|
-
*
|
|
136
|
-
* @param {
|
|
137
|
-
* @param {object} data -
|
|
138
|
-
* @param {
|
|
218
|
+
* Copies a document to a new location.
|
|
219
|
+
* @param {object} params - Optional query parameters.
|
|
220
|
+
* @param {object} data - Copy options.
|
|
221
|
+
* @param {string} data.folderId - The Guid of the destination folder to copy the document into.
|
|
222
|
+
* @param {string} documentId - The Id of the document to copy.
|
|
223
|
+
* @returns {Promise<string>} The API response containing the copied document.
|
|
139
224
|
*/
|
|
140
|
-
|
|
225
|
+
copyDocument(params: object, data: {
|
|
226
|
+
folderId: string;
|
|
227
|
+
}, documentId: string): Promise<string>;
|
|
141
228
|
/**
|
|
142
|
-
*
|
|
143
|
-
* @param {
|
|
144
|
-
* @param {
|
|
145
|
-
* @param {
|
|
146
|
-
* @param {
|
|
229
|
+
* Moves a document to a different folder.
|
|
230
|
+
* @param {object} params - Optional query parameters.
|
|
231
|
+
* @param {object} data - Move options.
|
|
232
|
+
* @param {string} data.folderId - The Guid of the destination folder to move the document into.
|
|
233
|
+
* @param {string} documentId - The Id of the document to move.
|
|
234
|
+
* @returns {Promise<string>} The API response containing the updated document.
|
|
147
235
|
*/
|
|
148
|
-
|
|
236
|
+
moveDocument(params: object, data: {
|
|
237
|
+
folderId: string;
|
|
238
|
+
}, documentId: string): Promise<string>;
|
|
149
239
|
/**
|
|
150
|
-
* Deletes
|
|
151
|
-
* @param {
|
|
152
|
-
* @param {
|
|
240
|
+
* Deletes a specific document.
|
|
241
|
+
* @param {object} params - Optional query parameters.
|
|
242
|
+
* @param {string} revisionId - The Id of the document revision to delete.
|
|
243
|
+
* @returns {Promise<string>} The API response confirming the deletion.
|
|
153
244
|
*/
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
isEnabled: any;
|
|
161
|
-
baseUrl: any;
|
|
162
|
-
models: ModelManager;
|
|
163
|
-
objects: ObjectManager;
|
|
164
|
-
}
|
|
165
|
-
|
|
166
|
-
declare class WorkflowManager {
|
|
167
|
-
constructor(httpHelper: any);
|
|
168
|
-
_httpHelper: any;
|
|
169
|
-
getWorkflow(workflowId: any): Promise<any>;
|
|
170
|
-
getWorkflowByName(workflowName: any): Promise<any>;
|
|
171
|
-
getWorkflowVariables(params: any, workflowId: any): Promise<any>;
|
|
172
|
-
/**
|
|
173
|
-
* Triggers workflow
|
|
174
|
-
* @param {string} workflowId
|
|
175
|
-
* @param {number} workflowRevision
|
|
176
|
-
* @param {string} objectId
|
|
177
|
-
* @param {object[]} workflowVariables - workflow values to be submitted to the workflow
|
|
178
|
-
* * @param {string} workflowVariables[].name = name of variable
|
|
179
|
-
* * @param {*} workflowVariables[].value - value to be passed
|
|
180
|
-
* * @param {number} workflowVariables[].dataType - Text: 1, Number: 2, Date: 3, Boolean: 4
|
|
245
|
+
deleteDocument(params: object, revisionId: string): Promise<string>;
|
|
246
|
+
/**
|
|
247
|
+
* Retrieves metadata for a specific document.
|
|
248
|
+
* @param {object} params - Optional query parameters.
|
|
249
|
+
* @param {string} revisionId - The revision Id of the document to retrieve.
|
|
250
|
+
* @returns {Promise<string>} The API response containing the document metadata.
|
|
181
251
|
*/
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
252
|
+
getDocumentRevision(params: object, revisionId: string): Promise<string>;
|
|
253
|
+
/**
|
|
254
|
+
* Retrieves a list of documents matching the given query parameters.
|
|
255
|
+
* @param {object} params - Query parameters for filtering, sorting, and pagination.
|
|
256
|
+
* @returns {Promise<string>} The API response containing the matching documents.
|
|
257
|
+
*/
|
|
258
|
+
getDocuments(params: object): Promise<string>;
|
|
259
|
+
/**
|
|
260
|
+
* Updates the index fields on a document.
|
|
261
|
+
* @param {object} data - Index field values to update.
|
|
262
|
+
* @param {string} data.indexFields - JSON-serialized index fields; accepts a JSON array of `{"fieldLabel": "value"}` objects or a single `{"fieldLabel": "value"}` object where keys are field labels or Guid IDs.
|
|
263
|
+
* @param {string} documentId - The Id of the document to update.
|
|
264
|
+
* @returns {Promise<string>} The API response confirming the update.
|
|
265
|
+
*/
|
|
266
|
+
putDocumentIndexFields(data: {
|
|
267
|
+
indexFields: string;
|
|
268
|
+
}, documentId: string): Promise<string>;
|
|
269
|
+
/**
|
|
270
|
+
* Subscribes a user to alert notifications for a specific document event.
|
|
271
|
+
* @param {string} documentId - The Id of the document to subscribe to.
|
|
272
|
+
* @param {string} eventId - The Id of the event to subscribe to.
|
|
273
|
+
* @param {string} userId - The Id of the user to subscribe.
|
|
274
|
+
* @returns {Promise<string>} The API response confirming the subscription.
|
|
275
|
+
*/
|
|
276
|
+
postDocumentAlertSubscription(documentId: string, eventId: string, userId: string): Promise<string>;
|
|
277
|
+
/**
|
|
278
|
+
* Removes a user's subscription to alert notifications for a specific document event.
|
|
279
|
+
* @param {string} documentId - The Id of the document.
|
|
280
|
+
* @param {string} eventId - The Id of the event to unsubscribe from.
|
|
281
|
+
* @param {string} userId - The Id of the user to unsubscribe.
|
|
282
|
+
* @returns {Promise<string>} The API response confirming the unsubscription.
|
|
283
|
+
*/
|
|
284
|
+
deleteDocumentAlertSubscription(documentId: string, eventId: string, userId: string): Promise<string>;
|
|
285
|
+
/**
|
|
286
|
+
* Retrieves OCR processing properties for a specific document revision.
|
|
287
|
+
* @param {object} params - Optional query parameters.
|
|
288
|
+
* @param {string} revisionId - The revision Id of the document.
|
|
289
|
+
* @returns {Promise<string>} The API response containing the OCR properties.
|
|
290
|
+
*/
|
|
291
|
+
getDocumentRevisionOcrProperties(params: object, revisionId: string): Promise<string>;
|
|
292
|
+
/**
|
|
293
|
+
* Creates a relationship between two document revisions.
|
|
294
|
+
* @param {string} revisionId - The Id of the source document revision.
|
|
295
|
+
* @param {string} relateToRevisionId - The revision Id of the document to relate to.
|
|
296
|
+
* @param {string} relateType - The type of relationship to create.
|
|
297
|
+
* @returns {Promise<string>} The API response confirming the relation.
|
|
298
|
+
*/
|
|
299
|
+
relateDocuments(revisionId: string, relateToRevisionId: string, relateType: string): Promise<string>;
|
|
300
|
+
/**
|
|
301
|
+
* Sets or updates the expiration date on a document.
|
|
302
|
+
* @param {string} documentId - The Id of the document to update.
|
|
303
|
+
* @param {string} expirationDate - The expiration date in ISO 8601 format.
|
|
304
|
+
* @returns {Promise<string>} The API response confirming the update.
|
|
305
|
+
*/
|
|
306
|
+
updateDocumentExpiration(documentId: string, expirationDate: string): Promise<string>;
|
|
307
|
+
/**
|
|
308
|
+
* Retrieves the WebDAV URL for a document.
|
|
309
|
+
* @param {string} documentId - The Id of the document.
|
|
310
|
+
* @returns {Promise<string>} The API response containing the WebDAV URL.
|
|
311
|
+
*/
|
|
312
|
+
getDocumentWebDavUrl(documentId: string): Promise<string>;
|
|
313
|
+
/**
|
|
314
|
+
* Retrieves the WOPI URL for a document.
|
|
315
|
+
* @param {string} documentId - The Id of the document.
|
|
316
|
+
* @returns {Promise<string>} The API response containing the WOPI URL.
|
|
317
|
+
*/
|
|
318
|
+
getDocumentWopiUrl(documentId: string): Promise<string>;
|
|
319
|
+
/**
|
|
320
|
+
* Initiates creation of a zip archive containing multiple documents.
|
|
321
|
+
* @param {object} params - Optional query parameters.
|
|
322
|
+
* @param {string[]} documentIds - Array of document Ids to include in the zip.
|
|
323
|
+
* @returns {Promise<string>} The API response containing a download key for polling zip status.
|
|
324
|
+
*/
|
|
325
|
+
createDocumentZipFile(params: object, documentIds: string[]): Promise<string>;
|
|
326
|
+
/**
|
|
327
|
+
* Checks the status of a zip file creation request initiated by createDocumentZipFile.
|
|
328
|
+
* @param {object} params - Optional query parameters.
|
|
329
|
+
* @param {string} downloadKey - The download key returned from createDocumentZipFile.
|
|
330
|
+
* @returns {Promise<string>} The API response containing the zip status and download URL.
|
|
331
|
+
*/
|
|
332
|
+
getDocumentZipFileStatus(params: object, downloadKey: string): Promise<string>;
|
|
333
|
+
/**
|
|
334
|
+
* Retrieves the index fields and their values for a specific document.
|
|
335
|
+
* @param {object} params - Optional query parameters.
|
|
336
|
+
* @param {string} documentId - The Id of the document.
|
|
337
|
+
* @returns {Promise<string>} The API response containing the document's index fields.
|
|
338
|
+
*/
|
|
339
|
+
getDocumentIndexFields(params: object, documentId: string): Promise<string>;
|
|
340
|
+
/**
|
|
341
|
+
* Retrieves available document types defined in the vault.
|
|
342
|
+
* @param {object} params - Optional query parameters for filtering.
|
|
343
|
+
* @returns {Promise<string>} The API response containing the document types.
|
|
344
|
+
*/
|
|
345
|
+
getDocumentTypes(params: object): Promise<string>;
|
|
346
|
+
/**
|
|
347
|
+
* Creates a new document type in the vault.
|
|
348
|
+
* @param {object} params - Optional query parameters.
|
|
349
|
+
* @param {string} name - The name of the document type to create.
|
|
350
|
+
* @returns {Promise<string>} The API response containing the created document type.
|
|
351
|
+
*/
|
|
352
|
+
createDocumentType(params: object, name: string): Promise<string>;
|
|
353
|
+
/**
|
|
354
|
+
* Retrieves saved document searches available to the current user.
|
|
355
|
+
* @param {object} params - Optional query parameters for filtering.
|
|
356
|
+
* @returns {Promise<string>} The API response containing the saved searches.
|
|
357
|
+
*/
|
|
358
|
+
getSavedSearches(params: object): Promise<string>;
|
|
359
|
+
/**
|
|
360
|
+
* Retrieves available document metadata fields defined in the vault.
|
|
361
|
+
* @param {object} params - Optional query parameters for filtering.
|
|
362
|
+
* @returns {Promise<string>} The API response containing the document fields.
|
|
363
|
+
*/
|
|
364
|
+
getDocumentFields(params: object): Promise<string>;
|
|
365
|
+
/**
|
|
366
|
+
* Retrieves the index fields associated with a saved search.
|
|
367
|
+
* @param {object} params - Optional query parameters.
|
|
368
|
+
* @param {string} savedSearchId - The Id of the saved search.
|
|
369
|
+
* @returns {Promise<string>} The API response containing the saved search's index fields.
|
|
370
|
+
*/
|
|
371
|
+
getSavedSearchIndexFields(params: object, savedSearchId: string): Promise<string>;
|
|
372
|
+
/**
|
|
373
|
+
* Retrieves the most recently accessed documents for the current user.
|
|
374
|
+
* @param {object} params - Optional query parameters for filtering and pagination.
|
|
375
|
+
* @returns {Promise<string>} The API response containing the recent documents.
|
|
376
|
+
*/
|
|
377
|
+
getLastDocuments(params: object): Promise<string>;
|
|
187
378
|
/**
|
|
188
|
-
*
|
|
189
|
-
* @param {
|
|
190
|
-
* @
|
|
191
|
-
* @returns
|
|
379
|
+
* Retrieves the most frequently accessed documents for the current user.
|
|
380
|
+
* @param {object} params - Optional query parameters for filtering and pagination.
|
|
381
|
+
* @returns {Promise<string>} The API response containing the frequent documents.
|
|
192
382
|
*/
|
|
193
|
-
|
|
383
|
+
getFrequentDocuments(params: object): Promise<string>;
|
|
194
384
|
/**
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
385
|
+
* Retrieves documents matching a saved search.
|
|
386
|
+
* @param {object} params - Optional query parameters for filtering and pagination.
|
|
387
|
+
* @param {string} savedSearchId - The Id of the saved search to execute.
|
|
388
|
+
* @returns {Promise<string>} The API response containing the matching documents.
|
|
389
|
+
*/
|
|
390
|
+
getSavedSearchDocuments(params: object, savedSearchId: string): Promise<string>;
|
|
201
391
|
/**
|
|
202
|
-
*
|
|
203
|
-
* @param {
|
|
204
|
-
* @param {string}
|
|
205
|
-
* @returns
|
|
392
|
+
* Retrieves the default action link for a document.
|
|
393
|
+
* @param {object} params - Optional query parameters.
|
|
394
|
+
* @param {string} documentId - The Id of the document.
|
|
395
|
+
* @returns {Promise<string>} The API response containing the default action link.
|
|
206
396
|
*/
|
|
207
|
-
|
|
397
|
+
getDocumentDefaultLink(params: object, documentId: string): Promise<string>;
|
|
208
398
|
}
|
|
209
399
|
|
|
210
|
-
|
|
211
|
-
|
|
400
|
+
/**
|
|
401
|
+
* Manages email sending operations via the VVRestApi.
|
|
402
|
+
*/
|
|
403
|
+
declare class EmailManager {
|
|
404
|
+
/**
|
|
405
|
+
* @param {object} httpHelper - The HTTP helper instance used to make API requests.
|
|
406
|
+
*/
|
|
407
|
+
constructor(httpHelper: object);
|
|
212
408
|
_httpHelper: any;
|
|
213
409
|
/**
|
|
214
|
-
*
|
|
215
|
-
* @param {object} params -
|
|
410
|
+
* Sends one or more emails.
|
|
411
|
+
* @param {object} params - URL parameters to include in the request.
|
|
412
|
+
* @param {object} data - The email data to submit in the request body.
|
|
413
|
+
* @param {string} data.recipients - The recipient email address(es).
|
|
414
|
+
* @param {string} data.body - The email body content.
|
|
415
|
+
* @param {string} [data.ccRecipients] - CC recipient email address(es).
|
|
416
|
+
* @param {string} [data.bccRecipients] - BCC recipient email address(es).
|
|
417
|
+
* @param {string} [data.subject] - The email subject line.
|
|
418
|
+
* @param {boolean} [data.hasAttachments] - Whether the email includes document attachments.
|
|
419
|
+
* @param {string|string[]} [data.documents] - One or more document IDs (Guids) to attach. Used when hasAttachments is true.
|
|
420
|
+
* @returns {Promise<string>} The API response confirming the emails were sent.
|
|
216
421
|
*/
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
422
|
+
postEmails(params: object, data: {
|
|
423
|
+
recipients: string;
|
|
424
|
+
body: string;
|
|
425
|
+
ccRecipients?: string;
|
|
426
|
+
bccRecipients?: string;
|
|
427
|
+
subject?: string;
|
|
428
|
+
hasAttachments?: boolean;
|
|
429
|
+
documents?: string | string[];
|
|
430
|
+
}): Promise<string>;
|
|
431
|
+
/**
|
|
432
|
+
* Sends one or more emails with file attachments.
|
|
433
|
+
* @param {object} params - URL parameters to include in the request.
|
|
434
|
+
* @param {object} data - The email data to submit in the request body.
|
|
435
|
+
* @param {string} data.recipients - The recipient email address(es).
|
|
436
|
+
* @param {string} data.body - The email body content.
|
|
437
|
+
* @param {string} [data.ccRecipients] - CC recipient email address(es).
|
|
438
|
+
* @param {string} [data.bccRecipients] - BCC recipient email address(es).
|
|
439
|
+
* @param {string} [data.subject] - The email subject line.
|
|
440
|
+
* @param {boolean} [data.hasAttachments] - Whether the email includes document attachments.
|
|
441
|
+
* @param {string|string[]} [data.documents] - One or more document IDs (Guids) to attach alongside the direct file uploads.
|
|
442
|
+
* @param {object[]} fileObjs - Array of file objects to attach directly to the email.
|
|
443
|
+
* @returns {Promise<string>} The API response confirming the emails were sent.
|
|
444
|
+
*/
|
|
445
|
+
postEmailsWithAttachments(params: object, data: {
|
|
446
|
+
recipients: string;
|
|
447
|
+
body: string;
|
|
448
|
+
ccRecipients?: string;
|
|
449
|
+
bccRecipients?: string;
|
|
450
|
+
subject?: string;
|
|
451
|
+
hasAttachments?: boolean;
|
|
452
|
+
documents?: string | string[];
|
|
453
|
+
}, fileObjs: object[]): Promise<string>;
|
|
227
454
|
}
|
|
228
455
|
|
|
229
|
-
|
|
230
|
-
|
|
456
|
+
/**
|
|
457
|
+
* Manages file upload and download operations via the VVRestApi.
|
|
458
|
+
*/
|
|
459
|
+
declare class FilesManager {
|
|
460
|
+
/**
|
|
461
|
+
* @param {object} httpHelper - The HTTP helper instance used to make API requests.
|
|
462
|
+
*/
|
|
463
|
+
constructor(httpHelper: object);
|
|
231
464
|
_httpHelper: any;
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
465
|
+
/**
|
|
466
|
+
* Downloads file bytes using a query string path.
|
|
467
|
+
* @param {string} query - The query string to append to the files resource URI.
|
|
468
|
+
* @returns {Promise<Buffer>} The API response containing the raw file bytes.
|
|
469
|
+
*/
|
|
470
|
+
getFileBytesQuery(query: string): Promise<Buffer>;
|
|
471
|
+
/**
|
|
472
|
+
* Downloads file bytes by file ID.
|
|
473
|
+
* @param {string} id - The ID (Guid) of the file to download.
|
|
474
|
+
* @returns {Promise<Buffer>} The API response containing the raw file bytes.
|
|
475
|
+
*/
|
|
476
|
+
getFileBytesId(id: string): Promise<Buffer>;
|
|
477
|
+
/**
|
|
478
|
+
* Uploads a file to the VVRestApi.
|
|
479
|
+
* @param {object} data - The file metadata to include in the request body.
|
|
480
|
+
* @param {string} [data.fileId] - The file revision ID of the document to update. Required if documentId is not provided.
|
|
481
|
+
* @param {string} [data.documentId] - The document ID of the document to update. Required if fileId is not provided.
|
|
482
|
+
* @param {string} [data.fileName] - The filename to assign to the uploaded file.
|
|
483
|
+
* @param {string} [data.revision] - The revision label to assign to the new revision.
|
|
484
|
+
* @param {string} [data.changeReason] - The reason for uploading a new revision.
|
|
485
|
+
* @param {string} [data.checkInDocumentState] - The document state after check-in: "Released", "Unreleased", or "Replace". Defaults to "Released".
|
|
486
|
+
* @param {boolean} [data.checkIn] - Whether to check in the document after upload. Defaults to true.
|
|
487
|
+
* @param {string} [data.indexFields] - JSON-serialized index fields; accepts an array of `{"fieldLabel": "value"}` objects or a single object with field labels as keys.
|
|
488
|
+
* @param {string} [data.parameters] - JSON string with optional upload parameters: `source`, `command`, `ocrStatus`, `keepAnnotations`.
|
|
489
|
+
* @param {Uint8Array} buffer - The raw file bytes to upload.
|
|
490
|
+
* @returns {Promise<string>} The API response containing the uploaded file details.
|
|
491
|
+
*/
|
|
492
|
+
postFile(data: {
|
|
493
|
+
fileId?: string;
|
|
494
|
+
documentId?: string;
|
|
495
|
+
fileName?: string;
|
|
496
|
+
revision?: string;
|
|
497
|
+
changeReason?: string;
|
|
498
|
+
checkInDocumentState?: string;
|
|
499
|
+
checkIn?: boolean;
|
|
500
|
+
indexFields?: string;
|
|
501
|
+
parameters?: string;
|
|
502
|
+
}, buffer: Uint8Array): Promise<string>;
|
|
241
503
|
}
|
|
242
504
|
|
|
243
505
|
/**
|
|
@@ -285,6 +547,1805 @@ declare class FormFieldCollection {
|
|
|
285
547
|
*/
|
|
286
548
|
getFieldArray(): Array<any>;
|
|
287
549
|
}
|
|
550
|
+
/**
|
|
551
|
+
* Manager class for Forms operations.
|
|
552
|
+
*
|
|
553
|
+
* All methods return a `Promise<string>` containing a JSON-encoded API response.
|
|
554
|
+
* When parsed, the response has the shape:
|
|
555
|
+
* ```json
|
|
556
|
+
* {
|
|
557
|
+
* "meta": { "status": 200, "statusMsg": "OK", "errors": [] },
|
|
558
|
+
* "data": { ... }
|
|
559
|
+
* }
|
|
560
|
+
* ```
|
|
561
|
+
* Check `meta.status` to determine success or failure before consuming `data`.
|
|
562
|
+
*/
|
|
563
|
+
declare class FormsManager {
|
|
564
|
+
/**
|
|
565
|
+
* @param {object} httpHelper - HTTP helper instance
|
|
566
|
+
*/
|
|
567
|
+
constructor(httpHelper: object);
|
|
568
|
+
_httpHelper: any;
|
|
569
|
+
/**
|
|
570
|
+
* Creates a ReturnField instance representing a form field value or error.
|
|
571
|
+
* @param {string} id - The field ID.
|
|
572
|
+
* @param {string} name - The field name.
|
|
573
|
+
* @param {*} value - The field value.
|
|
574
|
+
* @param {boolean} isError - Whether the field has an error.
|
|
575
|
+
* @param {string} errorMessage - The error message if isError is true.
|
|
576
|
+
* @returns {ReturnField} A new ReturnField instance.
|
|
577
|
+
*/
|
|
578
|
+
returnField(id: string, name: string, value: any, isError: boolean, errorMessage: string): ReturnField;
|
|
579
|
+
/**
|
|
580
|
+
* Retrieves available form templates in the vault.
|
|
581
|
+
* @param {object} params - Optional query parameters for filtering and pagination.
|
|
582
|
+
* @returns {Promise<string>} The API response containing the form templates.
|
|
583
|
+
*/
|
|
584
|
+
getFormTemplates(params: object): Promise<string>;
|
|
585
|
+
/**
|
|
586
|
+
* Looks up the GUID and revision GUID for a form template by its display name.
|
|
587
|
+
* @param {string} templateName - The display name of the form template.
|
|
588
|
+
* @returns {Promise<{formsManager: FormsManager, templateIdGuid: string, templateRevisionIdGuid: string, error?: string}>} A promise that resolves with the template IDs, or an error property if the lookup fails.
|
|
589
|
+
*/
|
|
590
|
+
getFormTemplateIdByName(templateName: string): Promise<{
|
|
591
|
+
formsManager: FormsManager;
|
|
592
|
+
templateIdGuid: string;
|
|
593
|
+
templateRevisionIdGuid: string;
|
|
594
|
+
error?: string;
|
|
595
|
+
}>;
|
|
596
|
+
/**
|
|
597
|
+
* Retrieves form instances for a given form template. Accepts either a template GUID or template name.
|
|
598
|
+
* @param {object} params - Optional query parameters for filtering and pagination.
|
|
599
|
+
* @param {string} formTemplateId - The form template GUID or display name.
|
|
600
|
+
* @returns {Promise<string>} The API response containing the form instances.
|
|
601
|
+
*/
|
|
602
|
+
getForms(params: object, formTemplateId: string): Promise<string>;
|
|
603
|
+
/**
|
|
604
|
+
* Sets an image field on a form instance.
|
|
605
|
+
* @param {string} formId - The ID of the form instance.
|
|
606
|
+
* @param {string} fieldId - The ID of the image field to set.
|
|
607
|
+
* @param {string} imageId - The ID of the image to assign to the field.
|
|
608
|
+
* @returns {Promise<string>} The API response confirming the update.
|
|
609
|
+
*/
|
|
610
|
+
setFieldImage(formId: string, fieldId: string, imageId: string): Promise<string>;
|
|
611
|
+
/**
|
|
612
|
+
* Imports a form template from a file stream.
|
|
613
|
+
* @param {object} data - Multipart metadata sent alongside the file stream.
|
|
614
|
+
* @param {string} formTemplateId - The ID of the form template to import into.
|
|
615
|
+
* @param {Uint8Array} buffer - The file content of the form template to import.
|
|
616
|
+
* @returns {Promise<string>} The API response confirming the import.
|
|
617
|
+
*/
|
|
618
|
+
importFormTemplate(data: object, formTemplateId: string, buffer: Uint8Array): Promise<string>;
|
|
619
|
+
/**
|
|
620
|
+
* Creates a new form instance for a given template. Accepts either a template GUID or template name.
|
|
621
|
+
* @param {object} params - Optional query parameters.
|
|
622
|
+
* @param {{[key: string]: string}} data - Form field key-value pairs where each key is a field name or Guid ID and each value is the field's string value.
|
|
623
|
+
* @param {string} formTemplateId - The form template GUID or display name.
|
|
624
|
+
* @returns {Promise<string>} The API response containing the created form instance.
|
|
625
|
+
*/
|
|
626
|
+
postForms(params: object, data: {
|
|
627
|
+
[key: string]: string;
|
|
628
|
+
}, formTemplateId: string): Promise<string>;
|
|
629
|
+
/**
|
|
630
|
+
* Creates a new revision of an existing form instance. Accepts either a template GUID or template name.
|
|
631
|
+
* @param {object} params - Optional query parameters.
|
|
632
|
+
* @param {{[key: string]: string}} data - Form field key-value pairs where each key is a field name or Guid ID and each value is the field's string value.
|
|
633
|
+
* @param {string} formTemplateId - The form template GUID or display name.
|
|
634
|
+
* @param {string} formId - The ID of the existing form instance to revise.
|
|
635
|
+
* @returns {Promise<string>} The API response containing the new form revision.
|
|
636
|
+
*/
|
|
637
|
+
postFormRevision(params: object, data: {
|
|
638
|
+
[key: string]: string;
|
|
639
|
+
}, formTemplateId: string, formId: string): Promise<string>;
|
|
640
|
+
/**
|
|
641
|
+
* Creates a new revision of a form instance identified directly by its form ID.
|
|
642
|
+
* @param {object} params - Optional query parameters.
|
|
643
|
+
* @param {{[key: string]: string}} data - Form field key-value pairs where each key is a field name or Guid ID and each value is the field's string value.
|
|
644
|
+
* @param {string} formId - The ID of the form instance to revise.
|
|
645
|
+
* @returns {Promise<string>} The API response containing the new form revision.
|
|
646
|
+
*/
|
|
647
|
+
postFormRevisionByFormId(params: object, data: {
|
|
648
|
+
[key: string]: string;
|
|
649
|
+
}, formId: string): Promise<string>;
|
|
650
|
+
/**
|
|
651
|
+
* Updates the originator (owner) of a form instance.
|
|
652
|
+
* @param {string} formInstanceId - The ID of the form instance to update.
|
|
653
|
+
* @param {string} newOriginatorUsID - The user ID of the new originator.
|
|
654
|
+
* @returns {Promise<string>} The API response confirming the update.
|
|
655
|
+
*/
|
|
656
|
+
updateFormInstanceOriginator(formInstanceId: string, newOriginatorUsID: string): Promise<string>;
|
|
657
|
+
/**
|
|
658
|
+
* Relates a form instance to another form instance by form ID.
|
|
659
|
+
* @param {string} formId - The ID of the source form instance.
|
|
660
|
+
* @param {string} relateToId - The ID of the form instance to relate to.
|
|
661
|
+
* @returns {Promise<string>} The API response confirming the relation.
|
|
662
|
+
*/
|
|
663
|
+
relateForm(formId: string, relateToId: string): Promise<string>;
|
|
664
|
+
/**
|
|
665
|
+
* Relates a form instance to another form instance by document ID.
|
|
666
|
+
* @param {string} formId - The ID of the source form instance.
|
|
667
|
+
* @param {string} relateToDocId - The document ID of the form instance to relate to.
|
|
668
|
+
* @returns {Promise<string>} The API response confirming the relation.
|
|
669
|
+
*/
|
|
670
|
+
relateFormByDocId(formId: string, relateToDocId: string): Promise<string>;
|
|
671
|
+
/**
|
|
672
|
+
* Relates a form instance to a document by document revision ID.
|
|
673
|
+
* @param {string} formId - The ID of the form instance.
|
|
674
|
+
* @param {string} relateToId - The revision ID of the document to relate to.
|
|
675
|
+
* @returns {Promise<string>} The API response confirming the relation.
|
|
676
|
+
*/
|
|
677
|
+
relateDocument(formId: string, relateToId: string): Promise<string>;
|
|
678
|
+
/**
|
|
679
|
+
* Relates a form instance to a document by document ID.
|
|
680
|
+
* @param {string} formId - The ID of the form instance.
|
|
681
|
+
* @param {string} relateToDocId - The document ID to relate to.
|
|
682
|
+
* @returns {Promise<string>} The API response confirming the relation.
|
|
683
|
+
*/
|
|
684
|
+
relateDocumentByDocId(formId: string, relateToDocId: string): Promise<string>;
|
|
685
|
+
/**
|
|
686
|
+
* Relates a form instance to a project by project ID.
|
|
687
|
+
* @param {string} formId - The ID of the form instance.
|
|
688
|
+
* @param {string} relateToId - The ID of the project to relate to.
|
|
689
|
+
* @returns {Promise<string>} The API response confirming the relation.
|
|
690
|
+
*/
|
|
691
|
+
relateProject(formId: string, relateToId: string): Promise<string>;
|
|
692
|
+
/**
|
|
693
|
+
* Relates a form instance to a project by project name.
|
|
694
|
+
* @param {string} formId - The ID of the form instance.
|
|
695
|
+
* @param {string} relateToProjectName - The name of the project to relate to.
|
|
696
|
+
* @returns {Promise<string>} The API response confirming the relation.
|
|
697
|
+
*/
|
|
698
|
+
relateProjectByName(formId: string, relateToProjectName: string): Promise<string>;
|
|
699
|
+
/**
|
|
700
|
+
* Removes a relationship between two form instances by form ID.
|
|
701
|
+
* @param {string} formId - The ID of the source form instance.
|
|
702
|
+
* @param {string} relateToId - The ID of the related form instance to unrelate.
|
|
703
|
+
* @returns {Promise<string>} The API response confirming the unrelation.
|
|
704
|
+
*/
|
|
705
|
+
unrelateForm(formId: string, relateToId: string): Promise<string>;
|
|
706
|
+
/**
|
|
707
|
+
* Removes a relationship between two form instances by document ID.
|
|
708
|
+
* @param {string} formId - The ID of the source form instance.
|
|
709
|
+
* @param {string} relateToDocId - The document ID of the related form instance to unrelate.
|
|
710
|
+
* @returns {Promise<string>} The API response confirming the unrelation.
|
|
711
|
+
*/
|
|
712
|
+
unrelateFormByDocId(formId: string, relateToDocId: string): Promise<string>;
|
|
713
|
+
/**
|
|
714
|
+
* Removes a relationship between a form instance and a document by document revision ID.
|
|
715
|
+
* @param {string} formId - The ID of the form instance.
|
|
716
|
+
* @param {string} relateToId - The revision ID of the related document to unrelate.
|
|
717
|
+
* @returns {Promise<string>} The API response confirming the unrelation.
|
|
718
|
+
*/
|
|
719
|
+
unrelateDocument(formId: string, relateToId: string): Promise<string>;
|
|
720
|
+
/**
|
|
721
|
+
* Removes a relationship between a form instance and a document by document ID.
|
|
722
|
+
* @param {string} formId - The ID of the form instance.
|
|
723
|
+
* @param {string} relateToDocId - The document ID of the related document to unrelate.
|
|
724
|
+
* @returns {Promise<string>} The API response confirming the unrelation.
|
|
725
|
+
*/
|
|
726
|
+
unrelateDocumentByDocId(formId: string, relateToDocId: string): Promise<string>;
|
|
727
|
+
/**
|
|
728
|
+
* Removes a relationship between a form instance and a project by project ID.
|
|
729
|
+
* @param {string} formId - The ID of the form instance.
|
|
730
|
+
* @param {string} relateToId - The ID of the related project to unrelate.
|
|
731
|
+
* @returns {Promise<string>} The API response confirming the unrelation.
|
|
732
|
+
*/
|
|
733
|
+
unrelateProject(formId: string, relateToId: string): Promise<string>;
|
|
734
|
+
/**
|
|
735
|
+
* Removes a relationship between a form instance and a project by project name.
|
|
736
|
+
* @param {string} formId - The ID of the form instance.
|
|
737
|
+
* @param {string} relateToProjectName - The name of the related project to unrelate.
|
|
738
|
+
* @returns {Promise<string>} The API response confirming the unrelation.
|
|
739
|
+
*/
|
|
740
|
+
unrelateProjectByName(formId: string, relateToProjectName: string): Promise<string>;
|
|
741
|
+
/**
|
|
742
|
+
* Retrieves documents related to a form instance.
|
|
743
|
+
* @param {string} formId - The ID of the form instance.
|
|
744
|
+
* @param {object} [params] - Optional query parameters for filtering and pagination.
|
|
745
|
+
* @returns {Promise<string>} The API response containing the related documents.
|
|
746
|
+
*/
|
|
747
|
+
getFormRelatedDocs(formId: string, params?: object): Promise<string>;
|
|
748
|
+
/**
|
|
749
|
+
* Retrieves form instances related to a given form instance.
|
|
750
|
+
* @param {string} formId - The ID of the form instance.
|
|
751
|
+
* @param {object} [params] - Optional query parameters for filtering and pagination.
|
|
752
|
+
* @returns {Promise<string>} The API response containing the related form instances.
|
|
753
|
+
*/
|
|
754
|
+
getFormRelatedForms(formId: string, params?: object): Promise<string>;
|
|
755
|
+
/**
|
|
756
|
+
* Tests whether a string is a valid GUID.
|
|
757
|
+
* @param {string} stringToTest - The string to test.
|
|
758
|
+
* @returns {boolean} True if the string is a valid GUID, false otherwise.
|
|
759
|
+
*/
|
|
760
|
+
isGuid(stringToTest: string): boolean;
|
|
761
|
+
/**
|
|
762
|
+
* Retrieves a specific form instance by template ID and instance ID.
|
|
763
|
+
* @param {string} templateId - The ID of the form template.
|
|
764
|
+
* @param {string} instanceId - The ID of the form instance.
|
|
765
|
+
* @returns {Promise<string>} The API response containing the form instance.
|
|
766
|
+
*/
|
|
767
|
+
getFormInstanceById(templateId: string, instanceId: string): Promise<string>;
|
|
768
|
+
/**
|
|
769
|
+
* Retrieves a form instance as a PDF stream.
|
|
770
|
+
* @param {string} templateId - The ID of the form template.
|
|
771
|
+
* @param {string} instanceId - The ID of the form instance.
|
|
772
|
+
* @returns {Promise<string>} The API response containing the PDF content stream.
|
|
773
|
+
*/
|
|
774
|
+
getFormInstancePDF(templateId: string, instanceId: string): Promise<string>;
|
|
775
|
+
/**
|
|
776
|
+
* Retrieves the field definitions for a form template.
|
|
777
|
+
* @param {string} templateId - The ID of the form template.
|
|
778
|
+
* @returns {Promise<string>} The API response containing the template's field definitions.
|
|
779
|
+
*/
|
|
780
|
+
getFormTemplateFields(templateId: string): Promise<string>;
|
|
781
|
+
/**
|
|
782
|
+
* Deletes a form instance.
|
|
783
|
+
* @param {string} instanceId - The ID of the form instance to delete.
|
|
784
|
+
* @returns {Promise<string>} The API response confirming the deletion.
|
|
785
|
+
*/
|
|
786
|
+
deleteFormInstance(instanceId: string): Promise<string>;
|
|
787
|
+
/**
|
|
788
|
+
* Releases a form template.
|
|
789
|
+
* @param {string} formTemplateId - The ID of the form template to release.
|
|
790
|
+
* @returns {Promise<string>} The API response confirming the release.
|
|
791
|
+
*/
|
|
792
|
+
releaseFormTemplate(formTemplateId: string): Promise<string>;
|
|
793
|
+
}
|
|
794
|
+
|
|
795
|
+
/**
|
|
796
|
+
* Manages group operations via the VVRestApi.
|
|
797
|
+
*/
|
|
798
|
+
declare class GroupsManager {
|
|
799
|
+
/**
|
|
800
|
+
* @param {object} httpHelper - The HTTP helper instance used to make API requests.
|
|
801
|
+
*/
|
|
802
|
+
constructor(httpHelper: object);
|
|
803
|
+
_httpHelper: any;
|
|
804
|
+
/**
|
|
805
|
+
* Retrieves a list of groups.
|
|
806
|
+
* @param {object} params - URL parameters to include in the request.
|
|
807
|
+
* @returns {Promise<string>} JSON string containing the list of groups.
|
|
808
|
+
*/
|
|
809
|
+
getGroups(params: object): Promise<string>;
|
|
810
|
+
/**
|
|
811
|
+
* Retrieves a specific group by its ID.
|
|
812
|
+
* @param {object} params - URL parameters to include in the request.
|
|
813
|
+
* @param {string} groupId - The ID (Guid) of the group to retrieve.
|
|
814
|
+
* @returns {Promise<string>} JSON string containing the group details.
|
|
815
|
+
*/
|
|
816
|
+
getGroupById(params: object, groupId: string): Promise<string>;
|
|
817
|
+
/**
|
|
818
|
+
* Creates a new group.
|
|
819
|
+
* @param {object} params - URL parameters to include in the request.
|
|
820
|
+
* @param {object} formData - The group data to submit in the request body.
|
|
821
|
+
* @returns {Promise<string>} JSON string containing the created group details.
|
|
822
|
+
*/
|
|
823
|
+
addGroup(params: object, formData: object): Promise<string>;
|
|
824
|
+
/**
|
|
825
|
+
* Updates an existing group by its ID.
|
|
826
|
+
* @param {object} params - URL parameters to include in the request.
|
|
827
|
+
* @param {string} groupId - The ID (Guid) of the group to update.
|
|
828
|
+
* @param {object} formData - The updated group data to submit in the request body.
|
|
829
|
+
* @returns {Promise<string>} JSON string confirming the group was updated.
|
|
830
|
+
*/
|
|
831
|
+
updateGroup(params: object, groupId: string, formData: object): Promise<string>;
|
|
832
|
+
/**
|
|
833
|
+
* Deletes a group by its ID.
|
|
834
|
+
* @param {object} params - URL parameters to include in the request.
|
|
835
|
+
* @param {string} groupId - The ID (Guid) of the group to delete.
|
|
836
|
+
* @returns {Promise<string>} JSON string confirming the group was deleted.
|
|
837
|
+
*/
|
|
838
|
+
deleteGroup(params: object, groupId: string): Promise<string>;
|
|
839
|
+
/**
|
|
840
|
+
* Retrieves all users belonging to a specific group.
|
|
841
|
+
* @param {object} params - URL parameters to include in the request.
|
|
842
|
+
* @param {string} groupId - The ID (Guid) of the group whose users to retrieve.
|
|
843
|
+
* @returns {Promise<string>} JSON string containing the list of users in the group.
|
|
844
|
+
*/
|
|
845
|
+
getGroupsUsers(params: object, groupId: string): Promise<string>;
|
|
846
|
+
/**
|
|
847
|
+
* Retrieves a specific user within a group.
|
|
848
|
+
* @param {object} params - URL parameters to include in the request.
|
|
849
|
+
* @param {string} groupId - The ID (Guid) of the group to look up the user in.
|
|
850
|
+
* @param {string} userId - The ID (Guid) of the user to retrieve.
|
|
851
|
+
* @returns {Promise<string>} JSON string containing the user's membership details within the group.
|
|
852
|
+
*/
|
|
853
|
+
getGroupUser(params: object, groupId: string, userId: string): Promise<string>;
|
|
854
|
+
/**
|
|
855
|
+
* Adds a user to a group.
|
|
856
|
+
* @param {object} params - URL parameters to include in the request.
|
|
857
|
+
* @param {string} groupId - The ID (Guid) of the group to add the user to.
|
|
858
|
+
* @param {string} userId - The ID (Guid) of the user to add to the group.
|
|
859
|
+
* @returns {Promise<string>} JSON string confirming the user was added to the group.
|
|
860
|
+
*/
|
|
861
|
+
addUserToGroup(params: object, groupId: string, userId: string): Promise<string>;
|
|
862
|
+
/**
|
|
863
|
+
* Removes a user from a group.
|
|
864
|
+
* @param {object} params - URL parameters to include in the request.
|
|
865
|
+
* @param {string} groupId - The ID (Guid) of the group to remove the user from.
|
|
866
|
+
* @param {string} userId - The ID (Guid) of the user to remove from the group.
|
|
867
|
+
* @returns {Promise<string>} JSON string confirming the user was removed from the group.
|
|
868
|
+
*/
|
|
869
|
+
removeUserFromGroup(params: object, groupId: string, userId: string): Promise<string>;
|
|
870
|
+
}
|
|
871
|
+
|
|
872
|
+
/**
|
|
873
|
+
* Manager class for Library (folder) operations.
|
|
874
|
+
*
|
|
875
|
+
* All methods return a `Promise<string>` containing a JSON-encoded API response.
|
|
876
|
+
* When parsed, the response has the shape:
|
|
877
|
+
* ```json
|
|
878
|
+
* {
|
|
879
|
+
* "meta": { "status": 200, "statusMsg": "OK", "errors": [] },
|
|
880
|
+
* "data": { ... }
|
|
881
|
+
* }
|
|
882
|
+
* ```
|
|
883
|
+
* Check `meta.status` to determine success or failure before consuming `data`.
|
|
884
|
+
*/
|
|
885
|
+
declare class LibraryManager {
|
|
886
|
+
/**
|
|
887
|
+
* @param {object} httpHelper - HTTP helper instance
|
|
888
|
+
*/
|
|
889
|
+
constructor(httpHelper: object);
|
|
890
|
+
_httpHelper: any;
|
|
891
|
+
/**
|
|
892
|
+
* Retrieves all folders.
|
|
893
|
+
* @param {object} params - Optional query parameters for filtering and pagination.
|
|
894
|
+
* @returns {Promise<string>} The API response containing the list of folders.
|
|
895
|
+
*/
|
|
896
|
+
getFolders(params: object): Promise<string>;
|
|
897
|
+
/**
|
|
898
|
+
* Creates a new folder at the specified path.
|
|
899
|
+
* @param {object} params - Optional query parameters.
|
|
900
|
+
* @param {object} data - Folder properties to create.
|
|
901
|
+
* @param {string} [data.name] - Folder name; if omitted, derived from the last segment of folderPath.
|
|
902
|
+
* @param {string} [data.description] - Folder description.
|
|
903
|
+
* @param {boolean} [data.allowRevisions] - Whether documents in this folder allow revisions.
|
|
904
|
+
* @param {string} [data.formUploadControlId] - Guid of the form upload control to associate.
|
|
905
|
+
* @param {string} [data.formId] - Guid of the form to associate with the folder.
|
|
906
|
+
* @param {boolean} [data.inheritNamingConvention] - Whether to inherit the naming convention from the parent folder.
|
|
907
|
+
* @param {boolean} [data.inheritRecordRetention] - Whether to inherit record retention settings from the parent folder.
|
|
908
|
+
* @param {string} [data.defaultDocType] - Default document type for the folder.
|
|
909
|
+
* @param {boolean} [data.docTypeRequired] - Whether a document type is required when uploading.
|
|
910
|
+
* @param {string} folderPath - The full path where the folder should be created.
|
|
911
|
+
* @returns {Promise<string>} The API response containing the created folder.
|
|
912
|
+
*/
|
|
913
|
+
postFolderByPath(params: object, data: {
|
|
914
|
+
name?: string;
|
|
915
|
+
description?: string;
|
|
916
|
+
allowRevisions?: boolean;
|
|
917
|
+
formUploadControlId?: string;
|
|
918
|
+
formId?: string;
|
|
919
|
+
inheritNamingConvention?: boolean;
|
|
920
|
+
inheritRecordRetention?: boolean;
|
|
921
|
+
defaultDocType?: string;
|
|
922
|
+
docTypeRequired?: boolean;
|
|
923
|
+
}, folderPath: string): Promise<string>;
|
|
924
|
+
/**
|
|
925
|
+
* Updates a folder's properties.
|
|
926
|
+
* @param {object} params - Optional query parameters.
|
|
927
|
+
* @param {object} data - Folder properties to update.
|
|
928
|
+
* @param {string} [data.name] - New folder name.
|
|
929
|
+
* @param {string} [data.description] - New folder description.
|
|
930
|
+
* @param {string} [data.defaultDocType] - Default document type for the folder.
|
|
931
|
+
* @param {boolean} [data.docTypeRequired] - Whether a document type is required when uploading.
|
|
932
|
+
* @param {string} folderId - The ID of the folder to update.
|
|
933
|
+
* @returns {Promise<string>} The API response containing the updated folder.
|
|
934
|
+
*/
|
|
935
|
+
putFolder(params: object, data: {
|
|
936
|
+
name?: string;
|
|
937
|
+
description?: string;
|
|
938
|
+
defaultDocType?: string;
|
|
939
|
+
docTypeRequired?: boolean;
|
|
940
|
+
}, folderId: string): Promise<string>;
|
|
941
|
+
/**
|
|
942
|
+
* Deletes a folder.
|
|
943
|
+
* @param {string} folderId - The ID of the folder to delete.
|
|
944
|
+
* @returns {Promise<string>} The API response confirming the deletion.
|
|
945
|
+
*/
|
|
946
|
+
deleteFolder(folderId: string): Promise<string>;
|
|
947
|
+
/**
|
|
948
|
+
* Copies a folder to a new location.
|
|
949
|
+
* @param {object} params - Optional query parameters.
|
|
950
|
+
* @param {object} data - Copy options.
|
|
951
|
+
* @param {string} [data.sourceFolderId] - Guid of the folder to copy; use instead of sourceFolderPath.
|
|
952
|
+
* @param {string} [data.sourceFolderPath] - Full path of the folder to copy; use instead of sourceFolderId.
|
|
953
|
+
* @param {string} [data.targetFolderId] - Guid of the destination folder; use instead of targetFolderPath.
|
|
954
|
+
* @param {string} [data.targetFolderPath] - Full path of the destination folder; use instead of targetFolderId.
|
|
955
|
+
* @returns {Promise<string>} The API response confirming the copy operation.
|
|
956
|
+
*/
|
|
957
|
+
copyFolder(params: object, data: {
|
|
958
|
+
sourceFolderId?: string;
|
|
959
|
+
sourceFolderPath?: string;
|
|
960
|
+
targetFolderId?: string;
|
|
961
|
+
targetFolderPath?: string;
|
|
962
|
+
}): Promise<string>;
|
|
963
|
+
/**
|
|
964
|
+
* Moves a folder to a new location.
|
|
965
|
+
* @param {object} params - Optional query parameters.
|
|
966
|
+
* @param {object} data - Move options.
|
|
967
|
+
* @param {string} [data.sourceFolderId] - Guid of the folder to move; use instead of sourceFolderPath.
|
|
968
|
+
* @param {string} [data.sourceFolderPath] - Full path of the folder to move; use instead of sourceFolderId.
|
|
969
|
+
* @param {string} [data.targetFolderId] - Guid of the destination folder; use instead of targetFolderPath.
|
|
970
|
+
* @param {string} [data.targetFolderPath] - Full path of the destination folder; use instead of targetFolderId.
|
|
971
|
+
* @returns {Promise<string>} The API response confirming the move operation.
|
|
972
|
+
*/
|
|
973
|
+
moveFolder(params: object, data: {
|
|
974
|
+
sourceFolderId?: string;
|
|
975
|
+
sourceFolderPath?: string;
|
|
976
|
+
targetFolderId?: string;
|
|
977
|
+
targetFolderPath?: string;
|
|
978
|
+
}): Promise<string>;
|
|
979
|
+
/**
|
|
980
|
+
* Retrieves documents within a specific folder.
|
|
981
|
+
* @param {object} params - Optional query parameters for filtering and pagination.
|
|
982
|
+
* @param {string} folderId - The ID of the folder to retrieve documents from.
|
|
983
|
+
* @returns {Promise<string>} The API response containing the folder's documents.
|
|
984
|
+
*/
|
|
985
|
+
getDocuments(params: object, folderId: string): Promise<string>;
|
|
986
|
+
/**
|
|
987
|
+
* Retrieves a folder by its full path.
|
|
988
|
+
* @param {object} params - Optional query parameters.
|
|
989
|
+
* @param {string} folderPath - The full path of the folder to retrieve.
|
|
990
|
+
* @returns {Promise<string>} The API response containing the folder.
|
|
991
|
+
*/
|
|
992
|
+
getFolderByPath(params: object, folderPath: string): Promise<string>;
|
|
993
|
+
/**
|
|
994
|
+
* Updates the index field override settings for a folder (query, dropdown list, required, default value).
|
|
995
|
+
* @param {string} folderId - The ID of the folder.
|
|
996
|
+
* @param {string} fieldId - The ID of the index field to configure.
|
|
997
|
+
* @param {string} queryId - The ID of the query to use for the field's dropdown.
|
|
998
|
+
* @param {string} displayField - The query field to display in the dropdown.
|
|
999
|
+
* @param {string} valueField - The query field to use as the stored value.
|
|
1000
|
+
* @param {string} dropDownListId - The ID of a static dropdown list, if used instead of a query.
|
|
1001
|
+
* @param {boolean} required - Whether the field is required.
|
|
1002
|
+
* @param {string} defaultValue - The default value for the field.
|
|
1003
|
+
* @returns {Promise<string>} The API response confirming the update.
|
|
1004
|
+
*/
|
|
1005
|
+
updateFolderIndexFieldOverrideSettings(folderId: string, fieldId: string, queryId: string, displayField: string, valueField: string, dropDownListId: string, required: boolean, defaultValue: string): Promise<string>;
|
|
1006
|
+
/**
|
|
1007
|
+
* Retrieves the index fields associated with a folder.
|
|
1008
|
+
* @param {object} params - Optional query parameters for filtering.
|
|
1009
|
+
* @param {string} folderId - The ID of the folder.
|
|
1010
|
+
* @returns {Promise<string>} The API response containing the folder's index fields.
|
|
1011
|
+
*/
|
|
1012
|
+
getFolderIndexFields(params: object, folderId: string): Promise<string>;
|
|
1013
|
+
/**
|
|
1014
|
+
* Subscribes a user to alert notifications for a specific folder event.
|
|
1015
|
+
* @param {string} folderId - The ID of the folder to subscribe to.
|
|
1016
|
+
* @param {string} eventId - The ID of the event to subscribe to.
|
|
1017
|
+
* @param {string} userId - The ID of the user to subscribe.
|
|
1018
|
+
* @returns {Promise<string>} The API response confirming the subscription.
|
|
1019
|
+
*/
|
|
1020
|
+
postFolderAlertSubscription(folderId: string, eventId: string, userId: string): Promise<string>;
|
|
1021
|
+
/**
|
|
1022
|
+
* Removes a user's subscription to alert notifications for a specific folder event.
|
|
1023
|
+
* @param {string} folderId - The ID of the folder.
|
|
1024
|
+
* @param {string} eventId - The ID of the event to unsubscribe from.
|
|
1025
|
+
* @param {string} userId - The ID of the user to unsubscribe.
|
|
1026
|
+
* @returns {Promise<string>} The API response confirming the unsubscription.
|
|
1027
|
+
*/
|
|
1028
|
+
deleteFolderAlertSubscription(folderId: string, eventId: string, userId: string): Promise<string>;
|
|
1029
|
+
/**
|
|
1030
|
+
* Retrieves the security members (users and groups) assigned to a folder.
|
|
1031
|
+
* @param {object} params - Optional query parameters for filtering.
|
|
1032
|
+
* @param {string} folderId - The ID of the folder.
|
|
1033
|
+
* @returns {Promise<string>} The API response containing the folder's security members.
|
|
1034
|
+
*/
|
|
1035
|
+
getFolderSecurityMembers(params: object, folderId: string): Promise<string>;
|
|
1036
|
+
/**
|
|
1037
|
+
* Adds or updates a security member's role on a folder.
|
|
1038
|
+
* @param {string} folderId - The ID of the folder.
|
|
1039
|
+
* @param {string} memberId - The ID of the user or group.
|
|
1040
|
+
* @param {"user"|"group"} memberType - The type of member.
|
|
1041
|
+
* @param {string} securityRole - The security role to assign (e.g., `editor`, `viewer`).
|
|
1042
|
+
* @param {boolean} cascadeSecurityChanges - Whether to apply the change to all subfolders.
|
|
1043
|
+
* @returns {Promise<string>} The API response confirming the update.
|
|
1044
|
+
*/
|
|
1045
|
+
putFolderSecurityMember(folderId: string, memberId: string, memberType: "user" | "group", securityRole: string, cascadeSecurityChanges: boolean): Promise<string>;
|
|
1046
|
+
/**
|
|
1047
|
+
* Removes a security member from a folder.
|
|
1048
|
+
* @param {string} folderId - The ID of the folder.
|
|
1049
|
+
* @param {string} memberId - The ID of the user or group to remove.
|
|
1050
|
+
* @param {boolean} cascadeSecurityChanges - Whether to remove the member from all subfolders.
|
|
1051
|
+
* @returns {Promise<string>} The API response confirming the deletion.
|
|
1052
|
+
*/
|
|
1053
|
+
deleteFolderSecurityMember(folderId: string, memberId: string, cascadeSecurityChanges: boolean): Promise<string>;
|
|
1054
|
+
}
|
|
1055
|
+
|
|
1056
|
+
/**
|
|
1057
|
+
* Manager class for Sites operations.
|
|
1058
|
+
*
|
|
1059
|
+
* All methods return a `Promise<string>` containing a JSON-encoded API response.
|
|
1060
|
+
* When parsed, the response has the shape:
|
|
1061
|
+
* ```json
|
|
1062
|
+
* {
|
|
1063
|
+
* "meta": { "status": 200, "statusMsg": "OK", "errors": [] },
|
|
1064
|
+
* "data": { ... }
|
|
1065
|
+
* }
|
|
1066
|
+
* ```
|
|
1067
|
+
* Check `meta.status` to determine success or failure before consuming `data`.
|
|
1068
|
+
*/
|
|
1069
|
+
declare class SitesManager {
|
|
1070
|
+
/**
|
|
1071
|
+
* @param {object} httpHelper - HTTP helper instance
|
|
1072
|
+
*/
|
|
1073
|
+
constructor(httpHelper: object);
|
|
1074
|
+
_httpHelper: any;
|
|
1075
|
+
/**
|
|
1076
|
+
* Retrieves all sites.
|
|
1077
|
+
* @param {object} params - Optional query parameters for filtering and pagination.
|
|
1078
|
+
* @returns {Promise<string>} The API response containing the list of sites.
|
|
1079
|
+
*/
|
|
1080
|
+
getSites(params: object): Promise<string>;
|
|
1081
|
+
/**
|
|
1082
|
+
* Creates a new site.
|
|
1083
|
+
* @param {object} params - Optional query parameters.
|
|
1084
|
+
* @param {object} data - Site properties to create.
|
|
1085
|
+
* @param {string} data.name - Site name (required).
|
|
1086
|
+
* @param {string} [data.description] - Site description.
|
|
1087
|
+
* @param {string} [data.sitetype] - Site type identifier.
|
|
1088
|
+
* @returns {Promise<string>} The API response containing the created site.
|
|
1089
|
+
*/
|
|
1090
|
+
postSites(params: object, data: {
|
|
1091
|
+
name: string;
|
|
1092
|
+
description?: string;
|
|
1093
|
+
sitetype?: string;
|
|
1094
|
+
}): Promise<string>;
|
|
1095
|
+
/**
|
|
1096
|
+
* Updates an existing site.
|
|
1097
|
+
* @param {object} params - Optional query parameters.
|
|
1098
|
+
* @param {object} data - Site properties to update.
|
|
1099
|
+
* @param {string} [data.name] - New site name.
|
|
1100
|
+
* @param {string} [data.description] - New site description.
|
|
1101
|
+
* @param {string} siteId - The ID of the site to update.
|
|
1102
|
+
* @returns {Promise<string>} The API response containing the updated site.
|
|
1103
|
+
*/
|
|
1104
|
+
putSites(params: object, data: {
|
|
1105
|
+
name?: string;
|
|
1106
|
+
description?: string;
|
|
1107
|
+
}, siteId: string): Promise<string>;
|
|
1108
|
+
/**
|
|
1109
|
+
* Retrieves all groups belonging to a site.
|
|
1110
|
+
* @param {object} params - Optional query parameters for filtering and pagination.
|
|
1111
|
+
* @param {string} siteId - The ID of the site.
|
|
1112
|
+
* @returns {Promise<string>} The API response containing the site's groups.
|
|
1113
|
+
*/
|
|
1114
|
+
getGroups(params: object, siteId: string): Promise<string>;
|
|
1115
|
+
/**
|
|
1116
|
+
* Creates a new group within a site.
|
|
1117
|
+
* @param {object} params - Optional query parameters.
|
|
1118
|
+
* @param {object} data - Group properties to create.
|
|
1119
|
+
* @param {string} data.name - Group name (required).
|
|
1120
|
+
* @param {string} [data.description] - Group description; defaults to name if omitted.
|
|
1121
|
+
* @param {string} siteId - The ID of the site to create the group in.
|
|
1122
|
+
* @returns {Promise<string>} The API response containing the created group.
|
|
1123
|
+
*/
|
|
1124
|
+
postGroups(params: object, data: {
|
|
1125
|
+
name: string;
|
|
1126
|
+
description?: string;
|
|
1127
|
+
}, siteId: string): Promise<string>;
|
|
1128
|
+
/**
|
|
1129
|
+
* Updates a group within a site.
|
|
1130
|
+
* @param {object} params - Optional query parameters.
|
|
1131
|
+
* @param {object} data - Group properties to update.
|
|
1132
|
+
* @param {string} [data.name] - New group name.
|
|
1133
|
+
* @param {string} [data.description] - New group description.
|
|
1134
|
+
* @param {string} siteId - The ID of the site the group belongs to.
|
|
1135
|
+
* @param {string} grId - The ID of the group to update.
|
|
1136
|
+
* @returns {Promise<string>} The API response containing the updated group.
|
|
1137
|
+
*/
|
|
1138
|
+
putGroups(params: object, data: {
|
|
1139
|
+
name?: string;
|
|
1140
|
+
description?: string;
|
|
1141
|
+
}, siteId: string, grId: string): Promise<string>;
|
|
1142
|
+
/**
|
|
1143
|
+
* Moves a user to a different site.
|
|
1144
|
+
* @param {string} userId - The ID of the user to move.
|
|
1145
|
+
* @param {string} newSiteId - The ID of the destination site.
|
|
1146
|
+
* @returns {Promise<string>} The API response confirming the site change.
|
|
1147
|
+
*/
|
|
1148
|
+
changeUserSite(userId: string, newSiteId: string): Promise<string>;
|
|
1149
|
+
/**
|
|
1150
|
+
* Retrieves a specific site by its ID.
|
|
1151
|
+
* @param {object} params - Optional query parameters.
|
|
1152
|
+
* @param {string} siteId - The ID of the site to retrieve.
|
|
1153
|
+
* @returns {Promise<string>} The API response containing the site.
|
|
1154
|
+
*/
|
|
1155
|
+
getSiteById(params: object, siteId: string): Promise<string>;
|
|
1156
|
+
/**
|
|
1157
|
+
* Deletes a site.
|
|
1158
|
+
* @param {object} params - Optional query parameters.
|
|
1159
|
+
* @param {string} siteId - The ID of the site to delete.
|
|
1160
|
+
* @returns {Promise<string>} The API response confirming the deletion.
|
|
1161
|
+
*/
|
|
1162
|
+
deleteSite(params: object, siteId: string): Promise<string>;
|
|
1163
|
+
/**
|
|
1164
|
+
* Moves a group to a different site.
|
|
1165
|
+
* @param {object} params - Optional query parameters.
|
|
1166
|
+
* @param {string} groupId - The ID of the group to move.
|
|
1167
|
+
* @param {string} newSiteId - The ID of the destination site.
|
|
1168
|
+
* @returns {Promise<string>} The API response confirming the site change.
|
|
1169
|
+
*/
|
|
1170
|
+
changeGroupSite(params: object, groupId: string, newSiteId: string): Promise<string>;
|
|
1171
|
+
}
|
|
1172
|
+
|
|
1173
|
+
/**
|
|
1174
|
+
* Manager class for Users operations.
|
|
1175
|
+
*
|
|
1176
|
+
* All methods return a `Promise<string>` containing a JSON-encoded API response.
|
|
1177
|
+
* When parsed, the response has the shape:
|
|
1178
|
+
* ```json
|
|
1179
|
+
* {
|
|
1180
|
+
* "meta": { "status": 200, "statusMsg": "OK", "errors": [] },
|
|
1181
|
+
* "data": { ... }
|
|
1182
|
+
* }
|
|
1183
|
+
* ```
|
|
1184
|
+
* Check `meta.status` to determine success or failure before consuming `data`.
|
|
1185
|
+
*/
|
|
1186
|
+
declare class UsersManager {
|
|
1187
|
+
/**
|
|
1188
|
+
* @param {object} httpHelper - HTTP helper instance
|
|
1189
|
+
*/
|
|
1190
|
+
constructor(httpHelper: object);
|
|
1191
|
+
_httpHelper: any;
|
|
1192
|
+
/**
|
|
1193
|
+
* Retrieves all users belonging to a site.
|
|
1194
|
+
* @param {object} params - Optional query parameters for filtering and pagination.
|
|
1195
|
+
* @param {string} siteId - The ID of the site to retrieve users from.
|
|
1196
|
+
* @returns {Promise<string>} The API response containing the list of users.
|
|
1197
|
+
*/
|
|
1198
|
+
getUsers(params: object, siteId: string): Promise<string>;
|
|
1199
|
+
/**
|
|
1200
|
+
* Creates a new user within a site.
|
|
1201
|
+
* @param {object} params - Optional query parameters.
|
|
1202
|
+
* @param {object} data - User properties to create.
|
|
1203
|
+
* @param {string} data.userId - Username (required if emailAddress is omitted; defaults to emailAddress when omitted).
|
|
1204
|
+
* @param {string} data.emailAddress - User email address (required if userId is omitted).
|
|
1205
|
+
* @param {string} [data.firstName] - User first name.
|
|
1206
|
+
* @param {string} [data.middleInitial] - User middle initial.
|
|
1207
|
+
* @param {string} [data.lastName] - User last name.
|
|
1208
|
+
* @param {string} [data.password] - Initial password.
|
|
1209
|
+
* @param {boolean} [data.mustChangePassword] - Whether the user must change their password on first login.
|
|
1210
|
+
* @param {boolean} [data.sendEmail] - Whether to send a welcome email; defaults to true.
|
|
1211
|
+
* @param {boolean} [data.passwordNeverExpires] - Whether the password never expires.
|
|
1212
|
+
* @param {string} [data.passwordExpires] - Date when the password expires.
|
|
1213
|
+
* @param {boolean} [data.getPasswordResetToken] - If true, the response includes a password reset token.
|
|
1214
|
+
* @param {string} [data.employeeId] - Employee ID.
|
|
1215
|
+
* @param {string} [data.employmentStatus] - Employment status.
|
|
1216
|
+
* @param {string} siteId - The ID of the site to create the user in.
|
|
1217
|
+
* @returns {Promise<string>} The API response containing the created user.
|
|
1218
|
+
*/
|
|
1219
|
+
postUsers(params: object, data: {
|
|
1220
|
+
userId: string;
|
|
1221
|
+
emailAddress: string;
|
|
1222
|
+
firstName?: string;
|
|
1223
|
+
middleInitial?: string;
|
|
1224
|
+
lastName?: string;
|
|
1225
|
+
password?: string;
|
|
1226
|
+
mustChangePassword?: boolean;
|
|
1227
|
+
sendEmail?: boolean;
|
|
1228
|
+
passwordNeverExpires?: boolean;
|
|
1229
|
+
passwordExpires?: string;
|
|
1230
|
+
getPasswordResetToken?: boolean;
|
|
1231
|
+
employeeId?: string;
|
|
1232
|
+
employmentStatus?: string;
|
|
1233
|
+
}, siteId: string): Promise<string>;
|
|
1234
|
+
/**
|
|
1235
|
+
* Updates a user within a site.
|
|
1236
|
+
* @param {object} params - Optional query parameters.
|
|
1237
|
+
* @param {object} data - User properties to update.
|
|
1238
|
+
* @param {string} [data.firstName] - New first name.
|
|
1239
|
+
* @param {string} [data.middleInitial] - New middle initial.
|
|
1240
|
+
* @param {string} [data.lastName] - New last name.
|
|
1241
|
+
* @param {string} [data.emailAddress] - New email address.
|
|
1242
|
+
* @param {string} [data.userId] - New username.
|
|
1243
|
+
* @param {string} [data.password] - New password.
|
|
1244
|
+
* @param {boolean} [data.mustChangePassword] - Whether the user must change their password on next login.
|
|
1245
|
+
* @param {boolean} [data.passwordNeverExpires] - Whether the password never expires.
|
|
1246
|
+
* @param {string} [data.passwordExpires] - Date when the password expires.
|
|
1247
|
+
* @param {string} [data.employeeId] - Employee ID.
|
|
1248
|
+
* @param {string} [data.employmentStatus] - Employment status.
|
|
1249
|
+
* @param {string} siteId - The ID of the site the user belongs to.
|
|
1250
|
+
* @param {string} usId - The ID of the user to update.
|
|
1251
|
+
* @returns {Promise<string>} The API response containing the updated user.
|
|
1252
|
+
*/
|
|
1253
|
+
putUsers(params: object, data: {
|
|
1254
|
+
firstName?: string;
|
|
1255
|
+
middleInitial?: string;
|
|
1256
|
+
lastName?: string;
|
|
1257
|
+
emailAddress?: string;
|
|
1258
|
+
userId?: string;
|
|
1259
|
+
password?: string;
|
|
1260
|
+
mustChangePassword?: boolean;
|
|
1261
|
+
passwordNeverExpires?: boolean;
|
|
1262
|
+
passwordExpires?: string;
|
|
1263
|
+
employeeId?: string;
|
|
1264
|
+
employmentStatus?: string;
|
|
1265
|
+
}, siteId: string, usId: string): Promise<string>;
|
|
1266
|
+
/**
|
|
1267
|
+
* Updates a user via the users endpoint (without site context).
|
|
1268
|
+
* When updating own profile: supports `newPassword`+`oldPassword`, `emailAddress`, and `firstName`+`lastName`.
|
|
1269
|
+
* When an admin updates another user: supports `isVaultAccess` and `enabled` in addition to profile fields.
|
|
1270
|
+
* @param {object} params - Optional query parameters.
|
|
1271
|
+
* @param {object} data - User properties to update.
|
|
1272
|
+
* @param {string} [data.firstName] - New first name.
|
|
1273
|
+
* @param {string} [data.lastName] - New last name.
|
|
1274
|
+
* @param {string} [data.emailAddress] - New email address.
|
|
1275
|
+
* @param {string} [data.newPassword] - New password (requires oldPassword).
|
|
1276
|
+
* @param {string} [data.oldPassword] - Current password (required when changing password).
|
|
1277
|
+
* @param {boolean} [data.isVaultAccess] - Whether the user has vault (account owner) access; admin only.
|
|
1278
|
+
* @param {boolean} [data.enabled] - Whether the user account is enabled; admin only.
|
|
1279
|
+
* @param {string} usId - The ID of the user to update.
|
|
1280
|
+
* @returns {Promise<string>} The API response containing the updated user.
|
|
1281
|
+
*/
|
|
1282
|
+
putUsersEndpoint(params: object, data: {
|
|
1283
|
+
firstName?: string;
|
|
1284
|
+
lastName?: string;
|
|
1285
|
+
emailAddress?: string;
|
|
1286
|
+
newPassword?: string;
|
|
1287
|
+
oldPassword?: string;
|
|
1288
|
+
isVaultAccess?: boolean;
|
|
1289
|
+
enabled?: boolean;
|
|
1290
|
+
}, usId: string): Promise<string>;
|
|
1291
|
+
/**
|
|
1292
|
+
* Retrieves users matching optional query parameters.
|
|
1293
|
+
* @param {object} params - Optional query parameters for filtering and pagination.
|
|
1294
|
+
* @returns {Promise<string>} The API response containing the matching users.
|
|
1295
|
+
*/
|
|
1296
|
+
getUser(params: object): Promise<string>;
|
|
1297
|
+
/**
|
|
1298
|
+
* Retrieves a specific user by their ID.
|
|
1299
|
+
* @param {object} params - Optional query parameters.
|
|
1300
|
+
* @param {string} usId - The ID of the user to retrieve.
|
|
1301
|
+
* @returns {Promise<string>} The API response containing the user.
|
|
1302
|
+
*/
|
|
1303
|
+
getUserById(params: object, usId: string): Promise<string>;
|
|
1304
|
+
/**
|
|
1305
|
+
* Retrieves the groups a user belongs to.
|
|
1306
|
+
* @param {object} params - Optional query parameters for filtering and pagination.
|
|
1307
|
+
* @param {string} usId - The ID of the user.
|
|
1308
|
+
* @returns {Promise<string>} The API response containing the user's groups.
|
|
1309
|
+
*/
|
|
1310
|
+
getUserGroups(params: object, usId: string): Promise<string>;
|
|
1311
|
+
/**
|
|
1312
|
+
* Retrieves the supervisors of a user.
|
|
1313
|
+
* @param {object} params - Optional query parameters for filtering and pagination.
|
|
1314
|
+
* @param {string} usId - The ID of the user.
|
|
1315
|
+
* @returns {Promise<string>} The API response containing the user's supervisors.
|
|
1316
|
+
*/
|
|
1317
|
+
getUserSupervisors(params: object, usId: string): Promise<string>;
|
|
1318
|
+
/**
|
|
1319
|
+
* Retrieves the supervisees of a user.
|
|
1320
|
+
* @param {object} params - Optional query parameters for filtering and pagination.
|
|
1321
|
+
* @param {string} usId - The ID of the user.
|
|
1322
|
+
* @returns {Promise<string>} The API response containing the user's supervisees.
|
|
1323
|
+
*/
|
|
1324
|
+
getUserSupervisees(params: object, usId: string): Promise<string>;
|
|
1325
|
+
/**
|
|
1326
|
+
* Retrieves a web login token for a user.
|
|
1327
|
+
* @param {string} usId - The ID of the user.
|
|
1328
|
+
* @returns {Promise<string>} The API response containing the user's login token.
|
|
1329
|
+
*/
|
|
1330
|
+
getUserLoginToken(usId: string): Promise<string>;
|
|
1331
|
+
/**
|
|
1332
|
+
* Retrieves a JWT for the current user, optionally scoped to an audience.
|
|
1333
|
+
* @param {string} [audience] - The intended audience for the JWT.
|
|
1334
|
+
* @returns {Promise<string>} The API response containing the JWT token data.
|
|
1335
|
+
*/
|
|
1336
|
+
getUserJwt(audience?: string): Promise<string>;
|
|
1337
|
+
/**
|
|
1338
|
+
* Retrieves the currently authenticated user's profile.
|
|
1339
|
+
* @returns {Promise<string>} The API response containing the current user's data.
|
|
1340
|
+
*/
|
|
1341
|
+
getCurrentUser(): Promise<string>;
|
|
1342
|
+
/**
|
|
1343
|
+
* Resets a user's password, optionally sending a notification email.
|
|
1344
|
+
* @param {string} usId - The ID of the user whose password to reset.
|
|
1345
|
+
* @param {boolean} [sendEmail=true] - Whether to send a password reset email to the user.
|
|
1346
|
+
* @returns {Promise<string>} The API response confirming the password reset.
|
|
1347
|
+
*/
|
|
1348
|
+
resetPassword(usId: string, sendEmail?: boolean): Promise<string>;
|
|
1349
|
+
/**
|
|
1350
|
+
* Updates the username (userId) of an existing user.
|
|
1351
|
+
* @param {string} usId - The ID of the user to update.
|
|
1352
|
+
* @param {string} newUserId - The new username to assign.
|
|
1353
|
+
* @returns {Promise<string>} The API response confirming the update.
|
|
1354
|
+
*/
|
|
1355
|
+
updateUserId(usId: string, newUserId: string): Promise<string>;
|
|
1356
|
+
}
|
|
1357
|
+
|
|
1358
|
+
/**
|
|
1359
|
+
* Manages scheduled process operations via the VVRestApi.
|
|
1360
|
+
*/
|
|
1361
|
+
declare class ScheduledProcessManager {
|
|
1362
|
+
/**
|
|
1363
|
+
* @param {object} httpHelper - The HTTP helper instance used to make API requests.
|
|
1364
|
+
*/
|
|
1365
|
+
constructor(httpHelper: object);
|
|
1366
|
+
_httpHelper: any;
|
|
1367
|
+
/**
|
|
1368
|
+
* Posts a completion status for a scheduled process.
|
|
1369
|
+
* @param {string} id - The ID of the scheduled process to complete.
|
|
1370
|
+
* @param {string} action - The action taken by the scheduled process.
|
|
1371
|
+
* @param {boolean|string} result - The result of the scheduled process execution.
|
|
1372
|
+
* @param {string} [message] - An optional message describing the result.
|
|
1373
|
+
* @returns {Promise<string>} JSON string confirming the completion was recorded.
|
|
1374
|
+
*/
|
|
1375
|
+
postCompletion(id: string, action: string, result: boolean | string, message?: string): Promise<string>;
|
|
1376
|
+
/**
|
|
1377
|
+
* Triggers an immediate run of all pending scheduled processes.
|
|
1378
|
+
* @returns {Promise<string>} JSON string confirming the scheduled processes were triggered.
|
|
1379
|
+
*/
|
|
1380
|
+
runAllScheduledProcesses(): Promise<string>;
|
|
1381
|
+
}
|
|
1382
|
+
|
|
1383
|
+
/**
|
|
1384
|
+
* Manages script and web service execution via the VVRestApi.
|
|
1385
|
+
*/
|
|
1386
|
+
declare class ScriptsManager {
|
|
1387
|
+
/**
|
|
1388
|
+
* @param {object} httpHelper - The HTTP helper instance used to make API requests.
|
|
1389
|
+
*/
|
|
1390
|
+
constructor(httpHelper: object);
|
|
1391
|
+
_httpHelper: any;
|
|
1392
|
+
/**
|
|
1393
|
+
* Executes a named web service script.
|
|
1394
|
+
* @param {string} serviceName - The name of the web service script to run.
|
|
1395
|
+
* @param {object} serviceData - The data to pass to the script in the request body.
|
|
1396
|
+
* @param {string} [usId] - The user session ID to run the script on behalf of.
|
|
1397
|
+
* @returns {Promise<string>} JSON string containing the script execution result.
|
|
1398
|
+
*/
|
|
1399
|
+
runWebService(serviceName: string, serviceData: object, usId?: string): Promise<string>;
|
|
1400
|
+
/**
|
|
1401
|
+
* Completes a workflow web service execution and returns variables to the workflow.
|
|
1402
|
+
* @param {string} executionId - The ID of the workflow script execution to complete.
|
|
1403
|
+
* @param {object[]} workflowVariables - The workflow variables to return upon completion.
|
|
1404
|
+
* @returns {Promise<string>} JSON string confirming the workflow completion was recorded.
|
|
1405
|
+
*/
|
|
1406
|
+
completeWorkflowWebService(executionId: string, workflowVariables: object[]): Promise<string>;
|
|
1407
|
+
}
|
|
1408
|
+
|
|
1409
|
+
/**
|
|
1410
|
+
* Manages project alert subscription operations via the VVRestApi.
|
|
1411
|
+
*/
|
|
1412
|
+
declare class ProjectsManager {
|
|
1413
|
+
/**
|
|
1414
|
+
* @param {object} httpHelper - The HTTP helper instance used to make API requests.
|
|
1415
|
+
*/
|
|
1416
|
+
constructor(httpHelper: object);
|
|
1417
|
+
_httpHelper: any;
|
|
1418
|
+
/**
|
|
1419
|
+
* Subscribes a user to alerts for a specific project event.
|
|
1420
|
+
* @param {string} projectId - The ID (Guid) of the project to subscribe to.
|
|
1421
|
+
* @param {string} eventId - The ID (Guid) of the project event to subscribe to.
|
|
1422
|
+
* @param {string} userId - The ID (Guid) of the user to subscribe.
|
|
1423
|
+
* @returns {Promise<string>} JSON string confirming the alert subscription was created.
|
|
1424
|
+
*/
|
|
1425
|
+
postProjectAlertSubscription(projectId: string, eventId: string, userId: string): Promise<string>;
|
|
1426
|
+
/**
|
|
1427
|
+
* Removes a user's subscription from alerts for a specific project event.
|
|
1428
|
+
* @param {string} projectId - The ID (Guid) of the project to unsubscribe from.
|
|
1429
|
+
* @param {string} eventId - The ID (Guid) of the project event to unsubscribe from.
|
|
1430
|
+
* @param {string} userId - The ID (Guid) of the user to unsubscribe.
|
|
1431
|
+
* @returns {Promise<string>} JSON string confirming the alert subscription was removed.
|
|
1432
|
+
*/
|
|
1433
|
+
deleteProjectAlertSubscription(projectId: string, eventId: string, userId: string): Promise<string>;
|
|
1434
|
+
}
|
|
1435
|
+
|
|
1436
|
+
/**
|
|
1437
|
+
* Manages customer-level operations such as invitations and user assignments.
|
|
1438
|
+
*/
|
|
1439
|
+
declare class CustomerManager {
|
|
1440
|
+
/**
|
|
1441
|
+
* @param {object} httpHelper - The HTTP helper instance used to make API requests.
|
|
1442
|
+
*/
|
|
1443
|
+
constructor(httpHelper: object);
|
|
1444
|
+
_httpHelper: any;
|
|
1445
|
+
/**
|
|
1446
|
+
* Creates a new customer invitation.
|
|
1447
|
+
* @param {object} data - The invitation data to submit in the request body.
|
|
1448
|
+
* @param {string} [data.email] - The email address to send the invitation code to. If omitted, the invite code is returned in the response metadata instead.
|
|
1449
|
+
* @returns {Promise<string>} The API response containing the created invitation details.
|
|
1450
|
+
*/
|
|
1451
|
+
createCustomerInvite(data: {
|
|
1452
|
+
email?: string;
|
|
1453
|
+
}): Promise<string>;
|
|
1454
|
+
/**
|
|
1455
|
+
* Assigns a user to a customer.
|
|
1456
|
+
* @param {string} customerId - The ID (Guid) of the customer to assign the user to.
|
|
1457
|
+
* @param {object} data - The user assignment data to submit in the request body.
|
|
1458
|
+
* @param {string} data.userId - The username (authentication user ID) of the user to assign.
|
|
1459
|
+
* @param {boolean} [data.allowMultipleCustomers] - Whether to allow the user to belong to multiple customers if already assigned to another.
|
|
1460
|
+
* @returns {Promise<string>} The API response confirming the user assignment.
|
|
1461
|
+
*/
|
|
1462
|
+
assignUser(customerId: string, data: {
|
|
1463
|
+
userId: string;
|
|
1464
|
+
allowMultipleCustomers?: boolean;
|
|
1465
|
+
}): Promise<string>;
|
|
1466
|
+
}
|
|
1467
|
+
|
|
1468
|
+
/**
|
|
1469
|
+
* Manages user assignment operations on customer databases.
|
|
1470
|
+
*/
|
|
1471
|
+
declare class CustomerDatabaseManager {
|
|
1472
|
+
/**
|
|
1473
|
+
* @param {object} httpHelper - The HTTP helper instance used to make API requests.
|
|
1474
|
+
*/
|
|
1475
|
+
constructor(httpHelper: object);
|
|
1476
|
+
_httpHelper: any;
|
|
1477
|
+
/**
|
|
1478
|
+
* Assigns a user to a customer database.
|
|
1479
|
+
* @param {string} customerId - The ID (Guid) of the customer database to assign the user to.
|
|
1480
|
+
* @param {object} data - The user assignment data to submit in the request body.
|
|
1481
|
+
* @param {string} data.userId - The username (authentication user ID) of the user to assign.
|
|
1482
|
+
* @returns {Promise<string>} The API response confirming the user assignment.
|
|
1483
|
+
*/
|
|
1484
|
+
assignUser(customerId: string, data: {
|
|
1485
|
+
userId: string;
|
|
1486
|
+
}): Promise<string>;
|
|
1487
|
+
/**
|
|
1488
|
+
* Removes a user from a customer database.
|
|
1489
|
+
* @param {string} authenticationUserId - The authentication user ID of the user to remove.
|
|
1490
|
+
* @param {string} databaseId - The ID (Guid) of the customer database to remove the user from.
|
|
1491
|
+
* @returns {Promise<string>} The API response confirming the user removal.
|
|
1492
|
+
*/
|
|
1493
|
+
removeUser(authenticationUserId: string, databaseId: string): Promise<string>;
|
|
1494
|
+
}
|
|
1495
|
+
|
|
1496
|
+
/**
|
|
1497
|
+
* Manages index field operations via the VVRestApi.
|
|
1498
|
+
*/
|
|
1499
|
+
declare class IndexFieldsManager {
|
|
1500
|
+
/**
|
|
1501
|
+
* @param {object} httpHelper - The HTTP helper instance used to make API requests.
|
|
1502
|
+
*/
|
|
1503
|
+
constructor(httpHelper: object);
|
|
1504
|
+
_httpHelper: any;
|
|
1505
|
+
/**
|
|
1506
|
+
* Retrieves all index fields.
|
|
1507
|
+
* @param {object} params - URL parameters to include in the request.
|
|
1508
|
+
* @returns {Promise<string>} JSON string containing the list of index fields.
|
|
1509
|
+
*/
|
|
1510
|
+
getIndexFields(params: object): Promise<string>;
|
|
1511
|
+
/**
|
|
1512
|
+
* Retrieves a specific index field by its ID.
|
|
1513
|
+
* @param {object} params - URL parameters to include in the request.
|
|
1514
|
+
* @param {string} id - The ID (Guid) of the index field to retrieve.
|
|
1515
|
+
* @returns {Promise<string>} JSON string containing the index field details.
|
|
1516
|
+
*/
|
|
1517
|
+
getIndexField(params: object, id: string): Promise<string>;
|
|
1518
|
+
/**
|
|
1519
|
+
* Payload for creating or updating index fields.
|
|
1520
|
+
* @typedef {object} IndexFieldData
|
|
1521
|
+
* @property {string} fieldType
|
|
1522
|
+
* @property {string} label
|
|
1523
|
+
* @property {string} [description]
|
|
1524
|
+
* @property {boolean} [required]
|
|
1525
|
+
* @property {string|null} [connectionId]
|
|
1526
|
+
* @property {string|null} [queryId]
|
|
1527
|
+
* @property {string|null} [queryDisplayField]
|
|
1528
|
+
* @property {string|null} [queryValueField]
|
|
1529
|
+
* @property {string|null} [dropDownListId]
|
|
1530
|
+
* @property {string|null} [defaultValue]
|
|
1531
|
+
*/
|
|
1532
|
+
/**
|
|
1533
|
+
* Creates a new index field.
|
|
1534
|
+
* @param {object} params - URL parameters to include in the request.
|
|
1535
|
+
* @param {IndexFieldData} data - The index field data to submit in the request body.
|
|
1536
|
+
* @returns {Promise<string>} JSON string containing the created index field details.
|
|
1537
|
+
*/
|
|
1538
|
+
createIndexField(params: object, data: {
|
|
1539
|
+
fieldType: string;
|
|
1540
|
+
label: string;
|
|
1541
|
+
description?: string;
|
|
1542
|
+
required?: boolean;
|
|
1543
|
+
connectionId?: string | null;
|
|
1544
|
+
queryId?: string | null;
|
|
1545
|
+
queryDisplayField?: string | null;
|
|
1546
|
+
queryValueField?: string | null;
|
|
1547
|
+
dropDownListId?: string | null;
|
|
1548
|
+
defaultValue?: string | null;
|
|
1549
|
+
}): Promise<string>;
|
|
1550
|
+
/**
|
|
1551
|
+
* Updates an existing index field by its ID.
|
|
1552
|
+
* @param {object} params - URL parameters to include in the request.
|
|
1553
|
+
* @param {string} id - The ID (Guid) of the index field to update.
|
|
1554
|
+
* @param {IndexFieldData} data - The updated index field data to submit in the request body.
|
|
1555
|
+
* @returns {Promise<string>} JSON string confirming the index field was updated.
|
|
1556
|
+
*/
|
|
1557
|
+
updateIndexField(params: object, id: string, data: {
|
|
1558
|
+
fieldType: string;
|
|
1559
|
+
label: string;
|
|
1560
|
+
description?: string;
|
|
1561
|
+
required?: boolean;
|
|
1562
|
+
connectionId?: string | null;
|
|
1563
|
+
queryId?: string | null;
|
|
1564
|
+
queryDisplayField?: string | null;
|
|
1565
|
+
queryValueField?: string | null;
|
|
1566
|
+
dropDownListId?: string | null;
|
|
1567
|
+
defaultValue?: string | null;
|
|
1568
|
+
}): Promise<string>;
|
|
1569
|
+
/**
|
|
1570
|
+
* Deletes an index field by its ID.
|
|
1571
|
+
* @param {object} params - URL parameters to include in the request.
|
|
1572
|
+
* @param {string} id - The ID (Guid) of the index field to delete.
|
|
1573
|
+
* @returns {Promise<string>} JSON string confirming the index field was deleted.
|
|
1574
|
+
*/
|
|
1575
|
+
deleteIndexField(params: object, id: string): Promise<string>;
|
|
1576
|
+
/**
|
|
1577
|
+
* Moves an index field to appear after a specified destination field.
|
|
1578
|
+
* @param {object} params - URL parameters to include in the request.
|
|
1579
|
+
* @param {string} sourceFieldId - The ID (Guid) of the index field to move.
|
|
1580
|
+
* @param {string} destinationFieldId - The ID (Guid) of the index field to place the source after.
|
|
1581
|
+
* @returns {Promise<string>} JSON string confirming the index field was moved.
|
|
1582
|
+
*/
|
|
1583
|
+
moveIndexFieldAfter(params: object, sourceFieldId: string, destinationFieldId: string): Promise<string>;
|
|
1584
|
+
/**
|
|
1585
|
+
* Associates an index field with a folder.
|
|
1586
|
+
* @param {string} indexFieldId - The ID (Guid) of the index field to associate.
|
|
1587
|
+
* @param {string} folderId - The ID (Guid) of the folder to associate the index field with.
|
|
1588
|
+
* @returns {Promise<string>} JSON string confirming the index field was added to the folder.
|
|
1589
|
+
*/
|
|
1590
|
+
addIndexFieldToFolder(indexFieldId: string, folderId: string): Promise<string>;
|
|
1591
|
+
}
|
|
1592
|
+
|
|
1593
|
+
/**
|
|
1594
|
+
* Manages outside process retrieval operations via the VVRestApi.
|
|
1595
|
+
*/
|
|
1596
|
+
declare class OutsideProcessesManager {
|
|
1597
|
+
/**
|
|
1598
|
+
* @param {object} httpHelper - The HTTP helper instance used to make API requests.
|
|
1599
|
+
*/
|
|
1600
|
+
constructor(httpHelper: object);
|
|
1601
|
+
_httpHelper: any;
|
|
1602
|
+
/**
|
|
1603
|
+
* Retrieves a list of outside processes.
|
|
1604
|
+
* @param {object} params - URL parameters to include in the request.
|
|
1605
|
+
* @returns {Promise<string>} JSON string containing the list of outside processes.
|
|
1606
|
+
*/
|
|
1607
|
+
getOutsideProcesses(params: object): Promise<string>;
|
|
1608
|
+
}
|
|
1609
|
+
|
|
1610
|
+
/**
|
|
1611
|
+
* Manages security member operations via the VVRestApi.
|
|
1612
|
+
*/
|
|
1613
|
+
declare class SecurityMembersManager {
|
|
1614
|
+
/**
|
|
1615
|
+
* @param {object} httpHelper - The HTTP helper instance used to make API requests.
|
|
1616
|
+
*/
|
|
1617
|
+
constructor(httpHelper: object);
|
|
1618
|
+
_httpHelper: any;
|
|
1619
|
+
/**
|
|
1620
|
+
* Adds a user or group as a security member to a parent resource.
|
|
1621
|
+
* @param {string} parentId - The ID (Guid) of the parent resource to add the member to.
|
|
1622
|
+
* @param {string} memberId - The ID (Guid) of the user or group to add as a member.
|
|
1623
|
+
* @param {string} roleType - The role to assign to the member on the parent resource.
|
|
1624
|
+
* @param {boolean} isGroup - Whether the member being added is a group.
|
|
1625
|
+
* @returns {Promise<string>} JSON string containing the created security member details.
|
|
1626
|
+
*/
|
|
1627
|
+
addSecurityMember(parentId: string, memberId: string, roleType: string, isGroup: boolean): Promise<string>;
|
|
1628
|
+
/**
|
|
1629
|
+
* Retrieves all security members associated with a parent resource.
|
|
1630
|
+
* @param {string} parentId - The ID (Guid) of the parent resource whose members to retrieve.
|
|
1631
|
+
* @returns {Promise<string>} JSON string containing the list of security members.
|
|
1632
|
+
*/
|
|
1633
|
+
getSecurityMembersForParentId(parentId: string): Promise<string>;
|
|
1634
|
+
/**
|
|
1635
|
+
* Removes a security member from a parent resource.
|
|
1636
|
+
* @param {string} parentId - The ID (Guid) of the parent resource to remove the member from.
|
|
1637
|
+
* @param {string} memberId - The ID (Guid) of the user or group to remove.
|
|
1638
|
+
* @returns {Promise<string>} JSON string confirming the security member was removed.
|
|
1639
|
+
*/
|
|
1640
|
+
removeSecurityMember(parentId: string, memberId: string): Promise<string>;
|
|
1641
|
+
/**
|
|
1642
|
+
* Updates the role of an existing security member on a parent resource.
|
|
1643
|
+
* @param {string} parentId - The ID (Guid) of the parent resource containing the member.
|
|
1644
|
+
* @param {string} memberId - The ID (Guid) of the user or group whose role to update.
|
|
1645
|
+
* @param {string} roleType - The new role to assign to the member.
|
|
1646
|
+
* @returns {Promise<string>} JSON string confirming the security member role was updated.
|
|
1647
|
+
*/
|
|
1648
|
+
updateSecurityMember(parentId: string, memberId: string, roleType: string): Promise<string>;
|
|
1649
|
+
}
|
|
1650
|
+
|
|
1651
|
+
/**
|
|
1652
|
+
* Manages layout retrieval operations via the VVRestApi.
|
|
1653
|
+
*/
|
|
1654
|
+
declare class LayoutsManager {
|
|
1655
|
+
/**
|
|
1656
|
+
* @param {object} httpHelper - The HTTP helper instance used to make API requests.
|
|
1657
|
+
*/
|
|
1658
|
+
constructor(httpHelper: object);
|
|
1659
|
+
_httpHelper: any;
|
|
1660
|
+
/**
|
|
1661
|
+
* Retrieves the layout configuration for the current site.
|
|
1662
|
+
* @returns {Promise<string>} JSON string containing the layout configuration.
|
|
1663
|
+
*/
|
|
1664
|
+
getLayout(): Promise<string>;
|
|
1665
|
+
}
|
|
1666
|
+
|
|
1667
|
+
/**
|
|
1668
|
+
* Manages report retrieval operations via the VVRestApi.
|
|
1669
|
+
*/
|
|
1670
|
+
declare class ReportsManager {
|
|
1671
|
+
/**
|
|
1672
|
+
* @param {object} httpHelper - The HTTP helper instance used to make API requests.
|
|
1673
|
+
*/
|
|
1674
|
+
constructor(httpHelper: object);
|
|
1675
|
+
_httpHelper: any;
|
|
1676
|
+
/**
|
|
1677
|
+
* Retrieves a list of available reports.
|
|
1678
|
+
* @param {object} params - URL parameters to include in the request.
|
|
1679
|
+
* @returns {Promise<string>} JSON string containing the list of reports.
|
|
1680
|
+
*/
|
|
1681
|
+
getReports(params: object): Promise<string>;
|
|
1682
|
+
/**
|
|
1683
|
+
* Downloads a report as a PDF by its ID.
|
|
1684
|
+
* @param {string} reportId - The ID (Guid) of the report to download.
|
|
1685
|
+
* @param {object} params - URL parameters to include in the request.
|
|
1686
|
+
* @returns {Promise<Buffer>} The API response containing the raw PDF file bytes.
|
|
1687
|
+
*/
|
|
1688
|
+
getReportPDF(reportId: string, params: object): Promise<Buffer>;
|
|
1689
|
+
}
|
|
1690
|
+
|
|
1691
|
+
/**
|
|
1692
|
+
* Manages language resource operations via the VVRestApi.
|
|
1693
|
+
*/
|
|
1694
|
+
declare class LanguageResourcesManager {
|
|
1695
|
+
/**
|
|
1696
|
+
* @param {object} httpHelper - The HTTP helper instance used to make API requests.
|
|
1697
|
+
* @param {string} baseUrl - The base URL of the VisualVault server.
|
|
1698
|
+
*/
|
|
1699
|
+
constructor(httpHelper: object, baseUrl: string);
|
|
1700
|
+
_httpHelper: any;
|
|
1701
|
+
_baseUrl: string;
|
|
1702
|
+
_apiUrl: any;
|
|
1703
|
+
/**
|
|
1704
|
+
* Retrieves available language areas.
|
|
1705
|
+
* @param {object} params - URL parameters to include in the request.
|
|
1706
|
+
* @returns {Promise<string>} JSON string containing the list of language areas.
|
|
1707
|
+
*/
|
|
1708
|
+
getLanguageAreas(params: object): Promise<string>;
|
|
1709
|
+
/**
|
|
1710
|
+
* Retrieves available languages.
|
|
1711
|
+
* @param {object} params - URL parameters to include in the request.
|
|
1712
|
+
* @returns {Promise<string>} JSON string containing the list of available languages.
|
|
1713
|
+
*/
|
|
1714
|
+
getLanguages(params: object): Promise<string>;
|
|
1715
|
+
/**
|
|
1716
|
+
* Exports language resource translations as a downloadable file.
|
|
1717
|
+
* @param {object} params - URL parameters to include in the request.
|
|
1718
|
+
* @returns {Promise<Buffer>} The API response containing the raw exported language file bytes.
|
|
1719
|
+
*/
|
|
1720
|
+
exportLanguages(params: object): Promise<Buffer>;
|
|
1721
|
+
/**
|
|
1722
|
+
* Imports language resource translations from a file.
|
|
1723
|
+
* @param {object} params - URL parameters containing the target area and language (params.area, params.lang).
|
|
1724
|
+
* @param {Buffer} fileData - The raw file bytes of the language file to import.
|
|
1725
|
+
* @param {string} fileName - The name of the file being imported.
|
|
1726
|
+
* @returns {Promise<string>} JSON string confirming the language import was processed.
|
|
1727
|
+
*/
|
|
1728
|
+
importLanguages(params: object, fileData: Buffer, fileName: string): Promise<string>;
|
|
1729
|
+
}
|
|
1730
|
+
|
|
1731
|
+
/**
|
|
1732
|
+
* Manages dropdown list operations via the VVRestApi.
|
|
1733
|
+
*/
|
|
1734
|
+
declare class DropdownListsManager {
|
|
1735
|
+
/**
|
|
1736
|
+
* @param {object} httpHelper - The HTTP helper instance used to make API requests.
|
|
1737
|
+
*/
|
|
1738
|
+
constructor(httpHelper: object);
|
|
1739
|
+
_httpHelper: any;
|
|
1740
|
+
/**
|
|
1741
|
+
* Retrieves all dropdown lists.
|
|
1742
|
+
* @param {object} params - URL parameters to include in the request.
|
|
1743
|
+
* @returns {Promise<string>} JSON string containing the list of dropdown lists.
|
|
1744
|
+
*/
|
|
1745
|
+
getDropDownLists(params: object): Promise<string>;
|
|
1746
|
+
/**
|
|
1747
|
+
* Retrieves a specific dropdown list by its ID.
|
|
1748
|
+
* @param {object} params - URL parameters to include in the request.
|
|
1749
|
+
* @param {string} listId - The ID (Guid) of the dropdown list to retrieve.
|
|
1750
|
+
* @returns {Promise<string>} JSON string containing the dropdown list details.
|
|
1751
|
+
*/
|
|
1752
|
+
getDropDownListById(params: object, listId: string): Promise<string>;
|
|
1753
|
+
/**
|
|
1754
|
+
* Retrieves the items of a specific dropdown list by its ID.
|
|
1755
|
+
* @param {object} params - URL parameters to include in the request.
|
|
1756
|
+
* @param {string} listId - The ID (Guid) of the dropdown list whose items to retrieve.
|
|
1757
|
+
* @returns {Promise<string>} JSON string containing the dropdown list items.
|
|
1758
|
+
*/
|
|
1759
|
+
getDropDownListItemsById(params: object, listId: string): Promise<string>;
|
|
1760
|
+
/**
|
|
1761
|
+
* Creates a new dropdown list with the specified items.
|
|
1762
|
+
* @param {object} params - URL parameters to include in the request.
|
|
1763
|
+
* @param {string} ddName - The name of the new dropdown list.
|
|
1764
|
+
* @param {string} ddDescription - The description of the new dropdown list.
|
|
1765
|
+
* @param {object[]} ddItems - The items to include in the new dropdown list.
|
|
1766
|
+
* @returns {Promise<string>} JSON string containing the created dropdown list details.
|
|
1767
|
+
*/
|
|
1768
|
+
addDropDownList(params: object, ddName: string, ddDescription: string, ddItems: object[]): Promise<string>;
|
|
1769
|
+
/**
|
|
1770
|
+
* Deletes a dropdown list by its ID.
|
|
1771
|
+
* @param {object} params - URL parameters to include in the request.
|
|
1772
|
+
* @param {string} listId - The ID (Guid) of the dropdown list to delete.
|
|
1773
|
+
* @returns {Promise<string>} JSON string confirming the dropdown list was deleted.
|
|
1774
|
+
*/
|
|
1775
|
+
deleteDropDownList(params: object, listId: string): Promise<string>;
|
|
1776
|
+
/**
|
|
1777
|
+
* Updates an existing dropdown list by its ID.
|
|
1778
|
+
* @param {object} params - URL parameters to include in the request.
|
|
1779
|
+
* @param {string} listId - The ID (Guid) of the dropdown list to update.
|
|
1780
|
+
* @param {string} ddName - The updated name for the dropdown list.
|
|
1781
|
+
* @param {string} ddDescription - The updated description for the dropdown list.
|
|
1782
|
+
* @param {object[]} items - The updated items for the dropdown list.
|
|
1783
|
+
* @returns {Promise<string>} JSON string confirming the dropdown list was updated.
|
|
1784
|
+
*/
|
|
1785
|
+
updateDropDownList(params: object, listId: string, ddName: string, ddDescription: string, items: object[]): Promise<string>;
|
|
1786
|
+
/**
|
|
1787
|
+
* Deletes one or more items from a dropdown list.
|
|
1788
|
+
* @param {object} params - URL parameters to include in the request.
|
|
1789
|
+
* @param {string} listId - The ID (Guid) of the dropdown list containing the items to delete.
|
|
1790
|
+
* @param {string[]} itemIds - Array of item IDs to delete from the dropdown list.
|
|
1791
|
+
* @returns {Promise<string>} JSON string confirming the items were deleted.
|
|
1792
|
+
*/
|
|
1793
|
+
deleteDropDownListItem(params: object, listId: string, itemIds: string[]): Promise<string>;
|
|
1794
|
+
}
|
|
1795
|
+
|
|
1796
|
+
/**
|
|
1797
|
+
* Manages operations for the currently authenticated user.
|
|
1798
|
+
*/
|
|
1799
|
+
declare class CurrentUserManager {
|
|
1800
|
+
/**
|
|
1801
|
+
* @param {object} httpHelper - The HTTP helper instance used to make API requests.
|
|
1802
|
+
*/
|
|
1803
|
+
constructor(httpHelper: object);
|
|
1804
|
+
_httpHelper: any;
|
|
1805
|
+
/**
|
|
1806
|
+
* Gets the currently authenticated user's information.
|
|
1807
|
+
* @param {object} [params] - Optional query parameters to include in the request.
|
|
1808
|
+
* @returns {Promise<string>} JSON string containing the current user's details.
|
|
1809
|
+
*/
|
|
1810
|
+
getCurrentUser(params?: object): Promise<string>;
|
|
1811
|
+
}
|
|
1812
|
+
|
|
1813
|
+
/**
|
|
1814
|
+
* Manager class for document API operations.
|
|
1815
|
+
*
|
|
1816
|
+
* All methods return a `Promise<string>` containing a JSON-encoded API response.
|
|
1817
|
+
* When parsed, the response has the shape:
|
|
1818
|
+
* ```json
|
|
1819
|
+
* {
|
|
1820
|
+
* "meta": { "status": 200, "statusMsg": "OK", "errors": [] },
|
|
1821
|
+
* "data": { ... }
|
|
1822
|
+
* }
|
|
1823
|
+
* ```
|
|
1824
|
+
* Check `meta.status` to determine success or failure before consuming `data`.
|
|
1825
|
+
*/
|
|
1826
|
+
declare class DocumentManager {
|
|
1827
|
+
/**
|
|
1828
|
+
* @param {object} httpHelper - The HTTP helper instance used to make API requests.
|
|
1829
|
+
*/
|
|
1830
|
+
constructor(httpHelper: object);
|
|
1831
|
+
_httpHelper: any;
|
|
1832
|
+
/**
|
|
1833
|
+
* Creates a new document.
|
|
1834
|
+
* @param {object} data - The document creation payload.
|
|
1835
|
+
* @param {string} data.folderId - (Required) The Guid of the folder to create the document in.
|
|
1836
|
+
* @param {string} [data.name] - The document name.
|
|
1837
|
+
* @param {string} [data.revision] - The revision label.
|
|
1838
|
+
* @param {string} [data.documentState] - The document state.
|
|
1839
|
+
* @param {string} [data.fileName] - The file name of the attached file.
|
|
1840
|
+
* @param {string} [data.contentType] - The MIME type of the attached file.
|
|
1841
|
+
* @param {number[]|Uint8Array} [data.fileBytes] - The file content as a byte array.
|
|
1842
|
+
* @param {number} [data.fileLength] - The byte length of the file.
|
|
1843
|
+
* @param {Array<{key: string, value: string}>} [data.indexFields] - Index field key/value pairs.
|
|
1844
|
+
* @param {string} [data.docType] - The document type.
|
|
1845
|
+
* @param {number} [data.confidence] - OCR confidence score (decimal).
|
|
1846
|
+
* @param {string} [data.description] - Document description.
|
|
1847
|
+
* @param {string} [data.keywords] - Document keywords.
|
|
1848
|
+
* @param {string} [data.abstract] - Document abstract.
|
|
1849
|
+
* @param {string} [data.changeText] - Change description for this revision.
|
|
1850
|
+
* @returns {Promise<string>} The API response containing the created document details.
|
|
1851
|
+
*/
|
|
1852
|
+
createDocument(data: {
|
|
1853
|
+
folderId: string;
|
|
1854
|
+
name?: string;
|
|
1855
|
+
revision?: string;
|
|
1856
|
+
documentState?: string;
|
|
1857
|
+
fileName?: string;
|
|
1858
|
+
contentType?: string;
|
|
1859
|
+
fileBytes?: number[] | Uint8Array;
|
|
1860
|
+
fileLength?: number;
|
|
1861
|
+
indexFields?: Array<{
|
|
1862
|
+
key: string;
|
|
1863
|
+
value: string;
|
|
1864
|
+
}>;
|
|
1865
|
+
docType?: string;
|
|
1866
|
+
confidence?: number;
|
|
1867
|
+
description?: string;
|
|
1868
|
+
keywords?: string;
|
|
1869
|
+
abstract?: string;
|
|
1870
|
+
changeText?: string;
|
|
1871
|
+
}): Promise<string>;
|
|
1872
|
+
/**
|
|
1873
|
+
* Retrieves a specific document revision by its ID.
|
|
1874
|
+
* @param {string} documentRevisionId - The ID (Guid) of the document revision to retrieve.
|
|
1875
|
+
* @returns {Promise<string>} The API response containing the document revision details.
|
|
1876
|
+
*/
|
|
1877
|
+
GetRevision(documentRevisionId: string): Promise<string>;
|
|
1878
|
+
/**
|
|
1879
|
+
* Retrieves the OCR processing status for a document revision.
|
|
1880
|
+
* @param {string} documentRevisionId - The ID (Guid) of the document revision to check.
|
|
1881
|
+
* @returns {Promise<string>} The API response containing the OCR status for the document revision.
|
|
1882
|
+
*/
|
|
1883
|
+
getDocumentOcrStatus(documentRevisionId: string): Promise<string>;
|
|
1884
|
+
/**
|
|
1885
|
+
* Updates the OCR processing status for a document revision.
|
|
1886
|
+
* @param {string} documentRevisionId - The ID (Guid) of the document revision to update.
|
|
1887
|
+
* @param {object} data - The OCR status payload.
|
|
1888
|
+
* @param {number} data.ocrErrorCode - Error code enum: 0=None, 1=ErrorThrown, 2=OcrProcessingError, 3=OcrOutputSaveError, 4=CheckinError.
|
|
1889
|
+
* @param {number} data.ocrStatus - Status enum: 0=None, 1=Success, 2=SuccessNoTextExtracted, 3=Failure, 4=FailureNoRetry, 5=ResultingDocumentFromSuccess.
|
|
1890
|
+
* @param {number} data.pageCount - Number of pages processed.
|
|
1891
|
+
* @param {number} data.wordCount - Number of words extracted.
|
|
1892
|
+
* @returns {Promise<string>} The API response confirming the OCR status update.
|
|
1893
|
+
*/
|
|
1894
|
+
updateDocumentOcrStatus(documentRevisionId: string, data: {
|
|
1895
|
+
ocrErrorCode: number;
|
|
1896
|
+
ocrStatus: number;
|
|
1897
|
+
pageCount: number;
|
|
1898
|
+
wordCount: number;
|
|
1899
|
+
}): Promise<string>;
|
|
1900
|
+
/**
|
|
1901
|
+
* Updates an existing document by its ID.
|
|
1902
|
+
* @param {string} documentId - The ID (Guid) of the document to update.
|
|
1903
|
+
* @param {object} data - The document update payload.
|
|
1904
|
+
* @param {string} [data.name] - The document name.
|
|
1905
|
+
* @param {string} [data.displayRev] - The display revision label.
|
|
1906
|
+
* @param {string} [data.description] - Document description.
|
|
1907
|
+
* @param {string} [data.keywords] - Document keywords.
|
|
1908
|
+
* @param {string} [data.comments] - Comments for this revision.
|
|
1909
|
+
* @param {string} [data.abstract] - Document abstract.
|
|
1910
|
+
* @param {string} [data.changeText] - Change description for this revision.
|
|
1911
|
+
* @param {string} [data.archive] - Archive state value.
|
|
1912
|
+
* @param {string} [data.state] - Document state.
|
|
1913
|
+
* @param {Array<{key: string, value: string}>} [data.indexFields] - Index field key/value pairs.
|
|
1914
|
+
* @param {string} [data.docType] - The document type.
|
|
1915
|
+
* @param {number} [data.confidence] - OCR confidence score (decimal).
|
|
1916
|
+
* @returns {Promise<string>} The API response confirming the document update.
|
|
1917
|
+
*/
|
|
1918
|
+
updateDocument(documentId: string, data: {
|
|
1919
|
+
name?: string;
|
|
1920
|
+
displayRev?: string;
|
|
1921
|
+
description?: string;
|
|
1922
|
+
keywords?: string;
|
|
1923
|
+
comments?: string;
|
|
1924
|
+
abstract?: string;
|
|
1925
|
+
changeText?: string;
|
|
1926
|
+
archive?: string;
|
|
1927
|
+
state?: string;
|
|
1928
|
+
indexFields?: Array<{
|
|
1929
|
+
key: string;
|
|
1930
|
+
value: string;
|
|
1931
|
+
}>;
|
|
1932
|
+
docType?: string;
|
|
1933
|
+
confidence?: number;
|
|
1934
|
+
}): Promise<string>;
|
|
1935
|
+
/**
|
|
1936
|
+
* Searches for documents using advanced search criteria.
|
|
1937
|
+
* @param {object[]} criteriaList - List of search criteria objects to filter results.
|
|
1938
|
+
* @param {string[]} searchFolders - List of folder paths to include in the search scope.
|
|
1939
|
+
* @param {string[]} excludeFolders - List of folder paths to exclude from the search scope.
|
|
1940
|
+
* @param {string} sortBy - The field name to sort the results by.
|
|
1941
|
+
* @param {string} [sortDirection='desc'] - Sort direction, either 'asc' or 'desc'.
|
|
1942
|
+
* @param {number} [page=0] - Zero-based page index for pagination.
|
|
1943
|
+
* @param {number} [take=15] - Number of results to return per page.
|
|
1944
|
+
* @param {number} [archiveType=0] - Archive type filter: 0 for active, 1 for archived documents.
|
|
1945
|
+
* @param {boolean} [roleSecurity=false] - Whether to apply role-based security filtering.
|
|
1946
|
+
* @returns {Promise<string>} The API response containing the matching documents and pagination info.
|
|
1947
|
+
*/
|
|
1948
|
+
search(criteriaList: object[], searchFolders: string[], excludeFolders: string[], sortBy: string, sortDirection?: string, page?: number, take?: number, archiveType?: number, roleSecurity?: boolean): Promise<string>;
|
|
1949
|
+
}
|
|
1950
|
+
|
|
1951
|
+
/**
|
|
1952
|
+
* Entry point for the DocApi service. Exposes the `documents` manager when the service is enabled.
|
|
1953
|
+
* Access via `client.docApi` after authentication. Check `client.docApi.isEnabled` before use.
|
|
1954
|
+
*/
|
|
1955
|
+
declare class DocApi {
|
|
1956
|
+
/**
|
|
1957
|
+
* @param {object} sessionToken - JWT session token from authentication.
|
|
1958
|
+
* @param {object} docApiConfig - DocApi configuration object returned by the VV configuration endpoint.
|
|
1959
|
+
*/
|
|
1960
|
+
constructor(sessionToken: object, docApiConfig: object);
|
|
1961
|
+
/** @type {boolean} */ isEnabled: boolean;
|
|
1962
|
+
/** @type {string|null} */ baseUrl: string | null;
|
|
1963
|
+
/** @type {boolean} */ roleSecurity: boolean;
|
|
1964
|
+
/** @type {DocumentManager} */ documents: DocumentManager;
|
|
1965
|
+
_httpHelper: HttpHelper;
|
|
1966
|
+
}
|
|
1967
|
+
|
|
1968
|
+
/**
|
|
1969
|
+
* Manager class for form instance operations.
|
|
1970
|
+
*
|
|
1971
|
+
* All methods return a `Promise<string>` containing a JSON-encoded API response.
|
|
1972
|
+
* When parsed, the response has the shape:
|
|
1973
|
+
* ```json
|
|
1974
|
+
* {
|
|
1975
|
+
* "meta": { "status": 200, "statusMsg": "OK", "errors": [] },
|
|
1976
|
+
* "data": { ... }
|
|
1977
|
+
* }
|
|
1978
|
+
* ```
|
|
1979
|
+
* Check `meta.status` to determine success or failure before consuming `data`.
|
|
1980
|
+
*/
|
|
1981
|
+
declare class FormInstanceManager {
|
|
1982
|
+
/**
|
|
1983
|
+
* @param {object} httpHelper - The HTTP helper instance used to make API requests.
|
|
1984
|
+
*/
|
|
1985
|
+
constructor(httpHelper: object);
|
|
1986
|
+
_httpHelper: any;
|
|
1987
|
+
/**
|
|
1988
|
+
* Creates a new form instance from a form template.
|
|
1989
|
+
* @param {object} params - URL parameters to include in the request.
|
|
1990
|
+
* @param {object} data - The form instance creation payload.
|
|
1991
|
+
* @param {string} data.formTemplateId - The Guid of the form template revision; overridden by the formTemplateRevisionId argument if provided.
|
|
1992
|
+
* @param {Array<{key: string, value: *, props?: Array<{key: string, value: string}>}>} data.fields - (Required) Form field values. Each item's key is the field name or its Guid; value is the field's value; props holds any extra key/value pairs to save alongside.
|
|
1993
|
+
* @param {string} [data.formName] - The DhDocId (display name) for the new form instance.
|
|
1994
|
+
* @param {string} [data.parentFormId] - Guid of the parent form instance (for child forms linked via a relation).
|
|
1995
|
+
* @param {string} [data.controlFormId] - Guid of the form control (e.g. RRC or Questions) associated with this instance.
|
|
1996
|
+
* @param {string} [data.offlineFormId] - Guid assigned to this form while offline; used when syncing offline forms.
|
|
1997
|
+
* @param {boolean} [data.ignoreWorkflow] - When true, skips workflow processing for this save.
|
|
1998
|
+
* @param {string} formTemplateRevisionId - The ID (Guid) of the form template revision to use; overrides any value in data.
|
|
1999
|
+
* @returns {Promise<string>} The API response containing the created form instance details.
|
|
2000
|
+
*/
|
|
2001
|
+
postForm(params: object, data: {
|
|
2002
|
+
formTemplateId: string;
|
|
2003
|
+
fields: Array<{
|
|
2004
|
+
key: string;
|
|
2005
|
+
value: any;
|
|
2006
|
+
props?: Array<{
|
|
2007
|
+
key: string;
|
|
2008
|
+
value: string;
|
|
2009
|
+
}>;
|
|
2010
|
+
}>;
|
|
2011
|
+
formName?: string;
|
|
2012
|
+
parentFormId?: string;
|
|
2013
|
+
controlFormId?: string;
|
|
2014
|
+
offlineFormId?: string;
|
|
2015
|
+
ignoreWorkflow?: boolean;
|
|
2016
|
+
}, formTemplateRevisionId: string): Promise<string>;
|
|
2017
|
+
/**
|
|
2018
|
+
* Submits a new revision for an existing form instance.
|
|
2019
|
+
* @param {object} params - URL parameters to include in the request.
|
|
2020
|
+
* @param {object} data - The form instance revision payload.
|
|
2021
|
+
* @param {string} data.formTemplateId - The Guid of the form template revision; overridden by the formTemplateRevisionId argument if provided.
|
|
2022
|
+
* @param {string} data.formId - The Guid of the existing form instance being revised; overridden by the formId argument if provided.
|
|
2023
|
+
* @param {Array<{key: string, value: *, props?: Array<{key: string, value: string}>}>} data.fields - (Required) Form field values. Each item's key is the field name or its Guid; value is the field's value; props holds any extra key/value pairs to save alongside.
|
|
2024
|
+
* @param {boolean} [data.replaceRevision] - When true, replaces the current revision instead of creating a new one.
|
|
2025
|
+
* @param {string} [data.formName] - The DhDocId (display name) for this revision.
|
|
2026
|
+
* @param {string} [data.parentFormId] - Guid of the parent form instance (for child forms linked via a relation).
|
|
2027
|
+
* @param {string} [data.controlFormId] - Guid of the form control (e.g. RRC or Questions) associated with this instance.
|
|
2028
|
+
* @param {string} [data.offlineFormId] - Guid assigned to this form while offline; used when syncing offline forms.
|
|
2029
|
+
* @param {boolean} [data.ignoreWorkflow] - When true, skips workflow processing for this save.
|
|
2030
|
+
* @param {string} formTemplateRevisionId - The ID (Guid) of the form template revision; overrides any value in data.
|
|
2031
|
+
* @param {string} formId - The ID (Guid) of the existing form instance to revise; overrides any value in data.
|
|
2032
|
+
* @returns {Promise<string>} The API response containing the updated form instance details.
|
|
2033
|
+
*/
|
|
2034
|
+
postFormRevision(params: object, data: {
|
|
2035
|
+
formTemplateId: string;
|
|
2036
|
+
formId: string;
|
|
2037
|
+
fields: Array<{
|
|
2038
|
+
key: string;
|
|
2039
|
+
value: any;
|
|
2040
|
+
props?: Array<{
|
|
2041
|
+
key: string;
|
|
2042
|
+
value: string;
|
|
2043
|
+
}>;
|
|
2044
|
+
}>;
|
|
2045
|
+
replaceRevision?: boolean;
|
|
2046
|
+
formName?: string;
|
|
2047
|
+
parentFormId?: string;
|
|
2048
|
+
controlFormId?: string;
|
|
2049
|
+
offlineFormId?: string;
|
|
2050
|
+
ignoreWorkflow?: boolean;
|
|
2051
|
+
}, formTemplateRevisionId: string, formId: string): Promise<string>;
|
|
2052
|
+
}
|
|
2053
|
+
|
|
2054
|
+
/**
|
|
2055
|
+
* Entry point for the FormsApi service. Exposes the `formInstances` manager when the service is enabled.
|
|
2056
|
+
* Access via `client.formsApi` after authentication. Check `client.formsApi.isEnabled` before use.
|
|
2057
|
+
*/
|
|
2058
|
+
declare class FormsApi {
|
|
2059
|
+
/**
|
|
2060
|
+
* @param {object} sessionToken - JWT session token from authentication.
|
|
2061
|
+
* @param {object} formsApiConfig - FormsApi configuration object returned by the VV configuration endpoint.
|
|
2062
|
+
*/
|
|
2063
|
+
constructor(sessionToken: object, formsApiConfig: object);
|
|
2064
|
+
/** @type {boolean} */ isEnabled: boolean;
|
|
2065
|
+
/** @type {string|null} */ baseUrl: string | null;
|
|
2066
|
+
/** @type {FormInstanceManager} */ formInstances: FormInstanceManager;
|
|
2067
|
+
_httpHelper: HttpHelper;
|
|
2068
|
+
}
|
|
2069
|
+
|
|
2070
|
+
/**
|
|
2071
|
+
* Manages model-related operations via the ObjectsApi.
|
|
2072
|
+
*/
|
|
2073
|
+
declare class ModelManager {
|
|
2074
|
+
/**
|
|
2075
|
+
* @param {object} httpHelper - The HTTP helper instance used to make API requests.
|
|
2076
|
+
*/
|
|
2077
|
+
constructor(httpHelper: object);
|
|
2078
|
+
_httpHelper: any;
|
|
2079
|
+
/**
|
|
2080
|
+
* Retrieves a list of available models.
|
|
2081
|
+
* @param {object} [params] - Optional URL parameters to include in the request.
|
|
2082
|
+
* @returns {Promise<object>} The API response containing the list of models.
|
|
2083
|
+
*/
|
|
2084
|
+
getModels(params?: object): Promise<object>;
|
|
2085
|
+
/**
|
|
2086
|
+
* Retrieves a specific model by its ID.
|
|
2087
|
+
* @param {string} modelId - The ID (Guid) for the requested model.
|
|
2088
|
+
* @param {object} [params] - Optional URL parameters to include in the request.
|
|
2089
|
+
* @returns {Promise<object>} The API response containing the model details.
|
|
2090
|
+
*/
|
|
2091
|
+
getModelById(modelId: string, params?: object): Promise<object>;
|
|
2092
|
+
}
|
|
2093
|
+
|
|
2094
|
+
/**
|
|
2095
|
+
* Manager class for object API operations.
|
|
2096
|
+
*
|
|
2097
|
+
* All methods return a `Promise<string>` containing a JSON-encoded API response.
|
|
2098
|
+
* When parsed, the response has the shape:
|
|
2099
|
+
* ```json
|
|
2100
|
+
* {
|
|
2101
|
+
* "meta": { "status": 200, "statusMsg": "OK", "errors": [] },
|
|
2102
|
+
* "data": { ... }
|
|
2103
|
+
* }
|
|
2104
|
+
* ```
|
|
2105
|
+
* Check `meta.status` to determine success or failure before consuming `data`.
|
|
2106
|
+
*/
|
|
2107
|
+
declare class ObjectManager {
|
|
2108
|
+
/**
|
|
2109
|
+
* @param {object} httpHelper - The HTTP helper instance used to make API requests.
|
|
2110
|
+
*/
|
|
2111
|
+
constructor(httpHelper: object);
|
|
2112
|
+
_httpHelper: any;
|
|
2113
|
+
/**
|
|
2114
|
+
* Retrieves a specific object by its ID.
|
|
2115
|
+
* @param {string} objectId - The ID (Guid) for the requested object.
|
|
2116
|
+
* @param {object} [params] - Optional URL parameters to include in the request.
|
|
2117
|
+
* @returns {Promise<string>} The API response containing the object details.
|
|
2118
|
+
*/
|
|
2119
|
+
getObject(objectId: string, params?: object): Promise<string>;
|
|
2120
|
+
/**
|
|
2121
|
+
* Retrieves a paged list of objects associated with a given model.
|
|
2122
|
+
* @param {string} modelId - The ID (Guid) for the requested model to search.
|
|
2123
|
+
* @param {object} data - The search payload.
|
|
2124
|
+
* @param {number} [data.page=0] - Zero-based page index for pagination.
|
|
2125
|
+
* @param {number} [data.take=10] - Number of results to return per page.
|
|
2126
|
+
* @param {Array<{sortField: string, direction: number}>} [data.sort] - Sort criteria; direction: 0=Ascending, 1=Descending.
|
|
2127
|
+
* @param {Array<{lookIn: string, clause: string, criteria: string, condition?: string, leftBracket?: boolean, rightBracket?: boolean}>} [data.criteriaList] - Filter criteria items. lookIn: property name or Guid. clause: 'IsEqual'|'NotEqual'|'GreaterThan'|'GreaterThanEqual'|'LessThan'|'LessThanEqual'|'BeginWith'|'NotBeginWith'|'EndWith'|'NotEndWith'|'Contain'|'NotContain'|'Null'|'NotNull'|'Between'|'NotBetween'|'In'|'NotIn'. criteria: value to compare. condition: 'AND'|'OR'. leftBracket/rightBracket: open/close a logical group.
|
|
2128
|
+
* @param {string[]} [data.propertyList] - Property names or Guids to include in results; empty array returns all properties.
|
|
2129
|
+
* @param {object} [params] - Optional URL parameters to include in the request.
|
|
2130
|
+
* @returns {Promise<string>} The API response containing the list of matching objects and pagination info.
|
|
2131
|
+
*/
|
|
2132
|
+
getObjectsByModelId(modelId: string, data: {
|
|
2133
|
+
page?: number;
|
|
2134
|
+
take?: number;
|
|
2135
|
+
sort?: Array<{
|
|
2136
|
+
sortField: string;
|
|
2137
|
+
direction: number;
|
|
2138
|
+
}>;
|
|
2139
|
+
criteriaList?: Array<{
|
|
2140
|
+
lookIn: string;
|
|
2141
|
+
clause: string;
|
|
2142
|
+
criteria: string;
|
|
2143
|
+
condition?: string;
|
|
2144
|
+
leftBracket?: boolean;
|
|
2145
|
+
rightBracket?: boolean;
|
|
2146
|
+
}>;
|
|
2147
|
+
propertyList?: string[];
|
|
2148
|
+
}, params?: object): Promise<string>;
|
|
2149
|
+
/**
|
|
2150
|
+
* Creates a new object adhering to a given model.
|
|
2151
|
+
* @param {string} modelId - The ID (Guid) used to create a new object for that model; overrides any value in data.
|
|
2152
|
+
* @param {object} data - The object creation payload.
|
|
2153
|
+
* @param {string} data.modelId - The Guid of the model this object belongs to; overridden by the modelId argument.
|
|
2154
|
+
* @param {object} [data.properties] - Key/value pairs for object property values, keyed by property name or Guid.
|
|
2155
|
+
* @param {Array<{id: string, revisionId: string, properties: object, relatedObjectUpdates?: Array}>} [data.relatedModels] - Related object instances to create or link alongside this object.
|
|
2156
|
+
* @param {object} [params] - Optional URL parameters to include in the request.
|
|
2157
|
+
* @returns {Promise<string>} The API response containing the created object details.
|
|
2158
|
+
*/
|
|
2159
|
+
createObject(modelId: string, data: {
|
|
2160
|
+
modelId: string;
|
|
2161
|
+
properties?: object;
|
|
2162
|
+
relatedModels?: Array<{
|
|
2163
|
+
id: string;
|
|
2164
|
+
revisionId: string;
|
|
2165
|
+
properties: object;
|
|
2166
|
+
relatedObjectUpdates?: any[];
|
|
2167
|
+
}>;
|
|
2168
|
+
}, params?: object): Promise<string>;
|
|
2169
|
+
/**
|
|
2170
|
+
* Updates an existing object by its ID and revision ID.
|
|
2171
|
+
* @param {string} objectId - The ID (Guid) for the requested object to update.
|
|
2172
|
+
* @param {string} objectRevisionId - The revision ID (Guid) for the requested object to update; overrides any value in data.
|
|
2173
|
+
* @param {object} data - The object update payload.
|
|
2174
|
+
* @param {string} data.revisionId - The revision Guid to update; overridden by the objectRevisionId argument.
|
|
2175
|
+
* @param {object} [data.properties] - Key/value pairs for the updated object property values, keyed by property name or Guid.
|
|
2176
|
+
* @param {Array<{id: string, revisionId: string, properties: object, relatedObjectUpdates?: Array}>} [data.relatedObjectUpdates] - Related object instances to update alongside this object.
|
|
2177
|
+
* @param {object} [params] - Optional URL parameters to include in the request.
|
|
2178
|
+
* @returns {Promise<string>} The API response confirming the object update.
|
|
2179
|
+
*/
|
|
2180
|
+
updateObject(objectId: string, objectRevisionId: string, data: {
|
|
2181
|
+
revisionId: string;
|
|
2182
|
+
properties?: object;
|
|
2183
|
+
relatedObjectUpdates?: Array<{
|
|
2184
|
+
id: string;
|
|
2185
|
+
revisionId: string;
|
|
2186
|
+
properties: object;
|
|
2187
|
+
relatedObjectUpdates?: any[];
|
|
2188
|
+
}>;
|
|
2189
|
+
}, params?: object): Promise<string>;
|
|
2190
|
+
/**
|
|
2191
|
+
* Deletes an existing object by its ID.
|
|
2192
|
+
* @param {string} objectId - The ID (Guid) for the requested object to delete.
|
|
2193
|
+
* @param {object} [params] - Optional URL parameters to include in the request.
|
|
2194
|
+
* @returns {Promise<string>} The API response confirming the object deletion.
|
|
2195
|
+
*/
|
|
2196
|
+
deleteObject(objectId: string, params?: object): Promise<string>;
|
|
2197
|
+
}
|
|
2198
|
+
|
|
2199
|
+
/**
|
|
2200
|
+
* Entry point for the ObjectsApi service. Exposes `models` and `objects` managers when the service is enabled.
|
|
2201
|
+
* Access via `client.objectsApi` after authentication. Check `client.objectsApi.isEnabled` before use.
|
|
2202
|
+
*/
|
|
2203
|
+
declare class ObjectsApi {
|
|
2204
|
+
/**
|
|
2205
|
+
* @param {object} sessionToken - JWT session token from authentication.
|
|
2206
|
+
* @param {object} objectsApiConfig - ObjectsApi configuration object returned by the VV configuration endpoint.
|
|
2207
|
+
*/
|
|
2208
|
+
constructor(sessionToken: object, objectsApiConfig: object);
|
|
2209
|
+
/** @type {boolean} */ isEnabled: boolean;
|
|
2210
|
+
/** @type {string|null} */ baseUrl: string | null;
|
|
2211
|
+
/** @type {ModelManager} */ models: ModelManager;
|
|
2212
|
+
/** @type {ObjectManager} */ objects: ObjectManager;
|
|
2213
|
+
_httpHelper: HttpHelper;
|
|
2214
|
+
}
|
|
2215
|
+
|
|
2216
|
+
/**
|
|
2217
|
+
* Manages workflow operations via the StudioApi.
|
|
2218
|
+
*/
|
|
2219
|
+
declare class WorkflowManager {
|
|
2220
|
+
/**
|
|
2221
|
+
* @param {object} httpHelper - The HTTP helper instance used to make API requests.
|
|
2222
|
+
*/
|
|
2223
|
+
constructor(httpHelper: object);
|
|
2224
|
+
_httpHelper: any;
|
|
2225
|
+
/**
|
|
2226
|
+
* Retrieves the latest published version of a workflow by its ID.
|
|
2227
|
+
* @param {string} workflowId - The ID (Guid) of the workflow to retrieve.
|
|
2228
|
+
* @returns {Promise<object>} The API response containing the workflow details.
|
|
2229
|
+
*/
|
|
2230
|
+
getWorkflow(workflowId: string): Promise<object>;
|
|
2231
|
+
/**
|
|
2232
|
+
* Retrieves the latest published version of a workflow by its name.
|
|
2233
|
+
* @param {string} workflowName - The name of the workflow to retrieve.
|
|
2234
|
+
* @returns {Promise<object>} The API response containing the workflow details.
|
|
2235
|
+
*/
|
|
2236
|
+
getWorkflowByName(workflowName: string): Promise<object>;
|
|
2237
|
+
/**
|
|
2238
|
+
* Retrieves the variables defined for a specific workflow.
|
|
2239
|
+
* @param {object} [params] - Optional URL parameters to include in the request.
|
|
2240
|
+
* @param {string} workflowId - The ID (Guid) of the workflow whose variables to retrieve.
|
|
2241
|
+
* @returns {Promise<object>} The API response containing the list of workflow variables.
|
|
2242
|
+
*/
|
|
2243
|
+
getWorkflowVariables(params?: object, workflowId: string): Promise<object>;
|
|
2244
|
+
/**
|
|
2245
|
+
* Triggers a workflow run for a specific object.
|
|
2246
|
+
* @param {string} workflowId - The ID (Guid) of the workflow to trigger.
|
|
2247
|
+
* @param {number} workflowRevision - The revision number of the workflow to run.
|
|
2248
|
+
* @param {string} objectId - The ID (Guid) of the object to run the workflow against.
|
|
2249
|
+
* @param {object[]} workflowVariables - Workflow variable values to pass into the workflow.
|
|
2250
|
+
* @param {string} workflowVariables[].name - The name of the variable.
|
|
2251
|
+
* @param {*} workflowVariables[].value - The value to pass for the variable.
|
|
2252
|
+
* @param {number} workflowVariables[].dataType - The data type: Text: 1, Number: 2, Date: 3, Boolean: 4.
|
|
2253
|
+
* @returns {Promise<object>} The API response containing the triggered workflow instance details.
|
|
2254
|
+
*/
|
|
2255
|
+
triggerWorkflow(workflowId: string, workflowRevision: number, objectId: string, workflowVariables: {
|
|
2256
|
+
name: string;
|
|
2257
|
+
value: any;
|
|
2258
|
+
dataType: number;
|
|
2259
|
+
}): Promise<object>;
|
|
2260
|
+
/**
|
|
2261
|
+
* Terminates a running workflow instance.
|
|
2262
|
+
* @param {string} workflowId - The ID (Guid) of the workflow containing the instance to terminate.
|
|
2263
|
+
* @param {string} instanceId - The ID (Guid) of the workflow instance to terminate.
|
|
2264
|
+
* @returns {Promise<object>} The API response confirming the workflow instance was terminated.
|
|
2265
|
+
*/
|
|
2266
|
+
terminateWorkflow(workflowId: string, instanceId: string): Promise<object>;
|
|
2267
|
+
/**
|
|
2268
|
+
* Returns the workflow execution history for an object under the provided workflow.
|
|
2269
|
+
* @param {string} objectId - The ID (Guid) of the object whose workflow history to retrieve.
|
|
2270
|
+
* @param {string} workflowId - The ID (Guid) of the workflow to query history for.
|
|
2271
|
+
* @returns {Promise<object>} The API response containing the workflow history entries for the object.
|
|
2272
|
+
*/
|
|
2273
|
+
GetWorkflowHistoryForObject(objectId: string, workflowId: string): Promise<object>;
|
|
2274
|
+
/**
|
|
2275
|
+
* Returns the currently running workflow instance, if any, for an object under the provided workflow.
|
|
2276
|
+
* @param {string} objectId - The ID (Guid) of the object to check for a running workflow.
|
|
2277
|
+
* @param {string} workflowId - The ID (Guid) of the workflow to query.
|
|
2278
|
+
* @returns {Promise<object>} The API response containing the running workflow instance, or empty if none is active.
|
|
2279
|
+
*/
|
|
2280
|
+
GetRunningWorkflowForObject(objectId: string, workflowId: string): Promise<object>;
|
|
2281
|
+
}
|
|
2282
|
+
|
|
2283
|
+
/**
|
|
2284
|
+
* Manages roles and permissions operations via the StudioApi.
|
|
2285
|
+
*/
|
|
2286
|
+
declare class RolesAndPermissionsManager {
|
|
2287
|
+
/**
|
|
2288
|
+
* @param {object} httpHelper - The HTTP helper instance used to make API requests.
|
|
2289
|
+
*/
|
|
2290
|
+
constructor(httpHelper: object);
|
|
2291
|
+
_httpHelper: any;
|
|
2292
|
+
/**
|
|
2293
|
+
* Retrieves available features for the requesting user.
|
|
2294
|
+
* @param {object} [params] - Optional URL parameters to include in the request.
|
|
2295
|
+
* @returns {Promise<object>} The API response containing the list of features available to the user.
|
|
2296
|
+
*/
|
|
2297
|
+
getUserFeatures(params?: object): Promise<object>;
|
|
2298
|
+
}
|
|
2299
|
+
|
|
2300
|
+
/**
|
|
2301
|
+
* Entry point for the StudioApi service. Exposes `workflow` and `permissions` managers when the service is enabled.
|
|
2302
|
+
* Access via `client.studioApi` after authentication. Check `client.studioApi.isEnabled` before use.
|
|
2303
|
+
*/
|
|
2304
|
+
declare class StudioApi {
|
|
2305
|
+
/**
|
|
2306
|
+
* @param {object} sessionToken - JWT session token from authentication.
|
|
2307
|
+
* @param {object} studioApiConfig - StudioApi configuration object returned by the VV configuration endpoint.
|
|
2308
|
+
*/
|
|
2309
|
+
constructor(sessionToken: object, studioApiConfig: object);
|
|
2310
|
+
/** @type {boolean} */ isEnabled: boolean;
|
|
2311
|
+
/** @type {string|null} */ baseUrl: string | null;
|
|
2312
|
+
/** @type {WorkflowManager} */ workflow: WorkflowManager;
|
|
2313
|
+
/** @type {RolesAndPermissionsManager} */ permissions: RolesAndPermissionsManager;
|
|
2314
|
+
_httpHelper: HttpHelper;
|
|
2315
|
+
}
|
|
2316
|
+
|
|
2317
|
+
/**
|
|
2318
|
+
* Manages user notification operations via the NotificationsApi.
|
|
2319
|
+
*/
|
|
2320
|
+
declare class UserNotificationsManager {
|
|
2321
|
+
/**
|
|
2322
|
+
* @param {object} httpHelper - The HTTP helper instance used to make API requests.
|
|
2323
|
+
*/
|
|
2324
|
+
constructor(httpHelper: object);
|
|
2325
|
+
_httpHelper: any;
|
|
2326
|
+
/**
|
|
2327
|
+
* Forces a UI refresh notification for a specific user.
|
|
2328
|
+
* @param {string} userGuid - The ID (Guid) of the user whose UI should be refreshed.
|
|
2329
|
+
* @returns {Promise<object>} The API response confirming the refresh notification was sent.
|
|
2330
|
+
*/
|
|
2331
|
+
forceUIRefresh(userGuid: string): Promise<object>;
|
|
2332
|
+
}
|
|
2333
|
+
|
|
2334
|
+
/**
|
|
2335
|
+
* Entry point for the NotificationsApi service. Exposes the `users` manager when the service is enabled.
|
|
2336
|
+
* Access via `client.notificationsApi` after authentication. Check `client.notificationsApi.isEnabled` before use.
|
|
2337
|
+
*/
|
|
2338
|
+
declare class NotificationsApi {
|
|
2339
|
+
/**
|
|
2340
|
+
* @param {object} sessionToken - JWT session token from authentication.
|
|
2341
|
+
* @param {object} notificationsApiConfig - NotificationsApi configuration object returned by the VV configuration endpoint.
|
|
2342
|
+
*/
|
|
2343
|
+
constructor(sessionToken: object, notificationsApiConfig: object);
|
|
2344
|
+
/** @type {boolean} */ isEnabled: boolean;
|
|
2345
|
+
/** @type {string|null} */ baseUrl: string | null;
|
|
2346
|
+
/** @type {UserNotificationsManager} */ users: UserNotificationsManager;
|
|
2347
|
+
_httpHelper: HttpHelper;
|
|
2348
|
+
}
|
|
288
2349
|
|
|
289
2350
|
/**
|
|
290
2351
|
* Main VisualVault API client providing access to all API managers.
|
|
@@ -294,29 +2355,29 @@ declare class VVClient {
|
|
|
294
2355
|
* @param {*} sessionToken - Session token from authentication
|
|
295
2356
|
*/
|
|
296
2357
|
constructor(sessionToken: any);
|
|
297
|
-
/** @type {
|
|
298
|
-
/** @type {
|
|
299
|
-
/** @type {
|
|
300
|
-
/** @type {
|
|
301
|
-
/** @type {
|
|
302
|
-
/** @type {
|
|
303
|
-
/** @type {
|
|
304
|
-
/** @type {
|
|
305
|
-
/** @type {
|
|
306
|
-
/** @type {
|
|
307
|
-
/** @type {
|
|
308
|
-
/** @type {
|
|
309
|
-
/** @type {
|
|
310
|
-
/** @type {
|
|
311
|
-
/** @type {
|
|
312
|
-
/** @type {
|
|
313
|
-
/** @type {
|
|
314
|
-
/** @type {
|
|
315
|
-
/** @type {
|
|
316
|
-
/** @type {
|
|
317
|
-
/** @type {
|
|
318
|
-
/** @type {
|
|
319
|
-
/** @type {
|
|
2358
|
+
/** @type {Constants} */ constants: Constants;
|
|
2359
|
+
/** @type {ConfigurationManager} */ configuration: ConfigurationManager;
|
|
2360
|
+
/** @type {CustomQueryManager} */ customQuery: CustomQueryManager;
|
|
2361
|
+
/** @type {DocumentsManager} */ documents: DocumentsManager;
|
|
2362
|
+
/** @type {EmailManager} */ email: EmailManager;
|
|
2363
|
+
/** @type {FilesManager} */ files: FilesManager;
|
|
2364
|
+
/** @type {FormsManager} */ forms: FormsManager;
|
|
2365
|
+
/** @type {GroupsManager} */ groups: GroupsManager;
|
|
2366
|
+
/** @type {LibraryManager} */ library: LibraryManager;
|
|
2367
|
+
/** @type {SitesManager} */ sites: SitesManager;
|
|
2368
|
+
/** @type {UsersManager} */ users: UsersManager;
|
|
2369
|
+
/** @type {ScheduledProcessManager} */ scheduledProcess: ScheduledProcessManager;
|
|
2370
|
+
/** @type {ScriptsManager} */ scripts: ScriptsManager;
|
|
2371
|
+
/** @type {ProjectsManager} */ projects: ProjectsManager;
|
|
2372
|
+
/** @type {CustomerManager} */ customer: CustomerManager;
|
|
2373
|
+
/** @type {CustomerDatabaseManager} */ customerDatabase: CustomerDatabaseManager;
|
|
2374
|
+
/** @type {IndexFieldsManager} */ indexFields: IndexFieldsManager;
|
|
2375
|
+
/** @type {OutsideProcessesManager} */ outsideProcesses: OutsideProcessesManager;
|
|
2376
|
+
/** @type {SecurityMembersManager} */ securityMembers: SecurityMembersManager;
|
|
2377
|
+
/** @type {LayoutsManager} */ layouts: LayoutsManager;
|
|
2378
|
+
/** @type {ReportsManager} */ reports: ReportsManager;
|
|
2379
|
+
/** @type {LanguageResourcesManager} */ languageResources: LanguageResourcesManager;
|
|
2380
|
+
/** @type {DropdownListsManager} */ dropdownLists: DropdownListsManager;
|
|
320
2381
|
yamlConfig: any;
|
|
321
2382
|
_httpHelper: HttpHelper;
|
|
322
2383
|
currentUser: CurrentUserManager;
|