@nebulateam/jarvis-sdk 0.0.0-stage → 5.57.9
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 +197 -2
- package/dist/app/automation-client.d.ts +33 -0
- package/dist/app/automation-client.models.d.ts +77 -0
- package/dist/app/jarvis-client.d.ts +201 -0
- package/dist/app/jarvis-public-api-v2.client.d.ts +8268 -0
- package/dist/app/jarvis-public-api.client.d.ts +4678 -0
- package/dist/app/jarvis-shell.d.ts +79 -0
- package/dist/app/jarvis-shell.models.d.ts +204 -0
- package/dist/app/public-api.client.extension.d.ts +22 -0
- package/dist/index.d.ts +6 -0
- package/dist/index.js +6 -0
- package/package.json +34 -4
|
@@ -0,0 +1,4678 @@
|
|
|
1
|
+
export declare class JarvisApiBase {
|
|
2
|
+
private readonly config;
|
|
3
|
+
protected constructor(config: JarvisApiConfig);
|
|
4
|
+
protected transformOptions: (options: RequestInit) => Promise<RequestInit>;
|
|
5
|
+
}
|
|
6
|
+
export declare class AccountV1Client extends JarvisApiBase {
|
|
7
|
+
private http;
|
|
8
|
+
private baseUrl;
|
|
9
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
10
|
+
constructor(configuration: JarvisApiConfig, baseUrl?: string, http?: {
|
|
11
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
12
|
+
});
|
|
13
|
+
getDetail(api_version: string | null, dto: AccountDetailRequest): Promise<ResponseOfAccountDetailResponse>;
|
|
14
|
+
protected processGetDetail(response: Response): Promise<ResponseOfAccountDetailResponse>;
|
|
15
|
+
/**
|
|
16
|
+
* Upsert (update or insert) a CRM account, creating it or updating it as needed.
|
|
17
|
+
* @param request DTO with info about the account to insert/update
|
|
18
|
+
*/
|
|
19
|
+
upsert(api_version: string | null, request: AccountUpsertRequest): Promise<ResponseOfString>;
|
|
20
|
+
protected processUpsert(response: Response): Promise<ResponseOfString>;
|
|
21
|
+
}
|
|
22
|
+
export declare class JarvisAppConfigurationV1Client extends JarvisApiBase {
|
|
23
|
+
private http;
|
|
24
|
+
private baseUrl;
|
|
25
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
26
|
+
constructor(configuration: JarvisApiConfig, baseUrl?: string, http?: {
|
|
27
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
28
|
+
});
|
|
29
|
+
getJarvisAppConfiguration(api_version: string | null): Promise<ResponseOfGetJarvisAppConfigurationResponseDto>;
|
|
30
|
+
protected processGetJarvisAppConfiguration(response: Response): Promise<ResponseOfGetJarvisAppConfigurationResponseDto>;
|
|
31
|
+
}
|
|
32
|
+
export declare class OutlookExtension1Client extends JarvisApiBase {
|
|
33
|
+
private http;
|
|
34
|
+
private baseUrl;
|
|
35
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
36
|
+
constructor(configuration: JarvisApiConfig, baseUrl?: string, http?: {
|
|
37
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
38
|
+
});
|
|
39
|
+
/**
|
|
40
|
+
* Custom BRETON - Create a worktask from an e-mail with custom title and email html as content
|
|
41
|
+
* @param api_version (optional)
|
|
42
|
+
* @param form (optional)
|
|
43
|
+
*/
|
|
44
|
+
createFromMail(api_version: string | null | undefined, form: any[] | null | undefined): Promise<CreateWorkTaskFromMailResponseDto>;
|
|
45
|
+
protected processCreateFromMail(response: Response): Promise<CreateWorkTaskFromMailResponseDto>;
|
|
46
|
+
test(api_version: string | null | undefined): Promise<ResponseOfBoolean>;
|
|
47
|
+
protected processTest(response: Response): Promise<ResponseOfBoolean>;
|
|
48
|
+
}
|
|
49
|
+
export declare class PublicNotificationClient extends JarvisApiBase {
|
|
50
|
+
private http;
|
|
51
|
+
private baseUrl;
|
|
52
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
53
|
+
constructor(configuration: JarvisApiConfig, baseUrl?: string, http?: {
|
|
54
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
55
|
+
});
|
|
56
|
+
getActualCheckpoint(api_version: string | null | undefined): Promise<ResponseOfString>;
|
|
57
|
+
protected processGetActualCheckpoint(response: Response): Promise<ResponseOfString>;
|
|
58
|
+
getNotificationList(api_version: string | null | undefined): Promise<ResponseOfNotificationDefinitionOf>;
|
|
59
|
+
protected processGetNotificationList(response: Response): Promise<ResponseOfNotificationDefinitionOf>;
|
|
60
|
+
poll(api_version: string | null | undefined, request: PublicNotificationPollRequest): Promise<ResponseOfPublicNotificationPage>;
|
|
61
|
+
protected processPoll(response: Response): Promise<ResponseOfPublicNotificationPage>;
|
|
62
|
+
}
|
|
63
|
+
export declare class AuthProxyV1Client extends JarvisApiBase {
|
|
64
|
+
private http;
|
|
65
|
+
private baseUrl;
|
|
66
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
67
|
+
constructor(configuration: JarvisApiConfig, baseUrl?: string, http?: {
|
|
68
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
69
|
+
});
|
|
70
|
+
ping(api_version: string | null): Promise<FileResponse>;
|
|
71
|
+
protected processPing(response: Response): Promise<FileResponse>;
|
|
72
|
+
/**
|
|
73
|
+
* Report a login event (success/failure/logout) from the proxy to Jarvis.
|
|
74
|
+
The proxy observes OIDC/SSO identity events that complete at the proxy
|
|
75
|
+
before (or independently of) reaching Jarvis. This endpoint lets the proxy
|
|
76
|
+
report those events so Jarvis can maintain a complete audit trail (FR-023-030).
|
|
77
|
+
|
|
78
|
+
The endpoint validates proxy trust via CheckProxyAuthentication (FR-024/SC-015):
|
|
79
|
+
- If proxy auth fails: return 403 Forbidden, record nothing
|
|
80
|
+
- If proxy auth succeeds: map the event to the recorder (no logic in controller - FR-027)
|
|
81
|
+
|
|
82
|
+
Recording is best-effort (R4): even if the recorder throws, return 200 on auth success
|
|
83
|
+
because the error signal (ERROR log + App Insights meta-event) is the durability signal.
|
|
84
|
+
* @param request Report DTO carrying eventKind, authMethod, user/email, source IP, timestamp, and failure reason.
|
|
85
|
+
* @return 200 OK on success (auth + recording both best-effort); 403 Forbidden on proxy auth failure.
|
|
86
|
+
*/
|
|
87
|
+
reportLoginEvent(api_version: string | null, request: ReportLoginEventRequest): Promise<Response>;
|
|
88
|
+
protected processReportLoginEvent(response: Response): Promise<Response>;
|
|
89
|
+
/**
|
|
90
|
+
* Introduced with #18469 it is used to ask to suspend SignalR connections so the proxy can close
|
|
91
|
+
avoiding to wait for the SignalR connections to close (30 seconds).
|
|
92
|
+
*/
|
|
93
|
+
suspendSignalr(api_version: string | null, request: JarvisRequestBase): Promise<Response>;
|
|
94
|
+
protected processSuspendSignalr(response: Response): Promise<Response>;
|
|
95
|
+
/**
|
|
96
|
+
* This API call actually does not only generate a temporary token, but also verify
|
|
97
|
+
if data passed by the proxy in parameter corresponds to a real user and returns
|
|
98
|
+
UserId, roles and a temporary token.
|
|
99
|
+
*/
|
|
100
|
+
generateTemporaryToken(api_version: string | null, request: TokenRequest): Promise<TokenResponse>;
|
|
101
|
+
protected processGenerateTemporaryToken(response: Response): Promise<TokenResponse>;
|
|
102
|
+
/**
|
|
103
|
+
* Validate credentials for proxy
|
|
104
|
+
*/
|
|
105
|
+
validateAdCredentials(api_version: string | null, request: ActiveDirectoryUserCredentialsValidationRequest): Promise<TokenResponse>;
|
|
106
|
+
protected processValidateAdCredentials(response: Response): Promise<TokenResponse>;
|
|
107
|
+
/**
|
|
108
|
+
* Used by the proxy, it allows for the proxy to pass a valid token, and jarvis is supposed
|
|
109
|
+
to validate the token, generate a temporary one and return with the very same return value
|
|
110
|
+
as GenerateTemporaryToken call.
|
|
111
|
+
*/
|
|
112
|
+
validateToken(api_version: string | null, request: ValidateTokenRequest): Promise<TokenResponse>;
|
|
113
|
+
protected processValidateToken(response: Response): Promise<TokenResponse>;
|
|
114
|
+
}
|
|
115
|
+
export declare class TeamsV1Client extends JarvisApiBase {
|
|
116
|
+
private http;
|
|
117
|
+
private baseUrl;
|
|
118
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
119
|
+
constructor(configuration: JarvisApiConfig, baseUrl?: string, http?: {
|
|
120
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
121
|
+
});
|
|
122
|
+
/**
|
|
123
|
+
* Return teams Dto by Id
|
|
124
|
+
*/
|
|
125
|
+
getById(api_version: string | null, dto: TeamDetailRequestDto): Promise<ResponseOfTeamPublicDetailResponseDto>;
|
|
126
|
+
protected processGetById(response: Response): Promise<ResponseOfTeamPublicDetailResponseDto>;
|
|
127
|
+
update(api_version: string | null, dto: TeamUpdateRequestDto): Promise<ResponseOfString>;
|
|
128
|
+
protected processUpdate(response: Response): Promise<ResponseOfString>;
|
|
129
|
+
}
|
|
130
|
+
export declare class UsersV1Client extends JarvisApiBase {
|
|
131
|
+
private http;
|
|
132
|
+
private baseUrl;
|
|
133
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
134
|
+
constructor(configuration: JarvisApiConfig, baseUrl?: string, http?: {
|
|
135
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
136
|
+
});
|
|
137
|
+
current(api_version: string | null): Promise<ResponseOfUserInfoResponse>;
|
|
138
|
+
protected processCurrent(response: Response): Promise<ResponseOfUserInfoResponse>;
|
|
139
|
+
getEmails(api_version: string | null, request: GetEmailsRequest): Promise<ResponseOfGetEmailsResponse>;
|
|
140
|
+
protected processGetEmails(response: Response): Promise<ResponseOfGetEmailsResponse>;
|
|
141
|
+
searchUsers(api_version: string | null, request: OmniSearchPublicSearchRequest): Promise<OmnisearchResultResponseOfUserInfoSearchResult>;
|
|
142
|
+
protected processSearchUsers(response: Response): Promise<OmnisearchResultResponseOfUserInfoSearchResult>;
|
|
143
|
+
translateIdList(api_version: string | null, request: TranslateUserRequest): Promise<ResponseOfTranslateUsersResponse>;
|
|
144
|
+
protected processTranslateIdList(response: Response): Promise<ResponseOfTranslateUsersResponse>;
|
|
145
|
+
}
|
|
146
|
+
export declare class AvatarV1Client extends JarvisApiBase {
|
|
147
|
+
private http;
|
|
148
|
+
private baseUrl;
|
|
149
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
150
|
+
constructor(configuration: JarvisApiConfig, baseUrl?: string, http?: {
|
|
151
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
152
|
+
});
|
|
153
|
+
/**
|
|
154
|
+
* Download the Avatar
|
|
155
|
+
* @param id Id of the entity for which we want to download/generate an Avatar.
|
|
156
|
+
* @param fullName Object Name: will be used to generate and avatar if none is present.
|
|
157
|
+
* @return the avatar image
|
|
158
|
+
*/
|
|
159
|
+
getAvatar(api_version: string | null, id: string, fullName: string): Promise<FileResponse>;
|
|
160
|
+
protected processGetAvatar(response: Response): Promise<FileResponse>;
|
|
161
|
+
}
|
|
162
|
+
export declare class PropertiesV1Old1Client extends JarvisApiBase {
|
|
163
|
+
private http;
|
|
164
|
+
private baseUrl;
|
|
165
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
166
|
+
constructor(configuration: JarvisApiConfig, baseUrl?: string, http?: {
|
|
167
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
168
|
+
});
|
|
169
|
+
/**
|
|
170
|
+
* List of Properties Definitions filtered by a term
|
|
171
|
+
user can select how many properties to retrieve.
|
|
172
|
+
if MaxAtTime is null, will be sent all properties matched the search
|
|
173
|
+
*/
|
|
174
|
+
search(api_version: string | null, dto: PropertiesDefinitionSearchRequest): Promise<ResponseOfPropertiesDefinitionSearchResponse>;
|
|
175
|
+
protected processSearch(response: Response): Promise<ResponseOfPropertiesDefinitionSearchResponse>;
|
|
176
|
+
/**
|
|
177
|
+
* Given an array of PropertyDefinitionId, will return the matched PropertiesDefinitions
|
|
178
|
+
*/
|
|
179
|
+
getDefinitions(api_version: string | null, dto: PropertiesDefinitionsDataRequest): Promise<ResponseOfPropertiesDefinitionsDataResponse>;
|
|
180
|
+
protected processGetDefinitions(response: Response): Promise<ResponseOfPropertiesDefinitionsDataResponse>;
|
|
181
|
+
}
|
|
182
|
+
export declare class ContactV1Client extends JarvisApiBase {
|
|
183
|
+
private http;
|
|
184
|
+
private baseUrl;
|
|
185
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
186
|
+
constructor(configuration: JarvisApiConfig, baseUrl?: string, http?: {
|
|
187
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
188
|
+
});
|
|
189
|
+
detail(api_version: string | null, dto: ContactDetailRequest): Promise<ContactDetailDto>;
|
|
190
|
+
protected processDetail(response: Response): Promise<ContactDetailDto>;
|
|
191
|
+
/**
|
|
192
|
+
* Update or Create Contact
|
|
193
|
+
* @return Id of created or updated contact
|
|
194
|
+
*/
|
|
195
|
+
upsert(api_version: string | null, request: UpsertContactRequestDto): Promise<ResponseOfString>;
|
|
196
|
+
protected processUpsert(response: Response): Promise<ResponseOfString>;
|
|
197
|
+
}
|
|
198
|
+
export declare class DatasetV1Client extends JarvisApiBase {
|
|
199
|
+
private http;
|
|
200
|
+
private baseUrl;
|
|
201
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
202
|
+
constructor(configuration: JarvisApiConfig, baseUrl?: string, http?: {
|
|
203
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
204
|
+
});
|
|
205
|
+
/**
|
|
206
|
+
* delete a list of items in omnisearch engine.
|
|
207
|
+
* @param request block of items ids to remove.
|
|
208
|
+
*/
|
|
209
|
+
deleteItemsBlock(api_version: string | null, request: OmniSearchItemIdsBlockToDeleteRequest): Promise<ResponseOfBoolean>;
|
|
210
|
+
protected processDeleteItemsBlock(response: Response): Promise<ResponseOfBoolean>;
|
|
211
|
+
/**
|
|
212
|
+
* Upsert a dataset detailed info.
|
|
213
|
+
* @param request The new shape of the Dataset, it will upsert the dataset
|
|
214
|
+
definition, creating one if it does not exists.
|
|
215
|
+
*/
|
|
216
|
+
upsertDatasetByTypeOrId(api_version: string | null, request: UpsertDatasetDefinitionRequest): Promise<PublicDatasetDetailDto>;
|
|
217
|
+
protected processUpsertDatasetByTypeOrId(response: Response): Promise<PublicDatasetDetailDto>;
|
|
218
|
+
/**
|
|
219
|
+
* Get a dataset detailed info using internal id or external type name.
|
|
220
|
+
* @param datasetIdOrDatasetType It can be a valid DatasetId in the form of
|
|
221
|
+
Dataset_123 or the type of the dataset (ex b2bitems)
|
|
222
|
+
*/
|
|
223
|
+
getDatasetByTypeOrId(api_version: string | null, datasetIdOrDatasetType: string): Promise<PublicDatasetDetailDto>;
|
|
224
|
+
protected processGetDatasetByTypeOrId(response: Response): Promise<PublicDatasetDetailDto>;
|
|
225
|
+
/**
|
|
226
|
+
* Retrieve the facet field configuration.
|
|
227
|
+
I.E: in Dataset_4 i'm filtering for a field with name "theme" and i want to know the facet configuration (if
|
|
228
|
+
it's a multiselect, in that case the list of elements that the user can select, ...)
|
|
229
|
+
*/
|
|
230
|
+
getFacetFieldConfig(api_version: string | null, dto: DatasetSearchFacetsRequestDto): Promise<ResponseOfOmniSearchFacetResult>;
|
|
231
|
+
protected processGetFacetFieldConfig(response: Response): Promise<ResponseOfOmniSearchFacetResult>;
|
|
232
|
+
/**
|
|
233
|
+
* Returns information about a Dataset item, given the name (or the id) of the
|
|
234
|
+
dataset as well as the code of the item. This will also returns the container
|
|
235
|
+
where to load documents for this specific item.
|
|
236
|
+
* @param request Request with all the needed info
|
|
237
|
+
*/
|
|
238
|
+
itemInfo(api_version: string | null, request: DatasetItemInfoRequest): Promise<ResponseOfDatasetItemInfoResponse>;
|
|
239
|
+
protected processItemInfo(response: Response): Promise<ResponseOfDatasetItemInfoResponse>;
|
|
240
|
+
/**
|
|
241
|
+
* Returns information about a Dataset item, given the name (or the id) of the
|
|
242
|
+
dataset as well as the code of the item. This will also returns the container
|
|
243
|
+
where to load documents for this specific item.
|
|
244
|
+
* @param request Request with all the needed info
|
|
245
|
+
*/
|
|
246
|
+
itemInfoOmnisearch(api_version: string | null, request: DatasetItemInfoRequest): Promise<ResponseOfDatasetItemFullOmnisearchItemDtoInfoResponse>;
|
|
247
|
+
protected processItemInfoOmnisearch(response: Response): Promise<ResponseOfDatasetItemFullOmnisearchItemDtoInfoResponse>;
|
|
248
|
+
/**
|
|
249
|
+
* Return a list of all the facets available for searching datasets
|
|
250
|
+
*/
|
|
251
|
+
listFacets(api_version: string | null, req: OmniSearchQueryFacetsRequestDto): Promise<ResponseOfOmniSearchFacetResult>;
|
|
252
|
+
protected processListFacets(response: Response): Promise<ResponseOfOmniSearchFacetResult>;
|
|
253
|
+
/**
|
|
254
|
+
* Return a list of all the datasets available to the user
|
|
255
|
+
*/
|
|
256
|
+
listSearch(api_version: string | null, req: DatasetDefinitionSearchRequest): Promise<ResponseOfPureJsonOmniSearchResultDto>;
|
|
257
|
+
protected processListSearch(response: Response): Promise<ResponseOfPureJsonOmniSearchResultDto>;
|
|
258
|
+
/**
|
|
259
|
+
* Save a list of items in omnisearch engine.
|
|
260
|
+
* @param request block of items to index. Items are of the same ItemType type
|
|
261
|
+
*/
|
|
262
|
+
saveItemsBlock(api_version: string | null, request: UpsertDatasetElementsRequests): Promise<ResponseOfUpsertDatasetElementResponse>;
|
|
263
|
+
protected processSaveItemsBlock(response: Response): Promise<ResponseOfUpsertDatasetElementResponse>;
|
|
264
|
+
/**
|
|
265
|
+
* Search dataset items grouped by requested field
|
|
266
|
+
*/
|
|
267
|
+
searchGroupedItems(api_version: string | null, request: DatasetItemsSearchGroupsRequest): Promise<ResponseOfPureJsonGroupedOmniSearchResultDto>;
|
|
268
|
+
protected processSearchGroupedItems(response: Response): Promise<ResponseOfPureJsonGroupedOmniSearchResultDto>;
|
|
269
|
+
/**
|
|
270
|
+
* Search dataset items
|
|
271
|
+
*/
|
|
272
|
+
searchItems(api_version: string | null, request: DatasetItemsSearchRequest): Promise<ResponseOfPureJsonOmniSearchResultDto>;
|
|
273
|
+
protected processSearchItems(response: Response): Promise<ResponseOfPureJsonOmniSearchResultDto>;
|
|
274
|
+
/**
|
|
275
|
+
* truncate the dataset type.
|
|
276
|
+
* @param request item type to truncate.
|
|
277
|
+
*/
|
|
278
|
+
truncateType(api_version: string | null, request: DatasetTruncateRequest): Promise<ResponseOfBoolean>;
|
|
279
|
+
protected processTruncateType(response: Response): Promise<ResponseOfBoolean>;
|
|
280
|
+
/**
|
|
281
|
+
* Retrieve the facets list.
|
|
282
|
+
This endpoint will retrieve ONLY the columns that are configured to be displayed in the UI.
|
|
283
|
+
*/
|
|
284
|
+
getDatasetConfigById(api_version: string | null, id: string): Promise<ResponseOfDatasetFieldsConfigDto>;
|
|
285
|
+
protected processGetDatasetConfigById(response: Response): Promise<ResponseOfDatasetFieldsConfigDto>;
|
|
286
|
+
}
|
|
287
|
+
export declare class AcesV1Client extends JarvisApiBase {
|
|
288
|
+
private http;
|
|
289
|
+
private baseUrl;
|
|
290
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
291
|
+
constructor(configuration: JarvisApiConfig, baseUrl?: string, http?: {
|
|
292
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
293
|
+
});
|
|
294
|
+
/**
|
|
295
|
+
* List of usable aces
|
|
296
|
+
*/
|
|
297
|
+
getList(api_version: string | null): Promise<ResponseOfAceReducedDtoOf>;
|
|
298
|
+
protected processGetList(response: Response): Promise<ResponseOfAceReducedDtoOf>;
|
|
299
|
+
/**
|
|
300
|
+
* Get information on a single ACE
|
|
301
|
+
* @param id Ace Id
|
|
302
|
+
*/
|
|
303
|
+
getAce(api_version: string | null, id: string): Promise<ResponseOfAceDto>;
|
|
304
|
+
protected processGetAce(response: Response): Promise<ResponseOfAceDto>;
|
|
305
|
+
}
|
|
306
|
+
export declare class ContainerV1Client extends JarvisApiBase {
|
|
307
|
+
private http;
|
|
308
|
+
private baseUrl;
|
|
309
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
310
|
+
constructor(configuration: JarvisApiConfig, baseUrl?: string, http?: {
|
|
311
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
312
|
+
});
|
|
313
|
+
/**
|
|
314
|
+
* Create a series of sub-containers, it does not allow to change any ACE or Permissions on each Containers.
|
|
315
|
+
This API is better suited to create children on already existing and configured container.
|
|
316
|
+
|
|
317
|
+
You use this command to ensure that a specific path like /bla/foo/bar exists
|
|
318
|
+
and the LAST container has properties specified (if is
|
|
319
|
+
present)
|
|
320
|
+
*/
|
|
321
|
+
createFromPath(api_version: string | null, dto: ImportContainerV2Dto): Promise<ResponseOfCreateContainerFromPathResponse>;
|
|
322
|
+
protected processCreateFromPath(response: Response): Promise<ResponseOfCreateContainerFromPathResponse>;
|
|
323
|
+
/**
|
|
324
|
+
* Given a Path, it returns the list of containers that exists and the containers that are missing
|
|
325
|
+
*/
|
|
326
|
+
pathExists(api_version: string | null, dto: ContainerPathExistsRequest): Promise<ResponseOfCheckContainerExistsResultDto>;
|
|
327
|
+
protected processPathExists(response: Response): Promise<ResponseOfCheckContainerExistsResultDto>;
|
|
328
|
+
/**
|
|
329
|
+
* returns Container information
|
|
330
|
+
*/
|
|
331
|
+
get(api_version: string | null, id: string): Promise<ResponseOfContainerInfoDto>;
|
|
332
|
+
protected processGet(response: Response): Promise<ResponseOfContainerInfoDto>;
|
|
333
|
+
/**
|
|
334
|
+
* Archive selected container and all his children!
|
|
335
|
+
* @return Correlation token to undo this operation
|
|
336
|
+
*/
|
|
337
|
+
archiveContainer(api_version: string | null, id: string): Promise<ResponseOfArchiveContainerResponse>;
|
|
338
|
+
protected processArchiveContainer(response: Response): Promise<ResponseOfArchiveContainerResponse>;
|
|
339
|
+
/**
|
|
340
|
+
* returns all the children of a container for browsing
|
|
341
|
+
|
|
342
|
+
Use 'Container_0' as Id for browsing Root
|
|
343
|
+
*/
|
|
344
|
+
browseContainer(api_version: string | null, id: string): Promise<ResponseOfContainerChildrenInfoResponse>;
|
|
345
|
+
protected processBrowseContainer(response: Response): Promise<ResponseOfContainerChildrenInfoResponse>;
|
|
346
|
+
/**
|
|
347
|
+
* Instantiate container template
|
|
348
|
+
* @param id Container parent Id
|
|
349
|
+
* @param dto Name and TemplateId to instantiate
|
|
350
|
+
* @return Id of the new container created
|
|
351
|
+
*/
|
|
352
|
+
createChildContainer(api_version: string | null, id: string, dto: ContainerCreateFromTemplateRequest): Promise<ResponseOfCreateChildContainerResponse>;
|
|
353
|
+
protected processCreateChildContainer(response: Response): Promise<ResponseOfCreateChildContainerResponse>;
|
|
354
|
+
/**
|
|
355
|
+
* Delete selected container (MUST BE ARCHIVED FIRST!)
|
|
356
|
+
*/
|
|
357
|
+
deleteContainer(api_version: string | null, id: string): Promise<Response>;
|
|
358
|
+
protected processDeleteContainer(response: Response): Promise<Response>;
|
|
359
|
+
/**
|
|
360
|
+
* Change container properties
|
|
361
|
+
*/
|
|
362
|
+
editContainerProperties(api_version: string | null, id: string, dto: ContainerPropertiesChangeRequest): Promise<Response>;
|
|
363
|
+
protected processEditContainerProperties(response: Response): Promise<Response>;
|
|
364
|
+
/**
|
|
365
|
+
* returns full path of a container from his Id
|
|
366
|
+
*/
|
|
367
|
+
getFullPath(api_version: string | null, id: string): Promise<string>;
|
|
368
|
+
protected processGetFullPath(response: Response): Promise<string>;
|
|
369
|
+
/**
|
|
370
|
+
* Move container position
|
|
371
|
+
*/
|
|
372
|
+
moveContainer(api_version: string | null, id: string, dto: ContainerMoveRequest): Promise<ResponseOfContainerMoveResponse>;
|
|
373
|
+
protected processMoveContainer(response: Response): Promise<ResponseOfContainerMoveResponse>;
|
|
374
|
+
/**
|
|
375
|
+
* allow to change container name
|
|
376
|
+
*/
|
|
377
|
+
renameContainer(api_version: string | null, id: string, dto: ContainerRenameRequest): Promise<ResponseOfContainerRenameResponse>;
|
|
378
|
+
protected processRenameContainer(response: Response): Promise<ResponseOfContainerRenameResponse>;
|
|
379
|
+
/**
|
|
380
|
+
* Unarchive container -
|
|
381
|
+
if CorrelationToken declared, will be raised unarchive for all childrens related
|
|
382
|
+
*/
|
|
383
|
+
unarchiveContainer(api_version: string | null, id: string, dto: ContainerUnarchiveRequest): Promise<ResponseOfContainerUnarchiveResponse>;
|
|
384
|
+
protected processUnarchiveContainer(response: Response): Promise<ResponseOfContainerUnarchiveResponse>;
|
|
385
|
+
/**
|
|
386
|
+
* Update container properties values
|
|
387
|
+
*/
|
|
388
|
+
updateCustomProperties(api_version: string | null, id: string, dto: PropertiesUpdateValuesRequest): Promise<Response>;
|
|
389
|
+
protected processUpdateCustomProperties(response: Response): Promise<Response>;
|
|
390
|
+
/**
|
|
391
|
+
* Update container metadata
|
|
392
|
+
Container can have only one metadata
|
|
393
|
+
*/
|
|
394
|
+
updateContainerMetadata(api_version: string | null, id: string, dto: UpdateContainerMetadataRequest): Promise<Response>;
|
|
395
|
+
protected processUpdateContainerMetadata(response: Response): Promise<Response>;
|
|
396
|
+
}
|
|
397
|
+
export declare class DocumentTypeV1Client extends JarvisApiBase {
|
|
398
|
+
private http;
|
|
399
|
+
private baseUrl;
|
|
400
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
401
|
+
constructor(configuration: JarvisApiConfig, baseUrl?: string, http?: {
|
|
402
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
403
|
+
});
|
|
404
|
+
/**
|
|
405
|
+
* Returns the list of all the defined DocumentType
|
|
406
|
+
*/
|
|
407
|
+
list(api_version: string | null): Promise<ResponseOfDocumentTypeListV2DtoOf>;
|
|
408
|
+
protected processList(response: Response): Promise<ResponseOfDocumentTypeListV2DtoOf>;
|
|
409
|
+
}
|
|
410
|
+
export declare class DocumentV1Client extends JarvisApiBase {
|
|
411
|
+
private http;
|
|
412
|
+
private baseUrl;
|
|
413
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
414
|
+
constructor(configuration: JarvisApiConfig, baseUrl?: string, http?: {
|
|
415
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
416
|
+
});
|
|
417
|
+
detail(api_version: string | null, dto: DocumentDetailRequestDto): Promise<ResponseOfDocumentDetailResponse>;
|
|
418
|
+
protected processDetail(response: Response): Promise<ResponseOfDocumentDetailResponse>;
|
|
419
|
+
/**
|
|
420
|
+
* Creates or Updates a Document.
|
|
421
|
+
The update operation replaces all the allowed information:
|
|
422
|
+
- Title
|
|
423
|
+
- Abstract
|
|
424
|
+
- Tags
|
|
425
|
+
- Files/Binaries
|
|
426
|
+
|
|
427
|
+
The purpose of this API is to give you a simple and stable way to load a document
|
|
428
|
+
and possibly prepare container structure.
|
|
429
|
+
|
|
430
|
+
This version of import document allows specifying file names without
|
|
431
|
+
or . It is duty of the importer to load data into documenstore.
|
|
432
|
+
* @param dto request dto
|
|
433
|
+
* @return A result structure containing the new DocumentId and detailed errors.
|
|
434
|
+
*/
|
|
435
|
+
import(api_version: string | null, dto: ImportDocumentRequest): Promise<ResponseOfString>;
|
|
436
|
+
protected processImport(response: Response): Promise<ResponseOfString>;
|
|
437
|
+
/**
|
|
438
|
+
* Performs update operations on a single document.
|
|
439
|
+
Operations are done from Top to Bottom.
|
|
440
|
+
*/
|
|
441
|
+
update(api_version: string | null, request: UpdateDocumentRequest): Promise<Response>;
|
|
442
|
+
protected processUpdate(response: Response): Promise<Response>;
|
|
443
|
+
/**
|
|
444
|
+
* Get the preview for the specified file within the document.
|
|
445
|
+
The preview is an image representing the file and can be requested at different sizes.
|
|
446
|
+
* @param documentId Id of the Document (e.g.: Document_1)
|
|
447
|
+
* @param blobId Id of the Blob (e.g.: Blob_1)
|
|
448
|
+
* @param size (optional) The size of the image preview. Can be small or large, defaults to small
|
|
449
|
+
*/
|
|
450
|
+
preview(api_version: string | null, documentId: string, blobId: string, size: string | null | undefined): Promise<FileResponse>;
|
|
451
|
+
protected processPreview(response: Response): Promise<FileResponse>;
|
|
452
|
+
/**
|
|
453
|
+
* Update Metadata values on a document
|
|
454
|
+
Dto contains a dictionary with key as DocumentClassMetaDataId and value as string
|
|
455
|
+
* @deprecated
|
|
456
|
+
*/
|
|
457
|
+
setMetadataValues(api_version: string | null, documentId: string, dto: SetDocumentMetadataValuesRequest): Promise<Response>;
|
|
458
|
+
protected processSetMetadataValues(response: Response): Promise<Response>;
|
|
459
|
+
/**
|
|
460
|
+
* Returns document detailed information
|
|
461
|
+
* @param id Document Id (i.e.: Document_1)
|
|
462
|
+
* @param history (optional) Whether or not to also resolve the document activity history
|
|
463
|
+
* @param includeNestedFields (optional) Whether or not to include nested fields in the response
|
|
464
|
+
* @return Document detailed information
|
|
465
|
+
*/
|
|
466
|
+
get(api_version: string | null, id: string, history: boolean | undefined, includeNestedFields: boolean | undefined): Promise<ResponseOfDocumentResponse>;
|
|
467
|
+
protected processGet(response: Response): Promise<ResponseOfDocumentResponse>;
|
|
468
|
+
/**
|
|
469
|
+
* Add a new Revision.
|
|
470
|
+
* @param id Document Id
|
|
471
|
+
* @param request Add revision parameters
|
|
472
|
+
*/
|
|
473
|
+
addRevision(api_version: string | null, id: string, request: AddNewRevisionIfNeededRequest): Promise<Response>;
|
|
474
|
+
protected processAddRevision(response: Response): Promise<Response>;
|
|
475
|
+
/**
|
|
476
|
+
* Approve and Publish the Revision.
|
|
477
|
+
* @param id Document Id
|
|
478
|
+
* @param request Approve revision parameters
|
|
479
|
+
*/
|
|
480
|
+
approveRevision(api_version: string | null, id: string, request: ApproveRevisionRequest): Promise<Response>;
|
|
481
|
+
protected processApproveRevision(response: Response): Promise<Response>;
|
|
482
|
+
/**
|
|
483
|
+
* Archive a document
|
|
484
|
+
* @param id Document Id (i.e.: Document_1)
|
|
485
|
+
*/
|
|
486
|
+
archive(api_version: string | null, id: string): Promise<Response>;
|
|
487
|
+
protected processArchive(response: Response): Promise<Response>;
|
|
488
|
+
/**
|
|
489
|
+
* Delete a document
|
|
490
|
+
* @param id Document Id (i.e.: Document_1)
|
|
491
|
+
*/
|
|
492
|
+
delete(api_version: string | null, id: string): Promise<Response>;
|
|
493
|
+
protected processDelete(response: Response): Promise<Response>;
|
|
494
|
+
/**
|
|
495
|
+
* Download the specified Document.
|
|
496
|
+
If it's a Single file the most recent published blob will be retrieved.
|
|
497
|
+
If it's a Multifile document the ZIP containing all the files will be retrieved
|
|
498
|
+
* @param id Id of the Document (e.g.: Document_1)
|
|
499
|
+
* @param fileName (optional) The name you want to give to the downloaded file, if NULL the Jarvis file name will be used.
|
|
500
|
+
*/
|
|
501
|
+
download(api_version: string | null, id: string, fileName: string | null | undefined): Promise<FileResponse>;
|
|
502
|
+
protected processDownload(response: Response): Promise<FileResponse>;
|
|
503
|
+
/**
|
|
504
|
+
* Download the specified binary file within the Document (FileId or BlobId).
|
|
505
|
+
* @param id Id of the Document (e.g.: Document_1)
|
|
506
|
+
* @param fileIdOrBlobId Can be a FileId (downloads the most recent file revision, e.g.: File_1), or a specific BlobId (downloads the specified revision, e.g.: Blob_1)
|
|
507
|
+
* @param fileName (optional) The name you want to give to the downloaded file, if NULL the Jarvis file name will be used.
|
|
508
|
+
* @param format (optional) The format you want your file in. Can be "original" or "pdf". Defaults to original.
|
|
509
|
+
*/
|
|
510
|
+
downloadBlob(api_version: string | null, id: string, fileIdOrBlobId: string, fileName: string | null | undefined, format: string | null | undefined): Promise<FileResponse>;
|
|
511
|
+
protected processDownloadBlob(response: Response): Promise<FileResponse>;
|
|
512
|
+
/**
|
|
513
|
+
* Set Document Abstract
|
|
514
|
+
* @param id Document Id (i.e.: Document_1)
|
|
515
|
+
* @param abstract The new Document abstract
|
|
516
|
+
*/
|
|
517
|
+
setAbstract(api_version: string | null, id: string, abstract: string): Promise<Response>;
|
|
518
|
+
protected processSetAbstract(response: Response): Promise<Response>;
|
|
519
|
+
/**
|
|
520
|
+
* Set Document Tags
|
|
521
|
+
* @param id Document Id (i.e.: Document_1)
|
|
522
|
+
* @param tags Array of Tags that will replace the old ones.
|
|
523
|
+
*/
|
|
524
|
+
setTags(api_version: string | null, id: string, tags: string[]): Promise<Response>;
|
|
525
|
+
protected processSetTags(response: Response): Promise<Response>;
|
|
526
|
+
/**
|
|
527
|
+
* Set Document Title
|
|
528
|
+
* @param id Document Id (i.e.: Document_1)
|
|
529
|
+
* @param title The new Document Title
|
|
530
|
+
*/
|
|
531
|
+
setTitle(api_version: string | null, id: string, title: string): Promise<Response>;
|
|
532
|
+
protected processSetTitle(response: Response): Promise<Response>;
|
|
533
|
+
/**
|
|
534
|
+
* Unarchive a document
|
|
535
|
+
* @param id Document Id (i.e.: Document_1)
|
|
536
|
+
*/
|
|
537
|
+
unarchive(api_version: string | null, id: string): Promise<Response>;
|
|
538
|
+
protected processUnarchive(response: Response): Promise<Response>;
|
|
539
|
+
}
|
|
540
|
+
export declare class PermalinkV1Client extends JarvisApiBase {
|
|
541
|
+
private http;
|
|
542
|
+
private baseUrl;
|
|
543
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
544
|
+
constructor(configuration: JarvisApiConfig, baseUrl?: string, http?: {
|
|
545
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
546
|
+
});
|
|
547
|
+
/**
|
|
548
|
+
* Create a Permalink element
|
|
549
|
+
|
|
550
|
+
Aggregate will be mapped to a permalink Id
|
|
551
|
+
* @return Permalink Id
|
|
552
|
+
*/
|
|
553
|
+
create(api_version: string | null, permalinkdto: CreatePermalinkRequest): Promise<ResponseOfPermalink>;
|
|
554
|
+
protected processCreate(response: Response): Promise<ResponseOfPermalink>;
|
|
555
|
+
/**
|
|
556
|
+
* Given a Permalink Id, will return the uri to the aggregate
|
|
557
|
+
*/
|
|
558
|
+
navigate(api_version: string | null, id: string): Promise<ResponseOfUri>;
|
|
559
|
+
protected processNavigate(response: Response): Promise<ResponseOfUri>;
|
|
560
|
+
}
|
|
561
|
+
export declare class SearchV1Client extends JarvisApiBase {
|
|
562
|
+
private http;
|
|
563
|
+
private baseUrl;
|
|
564
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
565
|
+
constructor(configuration: JarvisApiConfig, baseUrl?: string, http?: {
|
|
566
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
567
|
+
});
|
|
568
|
+
/**
|
|
569
|
+
* Search Documents and Containers on DMS
|
|
570
|
+
*/
|
|
571
|
+
search(api_version: string | null, dto: SearchResultRequest): Promise<ResponseOfSearchResultResponse>;
|
|
572
|
+
protected processSearch(response: Response): Promise<ResponseOfSearchResultResponse>;
|
|
573
|
+
/**
|
|
574
|
+
* Search documents by their owner (e.g. a CRM entity)
|
|
575
|
+
*/
|
|
576
|
+
searchByOwner(api_version: string | null, dto: SearchByOwnerRequest): Promise<ResponseOfSearchByOwnerResponse>;
|
|
577
|
+
protected processSearchByOwner(response: Response): Promise<ResponseOfSearchByOwnerResponse>;
|
|
578
|
+
}
|
|
579
|
+
export declare class FileUploadV1Client extends JarvisApiBase {
|
|
580
|
+
private http;
|
|
581
|
+
private baseUrl;
|
|
582
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
583
|
+
constructor(configuration: JarvisApiConfig, baseUrl?: string, http?: {
|
|
584
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
585
|
+
});
|
|
586
|
+
/**
|
|
587
|
+
* Upload files via multipart form data and save them in temp folders
|
|
588
|
+
* @param files (optional)
|
|
589
|
+
* @return A List of uploaded file random ids. These ids could be used in further API calls, like document management ones
|
|
590
|
+
*/
|
|
591
|
+
uploadMultipartV2(api_version: string | null, files: FileParameter[] | null | undefined): Promise<ResponseOfFileUploadResultDto>;
|
|
592
|
+
protected processUploadMultipartV2(response: Response): Promise<ResponseOfFileUploadResultDto>;
|
|
593
|
+
/**
|
|
594
|
+
* Upload a file in temp storage and return temp file Id
|
|
595
|
+
to send with other Jarvis call (eg for adding ticket's attachments)
|
|
596
|
+
|
|
597
|
+
The uploaded temp file will be deleted after awhile, based on
|
|
598
|
+
Jarvis global configuration
|
|
599
|
+
* @return uploaded temp file id
|
|
600
|
+
*/
|
|
601
|
+
upload(api_version: string | null): Promise<ResponseOfString>;
|
|
602
|
+
protected processUpload(response: Response): Promise<ResponseOfString>;
|
|
603
|
+
/**
|
|
604
|
+
* Upload files via multipart form data and save them in temp folders
|
|
605
|
+
* @param files (optional)
|
|
606
|
+
* @return A List of uploaded file random ids. These ids could be used in further API calls, like document management ones
|
|
607
|
+
*/
|
|
608
|
+
uploadMultipart(api_version: string | null, files: FileParameter[] | null | undefined): Promise<FileUploadResultDto>;
|
|
609
|
+
protected processUploadMultipart(response: Response): Promise<FileUploadResultDto>;
|
|
610
|
+
}
|
|
611
|
+
export declare class IdTranslationV1Client extends JarvisApiBase {
|
|
612
|
+
private http;
|
|
613
|
+
private baseUrl;
|
|
614
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
615
|
+
constructor(configuration: JarvisApiConfig, baseUrl?: string, http?: {
|
|
616
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
617
|
+
});
|
|
618
|
+
testDeprecated(api_version: string | null): Promise<ResponseOfTranslateIdResponse>;
|
|
619
|
+
protected processTestDeprecated(response: Response): Promise<ResponseOfTranslateIdResponse>;
|
|
620
|
+
testDeprecatedFields(api_version: string | null, request: ComplexApiRequest): Promise<ResponseOfTranslateIdResponse>;
|
|
621
|
+
protected processTestDeprecatedFields(response: Response): Promise<ResponseOfTranslateIdResponse>;
|
|
622
|
+
testPreview(api_version: string | null): Promise<ResponseOfTranslateIdResponse>;
|
|
623
|
+
protected processTestPreview(response: Response): Promise<ResponseOfTranslateIdResponse>;
|
|
624
|
+
translate(api_version: string | null, dto: TranslateIdRequest): Promise<ResponseOfTranslateIdResponse>;
|
|
625
|
+
protected processTranslate(response: Response): Promise<ResponseOfTranslateIdResponse>;
|
|
626
|
+
translateDictionary(api_version: string | null, dto: TranslateIdRequest): Promise<ResponseOfDictionaryOfStringAndSingleTranslatedId>;
|
|
627
|
+
protected processTranslateDictionary(response: Response): Promise<ResponseOfDictionaryOfStringAndSingleTranslatedId>;
|
|
628
|
+
}
|
|
629
|
+
export declare class LongRunningJobPublicV1Client extends JarvisApiBase {
|
|
630
|
+
private http;
|
|
631
|
+
private baseUrl;
|
|
632
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
633
|
+
constructor(configuration: JarvisApiConfig, baseUrl?: string, http?: {
|
|
634
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
635
|
+
});
|
|
636
|
+
getStatusDetail(api_version: string | null, id: string): Promise<ResponseOfLongRunningJobResponse>;
|
|
637
|
+
protected processGetStatusDetail(response: Response): Promise<ResponseOfLongRunningJobResponse>;
|
|
638
|
+
startLongRunningJob(api_version: string | null, id: string): Promise<Response>;
|
|
639
|
+
protected processStartLongRunningJob(response: Response): Promise<Response>;
|
|
640
|
+
getStatus(api_version: string | null, id: string): Promise<ResponseOfLongRunningJobResponse>;
|
|
641
|
+
protected processGetStatus(response: Response): Promise<ResponseOfLongRunningJobResponse>;
|
|
642
|
+
}
|
|
643
|
+
export declare class PropertiesV1Client extends JarvisApiBase {
|
|
644
|
+
private http;
|
|
645
|
+
private baseUrl;
|
|
646
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
647
|
+
constructor(configuration: JarvisApiConfig, baseUrl?: string, http?: {
|
|
648
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
649
|
+
});
|
|
650
|
+
/**
|
|
651
|
+
* List of Properties Definitions filtered by a term
|
|
652
|
+
user can select how many properties to retrieve.
|
|
653
|
+
if MaxAtTime is null, will be sent all properties matched the search
|
|
654
|
+
*/
|
|
655
|
+
search(api_version: string | null, dto: PropertiesDefinitionSearchRequest): Promise<ResponseOfPropertiesDefinitionSearchResponse>;
|
|
656
|
+
protected processSearch(response: Response): Promise<ResponseOfPropertiesDefinitionSearchResponse>;
|
|
657
|
+
/**
|
|
658
|
+
* Given an array of PropertyDefinitionId, will return the matched PropertiesDefinitions
|
|
659
|
+
*/
|
|
660
|
+
getDefinitions(api_version: string | null, dto: PropertiesDefinitionsDataRequest): Promise<ResponseOfPropertiesDefinitionsDataResponse>;
|
|
661
|
+
protected processGetDefinitions(response: Response): Promise<ResponseOfPropertiesDefinitionsDataResponse>;
|
|
662
|
+
/**
|
|
663
|
+
* Given a SELECT/MULTI-SELECT PropertyDefinition Id or Name, will return
|
|
664
|
+
the paginated results for its available values
|
|
665
|
+
*/
|
|
666
|
+
searchSelection(api_version: string | null, dto: PropertiesSelectSearchRequest): Promise<ResponseOfSearchSelectPropertyResultsDto>;
|
|
667
|
+
protected processSearchSelection(response: Response): Promise<ResponseOfSearchSelectPropertyResultsDto>;
|
|
668
|
+
}
|
|
669
|
+
export declare class TicketV1Client extends JarvisApiBase {
|
|
670
|
+
private http;
|
|
671
|
+
private baseUrl;
|
|
672
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
673
|
+
constructor(configuration: JarvisApiConfig, baseUrl?: string, http?: {
|
|
674
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
675
|
+
});
|
|
676
|
+
/**
|
|
677
|
+
* Get information regarding a ticket, given its id.
|
|
678
|
+
Returns a TicketDetailPublicDto DTO.
|
|
679
|
+
*/
|
|
680
|
+
detail(api_version: string | null, dto: GetTicketByIdRequest): Promise<ResponseOfTicketDetailPublicDto>;
|
|
681
|
+
protected processDetail(response: Response): Promise<ResponseOfTicketDetailPublicDto>;
|
|
682
|
+
/**
|
|
683
|
+
* Download a ticket or ticket reply attachment
|
|
684
|
+
*/
|
|
685
|
+
getAttachment(api_version: string | null, request: TicketAttachmentRequest): Promise<FileResponse>;
|
|
686
|
+
protected processGetAttachment(response: Response): Promise<FileResponse>;
|
|
687
|
+
/**
|
|
688
|
+
* Read ticket or ticket reply content as string
|
|
689
|
+
*/
|
|
690
|
+
getContentAsString(api_version: string | null, request: TicketContentRequest): Promise<ResponseOfString>;
|
|
691
|
+
protected processGetContentAsString(response: Response): Promise<ResponseOfString>;
|
|
692
|
+
/**
|
|
693
|
+
* Search tickets
|
|
694
|
+
*/
|
|
695
|
+
search(api_version: string | null, request: TicketSearchRequest): Promise<ResponseOfPureJsonOmniSearchResultDto>;
|
|
696
|
+
protected processSearch(response: Response): Promise<ResponseOfPureJsonOmniSearchResultDto>;
|
|
697
|
+
/**
|
|
698
|
+
* Upsert a ticket
|
|
699
|
+
* @param request dto for upsert a ticket
|
|
700
|
+
*/
|
|
701
|
+
upsert(api_version: string | null, request: TicketUpsertRequest): Promise<ResponseOfString>;
|
|
702
|
+
protected processUpsert(response: Response): Promise<ResponseOfString>;
|
|
703
|
+
}
|
|
704
|
+
export declare class WorkspaceV1Client extends JarvisApiBase {
|
|
705
|
+
private http;
|
|
706
|
+
private baseUrl;
|
|
707
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
708
|
+
constructor(configuration: JarvisApiConfig, baseUrl?: string, http?: {
|
|
709
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
710
|
+
});
|
|
711
|
+
/**
|
|
712
|
+
* Get metadata information regarding a workspace, given its id.
|
|
713
|
+
*/
|
|
714
|
+
settings(api_version: string | null, workspaceId: string): Promise<ResponseOfWorkspaceSettingsResponse>;
|
|
715
|
+
protected processSettings(response: Response): Promise<ResponseOfWorkspaceSettingsResponse>;
|
|
716
|
+
}
|
|
717
|
+
export declare class WorkTaskV1Client extends JarvisApiBase {
|
|
718
|
+
private http;
|
|
719
|
+
private baseUrl;
|
|
720
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
721
|
+
constructor(configuration: JarvisApiConfig, baseUrl?: string, http?: {
|
|
722
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
723
|
+
});
|
|
724
|
+
/**
|
|
725
|
+
* Get information regarding a worktask, given its id.
|
|
726
|
+
Returns a WorkTaskDetailPublicDto DTO.
|
|
727
|
+
*/
|
|
728
|
+
detailNew(api_version: string | null, dto: GetWorkTaskByIdRequest): Promise<ResponseOfWorkTaskDetailPublicDto>;
|
|
729
|
+
protected processDetailNew(response: Response): Promise<ResponseOfWorkTaskDetailPublicDto>;
|
|
730
|
+
/**
|
|
731
|
+
* Get information for a list of WorkTask, it is the very same of DetailNew
|
|
732
|
+
but allowing to ask for a list of id and returns an array of result.
|
|
733
|
+
*/
|
|
734
|
+
detailList(api_version: string | null, dto: GetWorkTasksByIdListRequest): Promise<ResponseOfIReadOnlyCollectionOfWorkTaskDetailPublicDto>;
|
|
735
|
+
protected processDetailList(response: Response): Promise<ResponseOfIReadOnlyCollectionOfWorkTaskDetailPublicDto>;
|
|
736
|
+
/**
|
|
737
|
+
* DEPRECATED: search worktasks returning a json-style object.
|
|
738
|
+
Use POST /workspaces/api/public/worktask/{workspaceId}/search instead, which accepts
|
|
739
|
+
a typed filtering expression and returns well typed worktask dtos.
|
|
740
|
+
*/
|
|
741
|
+
search(api_version: string | null, request: WorkTaskSearchRequest): Promise<ResponseOfPureJsonOmniSearchResultDto>;
|
|
742
|
+
protected processSearch(response: Response): Promise<ResponseOfPureJsonOmniSearchResultDto>;
|
|
743
|
+
/**
|
|
744
|
+
* Upsert worktask status
|
|
745
|
+
* @param request dto for upsert a worktask
|
|
746
|
+
*/
|
|
747
|
+
upsert(api_version: string | null, request: WorkTaskUpsertRequest): Promise<ResponseOfString>;
|
|
748
|
+
protected processUpsert(response: Response): Promise<ResponseOfString>;
|
|
749
|
+
/**
|
|
750
|
+
* Get information regarding a worktask, given its id.
|
|
751
|
+
Returns a json object containing its properties.
|
|
752
|
+
*/
|
|
753
|
+
detail(api_version: string | null, workTaskId: string): Promise<ResponseOfJObject>;
|
|
754
|
+
protected processDetail(response: Response): Promise<ResponseOfJObject>;
|
|
755
|
+
}
|
|
756
|
+
/** API Response Object. */
|
|
757
|
+
export interface JarvisResponse {
|
|
758
|
+
/** Success or Failure.
|
|
759
|
+
Failure can happen due to validation or constraint violation errors. */
|
|
760
|
+
success?: boolean;
|
|
761
|
+
/** An array of log entries that explain what happens inside the request. */
|
|
762
|
+
logs?: ResponseLog[] | undefined;
|
|
763
|
+
/** Error object describing what went wrong. */
|
|
764
|
+
error?: ResponseError | undefined;
|
|
765
|
+
}
|
|
766
|
+
export interface ResponseLog {
|
|
767
|
+
severity?: ResponseLogSeverity;
|
|
768
|
+
message?: string | undefined;
|
|
769
|
+
}
|
|
770
|
+
export declare enum ResponseLogSeverity {
|
|
771
|
+
None = "None",
|
|
772
|
+
Info = "Info",
|
|
773
|
+
Warning = "Warning",
|
|
774
|
+
Error = "Error"
|
|
775
|
+
}
|
|
776
|
+
/** The Error object */
|
|
777
|
+
export interface ResponseError {
|
|
778
|
+
/** Defined error code */
|
|
779
|
+
code?: string | undefined;
|
|
780
|
+
/** A human-readable representation of the error. */
|
|
781
|
+
message?: string | undefined;
|
|
782
|
+
/** [optional] An object containing more specific information than the current object about the error. */
|
|
783
|
+
data?: any | undefined;
|
|
784
|
+
/** [optional] In case of complex / structured errors. */
|
|
785
|
+
details?: ResponseError[] | undefined;
|
|
786
|
+
}
|
|
787
|
+
export interface JarvisRequestBase {
|
|
788
|
+
answerType?: AnswerType;
|
|
789
|
+
signature?: string | undefined;
|
|
790
|
+
}
|
|
791
|
+
export declare enum AnswerType {
|
|
792
|
+
Unknown = 0,
|
|
793
|
+
MachineEncrypted = 1,
|
|
794
|
+
PublicKeyEncrypted = 2
|
|
795
|
+
}
|
|
796
|
+
export interface TokenResponse {
|
|
797
|
+
token?: string | undefined;
|
|
798
|
+
expirationDate?: string | undefined;
|
|
799
|
+
userName?: string | undefined;
|
|
800
|
+
claims?: string[] | undefined;
|
|
801
|
+
}
|
|
802
|
+
export interface TokenRequest extends JarvisRequestBase {
|
|
803
|
+
userReference?: string | undefined;
|
|
804
|
+
authType?: string | undefined;
|
|
805
|
+
authNonce?: string | undefined;
|
|
806
|
+
forceEncryptionWithStaticKey?: boolean;
|
|
807
|
+
}
|
|
808
|
+
export interface ActiveDirectoryUserCredentialsValidationRequest extends JarvisRequestBase {
|
|
809
|
+
serverAddress?: string | undefined;
|
|
810
|
+
domain?: string | undefined;
|
|
811
|
+
userName?: string | undefined;
|
|
812
|
+
password?: string | undefined;
|
|
813
|
+
}
|
|
814
|
+
export interface ValidateTokenRequest extends JarvisRequestBase {
|
|
815
|
+
token?: string | undefined;
|
|
816
|
+
forceEncryptionWithStaticKey?: boolean;
|
|
817
|
+
}
|
|
818
|
+
/** Request DTO for reporting login events from the proxy to Jarvis. Used by the proxy to report events it observes (OIDC/SSO login, logout) that Jarvis cannot observe on its own (FR-023, US1b). */
|
|
819
|
+
export interface ReportLoginEventRequest extends JarvisRequestBase {
|
|
820
|
+
/** The kind of event being reported: "login-success", "login-failure", or "logout". */
|
|
821
|
+
eventKind?: string | undefined;
|
|
822
|
+
/** The authentication method that handled the event (e.g., "Oidc", "ADValidation"). */
|
|
823
|
+
authMethod?: string | undefined;
|
|
824
|
+
/** The authenticated user ID, when available (nullable for failures where identity is not established). */
|
|
825
|
+
userId?: string | undefined;
|
|
826
|
+
/** The user's email address, when available (nullable for failures or logouts where email is not present). */
|
|
827
|
+
userEmail?: string | undefined;
|
|
828
|
+
/** The source IP address of the request, when available (nullable; null persisted as null per FR-028). */
|
|
829
|
+
sourceIp?: string | undefined;
|
|
830
|
+
/** The URL of the request, when available (nullable). */
|
|
831
|
+
url?: string | undefined;
|
|
832
|
+
/** The timestamp of the event (UTC). */
|
|
833
|
+
timestamp?: Date;
|
|
834
|
+
/** The failure reason for login-failure events (e.g., "InvalidCredentials").
|
|
835
|
+
Null or omitted for success/logout events. */
|
|
836
|
+
failureReason?: string | undefined;
|
|
837
|
+
}
|
|
838
|
+
/** API Response Object. */
|
|
839
|
+
export interface ResponseOfTeamPublicDetailResponseDto extends JarvisResponse {
|
|
840
|
+
/** The actual result of the operation. */
|
|
841
|
+
data?: TeamPublicDetailResponseDto | undefined;
|
|
842
|
+
}
|
|
843
|
+
/** { "Id": "Team_X", "AggregateId": "Contact_X", // Related Aggregate id (contacts, accounts, etc...) "Name": "Team name", "Members": [ { "UserId": "User_X", "UserName": "John Doe", // user fullName "RoleTypeId": "RoleType_X", "RoleTypeName": "Administrator", // RoleType denormalized value "Note": "Related user role notes" } ], "IsPublic": "bool" // team visibility restrictions enabled? } */
|
|
844
|
+
export interface TeamPublicDetailResponseDto {
|
|
845
|
+
id?: string | undefined;
|
|
846
|
+
aggregateId?: string | undefined;
|
|
847
|
+
name?: string | undefined;
|
|
848
|
+
members?: TeamMemberDto[] | undefined;
|
|
849
|
+
isPublic?: boolean;
|
|
850
|
+
}
|
|
851
|
+
export interface TeamMemberDto {
|
|
852
|
+
userId?: string | undefined;
|
|
853
|
+
roleTypeId?: string | undefined;
|
|
854
|
+
note?: string | undefined;
|
|
855
|
+
userName?: string | undefined;
|
|
856
|
+
roleTypeName?: string | undefined;
|
|
857
|
+
}
|
|
858
|
+
/** { "Id":"Team_X", //HistoricalVersionInfo is optional. "HistoricalVersionInfo" : { //those three are mutually exclusive!! "Version" : 4 "TimestampInUtc" : "2022-09-12T10:00:55Z" "Checkpoint" : 400 } } */
|
|
859
|
+
export interface TeamDetailRequestDto {
|
|
860
|
+
historicalVersionInfo?: HistoricalVersionInfoDto | undefined;
|
|
861
|
+
/** TeamId */
|
|
862
|
+
id?: string | undefined;
|
|
863
|
+
}
|
|
864
|
+
/** Selects the version of an entity to return. Set only one of Version, TimestampInUtc, Checkpoint or Latest: they are mutually exclusive. */
|
|
865
|
+
export interface HistoricalVersionInfoDto {
|
|
866
|
+
/** Most up-to-date version, will project all events.
|
|
867
|
+
- null or true : get most up to date version
|
|
868
|
+
- false: get last projected version */
|
|
869
|
+
latest?: boolean | undefined;
|
|
870
|
+
/** Returns the entity as it was at this global event store checkpoint. */
|
|
871
|
+
checkpoint?: number | undefined;
|
|
872
|
+
/** Returns the entity at this aggregate version. */
|
|
873
|
+
version?: number | undefined;
|
|
874
|
+
/** Returns the entity as it was at this point in time, ISO 8601 UTC (e.g. 2022-09-12T10:00:55Z). */
|
|
875
|
+
timestampInUtc?: string | undefined;
|
|
876
|
+
}
|
|
877
|
+
/** API Response Object. */
|
|
878
|
+
export interface ResponseOfString extends JarvisResponse {
|
|
879
|
+
/** The actual result of the operation. */
|
|
880
|
+
data?: string | undefined;
|
|
881
|
+
}
|
|
882
|
+
/** { "TeamId":"string", "AddRolesRequest":{ "RolesToAdd":[ { "UserId":"string", "RoleId":"string", "Note":"string" } ] }, "RemoveTeamUsersRequest":{ "RolesToRemove":[ { "UserId":"string", "RoleId":"string", "Note":"string" } ] }, "ChangePrivateStatusRequest":{ "IsPrivate":true, "RoleId":"string", "ListCleanUp":true } } */
|
|
883
|
+
export interface TeamUpdateRequestDto {
|
|
884
|
+
/** CANNOT BE NULL
|
|
885
|
+
Teams are automatically generated by related aggregate and cannot be created by external API call, they can only be updated! */
|
|
886
|
+
teamId?: string | undefined;
|
|
887
|
+
addRolesRequest?: TeamUpdateAddUserRoleRequest | undefined;
|
|
888
|
+
removeTeamUsersRequest?: TeamUpdateRemoveUserRequest | undefined;
|
|
889
|
+
changePrivateStatusRequest?: TeamUpdateChangePrivateStatusRequest | undefined;
|
|
890
|
+
}
|
|
891
|
+
export interface TeamUpdateAddUserRoleRequest {
|
|
892
|
+
rolesToAdd?: TeamUpdateRoleDto[] | undefined;
|
|
893
|
+
}
|
|
894
|
+
export interface TeamUpdateRoleDto {
|
|
895
|
+
userId?: string | undefined;
|
|
896
|
+
roleId?: string | undefined;
|
|
897
|
+
note?: string | undefined;
|
|
898
|
+
}
|
|
899
|
+
export interface TeamUpdateRemoveUserRequest {
|
|
900
|
+
/** List of userId to remove from team */
|
|
901
|
+
rolesToRemove?: TeamUpdateRoleDto[] | undefined;
|
|
902
|
+
}
|
|
903
|
+
export interface TeamUpdateChangePrivateStatusRequest {
|
|
904
|
+
/** Set team visibility to private or public.
|
|
905
|
+
Private teams are visible only to team members and users with generic write permissions on related aggregate, public teams are visible to everyone. */
|
|
906
|
+
isPrivate?: boolean;
|
|
907
|
+
/** If null, generic role will be selected */
|
|
908
|
+
roleId?: string | undefined;
|
|
909
|
+
/** Clear all user list and relative roles */
|
|
910
|
+
listCleanUp?: boolean;
|
|
911
|
+
}
|
|
912
|
+
/** API Response Object. */
|
|
913
|
+
export interface ResponseOfUserInfoResponse extends JarvisResponse {
|
|
914
|
+
/** The actual result of the operation. */
|
|
915
|
+
data?: UserInfoResponse | undefined;
|
|
916
|
+
}
|
|
917
|
+
/** Information about a Jarvis User */
|
|
918
|
+
export interface UserInfoResponse {
|
|
919
|
+
/** User Id */
|
|
920
|
+
id?: string | undefined;
|
|
921
|
+
/** User Fullname */
|
|
922
|
+
fullname?: string | undefined;
|
|
923
|
+
/** AvatarId is the string you need to pass to the avatar service API to generate
|
|
924
|
+
user avatar. */
|
|
925
|
+
avatarId?: string | undefined;
|
|
926
|
+
/** Id of the groups to which to user belongs */
|
|
927
|
+
groupIds?: string[] | undefined;
|
|
928
|
+
}
|
|
929
|
+
/** API Response Object. */
|
|
930
|
+
export interface ResponseOfIReadOnlyListOfUserInfoSearchResult extends JarvisResponse {
|
|
931
|
+
/** The actual result of the operation. */
|
|
932
|
+
data?: UserInfoSearchResult[] | undefined;
|
|
933
|
+
}
|
|
934
|
+
export interface OmnisearchResultResponseOfUserInfoSearchResult extends ResponseOfIReadOnlyListOfUserInfoSearchResult {
|
|
935
|
+
total?: number;
|
|
936
|
+
}
|
|
937
|
+
export interface UserInfoSearchResult {
|
|
938
|
+
id?: string | undefined;
|
|
939
|
+
/** User FullName (First Name + Middle Name + Last Name) */
|
|
940
|
+
title?: string | undefined;
|
|
941
|
+
firstName?: string | undefined;
|
|
942
|
+
lastName?: string | undefined;
|
|
943
|
+
signature?: string | undefined;
|
|
944
|
+
eMail?: string | undefined;
|
|
945
|
+
/** User roles (crm, plm...) */
|
|
946
|
+
roles?: string[] | undefined;
|
|
947
|
+
disabled?: boolean;
|
|
948
|
+
disabledAt?: Date | undefined;
|
|
949
|
+
disabledBy?: string | undefined;
|
|
950
|
+
middleName?: string | undefined;
|
|
951
|
+
plmUserId?: string | undefined;
|
|
952
|
+
crmUserId?: string | undefined;
|
|
953
|
+
logins?: string[] | undefined;
|
|
954
|
+
}
|
|
955
|
+
/** Base class to express a search in omnisearch done by public api, that is simple to use. */
|
|
956
|
+
export interface OmniSearchPublicSearchRequest {
|
|
957
|
+
/** If different from null it will specify the field to be use for
|
|
958
|
+
sorting. */
|
|
959
|
+
sortField?: string | undefined;
|
|
960
|
+
/** If SortField is not null, this value allow for searching
|
|
961
|
+
ascending or descending. */
|
|
962
|
+
sortDescending?: boolean;
|
|
963
|
+
/** Ordered list of sort conditions. When non-empty this is authoritative and
|
|
964
|
+
takes precedence over the deprecated scalar sort fields. */
|
|
965
|
+
sortConditions?: PublicSortCondition[] | undefined;
|
|
966
|
+
/** Page size, how many element you want to return. */
|
|
967
|
+
pageSize?: number;
|
|
968
|
+
/** Start index allow to paginate the result, 0 means starts from the first element
|
|
969
|
+
and if you want second page you need to specify PageSize multiplied by the page size.
|
|
970
|
+
|
|
971
|
+
Ex.
|
|
972
|
+
|
|
973
|
+
PageSize = 10 and StartIndex = 0 will return the first 10 elements.
|
|
974
|
+
PageSize = 10 and StartIndex = 10 will return the second 10 elements.
|
|
975
|
+
PageSize = 10 and StartIndex = 20 will return the third 10 elements. */
|
|
976
|
+
startIndex?: number;
|
|
977
|
+
/** true if you want to search even deleted items. */
|
|
978
|
+
showArchived?: boolean;
|
|
979
|
+
/** Text for a full text search, not specific field parameters. */
|
|
980
|
+
text?: string | undefined;
|
|
981
|
+
/** true if you want to search for all terms in the text. */
|
|
982
|
+
includeAllTerms?: boolean | undefined;
|
|
983
|
+
/** This is field specific search. */
|
|
984
|
+
fieldSearches?: FieldSearch[] | undefined;
|
|
985
|
+
/** Advanced filtering expression */
|
|
986
|
+
filteringExpression?: PublicFilteringExpressionDto | undefined;
|
|
987
|
+
}
|
|
988
|
+
/** Represents a single sort condition for OmniSearch results. */
|
|
989
|
+
export interface PublicSortCondition {
|
|
990
|
+
/** Internal field id or field name to order by. */
|
|
991
|
+
field?: string | undefined;
|
|
992
|
+
/** true for descending, false (default) for ascending. */
|
|
993
|
+
descending?: boolean;
|
|
994
|
+
}
|
|
995
|
+
export interface FieldSearch {
|
|
996
|
+
propertyName?: string | undefined;
|
|
997
|
+
/** This is used when you search for equality or single value. */
|
|
998
|
+
value?: any | undefined;
|
|
999
|
+
/** Trigger an exact search, where no analyzer is used in elastic (useful for id etc). */
|
|
1000
|
+
exactSearch?: boolean;
|
|
1001
|
+
/** Valid only if ExactSearch is true, allows for a case sensitive search. */
|
|
1002
|
+
caseSensitiveSearch?: boolean | undefined;
|
|
1003
|
+
}
|
|
1004
|
+
/** Combines a list of operands (field filters or nested expressions) with a logic operator. */
|
|
1005
|
+
export interface PublicFilteringExpressionDto {
|
|
1006
|
+
/** Logic operator used to combine the operands: 0 = And (default), 1 = Or.
|
|
1007
|
+
The names "And" and "Or" are accepted as well. */
|
|
1008
|
+
logic?: PublicFilteringLogic | undefined;
|
|
1009
|
+
/** List of filtering operands to apply.
|
|
1010
|
+
Each one could be a simple FieldFiltersPublicDto or a nested PublicFilteringExpressionDto */
|
|
1011
|
+
operands?: IFilteringOperandPublicDto[] | undefined;
|
|
1012
|
+
}
|
|
1013
|
+
/** Logic operator used to combine the operands of a PublicFilteringExpressionDto. */
|
|
1014
|
+
export declare enum PublicFilteringLogic {
|
|
1015
|
+
And = 0,
|
|
1016
|
+
Or = 1
|
|
1017
|
+
}
|
|
1018
|
+
/** A single operand of a PublicFilteringExpressionDto. It has no properties of its own: each element of the operands array must be a JSON object with one of the two following shapes. Property names are case insensitive. 1. Nested expression (PublicFilteringExpressionDto), used whenever the object has an "operands" property: { "logic": 1, "operands": [ { "field": "field2", "value": "B" }, { "field": "field3", "value": ["C", "D"], "filterType": "OneOf" } ] } - logic: how the operands are combined, 0 = And (default), 1 = Or. The names "And" and "Or" are accepted as well. - operands: array of operands, each one again a nested expression or a field filter. 2. Field filter (FieldFiltersPublicDto), used for any object without "operands": { "field": "field1", "value": "A", "filterType": "NotEqual", "caseSensitive": false } - field: internal field id or field name to filter on. - value: single value, or array of values for OneOf, NotOneOf and Between. Ignored by IsNull and IsNotNull. - filterType: Equals, NotEqual, OneOf, NotOneOf, Contains, DoesNotContain, StartsWith, EndsWith, GreaterThan, GreaterThanOrEqualTo, LessThan, LessThanOrEqualTo, Between, IsNull, IsNotNull. When omitted, Equals is used for a single value and OneOf for an array. Not every filter type is allowed on every field type (see filterType on FieldFiltersPublicDto). - caseSensitive: optional, applies only to equality filters. The two shapes can be nested at any depth to build complex conditions. */
|
|
1019
|
+
export interface IFilteringOperandPublicDto {
|
|
1020
|
+
}
|
|
1021
|
+
/** API Response Object. */
|
|
1022
|
+
export interface ResponseOfTranslateUsersResponse extends JarvisResponse {
|
|
1023
|
+
/** The actual result of the operation. */
|
|
1024
|
+
data?: TranslateUsersResponse | undefined;
|
|
1025
|
+
}
|
|
1026
|
+
/** Return translation of userid into some user friendly information (fullName and avatarId) */
|
|
1027
|
+
export interface TranslateUsersResponse {
|
|
1028
|
+
/** List of translated users. */
|
|
1029
|
+
users?: UserInfoResponse[] | undefined;
|
|
1030
|
+
}
|
|
1031
|
+
/** Allows the caller to pass a list of valid UserId and retrieve the translation with information about the user. */
|
|
1032
|
+
export interface TranslateUserRequest {
|
|
1033
|
+
/** List of UserId to translate */
|
|
1034
|
+
userIdList?: string[] | undefined;
|
|
1035
|
+
}
|
|
1036
|
+
/** API Response Object. */
|
|
1037
|
+
export interface ResponseOfGetEmailsResponse extends JarvisResponse {
|
|
1038
|
+
/** The actual result of the operation. */
|
|
1039
|
+
data?: GetEmailsResponse | undefined;
|
|
1040
|
+
}
|
|
1041
|
+
/** Allows the caller to pass a list of valid UserId or GroupId and retrieve email information for all entities */
|
|
1042
|
+
export interface GetEmailsResponse {
|
|
1043
|
+
/** Email associated to GroupId */
|
|
1044
|
+
groupEmails?: EmailInfo[] | undefined;
|
|
1045
|
+
/** Email associated to UserId */
|
|
1046
|
+
userEmails?: EmailInfo[] | undefined;
|
|
1047
|
+
}
|
|
1048
|
+
export interface EmailInfo {
|
|
1049
|
+
id?: string | undefined;
|
|
1050
|
+
email?: string | undefined;
|
|
1051
|
+
description?: string | undefined;
|
|
1052
|
+
}
|
|
1053
|
+
/** Allows the caller to pass a list of valid UserId or GroupId and retrieve email information for all entities */
|
|
1054
|
+
export interface GetEmailsRequest {
|
|
1055
|
+
/** List of UserId or GroupId to retrieve email information */
|
|
1056
|
+
idList?: string[] | undefined;
|
|
1057
|
+
/** If true for each GroupId present in IdList
|
|
1058
|
+
property server will expand all the user belonging to that group and
|
|
1059
|
+
will include in the answer. */
|
|
1060
|
+
expandGroups?: boolean;
|
|
1061
|
+
/** Filter disabled groups or users */
|
|
1062
|
+
filterDisabled?: boolean;
|
|
1063
|
+
}
|
|
1064
|
+
export interface BaseAccountUpsertRequest {
|
|
1065
|
+
/** The account id.
|
|
1066
|
+
If "null", we need to create it
|
|
1067
|
+
If it holds a value, update this account */
|
|
1068
|
+
accountId?: string | undefined;
|
|
1069
|
+
/** "UpdateBaseInfoRequest": {
|
|
1070
|
+
"Name": "",
|
|
1071
|
+
"AccountStateId": "CrmAccountState_X"
|
|
1072
|
+
} */
|
|
1073
|
+
updateBaseInfoRequest?: UpdateAccountNameRequestDto | undefined;
|
|
1074
|
+
/** The website associated with this account
|
|
1075
|
+
|
|
1076
|
+
"WebSiteRequest": {
|
|
1077
|
+
WebSite: ""
|
|
1078
|
+
} */
|
|
1079
|
+
setWebSiteRequest?: UpdateAccountWebSiteRequestDto | undefined;
|
|
1080
|
+
/** The VAT number associated with this account
|
|
1081
|
+
|
|
1082
|
+
"SetVATNumberRequest ": {
|
|
1083
|
+
"VATNumber": ""
|
|
1084
|
+
} */
|
|
1085
|
+
setVATNumberRequest?: UpdateAccountVATNumberRequestDto | undefined;
|
|
1086
|
+
/** The total number of emplyees in this account
|
|
1087
|
+
|
|
1088
|
+
"SetEmployeeNumberRequest":{
|
|
1089
|
+
"EmployeeNumber": ""
|
|
1090
|
+
} */
|
|
1091
|
+
setEmployeeNumberRequest?: UpdateAccountEmployeeNumberRequestDto | undefined;
|
|
1092
|
+
/** The annual revenue of this account
|
|
1093
|
+
|
|
1094
|
+
"SetAnnualRevenueRequest": {
|
|
1095
|
+
"AnnualRevenue" : ""
|
|
1096
|
+
} */
|
|
1097
|
+
setAnnualRevenueRequest?: SetAnnualRevenueRequestDto | undefined;
|
|
1098
|
+
/** Set to true if we want to archive this account
|
|
1099
|
+
|
|
1100
|
+
"SetAccountArchivedRequestDto":{
|
|
1101
|
+
"Archived" : false
|
|
1102
|
+
} */
|
|
1103
|
+
setArchivedRequest?: SetAccountArchivedRequestDto | undefined;
|
|
1104
|
+
/** Update addresses
|
|
1105
|
+
|
|
1106
|
+
"UpdateAddressesRequest": {
|
|
1107
|
+
"Addresses":[
|
|
1108
|
+
{
|
|
1109
|
+
"Id": "CrmAddress_X", // CANNOT BE NULL
|
|
1110
|
+
"AddressLine" : "Via Martiri della libertà",
|
|
1111
|
+
"AddressLine2" : "C/O Proximo S.R.L.",
|
|
1112
|
+
"City": "Castelfidardo",
|
|
1113
|
+
"Municipality": "Castelfidardo",
|
|
1114
|
+
"ZIPCode": "60022",
|
|
1115
|
+
"County" : "Marche",
|
|
1116
|
+
"State" : "Italia", // IT or italy or italia or State_X
|
|
1117
|
+
"POBox": ""
|
|
1118
|
+
}
|
|
1119
|
+
]
|
|
1120
|
+
} */
|
|
1121
|
+
updateAddressesRequest?: UpdateAccountAddressesRequestDto | undefined;
|
|
1122
|
+
/** Remove Address by Id
|
|
1123
|
+
|
|
1124
|
+
"RemoveAddressesRequest": {
|
|
1125
|
+
"AddressIds":["CrmAddress_1", "CrmAddress_2"]
|
|
1126
|
+
} */
|
|
1127
|
+
removeAddressesRequest?: RemoveAccountAddressesRequestDto | undefined;
|
|
1128
|
+
/** "RemovePhoneNumbersRequest": {
|
|
1129
|
+
"PhoneIds": ["CrmPhoneNumber_1", "CrmPhoneNumber_2"]
|
|
1130
|
+
} */
|
|
1131
|
+
removePhoneNumbersRequest?: RemoveAccountPhoneNumbersRequestDto | undefined;
|
|
1132
|
+
/** "RemoveEmailsRequest": {
|
|
1133
|
+
"EmailIds": ["CrmEmailAddress_1"]
|
|
1134
|
+
} */
|
|
1135
|
+
removeEmailsRequest?: RemoveAccountEmailRequestDto | undefined;
|
|
1136
|
+
/** "AddSocialsRequest": {
|
|
1137
|
+
"Socials": [
|
|
1138
|
+
{
|
|
1139
|
+
"Type": "LinkedIn", //social type (Facebook, Twitter, Skype, Instagram, LinkedIn, Google+) or CrmSocialType_X
|
|
1140
|
+
"Value": "Proximo SRL",
|
|
1141
|
+
"Note":""
|
|
1142
|
+
}
|
|
1143
|
+
]
|
|
1144
|
+
} */
|
|
1145
|
+
addSocialsRequest?: AddAccountSocialRequestDto | undefined;
|
|
1146
|
+
/** "RemoveSocialsRequest": {
|
|
1147
|
+
"SocialIds": ["CrmSocial_X"]
|
|
1148
|
+
} */
|
|
1149
|
+
removeSocialsRequest?: RemoveAccountSocialRequestDto | undefined;
|
|
1150
|
+
/** "UpdateSocialRequest": {
|
|
1151
|
+
"Socials": [
|
|
1152
|
+
{
|
|
1153
|
+
"Id": "CrmSocial_X", //CANNOT BE NULL
|
|
1154
|
+
"Type": "LinkedIn", //social type (Facebook, Twitter, Skype, Instagram, LinkedIn, Google+) or CrmSocialType_X
|
|
1155
|
+
"Value": "Proximo SRL",
|
|
1156
|
+
"Note":""
|
|
1157
|
+
}
|
|
1158
|
+
]
|
|
1159
|
+
} */
|
|
1160
|
+
updateSocialsRequest?: UpdateAccountSocialRequestDto | undefined;
|
|
1161
|
+
/** "AddDivisionRequest": {
|
|
1162
|
+
"Divisions": ["Division_1"]
|
|
1163
|
+
} */
|
|
1164
|
+
addDivisionRequest?: AccountDivisionRequestDto | undefined;
|
|
1165
|
+
/** "RemoveDivisionRequest": {
|
|
1166
|
+
"Divisions": ["Division_1"]
|
|
1167
|
+
} */
|
|
1168
|
+
removeDivisionRequest?: AccountDivisionRequestDto | undefined;
|
|
1169
|
+
/** Set or update the account external id */
|
|
1170
|
+
updateExternalIdRequest?: AccountExternalIdUpdateRequestDto | undefined;
|
|
1171
|
+
}
|
|
1172
|
+
export interface AccountUpsertRequest extends BaseAccountUpsertRequest {
|
|
1173
|
+
/** All data to create an Account
|
|
1174
|
+
Name and CommercialAreaId is mandatory in order to create an Account */
|
|
1175
|
+
createRequest?: CreateAccountRequestDto | undefined;
|
|
1176
|
+
/** Update value properties
|
|
1177
|
+
|
|
1178
|
+
"UpdatePropertiesRequest" : {
|
|
1179
|
+
"UpdateValues": [
|
|
1180
|
+
{
|
|
1181
|
+
"FormFieldId": "",
|
|
1182
|
+
"Values":[
|
|
1183
|
+
{} // object or value
|
|
1184
|
+
]
|
|
1185
|
+
}
|
|
1186
|
+
]
|
|
1187
|
+
} */
|
|
1188
|
+
updatePropertiesRequest?: PublicFormDataValuesUpdateRequest | undefined;
|
|
1189
|
+
/** Add addresses
|
|
1190
|
+
|
|
1191
|
+
"AddAddressesRequest": {
|
|
1192
|
+
"Addresses":[
|
|
1193
|
+
{
|
|
1194
|
+
"AddressLine" : "Via Martiri della libertà",
|
|
1195
|
+
"AddressLine2" : "C/O Proximo S.R.L.",
|
|
1196
|
+
"City": "Castelfidardo",
|
|
1197
|
+
"Municipality": "Castelfidardo",
|
|
1198
|
+
"ZIPCode": "60022",
|
|
1199
|
+
"County" : "Marche",
|
|
1200
|
+
"State" : "Italia", // IT or italy or italia or State_X
|
|
1201
|
+
"POBox": ""
|
|
1202
|
+
}
|
|
1203
|
+
]
|
|
1204
|
+
} */
|
|
1205
|
+
addAddressesRequest?: AddAccountAddressesRequestDto | undefined;
|
|
1206
|
+
/** "AddPhoneNumbersRequest": {
|
|
1207
|
+
"Phones": [
|
|
1208
|
+
{
|
|
1209
|
+
"PhoneNumber": "",
|
|
1210
|
+
"Type": "Phone" //Phone, Mobile, Fax
|
|
1211
|
+
}
|
|
1212
|
+
]
|
|
1213
|
+
} */
|
|
1214
|
+
addPhoneNumbersRequest?: AddAccountPhoneNumbersRequestDto | undefined;
|
|
1215
|
+
/** "UpdatePhoneNumbersRequest": {
|
|
1216
|
+
"Phones": [
|
|
1217
|
+
{
|
|
1218
|
+
"Id": "CrmPhoneNumber_X", // CANNOT BE NULL
|
|
1219
|
+
"PhoneNumber": "",
|
|
1220
|
+
"Type": "Phone" //Phone, Mobile, Fax
|
|
1221
|
+
}
|
|
1222
|
+
]
|
|
1223
|
+
} */
|
|
1224
|
+
updatePhoneNumbersRequest?: UpdateAccountPhoneNumbersRequestDto | undefined;
|
|
1225
|
+
/** "AddEmailsRequest": {
|
|
1226
|
+
"Emails":[
|
|
1227
|
+
{
|
|
1228
|
+
"Email" : "info@prxm.it",
|
|
1229
|
+
"Name" : "Info Prxm",
|
|
1230
|
+
"Note": "",
|
|
1231
|
+
"Type": "" //Email, PersonalEMail, etc...
|
|
1232
|
+
}
|
|
1233
|
+
]
|
|
1234
|
+
} */
|
|
1235
|
+
addEmailsRequest?: AddAccountEmailRequestDto | undefined;
|
|
1236
|
+
/** "UpdateEmailsRequest": {
|
|
1237
|
+
"Emails":[
|
|
1238
|
+
{
|
|
1239
|
+
"Id" : "CrmEmailAddress_1", CANNOT BE NULL
|
|
1240
|
+
"Email" : "info@prxm.it",
|
|
1241
|
+
"Name" : "Info Prxm",
|
|
1242
|
+
"Note": "",
|
|
1243
|
+
"Type": "" //Email, PersonalEMail, etc...
|
|
1244
|
+
}
|
|
1245
|
+
]
|
|
1246
|
+
} */
|
|
1247
|
+
updateEmailsRequest?: UpdateAccountEmailRequestDto | undefined;
|
|
1248
|
+
}
|
|
1249
|
+
export interface CreateAccountBaseRequestDto {
|
|
1250
|
+
/** The account name */
|
|
1251
|
+
name?: string | undefined;
|
|
1252
|
+
/** Whether this account should be public or not */
|
|
1253
|
+
isPublic?: boolean;
|
|
1254
|
+
/** The status of this account (e.g. Lead, Prospect, Customer...) */
|
|
1255
|
+
stateId?: string | undefined;
|
|
1256
|
+
/** The VAT number associated with this account */
|
|
1257
|
+
vatNumber?: string | undefined;
|
|
1258
|
+
webSite?: string | undefined;
|
|
1259
|
+
employeeNumber?: string | undefined;
|
|
1260
|
+
annualRevenue?: string | undefined;
|
|
1261
|
+
}
|
|
1262
|
+
/** { "Name":"", "IsPublic": true, "StateId": "CrmState_X", Addresses: [ { "Id": "", // null = new "AddressLine" : "Via Martiri della libertà", "AddressLine2" : "C/O Proximo S.R.L.", "City": "Castelfidardo", "Municipality": "Castelfidardo", "ZIPCode": "60022", "County" : "Marche", "State" : "Italia", // IT or italy or italia or State_X "POBox": "" } ], "Phones":[ { "Id": "", // null = new "PhoneNumber": "", "Type": "Phone" //Phone, Mobile, Fax } ], "Emails":[ { "Id" : "", //null = new "Email" : "info@prxm.it", "Name" : "Info Prxm", "Note": "", "Type": "" //Email, PersonalEMail, etc... } ], "Socials":[ { "Id": "", // null = new "Type": "LinkedIn", //social type (Facebook, Twitter, Skype, Instagram, LinkedIn, Google+) or CrmSocialType_X "Value": "Proximo SRL", "Note":"" } ], "VATNumber": "", "CommercialAreaIds":["CrmCommercialArea_X", "Meccanica"] } */
|
|
1263
|
+
export interface CreateAccountRequestDto extends CreateAccountBaseRequestDto {
|
|
1264
|
+
/** The account addresses to add, delete or edit */
|
|
1265
|
+
addresses?: PublicAddressDto[] | undefined;
|
|
1266
|
+
/** The account phone numbers to add, delete or edit */
|
|
1267
|
+
phones?: PublicPhoneNumberDto[] | undefined;
|
|
1268
|
+
/** The account emails to add, delete or edit */
|
|
1269
|
+
emails?: PublicEmailDto[] | undefined;
|
|
1270
|
+
/** The account social networks to add, delete or edit */
|
|
1271
|
+
socials?: PublicSocialDto[] | undefined;
|
|
1272
|
+
commercialAreaIds?: string[] | undefined;
|
|
1273
|
+
divisions?: string[] | undefined;
|
|
1274
|
+
}
|
|
1275
|
+
/** A street address related to a CRM entity */
|
|
1276
|
+
export interface PublicAddressDto {
|
|
1277
|
+
/** If null, Address will be added */
|
|
1278
|
+
id?: string | undefined;
|
|
1279
|
+
/** Address line */
|
|
1280
|
+
addressLine?: string | undefined;
|
|
1281
|
+
/** C/O */
|
|
1282
|
+
addressLine2?: string | undefined;
|
|
1283
|
+
/** Civic number */
|
|
1284
|
+
number?: string | undefined;
|
|
1285
|
+
city?: string | undefined;
|
|
1286
|
+
municipality?: string | undefined;
|
|
1287
|
+
zipCode?: string | undefined;
|
|
1288
|
+
county?: string | undefined;
|
|
1289
|
+
/** Post office box */
|
|
1290
|
+
poBox?: string | undefined;
|
|
1291
|
+
/** Address State
|
|
1292
|
+
can be state abbreviation (ISO 3166-1 alpha-2) or full name or id
|
|
1293
|
+
Es: IT or italy or italia or State_X */
|
|
1294
|
+
state?: string | undefined;
|
|
1295
|
+
/** Address type (e.g. CrmAddressType_1) */
|
|
1296
|
+
addressType?: string | undefined;
|
|
1297
|
+
/** Various notes */
|
|
1298
|
+
note?: string | undefined;
|
|
1299
|
+
}
|
|
1300
|
+
/** A phone number */
|
|
1301
|
+
export interface PublicPhoneNumberDto {
|
|
1302
|
+
/** The id of this phone number, if null a new one is created. */
|
|
1303
|
+
id?: string | undefined;
|
|
1304
|
+
/** The phone number. */
|
|
1305
|
+
phoneNumber?: string | undefined;
|
|
1306
|
+
/** Various notes */
|
|
1307
|
+
note?: string | undefined;
|
|
1308
|
+
/** Phone, Mobile, Fax */
|
|
1309
|
+
type?: string | undefined;
|
|
1310
|
+
}
|
|
1311
|
+
/** An email address */
|
|
1312
|
+
export interface PublicEmailDto {
|
|
1313
|
+
/** If NULL create a new E-Mail */
|
|
1314
|
+
id?: string | undefined;
|
|
1315
|
+
/** The actual email address */
|
|
1316
|
+
email?: string | undefined;
|
|
1317
|
+
/** Not used in the Jarvis UI, the name of the email */
|
|
1318
|
+
name?: string | undefined;
|
|
1319
|
+
/** Various notes */
|
|
1320
|
+
note?: string | undefined;
|
|
1321
|
+
/** The type of email, like Email, PersonalEmail, etc...
|
|
1322
|
+
e.g. CrmMailType_1 */
|
|
1323
|
+
type?: string | undefined;
|
|
1324
|
+
}
|
|
1325
|
+
/** A social, like Twitter or Facebook */
|
|
1326
|
+
export interface PublicSocialDto {
|
|
1327
|
+
/** The id of this social, if null create a new. If present, edit or remove. */
|
|
1328
|
+
id?: string | undefined;
|
|
1329
|
+
/** The social type name (Facebook, Twitter, Skype, Instagram, LinkedIn, Google+)
|
|
1330
|
+
or its id, e.g. CrmSocialType_1 */
|
|
1331
|
+
type?: string | undefined;
|
|
1332
|
+
/** The link or username to the social network in question */
|
|
1333
|
+
value?: string | undefined;
|
|
1334
|
+
/** Various notes */
|
|
1335
|
+
note?: string | undefined;
|
|
1336
|
+
}
|
|
1337
|
+
/** "UpdateValues": [ { "FormFieldId": "", "Values":[ {} // object or value ] } ] */
|
|
1338
|
+
export interface PublicFormDataValuesUpdateRequest {
|
|
1339
|
+
updateValues?: PublicFormDataValueUpdateDto[] | undefined;
|
|
1340
|
+
}
|
|
1341
|
+
/** { "FormFieldId": "", "Values":[ {} // object or value ] } */
|
|
1342
|
+
export interface PublicFormDataValueUpdateDto {
|
|
1343
|
+
/** Can use JarvisFormField_Y */
|
|
1344
|
+
formFieldId?: string | undefined;
|
|
1345
|
+
/** Value (can be an Array) */
|
|
1346
|
+
values?: any[] | undefined;
|
|
1347
|
+
}
|
|
1348
|
+
export interface AddAccountAddressesRequestDto {
|
|
1349
|
+
addresses?: PublicAddressDto[] | undefined;
|
|
1350
|
+
}
|
|
1351
|
+
/** "Phones": [ { "PhoneNumber": "", "Type": "Phone" //Phone, Mobile, Fax } ] */
|
|
1352
|
+
export interface AddAccountPhoneNumbersRequestDto {
|
|
1353
|
+
phones?: PublicPhoneNumberDto[] | undefined;
|
|
1354
|
+
}
|
|
1355
|
+
/** "Phones": [ { "Id": "CrmPhoneNumber_X", // CANNOT BE NULL "PhoneNumber": "", "Type": "Phone" //Phone, Mobile, Fax } ] */
|
|
1356
|
+
export interface UpdateAccountPhoneNumbersRequestDto {
|
|
1357
|
+
phones?: PublicPhoneNumberDto[] | undefined;
|
|
1358
|
+
}
|
|
1359
|
+
/** "Emails":[ { "Email" : "info@prxm.it", "Name" : "Info Prxm", "Note": "", "Type": "" //Email, PersonalEMail, etc... } ] */
|
|
1360
|
+
export interface AddAccountEmailRequestDto {
|
|
1361
|
+
emails?: PublicEmailDto[] | undefined;
|
|
1362
|
+
}
|
|
1363
|
+
/** "Emails":[ { "Id" : "CrmEmailAddress_1", CANNOT BE NULL "Email" : "info@prxm.it", "Name" : "Info Prxm", "Note": "", "Type": "" //Email, PersonalEMail, etc... } ] */
|
|
1364
|
+
export interface UpdateAccountEmailRequestDto {
|
|
1365
|
+
emails?: PublicEmailDto[] | undefined;
|
|
1366
|
+
}
|
|
1367
|
+
/** { "Name": "", "AccountStateId": "CrmAccountState_X" } */
|
|
1368
|
+
export interface UpdateAccountNameRequestDto {
|
|
1369
|
+
name?: string | undefined;
|
|
1370
|
+
accountStateId?: string | undefined;
|
|
1371
|
+
}
|
|
1372
|
+
/** { WebSite: "" } */
|
|
1373
|
+
export interface UpdateAccountWebSiteRequestDto {
|
|
1374
|
+
webSite?: string | undefined;
|
|
1375
|
+
}
|
|
1376
|
+
export interface UpdateAccountVATNumberRequestDto {
|
|
1377
|
+
vatNumber?: string | undefined;
|
|
1378
|
+
}
|
|
1379
|
+
export interface UpdateAccountEmployeeNumberRequestDto {
|
|
1380
|
+
employeeNumber?: string | undefined;
|
|
1381
|
+
}
|
|
1382
|
+
export interface SetAnnualRevenueRequestDto {
|
|
1383
|
+
annualRevenue?: string | undefined;
|
|
1384
|
+
}
|
|
1385
|
+
export interface SetAccountArchivedRequestDto {
|
|
1386
|
+
archived?: boolean;
|
|
1387
|
+
archiviationToken?: string | undefined;
|
|
1388
|
+
}
|
|
1389
|
+
export interface UpdateAccountAddressesRequestDto {
|
|
1390
|
+
addresses?: PublicAddressDto[] | undefined;
|
|
1391
|
+
}
|
|
1392
|
+
export interface RemoveAccountAddressesRequestDto {
|
|
1393
|
+
addressIds?: string[] | undefined;
|
|
1394
|
+
}
|
|
1395
|
+
/** "PhoneIds": ["CrmPhoneNumber_1", "CrmPhoneNumber_2"] */
|
|
1396
|
+
export interface RemoveAccountPhoneNumbersRequestDto {
|
|
1397
|
+
phoneIds?: string[] | undefined;
|
|
1398
|
+
}
|
|
1399
|
+
/** "EmailIds": ["CrmEmailAddress_1"] */
|
|
1400
|
+
export interface RemoveAccountEmailRequestDto {
|
|
1401
|
+
emailIds?: string[] | undefined;
|
|
1402
|
+
}
|
|
1403
|
+
/** "Socials": [ { "Type": "LinkedIn", //social type (Facebook, Twitter, Skype, Instagram, LinkedIn, Google+) or CrmSocialType_X "Value": "Proximo SRL", "Note":"" } ] */
|
|
1404
|
+
export interface AddAccountSocialRequestDto {
|
|
1405
|
+
socials?: PublicSocialDto[] | undefined;
|
|
1406
|
+
}
|
|
1407
|
+
/** "SocialIds": ["CrmSocial_X"] */
|
|
1408
|
+
export interface RemoveAccountSocialRequestDto {
|
|
1409
|
+
socialIds?: string[] | undefined;
|
|
1410
|
+
}
|
|
1411
|
+
/** "Socials": [ { "Id": "CrmSocial_X", //CANNOT BE NULL "Type": "LinkedIn", //social type (Facebook, Twitter, Skype, Instagram, LinkedIn, Google+) or CrmSocialType_X "Value": "Proximo SRL", "Note":"" } ] */
|
|
1412
|
+
export interface UpdateAccountSocialRequestDto {
|
|
1413
|
+
socials?: PublicSocialDto[] | undefined;
|
|
1414
|
+
}
|
|
1415
|
+
/** "Divisions": ["Division_1"] */
|
|
1416
|
+
export interface AccountDivisionRequestDto {
|
|
1417
|
+
divisions?: string[] | undefined;
|
|
1418
|
+
}
|
|
1419
|
+
export interface AccountExternalIdUpdateRequestDto {
|
|
1420
|
+
externalId?: string | undefined;
|
|
1421
|
+
}
|
|
1422
|
+
/** API Response Object. */
|
|
1423
|
+
export interface ResponseOfAccountDetailResponse extends JarvisResponse {
|
|
1424
|
+
/** The actual result of the operation. */
|
|
1425
|
+
data?: AccountDetailResponse | undefined;
|
|
1426
|
+
}
|
|
1427
|
+
/** { "id": "Account_1", "name": "Testing account", "teamId": "Team_1", "vatNumber": "", "externalId": "", "employeeNumber": "51-200", "webSite": "www.test.com", "state": null, "creationDate": "2022-11-29T15:35:50.454Z", "divisions": [ "Division_4", "Division_5" ], "archived": false, "categoryIds": [ "Agente", "Rivenditore" ], "commercialAreaIds": [], "annualRevenue": "100.000.001-400.000.000", "formData": [], "addresses": [ { "id": "CrmAddress_1", "addressLine": "Via Roma", "addressLine2": "", "number": "", "city": "Roma", "municipality": "", "zipCode": "60100", "county": "", "poBox": "", "state": "State_1", "addressType": "CrmAddressType_1" } ], "phoneNumbers": [ { "id": "CrmPhoneNumber_1", "phoneNumber": "XXXXXXX", "type": "CrmPhoneType_1" } ], "emails": [ { "id": "CrmEmailAddress_1", "email": "info@test.it", "name": null, "note": null, "type": "CrmMailType_1" } ], "socials": [ { "id": "CrmSocial_1", "type": "CrmSocialType_1", "value": "Test", "note": null } ], "notes": [] } */
|
|
1428
|
+
export interface AccountDetailResponse {
|
|
1429
|
+
id?: string | undefined;
|
|
1430
|
+
name?: string | undefined;
|
|
1431
|
+
teamId?: string | undefined;
|
|
1432
|
+
vatNumber?: string | undefined;
|
|
1433
|
+
externalId?: string | undefined;
|
|
1434
|
+
/** EmployeeNumber Value */
|
|
1435
|
+
employeeNumber?: string | undefined;
|
|
1436
|
+
webSite?: string | undefined;
|
|
1437
|
+
state?: string | undefined;
|
|
1438
|
+
creationDate?: Date;
|
|
1439
|
+
divisions?: string[] | undefined;
|
|
1440
|
+
archived?: boolean;
|
|
1441
|
+
/** Denormalized Account category */
|
|
1442
|
+
categoryIds?: string[] | undefined;
|
|
1443
|
+
commercialAreaIds?: string[] | undefined;
|
|
1444
|
+
/** Denormalized value */
|
|
1445
|
+
annualRevenue?: string | undefined;
|
|
1446
|
+
formData?: PublicFormDataAssociatorDto[] | undefined;
|
|
1447
|
+
addresses?: PublicAddressDto[] | undefined;
|
|
1448
|
+
phoneNumbers?: PublicPhoneNumberDto[] | undefined;
|
|
1449
|
+
emails?: PublicEmailDto[] | undefined;
|
|
1450
|
+
socials?: PublicSocialDto[] | undefined;
|
|
1451
|
+
notes?: NoteDetailPublicDto[] | undefined;
|
|
1452
|
+
}
|
|
1453
|
+
export interface PublicFormDataAssociatorDto {
|
|
1454
|
+
name?: string | undefined;
|
|
1455
|
+
formDataDefinitionId?: string | undefined;
|
|
1456
|
+
owner?: string | undefined;
|
|
1457
|
+
values?: PublicFormDataValueDto[] | undefined;
|
|
1458
|
+
localizedNames?: {
|
|
1459
|
+
[key: string]: string;
|
|
1460
|
+
} | undefined;
|
|
1461
|
+
localizedDescriptions?: {
|
|
1462
|
+
[key: string]: string;
|
|
1463
|
+
} | undefined;
|
|
1464
|
+
}
|
|
1465
|
+
export interface PublicFormDataValueDto {
|
|
1466
|
+
formFieldId?: string | undefined;
|
|
1467
|
+
name?: string | undefined;
|
|
1468
|
+
values?: any[] | undefined;
|
|
1469
|
+
}
|
|
1470
|
+
export interface NoteDetailPublicDto {
|
|
1471
|
+
id?: string | undefined;
|
|
1472
|
+
note?: string | undefined;
|
|
1473
|
+
createdBy?: string | undefined;
|
|
1474
|
+
createdAt?: Date;
|
|
1475
|
+
editedBy?: string | undefined;
|
|
1476
|
+
lastUpdate?: Date;
|
|
1477
|
+
}
|
|
1478
|
+
/** Request information about an account. Optionally it can return the account at a specific version or point in time. */
|
|
1479
|
+
export interface AccountDetailRequest {
|
|
1480
|
+
/** The account id */
|
|
1481
|
+
accountId?: string | undefined;
|
|
1482
|
+
/** The specific point in time or version you want the account at.
|
|
1483
|
+
If null, return the current state. */
|
|
1484
|
+
historicalVersionInfo?: HistoricalVersionInfoDto | undefined;
|
|
1485
|
+
}
|
|
1486
|
+
export interface UpsertContactRequestDto {
|
|
1487
|
+
/** If null CREATE a new contact */
|
|
1488
|
+
contactId?: string | undefined;
|
|
1489
|
+
/** PropertyValues to create contact */
|
|
1490
|
+
contactCreationDataRequest?: ContactCreationDataRequest | undefined;
|
|
1491
|
+
/** Update contact data */
|
|
1492
|
+
updateContactInfoRequest?: ContactUpdateDataRequest | undefined;
|
|
1493
|
+
/** Set or update external code only */
|
|
1494
|
+
updateContactExternalCodeRequest?: ContactExternalCodeUpdateRequest | undefined;
|
|
1495
|
+
/** Set all categories of a contact */
|
|
1496
|
+
contactCategoryUpdate?: UpdateContactCategoryRequest | undefined;
|
|
1497
|
+
/** List of address to add */
|
|
1498
|
+
addAddresses?: ContactAddAddressesRequest | undefined;
|
|
1499
|
+
/** List of address to remove */
|
|
1500
|
+
removeAddresses?: ContactRemoveAddressesRequest | undefined;
|
|
1501
|
+
/** List of address to update */
|
|
1502
|
+
updateAddresses?: ContactUpdateAddressesRequest | undefined;
|
|
1503
|
+
/** List of e-mail address to add */
|
|
1504
|
+
addEmails?: ContactAddEmailsRequest | undefined;
|
|
1505
|
+
/** List of e-mail address to remove */
|
|
1506
|
+
removeEmails?: ContactRemoveEmailsRequest | undefined;
|
|
1507
|
+
/** List of e-mail address to update */
|
|
1508
|
+
updateEmails?: ContactUpdateEmailsRequest | undefined;
|
|
1509
|
+
/** List of phone numbers to add */
|
|
1510
|
+
addPhoneNumbers?: ContactAddPhoneNumbersRequest | undefined;
|
|
1511
|
+
/** List of phone numbers to remove */
|
|
1512
|
+
removePhoneNumbers?: ContactRemovePhoneNumbersRequest | undefined;
|
|
1513
|
+
/** List of phone numbers to update */
|
|
1514
|
+
updatePhoneNumbers?: ContactUpdatePhoneNumbersRequest | undefined;
|
|
1515
|
+
/** Update value properties */
|
|
1516
|
+
updateProperties?: PublicFormDataValuesUpdateRequest | undefined;
|
|
1517
|
+
archive?: ContactArchiveRequest | undefined;
|
|
1518
|
+
addAccountRelationships?: ContactAddAccountRelationshipsRequest | undefined;
|
|
1519
|
+
updateAccountRelationships?: ContactUpdateAccountRelationshipsRequest | undefined;
|
|
1520
|
+
removeAccountRelationships?: ContactRemoveAccountRelationshipRequest | undefined;
|
|
1521
|
+
updateState?: ContactUpdateStateRequest | undefined;
|
|
1522
|
+
}
|
|
1523
|
+
export interface ContactBaseDataInfoRequest {
|
|
1524
|
+
firstName?: string | undefined;
|
|
1525
|
+
lastName?: string | undefined;
|
|
1526
|
+
middleName?: string | undefined;
|
|
1527
|
+
/** Mr., Mrs. or ContactTitle_X */
|
|
1528
|
+
title?: string | undefined;
|
|
1529
|
+
}
|
|
1530
|
+
export interface ContactCreationDataRequest extends ContactBaseDataInfoRequest {
|
|
1531
|
+
/** if not null and only on contact creation, will be set as creation date of contact
|
|
1532
|
+
(to manage old data and keep real creation time) */
|
|
1533
|
+
creationData?: Date | undefined;
|
|
1534
|
+
}
|
|
1535
|
+
export interface ContactUpdateDataRequest extends ContactBaseDataInfoRequest {
|
|
1536
|
+
externalCode?: string | undefined;
|
|
1537
|
+
externalCodeSource?: string | undefined;
|
|
1538
|
+
}
|
|
1539
|
+
export interface ContactExternalCodeUpdateRequest {
|
|
1540
|
+
/** external key (should be unique) */
|
|
1541
|
+
externalCode?: string | undefined;
|
|
1542
|
+
/** Source name */
|
|
1543
|
+
externalCodeSource?: string | undefined;
|
|
1544
|
+
}
|
|
1545
|
+
export interface UpdateContactCategoryRequest {
|
|
1546
|
+
/** can contains CategoryId or name
|
|
1547
|
+
Es: Agent OR ContactCategory_1 */
|
|
1548
|
+
categories?: string[] | undefined;
|
|
1549
|
+
}
|
|
1550
|
+
export interface ContactAddAddressesRequest {
|
|
1551
|
+
addresses?: PublicAddressDto[] | undefined;
|
|
1552
|
+
}
|
|
1553
|
+
export interface ContactRemoveAddressesRequest {
|
|
1554
|
+
/** List of address Ids to remove */
|
|
1555
|
+
addressIds?: string[] | undefined;
|
|
1556
|
+
}
|
|
1557
|
+
export interface ContactUpdateAddressesRequest {
|
|
1558
|
+
addresses?: PublicAddressDto[] | undefined;
|
|
1559
|
+
}
|
|
1560
|
+
export interface ContactAddEmailsRequest {
|
|
1561
|
+
emails?: PublicEmailDto[] | undefined;
|
|
1562
|
+
}
|
|
1563
|
+
export interface ContactRemoveEmailsRequest {
|
|
1564
|
+
emailIds?: string[] | undefined;
|
|
1565
|
+
}
|
|
1566
|
+
export interface ContactUpdateEmailsRequest {
|
|
1567
|
+
emails?: PublicEmailDto[] | undefined;
|
|
1568
|
+
}
|
|
1569
|
+
export interface ContactAddPhoneNumbersRequest {
|
|
1570
|
+
phoneNumbers?: PublicPhoneNumberDto[] | undefined;
|
|
1571
|
+
}
|
|
1572
|
+
export interface ContactRemovePhoneNumbersRequest {
|
|
1573
|
+
phoneNumberIds?: string[] | undefined;
|
|
1574
|
+
}
|
|
1575
|
+
export interface ContactUpdatePhoneNumbersRequest {
|
|
1576
|
+
phoneNumbers?: PublicPhoneNumberDto[] | undefined;
|
|
1577
|
+
}
|
|
1578
|
+
export interface ContactArchiveRequest {
|
|
1579
|
+
/** if TRUE archive contact ELSE unarchive it */
|
|
1580
|
+
archive?: boolean;
|
|
1581
|
+
/** Mandatory to unarchive contact */
|
|
1582
|
+
archiviationToken?: string | undefined;
|
|
1583
|
+
}
|
|
1584
|
+
export interface ContactAddAccountRelationshipsRequest {
|
|
1585
|
+
relationships?: ContactAccountRelationDto[] | undefined;
|
|
1586
|
+
}
|
|
1587
|
+
export interface ContactAccountRelationDto {
|
|
1588
|
+
id?: string | undefined;
|
|
1589
|
+
/** Can be an AccountId or a CompanyName if is a new AccountRelation */
|
|
1590
|
+
accountId?: string | undefined;
|
|
1591
|
+
role?: string | undefined;
|
|
1592
|
+
validFrom?: Date | undefined;
|
|
1593
|
+
validTo?: Date | undefined;
|
|
1594
|
+
}
|
|
1595
|
+
export interface ContactUpdateAccountRelationshipsRequest {
|
|
1596
|
+
relationships?: ContactAccountRelationDto[] | undefined;
|
|
1597
|
+
}
|
|
1598
|
+
export interface ContactRemoveAccountRelationshipRequest {
|
|
1599
|
+
relationships?: ContactAccountRelationRequestDto[] | undefined;
|
|
1600
|
+
}
|
|
1601
|
+
export interface ContactAccountRelationRequestDto extends ContactAccountRelationDto {
|
|
1602
|
+
/** Reason to remove relation (optional) */
|
|
1603
|
+
reason?: string | undefined;
|
|
1604
|
+
}
|
|
1605
|
+
/** "State": "CrmAccountState_X" or "StateName" */
|
|
1606
|
+
export interface ContactUpdateStateRequest {
|
|
1607
|
+
/** Crm state id or name */
|
|
1608
|
+
state?: string | undefined;
|
|
1609
|
+
}
|
|
1610
|
+
export interface ContactDetailBaseDto {
|
|
1611
|
+
/** The id of the contact */
|
|
1612
|
+
id?: string | undefined;
|
|
1613
|
+
/** The contact first name */
|
|
1614
|
+
firstName?: string | undefined;
|
|
1615
|
+
/** The contact last name */
|
|
1616
|
+
lastName?: string | undefined;
|
|
1617
|
+
/** The contact full name (first name + last name) */
|
|
1618
|
+
fullName?: string | undefined;
|
|
1619
|
+
/** The id of the contact state (e.g. CrmAccountState_1) */
|
|
1620
|
+
stateId?: string | undefined;
|
|
1621
|
+
/** The id of the contact team (e.g. Team_19) */
|
|
1622
|
+
teamId?: string | undefined;
|
|
1623
|
+
/** If the contact has been deleted */
|
|
1624
|
+
archived?: boolean;
|
|
1625
|
+
addresses?: PublicAddressDto[] | undefined;
|
|
1626
|
+
phoneNumbers?: PublicPhoneNumberDto[] | undefined;
|
|
1627
|
+
socials?: PublicSocialDto[] | undefined;
|
|
1628
|
+
emails?: PublicEmailDto[] | undefined;
|
|
1629
|
+
/** The id in an external system associated with this contact */
|
|
1630
|
+
externalId?: string | undefined;
|
|
1631
|
+
/** The external id type */
|
|
1632
|
+
externalIdType?: string | undefined;
|
|
1633
|
+
/** The user that created this contact */
|
|
1634
|
+
createdBy?: string | undefined;
|
|
1635
|
+
/** When the contact was created */
|
|
1636
|
+
creationDate?: Date;
|
|
1637
|
+
/** The contact tile, e.g. ContactTitle_1 */
|
|
1638
|
+
titleId?: string | undefined;
|
|
1639
|
+
/** The categories the contact belong to, e.g. [ "ContactCategory_1" ] */
|
|
1640
|
+
categoryIds?: string[] | undefined;
|
|
1641
|
+
/** Various notes assocaited with this contact */
|
|
1642
|
+
notes?: NoteDetailPublicDto[] | undefined;
|
|
1643
|
+
/** Relationships with other CRM entitities */
|
|
1644
|
+
accountsRelationships?: ContactAccountRelationDto[] | undefined;
|
|
1645
|
+
}
|
|
1646
|
+
export interface ContactDetailDto extends ContactDetailBaseDto {
|
|
1647
|
+
/** The properties associated with this contact
|
|
1648
|
+
Null if no property is present */
|
|
1649
|
+
properties?: PublicFormDataAssociatorDto | undefined;
|
|
1650
|
+
}
|
|
1651
|
+
/** Request infromation about a contact. Optionally it can return the contact at a specific version or point in time. */
|
|
1652
|
+
export interface ContactDetailRequest {
|
|
1653
|
+
/** The contact id */
|
|
1654
|
+
contactId?: string | undefined;
|
|
1655
|
+
/** The specific point in time or version you want the contact at.
|
|
1656
|
+
If null, return the current state. */
|
|
1657
|
+
historicalVersionInfo?: HistoricalVersionInfoDto | undefined;
|
|
1658
|
+
}
|
|
1659
|
+
/** Request that allows Create or update a ticket. Each property represents an action that can be performed on the ticket. Operation order is from Top to Bottom. */
|
|
1660
|
+
export interface TicketUpsertRequest {
|
|
1661
|
+
/** Ticket Id */
|
|
1662
|
+
id?: string | undefined;
|
|
1663
|
+
creationOptions?: TicketInsertOptionRequest | undefined;
|
|
1664
|
+
subject?: TicketSetSubjectRequest | undefined;
|
|
1665
|
+
content?: TicketSetContentRequest | undefined;
|
|
1666
|
+
recipients?: TicketSetRecipientsRequest | undefined;
|
|
1667
|
+
visibleTo?: TicketSetVisibleToRequest | undefined;
|
|
1668
|
+
addVisibleTo?: TicketAddVisibleToRequest | undefined;
|
|
1669
|
+
removeVisibleTo?: TicketRemoveVisibleToRequest | undefined;
|
|
1670
|
+
tags?: TicketSetTagsToRequest | undefined;
|
|
1671
|
+
addTags?: TicketAddTagsToRequest | undefined;
|
|
1672
|
+
removeTags?: TicketRemoveTagsToRequest | undefined;
|
|
1673
|
+
assign?: TicketAssignRequest | undefined;
|
|
1674
|
+
changeStatus?: TicketChangeStatusRequest | undefined;
|
|
1675
|
+
changeDueDate?: TicketChangeDueDateRequest | undefined;
|
|
1676
|
+
addReplies?: TicketAddReplyRequest[] | undefined;
|
|
1677
|
+
addAttachments?: TicketAddAttachmentsRequest | undefined;
|
|
1678
|
+
removeAttachments?: TicketRemoveAttachmentsRequest | undefined;
|
|
1679
|
+
saveProperties?: PropertiesUpdateValuesRequest | undefined;
|
|
1680
|
+
upsertCauses?: TicketCausesRequest | undefined;
|
|
1681
|
+
removeCauses?: TicketRemoveCausesRequest | undefined;
|
|
1682
|
+
addRelatedTicketsToCauses?: TicketAddRelatedTicketsToCausesRequest | undefined;
|
|
1683
|
+
removeRelatedTicketsToCauses?: TicketRemoveRelatedTicketsToCausesRequest | undefined;
|
|
1684
|
+
archive?: TicketArchiveRequest | undefined;
|
|
1685
|
+
unarchive?: TicketUnarchiveRequest | undefined;
|
|
1686
|
+
changeModelRequest?: TicketChangeModelRequest | undefined;
|
|
1687
|
+
}
|
|
1688
|
+
/** Contains the information that can be set only in the creation phase. Other required data (like ticket's subject) is managed with specific request in order to reuse that request both in insert or update */
|
|
1689
|
+
export interface TicketInsertOptionRequest {
|
|
1690
|
+
ticketModelId?: string | undefined;
|
|
1691
|
+
parentId?: string | undefined;
|
|
1692
|
+
/** Valid only if ParentId is not null/empty */
|
|
1693
|
+
syncVisibilityWithParent?: boolean;
|
|
1694
|
+
/** The ticket will be created, but not confirmed */
|
|
1695
|
+
createAsDraft?: boolean;
|
|
1696
|
+
}
|
|
1697
|
+
export interface TicketSetSubjectRequest {
|
|
1698
|
+
subject?: string | undefined;
|
|
1699
|
+
}
|
|
1700
|
+
export interface TicketSetContentRequest {
|
|
1701
|
+
content?: string | undefined;
|
|
1702
|
+
}
|
|
1703
|
+
/** TODO: per ora ho fatto il set per semplciità occorre avere sempre almeno un recipient, ma deve essere controllato nelle API (non c'è a dominio) */
|
|
1704
|
+
export interface TicketSetRecipientsRequest {
|
|
1705
|
+
recipients?: string[] | undefined;
|
|
1706
|
+
}
|
|
1707
|
+
export interface TicketSetVisibleToRequest {
|
|
1708
|
+
visibleTo?: string[] | undefined;
|
|
1709
|
+
}
|
|
1710
|
+
export interface TicketAddVisibleToRequest {
|
|
1711
|
+
visibleTo?: string[] | undefined;
|
|
1712
|
+
}
|
|
1713
|
+
export interface TicketRemoveVisibleToRequest {
|
|
1714
|
+
visibleTo?: string[] | undefined;
|
|
1715
|
+
}
|
|
1716
|
+
export interface TicketSetTagsToRequest {
|
|
1717
|
+
tags?: string[] | undefined;
|
|
1718
|
+
}
|
|
1719
|
+
export interface TicketAddTagsToRequest {
|
|
1720
|
+
tags?: string[] | undefined;
|
|
1721
|
+
}
|
|
1722
|
+
export interface TicketRemoveTagsToRequest {
|
|
1723
|
+
tags?: string[] | undefined;
|
|
1724
|
+
}
|
|
1725
|
+
export interface TicketAssignRequest {
|
|
1726
|
+
assignedTo?: string | undefined;
|
|
1727
|
+
}
|
|
1728
|
+
export interface TicketChangeStatusRequest {
|
|
1729
|
+
statusIdOrLabel?: string | undefined;
|
|
1730
|
+
/** Used only for closing status */
|
|
1731
|
+
closingDate?: DateWithoutTime | undefined;
|
|
1732
|
+
}
|
|
1733
|
+
/** Convenient struct when you need a business value expressed only with date part and not time, and you are NOT INTERESTED IN TIMEZONE OR OTHER TIME RELATED ISSUE */
|
|
1734
|
+
export interface DateWithoutTime {
|
|
1735
|
+
year?: number;
|
|
1736
|
+
day?: number;
|
|
1737
|
+
month?: number;
|
|
1738
|
+
/** Iso date in format YYYYMMDD, any other format is not allowed */
|
|
1739
|
+
serializedFormat?: string | undefined;
|
|
1740
|
+
}
|
|
1741
|
+
export interface TicketChangeDueDateRequest {
|
|
1742
|
+
dueDate?: Date | undefined;
|
|
1743
|
+
}
|
|
1744
|
+
export interface TicketAddReplyRequest {
|
|
1745
|
+
replyContent?: string | undefined;
|
|
1746
|
+
relatedReplyId?: string | undefined;
|
|
1747
|
+
activity?: string | undefined;
|
|
1748
|
+
/** Time span in format "hh:mm:ss" (eg "08:30:00" for 8 hours and 30 minutes) */
|
|
1749
|
+
elapsedTime?: string;
|
|
1750
|
+
/** Request to set new reply attachments */
|
|
1751
|
+
addAttachments?: TicketAddAttachmentsRequest | undefined;
|
|
1752
|
+
/** Request to remove reply attachments */
|
|
1753
|
+
removeAttachments?: TicketRemoveAttachmentsRequest | undefined;
|
|
1754
|
+
}
|
|
1755
|
+
export interface TicketAddAttachmentsRequest {
|
|
1756
|
+
/** List of attachements to add */
|
|
1757
|
+
attachments?: AddAttachmentRequest[] | undefined;
|
|
1758
|
+
}
|
|
1759
|
+
export interface AddAttachmentRequest {
|
|
1760
|
+
/** File Id, previously returned by an upload operation */
|
|
1761
|
+
fileId?: string | undefined;
|
|
1762
|
+
/** Attachment file name */
|
|
1763
|
+
fileName?: string | undefined;
|
|
1764
|
+
}
|
|
1765
|
+
export interface TicketRemoveAttachmentsRequest {
|
|
1766
|
+
attachmentIds?: string[] | undefined;
|
|
1767
|
+
}
|
|
1768
|
+
export interface PropertiesUpdateValuesRequest {
|
|
1769
|
+
/** Array of objects with Definition id or name of the property and relative values to set */
|
|
1770
|
+
data?: PropertyObjectValueData[] | undefined;
|
|
1771
|
+
}
|
|
1772
|
+
export interface PropertyObjectValueData {
|
|
1773
|
+
/** Definition id or Name of the property on any language */
|
|
1774
|
+
definitionIdOrName?: string | undefined;
|
|
1775
|
+
values?: any[] | undefined;
|
|
1776
|
+
}
|
|
1777
|
+
export interface TicketCausesRequest {
|
|
1778
|
+
causes?: TicketCauseRequest[] | undefined;
|
|
1779
|
+
}
|
|
1780
|
+
export interface TicketCauseRequest {
|
|
1781
|
+
/** if null, cause will be added */
|
|
1782
|
+
causeId?: string | undefined;
|
|
1783
|
+
causeEntryId?: string | undefined;
|
|
1784
|
+
causeDescrition?: string | undefined;
|
|
1785
|
+
}
|
|
1786
|
+
export interface TicketRemoveCausesRequest {
|
|
1787
|
+
causeIds?: string[] | undefined;
|
|
1788
|
+
}
|
|
1789
|
+
export interface TicketAddRelatedTicketsToCausesRequest {
|
|
1790
|
+
ticketsOfCause?: TicketRelatedTicketsToCausesRequest[] | undefined;
|
|
1791
|
+
}
|
|
1792
|
+
export interface TicketRelatedTicketsToCausesRequest {
|
|
1793
|
+
causeId?: string | undefined;
|
|
1794
|
+
ticketIds?: string[] | undefined;
|
|
1795
|
+
}
|
|
1796
|
+
export interface TicketRemoveRelatedTicketsToCausesRequest {
|
|
1797
|
+
ticketsOfCause?: TicketRelatedTicketsToCausesRequest[] | undefined;
|
|
1798
|
+
}
|
|
1799
|
+
export interface TicketArchiveRequest {
|
|
1800
|
+
}
|
|
1801
|
+
export interface TicketUnarchiveRequest {
|
|
1802
|
+
}
|
|
1803
|
+
export interface TicketChangeModelRequest {
|
|
1804
|
+
/** New model Id to apply */
|
|
1805
|
+
modelId?: string | undefined;
|
|
1806
|
+
/** Reset recipients to match the new model */
|
|
1807
|
+
resetRecipients?: boolean;
|
|
1808
|
+
/** Reset status to new model default status */
|
|
1809
|
+
resetStatus?: boolean;
|
|
1810
|
+
/** Remove assignee from ticket */
|
|
1811
|
+
resetAssignedTo?: boolean;
|
|
1812
|
+
/** Reset tags to match the new model Tags */
|
|
1813
|
+
resetTags?: boolean;
|
|
1814
|
+
/** Reset due date */
|
|
1815
|
+
resetDueDate?: boolean;
|
|
1816
|
+
}
|
|
1817
|
+
/** API Response Object. */
|
|
1818
|
+
export interface ResponseOfPureJsonOmniSearchResultDto extends JarvisResponse {
|
|
1819
|
+
/** The actual result of the operation. */
|
|
1820
|
+
data?: PureJsonOmniSearchResultDto | undefined;
|
|
1821
|
+
}
|
|
1822
|
+
export interface PureJsonOmniSearchResultDto {
|
|
1823
|
+
total?: number;
|
|
1824
|
+
items?: any[] | undefined;
|
|
1825
|
+
}
|
|
1826
|
+
export interface OmniSearchQueryRequest {
|
|
1827
|
+
filters?: FieldFilters[] | undefined;
|
|
1828
|
+
/** if null will not sort */
|
|
1829
|
+
sort?: OmniSearchSortingRequest | undefined;
|
|
1830
|
+
chunkSize?: number;
|
|
1831
|
+
startIndex?: number;
|
|
1832
|
+
showArchived?: boolean;
|
|
1833
|
+
text?: string | undefined;
|
|
1834
|
+
includeAllTerms?: boolean | undefined;
|
|
1835
|
+
}
|
|
1836
|
+
export interface TicketSearchRequest extends OmniSearchQueryRequest {
|
|
1837
|
+
/** Ticket Search type.
|
|
1838
|
+
|
|
1839
|
+
0 - received tickets
|
|
1840
|
+
|
|
1841
|
+
2 - created/sent tickets
|
|
1842
|
+
|
|
1843
|
+
///
|
|
1844
|
+
3 - all confirmed tickets */
|
|
1845
|
+
requestType?: ETicketListRequestType;
|
|
1846
|
+
}
|
|
1847
|
+
export declare enum ETicketListRequestType {
|
|
1848
|
+
Received = 0,
|
|
1849
|
+
Cc = 1,
|
|
1850
|
+
Sent = 2,
|
|
1851
|
+
AllConfirmed = 3
|
|
1852
|
+
}
|
|
1853
|
+
/** Express a filter for a field. */
|
|
1854
|
+
export interface FieldFilters {
|
|
1855
|
+
field?: string | undefined;
|
|
1856
|
+
/** Specify the SearchableDataType of the field
|
|
1857
|
+
|
|
1858
|
+
String = 0, Numeric = 1, DateTime = 2 */
|
|
1859
|
+
dataType?: SearchableDataType;
|
|
1860
|
+
/** it's filled when the "contains" case is chosen by the user */
|
|
1861
|
+
value?: any | undefined;
|
|
1862
|
+
/** it's filled when the "in" case is chosen by the user */
|
|
1863
|
+
values?: any[] | undefined;
|
|
1864
|
+
/** Useful for id or other values where we want to perform an exact
|
|
1865
|
+
search without any elasicsearch analysis.
|
|
1866
|
+
to perform an exact and case sensitive search. */
|
|
1867
|
+
exactSearch?: boolean;
|
|
1868
|
+
/** Valid only if is true, it will trigger an exact search
|
|
1869
|
+
that is also case sensitive. */
|
|
1870
|
+
caseSensitiveSearch?: boolean;
|
|
1871
|
+
}
|
|
1872
|
+
/** Represents type of the field, it is necessary because you will declare the unerdling type so we can automatically translate without the need for the user to specify type */
|
|
1873
|
+
export declare enum SearchableDataType {
|
|
1874
|
+
String = 0,
|
|
1875
|
+
Numeric = 1,
|
|
1876
|
+
DateTime = 2,
|
|
1877
|
+
Boolean = 3,
|
|
1878
|
+
DateWithoutTime = 4
|
|
1879
|
+
}
|
|
1880
|
+
export interface OmniSearchSortingRequest {
|
|
1881
|
+
sortField?: string | undefined;
|
|
1882
|
+
/** Specify the SearchableDataType of the field
|
|
1883
|
+
|
|
1884
|
+
String = 0, Numeric = 1, DateTime = 2 */
|
|
1885
|
+
sortFieldType?: SearchableDataType;
|
|
1886
|
+
sortDescending?: boolean;
|
|
1887
|
+
}
|
|
1888
|
+
export interface TicketContentRequest {
|
|
1889
|
+
/** Ticket Id or Reply Id */
|
|
1890
|
+
id?: string | undefined;
|
|
1891
|
+
/** The attachament id to retrieve (eg. Attachment_65) */
|
|
1892
|
+
attachmentId?: string | undefined;
|
|
1893
|
+
}
|
|
1894
|
+
export interface TicketAttachmentRequest {
|
|
1895
|
+
/** Ticket Id */
|
|
1896
|
+
id?: string | undefined;
|
|
1897
|
+
/** The attachament id to retrieve (eg. ticketattachment_23) */
|
|
1898
|
+
attachmentId?: string | undefined;
|
|
1899
|
+
}
|
|
1900
|
+
/** API Response Object. */
|
|
1901
|
+
export interface ResponseOfTicketDetailPublicDto extends JarvisResponse {
|
|
1902
|
+
/** The actual result of the operation. */
|
|
1903
|
+
data?: TicketDetailPublicDto | undefined;
|
|
1904
|
+
}
|
|
1905
|
+
export interface TicketDetailPublicDto {
|
|
1906
|
+
id?: string | undefined;
|
|
1907
|
+
aggregateCheckpointId?: number;
|
|
1908
|
+
aggregateVersion?: number;
|
|
1909
|
+
lastModifiy?: string | undefined;
|
|
1910
|
+
lastModify?: string | undefined;
|
|
1911
|
+
createdAt?: string | undefined;
|
|
1912
|
+
createdBy?: TicketUserPublicDto | undefined;
|
|
1913
|
+
modelId?: string | undefined;
|
|
1914
|
+
subject?: string | undefined;
|
|
1915
|
+
contentAsAttachmentId?: string | undefined;
|
|
1916
|
+
assignedTo?: TicketUserPublicDto | undefined;
|
|
1917
|
+
recipients?: TicketUserPublicDto[] | undefined;
|
|
1918
|
+
visibilityCC?: TicketUserPublicDto[] | undefined;
|
|
1919
|
+
tags?: string[] | undefined;
|
|
1920
|
+
propertyVersion?: number;
|
|
1921
|
+
attachments?: TicketAttachmentPublicDto[] | undefined;
|
|
1922
|
+
replies?: TicketReplyPublicDto[] | undefined;
|
|
1923
|
+
activities?: string[] | undefined;
|
|
1924
|
+
dueDate?: string | undefined;
|
|
1925
|
+
isClosed?: boolean;
|
|
1926
|
+
closingDate?: string | undefined;
|
|
1927
|
+
archived?: boolean;
|
|
1928
|
+
/** Ticket properties */
|
|
1929
|
+
properties?: {
|
|
1930
|
+
[key: string]: any;
|
|
1931
|
+
} | undefined;
|
|
1932
|
+
statusId?: string | undefined;
|
|
1933
|
+
statusLabel?: string | undefined;
|
|
1934
|
+
}
|
|
1935
|
+
export interface TicketUserPublicDto {
|
|
1936
|
+
id?: string | undefined;
|
|
1937
|
+
name?: string | undefined;
|
|
1938
|
+
}
|
|
1939
|
+
export interface TicketAttachmentPublicDto {
|
|
1940
|
+
id?: string | undefined;
|
|
1941
|
+
name?: string | undefined;
|
|
1942
|
+
}
|
|
1943
|
+
export interface TicketReplyPublicDto {
|
|
1944
|
+
id?: string | undefined;
|
|
1945
|
+
content?: string | undefined;
|
|
1946
|
+
contentAsAttachmentId?: string | undefined;
|
|
1947
|
+
user?: TicketUserPublicDto | undefined;
|
|
1948
|
+
postedAt?: string | undefined;
|
|
1949
|
+
activity?: string | undefined;
|
|
1950
|
+
activityHours?: number;
|
|
1951
|
+
activityMinutes?: number;
|
|
1952
|
+
attachments?: TicketAttachmentPublicDto[] | undefined;
|
|
1953
|
+
}
|
|
1954
|
+
/** Request a ticket id and return it even with historical informations. */
|
|
1955
|
+
export interface GetTicketByIdRequest {
|
|
1956
|
+
/** Optional, the version or point in time you want the ticket at. If null, returns the current state. */
|
|
1957
|
+
historicalVersionInfo?: HistoricalVersionInfoDto | undefined;
|
|
1958
|
+
/** The ticket id. */
|
|
1959
|
+
ticketId?: string | undefined;
|
|
1960
|
+
}
|
|
1961
|
+
/** DTO class used to pass parameter to populate */
|
|
1962
|
+
export interface OmniSearchQueryRequestDto {
|
|
1963
|
+
/** List of filters applied to the search query
|
|
1964
|
+
Only one between this and FilteringExpression must be populated
|
|
1965
|
+
This is somewhat made obsolete because of FilteringExpression that allows
|
|
1966
|
+
for a much more expressive filtering capabilities. */
|
|
1967
|
+
filters?: FieldFiltersDto[] | undefined;
|
|
1968
|
+
/** Nested filtering expression.
|
|
1969
|
+
Only one between this and Filters must be populated */
|
|
1970
|
+
filteringExpression?: FilteringExpressionDto | undefined;
|
|
1971
|
+
/** if null will not sort */
|
|
1972
|
+
sort?: OmniSearchSortingRequestDto | undefined;
|
|
1973
|
+
/** Ordered list of sort conditions. When non-empty this is authoritative and
|
|
1974
|
+
Sort mirrors its first entry. Position determines priority. */
|
|
1975
|
+
sortConditions?: OmniSearchSortingRequestDto[] | undefined;
|
|
1976
|
+
/** The ui can ask for highlights. */
|
|
1977
|
+
highlights?: boolean;
|
|
1978
|
+
/** Page size, for pagination */
|
|
1979
|
+
chunkSize?: number;
|
|
1980
|
+
/** Starting index, for pagination */
|
|
1981
|
+
startIndex?: number;
|
|
1982
|
+
/** Show archived results */
|
|
1983
|
+
showArchived?: boolean;
|
|
1984
|
+
/** Text to filter by */
|
|
1985
|
+
text?: string | undefined;
|
|
1986
|
+
/** Include all terms in the search */
|
|
1987
|
+
includeAllTerms?: boolean | undefined;
|
|
1988
|
+
}
|
|
1989
|
+
/** Dto to search in dataset definition. */
|
|
1990
|
+
export interface DatasetDefinitionSearchRequest extends OmniSearchQueryRequestDto {
|
|
1991
|
+
}
|
|
1992
|
+
/** this DTO is global and is used for the infragistic grid's server-side filters management. For now, it only handles "contains" filters with single value or "in" filters for multiple values. */
|
|
1993
|
+
export interface FieldFiltersDto {
|
|
1994
|
+
field?: string | undefined;
|
|
1995
|
+
/** Specify the SearchableDataType of the field */
|
|
1996
|
+
dataType?: SearchableDataType2 | undefined;
|
|
1997
|
+
/** This is the old version of the filter value, it allows for a single value, and it can be
|
|
1998
|
+
used on all filters that logically accepts a single value, like equals. To simplifiy everything
|
|
1999
|
+
you can always use even for single values, so this field can be considered
|
|
2000
|
+
almmost obsolete.
|
|
2001
|
+
|
|
2002
|
+
It is still used but almost all code converter that convert various public and private dto into
|
|
2003
|
+
this common search object uses for every filter. */
|
|
2004
|
+
value?: any | undefined;
|
|
2005
|
+
/** This is the preferred way to specify values to search, if you use filters like In this contains more
|
|
2006
|
+
than one value, if you use equals, usually this contains a single value.
|
|
2007
|
+
You can always (and it is preferred) to use this instead of Value, because it is
|
|
2008
|
+
more consistent and it is used by all the code that convert various dto into this common search object. */
|
|
2009
|
+
values?: any[] | undefined;
|
|
2010
|
+
/** Trigger an exact search, where no analyzer is used in elastic (useful for id etc). */
|
|
2011
|
+
exactSearch?: boolean;
|
|
2012
|
+
/** Valid only if ExactSearch is true, allows for a case sensitive search. */
|
|
2013
|
+
caseSensitiveSearch?: boolean | undefined;
|
|
2014
|
+
filterType?: FieldFilterType;
|
|
2015
|
+
}
|
|
2016
|
+
export declare enum SearchableDataType2 {
|
|
2017
|
+
String = 0,
|
|
2018
|
+
Numeric = 1,
|
|
2019
|
+
DateTime = 2
|
|
2020
|
+
}
|
|
2021
|
+
/** Values seems to suggest a [Flags] enum but this is a standard field NOT FLAG so you can add more values without using powers of 2. */
|
|
2022
|
+
export declare enum FieldFilterType {
|
|
2023
|
+
Unknown = 0,
|
|
2024
|
+
IsNull = 1,
|
|
2025
|
+
IsNotNull = 2,
|
|
2026
|
+
OneOf = 4,
|
|
2027
|
+
Contains = 8,
|
|
2028
|
+
DoesNotContain = 16,
|
|
2029
|
+
StartsWith = 32,
|
|
2030
|
+
EndsWith = 64,
|
|
2031
|
+
Equals = 128,
|
|
2032
|
+
NotEqual = 256,
|
|
2033
|
+
GreaterThan = 512,
|
|
2034
|
+
GreaterThanOrEqualTo = 1024,
|
|
2035
|
+
LessThan = 2048,
|
|
2036
|
+
LessThanOrEqualTo = 4096,
|
|
2037
|
+
NotOneOf = 8192,
|
|
2038
|
+
Between = 16384
|
|
2039
|
+
}
|
|
2040
|
+
export interface FilteringExpressionDto {
|
|
2041
|
+
logic?: FilteringLogic;
|
|
2042
|
+
operands?: IFilteringOperandDto[] | undefined;
|
|
2043
|
+
}
|
|
2044
|
+
export declare enum FilteringLogic {
|
|
2045
|
+
And = 0,
|
|
2046
|
+
Or = 1
|
|
2047
|
+
}
|
|
2048
|
+
export interface IFilteringOperandDto {
|
|
2049
|
+
}
|
|
2050
|
+
export interface OmniSearchSortingRequestDto {
|
|
2051
|
+
/** Sorting field */
|
|
2052
|
+
sortField?: string | undefined;
|
|
2053
|
+
/** Type of the sorting field */
|
|
2054
|
+
sortFieldType?: SearchableDataType2;
|
|
2055
|
+
/** Is it descending or ascending */
|
|
2056
|
+
sortDescending?: boolean;
|
|
2057
|
+
}
|
|
2058
|
+
/** API Response Object. */
|
|
2059
|
+
export interface ResponseOfOmniSearchFacetResult extends JarvisResponse {
|
|
2060
|
+
/** The actual result of the operation. */
|
|
2061
|
+
data?: OmniSearchFacetResult | undefined;
|
|
2062
|
+
}
|
|
2063
|
+
export interface SearchInfo {
|
|
2064
|
+
/** Page number (0 based) */
|
|
2065
|
+
page?: number;
|
|
2066
|
+
total?: number;
|
|
2067
|
+
}
|
|
2068
|
+
export interface OmniSearchFacetResult extends SearchInfo {
|
|
2069
|
+
facets?: OmniSearchFacet[] | undefined;
|
|
2070
|
+
success?: boolean;
|
|
2071
|
+
errorMessage?: string | undefined;
|
|
2072
|
+
queryDump?: string | undefined;
|
|
2073
|
+
}
|
|
2074
|
+
export interface OmniSearchFacet {
|
|
2075
|
+
id?: string | undefined;
|
|
2076
|
+
total?: number;
|
|
2077
|
+
buckets?: OmniSearchFacetBucket[] | undefined;
|
|
2078
|
+
/** needs for UI */
|
|
2079
|
+
filtered?: boolean;
|
|
2080
|
+
}
|
|
2081
|
+
export interface OmniSearchFacetBucket {
|
|
2082
|
+
key?: string | undefined;
|
|
2083
|
+
count?: number;
|
|
2084
|
+
filtering?: boolean;
|
|
2085
|
+
translatedId?: string | undefined;
|
|
2086
|
+
}
|
|
2087
|
+
/** DTO class used to pass parameter to populate FacetOmniSearchQueryDefinition */
|
|
2088
|
+
export interface OmniSearchQueryFacetsRequestDto extends OmniSearchQueryRequestDto {
|
|
2089
|
+
/** This is the filter for facets value. */
|
|
2090
|
+
facetFilter?: FieldFiltersDto | undefined;
|
|
2091
|
+
facetTranslateEnabled?: boolean;
|
|
2092
|
+
facetLookupTypeName?: string | undefined;
|
|
2093
|
+
}
|
|
2094
|
+
/** This dto is used both as return value to represent the shape of a dataset and as upload value to represent an upsert. Since Dataset are a simple payload we do not need a chain of command like in other upsert. Usual pattern is get actual definition from the api, change and then upsert. */
|
|
2095
|
+
export interface PublicDatasetDetailDto {
|
|
2096
|
+
/** Name of the dataset, integrators can use this to identify the dataset instead
|
|
2097
|
+
of a real DatasetId object, for dataset it is better to stick
|
|
2098
|
+
to the name of the dataset instead of internal id.
|
|
2099
|
+
This is the very same property of the Type */
|
|
2100
|
+
id?: string | undefined;
|
|
2101
|
+
/** The description of the dataset */
|
|
2102
|
+
description?: string | undefined;
|
|
2103
|
+
defaultSortColumn?: string | undefined;
|
|
2104
|
+
defaultSortColumnDescending?: boolean;
|
|
2105
|
+
categories?: string[] | undefined;
|
|
2106
|
+
securityTokens?: string[] | undefined;
|
|
2107
|
+
/** Internal meta detail, ignored on update */
|
|
2108
|
+
_Meta?: PublicDatasetMetaDetailDto | undefined;
|
|
2109
|
+
/** Configuration for the fields to show to the user */
|
|
2110
|
+
columns?: PublicDatasetColumnInfoDto[] | undefined;
|
|
2111
|
+
/** Configured tabs for the dataset */
|
|
2112
|
+
tabsExternal?: PublicExternalDatasetTabConfigDto[] | undefined;
|
|
2113
|
+
}
|
|
2114
|
+
export interface PublicDatasetMetaDetailDto {
|
|
2115
|
+
internalId?: string | undefined;
|
|
2116
|
+
}
|
|
2117
|
+
export interface PublicDatasetColumnInfoDto {
|
|
2118
|
+
field?: string | undefined;
|
|
2119
|
+
headers?: {
|
|
2120
|
+
[key: string]: string;
|
|
2121
|
+
} | undefined;
|
|
2122
|
+
dataType?: string | undefined;
|
|
2123
|
+
filterStrategy?: string | undefined;
|
|
2124
|
+
/** This helps the index to search the lookup in another data source entity. */
|
|
2125
|
+
destinationFacetType?: string | undefined;
|
|
2126
|
+
filterable?: boolean;
|
|
2127
|
+
hidden?: boolean;
|
|
2128
|
+
localized?: boolean;
|
|
2129
|
+
sortable?: boolean;
|
|
2130
|
+
separator?: string | undefined;
|
|
2131
|
+
visibleInGrid?: boolean;
|
|
2132
|
+
notSelectable?: boolean;
|
|
2133
|
+
includeInFullText?: boolean;
|
|
2134
|
+
template?: string | undefined;
|
|
2135
|
+
cellTemplate?: string | undefined;
|
|
2136
|
+
cellTemplateData?: string | undefined;
|
|
2137
|
+
displayRaw?: boolean;
|
|
2138
|
+
}
|
|
2139
|
+
export interface PublicExternalDatasetTabConfigDto {
|
|
2140
|
+
/** The name of the tab */
|
|
2141
|
+
name?: string | undefined;
|
|
2142
|
+
/** The kind of tab */
|
|
2143
|
+
type?: string | undefined;
|
|
2144
|
+
externalContent?: string | undefined;
|
|
2145
|
+
/** The custom CSS style to apply to the tab */
|
|
2146
|
+
style?: string | undefined;
|
|
2147
|
+
}
|
|
2148
|
+
/** Upsert is using the same dto definition returned from the get api. */
|
|
2149
|
+
export interface UpsertDatasetDefinitionRequest extends PublicDatasetDetailDto {
|
|
2150
|
+
}
|
|
2151
|
+
/** Allows for searching inside dataset. */
|
|
2152
|
+
export interface DatasetItemsSearchRequest extends OmniSearchQueryRequest {
|
|
2153
|
+
/** dataset Id to search into, you can use this parameter or you can specify
|
|
2154
|
+
dataset name in DatasetType */
|
|
2155
|
+
datasetId?: string | undefined;
|
|
2156
|
+
/** You can search not only by DatasetId but also by DatasetType */
|
|
2157
|
+
datasetType?: string | undefined;
|
|
2158
|
+
/** If true it will include metadata (_meta) in the response. */
|
|
2159
|
+
includeMeta?: boolean;
|
|
2160
|
+
/** If this parameter is set to true, search result will include only properties
|
|
2161
|
+
specified in this array. */
|
|
2162
|
+
propertiesToInclude?: string[] | undefined;
|
|
2163
|
+
}
|
|
2164
|
+
/** API Response Object. */
|
|
2165
|
+
export interface ResponseOfPureJsonGroupedOmniSearchResultDto extends JarvisResponse {
|
|
2166
|
+
/** The actual result of the operation. */
|
|
2167
|
+
data?: PureJsonGroupedOmniSearchResultDto | undefined;
|
|
2168
|
+
}
|
|
2169
|
+
export interface PureJsonGroupedOmniSearchResultDto {
|
|
2170
|
+
total?: number;
|
|
2171
|
+
itemsGroups?: PureJsonOmniSearchItemsGroup[] | undefined;
|
|
2172
|
+
}
|
|
2173
|
+
export interface PureJsonOmniSearchItemsGroup {
|
|
2174
|
+
key?: string | undefined;
|
|
2175
|
+
count?: number;
|
|
2176
|
+
items?: any[] | undefined;
|
|
2177
|
+
aggregations?: OmniSearchItemsAggegationValue[] | undefined;
|
|
2178
|
+
}
|
|
2179
|
+
export interface OmniSearchItemsAggegationValue {
|
|
2180
|
+
field?: string | undefined;
|
|
2181
|
+
value?: number | undefined;
|
|
2182
|
+
}
|
|
2183
|
+
export interface OmniSearchQueryGroupsRequest extends OmniSearchQueryRequest {
|
|
2184
|
+
/** Field on which to group the items */
|
|
2185
|
+
groupField?: string | undefined;
|
|
2186
|
+
/** if null, all the groups (till a max of 999) are returned */
|
|
2187
|
+
numGroupsToReturn?: number | undefined;
|
|
2188
|
+
aggregations?: OmniSearchQueryGroupAggregationRequest[] | undefined;
|
|
2189
|
+
}
|
|
2190
|
+
/** Request for search grouped items. Identify the dataset with DatasetType or, if you know it, with DatasetId. */
|
|
2191
|
+
export interface DatasetItemsSearchGroupsRequest extends OmniSearchQueryGroupsRequest {
|
|
2192
|
+
/** Id of the dataset. If null DatasetType is required */
|
|
2193
|
+
datasetId?: string | undefined;
|
|
2194
|
+
/** type name of dataset. If null DatasetId is required */
|
|
2195
|
+
datasetType?: string | undefined;
|
|
2196
|
+
}
|
|
2197
|
+
export interface OmniSearchQueryGroupAggregationRequest {
|
|
2198
|
+
field?: string | undefined;
|
|
2199
|
+
/** Field type. Valid value are:
|
|
2200
|
+
1-String, 2-Numeric, 3-DateTime */
|
|
2201
|
+
fieldType?: OmniSearchItemPropertyType;
|
|
2202
|
+
/** Type of aggregations. Valid values are:
|
|
2203
|
+
1-Sum, 2-Average, 3-Max, 4-Min */
|
|
2204
|
+
aggregationType?: GroupOmniSearchAggregationType;
|
|
2205
|
+
}
|
|
2206
|
+
export declare enum OmniSearchItemPropertyType {
|
|
2207
|
+
Unknown = 0,
|
|
2208
|
+
String = 1,
|
|
2209
|
+
Numeric = 2,
|
|
2210
|
+
DateTime = 3
|
|
2211
|
+
}
|
|
2212
|
+
export declare enum GroupOmniSearchAggregationType {
|
|
2213
|
+
Unknown = 0,
|
|
2214
|
+
Sum = 1,
|
|
2215
|
+
Average = 2,
|
|
2216
|
+
Max = 3,
|
|
2217
|
+
Min = 4
|
|
2218
|
+
}
|
|
2219
|
+
/** API Response Object. */
|
|
2220
|
+
export interface ResponseOfDatasetItemInfoResponse extends JarvisResponse {
|
|
2221
|
+
/** The actual result of the operation. */
|
|
2222
|
+
data?: DatasetItemInfoResponse | undefined;
|
|
2223
|
+
}
|
|
2224
|
+
/** Base dto for Dataset item detail response */
|
|
2225
|
+
export interface DatasetItemInfoResponseBase {
|
|
2226
|
+
datasetId?: string | undefined;
|
|
2227
|
+
/** Internal id associated by jarvis to this specific element. */
|
|
2228
|
+
datasetElementId?: string | undefined;
|
|
2229
|
+
/** To load documents associated to the id. */
|
|
2230
|
+
containerId?: string | undefined;
|
|
2231
|
+
/** A dictionary containing the translation of some of the ids included in the response */
|
|
2232
|
+
translatedIds?: {
|
|
2233
|
+
[key: string]: string;
|
|
2234
|
+
} | undefined;
|
|
2235
|
+
/** An ordered list of all available tabs to be shown in the item detail */
|
|
2236
|
+
tabNames?: string[] | undefined;
|
|
2237
|
+
/** The external tabs configured to be shown in this item detail */
|
|
2238
|
+
externalTabs?: DatasetExternalTabPublicConfigDto[] | undefined;
|
|
2239
|
+
/** How to display specific fields of the item */
|
|
2240
|
+
itemViewConfig?: {
|
|
2241
|
+
[key: string]: DatasetItemViewConfigDto;
|
|
2242
|
+
} | undefined;
|
|
2243
|
+
/** If request contains ReturnNewIfNotFound equal to true
|
|
2244
|
+
and the item was not found, this property will indicate to the caller that this is not a match
|
|
2245
|
+
but an empty object. */
|
|
2246
|
+
isNew?: boolean;
|
|
2247
|
+
}
|
|
2248
|
+
/** Dataset item detail passed as plain object, with a JObject object, to return object with the very same properties as you loaded with excel. */
|
|
2249
|
+
export interface DatasetItemInfoResponse extends DatasetItemInfoResponseBase {
|
|
2250
|
+
/** The properties of the item itself */
|
|
2251
|
+
item?: any | undefined;
|
|
2252
|
+
}
|
|
2253
|
+
export interface DatasetExternalTabPublicConfigDto {
|
|
2254
|
+
name?: string | undefined;
|
|
2255
|
+
/** Type of property. */
|
|
2256
|
+
type?: string | undefined;
|
|
2257
|
+
/** The HTML to show inside the tab */
|
|
2258
|
+
externalContent?: string | undefined;
|
|
2259
|
+
/** The custom CSS style to apply to the tab */
|
|
2260
|
+
style?: string | undefined;
|
|
2261
|
+
}
|
|
2262
|
+
export interface DatasetItemViewConfigDto {
|
|
2263
|
+
/** The kind of field e.g. stadard text field, link, etc. */
|
|
2264
|
+
cellTemplate?: string | undefined;
|
|
2265
|
+
/** Data used to correctly display the field, can be null
|
|
2266
|
+
e.g. null for a standard field, contains the target link tempalte for external links */
|
|
2267
|
+
cellTemplateData?: string | undefined;
|
|
2268
|
+
}
|
|
2269
|
+
export interface DatasetItemInfoRequest {
|
|
2270
|
+
/** DatsetId to perform the request */
|
|
2271
|
+
datasetId?: string | undefined;
|
|
2272
|
+
/** You can specify DatasetId or Datset Type to perform the request */
|
|
2273
|
+
datasetType?: string | undefined;
|
|
2274
|
+
/** If specified it ask for a specific version of the dataset, we should
|
|
2275
|
+
have change tracking enabled. */
|
|
2276
|
+
version?: number | undefined;
|
|
2277
|
+
/** This is the outer element id, it is the id that an integrator see. */
|
|
2278
|
+
elementId?: string | undefined;
|
|
2279
|
+
/** This is the internal id, of type DatasetElementId */
|
|
2280
|
+
internalId?: string | undefined;
|
|
2281
|
+
/** If true it will include _meta in the answer */
|
|
2282
|
+
includeMeta?: boolean;
|
|
2283
|
+
/** To simplify editing operations it is probably better for a public api to ask for a given
|
|
2284
|
+
item, and if the item is not present return an empty one that can be bound to the ui. */
|
|
2285
|
+
returnNewIfNotFound?: boolean;
|
|
2286
|
+
}
|
|
2287
|
+
/** API Response Object. */
|
|
2288
|
+
export interface ResponseOfDatasetItemFullOmnisearchItemDtoInfoResponse extends JarvisResponse {
|
|
2289
|
+
/** The actual result of the operation. */
|
|
2290
|
+
data?: DatasetItemFullOmnisearchItemDtoInfoResponse | undefined;
|
|
2291
|
+
}
|
|
2292
|
+
/** Dataset Item details passed as serialization of internal OmniSearchItemDto it can be useful for app and for all clients that wants to have a full list of string integer date properties as well as internal omnisearch item stuff. */
|
|
2293
|
+
export interface DatasetItemFullOmnisearchItemDtoInfoResponse extends DatasetItemInfoResponseBase {
|
|
2294
|
+
/** The properties of the item itself */
|
|
2295
|
+
item?: OmniSearchItemDto | undefined;
|
|
2296
|
+
}
|
|
2297
|
+
export interface OmniSearchItemDto {
|
|
2298
|
+
/** Identificator of the resource, this is usually an EventStoreIdentity */
|
|
2299
|
+
id?: string | undefined;
|
|
2300
|
+
/** This is needed for routing. */
|
|
2301
|
+
parentSecurityDescriptor?: string | undefined;
|
|
2302
|
+
/** Not used, but can be useful to diagnostic. */
|
|
2303
|
+
checkpointToken?: number;
|
|
2304
|
+
/** Needed for the poller, if the original source can update multiple record with
|
|
2305
|
+
the very same tick (massive update) we need somewhat to generate an unique Secondary
|
|
2306
|
+
index that will guarantee uniqueness. */
|
|
2307
|
+
secondaryUpdateToken?: number;
|
|
2308
|
+
/** Needed only for kibana, this is when the item was last updated. */
|
|
2309
|
+
lastUpdated?: Date;
|
|
2310
|
+
/** In an index we can have multiple types of objects, all collapsed in a single object.
|
|
2311
|
+
This property contains the type of the object, to filter for specific type or to
|
|
2312
|
+
suggest to the ui what to show to the user. */
|
|
2313
|
+
type?: string | undefined;
|
|
2314
|
+
/** It is really convenient to store all deleted object inside the omnisearch to being
|
|
2315
|
+
able to search deleted data if needed. */
|
|
2316
|
+
deleted?: boolean;
|
|
2317
|
+
/** This is a string that represent the resource, it is something that have high
|
|
2318
|
+
importance and contains usually the most important search information for the
|
|
2319
|
+
object. */
|
|
2320
|
+
title?: string | undefined;
|
|
2321
|
+
/** These are for trace the ids related to the item.
|
|
2322
|
+
These Ids will be translated by the OmniSearch in order to
|
|
2323
|
+
enrich the item with basic information from other related entities */
|
|
2324
|
+
relatedIds?: string[] | undefined;
|
|
2325
|
+
/** These are for advanced search, allow for searching inside specific properties and
|
|
2326
|
+
also these are used to do sorting. */
|
|
2327
|
+
stringProperties?: OmniSearchPropertyStringDto[] | undefined;
|
|
2328
|
+
/** These are for advanced search, allow for searching inside specific properties and
|
|
2329
|
+
also these are used to do sorting. */
|
|
2330
|
+
numericProperties?: OmniSearchPropertyNumericDto[] | undefined;
|
|
2331
|
+
/** These are for advanced search, allow for searching inside specific properties and
|
|
2332
|
+
also these are used to do sorting. */
|
|
2333
|
+
dateTimeProperties?: OmniSearchPropertyDateTimeDto[] | undefined;
|
|
2334
|
+
/** This field is stored as Ngrammed, and will be populated with properties value
|
|
2335
|
+
that are ngrammed.
|
|
2336
|
+
Some search, as for searches in telephone numbers, really cannot rely on standard
|
|
2337
|
+
default analyzer. For telephone a search for telephone 23456 should match 03212345678
|
|
2338
|
+
and 032 123 456 78 */
|
|
2339
|
+
ngrammed?: string[] | undefined;
|
|
2340
|
+
/** Contains large section of text, that can be used to search if the item has
|
|
2341
|
+
associated large quantity of text. */
|
|
2342
|
+
fullText?: string | undefined;
|
|
2343
|
+
/** This is not indexed, it is a simple string that can be returned to the caller. */
|
|
2344
|
+
payload?: string | undefined;
|
|
2345
|
+
/** If this property is true, we do not need to check SecurityTokens when
|
|
2346
|
+
we are looking for object with security */
|
|
2347
|
+
unsecured?: boolean;
|
|
2348
|
+
/** This collection contains a list of the security descriptor that can access
|
|
2349
|
+
the object, it can contain UserId GroupId or
|
|
2350
|
+
whatever information you need to access this object. From the point of
|
|
2351
|
+
view of security we can search for object that have one or more string in this
|
|
2352
|
+
property */
|
|
2353
|
+
securityTokens?: string[] | undefined;
|
|
2354
|
+
/** This indicates a record that was created for an offline projection, this flag is used
|
|
2355
|
+
both to identify record created outside of the poller, and also it avoid security like
|
|
2356
|
+
the Unsecured flag, because a record created offline is always visible */
|
|
2357
|
+
offline?: boolean;
|
|
2358
|
+
}
|
|
2359
|
+
export interface OmniSearchPropertyStringDto {
|
|
2360
|
+
key?: string | undefined;
|
|
2361
|
+
value?: string[] | undefined;
|
|
2362
|
+
}
|
|
2363
|
+
export interface OmniSearchPropertyNumericDto {
|
|
2364
|
+
key?: string | undefined;
|
|
2365
|
+
value?: number[] | undefined;
|
|
2366
|
+
}
|
|
2367
|
+
export interface OmniSearchPropertyDateTimeDto {
|
|
2368
|
+
key?: string | undefined;
|
|
2369
|
+
value?: Date[] | undefined;
|
|
2370
|
+
}
|
|
2371
|
+
export interface DatasetSearchFacetsRequestDto extends OmniSearchQueryFacetsRequestDto {
|
|
2372
|
+
/** The id of the dataset */
|
|
2373
|
+
datasetId?: string | undefined;
|
|
2374
|
+
/** THe type of the dataset */
|
|
2375
|
+
type?: string | undefined;
|
|
2376
|
+
}
|
|
2377
|
+
/** API Response Object. */
|
|
2378
|
+
export interface ResponseOfDatasetFieldsConfigDto extends JarvisResponse {
|
|
2379
|
+
/** The actual result of the operation. */
|
|
2380
|
+
data?: DatasetFieldsConfigDto | undefined;
|
|
2381
|
+
}
|
|
2382
|
+
/** Used only by Jarvis App for now. Needed in order to filter by facets given the fields configuration TODO: move inside Dataset.Api.Shared.Dto.Public */
|
|
2383
|
+
export interface DatasetFieldsConfigDto {
|
|
2384
|
+
/** Dataset id */
|
|
2385
|
+
id?: string | undefined;
|
|
2386
|
+
/** Configuration for the field to show to the user */
|
|
2387
|
+
fieldsConfig?: OmniSearchFieldDto[] | undefined;
|
|
2388
|
+
}
|
|
2389
|
+
export interface OmniSearchFieldDto {
|
|
2390
|
+
field?: string | undefined;
|
|
2391
|
+
/** The source origin of the field.
|
|
2392
|
+
|
|
2393
|
+
It should one of the "domain origin" () or the PropertyDefinition for properties.
|
|
2394
|
+
This is useful to let understand better the inner fields for lookup/dataset properties
|
|
2395
|
+
|
|
2396
|
+
Not all the Dataset properties should be used, but only those marked as public/searchable
|
|
2397
|
+
|
|
2398
|
+
TODO: può essere solo nel DTO esposto? */
|
|
2399
|
+
origin?: string | undefined;
|
|
2400
|
+
/** This is true if this is a default field for the actual context, this is important because default fields
|
|
2401
|
+
cannot be actually removed from the ui configuration they can only be hidden.
|
|
2402
|
+
|
|
2403
|
+
Pay attention that this field is introduced later after lots of refactoring, it is populated by the
|
|
2404
|
+
interface initially. */
|
|
2405
|
+
isDefault?: boolean;
|
|
2406
|
+
dataType?: OmniSearchItemGridColumnDataType;
|
|
2407
|
+
filterStrategy?: OmniSearchItemConfigurationFilterStrategy;
|
|
2408
|
+
template?: OmniSearchItemConfigurationFilterColumnTemplate;
|
|
2409
|
+
width?: string | undefined;
|
|
2410
|
+
headers?: {
|
|
2411
|
+
[key: string]: string;
|
|
2412
|
+
} | undefined;
|
|
2413
|
+
originHeaders?: {
|
|
2414
|
+
[key: string]: string;
|
|
2415
|
+
} | undefined;
|
|
2416
|
+
filterable?: boolean;
|
|
2417
|
+
sortable?: boolean;
|
|
2418
|
+
filterStrategyInput?: OmniSearchItemFilterStrategyInputDto | undefined;
|
|
2419
|
+
/** If true, don't attempt to translate this value, even if it's an id */
|
|
2420
|
+
displayRaw?: boolean;
|
|
2421
|
+
/** If the field configuration has the "localized" property set
|
|
2422
|
+
the UI will transform the field name from "field" to "field_lang" (eg. "fieldname_it") */
|
|
2423
|
+
localized?: boolean;
|
|
2424
|
+
hidden?: boolean;
|
|
2425
|
+
/** This is used to hide fields like enums from the select properties on a workspace
|
|
2426
|
+
in which an enum is attached. */
|
|
2427
|
+
notSelectable?: boolean;
|
|
2428
|
+
backgroundColor?: string | undefined;
|
|
2429
|
+
canBeUsedToAggregate?: boolean;
|
|
2430
|
+
cellTemplate?: OmniSearchFieldCellTemplate;
|
|
2431
|
+
/** CellTemplateData for existing uses (ExternalLink templates, etc.) */
|
|
2432
|
+
cellTemplateData?: string | undefined;
|
|
2433
|
+
/** Display/rendering settings for the field, populated from field metadata (anagrafica).
|
|
2434
|
+
Contains type-specific DTO (e.g., NumberDisplaySettings for number fields).
|
|
2435
|
+
This field is NEVER saved in view configurations - it's always populated from field metadata at runtime.
|
|
2436
|
+
When admin changes field configuration (e.g., decimal places), all views automatically reflect the change. */
|
|
2437
|
+
displaySettings?: IFieldDisplaySettings | undefined;
|
|
2438
|
+
/** Default field for aggregated view/query */
|
|
2439
|
+
defaultAggregateField?: boolean;
|
|
2440
|
+
/** #12803 True if field can be used as a link through the connected linked item */
|
|
2441
|
+
linkable?: boolean;
|
|
2442
|
+
/** #14601 True if field values can be returned as an enumerable list */
|
|
2443
|
+
isEnumerable?: boolean;
|
|
2444
|
+
/** In the #18403 we have a problem where the Jarvis Fields with AllowedValues
|
|
2445
|
+
needs to be able to call the allowed value service, but we need to know the AssociationId.
|
|
2446
|
+
This field will contains the AssociationId for that specific situation.
|
|
2447
|
+
This is needed because some of the information that allows to work with jarvis fields
|
|
2448
|
+
are contained in the association so this is an information that we need to pass to the ui.
|
|
2449
|
+
|
|
2450
|
+
It is put here because we need to access it from the interface IOmniSearchFieldDto */
|
|
2451
|
+
jarvisFieldsAssociationId?: string | undefined;
|
|
2452
|
+
}
|
|
2453
|
+
export declare enum OmniSearchItemGridColumnDataType {
|
|
2454
|
+
Unknown = "unknown",
|
|
2455
|
+
String = "string",
|
|
2456
|
+
Number = "number",
|
|
2457
|
+
Boolean = "boolean",
|
|
2458
|
+
Date = "date",
|
|
2459
|
+
DateTime = "dateTime",
|
|
2460
|
+
Time = "time",
|
|
2461
|
+
Currency = "currency",
|
|
2462
|
+
Percent = "percent",
|
|
2463
|
+
Hyperlink = "hyperlink",
|
|
2464
|
+
Entity = "entity",
|
|
2465
|
+
Enum = "enum",
|
|
2466
|
+
Integer = "integer",
|
|
2467
|
+
File = "file",
|
|
2468
|
+
RTE = "rte",
|
|
2469
|
+
Counter = "counter"
|
|
2470
|
+
}
|
|
2471
|
+
export declare enum OmniSearchItemConfigurationFilterStrategy {
|
|
2472
|
+
Unknown = "unknown",
|
|
2473
|
+
NoSearch = "no-search",
|
|
2474
|
+
Custom = "custom",
|
|
2475
|
+
ByFacet = "by-facet",
|
|
2476
|
+
ByFacetId = "by-facet-id",
|
|
2477
|
+
ByUDVL = "by-user-defined-value-list",
|
|
2478
|
+
ByUser = "by-user",
|
|
2479
|
+
ByUserAndGroup = "by-user-and-group",
|
|
2480
|
+
ByAvailableValues = "by-available-values",
|
|
2481
|
+
Disabled = "disabled"
|
|
2482
|
+
}
|
|
2483
|
+
export declare enum OmniSearchItemConfigurationFilterColumnTemplate {
|
|
2484
|
+
Unknown = "unknown",
|
|
2485
|
+
Selection = "selection",
|
|
2486
|
+
AutoComplete = "auto-complete",
|
|
2487
|
+
TranslatedAutoComplete = "translated-auto-complete",
|
|
2488
|
+
DateRange = "date-range",
|
|
2489
|
+
SearchText = "string",
|
|
2490
|
+
Custom = "custom",
|
|
2491
|
+
Users = "users",
|
|
2492
|
+
Enum = "enum"
|
|
2493
|
+
}
|
|
2494
|
+
export interface OmniSearchItemFilterStrategyInputDto {
|
|
2495
|
+
pageSize?: number;
|
|
2496
|
+
stringParams?: {
|
|
2497
|
+
[key: string]: string;
|
|
2498
|
+
} | undefined;
|
|
2499
|
+
}
|
|
2500
|
+
export declare enum OmniSearchFieldCellTemplate {
|
|
2501
|
+
Unknown = "unknown",
|
|
2502
|
+
Standard = "standard",
|
|
2503
|
+
ExternalLink = "external-link",
|
|
2504
|
+
Link = "link",
|
|
2505
|
+
InlineRichText = "inline-rich-text"
|
|
2506
|
+
}
|
|
2507
|
+
/** Marker interface for field display/rendering settings DTOs. These DTOs contain metadata from field anagrafica for UI rendering. These settings are NEVER saved in view configurations - always populated from field metadata at runtime. */
|
|
2508
|
+
export interface IFieldDisplaySettings {
|
|
2509
|
+
}
|
|
2510
|
+
/** API Response Object. */
|
|
2511
|
+
export interface ResponseOfUpsertDatasetElementResponse extends JarvisResponse {
|
|
2512
|
+
/** The actual result of the operation. */
|
|
2513
|
+
data?: UpsertDatasetElementResponse | undefined;
|
|
2514
|
+
}
|
|
2515
|
+
/** Contains the list of upserted elements with information about id of upserted elements. */
|
|
2516
|
+
export interface UpsertDatasetElementResponse {
|
|
2517
|
+
/** Contains all successfully inserted elements. */
|
|
2518
|
+
importResults?: UpsertDatasetElementResult[] | undefined;
|
|
2519
|
+
}
|
|
2520
|
+
/** Information about inserted element. */
|
|
2521
|
+
export interface UpsertDatasetElementResult {
|
|
2522
|
+
success?: boolean;
|
|
2523
|
+
errorMessage?: string | undefined;
|
|
2524
|
+
originalId?: string | undefined;
|
|
2525
|
+
internalId?: string | undefined;
|
|
2526
|
+
}
|
|
2527
|
+
/** Upsert a series of dataset elements. */
|
|
2528
|
+
export interface UpsertDatasetElementsRequests {
|
|
2529
|
+
/** Dataset id */
|
|
2530
|
+
datasetId?: string | undefined;
|
|
2531
|
+
/** If no DatasetId parameter is provided you can specify type of the dataset. */
|
|
2532
|
+
datasetType?: string | undefined;
|
|
2533
|
+
/** List of objects to upsert. */
|
|
2534
|
+
elements?: any[] | undefined;
|
|
2535
|
+
/** Inserted with #12900: call is now sync, after you save something in the public api
|
|
2536
|
+
data is immediately searchable in elasetic upon return. If this parameter is true the
|
|
2537
|
+
insert is done asynchronously, data is stored in mongo then indexed in elastic by the standard
|
|
2538
|
+
poller. */
|
|
2539
|
+
async?: boolean;
|
|
2540
|
+
}
|
|
2541
|
+
/** API Response Object. */
|
|
2542
|
+
export interface ResponseOfBoolean extends JarvisResponse {
|
|
2543
|
+
/** The actual result of the operation. */
|
|
2544
|
+
data?: boolean;
|
|
2545
|
+
}
|
|
2546
|
+
export interface OmniSearchItemIdsBlockToDeleteRequest {
|
|
2547
|
+
/** items type. All the passed items should be of this type */
|
|
2548
|
+
itemType?: string | undefined;
|
|
2549
|
+
/** Item to index in Omnisearch engine */
|
|
2550
|
+
itemIds?: string[] | undefined;
|
|
2551
|
+
}
|
|
2552
|
+
export interface DatasetTruncateRequest {
|
|
2553
|
+
/** DatasetId of the dataset to truncate */
|
|
2554
|
+
datasetId?: string | undefined;
|
|
2555
|
+
/** If DatasetId is not specified we can specify DatasetType */
|
|
2556
|
+
datasetType?: string | undefined;
|
|
2557
|
+
}
|
|
2558
|
+
/** API Response Object. */
|
|
2559
|
+
export interface ResponseOfAceReducedDtoOf extends JarvisResponse {
|
|
2560
|
+
/** The actual result of the operation. */
|
|
2561
|
+
data?: AceReducedDto[] | undefined;
|
|
2562
|
+
}
|
|
2563
|
+
export interface AceReducedDto {
|
|
2564
|
+
id?: string | undefined;
|
|
2565
|
+
name?: string | undefined;
|
|
2566
|
+
enabled?: boolean;
|
|
2567
|
+
}
|
|
2568
|
+
/** API Response Object. */
|
|
2569
|
+
export interface ResponseOfAceDto extends JarvisResponse {
|
|
2570
|
+
/** The actual result of the operation. */
|
|
2571
|
+
data?: AceDto | undefined;
|
|
2572
|
+
}
|
|
2573
|
+
export interface AceDto {
|
|
2574
|
+
id?: string | undefined;
|
|
2575
|
+
name?: string | undefined;
|
|
2576
|
+
enabled?: boolean;
|
|
2577
|
+
identities?: AcePermissionDto[] | undefined;
|
|
2578
|
+
}
|
|
2579
|
+
export interface AcePermissionDto {
|
|
2580
|
+
identity?: string | undefined;
|
|
2581
|
+
documentRead?: boolean;
|
|
2582
|
+
documentWrite?: boolean;
|
|
2583
|
+
documentDeny?: boolean;
|
|
2584
|
+
documentUpload?: boolean;
|
|
2585
|
+
containerCreate?: boolean;
|
|
2586
|
+
containerAdmin?: boolean;
|
|
2587
|
+
specialClaims?: string | undefined;
|
|
2588
|
+
isGroup?: boolean;
|
|
2589
|
+
}
|
|
2590
|
+
/** API Response Object. */
|
|
2591
|
+
export interface ResponseOfContainerInfoDto extends JarvisResponse {
|
|
2592
|
+
/** The actual result of the operation. */
|
|
2593
|
+
data?: ContainerInfoDto | undefined;
|
|
2594
|
+
}
|
|
2595
|
+
export interface BaseInfoDto {
|
|
2596
|
+
id?: string | undefined;
|
|
2597
|
+
name?: string | undefined;
|
|
2598
|
+
isFavourite?: boolean;
|
|
2599
|
+
lastModified?: Date;
|
|
2600
|
+
lastModifiedByUser?: string | undefined;
|
|
2601
|
+
lastModifiedByUserFullName?: string | undefined;
|
|
2602
|
+
archived?: boolean;
|
|
2603
|
+
archiviationEvents?: {
|
|
2604
|
+
[key: string]: ContainerArchiviationDataDto;
|
|
2605
|
+
} | undefined;
|
|
2606
|
+
}
|
|
2607
|
+
export interface BaseContainerInfoDto extends BaseInfoDto {
|
|
2608
|
+
type?: EContainerChildInfo;
|
|
2609
|
+
/** Parent ContainerId */
|
|
2610
|
+
parentId?: string | undefined;
|
|
2611
|
+
}
|
|
2612
|
+
export interface ContainerInfoDto extends BaseContainerInfoDto {
|
|
2613
|
+
documentClassId?: string | undefined;
|
|
2614
|
+
admitFiles?: boolean;
|
|
2615
|
+
admitSubContainers?: boolean;
|
|
2616
|
+
/** Document counter */
|
|
2617
|
+
documentsCount?: number;
|
|
2618
|
+
/** Child container counter */
|
|
2619
|
+
containersCount?: number;
|
|
2620
|
+
/** container's ace id */
|
|
2621
|
+
aceId?: string | undefined;
|
|
2622
|
+
/** This is the private Ace Id, it can be null if the container never enabled
|
|
2623
|
+
private aces, once set it cannot be changed. */
|
|
2624
|
+
privateAceId?: string | undefined;
|
|
2625
|
+
stopAceInheritance?: boolean;
|
|
2626
|
+
/** get the metadata id for the container */
|
|
2627
|
+
metaDataId?: string | undefined;
|
|
2628
|
+
/** get the metadata values of the container, when present */
|
|
2629
|
+
metaDataValues?: {
|
|
2630
|
+
[key: string]: MetaDataValue;
|
|
2631
|
+
} | undefined;
|
|
2632
|
+
/** Logial name used for fac */
|
|
2633
|
+
logicalName?: string | undefined;
|
|
2634
|
+
/** set the autopublication of all container's documents, is expressed in minutes */
|
|
2635
|
+
freePassInterval?: number | undefined;
|
|
2636
|
+
/** the editor of all container's documents */
|
|
2637
|
+
publisherId?: string | undefined;
|
|
2638
|
+
/** Recipient for all the aces (parent containers and current container) */
|
|
2639
|
+
aceIds?: string[] | undefined;
|
|
2640
|
+
/** Ordered list of path elements */
|
|
2641
|
+
pathSegments?: ContainerPathSegmentDto[] | undefined;
|
|
2642
|
+
isSystem?: boolean;
|
|
2643
|
+
containers?: ContainerInfoDto[] | undefined;
|
|
2644
|
+
documents?: DocumentInfoDto[] | undefined;
|
|
2645
|
+
/** if true this child should be visible only if user has access on one of his childrens */
|
|
2646
|
+
isForbidden?: boolean;
|
|
2647
|
+
isTemplate?: boolean;
|
|
2648
|
+
history?: ContainerHistoryInfoDto[] | undefined;
|
|
2649
|
+
settings?: ContainerSettingsDto | undefined;
|
|
2650
|
+
templates?: ContainerTemplateInfoDto[] | undefined;
|
|
2651
|
+
canCreateContainer?: boolean;
|
|
2652
|
+
canWriteContainer?: boolean;
|
|
2653
|
+
canCreateDocument?: boolean;
|
|
2654
|
+
canWriteDocument?: boolean;
|
|
2655
|
+
canAdminContainer?: boolean;
|
|
2656
|
+
documentClassesFullList?: string[] | undefined;
|
|
2657
|
+
/** This property is valued only for the child container.
|
|
2658
|
+
Is a dictionary of the property values of each child container. */
|
|
2659
|
+
properties?: {
|
|
2660
|
+
[key: string]: any[];
|
|
2661
|
+
} | undefined;
|
|
2662
|
+
}
|
|
2663
|
+
export interface MetaDataValue {
|
|
2664
|
+
metadataId?: string | undefined;
|
|
2665
|
+
key?: string | undefined;
|
|
2666
|
+
value?: string | undefined;
|
|
2667
|
+
}
|
|
2668
|
+
export interface ContainerPathSegmentDto {
|
|
2669
|
+
containerId?: string | undefined;
|
|
2670
|
+
name?: string | undefined;
|
|
2671
|
+
archived?: boolean;
|
|
2672
|
+
isSystem?: boolean;
|
|
2673
|
+
}
|
|
2674
|
+
export interface DocumentInfoDto extends BaseInfoDto {
|
|
2675
|
+
protocolNumber?: string | undefined;
|
|
2676
|
+
isMultifile?: boolean;
|
|
2677
|
+
iconType?: string | undefined;
|
|
2678
|
+
tags?: string[] | undefined;
|
|
2679
|
+
tagLabels?: string[] | undefined;
|
|
2680
|
+
workflowSummary?: DocumentWorkflowSummaryDto | undefined;
|
|
2681
|
+
isLocked?: boolean;
|
|
2682
|
+
lockUser?: string | undefined;
|
|
2683
|
+
permissions?: Permissions | undefined;
|
|
2684
|
+
documentType?: string | undefined;
|
|
2685
|
+
documentTypeName?: string | undefined;
|
|
2686
|
+
isPublished?: boolean;
|
|
2687
|
+
publishStamp?: Date;
|
|
2688
|
+
publishUser?: string | undefined;
|
|
2689
|
+
publishUserFullName?: string | undefined;
|
|
2690
|
+
/** Ordered list of path elements */
|
|
2691
|
+
pathSegments?: ContainerPathSegmentDto[] | undefined;
|
|
2692
|
+
isInDraft?: boolean;
|
|
2693
|
+
containerId?: string | undefined;
|
|
2694
|
+
canBePublished?: boolean;
|
|
2695
|
+
containerName?: string | undefined;
|
|
2696
|
+
metadataContextValue?: string | undefined;
|
|
2697
|
+
properties?: {
|
|
2698
|
+
[key: string]: any[];
|
|
2699
|
+
} | undefined;
|
|
2700
|
+
abstract?: string | undefined;
|
|
2701
|
+
previewBlobInfos?: BlobInfoDto[] | undefined;
|
|
2702
|
+
}
|
|
2703
|
+
export interface DocumentWorkflowSummaryDto {
|
|
2704
|
+
actualState?: string | undefined;
|
|
2705
|
+
revision?: number;
|
|
2706
|
+
}
|
|
2707
|
+
export interface Permissions {
|
|
2708
|
+
none?: boolean;
|
|
2709
|
+
canRead?: boolean;
|
|
2710
|
+
canWrite?: boolean;
|
|
2711
|
+
canArchive?: boolean;
|
|
2712
|
+
}
|
|
2713
|
+
export interface BlobInfoDto {
|
|
2714
|
+
blobId?: string | undefined;
|
|
2715
|
+
timeStamp?: Date;
|
|
2716
|
+
isDefault?: boolean;
|
|
2717
|
+
}
|
|
2718
|
+
export interface ContainerArchiviationDataDto {
|
|
2719
|
+
when?: Date;
|
|
2720
|
+
issuedBy?: string | undefined;
|
|
2721
|
+
containers?: number;
|
|
2722
|
+
documents?: number;
|
|
2723
|
+
}
|
|
2724
|
+
export interface ContainerHistoryInfoDto {
|
|
2725
|
+
id?: string | undefined;
|
|
2726
|
+
name?: string | undefined;
|
|
2727
|
+
lastTimeUsed?: Date;
|
|
2728
|
+
}
|
|
2729
|
+
export interface ContainerSettingsDto {
|
|
2730
|
+
sourceValues?: FormDataSourceValue[] | undefined;
|
|
2731
|
+
properties?: PropertiesListDto | undefined;
|
|
2732
|
+
layoutInfo?: ContainerLayoutDto | undefined;
|
|
2733
|
+
/** informations about allowed document types should be always available, might be needed to
|
|
2734
|
+
configure several dialogs. */
|
|
2735
|
+
allowedDocumentTypes?: ContainerAllowedDocumentTypesDto | undefined;
|
|
2736
|
+
}
|
|
2737
|
+
export interface FormDataSourceValue {
|
|
2738
|
+
fieldName?: string | undefined;
|
|
2739
|
+
fieldType?: string | undefined;
|
|
2740
|
+
defaultValue?: any | undefined;
|
|
2741
|
+
source?: string | undefined;
|
|
2742
|
+
readOnly?: boolean;
|
|
2743
|
+
}
|
|
2744
|
+
/** This dto contains all properties definitions and values, without specifying an owner */
|
|
2745
|
+
export interface PropertiesListDefinitionAndValuesDto {
|
|
2746
|
+
/** we could have the same definition on different items
|
|
2747
|
+
because the same definition is on different ancestor's definition list */
|
|
2748
|
+
definitionList?: PropertiesDefinitionListDto[] | undefined;
|
|
2749
|
+
/** The "merged" definition list.
|
|
2750
|
+
There is only one resulting definition list for an owner.
|
|
2751
|
+
It contains all the property definitions coming from each ancestor
|
|
2752
|
+
in the owner's ancestor list.
|
|
2753
|
+
The definition will merge hierarchical properties values like
|
|
2754
|
+
Required, Visible fields, based on the ancestors priority. */
|
|
2755
|
+
definitions?: PropertiesDefinitionListDto[] | undefined;
|
|
2756
|
+
/** Value list of the last ownerId eventually overridden by other ancestors value list */
|
|
2757
|
+
valueList?: PropertiesValueListDto | undefined;
|
|
2758
|
+
/** All ancestors if you want to use hierarchy for value list */
|
|
2759
|
+
ancestors?: string[] | undefined;
|
|
2760
|
+
}
|
|
2761
|
+
/** This dto contains all properties definitions and values for a specific owner. */
|
|
2762
|
+
export interface PropertiesListDto extends PropertiesListDefinitionAndValuesDto {
|
|
2763
|
+
ownerId?: string | undefined;
|
|
2764
|
+
}
|
|
2765
|
+
/** Flattened properties definition List. If a Definition List has two properties, there should be two instances of this class with the same DefinitionListId */
|
|
2766
|
+
export interface PropertiesDefinitionListDto {
|
|
2767
|
+
definitionId?: string | undefined;
|
|
2768
|
+
definitionListId?: string | undefined;
|
|
2769
|
+
required?: boolean;
|
|
2770
|
+
/** Flags */
|
|
2771
|
+
flags?: PropertyDefinitionReferenceFlags;
|
|
2772
|
+
localizedNames?: {
|
|
2773
|
+
[key: string]: string;
|
|
2774
|
+
} | undefined;
|
|
2775
|
+
localizedDescriptions?: {
|
|
2776
|
+
[key: string]: string;
|
|
2777
|
+
} | undefined;
|
|
2778
|
+
propertyType?: string | undefined;
|
|
2779
|
+
version?: number;
|
|
2780
|
+
additionalInfo?: any | undefined;
|
|
2781
|
+
fields?: OmniSearchExtendedFieldDto[] | undefined;
|
|
2782
|
+
/** (#14349) Tag / String value that identifies the custom component the UI
|
|
2783
|
+
should display to the user when editing the property Value */
|
|
2784
|
+
customEditor?: string | undefined;
|
|
2785
|
+
/** #14985 Propery definition owners
|
|
2786
|
+
Could be 'public' or it could contain owners id (e.g. Workspace_1, WorkspaceModel_1, TicketModel_2) */
|
|
2787
|
+
scopes?: string[] | undefined;
|
|
2788
|
+
/** Property datasource fields to show */
|
|
2789
|
+
visibleFields?: string[] | undefined;
|
|
2790
|
+
}
|
|
2791
|
+
export declare enum PropertyDefinitionReferenceFlags {
|
|
2792
|
+
None = 0,
|
|
2793
|
+
Contextual = 1,
|
|
2794
|
+
Readonly = 2,
|
|
2795
|
+
Hidden = 4
|
|
2796
|
+
}
|
|
2797
|
+
export interface OmniSearchExtendedFieldDto extends OmniSearchFieldDto {
|
|
2798
|
+
/** True id the field is an inner field of a lookup.
|
|
2799
|
+
Useful in UI fields configuration, in order to
|
|
2800
|
+
display innerfields as grouped ones */
|
|
2801
|
+
isInnerField?: boolean;
|
|
2802
|
+
}
|
|
2803
|
+
/** Dto that contains Values of properties for an owner. */
|
|
2804
|
+
export interface PropertiesValueListDto {
|
|
2805
|
+
/** Owner of the properties */
|
|
2806
|
+
id?: string | undefined;
|
|
2807
|
+
/** version of the properties */
|
|
2808
|
+
version?: number;
|
|
2809
|
+
propertyValues?: PropertyValueDto[] | undefined;
|
|
2810
|
+
/** Really old version of the properties, it should not be used anymoer. */
|
|
2811
|
+
serializedValues?: string | undefined;
|
|
2812
|
+
/** TElls if the actual value of the properties are valid or not. */
|
|
2813
|
+
isValid?: boolean;
|
|
2814
|
+
}
|
|
2815
|
+
/** Single value for as single property, remember that a property can have multiple values so value is a for this object. */
|
|
2816
|
+
export interface PropertyValueDto {
|
|
2817
|
+
definitionId?: string | undefined;
|
|
2818
|
+
/** This is the original Value property of the DTO, it represent the value of the
|
|
2819
|
+
property that can be set to a this owner or can be inherited from one of the ancestors. */
|
|
2820
|
+
value?: PropertyInnerValueDto | undefined;
|
|
2821
|
+
definitionOwners?: string[] | undefined;
|
|
2822
|
+
/** Id of the owner of the value, remember that if the
|
|
2823
|
+
Value owner is different from the property owner
|
|
2824
|
+
this value must be considered readonly because it is
|
|
2825
|
+
inherited from the property owner. */
|
|
2826
|
+
valueOwner?: string | undefined;
|
|
2827
|
+
isUpdated?: boolean;
|
|
2828
|
+
isMissing?: boolean;
|
|
2829
|
+
isNew?: boolean;
|
|
2830
|
+
/** This field identifies if the property definition is declared in an ancestor,
|
|
2831
|
+
or directly in the owner */
|
|
2832
|
+
isDefinitionInherited?: boolean;
|
|
2833
|
+
/** This property identify if the value is inherited from the property owner
|
|
2834
|
+
or is a value that is defined on the owner. */
|
|
2835
|
+
isValueInherited?: boolean;
|
|
2836
|
+
/** This is the value of the property that is defined on the property owner.
|
|
2837
|
+
Actually we cannot admit ovveride of the property so we do not expect
|
|
2838
|
+
in this first version to have this value different from AncestorInheritedValue */
|
|
2839
|
+
currentOwnerValue?: PropertyInnerValueDto | undefined;
|
|
2840
|
+
/** This is the value of the property that is inherited from one of the ancestors. Since
|
|
2841
|
+
overriding is not allowed if this value is different from null we will have CurrentOwnerValue
|
|
2842
|
+
null. */
|
|
2843
|
+
ancestorInheritedValue?: PropertyInnerValueDto | undefined;
|
|
2844
|
+
}
|
|
2845
|
+
export interface PropertyInnerValueDto {
|
|
2846
|
+
propertyDefinitionId?: string | undefined;
|
|
2847
|
+
fieldId?: string | undefined;
|
|
2848
|
+
hasNestedValues?: boolean;
|
|
2849
|
+
simpleValues?: any[] | undefined;
|
|
2850
|
+
nestedValues?: PropertyInnerValueDto[] | undefined;
|
|
2851
|
+
}
|
|
2852
|
+
export interface ContainerLayoutDto {
|
|
2853
|
+
id?: string | undefined;
|
|
2854
|
+
layout?: string | undefined;
|
|
2855
|
+
fields?: ContainerFieldDto[] | undefined;
|
|
2856
|
+
}
|
|
2857
|
+
export interface ContainerFieldDto {
|
|
2858
|
+
fieldId?: string | undefined;
|
|
2859
|
+
origin?: string | undefined;
|
|
2860
|
+
hidden?: boolean;
|
|
2861
|
+
disabled?: boolean;
|
|
2862
|
+
dataType?: string | undefined;
|
|
2863
|
+
headers?: {
|
|
2864
|
+
[key: string]: string;
|
|
2865
|
+
} | undefined;
|
|
2866
|
+
originHeaders?: {
|
|
2867
|
+
[key: string]: string;
|
|
2868
|
+
} | undefined;
|
|
2869
|
+
}
|
|
2870
|
+
export interface ContainerAllowedDocumentTypesDto {
|
|
2871
|
+
documentTypesRestrictionsEnabled?: boolean;
|
|
2872
|
+
untypedDocumentsAllowed?: boolean;
|
|
2873
|
+
/** List of DocumentTypeId */
|
|
2874
|
+
allowedDocumentTypeIds?: string[] | undefined;
|
|
2875
|
+
}
|
|
2876
|
+
export interface ContainerTemplateInfoDto extends BaseContainerInfoDto {
|
|
2877
|
+
documentClassesFullList?: string[] | undefined;
|
|
2878
|
+
documentClassId?: string | undefined;
|
|
2879
|
+
/** If template name has ";" between names,
|
|
2880
|
+
the container name created from this template should be restricted to this names */
|
|
2881
|
+
validNames?: string[] | undefined;
|
|
2882
|
+
/** If template has only one name, the name should be used as suggestion for the user */
|
|
2883
|
+
nameHint?: string | undefined;
|
|
2884
|
+
/** The metadata id of the template, when present */
|
|
2885
|
+
metadataId?: string | undefined;
|
|
2886
|
+
/** The label related to the metadata id, when present */
|
|
2887
|
+
label?: string | undefined;
|
|
2888
|
+
}
|
|
2889
|
+
export declare enum EContainerChildInfo {
|
|
2890
|
+
Undefined = 0,
|
|
2891
|
+
Container = 1,
|
|
2892
|
+
Document = 2
|
|
2893
|
+
}
|
|
2894
|
+
/** API Response Object. */
|
|
2895
|
+
export interface ResponseOfContainerChildrenInfoResponse extends JarvisResponse {
|
|
2896
|
+
/** The actual result of the operation. */
|
|
2897
|
+
data?: ContainerChildrenInfoResponse | undefined;
|
|
2898
|
+
}
|
|
2899
|
+
export interface ContainerChildrenInfoResponse {
|
|
2900
|
+
currentContainer?: ContainerPathInfoDto | undefined;
|
|
2901
|
+
/** Current container children */
|
|
2902
|
+
containers?: ContainerPathInfoDto[] | undefined;
|
|
2903
|
+
/** Current container documents */
|
|
2904
|
+
documents?: ContainerDocInfoDto[] | undefined;
|
|
2905
|
+
}
|
|
2906
|
+
export interface ContainerPathInfoDto {
|
|
2907
|
+
id?: string | undefined;
|
|
2908
|
+
name?: string | undefined;
|
|
2909
|
+
isSystemContainer?: boolean;
|
|
2910
|
+
pathSegmentList?: string[] | undefined;
|
|
2911
|
+
fullPath?: string | undefined;
|
|
2912
|
+
parentContainerId?: string | undefined;
|
|
2913
|
+
}
|
|
2914
|
+
export interface ContainerDocInfoDto {
|
|
2915
|
+
tags?: StyledTag[] | undefined;
|
|
2916
|
+
id?: string | undefined;
|
|
2917
|
+
previewBlobId?: string | undefined;
|
|
2918
|
+
title?: string | undefined;
|
|
2919
|
+
multifile?: boolean;
|
|
2920
|
+
fullPath?: string | undefined;
|
|
2921
|
+
defaultIconType?: string | undefined;
|
|
2922
|
+
protocolNumber?: string | undefined;
|
|
2923
|
+
documentTypeId?: string | undefined;
|
|
2924
|
+
documentTypeName?: string | undefined;
|
|
2925
|
+
tagIds?: string[] | undefined;
|
|
2926
|
+
}
|
|
2927
|
+
/** A tag with a name and a style */
|
|
2928
|
+
export interface StyledTag {
|
|
2929
|
+
id?: string | undefined;
|
|
2930
|
+
name?: string | undefined;
|
|
2931
|
+
style?: string | undefined;
|
|
2932
|
+
/** Whether the text of the tag should be displayd using a dark or a light color
|
|
2933
|
+
depending on the color of the background. */
|
|
2934
|
+
isTextDark?: boolean;
|
|
2935
|
+
}
|
|
2936
|
+
/** API Response Object. */
|
|
2937
|
+
export interface ResponseOfCheckContainerExistsResultDto extends JarvisResponse {
|
|
2938
|
+
/** The actual result of the operation. */
|
|
2939
|
+
data?: CheckContainerExistsResultDto | undefined;
|
|
2940
|
+
}
|
|
2941
|
+
export interface CheckContainerExistsResultDto {
|
|
2942
|
+
foundPaths?: ContainerPathInfoDto[] | undefined;
|
|
2943
|
+
missingPaths?: string[] | undefined;
|
|
2944
|
+
}
|
|
2945
|
+
export interface ContainerPathExistsRequest {
|
|
2946
|
+
path?: string | undefined;
|
|
2947
|
+
}
|
|
2948
|
+
/** API Response Object. */
|
|
2949
|
+
export interface ResponseOfCreateContainerFromPathResponse extends JarvisResponse {
|
|
2950
|
+
/** The actual result of the operation. */
|
|
2951
|
+
data?: CreateContainerFromPathResponse | undefined;
|
|
2952
|
+
}
|
|
2953
|
+
export interface CreateContainerFromPathResponse {
|
|
2954
|
+
/** Id of the last created container */
|
|
2955
|
+
id?: string | undefined;
|
|
2956
|
+
}
|
|
2957
|
+
/** This is more a ensure container, but name import suggests that it should be used along with the to import files inside the system. You use this command to ensure that a specific path like /bla/foo/bar exists and the LAST container has properties specified (if is present) */
|
|
2958
|
+
export interface ImportContainerV2Dto {
|
|
2959
|
+
/** Full path like /foo/bar/fex/xxx
|
|
2960
|
+
First level container should be already created and this does not allow loading files in system container
|
|
2961
|
+
only in regular container path. */
|
|
2962
|
+
fullPath?: string | undefined;
|
|
2963
|
+
/** Properties for container, remember that container usually has definition and / or values and this means
|
|
2964
|
+
that each instance in the list can have only definition and not values if we do not want to setup values
|
|
2965
|
+
on the container but only the property. */
|
|
2966
|
+
propertyValues?: ImportPropertyDefinitionAndValueDto[] | undefined;
|
|
2967
|
+
/** Layout for container. You can set layout type and visible fields for the container (if with grid-style)
|
|
2968
|
+
If Null, no layout will be set. */
|
|
2969
|
+
layout?: ImportContainerLayoutDto | undefined;
|
|
2970
|
+
}
|
|
2971
|
+
export interface ImportPropertyDefinitionAndValueDto {
|
|
2972
|
+
/** It can be one of the name in localized value for definition (be wary of ambiguity)
|
|
2973
|
+
or
|
|
2974
|
+
|
|
2975
|
+
Ambiguity is resolved in the context of the object, if you have two properties named foo
|
|
2976
|
+
you can still use foo if only one of the property is set in one of the ancestors of the
|
|
2977
|
+
object. */
|
|
2978
|
+
definitionName?: string | undefined;
|
|
2979
|
+
values?: any[] | undefined;
|
|
2980
|
+
required?: boolean;
|
|
2981
|
+
}
|
|
2982
|
+
export interface ImportContainerLayoutDto {
|
|
2983
|
+
layoutType?: string | undefined;
|
|
2984
|
+
fields?: ImportContainerLayoutFieldDto[] | undefined;
|
|
2985
|
+
}
|
|
2986
|
+
export interface ImportContainerLayoutFieldDto {
|
|
2987
|
+
fieldId?: string | undefined;
|
|
2988
|
+
origin?: string | undefined;
|
|
2989
|
+
disabled?: boolean;
|
|
2990
|
+
hidden?: boolean;
|
|
2991
|
+
}
|
|
2992
|
+
/** API Response Object. */
|
|
2993
|
+
export interface ResponseOfCreateChildContainerResponse extends JarvisResponse {
|
|
2994
|
+
/** The actual result of the operation. */
|
|
2995
|
+
data?: CreateChildContainerResponse | undefined;
|
|
2996
|
+
}
|
|
2997
|
+
export interface CreateChildContainerResponse {
|
|
2998
|
+
id?: string | undefined;
|
|
2999
|
+
}
|
|
3000
|
+
export interface ContainerCreateFromTemplateRequest {
|
|
3001
|
+
/** Id of the template to clone (Can be null) */
|
|
3002
|
+
templateId?: string | undefined;
|
|
3003
|
+
/** [MANDATORY] New Container name */
|
|
3004
|
+
name?: string | undefined;
|
|
3005
|
+
/** Container can contains files (default value TRUE) */
|
|
3006
|
+
admitFiles?: boolean;
|
|
3007
|
+
/** Container admit children containers (default value TRUE) */
|
|
3008
|
+
admitSubContainers?: boolean;
|
|
3009
|
+
}
|
|
3010
|
+
/** API Response Object. */
|
|
3011
|
+
export interface ResponseOfContainerRenameResponse extends JarvisResponse {
|
|
3012
|
+
/** The actual result of the operation. */
|
|
3013
|
+
data?: ContainerRenameResponse | undefined;
|
|
3014
|
+
}
|
|
3015
|
+
export interface ContainerRenameResponse {
|
|
3016
|
+
id?: string | undefined;
|
|
3017
|
+
}
|
|
3018
|
+
export interface ContainerRenameRequest {
|
|
3019
|
+
newName?: string | undefined;
|
|
3020
|
+
}
|
|
3021
|
+
/** API Response Object. */
|
|
3022
|
+
export interface ResponseOfContainerMoveResponse extends JarvisResponse {
|
|
3023
|
+
/** The actual result of the operation. */
|
|
3024
|
+
data?: ContainerMoveResponse | undefined;
|
|
3025
|
+
}
|
|
3026
|
+
export interface ContainerMoveResponse {
|
|
3027
|
+
id?: string | undefined;
|
|
3028
|
+
}
|
|
3029
|
+
export interface ContainerMoveRequest {
|
|
3030
|
+
newParentId?: string | undefined;
|
|
3031
|
+
}
|
|
3032
|
+
export interface ContainerPropertiesChangeRequest {
|
|
3033
|
+
/** Container can admit files */
|
|
3034
|
+
admitFiles?: boolean;
|
|
3035
|
+
/** Container can admit containers as children */
|
|
3036
|
+
admitSubContainers?: boolean;
|
|
3037
|
+
/** Default documentClassId for files on this container */
|
|
3038
|
+
documentClassId?: string | undefined;
|
|
3039
|
+
/** Container permission set */
|
|
3040
|
+
aceId?: string | undefined;
|
|
3041
|
+
properties?: {
|
|
3042
|
+
[key: string]: any;
|
|
3043
|
+
} | undefined;
|
|
3044
|
+
/** Stop properties inheritance from parent containers */
|
|
3045
|
+
stopInheritance?: boolean;
|
|
3046
|
+
}
|
|
3047
|
+
/** API Response Object. */
|
|
3048
|
+
export interface ResponseOfArchiveContainerResponse extends JarvisResponse {
|
|
3049
|
+
/** The actual result of the operation. */
|
|
3050
|
+
data?: ArchiveContainerResponse | undefined;
|
|
3051
|
+
}
|
|
3052
|
+
export interface ArchiveContainerResponse {
|
|
3053
|
+
/** Id of container */
|
|
3054
|
+
id?: string | undefined;
|
|
3055
|
+
/** Token to undo this operation */
|
|
3056
|
+
correlationToken?: string | undefined;
|
|
3057
|
+
}
|
|
3058
|
+
/** API Response Object. */
|
|
3059
|
+
export interface ResponseOfContainerUnarchiveResponse extends JarvisResponse {
|
|
3060
|
+
/** The actual result of the operation. */
|
|
3061
|
+
data?: ContainerUnarchiveResponse | undefined;
|
|
3062
|
+
}
|
|
3063
|
+
export interface ContainerUnarchiveResponse {
|
|
3064
|
+
/** ContainerId */
|
|
3065
|
+
id?: string | undefined;
|
|
3066
|
+
/** Token of the operation to restore */
|
|
3067
|
+
correlationToken?: string | undefined;
|
|
3068
|
+
}
|
|
3069
|
+
export interface ContainerUnarchiveRequest {
|
|
3070
|
+
/** key of the archive operation */
|
|
3071
|
+
correlationToken?: string | undefined;
|
|
3072
|
+
}
|
|
3073
|
+
/** Request to update Container metadata id */
|
|
3074
|
+
export interface UpdateContainerMetadataRequest {
|
|
3075
|
+
/** MetadataId should be an DocumentClassMetadataId like DocumentClassMetaData_X */
|
|
3076
|
+
metadataId?: string | undefined;
|
|
3077
|
+
}
|
|
3078
|
+
/** API Response Object. */
|
|
3079
|
+
export interface ResponseOfDocumentTypeListV2DtoOf extends JarvisResponse {
|
|
3080
|
+
/** The actual result of the operation. */
|
|
3081
|
+
data?: DocumentTypeListV2Dto[] | undefined;
|
|
3082
|
+
}
|
|
3083
|
+
export interface DocumentTypeListV2Dto {
|
|
3084
|
+
id?: string | undefined;
|
|
3085
|
+
name?: string | undefined;
|
|
3086
|
+
disabled?: boolean;
|
|
3087
|
+
tags?: string[] | undefined;
|
|
3088
|
+
multifile?: boolean;
|
|
3089
|
+
protocolNumberType?: ProtocolNumberType;
|
|
3090
|
+
protocolAsTitle?: boolean;
|
|
3091
|
+
protocolNumberPrefix?: string | undefined;
|
|
3092
|
+
protocolNumberPrefixLength?: number;
|
|
3093
|
+
lastModificationUser?: string | undefined;
|
|
3094
|
+
lastModify?: Date;
|
|
3095
|
+
workflowDefinitionId?: string | undefined;
|
|
3096
|
+
}
|
|
3097
|
+
export declare enum ProtocolNumberType {
|
|
3098
|
+
Optional = 0,
|
|
3099
|
+
Automatic = 1,
|
|
3100
|
+
Required = 2
|
|
3101
|
+
}
|
|
3102
|
+
/** IMPORTANT: all properties of this dto will be automapped to ImportDocumentInfoV2/> */
|
|
3103
|
+
export interface ImportDocumentInfoV2DtoBase {
|
|
3104
|
+
/** Document Type, it can be null if you do not want to import a specific
|
|
3105
|
+
document type and you want to create a generic document. */
|
|
3106
|
+
documentTypeId?: string | undefined;
|
|
3107
|
+
/** Mandatory when you insert new document, this is the title of the document. */
|
|
3108
|
+
title?: string | undefined;
|
|
3109
|
+
/** It must be different from null if you have Update set to true because
|
|
3110
|
+
you need to specify document to update. It must be null when you preload a document. */
|
|
3111
|
+
documentId?: string | undefined;
|
|
3112
|
+
/** Useful only if you are creating a document with a DocumentTypeId that
|
|
3113
|
+
contains more than one document template. */
|
|
3114
|
+
selectedTemplateId?: string | undefined;
|
|
3115
|
+
/** If DocumentTypeId is null, we can still create the
|
|
3116
|
+
document as multifile setting this property to true. */
|
|
3117
|
+
multifile?: boolean;
|
|
3118
|
+
/** Old password field, used only if you are loading a pdf with password and
|
|
3119
|
+
you want to use the password to extract data with documentstore. */
|
|
3120
|
+
password?: string | undefined;
|
|
3121
|
+
/** Array of tags, it should contains name of the tag not id, real id will be remapped
|
|
3122
|
+
or created on the fly if needed. */
|
|
3123
|
+
tags?: string[] | undefined;
|
|
3124
|
+
/** This is needed if you specify Update false, because you need to tell
|
|
3125
|
+
to the system where you want to locate your document. You can, as an alternative,
|
|
3126
|
+
use ContainerFullPath.
|
|
3127
|
+
When Update is "true" this information will be ignored. */
|
|
3128
|
+
containerId?: string | undefined;
|
|
3129
|
+
/** This is an alternative way to specify container, instead that specifying the container id
|
|
3130
|
+
you can simply specify the full path of the container. If the full path does not exists
|
|
3131
|
+
it will be created.
|
|
3132
|
+
When Update is "true" this information will be ignored. */
|
|
3133
|
+
containerFullPath?: string | undefined;
|
|
3134
|
+
/** If true we are requesting an update of the document, you should specify a valid
|
|
3135
|
+
DocumentId as well as not specifying ContainerId */
|
|
3136
|
+
update?: boolean;
|
|
3137
|
+
publishDate?: Date;
|
|
3138
|
+
/** Old metadata information that are used with document class. */
|
|
3139
|
+
metadata?: {
|
|
3140
|
+
[key: string]: string;
|
|
3141
|
+
} | undefined;
|
|
3142
|
+
/** Document will be automatically published, set to True to avoid it. */
|
|
3143
|
+
skipPublish?: boolean;
|
|
3144
|
+
/** If true and Update is true,
|
|
3145
|
+
a new revision will be creted for the document to update
|
|
3146
|
+
only if document is in an approved state */
|
|
3147
|
+
addNewRevisionIfNeeded?: boolean;
|
|
3148
|
+
/** If new revision should be added,
|
|
3149
|
+
this parameter will be used as new revision date */
|
|
3150
|
+
newRevisionDate?: Date | undefined;
|
|
3151
|
+
/** If true revision 0 will be immediately approved */
|
|
3152
|
+
approveRevision?: boolean;
|
|
3153
|
+
/** if ApproveRevision is true it contains approval date. */
|
|
3154
|
+
approvalDate?: Date;
|
|
3155
|
+
/** if ApproveRevision is true it contains approval note. */
|
|
3156
|
+
approvalNote?: string | undefined;
|
|
3157
|
+
/** Used to force protocol number if you want to import a document with a specific document number.
|
|
3158
|
+
Remember to use ForceProtocolNumber if you are creating a document with automatic
|
|
3159
|
+
protocol number generation. */
|
|
3160
|
+
protocolNumber?: string | undefined;
|
|
3161
|
+
/** if true even if document has automatic protocol number generation and ProtocolNumber
|
|
3162
|
+
is different from null, that protocol number will be forced even if automatic generation is present. */
|
|
3163
|
+
forceProtocolNumber?: boolean;
|
|
3164
|
+
/** List of property values that you want to preload on document. Remember that each property definition
|
|
3165
|
+
should be already present in parent container/documenttype, or the import will fail. */
|
|
3166
|
+
propertyValues?: ImportPropertyValueDto[] | undefined;
|
|
3167
|
+
/** Document's abstract */
|
|
3168
|
+
abstract?: string | undefined;
|
|
3169
|
+
/** Sometimes we need to have a document starting from revision not 0, this will
|
|
3170
|
+
allow for the creation of a document in a certain revision, this means that
|
|
3171
|
+
we create an empty document, then force revision and finally add files.
|
|
3172
|
+
If value is null this means that we do not want to force revision. */
|
|
3173
|
+
initialRevision?: number | undefined;
|
|
3174
|
+
/** If InitialRevision is greater than zero we can use this field
|
|
3175
|
+
to set revision content. */
|
|
3176
|
+
initialRevisionNotes?: string | undefined;
|
|
3177
|
+
}
|
|
3178
|
+
/** This version of import document allows to upload file just specifying file names without FileId or BlobId. It is duty of the importer to load data into documenstore. IMPORTANT: all properties of this dto will be automapped to ImportDocumentInfoV2 */
|
|
3179
|
+
export interface ImportDocumentInfoV2Dto extends ImportDocumentInfoV2DtoBase {
|
|
3180
|
+
/** Files to load, specified as full file name */
|
|
3181
|
+
fileList?: ImportMultiFileInfoDto[] | undefined;
|
|
3182
|
+
/** if true, files will be deleted at the end of the import process */
|
|
3183
|
+
deleteFilesAfterImport?: boolean;
|
|
3184
|
+
/** True if you want to reference the file not loading into DocumentStore, it will use
|
|
3185
|
+
the Reference File functionalities. Remember JARVIS WILL NOT LOAD THIS FILE INTO THE
|
|
3186
|
+
DATABASE BUT WILL REFENCE IT FROM ACTUAL LOCATION.
|
|
3187
|
+
|
|
3188
|
+
If this parameter is true the parameter is not be
|
|
3189
|
+
used and it should be left to value false. */
|
|
3190
|
+
referenceFiles?: boolean;
|
|
3191
|
+
}
|
|
3192
|
+
export interface ImportDocumentRequest extends ImportDocumentInfoV2Dto {
|
|
3193
|
+
}
|
|
3194
|
+
/** This class is used to import multifile when the caller already loaded everything inside documentstore and wants to specify fileid and bloib id. */
|
|
3195
|
+
export interface ImportMultiFileInfoDto {
|
|
3196
|
+
/** Id of the file we want to update with new blob version.
|
|
3197
|
+
If null means there's NO update, but new file creation.
|
|
3198
|
+
This must be null when document is to be created because
|
|
3199
|
+
all id must the generated inside the import service. */
|
|
3200
|
+
fileId?: string | undefined;
|
|
3201
|
+
/** Full path for the binary file to import */
|
|
3202
|
+
fullName?: string | undefined;
|
|
3203
|
+
/** If not null, will be used as fileName, in other cases will be taken by FullName
|
|
3204
|
+
USE GetFileName for calculated fileName */
|
|
3205
|
+
customFileName?: string | undefined;
|
|
3206
|
+
publishDate?: Date;
|
|
3207
|
+
/** If you want to import this file and you already have the PDF version, you can specify
|
|
3208
|
+
the file representing pdf format in this property. PAY ATTENTION, if is
|
|
3209
|
+
true this wil will also be referenced and not internally loaded in the document store.
|
|
3210
|
+
|
|
3211
|
+
IMPORTANT: in this first version you can specify a valid value only if
|
|
3212
|
+
is true. */
|
|
3213
|
+
pdfFile?: string | undefined;
|
|
3214
|
+
}
|
|
3215
|
+
/** Allows to import properties value for documents/card or any other "owners" not ancestors. */
|
|
3216
|
+
export interface ImportPropertyValueDto {
|
|
3217
|
+
/** It can be one of the name in localized value for definition (be wary of ambiguity)
|
|
3218
|
+
or
|
|
3219
|
+
|
|
3220
|
+
Ambiguity is resolved in the context of the object, if you have two properties named foo
|
|
3221
|
+
you can still use foo if only one of the property is set in one of the ancestors of the
|
|
3222
|
+
object. */
|
|
3223
|
+
definitionName?: string | undefined;
|
|
3224
|
+
/** Value for the properties. */
|
|
3225
|
+
values?: any[] | undefined;
|
|
3226
|
+
}
|
|
3227
|
+
/** API Response Object. */
|
|
3228
|
+
export interface ResponseOfDocumentResponse extends JarvisResponse {
|
|
3229
|
+
/** The actual result of the operation. */
|
|
3230
|
+
data?: DocumentResponse | undefined;
|
|
3231
|
+
}
|
|
3232
|
+
/** Info related to a document */
|
|
3233
|
+
export interface BaseDocumentResponse {
|
|
3234
|
+
/** The unique id that identifies the document */
|
|
3235
|
+
id?: string | undefined;
|
|
3236
|
+
/** The id of the container in which the document is */
|
|
3237
|
+
containerId?: string | undefined;
|
|
3238
|
+
/** The name of the document */
|
|
3239
|
+
name?: string | undefined;
|
|
3240
|
+
/** A text describing the content of the document */
|
|
3241
|
+
abstract?: string | undefined;
|
|
3242
|
+
/** If the document was marked as a favourite by the user */
|
|
3243
|
+
isFavourite?: boolean;
|
|
3244
|
+
/** If the document has been published.
|
|
3245
|
+
Published document will appear in searches. */
|
|
3246
|
+
isPublished?: boolean;
|
|
3247
|
+
/** If the document MAY contain more than one file.
|
|
3248
|
+
A document can be a multifile even if it contains zero files. */
|
|
3249
|
+
isMultiFile?: boolean;
|
|
3250
|
+
/** A list of tags associated to the document */
|
|
3251
|
+
tags?: string[] | undefined;
|
|
3252
|
+
/** The unique protocol number assigned to the document.
|
|
3253
|
+
A protocol number can only be assigned to one document. */
|
|
3254
|
+
protocolNumber?: string | undefined;
|
|
3255
|
+
/** The document type */
|
|
3256
|
+
documentType?: string | undefined;
|
|
3257
|
+
/** If the doucment cannot be modified */
|
|
3258
|
+
isLocked?: boolean;
|
|
3259
|
+
/** The user id of the user who locked the file */
|
|
3260
|
+
lockUser?: string | undefined;
|
|
3261
|
+
/** The reason why the file has been locked */
|
|
3262
|
+
lockReason?: string | undefined;
|
|
3263
|
+
/** When the file was last modified */
|
|
3264
|
+
lastModified?: Date;
|
|
3265
|
+
/** The user id of the user who last modified this file */
|
|
3266
|
+
lastModifiedByUser?: string | undefined;
|
|
3267
|
+
/** A list of FileInfoDto describing the files contained in the document */
|
|
3268
|
+
filesInfo?: FileInfoDto[] | undefined;
|
|
3269
|
+
/** An object contaning an history of activities related to the document */
|
|
3270
|
+
history?: HistoryDto | undefined;
|
|
3271
|
+
/** Information about the fascicle generated from the document */
|
|
3272
|
+
fascicleInfo?: FascicleInfoDto | undefined;
|
|
3273
|
+
/** If the document is being modified by someone */
|
|
3274
|
+
isInDraftMode?: boolean;
|
|
3275
|
+
/** If the current user can access the current draft */
|
|
3276
|
+
canAccessDraft?: boolean;
|
|
3277
|
+
/** If the file is in draft and it has been modified in some way */
|
|
3278
|
+
isDirty?: boolean;
|
|
3279
|
+
/** All the permissions the user has regarding this document */
|
|
3280
|
+
permissions?: Permissions2 | undefined;
|
|
3281
|
+
/** Ordered list of the path elements of the document */
|
|
3282
|
+
pathSegments?: ContainerPathSegmentDto2[] | undefined;
|
|
3283
|
+
/** Full name of the user who made the draft */
|
|
3284
|
+
inDraftByUserFullName?: string | undefined;
|
|
3285
|
+
/** Id of the user who made the draft */
|
|
3286
|
+
inDraftByUserId?: string | undefined;
|
|
3287
|
+
/** When the draft was started */
|
|
3288
|
+
draftStartedAt?: Date | undefined;
|
|
3289
|
+
/** Whether the document has been archived */
|
|
3290
|
+
archived?: boolean;
|
|
3291
|
+
/** When the document has been published */
|
|
3292
|
+
publishStamp?: Date;
|
|
3293
|
+
/** If the document is in a system container, with its limitations */
|
|
3294
|
+
isInSystemContainer?: boolean;
|
|
3295
|
+
/** The current workflow state of the document, if present */
|
|
3296
|
+
workflow?: DocumentWorkflowDto | undefined;
|
|
3297
|
+
/** Kind of icon that can used to represnet the document */
|
|
3298
|
+
iconType?: string | undefined;
|
|
3299
|
+
/** If the document can be published */
|
|
3300
|
+
canBePublished?: boolean;
|
|
3301
|
+
/** When the document was first created */
|
|
3302
|
+
creationDate?: Date;
|
|
3303
|
+
/** The id of the user who created this document */
|
|
3304
|
+
creationUser?: string | undefined;
|
|
3305
|
+
/** If the document has been copied from another one, the id of that document */
|
|
3306
|
+
originalDocumentId?: string | undefined;
|
|
3307
|
+
/** Links attached to document */
|
|
3308
|
+
links?: LinkDetailDto[] | undefined;
|
|
3309
|
+
/** Jarvis fields in a public dto. */
|
|
3310
|
+
fields?: JarvisFieldValuePublicDto[] | undefined;
|
|
3311
|
+
/** Nested fields. */
|
|
3312
|
+
nestedFields?: JarvisFieldValuePublicDto[] | undefined;
|
|
3313
|
+
}
|
|
3314
|
+
export interface DocumentResponse extends BaseDocumentResponse {
|
|
3315
|
+
/** An object containing all the different kind of properties of the document */
|
|
3316
|
+
properties?: DocumentPropertiesDto | undefined;
|
|
3317
|
+
/** The full name of the user who created this document */
|
|
3318
|
+
creationUserFullName?: string | undefined;
|
|
3319
|
+
/** The full name of the user who last modified this file */
|
|
3320
|
+
lastModifiedByUserFullName?: string | undefined;
|
|
3321
|
+
/** A list of tags associated to the document, together with their style */
|
|
3322
|
+
styledTags?: StyledTag[] | undefined;
|
|
3323
|
+
}
|
|
3324
|
+
export interface DocumentPropertiesDto {
|
|
3325
|
+
/** Metadata associated with the document */
|
|
3326
|
+
metaData?: MetaDataDto[] | undefined;
|
|
3327
|
+
/** Formdata associated with the document, an earlier version of the document Properties */
|
|
3328
|
+
formDataGroups?: FormDataGroupDto[] | undefined;
|
|
3329
|
+
/** Custom properties associated with the document */
|
|
3330
|
+
properties?: PropertiesValueListDto2 | undefined;
|
|
3331
|
+
}
|
|
3332
|
+
export interface MetaDataDto {
|
|
3333
|
+
id?: string | undefined;
|
|
3334
|
+
key?: string | undefined;
|
|
3335
|
+
label?: string | undefined;
|
|
3336
|
+
value?: string | undefined;
|
|
3337
|
+
/** The external service from which this property is populated */
|
|
3338
|
+
externalService?: string | undefined;
|
|
3339
|
+
isSystemMetaData?: boolean;
|
|
3340
|
+
/** If this field must be set for this document */
|
|
3341
|
+
mandatory?: boolean;
|
|
3342
|
+
/** Whether or not the value of this field may be changed */
|
|
3343
|
+
readOnly?: boolean;
|
|
3344
|
+
}
|
|
3345
|
+
export interface FormDataGroupDto {
|
|
3346
|
+
/** The title of this formData group */
|
|
3347
|
+
title?: string | undefined;
|
|
3348
|
+
/** List of all the associated formData ids */
|
|
3349
|
+
formDataList?: string[] | undefined;
|
|
3350
|
+
/** A dictionary with the following structure:
|
|
3351
|
+
key: FormDataId
|
|
3352
|
+
value: A boolean indicating whether or not the formData is valid */
|
|
3353
|
+
formDataListValidity?: {
|
|
3354
|
+
[key: string]: boolean;
|
|
3355
|
+
} | undefined;
|
|
3356
|
+
/** List of formData values, related to FormDataList */
|
|
3357
|
+
formDataValues?: FormDataDto[] | undefined;
|
|
3358
|
+
/** AspectId, if "Aspect Mode" is enabled, null otherwise */
|
|
3359
|
+
aspectId?: string | undefined;
|
|
3360
|
+
/** Contains, for each formDataId (key) a boolean value that tells if that formData is disabled */
|
|
3361
|
+
formDataListDisabled?: {
|
|
3362
|
+
[key: string]: boolean;
|
|
3363
|
+
} | undefined;
|
|
3364
|
+
}
|
|
3365
|
+
export interface FormDataDto {
|
|
3366
|
+
title?: string | undefined;
|
|
3367
|
+
/** Id of the formData Value */
|
|
3368
|
+
formDataId?: string | undefined;
|
|
3369
|
+
/** Id f the formData template */
|
|
3370
|
+
definitionId?: string | undefined;
|
|
3371
|
+
/** Json string of data values */
|
|
3372
|
+
jsonData?: string | undefined;
|
|
3373
|
+
/** Actual version */
|
|
3374
|
+
version?: number;
|
|
3375
|
+
}
|
|
3376
|
+
export interface PropertiesValueListDto2 {
|
|
3377
|
+
id?: string | undefined;
|
|
3378
|
+
version?: number;
|
|
3379
|
+
/** The actual list of properties values */
|
|
3380
|
+
propertyValues?: PropertyValueDto2[] | undefined;
|
|
3381
|
+
isValid?: boolean;
|
|
3382
|
+
}
|
|
3383
|
+
export interface PropertyValueDto2 {
|
|
3384
|
+
/** The id of the property definition */
|
|
3385
|
+
definitionId?: string | undefined;
|
|
3386
|
+
/** The value of the property.
|
|
3387
|
+
A complex object tha may contain nested values. */
|
|
3388
|
+
value?: PropertyInnerValueDto2 | undefined;
|
|
3389
|
+
/** The owners of the definition of this property. */
|
|
3390
|
+
definitionOwners?: string[] | undefined;
|
|
3391
|
+
/** The owner of this property.
|
|
3392
|
+
Used to determine if this property was inherited and how. */
|
|
3393
|
+
valueOwner?: string | undefined;
|
|
3394
|
+
}
|
|
3395
|
+
export interface PropertyInnerValueDto2 {
|
|
3396
|
+
/** The id of the property definition */
|
|
3397
|
+
propertyDefinitionId?: string | undefined;
|
|
3398
|
+
fieldId?: string | undefined;
|
|
3399
|
+
/** If the value contains any nested values */
|
|
3400
|
+
hasNestedValues?: boolean;
|
|
3401
|
+
/** A list of objects containg the values of this property */
|
|
3402
|
+
simpleValues?: any[] | undefined;
|
|
3403
|
+
/** All the nested values of this properties */
|
|
3404
|
+
nestedValues?: PropertyInnerValueDto2[] | undefined;
|
|
3405
|
+
}
|
|
3406
|
+
export interface FileInfoDto {
|
|
3407
|
+
/** File name */
|
|
3408
|
+
name?: string | undefined;
|
|
3409
|
+
/** File extension */
|
|
3410
|
+
extension?: string | undefined;
|
|
3411
|
+
fileId?: string | undefined;
|
|
3412
|
+
/** Id of the blob content of the file, different from FileId */
|
|
3413
|
+
blobId?: string | undefined;
|
|
3414
|
+
/** The uri of the blob content of the file */
|
|
3415
|
+
blobUri?: string | undefined;
|
|
3416
|
+
fileType?: string | undefined;
|
|
3417
|
+
mimeType?: string | undefined;
|
|
3418
|
+
/** Id of the last revision of the file */
|
|
3419
|
+
lastVersion?: string | undefined;
|
|
3420
|
+
/** Whether this is the main file of the document */
|
|
3421
|
+
isMain?: boolean;
|
|
3422
|
+
/** If the file has a pdf version */
|
|
3423
|
+
hasPdf?: boolean;
|
|
3424
|
+
/** The order of the file inside the document */
|
|
3425
|
+
order?: number;
|
|
3426
|
+
/** Whether the file has been added by a user or generated by the system */
|
|
3427
|
+
generated?: boolean;
|
|
3428
|
+
archived?: boolean;
|
|
3429
|
+
/** A list of all the attachments of the file
|
|
3430
|
+
e.g. The attachments of a mail or the contents of a zip file */
|
|
3431
|
+
attachments?: AttachmentDto[] | undefined;
|
|
3432
|
+
/** If this file is a fascicle, the title of the fascicle */
|
|
3433
|
+
fascicleName?: string | undefined;
|
|
3434
|
+
/** If this file i sthe fascicle of the document */
|
|
3435
|
+
isFascicle?: boolean;
|
|
3436
|
+
/** When this file was added to the document */
|
|
3437
|
+
addedStamp?: Date;
|
|
3438
|
+
/** The id of the file to use as a preview for the fascicle.
|
|
3439
|
+
This could be any file, it is not constrained to one of the document files */
|
|
3440
|
+
fasciclePreviewFileId?: string | undefined;
|
|
3441
|
+
/** The id of the blob to use as a preview for the fascicle.
|
|
3442
|
+
This could be any blob, it is not constrained to one of the document blobs */
|
|
3443
|
+
fasciclePreviewBlobId?: string | undefined;
|
|
3444
|
+
/** When present, the size of the document.
|
|
3445
|
+
If this property is null, this DOES NOT mean that the file is empty.
|
|
3446
|
+
Use this information only when it's not null. */
|
|
3447
|
+
size?: number | undefined;
|
|
3448
|
+
}
|
|
3449
|
+
export interface AttachmentDto {
|
|
3450
|
+
/** The uniue id identifying this attachment */
|
|
3451
|
+
attachmentId?: string | undefined;
|
|
3452
|
+
/** The id of the document which contains this attachment */
|
|
3453
|
+
documentId?: string | undefined;
|
|
3454
|
+
/** The name of the the file which contains this attachment */
|
|
3455
|
+
fileName?: string | undefined;
|
|
3456
|
+
}
|
|
3457
|
+
export interface HistoryDto {
|
|
3458
|
+
/** A list of all the activies related to the workflow of this document
|
|
3459
|
+
Each one may have other nested activies related to all the changes
|
|
3460
|
+
made to the document while it was in that state */
|
|
3461
|
+
activities?: FlowActivityDto[] | undefined;
|
|
3462
|
+
}
|
|
3463
|
+
export interface ActivityAuditDto {
|
|
3464
|
+
/** The name of the action the user made */
|
|
3465
|
+
action?: string | undefined;
|
|
3466
|
+
/** When the activity was made */
|
|
3467
|
+
issuedAt?: Date;
|
|
3468
|
+
/** The id of the user who issued the action */
|
|
3469
|
+
issuedBy?: string | undefined;
|
|
3470
|
+
/** The full name of the user who issued the action */
|
|
3471
|
+
issuedByFullName?: string | undefined;
|
|
3472
|
+
/** If the action was responsible for a change in the workflow state of the document */
|
|
3473
|
+
isStatusChanged?: boolean;
|
|
3474
|
+
/** If present, the name of the current revision */
|
|
3475
|
+
revision?: string | undefined;
|
|
3476
|
+
/** An incrementing id useful to sort activities.
|
|
3477
|
+
Activies with a same Checkpoint are the result of a single action made by the user. */
|
|
3478
|
+
checkPoint?: number;
|
|
3479
|
+
/** A dictionary containg custom additional information related to an activity.
|
|
3480
|
+
e.g. Information on the file that was added to the document */
|
|
3481
|
+
additionalInfo?: {
|
|
3482
|
+
[key: string]: any;
|
|
3483
|
+
} | undefined;
|
|
3484
|
+
}
|
|
3485
|
+
export interface FlowActivityDto extends ActivityAuditDto {
|
|
3486
|
+
/** A list of all the activies of the document while in this workflow state */
|
|
3487
|
+
activities?: ActivityAuditDto[] | undefined;
|
|
3488
|
+
}
|
|
3489
|
+
export interface FascicleInfoDto {
|
|
3490
|
+
/** The fascicle title */
|
|
3491
|
+
title?: string | undefined;
|
|
3492
|
+
fileId?: string | undefined;
|
|
3493
|
+
blobId?: string | undefined;
|
|
3494
|
+
blobUri?: string | undefined;
|
|
3495
|
+
/** An ordered list of the files the fascicle is built out of */
|
|
3496
|
+
orderedFilesId?: string[] | undefined;
|
|
3497
|
+
/** The id of the file used as a preview for the fascicle.
|
|
3498
|
+
This may be a file outside of the document. */
|
|
3499
|
+
previewFileId?: string | undefined;
|
|
3500
|
+
}
|
|
3501
|
+
export interface Permissions2 {
|
|
3502
|
+
none?: boolean;
|
|
3503
|
+
canRead?: boolean;
|
|
3504
|
+
canWrite?: boolean;
|
|
3505
|
+
canArchive?: boolean;
|
|
3506
|
+
}
|
|
3507
|
+
export interface ContainerPathSegmentDto2 {
|
|
3508
|
+
/** The id of the container */
|
|
3509
|
+
containerId?: string | undefined;
|
|
3510
|
+
/** The name of the container */
|
|
3511
|
+
name?: string | undefined;
|
|
3512
|
+
/** Whether the container has been archived or not */
|
|
3513
|
+
archived?: boolean;
|
|
3514
|
+
/** If the container is a system container, with all its limitations */
|
|
3515
|
+
isSystem?: boolean;
|
|
3516
|
+
}
|
|
3517
|
+
export interface DocumentWorkflowDto {
|
|
3518
|
+
/** The name of the actual workflow state */
|
|
3519
|
+
actualState?: string | undefined;
|
|
3520
|
+
/** The id of the workflow associated with the document */
|
|
3521
|
+
workflowId?: string | undefined;
|
|
3522
|
+
/** If present, due date associated with the current workflow state */
|
|
3523
|
+
dueDate?: Date | undefined;
|
|
3524
|
+
/** An incrementing integer representing the current revision number */
|
|
3525
|
+
revision?: number;
|
|
3526
|
+
}
|
|
3527
|
+
export interface LinkDetailDto {
|
|
3528
|
+
linkDefinitionId?: string | undefined;
|
|
3529
|
+
targetId?: string | undefined;
|
|
3530
|
+
}
|
|
3531
|
+
export interface JarvisFieldValuePublicDto {
|
|
3532
|
+
id?: string | undefined;
|
|
3533
|
+
/** Field can be single valued or multi valued, but we do not know in advance, so each field is always
|
|
3534
|
+
returned as an array */
|
|
3535
|
+
values?: any[] | undefined;
|
|
3536
|
+
}
|
|
3537
|
+
/** API Response Object. */
|
|
3538
|
+
export interface ResponseOfDocumentDetailResponse extends JarvisResponse {
|
|
3539
|
+
/** The actual result of the operation. */
|
|
3540
|
+
data?: DocumentDetailResponse | undefined;
|
|
3541
|
+
}
|
|
3542
|
+
/** This is the same as DocumentResponse but the properties are sent as a plain dictionary of values. */
|
|
3543
|
+
export interface DocumentDetailResponse extends BaseDocumentResponse {
|
|
3544
|
+
/** Document properties as a plain dictionary of simple values */
|
|
3545
|
+
properties?: {
|
|
3546
|
+
[key: string]: any;
|
|
3547
|
+
} | undefined;
|
|
3548
|
+
}
|
|
3549
|
+
export interface DocumentDetailRequestDto {
|
|
3550
|
+
/** The id of the document */
|
|
3551
|
+
documentId?: string | undefined;
|
|
3552
|
+
/** If we want the history of the document */
|
|
3553
|
+
history?: boolean;
|
|
3554
|
+
/** If we want the links of the document */
|
|
3555
|
+
includeLinks?: boolean;
|
|
3556
|
+
/** If true will include a special property called nestedFields that contains all
|
|
3557
|
+
navigation fields that are associated to this work task. All value contained in
|
|
3558
|
+
that property are not owned by this work task but are derived by connecting fields
|
|
3559
|
+
with omnisearch values. */
|
|
3560
|
+
includeNestedFields?: boolean;
|
|
3561
|
+
}
|
|
3562
|
+
/** Add a new Revision if needed. */
|
|
3563
|
+
export interface AddNewRevisionIfNeededRequest {
|
|
3564
|
+
/** Notes */
|
|
3565
|
+
notes?: string | undefined;
|
|
3566
|
+
/** New revision date, if null Now() will be used. */
|
|
3567
|
+
addRevisionDate?: Date | undefined;
|
|
3568
|
+
}
|
|
3569
|
+
/** Approve and Publish the current revision */
|
|
3570
|
+
export interface ApproveRevisionRequest {
|
|
3571
|
+
/** Notes */
|
|
3572
|
+
notes?: string | undefined;
|
|
3573
|
+
/** Approval Date, if null Now() will be used. */
|
|
3574
|
+
approvalDate?: Date | undefined;
|
|
3575
|
+
}
|
|
3576
|
+
/** Request that allows to perform multiple actions on a single document Instead of having multiple API calls. Each property represents an action that can be performed on the document. Operation order is from Top to Bottom. */
|
|
3577
|
+
export interface UpdateDocumentRequest {
|
|
3578
|
+
/** Document Id */
|
|
3579
|
+
id?: string | undefined;
|
|
3580
|
+
addNewRevisionIfNeeded?: AddNewRevisionIfNeededRequest | undefined;
|
|
3581
|
+
setTitle?: SetDocumentTitleRequest | undefined;
|
|
3582
|
+
setProtocolNumber?: SetDocumentProtocolNumberRequest | undefined;
|
|
3583
|
+
setAbstract?: SetDocumentAbstractRequest | undefined;
|
|
3584
|
+
setTags?: SetDocumentTagsRequest | undefined;
|
|
3585
|
+
/** Add or Updates Files */
|
|
3586
|
+
setFileList?: SetDocumentFileListRequest | undefined;
|
|
3587
|
+
approveRevision?: ApproveRevisionRequest | undefined;
|
|
3588
|
+
setProperties?: PropertiesUpdateValuesRequest | undefined;
|
|
3589
|
+
}
|
|
3590
|
+
/** Set / Update the document title */
|
|
3591
|
+
export interface SetDocumentTitleRequest {
|
|
3592
|
+
/** The New Document Title
|
|
3593
|
+
Required: empty title should not be allowed */
|
|
3594
|
+
title?: string | undefined;
|
|
3595
|
+
}
|
|
3596
|
+
/** Set / Update the Protocol Number */
|
|
3597
|
+
export interface SetDocumentProtocolNumberRequest {
|
|
3598
|
+
protocolNumber?: string | undefined;
|
|
3599
|
+
}
|
|
3600
|
+
/** Set / Update the document Abstract */
|
|
3601
|
+
export interface SetDocumentAbstractRequest {
|
|
3602
|
+
/** The new document Abstract */
|
|
3603
|
+
abstract?: string | undefined;
|
|
3604
|
+
}
|
|
3605
|
+
/** Set / Update the document Tags */
|
|
3606
|
+
export interface SetDocumentTagsRequest {
|
|
3607
|
+
/** The new document Tags */
|
|
3608
|
+
tags?: string[] | undefined;
|
|
3609
|
+
}
|
|
3610
|
+
/** Add New files / Upade already existing files */
|
|
3611
|
+
export interface SetDocumentFileListRequest {
|
|
3612
|
+
/** Files to load, specified as full file name */
|
|
3613
|
+
fileList?: ImportMultiFileInfoDto[] | undefined;
|
|
3614
|
+
/** if true, files will be deleted at the end of the import process */
|
|
3615
|
+
deleteFilesAfterImport?: boolean;
|
|
3616
|
+
/** True if you want to reference the file not loading into DocumentStore, it will use
|
|
3617
|
+
the Reference File functionalities. Remember JARVIS WILL NOT LOAD THIS FILE INTO THE
|
|
3618
|
+
DATABASE BUT WILL REFENCE IT FROM ACTUAL LOCATION.
|
|
3619
|
+
|
|
3620
|
+
If this parameter is true the parameter is not be
|
|
3621
|
+
used and it should be left to value false. */
|
|
3622
|
+
referenceFiles?: boolean;
|
|
3623
|
+
}
|
|
3624
|
+
export interface SetDocumentMetadataValuesRequest {
|
|
3625
|
+
/** Key = DocumentClassMetaDataId (DocumentClassMetaData_X)
|
|
3626
|
+
Value = string value */
|
|
3627
|
+
metaData?: {
|
|
3628
|
+
[key: string]: string;
|
|
3629
|
+
} | undefined;
|
|
3630
|
+
}
|
|
3631
|
+
/** API Response Object. */
|
|
3632
|
+
export interface ResponseOfPermalink extends JarvisResponse {
|
|
3633
|
+
/** The actual result of the operation. */
|
|
3634
|
+
data?: Permalink | undefined;
|
|
3635
|
+
}
|
|
3636
|
+
/** This is the class stored in database to save permalink. */
|
|
3637
|
+
export interface Permalink {
|
|
3638
|
+
id?: string | undefined;
|
|
3639
|
+
/** This is the internal jarvis id that is the destination
|
|
3640
|
+
of the permalink. */
|
|
3641
|
+
jarvisId?: string | undefined;
|
|
3642
|
+
/** Some link, as files, can have a subtype where the subtype determines if it is
|
|
3643
|
+
a download or a stream. As an example we can have File_1 as Subtype streaming or subtype download. */
|
|
3644
|
+
subType?: string | undefined;
|
|
3645
|
+
/** generic bag of properties. */
|
|
3646
|
+
attributes?: {
|
|
3647
|
+
[key: string]: string;
|
|
3648
|
+
} | undefined;
|
|
3649
|
+
}
|
|
3650
|
+
export interface CreatePermalinkRequest {
|
|
3651
|
+
jarvisId?: string | undefined;
|
|
3652
|
+
subType?: string | undefined;
|
|
3653
|
+
attributes?: {
|
|
3654
|
+
[key: string]: string;
|
|
3655
|
+
} | undefined;
|
|
3656
|
+
}
|
|
3657
|
+
/** API Response Object. */
|
|
3658
|
+
export interface ResponseOfUri extends JarvisResponse {
|
|
3659
|
+
/** The actual result of the operation. */
|
|
3660
|
+
data?: string | undefined;
|
|
3661
|
+
}
|
|
3662
|
+
/** API Response Object. */
|
|
3663
|
+
export interface ResponseOfSearchResultResponse extends JarvisResponse {
|
|
3664
|
+
/** The actual result of the operation. */
|
|
3665
|
+
data?: SearchResultResponse | undefined;
|
|
3666
|
+
}
|
|
3667
|
+
export interface SearchResultResponse {
|
|
3668
|
+
/** Facets that can be used to further refine the search */
|
|
3669
|
+
metadataFacets?: SearchResultMetadataFacets[] | undefined;
|
|
3670
|
+
/** Documents found on search */
|
|
3671
|
+
documents?: SearchResultDocument[] | undefined;
|
|
3672
|
+
/** Current page */
|
|
3673
|
+
page?: number;
|
|
3674
|
+
/** Total found documents */
|
|
3675
|
+
total?: number;
|
|
3676
|
+
}
|
|
3677
|
+
export interface SearchResultMetadataFacets {
|
|
3678
|
+
/** Facet values for this metadata property */
|
|
3679
|
+
facets?: SearchResultFacet[] | undefined;
|
|
3680
|
+
/** Metadata id */
|
|
3681
|
+
metadataId?: string | undefined;
|
|
3682
|
+
/** Type of the metadata */
|
|
3683
|
+
metadataType?: SearchResultFacetType;
|
|
3684
|
+
/** Descriptive name, not localized */
|
|
3685
|
+
descriptiveName?: string | undefined;
|
|
3686
|
+
/** The kind of facet */
|
|
3687
|
+
facetType?: string | undefined;
|
|
3688
|
+
/** Localized name, if available */
|
|
3689
|
+
localizedName?: {
|
|
3690
|
+
[key: string]: string;
|
|
3691
|
+
} | undefined;
|
|
3692
|
+
/** Color to display the tag in */
|
|
3693
|
+
uiColorName?: string | undefined;
|
|
3694
|
+
/** Order in which to show the facet */
|
|
3695
|
+
order?: number;
|
|
3696
|
+
/** If this must be hidden by default */
|
|
3697
|
+
hide?: boolean;
|
|
3698
|
+
/** If not zero, total number of documents that can be filtered using this facet */
|
|
3699
|
+
total?: number;
|
|
3700
|
+
}
|
|
3701
|
+
export interface SearchResultFacet {
|
|
3702
|
+
/** Id of the facet value */
|
|
3703
|
+
uniqueId?: string | undefined;
|
|
3704
|
+
/** Raw value of the facet */
|
|
3705
|
+
rawValue?: string | undefined;
|
|
3706
|
+
/** Key used to identify the facet */
|
|
3707
|
+
key?: string | undefined;
|
|
3708
|
+
/** Kind of metadata */
|
|
3709
|
+
metadataType?: SearchResultFacetType;
|
|
3710
|
+
/** Total number of documents corresponding to this facet value */
|
|
3711
|
+
count?: number;
|
|
3712
|
+
/** Description of the facet value */
|
|
3713
|
+
description?: string | undefined;
|
|
3714
|
+
/** Human readable version of the facet value, if present */
|
|
3715
|
+
displayValue?: string | undefined;
|
|
3716
|
+
/** If the facet has been used to filter the search results */
|
|
3717
|
+
filtering?: boolean;
|
|
3718
|
+
/** If the facet represents a range, minimum possible value for the facet */
|
|
3719
|
+
minDouble?: number;
|
|
3720
|
+
/** If the facet represents a range, max possible value for the facet */
|
|
3721
|
+
maxDouble?: number;
|
|
3722
|
+
}
|
|
3723
|
+
export declare enum SearchResultFacetType {
|
|
3724
|
+
Unknown = 0,
|
|
3725
|
+
Default = 1,
|
|
3726
|
+
FormDataString = 2,
|
|
3727
|
+
FormDataInt = 3,
|
|
3728
|
+
FormDataDate = 4,
|
|
3729
|
+
FormDataUdt = 5
|
|
3730
|
+
}
|
|
3731
|
+
export interface SearchResultDocument {
|
|
3732
|
+
documentId?: string | undefined;
|
|
3733
|
+
/** Tells me if the file is multifile */
|
|
3734
|
+
multiFile?: boolean;
|
|
3735
|
+
/** This is the default FileId for multifile documento or the
|
|
3736
|
+
single FileId for single file document */
|
|
3737
|
+
fileId?: string | undefined;
|
|
3738
|
+
/** This is the BlobId related to the FileId property. */
|
|
3739
|
+
blobId?: string | undefined;
|
|
3740
|
+
creationDate?: Date;
|
|
3741
|
+
publishDate?: Date | undefined;
|
|
3742
|
+
title?: string | undefined;
|
|
3743
|
+
protocolNumber?: string | undefined;
|
|
3744
|
+
fileName?: string | undefined;
|
|
3745
|
+
fileLength?: number;
|
|
3746
|
+
score?: number;
|
|
3747
|
+
mimeType?: string | undefined;
|
|
3748
|
+
tags?: string[] | undefined;
|
|
3749
|
+
tagIds?: string[] | undefined;
|
|
3750
|
+
publisher?: string | undefined;
|
|
3751
|
+
publisherId?: string | undefined;
|
|
3752
|
+
isFavorite?: boolean;
|
|
3753
|
+
path?: string | undefined;
|
|
3754
|
+
hightlights?: Hightlight[] | undefined;
|
|
3755
|
+
scoreExplained?: string | undefined;
|
|
3756
|
+
/** True if the document is returned from the search because
|
|
3757
|
+
the user is superadmin, but the document cannot be accessed */
|
|
3758
|
+
unpermitted?: boolean;
|
|
3759
|
+
/** Description of document content */
|
|
3760
|
+
abstract?: string | undefined;
|
|
3761
|
+
revision?: number;
|
|
3762
|
+
pathIdList?: string[] | undefined;
|
|
3763
|
+
documentTypeId?: string | undefined;
|
|
3764
|
+
}
|
|
3765
|
+
export interface Hightlight {
|
|
3766
|
+
page?: number;
|
|
3767
|
+
/** The highlight comes from a single page document. */
|
|
3768
|
+
singlePageDocument?: boolean;
|
|
3769
|
+
fieldName?: string | undefined;
|
|
3770
|
+
/** For multifile document this is the name of the file that contains the highlight. */
|
|
3771
|
+
fileName?: string | undefined;
|
|
3772
|
+
fileId?: number;
|
|
3773
|
+
matches?: string[] | undefined;
|
|
3774
|
+
score?: number;
|
|
3775
|
+
}
|
|
3776
|
+
export interface SearchResultRequest {
|
|
3777
|
+
/** Search term */
|
|
3778
|
+
term?: string | undefined;
|
|
3779
|
+
/** Search using wildcard character (Default TRUE)
|
|
3780
|
+
|
|
3781
|
+
this settings has 'AutomaticWildcard' as fallback value */
|
|
3782
|
+
useWildcard?: boolean;
|
|
3783
|
+
/** Number of results to skip */
|
|
3784
|
+
startIndex?: number;
|
|
3785
|
+
/** Number of results to take (default 100) */
|
|
3786
|
+
maxResults?: number;
|
|
3787
|
+
/** 'Or' or 'And' search */
|
|
3788
|
+
searchType?: string | undefined;
|
|
3789
|
+
/** Include unpublished documents */
|
|
3790
|
+
unpublishedIncluded?: boolean;
|
|
3791
|
+
/** Filter only favorites elements */
|
|
3792
|
+
restrictToFavorites?: boolean;
|
|
3793
|
+
/** Include Highlights on resutls */
|
|
3794
|
+
includeHighlights?: boolean;
|
|
3795
|
+
/** Max number of elements to return in the facets used to filter the results */
|
|
3796
|
+
maxNumberOfElementsInFacets?: number;
|
|
3797
|
+
/** Facets used to filter the results */
|
|
3798
|
+
facets?: SearchResultFacet[] | undefined;
|
|
3799
|
+
}
|
|
3800
|
+
/** API Response Object. */
|
|
3801
|
+
export interface ResponseOfSearchByOwnerResponse extends JarvisResponse {
|
|
3802
|
+
/** The actual result of the operation. */
|
|
3803
|
+
data?: SearchByOwnerResponse | undefined;
|
|
3804
|
+
}
|
|
3805
|
+
export interface SearchByOwnerResponse {
|
|
3806
|
+
/** Documents found on search */
|
|
3807
|
+
documents?: SearchResultDocument[] | undefined;
|
|
3808
|
+
}
|
|
3809
|
+
export interface SearchByOwnerRequest {
|
|
3810
|
+
/** Aggregate id of the owner of the searched documents */
|
|
3811
|
+
ownerId?: string | undefined;
|
|
3812
|
+
/** Id of the of the secodnary contenxt of the searched documents */
|
|
3813
|
+
secondaryOwnerId?: string | undefined;
|
|
3814
|
+
/** Text filter for the tile or abstract of the document */
|
|
3815
|
+
filter?: string | undefined;
|
|
3816
|
+
}
|
|
3817
|
+
export interface FileUploadResultDto {
|
|
3818
|
+
success?: boolean;
|
|
3819
|
+
/** Map of uploaded files.
|
|
3820
|
+
Key: file name
|
|
3821
|
+
Value: Uploaded file id */
|
|
3822
|
+
uploaded?: {
|
|
3823
|
+
[key: string]: string;
|
|
3824
|
+
} | undefined;
|
|
3825
|
+
/** List of file names with un unsuccessfull upload */
|
|
3826
|
+
errors?: string[] | undefined;
|
|
3827
|
+
}
|
|
3828
|
+
/** API Response Object. */
|
|
3829
|
+
export interface ResponseOfFileUploadResultDto extends JarvisResponse {
|
|
3830
|
+
/** The actual result of the operation. */
|
|
3831
|
+
data?: FileUploadResultDto | undefined;
|
|
3832
|
+
}
|
|
3833
|
+
/** API Response Object. */
|
|
3834
|
+
export interface ResponseOfTranslateIdResponse extends JarvisResponse {
|
|
3835
|
+
/** The actual result of the operation. */
|
|
3836
|
+
data?: TranslateIdResponse | undefined;
|
|
3837
|
+
}
|
|
3838
|
+
export interface TranslateIdResponse {
|
|
3839
|
+
translatedIdList?: TranslatedId[] | undefined;
|
|
3840
|
+
someEntitiesCannotBeTranslated?: boolean;
|
|
3841
|
+
}
|
|
3842
|
+
export interface TranslatedId {
|
|
3843
|
+
id?: string | undefined;
|
|
3844
|
+
title?: string | undefined;
|
|
3845
|
+
}
|
|
3846
|
+
export interface ComplexApiRequest {
|
|
3847
|
+
deadFieldWalking?: number | undefined;
|
|
3848
|
+
anotherToRemove?: number | undefined;
|
|
3849
|
+
newKidOnTheBlock?: number | undefined;
|
|
3850
|
+
inner?: ComplexInnerDto | undefined;
|
|
3851
|
+
inners?: ComplexInnerDto[] | undefined;
|
|
3852
|
+
}
|
|
3853
|
+
export interface ComplexInnerDto {
|
|
3854
|
+
innerDead?: number | undefined;
|
|
3855
|
+
innerAlive?: number;
|
|
3856
|
+
}
|
|
3857
|
+
/** Translate a series of id returning information about the id in question */
|
|
3858
|
+
export interface TranslateIdRequest {
|
|
3859
|
+
idList?: string[] | undefined;
|
|
3860
|
+
test?: number;
|
|
3861
|
+
}
|
|
3862
|
+
/** API Response Object. */
|
|
3863
|
+
export interface ResponseOfDictionaryOfStringAndSingleTranslatedId extends JarvisResponse {
|
|
3864
|
+
/** The actual result of the operation. */
|
|
3865
|
+
data?: {
|
|
3866
|
+
[key: string]: SingleTranslatedId;
|
|
3867
|
+
} | undefined;
|
|
3868
|
+
}
|
|
3869
|
+
export interface SingleTranslatedId {
|
|
3870
|
+
title?: string | undefined;
|
|
3871
|
+
}
|
|
3872
|
+
/** API Response Object. */
|
|
3873
|
+
export interface ResponseOfGetJarvisAppConfigurationResponseDto extends JarvisResponse {
|
|
3874
|
+
/** The actual result of the operation. */
|
|
3875
|
+
data?: GetJarvisAppConfigurationResponseDto | undefined;
|
|
3876
|
+
}
|
|
3877
|
+
/** DTO to manage feature flags and configurations for Jarvis Apps */
|
|
3878
|
+
export interface GetJarvisAppConfigurationResponseDto {
|
|
3879
|
+
/** Array of feature flags and relative configuration */
|
|
3880
|
+
featureFlags?: JarvisAppFeatureFlagDto[] | undefined;
|
|
3881
|
+
/** Custom configuration for the app */
|
|
3882
|
+
configuration?: JarvisAppConfigurationDto | undefined;
|
|
3883
|
+
}
|
|
3884
|
+
/** Class to enable a feature on Jarvis apps and their relative configuration */
|
|
3885
|
+
export interface JarvisAppFeatureFlagDto {
|
|
3886
|
+
/** Feature name (should match with app configuration!) */
|
|
3887
|
+
featureName?: string | undefined;
|
|
3888
|
+
/** If the feature is enabled or not */
|
|
3889
|
+
enabled?: boolean;
|
|
3890
|
+
}
|
|
3891
|
+
/** Custom configuration by tenant */
|
|
3892
|
+
export interface JarvisAppConfigurationDto {
|
|
3893
|
+
/** email address where to send feedback */
|
|
3894
|
+
feedbackEmail?: string | undefined;
|
|
3895
|
+
}
|
|
3896
|
+
/** API Response Object. */
|
|
3897
|
+
export interface ResponseOfLongRunningJobResponse extends JarvisResponse {
|
|
3898
|
+
/** The actual result of the operation. */
|
|
3899
|
+
data?: LongRunningJobResponse | undefined;
|
|
3900
|
+
}
|
|
3901
|
+
export interface LongRunningJobResponse {
|
|
3902
|
+
/** Job Id that can be used to request Job Status */
|
|
3903
|
+
jobId?: string | undefined;
|
|
3904
|
+
/** Extra data: Can contains Job Status and details */
|
|
3905
|
+
statusDetail?: LongRunningJobStatusResponse | undefined;
|
|
3906
|
+
}
|
|
3907
|
+
export interface LongRunningJobStatusResponse {
|
|
3908
|
+
status?: string | undefined;
|
|
3909
|
+
/** Total jobs */
|
|
3910
|
+
total?: number;
|
|
3911
|
+
}
|
|
3912
|
+
/** API Response Object. */
|
|
3913
|
+
export interface ResponseOfPropertiesDefinitionSearchResponse extends JarvisResponse {
|
|
3914
|
+
/** The actual result of the operation. */
|
|
3915
|
+
data?: PropertiesDefinitionSearchResponse | undefined;
|
|
3916
|
+
}
|
|
3917
|
+
export interface PropertiesDefinitionSearchResponse {
|
|
3918
|
+
/** Smaller set of info to browse and filter PropertyDefinitions */
|
|
3919
|
+
values?: PropertyDefinitionInfoDto[] | undefined;
|
|
3920
|
+
}
|
|
3921
|
+
/** Smaller set of data to browse Property definitions */
|
|
3922
|
+
export interface PropertyDefinitionInfoDto {
|
|
3923
|
+
id?: string | undefined;
|
|
3924
|
+
localizedNames?: {
|
|
3925
|
+
[key: string]: string;
|
|
3926
|
+
} | undefined;
|
|
3927
|
+
localizedDescriptions?: {
|
|
3928
|
+
[key: string]: string;
|
|
3929
|
+
} | undefined;
|
|
3930
|
+
version?: number;
|
|
3931
|
+
/** "unknown";
|
|
3932
|
+
"integer";
|
|
3933
|
+
"number";
|
|
3934
|
+
"string";
|
|
3935
|
+
"datetime";
|
|
3936
|
+
"bool";
|
|
3937
|
+
"html";
|
|
3938
|
+
"lookup";
|
|
3939
|
+
"select";
|
|
3940
|
+
"multi-select" */
|
|
3941
|
+
type?: string | undefined;
|
|
3942
|
+
}
|
|
3943
|
+
export interface PropertiesDefinitionSearchRequest {
|
|
3944
|
+
/** Filter terms */
|
|
3945
|
+
terms?: string | undefined;
|
|
3946
|
+
/** Max elements at time. if null will be sent the entire list */
|
|
3947
|
+
maxAtTime?: number | undefined;
|
|
3948
|
+
/** Search to deleted properties too */
|
|
3949
|
+
showDeleted?: boolean;
|
|
3950
|
+
}
|
|
3951
|
+
/** API Response Object. */
|
|
3952
|
+
export interface ResponseOfPropertiesDefinitionsDataResponse extends JarvisResponse {
|
|
3953
|
+
/** The actual result of the operation. */
|
|
3954
|
+
data?: PropertiesDefinitionsDataResponse | undefined;
|
|
3955
|
+
}
|
|
3956
|
+
export interface PropertiesDefinitionsDataResponse {
|
|
3957
|
+
definitions?: PropertyDefinitionDto[] | undefined;
|
|
3958
|
+
}
|
|
3959
|
+
export interface PropertyDefinitionDto {
|
|
3960
|
+
id?: string | undefined;
|
|
3961
|
+
localizedNames?: {
|
|
3962
|
+
[key: string]: string;
|
|
3963
|
+
} | undefined;
|
|
3964
|
+
localizedDescriptions?: {
|
|
3965
|
+
[key: string]: string;
|
|
3966
|
+
} | undefined;
|
|
3967
|
+
version?: number;
|
|
3968
|
+
/** "unknown";
|
|
3969
|
+
"integer";
|
|
3970
|
+
"number";
|
|
3971
|
+
"string";
|
|
3972
|
+
"datetime";
|
|
3973
|
+
"bool";
|
|
3974
|
+
"html";
|
|
3975
|
+
"lookup";
|
|
3976
|
+
"select";
|
|
3977
|
+
"multi-select"
|
|
3978
|
+
"hyperlink" */
|
|
3979
|
+
type?: string | undefined;
|
|
3980
|
+
innerFields?: FieldInfoBaseDataDto | undefined;
|
|
3981
|
+
}
|
|
3982
|
+
export interface FieldInfoBaseDataDto {
|
|
3983
|
+
id?: string | undefined;
|
|
3984
|
+
type?: string | undefined;
|
|
3985
|
+
maxOccurence?: number;
|
|
3986
|
+
minOccurrence?: number;
|
|
3987
|
+
substitutionKeyField?: string | undefined;
|
|
3988
|
+
}
|
|
3989
|
+
export interface PropertiesDefinitionsDataRequest {
|
|
3990
|
+
/** List of ids to get
|
|
3991
|
+
[PropertyDefinition_X, PropertyDefinition_Y] */
|
|
3992
|
+
ids?: string[] | undefined;
|
|
3993
|
+
}
|
|
3994
|
+
/** API Response Object. */
|
|
3995
|
+
export interface ResponseOfSearchSelectPropertyResultsDto extends JarvisResponse {
|
|
3996
|
+
/** The actual result of the operation. */
|
|
3997
|
+
data?: SearchSelectPropertyResultsDto | undefined;
|
|
3998
|
+
}
|
|
3999
|
+
/** Results has different format based on data source type ("dataType") for data source of type "AllowedValues" { "dataType": "AllowedValues", "total": 5, "items": [ { "id": "Automotive", "title": "Automotive" } ] } for data source of type "UDVL" { "dataType": "UDVL", "total": 4, "items": [ { "id": "UserDefinedValueListEntry_1", "title": "Automotive", "externalId": "Automotive", "name_it": "Automotive", "name_en": "Automotive" } ] } for data source of type "Datasource" { "dataType": "Datasource", "total": 4, "items": [ { "id": "WorkTask_69", "title": "Titolo del workitem", "deleted": false, "type": "worktask", "icon": null, "description": null, "tasktitle": "Titolo del workitem", "workspaceid": "Workspace_16", "workspacetitle": "Workspace 📃", "draft": "False", "ownerid": "User_2", "workprogress": null, "workprogressuserid": null, "taskstatusid": "WorkTaskStatus_2", "statusname": "New", ... "propertydefinition_29/jarvisformfield_66": "7841", "propertydefinition_48/jarvisformfield_85": "XXXXX", "propertydefinition_11/jarvisformfield_11": "2024-01-05T00:00:00Z", "propertydefinition_28/jarvisformfield_65": "2024-01-26T00:00:00Z" } ] } */
|
|
4000
|
+
export interface SearchSelectPropertyResultsDto {
|
|
4001
|
+
dataType?: string | undefined;
|
|
4002
|
+
total?: number;
|
|
4003
|
+
items?: any[] | undefined;
|
|
4004
|
+
}
|
|
4005
|
+
export interface PropertiesSelectSearchRequest {
|
|
4006
|
+
/** Property name or Id to search in. */
|
|
4007
|
+
propertyNameOrId?: string | undefined;
|
|
4008
|
+
/** Full text term to apply to query */
|
|
4009
|
+
term?: string | undefined;
|
|
4010
|
+
/** List of element Ids to get from search. This is used to get specific id, for example to
|
|
4011
|
+
populate combo-box with preselected property element id. */
|
|
4012
|
+
idList?: string[] | undefined;
|
|
4013
|
+
/** If false (default) it return only id and title.
|
|
4014
|
+
If true it returns all the fields expected by the property datasource configuration
|
|
4015
|
+
or the UDVL */
|
|
4016
|
+
completeResult?: boolean;
|
|
4017
|
+
/** initial record for page search */
|
|
4018
|
+
startIndex?: number | undefined;
|
|
4019
|
+
/** Number of records to return from query execution */
|
|
4020
|
+
numOfRecords?: number | undefined;
|
|
4021
|
+
/** Desired language for multilanguage UDVL descriptions
|
|
4022
|
+
|
|
4023
|
+
Allowed values could be "it" (Italian), "en" (English).
|
|
4024
|
+
See Common Jarvis configuration to see which are set */
|
|
4025
|
+
language?: string | undefined;
|
|
4026
|
+
}
|
|
4027
|
+
/** API Response Object. */
|
|
4028
|
+
export interface ResponseOfWorkspaceSettingsResponse extends JarvisResponse {
|
|
4029
|
+
/** The actual result of the operation. */
|
|
4030
|
+
data?: WorkspaceSettingsResponse | undefined;
|
|
4031
|
+
}
|
|
4032
|
+
export interface WorkspaceBaseSettingsResponse {
|
|
4033
|
+
/** Workspace Id */
|
|
4034
|
+
id?: string | undefined;
|
|
4035
|
+
/** Workspace Title */
|
|
4036
|
+
title?: string | undefined;
|
|
4037
|
+
/** Workspace Description */
|
|
4038
|
+
description?: string | undefined;
|
|
4039
|
+
/** List of users in this workspace, with their permissions and role */
|
|
4040
|
+
users?: WorkspaceUserResponseWithPermissions[] | undefined;
|
|
4041
|
+
/** List of available task statuses within the workspace (TaskStatusId) */
|
|
4042
|
+
statuses?: WorkspaceTaskStatusResponse[] | undefined;
|
|
4043
|
+
/** Ordered Array of task types allowed to be created in the workspace (TaskTypeId) */
|
|
4044
|
+
taskTypes?: WorkspaceTaskTypeResponse[] | undefined;
|
|
4045
|
+
/** Context data (can be used as placeholder value for some filtered query) */
|
|
4046
|
+
contextData?: {
|
|
4047
|
+
[key: string]: any;
|
|
4048
|
+
} | undefined;
|
|
4049
|
+
/** The owner of the workspace */
|
|
4050
|
+
owner?: string | undefined;
|
|
4051
|
+
/** true if Workspace is archived */
|
|
4052
|
+
archived?: boolean;
|
|
4053
|
+
}
|
|
4054
|
+
/** Workspace Settings informations */
|
|
4055
|
+
export interface WorkspaceSettingsResponse extends WorkspaceBaseSettingsResponse {
|
|
4056
|
+
/** Workspace Properties */
|
|
4057
|
+
properties?: WorkspacePropertyDefinitionInfoDto[] | undefined;
|
|
4058
|
+
}
|
|
4059
|
+
export interface WorkspacePropertyDefinitionInfoDto extends PropertyDefinitionInfoDto {
|
|
4060
|
+
required?: boolean;
|
|
4061
|
+
}
|
|
4062
|
+
/** Workspace User Info NOTA BENE! Remeber to update the WorkspaceUserResponseWithPermissions constructor when adding properties to this class! */
|
|
4063
|
+
export interface WorkspaceUserResponse {
|
|
4064
|
+
/** The id of the user */
|
|
4065
|
+
id?: string | undefined;
|
|
4066
|
+
/** The full name of the user */
|
|
4067
|
+
fullName?: string | undefined;
|
|
4068
|
+
}
|
|
4069
|
+
/** Workspace User Info */
|
|
4070
|
+
export interface WorkspaceUserResponseWithPermissions extends WorkspaceUserResponse {
|
|
4071
|
+
/** The id of the tole the user has in this workspace */
|
|
4072
|
+
roleTypeId?: string | undefined;
|
|
4073
|
+
/** If the user can edit work items inside the workspace */
|
|
4074
|
+
canEditWorkItems?: boolean;
|
|
4075
|
+
/** If the user can see work items inside the workspace */
|
|
4076
|
+
canViewWorkItems?: boolean;
|
|
4077
|
+
/** If the user can edit the workspace settings */
|
|
4078
|
+
canEditSettings?: boolean;
|
|
4079
|
+
/** If the user can delete the workspace */
|
|
4080
|
+
canDelete?: boolean;
|
|
4081
|
+
/** If the user can add/remove users from the workspace */
|
|
4082
|
+
canAddRemoveUsers?: boolean;
|
|
4083
|
+
/** If the user can edit/add/delete the workspace views */
|
|
4084
|
+
canEditViews?: boolean;
|
|
4085
|
+
/** If the user can export the workspace as an excel spreadsheet */
|
|
4086
|
+
canExportExcel?: boolean;
|
|
4087
|
+
/** If the user can be assigned to a work item */
|
|
4088
|
+
canBeAssignee?: boolean;
|
|
4089
|
+
/** If the user can be the collaborator of a work item */
|
|
4090
|
+
canBeCollaborator?: boolean;
|
|
4091
|
+
/** Tells if you can add/remove instance fields from work items in this workspace */
|
|
4092
|
+
canAddRemoveInstanceFields?: boolean;
|
|
4093
|
+
/** If the user can edit discussions (notes) on work items. If false, the user can only view discussions. */
|
|
4094
|
+
canEditDiscussions?: boolean;
|
|
4095
|
+
/** If the user can edit planning in the workspace */
|
|
4096
|
+
canEditPlanning?: boolean;
|
|
4097
|
+
/** If the user is a real user or an non interactive user */
|
|
4098
|
+
isInteractive?: boolean;
|
|
4099
|
+
}
|
|
4100
|
+
/** Workspace TaskStatus Info */
|
|
4101
|
+
export interface WorkspaceTaskStatusResponse {
|
|
4102
|
+
id?: string | undefined;
|
|
4103
|
+
name?: string | undefined;
|
|
4104
|
+
/** 1 = Open, 2 = Closed */
|
|
4105
|
+
type?: number;
|
|
4106
|
+
}
|
|
4107
|
+
/** Workspace TaskType Info */
|
|
4108
|
+
export interface WorkspaceTaskTypeResponse {
|
|
4109
|
+
/** TaskTypeId */
|
|
4110
|
+
id?: string | undefined;
|
|
4111
|
+
/** Name */
|
|
4112
|
+
name?: string | undefined;
|
|
4113
|
+
/** Color */
|
|
4114
|
+
color?: string | undefined;
|
|
4115
|
+
/** The list of children (TaskTypeId)
|
|
4116
|
+
(#13634) */
|
|
4117
|
+
children?: string[] | undefined;
|
|
4118
|
+
archived?: boolean;
|
|
4119
|
+
}
|
|
4120
|
+
/** This is OBSOLETE IT IS NOT PUBLIC BECAUSE IT INHERITS FROM A PRIVATE DTO. */
|
|
4121
|
+
export interface WorkTaskSearchRequest extends OmniSearchQueryRequest {
|
|
4122
|
+
workspaceId?: string | undefined;
|
|
4123
|
+
}
|
|
4124
|
+
/** The public dto v1 class to create or update a worktask. */
|
|
4125
|
+
export interface WorkTaskUpsertRequest {
|
|
4126
|
+
/** Contains operation metadata that does not modify the operation semantics, but controls
|
|
4127
|
+
internal aspects of the operation.
|
|
4128
|
+
|
|
4129
|
+
Available metadata keys:
|
|
4130
|
+
|
|
4131
|
+
- SkipElasticRefresh: Set to "true" to skip the Elasticsearch index refresh
|
|
4132
|
+
after the operation. Useful for bulk imports where intermediate consistency is not required.
|
|
4133
|
+
|
|
4134
|
+
- ProfileEnable: Set to "true" to enable profiling logs in the response
|
|
4135
|
+
(for internal use only).
|
|
4136
|
+
|
|
4137
|
+
- OperationId: Makes the operation idempotent to support client retry policies.
|
|
4138
|
+
Use a GUID as the value. Two calls with the same OperationId may produce unpredictable results.
|
|
4139
|
+
|
|
4140
|
+
- FORCE-ID:{fieldId}: Forces a specific value for the counter field identified by
|
|
4141
|
+
{fieldId}. Useful when importing data with pre-existing IDs that must be preserved.
|
|
4142
|
+
Example — to force the value "PC-00042" on field "JarvisField_7":
|
|
4143
|
+
|
|
4144
|
+
"FORCE-ID:JarvisField_7": "PC-00042"
|
|
4145
|
+
|
|
4146
|
+
Multiple fields can be forced in a single request by adding more keys with the same prefix. */
|
|
4147
|
+
operationMetadata?: {
|
|
4148
|
+
[key: string]: string;
|
|
4149
|
+
} | undefined;
|
|
4150
|
+
/** Worktask Id. Leave null to create a new worktask. */
|
|
4151
|
+
id?: string | undefined;
|
|
4152
|
+
/** Request to create a new worktask. */
|
|
4153
|
+
create?: WorkTaskCreateRequest | undefined;
|
|
4154
|
+
/** Request to confirm a draft worktask. */
|
|
4155
|
+
confirm?: WorkTaskConfirmRequest | undefined;
|
|
4156
|
+
/** Request to change the worktask title. */
|
|
4157
|
+
changeTitle?: WorkTaskChangeTitleRequest | undefined;
|
|
4158
|
+
/** Request to change the worktask status. */
|
|
4159
|
+
changeStatus?: WorkTaskChangeStatusRequest | undefined;
|
|
4160
|
+
/** Request to change the worktask type. */
|
|
4161
|
+
changeType?: WorkTaskChangeTypeRequest | undefined;
|
|
4162
|
+
/** Request to assign the worktask to a user. */
|
|
4163
|
+
assign?: WorkTaskAssignRequest | undefined;
|
|
4164
|
+
/** Request to change the worktask content. */
|
|
4165
|
+
changeContent?: WorkTaskChangeContentRequest | undefined;
|
|
4166
|
+
/** Request to change the worktask due date. */
|
|
4167
|
+
changeDueDate?: WorkTaskChangeDueDateRequest | undefined;
|
|
4168
|
+
/** Request to change the worktask start and end dates. */
|
|
4169
|
+
changeStartEndDate?: WorkTaskChangeStartEndDateRequest | undefined;
|
|
4170
|
+
/** Request to set the worktask progress. */
|
|
4171
|
+
setProgress?: WorkTaskSetProgressRequest | undefined;
|
|
4172
|
+
/** Request to add collaborators to the worktask. */
|
|
4173
|
+
addCollaborators?: WorkTaskAddCollaboratorsRequest | undefined;
|
|
4174
|
+
/** Request to remove collaborators from the worktask. */
|
|
4175
|
+
removeCollaborators?: WorkTaskRemoveCollaboratorsRequest | undefined;
|
|
4176
|
+
/** Request to set the collaborators for the worktask. */
|
|
4177
|
+
setCollaborators?: WorkTaskSetCollaboratorsRequest | undefined;
|
|
4178
|
+
/** Request to save or update worktask properties. */
|
|
4179
|
+
saveProperties?: PropertiesUpdateValuesRequest | undefined;
|
|
4180
|
+
/** Request to add links to the worktask. */
|
|
4181
|
+
addLinks?: AddLinksRequest | undefined;
|
|
4182
|
+
/** Request to remove links from the worktask. */
|
|
4183
|
+
removeLinks?: RemoveLinksRequest | undefined;
|
|
4184
|
+
/** Request to archive the worktask. */
|
|
4185
|
+
archive?: WorkTaskArchiveRequest | undefined;
|
|
4186
|
+
/** Request to set the parent of the worktask. */
|
|
4187
|
+
setParent?: WorkTaskSetParentRequest | undefined;
|
|
4188
|
+
}
|
|
4189
|
+
export interface WorkTaskCreateRequest {
|
|
4190
|
+
/** Workspace that worktask belongs to. It should be valid WorkspaceId (eg "Workspace_12") */
|
|
4191
|
+
workspaceId?: string | undefined;
|
|
4192
|
+
/** Task owner. It should be valid UserId */
|
|
4193
|
+
ownerId?: string | undefined;
|
|
4194
|
+
/** If true, the worktask will be created as draft. Default is false.
|
|
4195
|
+
If the worktask is created as draft, it will not be visible to other users until it is confirmed through WorkTaskConfirmRequest section. */
|
|
4196
|
+
asDraft?: boolean;
|
|
4197
|
+
/** Request to copy from an existing worktask. */
|
|
4198
|
+
copyFrom?: CopyWorkTaskRequest | undefined;
|
|
4199
|
+
}
|
|
4200
|
+
export interface CopyWorkTaskRequest {
|
|
4201
|
+
/** Source worktask id to copy from. It should be valid Id */
|
|
4202
|
+
id?: string | undefined;
|
|
4203
|
+
/** Copy properties and fields from the source worktask */
|
|
4204
|
+
withProperties?: boolean;
|
|
4205
|
+
/** Copy links from the source worktask. */
|
|
4206
|
+
withLinks?: boolean;
|
|
4207
|
+
/** When true, copy the planning representation of the source worktask in addition to the worktask itself.
|
|
4208
|
+
Use PlanningOptions to override the default planning copy behavior. */
|
|
4209
|
+
withPlanning?: boolean;
|
|
4210
|
+
/** Optional overrides for the planning copy behavior. Has effect only when WithPlanning is true.
|
|
4211
|
+
Leave null to copy the planning subtree using default options. */
|
|
4212
|
+
planningOptions?: PlanningCopyOptionsPublicDto | undefined;
|
|
4213
|
+
/** Copy todo list from the source worktask */
|
|
4214
|
+
withTodoList?: boolean;
|
|
4215
|
+
}
|
|
4216
|
+
/** Options that control how the source worktask planning subtree is copied. */
|
|
4217
|
+
export interface PlanningCopyOptionsPublicDto {
|
|
4218
|
+
/** Controls how the source planning is copied. When omitted, defaults to Subtree. */
|
|
4219
|
+
mode?: PlanningCopyModePublic | undefined;
|
|
4220
|
+
/** Optional existing target project, identified by the root work task id of that project
|
|
4221
|
+
(e.g. "WorkTask_42"). Must be a valid WorkTaskId; the server resolves it to the internal
|
|
4222
|
+
planning project whose RootElementId equals this value. Leave null to create a new
|
|
4223
|
+
destination project rooted at the copied work task. */
|
|
4224
|
+
targetProjectId?: string | undefined;
|
|
4225
|
+
/** Optional target parent worktask id inside the target project. It should be a valid Id. */
|
|
4226
|
+
targetParentId?: string | undefined;
|
|
4227
|
+
/** Optional target sibling worktask id that the copied subtree should be inserted after.
|
|
4228
|
+
It should be a valid Id. */
|
|
4229
|
+
targetAfterId?: string | undefined;
|
|
4230
|
+
/** Optional target sibling worktask id that the copied subtree should be inserted before.
|
|
4231
|
+
It should be a valid Id. */
|
|
4232
|
+
targetBeforeId?: string | undefined;
|
|
4233
|
+
/** Copy planning constraints from the source subtree. Defaults to true when not declared. */
|
|
4234
|
+
withConstraints?: boolean;
|
|
4235
|
+
/** Copy planning dependency links between activities inside the copied subtree. Only links
|
|
4236
|
+
whose source and target both belong to the copied set are recreated; links to activities
|
|
4237
|
+
outside the copied set are omitted. Defaults to true when not declared.
|
|
4238
|
+
This is independent from WithLinks, which controls
|
|
4239
|
+
generic worktask-level link copying. */
|
|
4240
|
+
withLinks?: boolean;
|
|
4241
|
+
/** Optional constraint sets applied to the copied target activities after source constraints are resolved. */
|
|
4242
|
+
constraintSets?: PlanningConstraintSetPublicDto[] | undefined;
|
|
4243
|
+
}
|
|
4244
|
+
export declare enum PlanningCopyModePublic {
|
|
4245
|
+
OnlyActivity = "OnlyActivity",
|
|
4246
|
+
Subtree = "Subtree"
|
|
4247
|
+
}
|
|
4248
|
+
export interface PlanningConstraintSetPublicDto {
|
|
4249
|
+
/** Source work task id whose copied target activity should receive the constraint. */
|
|
4250
|
+
sourceId?: string | undefined;
|
|
4251
|
+
/** Constraint applied to the copied target activity, replacing any source-derived one. */
|
|
4252
|
+
constraint?: JarvisProjectActivityConstraintPublicDto | undefined;
|
|
4253
|
+
}
|
|
4254
|
+
/** Public representation of a scheduling constraint applied to an activity. Public counterpart of JarvisProjectActivityConstraintDto: only the Must* constraint types are exposed via JarvisActivityConstraintTypePublic. */
|
|
4255
|
+
export interface JarvisProjectActivityConstraintPublicDto {
|
|
4256
|
+
/** The type of constraint. */
|
|
4257
|
+
type?: JarvisActivityConstraintTypePublic;
|
|
4258
|
+
/** The date associated with the constraint (ISO 8601). */
|
|
4259
|
+
date?: string | undefined;
|
|
4260
|
+
}
|
|
4261
|
+
/** Type of constraints that may be applied from public api. Currently, only Must constraints are supported. */
|
|
4262
|
+
export declare enum JarvisActivityConstraintTypePublic {
|
|
4263
|
+
None = "None",
|
|
4264
|
+
MustStartOn = "MustStartOn",
|
|
4265
|
+
MustFinishOn = "MustFinishOn"
|
|
4266
|
+
}
|
|
4267
|
+
export interface WorkTaskConfirmRequest {
|
|
4268
|
+
confirm?: boolean;
|
|
4269
|
+
}
|
|
4270
|
+
export interface WorkTaskChangeTitleRequest {
|
|
4271
|
+
title?: string | undefined;
|
|
4272
|
+
}
|
|
4273
|
+
export interface WorkTaskChangeStatusRequest {
|
|
4274
|
+
/** The new status id of the worktask, from the list of available workspace statuses */
|
|
4275
|
+
statusId?: string | undefined;
|
|
4276
|
+
}
|
|
4277
|
+
export interface WorkTaskChangeTypeRequest {
|
|
4278
|
+
/** The new task type id of the worktask, from the list of available workspace task types */
|
|
4279
|
+
taskTypeId?: string | undefined;
|
|
4280
|
+
}
|
|
4281
|
+
export interface WorkTaskAssignRequest {
|
|
4282
|
+
/** Assignee. It should be valid UserId */
|
|
4283
|
+
assigneeId?: string | undefined;
|
|
4284
|
+
}
|
|
4285
|
+
export interface WorkTaskChangeContentRequest {
|
|
4286
|
+
/** The HTML content (description) of the worktask.
|
|
4287
|
+
|
|
4288
|
+
To mention a user, include a <j-user> tag with the userid attribute:
|
|
4289
|
+
|
|
4290
|
+
<j-user userid="User_123">@John Doe</j-user>
|
|
4291
|
+
|
|
4292
|
+
|
|
4293
|
+
The display name inside the tag is optional; the system will automatically
|
|
4294
|
+
resolve it from the userid on save. So this is also valid:
|
|
4295
|
+
|
|
4296
|
+
<j-user userid="User_123"></j-user>
|
|
4297
|
+
|
|
4298
|
+
|
|
4299
|
+
Multiple mentions can be included in the same content:
|
|
4300
|
+
|
|
4301
|
+
"Assigned to <j-user userid=\"User_1\">@Alice</j-user> and <j-user userid=\"User_2\">@Bob</j-user>"
|
|
4302
|
+
|
|
4303
|
+
|
|
4304
|
+
Mentioned users will receive an email notification. */
|
|
4305
|
+
content?: string | undefined;
|
|
4306
|
+
}
|
|
4307
|
+
export interface WorkTaskChangeDueDateRequest {
|
|
4308
|
+
/** date should be expressed in format YYYYMMDD or full iso 8601 without time part */
|
|
4309
|
+
dueDate?: string | undefined;
|
|
4310
|
+
}
|
|
4311
|
+
export interface WorkTaskChangeStartEndDateRequest {
|
|
4312
|
+
/** The worktask start date, in ISO format "yyyy-mm-ddT:hh:mm:ssZ" (UTC) */
|
|
4313
|
+
startDate?: Date | undefined;
|
|
4314
|
+
/** The worktask end date, in ISO format "yyyy-mm-ddT:hh:mm:ssZ" (UTC) */
|
|
4315
|
+
endDate?: Date | undefined;
|
|
4316
|
+
}
|
|
4317
|
+
export interface WorkTaskSetProgressRequest {
|
|
4318
|
+
progressDesc?: string | undefined;
|
|
4319
|
+
/** date should be expressed in format YYYYMMDD or full iso 8601 without time part */
|
|
4320
|
+
workProgressDateTime?: string | undefined;
|
|
4321
|
+
/** Author of worktask progress. It should be valid UserId */
|
|
4322
|
+
userId?: string | undefined;
|
|
4323
|
+
}
|
|
4324
|
+
export interface WorkTaskAddCollaboratorsRequest {
|
|
4325
|
+
/** Collaborators to add. They should be valid UserId */
|
|
4326
|
+
collaboratorIds?: string[] | undefined;
|
|
4327
|
+
}
|
|
4328
|
+
export interface WorkTaskRemoveCollaboratorsRequest {
|
|
4329
|
+
/** Collaborators to remove. They should be valid UserId */
|
|
4330
|
+
collaboratorIds?: string[] | undefined;
|
|
4331
|
+
}
|
|
4332
|
+
export interface WorkTaskSetCollaboratorsRequest {
|
|
4333
|
+
/** Collaborators to set. They should be valid UserId */
|
|
4334
|
+
collaboratorIds?: string[] | undefined;
|
|
4335
|
+
}
|
|
4336
|
+
export interface AddLinksRequest {
|
|
4337
|
+
links?: TargetLinkRequest[] | undefined;
|
|
4338
|
+
}
|
|
4339
|
+
export interface TargetLinkRequest {
|
|
4340
|
+
targetId?: string | undefined;
|
|
4341
|
+
/** Link Definition to use. It can be null, in that case it use generic "Related to" link definition */
|
|
4342
|
+
linkDefinitionId?: string | undefined;
|
|
4343
|
+
}
|
|
4344
|
+
export interface RemoveLinksRequest {
|
|
4345
|
+
links?: TargetLinkRequest[] | undefined;
|
|
4346
|
+
}
|
|
4347
|
+
export interface WorkTaskArchiveRequest {
|
|
4348
|
+
archive?: boolean;
|
|
4349
|
+
}
|
|
4350
|
+
export interface WorkTaskSetParentRequest {
|
|
4351
|
+
workTaskParentId?: string | undefined;
|
|
4352
|
+
}
|
|
4353
|
+
/** API Response Object. */
|
|
4354
|
+
export interface ResponseOfJObject extends JarvisResponse {
|
|
4355
|
+
/** The actual result of the operation. */
|
|
4356
|
+
data?: any | undefined;
|
|
4357
|
+
}
|
|
4358
|
+
/** API Response Object. */
|
|
4359
|
+
export interface ResponseOfWorkTaskDetailPublicDto extends JarvisResponse {
|
|
4360
|
+
/** The actual result of the operation. */
|
|
4361
|
+
data?: WorkTaskDetailPublicDto | undefined;
|
|
4362
|
+
}
|
|
4363
|
+
export interface WorkTaskDetailPublicDto {
|
|
4364
|
+
/** The worktask id */
|
|
4365
|
+
id?: string | undefined;
|
|
4366
|
+
/** The worktask id number */
|
|
4367
|
+
taskNumber?: number;
|
|
4368
|
+
/** The worktask title */
|
|
4369
|
+
title?: string | undefined;
|
|
4370
|
+
/** Indicates if title is calculated (readonly in UI).
|
|
4371
|
+
#18900 - Title formula support */
|
|
4372
|
+
isCalculatedTitle?: boolean;
|
|
4373
|
+
/** Contains any warnings about the title formula.
|
|
4374
|
+
#18900 - Title formula support */
|
|
4375
|
+
titleWarnings?: string[] | undefined;
|
|
4376
|
+
/** The id of the attachment */
|
|
4377
|
+
descriptionAttachmentId?: string | undefined;
|
|
4378
|
+
/** String description, if you want to include the full description without the
|
|
4379
|
+
need to pass from the attachmentId api */
|
|
4380
|
+
description?: string | undefined;
|
|
4381
|
+
/** The workspace this worktask belong to */
|
|
4382
|
+
workspaceId?: string | undefined;
|
|
4383
|
+
/** If this workspace is a draft and can only be seen by the user that created it */
|
|
4384
|
+
draft?: boolean;
|
|
4385
|
+
/** Creation date for a confirmed task. This field is empty for drafts */
|
|
4386
|
+
creationDate?: string | undefined;
|
|
4387
|
+
/** The due date of the activity related to this worktask */
|
|
4388
|
+
dueDate?: string | undefined;
|
|
4389
|
+
/** The worktask type, from the possible types of the workspace */
|
|
4390
|
+
taskTypeId?: string | undefined;
|
|
4391
|
+
/** The current status of the worktask, from the possible statuses of the workspace */
|
|
4392
|
+
statusId?: string | undefined;
|
|
4393
|
+
/** Id of the parent worktask, if exists. */
|
|
4394
|
+
parentId?: string | undefined;
|
|
4395
|
+
/** A short string containing a brief description of the status of this worktask */
|
|
4396
|
+
workProgress?: string | undefined;
|
|
4397
|
+
/** The user that wrote the last work progress */
|
|
4398
|
+
workProgressModifiedBy?: string | undefined;
|
|
4399
|
+
/** The time at which the work progress was last updated */
|
|
4400
|
+
workProgressModifiedAt?: string | undefined;
|
|
4401
|
+
/** The user responsible for this worktask */
|
|
4402
|
+
assignee?: string | undefined;
|
|
4403
|
+
/** A list of people that can work on this worktask */
|
|
4404
|
+
collaborators?: string[] | undefined;
|
|
4405
|
+
/** If the worktask has been archived */
|
|
4406
|
+
archived?: boolean;
|
|
4407
|
+
/** Additional metadata information about the work task state.
|
|
4408
|
+
Used to convey reasons or context for certain states (e.g., why it's archived).
|
|
4409
|
+
Keys: "ArchivedReason" - reason for archiving (e.g., "StrongRelationDeleted", "PlanningActivityDeleted") */
|
|
4410
|
+
metadataInfo?: {
|
|
4411
|
+
[key: string]: string;
|
|
4412
|
+
} | undefined;
|
|
4413
|
+
/** WorkTask properties version */
|
|
4414
|
+
propertyVersion?: number;
|
|
4415
|
+
/** WorkTask properties */
|
|
4416
|
+
properties?: {
|
|
4417
|
+
[key: string]: any;
|
|
4418
|
+
} | undefined;
|
|
4419
|
+
/** Jarvis fields in a public dto. */
|
|
4420
|
+
fields?: JarvisFieldValuePublicDto[] | undefined;
|
|
4421
|
+
/** Nested fields. */
|
|
4422
|
+
nestedFields?: JarvisFieldValuePublicDto[] | undefined;
|
|
4423
|
+
/** List of field definitions associated to this work item */
|
|
4424
|
+
fieldDefinitions?: JarvisFieldPublicDefinitionDto[] | undefined;
|
|
4425
|
+
lastModifiy?: string | undefined;
|
|
4426
|
+
/** last modify date */
|
|
4427
|
+
lastModify?: string | undefined;
|
|
4428
|
+
/** Last modification user */
|
|
4429
|
+
lastModifyBy?: string | undefined;
|
|
4430
|
+
/** It is interesting for public api to have version of the aggregate */
|
|
4431
|
+
aggregateVersion?: number;
|
|
4432
|
+
/** Interesting for public api to have checkpoint version */
|
|
4433
|
+
aggregateCheckpointId?: number;
|
|
4434
|
+
/** The start date of the activity related to this worktask */
|
|
4435
|
+
startDate?: string | undefined;
|
|
4436
|
+
/** The end date of the activity related to this worktask */
|
|
4437
|
+
endDate?: string | undefined;
|
|
4438
|
+
/** #13959 Links attached to worktask */
|
|
4439
|
+
links?: LinkDetailDto[] | undefined;
|
|
4440
|
+
}
|
|
4441
|
+
export interface JarvisFieldPublicDefinitionDto {
|
|
4442
|
+
/** The field id */
|
|
4443
|
+
id?: string | undefined;
|
|
4444
|
+
/** The name of the field */
|
|
4445
|
+
name?: string | undefined;
|
|
4446
|
+
/** If the field is disabled */
|
|
4447
|
+
disabled?: boolean;
|
|
4448
|
+
/** If the field can have multiple values */
|
|
4449
|
+
multiple?: boolean;
|
|
4450
|
+
/** True if the field is required. */
|
|
4451
|
+
required?: boolean;
|
|
4452
|
+
/** The type of the field (domain/storage perspective).
|
|
4453
|
+
Represents how the field is stored and managed in the domain model.
|
|
4454
|
+
Use this when you need to understand the underlying data type for persistence. */
|
|
4455
|
+
type?: JarvisFieldType;
|
|
4456
|
+
/** The data type for presentation/UI layer.
|
|
4457
|
+
Uses OmniSearchItemGridColumnDataType which includes Currency and Percent as distinct types.
|
|
4458
|
+
Prefer using this property for UI rendering, icons, labels, and formatting decisions.
|
|
4459
|
+
This provides more granular type information than Type (e.g., Currency vs Number vs Percent). */
|
|
4460
|
+
dataType?: OmniSearchItemGridColumnDataType;
|
|
4461
|
+
/** The id of the omnisearch view to use, if the field is an omnisearch field */
|
|
4462
|
+
omniSearchViewId?: string | undefined;
|
|
4463
|
+
/** This can be populated only if the type is OmniSearchDataSource */
|
|
4464
|
+
visibleFields?: string[] | undefined;
|
|
4465
|
+
/** Tag / String value that identifies the custom component the UI
|
|
4466
|
+
should display to the user when editing the property Value */
|
|
4467
|
+
customEditor?: string | undefined;
|
|
4468
|
+
/** A JSON string used as settings to be used by the custom editor */
|
|
4469
|
+
customEditorSettings?: string | undefined;
|
|
4470
|
+
/** Formula for Calculated Fields */
|
|
4471
|
+
formula?: string | undefined;
|
|
4472
|
+
/** True if field is calculated by a formula */
|
|
4473
|
+
calculated?: boolean;
|
|
4474
|
+
/** This can be populated only if the type is String, Number or Integer. */
|
|
4475
|
+
allowedValues?: any[] | undefined;
|
|
4476
|
+
/** If set, this template will be used to build the label for the field to be used instead of the field name.
|
|
4477
|
+
|
|
4478
|
+
This is a template that allows the use of the following placeholders:
|
|
4479
|
+
|
|
4480
|
+
|
|
4481
|
+
@name
|
|
4482
|
+
the name of the field
|
|
4483
|
+
|
|
4484
|
+
*/
|
|
4485
|
+
labelTemplate?: string | undefined;
|
|
4486
|
+
/** If set, this should be used as label for the field instead of the field name. */
|
|
4487
|
+
label?: string | undefined;
|
|
4488
|
+
/** Default value for this field in this specific association context.
|
|
4489
|
+
This overrides the field's global default value when used in this association. */
|
|
4490
|
+
defaultValue?: any | undefined;
|
|
4491
|
+
}
|
|
4492
|
+
export declare enum JarvisFieldType {
|
|
4493
|
+
Unknown = "Unknown",
|
|
4494
|
+
Integer = "integer",
|
|
4495
|
+
Number = "number",
|
|
4496
|
+
String = "string",
|
|
4497
|
+
DateTime = "datetime",
|
|
4498
|
+
Date = "date",
|
|
4499
|
+
Boolean = "bool",
|
|
4500
|
+
OmniSearchDataSource = "omnisearch-data-source",
|
|
4501
|
+
Hyperlink = "hyperlink",
|
|
4502
|
+
Counter = "counter",
|
|
4503
|
+
Enum = "enum",
|
|
4504
|
+
File = "file",
|
|
4505
|
+
RTE = "rte"
|
|
4506
|
+
}
|
|
4507
|
+
/** Request a work task id and return it even with historical informations. */
|
|
4508
|
+
export interface GetWorkTaskByIdRequest {
|
|
4509
|
+
/** Optional, the version or point in time you want the work task at. If null, returns the current state. */
|
|
4510
|
+
historicalVersionInfo?: HistoricalVersionInfoDto | undefined;
|
|
4511
|
+
/** The work task id. */
|
|
4512
|
+
workTaskId?: string | undefined;
|
|
4513
|
+
/** If true will load the description, description can be really long because
|
|
4514
|
+
is an HTML field. */
|
|
4515
|
+
includeDescription?: boolean | undefined;
|
|
4516
|
+
/** If true will include the links. */
|
|
4517
|
+
includeLinks?: boolean | undefined;
|
|
4518
|
+
/** If true will include a special property called nestedFields that contains all
|
|
4519
|
+
navigation fields that are associated to this work task. All value contained in
|
|
4520
|
+
that property are not owned by this work task but are derived by connecting fields
|
|
4521
|
+
with omnisearch values. */
|
|
4522
|
+
includeNestedFields?: boolean | undefined;
|
|
4523
|
+
/** If true will include the content of long text fields (RTE). */
|
|
4524
|
+
includeLongTextFieldsContents?: boolean | undefined;
|
|
4525
|
+
}
|
|
4526
|
+
/** API Response Object. */
|
|
4527
|
+
export interface ResponseOfIReadOnlyCollectionOfWorkTaskDetailPublicDto extends JarvisResponse {
|
|
4528
|
+
/** The actual result of the operation. */
|
|
4529
|
+
data?: WorkTaskDetailPublicDto[] | undefined;
|
|
4530
|
+
}
|
|
4531
|
+
export interface GetWorkTasksByIdListRequest {
|
|
4532
|
+
requestList?: GetWorkTaskByIdRequest[] | undefined;
|
|
4533
|
+
}
|
|
4534
|
+
export interface CreateWorkTaskFromMailResponseDto {
|
|
4535
|
+
workTaskId?: string | undefined;
|
|
4536
|
+
}
|
|
4537
|
+
/** API Response Object. */
|
|
4538
|
+
export interface ResponseOfPublicNotificationPage extends JarvisResponse {
|
|
4539
|
+
/** The actual result of the operation. */
|
|
4540
|
+
data?: PublicNotificationPage | undefined;
|
|
4541
|
+
}
|
|
4542
|
+
export interface PublicNotificationPage {
|
|
4543
|
+
nextToken?: string | undefined;
|
|
4544
|
+
data?: PublicChangeStreamNotification[] | undefined;
|
|
4545
|
+
}
|
|
4546
|
+
/** Represent a change on the stream that will be sent to external subscribers like automation to the caller. */
|
|
4547
|
+
export interface PublicChangeStreamNotification {
|
|
4548
|
+
/** Id of the object, usually is the id of the aggregate */
|
|
4549
|
+
id?: string | undefined;
|
|
4550
|
+
/** A lowercase string that identify the object that was modified
|
|
4551
|
+
this is necessary because some logical objects, like quotebom are
|
|
4552
|
+
composed by more than one aggregate */
|
|
4553
|
+
type?: string | undefined;
|
|
4554
|
+
/** Name of the event */
|
|
4555
|
+
event?: string | undefined;
|
|
4556
|
+
/** Unique id of the checkpoint in NStore */
|
|
4557
|
+
checkpoint?: number;
|
|
4558
|
+
/** Aggregate version or whathever version number used to identify the version
|
|
4559
|
+
of the object with id Id */
|
|
4560
|
+
version?: number;
|
|
4561
|
+
/** Version of the aggregate. */
|
|
4562
|
+
aggregateVersion?: number;
|
|
4563
|
+
/** Id of the user, used to uniquely identify the user. */
|
|
4564
|
+
userName?: string | undefined;
|
|
4565
|
+
/** Username. */
|
|
4566
|
+
userId?: string | undefined;
|
|
4567
|
+
}
|
|
4568
|
+
/** Poll for a page of notifications. */
|
|
4569
|
+
export interface PublicNotificationPollRequest {
|
|
4570
|
+
/** This is the token that is returned from the last call, it can be 0 to poll
|
|
4571
|
+
from the beginning, but remember that the poller prevents from goint too much
|
|
4572
|
+
in the past, so it usually when a service starts polling should start from the
|
|
4573
|
+
last commit. */
|
|
4574
|
+
token?: string | undefined;
|
|
4575
|
+
pageLength?: number;
|
|
4576
|
+
/** If true we can have more than PageLength events, because we do not want to break
|
|
4577
|
+
a commit, but if a commit has more than 1 events it will not consider pageLength. */
|
|
4578
|
+
doNotBreakCommit?: boolean;
|
|
4579
|
+
}
|
|
4580
|
+
/** API Response Object. */
|
|
4581
|
+
export interface ResponseOfNotificationDefinitionOf extends JarvisResponse {
|
|
4582
|
+
/** The actual result of the operation. */
|
|
4583
|
+
data?: NotificationDefinition[] | undefined;
|
|
4584
|
+
}
|
|
4585
|
+
export interface NotificationDefinition {
|
|
4586
|
+
typeName?: string | undefined;
|
|
4587
|
+
allEvents?: string[] | undefined;
|
|
4588
|
+
}
|
|
4589
|
+
/** Comparison applied by a FieldFiltersPublicDto. OneOf, NotOneOf and Between accept an array as Value; IsNull and IsNotNull ignore Value. */
|
|
4590
|
+
export declare enum FieldFilterPublicType {
|
|
4591
|
+
Unknown = "Unknown",
|
|
4592
|
+
IsNull = "IsNull",
|
|
4593
|
+
IsNotNull = "IsNotNull",
|
|
4594
|
+
OneOf = "OneOf",
|
|
4595
|
+
Contains = "Contains",
|
|
4596
|
+
DoesNotContain = "DoesNotContain",
|
|
4597
|
+
StartsWith = "StartsWith",
|
|
4598
|
+
EndsWith = "EndsWith",
|
|
4599
|
+
Equals = "Equals",
|
|
4600
|
+
NotEqual = "NotEqual",
|
|
4601
|
+
GreaterThan = "GreaterThan",
|
|
4602
|
+
GreaterThanOrEqualTo = "GreaterThanOrEqualTo",
|
|
4603
|
+
LessThan = "LessThan",
|
|
4604
|
+
LessThanOrEqualTo = "LessThanOrEqualTo",
|
|
4605
|
+
NotOneOf = "NotOneOf",
|
|
4606
|
+
Between = "Between"
|
|
4607
|
+
}
|
|
4608
|
+
/** Filter applied to a single field. */
|
|
4609
|
+
export interface FieldFiltersPublicDto {
|
|
4610
|
+
/** Internal field id or field name to filter on. */
|
|
4611
|
+
Field?: string | undefined;
|
|
4612
|
+
/** This could be a single value or a multiple one.
|
|
4613
|
+
In the latter case, values will be queried with an OR operator. */
|
|
4614
|
+
Value?: any | undefined;
|
|
4615
|
+
/** Valid only in equality filters, allows for a case sensitive search. */
|
|
4616
|
+
CaseSensitive?: boolean | undefined;
|
|
4617
|
+
/** Filter type. If null, Equals is applied for a single value and OneOf for multiple values.
|
|
4618
|
+
|
|
4619
|
+
Possible values:
|
|
4620
|
+
- Equals, NotEqual: field equal / not equal to "value".
|
|
4621
|
+
- OneOf, NotOneOf: field equal / not equal to any of the elements of the "value" array.
|
|
4622
|
+
- Contains, DoesNotContain, StartsWith, EndsWith: partial text match on "value".
|
|
4623
|
+
- GreaterThan, GreaterThanOrEqualTo, LessThan, LessThanOrEqualTo: comparison with "value".
|
|
4624
|
+
- Between: field inside a range, "value" is an array of two elements [start, end].
|
|
4625
|
+
- IsNull, IsNotNull: field without / with a value, "value" is ignored.
|
|
4626
|
+
|
|
4627
|
+
Not every filter type is allowed on every field type:
|
|
4628
|
+
- Contains, DoesNotContain, StartsWith, EndsWith apply only to text fields; on fields searched by
|
|
4629
|
+
exact value (ids, codes, keywords) they return no results.
|
|
4630
|
+
- GreaterThan, GreaterThanOrEqualTo, LessThan, LessThanOrEqualTo and Between are meant for numeric and date fields.
|
|
4631
|
+
- Equals, NotEqual, OneOf, NotOneOf, IsNull, IsNotNull apply to any field type. */
|
|
4632
|
+
FilterType?: FieldFilterPublicType | undefined;
|
|
4633
|
+
/** Textual representation of the filter type in public responses. */
|
|
4634
|
+
readonly FilterTypeName?: string | undefined;
|
|
4635
|
+
}
|
|
4636
|
+
export interface FileParameter {
|
|
4637
|
+
data: any;
|
|
4638
|
+
fileName: string;
|
|
4639
|
+
}
|
|
4640
|
+
export interface FileResponse {
|
|
4641
|
+
data: Blob;
|
|
4642
|
+
status: number;
|
|
4643
|
+
fileName?: string;
|
|
4644
|
+
headers?: {
|
|
4645
|
+
[name: string]: any;
|
|
4646
|
+
};
|
|
4647
|
+
}
|
|
4648
|
+
export declare class ApiException extends Error {
|
|
4649
|
+
message: string;
|
|
4650
|
+
status: number;
|
|
4651
|
+
response: string;
|
|
4652
|
+
headers: {
|
|
4653
|
+
[key: string]: any;
|
|
4654
|
+
};
|
|
4655
|
+
result: any;
|
|
4656
|
+
constructor(message: string, status: number, response: string, headers: {
|
|
4657
|
+
[key: string]: any;
|
|
4658
|
+
}, result: any);
|
|
4659
|
+
protected isApiException: boolean;
|
|
4660
|
+
static isApiException(obj: any): obj is ApiException;
|
|
4661
|
+
}
|
|
4662
|
+
export declare class JarvisApiBaseClient {
|
|
4663
|
+
constructor();
|
|
4664
|
+
}
|
|
4665
|
+
/**
|
|
4666
|
+
* Configuration class needed in base class.
|
|
4667
|
+
* The config is provided to the API client at initialization time.
|
|
4668
|
+
* API clients inherit from #AuthorizedApiBase and provide the config.
|
|
4669
|
+
*/
|
|
4670
|
+
export declare class JarvisApiConfig {
|
|
4671
|
+
jarvisToken: string;
|
|
4672
|
+
jarvisCallInfoHeader?: string | undefined;
|
|
4673
|
+
/**
|
|
4674
|
+
* Returns a valid value for the Authorization header.
|
|
4675
|
+
* Used to dynamically inject the current auth header and call info header.
|
|
4676
|
+
*/
|
|
4677
|
+
constructor(jarvisToken: string, jarvisCallInfoHeader?: string | undefined);
|
|
4678
|
+
}
|