octopian-configuration-apis 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/README.md +104 -0
  2. package/package.json +18 -0
  3. package/src/CoreServices/configurationServices.js +1501 -0
  4. package/src/CoreServices/darAlBerServices.js +239 -0
  5. package/src/config.js +22 -0
  6. package/src/index.d.ts +908 -0
  7. package/src/index.js +101 -0
  8. package/src/modals/input-modals/CreateNewCorrespondenceInput.ts +7 -0
  9. package/src/modals/input-modals/GetAssetBlazorViewInput.ts +4 -0
  10. package/src/modals/input-modals/GetAssetListInput.ts +8 -0
  11. package/src/modals/input-modals/GetAttributeTypesInput.ts +6 -0
  12. package/src/modals/input-modals/GetDABAssetsInput.ts +4 -0
  13. package/src/modals/input-modals/GetDocumentTypesInput.ts +6 -0
  14. package/src/modals/input-modals/GetInteractorListInput.ts +5 -0
  15. package/src/modals/input-modals/GetItemListInput.ts +8 -0
  16. package/src/modals/input-modals/GetPositionsInput.ts +6 -0
  17. package/src/modals/input-modals/GetRoleListByPermissionInput.ts +13 -0
  18. package/src/modals/input-modals/GetServiceAttributeListInput.ts +8 -0
  19. package/src/modals/input-modals/GetServiceCategoryInput.ts +6 -0
  20. package/src/modals/input-modals/GetServiceListInput.ts +10 -0
  21. package/src/modals/input-modals/GetServiceStepListInput.ts +8 -0
  22. package/src/modals/input-modals/GetServiceSubCategoryInput.ts +7 -0
  23. package/src/modals/input-modals/GetStepTypesInput.ts +7 -0
  24. package/src/modals/input-modals/LoginUserInput.ts +8 -0
  25. package/src/modals/input-modals/MaintainAttributeListInput.ts +6 -0
  26. package/src/modals/input-modals/MaintainAttributeTypeInput.ts +142 -0
  27. package/src/modals/input-modals/MaintainSubCategoryInput.ts +6 -0
  28. package/src/modals/output-modals/BaseResponse.ts +13 -0
  29. package/src/modals/output-modals/GetAssetBlazorViewOutput.ts +11 -0
  30. package/src/modals/output-modals/GetAssetListOutput.ts +92 -0
  31. package/src/modals/output-modals/GetAttributeTypesOutput.ts +37 -0
  32. package/src/modals/output-modals/GetDefaultConfigurationOutput.ts +273 -0
  33. package/src/modals/output-modals/GetDocumentTypesOutput.ts +23 -0
  34. package/src/modals/output-modals/GetInteractorListOutput.ts +81 -0
  35. package/src/modals/output-modals/GetInteractorTypeListOutput.ts +59 -0
  36. package/src/modals/output-modals/GetItemListOutput.ts +92 -0
  37. package/src/modals/output-modals/GetPositionsOutput.ts +10 -0
  38. package/src/modals/output-modals/GetRoleListByPermissionOutput.ts +18 -0
  39. package/src/modals/output-modals/GetServiceAttributeListOutput.ts +95 -0
  40. package/src/modals/output-modals/GetServiceCategoryOutput.ts +62 -0
  41. package/src/modals/output-modals/GetServiceListOutput.ts +183 -0
  42. package/src/modals/output-modals/GetServiceStepListOutput.ts +163 -0
  43. package/src/modals/output-modals/GetServiceSubCategoryOuput.ts +71 -0
  44. package/src/modals/output-modals/GetStepTypesOutput.ts +7 -0
  45. package/src/modals/output-modals/GetUnitListOutput.ts +27 -0
  46. package/src/modals/output-modals/LoginUserOutput.ts +8 -0
  47. package/src/sdkUtilities.js +22 -0
  48. package/src/web-services/apiConstants.js +99 -0
  49. package/src/web-services/apiHandler.js +154 -0
package/src/index.d.ts ADDED
@@ -0,0 +1,908 @@
1
+ import { GetServiceAttributeListInput } from "./modals/input-modals/GetServiceAttributeListInput";
2
+ import { GetServiceListInput } from "./modals/input-modals/GetServiceListInput";
3
+ import { MaintainAttributeListInput } from "./modals/input-modals/MaintainAttributeListInput";
4
+ import { GetServiceStepListInput } from "./modals/input-modals/GetServiceStepListInput";
5
+ import {
6
+ BaseErrorResponse,
7
+ BaseResponse,
8
+ } from "./modals/output-modals/BaseResponse";
9
+ import { GetServiceAttributeListOutput } from "./modals/output-modals/GetServiceAttributeListOutput";
10
+ import { GetServiceListOutput } from "./modals/output-modals/GetServiceListOutput";
11
+ import { GetServiceStepListOutput } from "./modals/output-modals/GetServiceStepListOutput";
12
+ import { GetServiceCategoryInput } from "./modals/input-modals/GetServiceCategoryInput";
13
+ import { GetServiceCategoryOutput } from "./modals/output-modals/GetServiceCategoryOutput";
14
+ import { GetServiceSubCategoryOutput } from "./modals/output-modals/GetServiceSubCategoryOuput";
15
+ import { MaintainSubCategoryInput } from "./modals/input-modals/MaintainSubCategoryInput";
16
+ import { GetServiceSubCategoryInput } from "./modals/input-modals/GetServiceSubCategoryInput";
17
+ import { GetAssetListOutput } from "./modals/output-modals/GetAssetListOutput";
18
+ import { GetAssetListInput } from "./modals/input-modals/GetAssetListInput";
19
+ import { GetItemListOutput } from "./modals/output-modals/GetItemListOutput";
20
+ import { GetItemListInput } from "./modals/input-modals/GetItemListInput";
21
+ import { GetPositionsInput } from "./modals/input-modals/GetPositionsInput";
22
+ import { GetPositionsOutput } from "./modals/output-modals/GetPositionsOutput";
23
+ import { GetDocumentTypesOutput } from "./modals/output-modals/GetDocumentTypesOutput";
24
+ import { GetAttributeTypesInput } from "./modals/input-modals/GetAttributeTypesInput";
25
+ import { GetAttributeTypesOutput } from "./modals/output-modals/GetAttributeTypesOutput";
26
+ import { GetStepTypesInput } from "./modals/input-modals/GetStepTypesInput";
27
+ import { GetStepTypesOutput } from "./modals/output-modals/GetStepTypesOutput";
28
+ import { GetDABAssetsInput } from "./modals/input-modals/GetDABAssetsInput";
29
+ import {
30
+ MaintainAttributeTypeInput,
31
+ AttributeTypeSimpleIntegrationDto,
32
+ AttributeTypeValueDto,
33
+ AttributeTypeRecordDto,
34
+ AttributeTypeAssetListDto,
35
+ AttributeTypeItemListDto,
36
+ AttributeTypeAssetSubGroupListDto,
37
+ AttributeTypeItemSubGroupListDto,
38
+ AttributeTypeUnitListDto,
39
+ AttributeTypeInteractorListDto,
40
+ AttributeTypePositionListDto,
41
+ AttributeTypeDocumentDto,
42
+ AttributeTypePersonalUnitMemberDto,
43
+ } from "./modals/input-modals/MaintainAttributeTypeInput";
44
+ import { GetDocumentTypesInput } from "./modals/input-modals/GetDocumentTypesInput";
45
+ import { LoginUserInput } from "./modals/input-modals/LoginUserInput";
46
+ import { LoginUserOutput } from "./modals/output-modals/LoginUserOutput";
47
+ import { GetRoleListByPermissionInput } from "./modals/input-modals/GetRoleListByPermissionInput";
48
+ import { GetRoleListByPermissionOutput } from "./modals/output-modals/GetRoleListByPermissionOutput";
49
+ import { GetInteractorTypeListOutput } from "./modals/output-modals/GetInteractorTypeListOutput";
50
+ import {
51
+ GetDefaultConfigurationOutput,
52
+ GetCurrentUserPermissionOutputDto,
53
+ StakeholderDto,
54
+ AttributeTypeDto,
55
+ PositionTypeDto,
56
+ StepTypeDto,
57
+ AttributeSetDto,
58
+ FormatTypeDto,
59
+ RoleTypeDto,
60
+ CompanyLanguageDto,
61
+ IntegrationConnectionDto,
62
+ AttributeTypeValueTypeDto,
63
+ CompanyEncryptionCertificateDto,
64
+ QuestionnaireTemplateDto,
65
+ GroupDto,
66
+ CloudPrinterDto,
67
+ AccountingBookTypeDto,
68
+ RequestStatusDto,
69
+ CountryDto,
70
+ RoleDto,
71
+ PriceBookTypeDto,
72
+ UnitOfMeasureTypeDto,
73
+ NotificationMessageDto,
74
+ } from "./modals/output-modals/GetDefaultConfigurationOutput";
75
+ import { CreateNewCorrespondenceInput } from "./modals/input-modals/CreateNewCorrespondenceInput";
76
+ import { GetInteractorListOutput } from "./modals/output-modals/GetInteractorListOutput";
77
+ import { GetInteractorListInput } from "./modals/input-modals/GetInteractorListInput";
78
+ import { GetUnitListOutput } from "./modals/output-modals/GetUnitListOutput";
79
+ // Define each module with its specific functions
80
+ interface ConfigurationServices {
81
+ /**
82
+ * @description
83
+ * Submits a request to login using the provided input data.
84
+ *
85
+ * @param {LoginUserInput} Input
86
+ * The data required to process the request to login.
87
+ *
88
+ * @param {number} Timeout
89
+ * Optional time in milliseconds to wait before the request times out. Default is 30000.
90
+ *
91
+ * @returns {BaseResponse<LoginUserOutput | BaseErrorResponse>}
92
+ * An object containing the response from the Login API,
93
+ * including a success message, status code, and any additional data returned by the API.
94
+ * {
95
+ * Message: Success,
96
+ * StatusCode: 200,
97
+ * Result: LoginUserOutput,
98
+ * }
99
+ */
100
+ Login: (
101
+ Input: LoginUserInput,
102
+ Timeout?: number | null
103
+ ) => BaseResponse<LoginUserOutput | BaseErrorResponse>;
104
+ /**
105
+ * @description
106
+ * Submits a request to become a benefit grantor using the provided input data.
107
+ *
108
+ * @param {GetServiceListInput} Input
109
+ * The data required to process the request to become a benefit grantor.
110
+ * pageSize: number;
111
+ * pageIndex: number;
112
+ * interactorTypeId: number;
113
+ * serviceCategoryId: number;
114
+ * serviceSubCategoryId: number;
115
+ * serviceId: number;
116
+ * serviceIdList: number[];
117
+ * shortcutServiceId: number;
118
+ *
119
+ * @param {string} AuthToken
120
+ * Optional authentication token for authorization purposes. Default is null.
121
+ *
122
+ * @param {number} Timeout
123
+ * Optional time in milliseconds to wait before the request times out. Default is 30000.
124
+ *
125
+ * @returns {BaseResponse<GetServiceListOutput[] | BaseErrorResponse>}
126
+ * An object containing the response from the GetServiceList API,
127
+ * including a success message, status code, and any additional data returned by the API.
128
+ * {
129
+ * Message: Success,
130
+ * StatusCode: 200,
131
+ * Result: GetServiceListOutput[],
132
+ * }
133
+ */
134
+ GetServiceList: (
135
+ Input: GetServiceListInput,
136
+ AuthToken?: string | null,
137
+ Timeout?: number | null
138
+ ) => BaseResponse<GetServiceListOutput[] | BaseErrorResponse>;
139
+
140
+ /**
141
+ * @description
142
+ * Submits a request to maintain a list of services using the provided input data.
143
+ *
144
+ * @param {GetServiceListOutput[]} Input
145
+ * The list of services to maintain.
146
+ *
147
+ * @param {string} AuthToken
148
+ * Optional authentication token for authorization purposes. Default is null.
149
+ *
150
+ * @param {number} Timeout
151
+ * Optional time in milliseconds to wait before the request times out. Default is 30000.
152
+ *
153
+ * @returns {BaseResponse<GetServiceListOutput[] | BaseErrorResponse>}
154
+ * An object containing the response from the MaintainServiceList API,
155
+ * including a success message, status code, and any additional data returned by the API.
156
+ * {
157
+ * Message: Success,
158
+ * StatusCode: 200,
159
+ * Result: GetServiceListOutput[],
160
+ * }
161
+ */
162
+ MaintainServiceList: (
163
+ Input: GetServiceListOutput[],
164
+ AuthToken?: string | null,
165
+ Timeout?: number | null
166
+ ) => BaseResponse<GetServiceListOutput[] | BaseErrorResponse>;
167
+
168
+ /**
169
+ * @description
170
+ * Submits a request to get a list of service steps using the provided input data.
171
+ *
172
+ * @param {GetServiceStepListInput} Input
173
+ * The data required to process the request to get a list of service steps.
174
+ *
175
+ * @param {string} AuthToken
176
+ * Optional authentication token for authorization purposes. Default is null.
177
+ *
178
+ * @param {number} Timeout
179
+ * Optional time in milliseconds to wait before the request times out. Default is 30000.
180
+ *
181
+ * @returns {BaseResponse<GetServiceStepListOutput[] | BaseErrorResponse>}
182
+ * An object containing the response from the GetServiceStepList API,
183
+ * including a success message, status code, and any additional data returned by the API.
184
+ * {
185
+ * Message: Success,
186
+ * StatusCode: 200,
187
+ * Result: GetServiceStepListOutput[],
188
+ * }
189
+ */
190
+ GetServiceStepList: (
191
+ Input: GetServiceStepListInput,
192
+ AuthToken?: string | null,
193
+ Timeout?: number | null
194
+ ) => BaseResponse<GetServiceStepListOutput[] | BaseErrorResponse>;
195
+
196
+ /**
197
+ * @description
198
+ * Submits a request to maintain a list of service steps using the provided input data.
199
+ *
200
+ * @param {GetServiceStepListOutput[]} Input
201
+ * The list of service steps to maintain.
202
+ *
203
+ * @param {string} AuthToken
204
+ * Optional authentication token for authorization purposes. Default is null.
205
+ *
206
+ * @param {number} Timeout
207
+ * Optional time in milliseconds to wait before the request times out. Default is 30000.
208
+ *
209
+ * @returns {BaseResponse<GetServiceStepListOutput[] | BaseErrorResponse>}
210
+ * An object containing the response from the MaintainServiceStepList API,
211
+ * including a success message, status code, and any additional data returned by the API.
212
+ * {
213
+ * Message: Success,
214
+ * StatusCode: 200,
215
+ * Result: GetServiceStepListOutput[],
216
+ * }
217
+ */
218
+ MaintainServiceStepList: (
219
+ Input: GetServiceStepListOutput[],
220
+ AuthToken?: string | null,
221
+ Timeout?: number | null
222
+ ) => BaseResponse<GetServiceStepListOutput[] | BaseErrorResponse>;
223
+
224
+ /**
225
+ * @description
226
+ * Submits a request to get a list of attributes using the provided input data.
227
+ *
228
+ * @param {GetServiceAttributeListInput} Input
229
+ * The data required to process the request to get a list of attributes.
230
+ *
231
+ * @param {string} AuthToken
232
+ * Optional authentication token for authorization purposes. Default is null.
233
+ *
234
+ * @param {number} Timeout
235
+ * Optional time in milliseconds to wait before the request times out. Default is 30000.
236
+ *
237
+ * @returns {BaseResponse<GetServiceAttributeListOutput[] | BaseErrorResponse>}
238
+ * An object containing the response from the GetAttributeList API,
239
+ * including a success message, status code, and any additional data returned by the API.
240
+ * {
241
+ * Message: Success,
242
+ * StatusCode: 200,
243
+ * Result: GetServiceAttributeListOutput[],
244
+ * }
245
+ */
246
+ GetAttributeList: (
247
+ Input: GetServiceAttributeListInput,
248
+ AuthToken?: string | null,
249
+ Timeout?: number | null
250
+ ) => BaseResponse<GetServiceAttributeListOutput[] | BaseErrorResponse>;
251
+
252
+ /**
253
+ * @description
254
+ * Submits a request to maintain a list of attributes using the provided input data.
255
+ *
256
+ * @param {MaintainAttributeListInput} Input
257
+ * The data required to process the request to maintain a list of attributes.
258
+ *
259
+ * @param {string} AuthToken
260
+ * Optional authentication token for authorization purposes. Default is null.
261
+ *
262
+ * @param {number} Timeout
263
+ * Optional time in milliseconds to wait before the request times out. Default is 30000.
264
+ *
265
+ * @returns {BaseResponse<GetServiceAttributeListOutput[] | BaseErrorResponse>}
266
+ * An object containing the response from the MaintainAttributeList API,
267
+ * including a success message, status code, and any additional data returned by the API.
268
+ * {
269
+ * Message: Success,
270
+ * StatusCode: 200,
271
+ * Result: GetServiceAttributeListOutput[],
272
+ * }
273
+ */
274
+ MaintainAttributeList: (
275
+ Input: MaintainAttributeListInput,
276
+ AuthToken?: string | null,
277
+ Timeout?: number | null
278
+ ) => BaseResponse<GetServiceAttributeListOutput[] | BaseErrorResponse>;
279
+ /**
280
+ * @description
281
+ * Submits a request to get a list of service categories using the provided input data.
282
+ *
283
+ * @param {GetServiceCategoryInput} Input
284
+ * The data required to process the request to get a list of service categories.
285
+ *
286
+ * @param {string} AuthToken
287
+ * Optional authentication token for authorization purposes. Default is null.
288
+ *
289
+ * @param {number} Timeout
290
+ * Optional time in milliseconds to wait before the request times out. Default is 30000.
291
+ *
292
+ * @returns {BaseResponse<GetServiceCategoryOutput[] | BaseErrorResponse>}
293
+ * An object containing the response from the GetServiceCategoryList API,
294
+ * including a success message, status code, and any additional data returned by the API.
295
+ * {
296
+ * Message: Success,
297
+ * StatusCode: 200,
298
+ * Result: GetServiceCategoryOutput[],
299
+ * }
300
+ */
301
+ GetServiceCategoryList: (
302
+ Input: GetServiceCategoryInput,
303
+ AuthToken?: string | null,
304
+ Timeout?: number | null
305
+ ) => BaseResponse<GetServiceCategoryOutput[] | BaseErrorResponse>;
306
+ /**
307
+ * @description
308
+ * Submits a request to maintain a list of service categories using the provided input data.
309
+ *
310
+ * @param {GetServiceCategoryOutput[]} Input
311
+ * The list of service categories to maintain.
312
+ *
313
+ * @param {string} AuthToken
314
+ * Optional authentication token for authorization purposes. Default is null.
315
+ *
316
+ * @param {number} Timeout
317
+ * Optional time in milliseconds to wait before the request times out. Default is 30000.
318
+ *
319
+ * @returns {BaseResponse<GetServiceCategoryOutput[] | BaseErrorResponse>}
320
+ * An object containing the response from the MaintainServiceCategoryList API,
321
+ * including a success message, status code, and any additional data returned by the API.
322
+ * {
323
+ * Message: Success,
324
+ * StatusCode: 200,
325
+ * Result: GetServiceCategoryOutput[],
326
+ * }
327
+ */
328
+ MaintainServiceCategoryList: (
329
+ Input: GetServiceCategoryOutput[],
330
+ AuthToken?: string | null,
331
+ Timeout?: number | null
332
+ ) => BaseResponse<GetServiceCategoryOutput[] | BaseErrorResponse>;
333
+ /**
334
+ * @description
335
+ * Submits a request to get a list of service subcategories using the provided input data.
336
+ *
337
+ * @param {GetServiceSubCategoryInput} Input
338
+ * The data required to process the request to get a list of service subcategories.
339
+ *
340
+ * @param {string} AuthToken
341
+ * Optional authentication token for authorization purposes. Default is null.
342
+ *
343
+ * @param {number} Timeout
344
+ * Optional time in milliseconds to wait before the request times out. Default is 30000.
345
+ *
346
+ * @returns {BaseResponse<GetServiceSubCategoryOutput[] | BaseErrorResponse>}
347
+ * An object containing the response from the GetServiceSubCategoryList API,
348
+ * including a success message, status code, and any additional data returned by the API.
349
+ * {
350
+ * Message: Success,
351
+ * StatusCode: 200,
352
+ * Result: GetServiceSubCategoryOutput[],
353
+ * }
354
+ */
355
+ GetServiceSubCategoryList: (
356
+ Input: GetServiceSubCategoryInput,
357
+ AuthToken?: string | null,
358
+ Timeout?: number | null
359
+ ) => BaseResponse<GetServiceSubCategoryOutput[] | BaseErrorResponse>;
360
+
361
+ /**
362
+ * @description
363
+ * Submits a request to maintain a list of service subcategories using the provided input data.
364
+ *
365
+ * @param {MaintainSubCategoryInput} Input
366
+ * The data required to process the request to maintain a list of service subcategories.
367
+ *
368
+ * @param {string} AuthToken
369
+ * Optional authentication token for authorization purposes. Default is null.
370
+ *
371
+ * @param {number} Timeout
372
+ * Optional time in milliseconds to wait before the request times out. Default is 30000.
373
+ *
374
+ * @returns {BaseResponse<GetServiceSubCategoryOutput[] | BaseErrorResponse>}
375
+ * An object containing the response from the MaintainServiceSubCategoryList API,
376
+ * including a success message, status code, and any additional data returned by the API.
377
+ * {
378
+ * Message: Success,
379
+ * StatusCode: 200,
380
+ * Result: GetServiceSubCategoryOutput[],
381
+ * }
382
+ */
383
+ MaintainServiceSubCategoryList: (
384
+ Input: MaintainSubCategoryInput,
385
+ AuthToken?: string | null,
386
+ Timeout?: number | null
387
+ ) => BaseResponse<GetServiceSubCategoryOutput[] | BaseErrorResponse>;
388
+ /**
389
+ * @description
390
+ * Submits a request to get a list of assets using the provided input data.
391
+ *
392
+ * @param {GetAssetListInput} Input
393
+ * The data required to process the request to get a list of assets.
394
+ *
395
+ * @param {string} AuthToken
396
+ * Optional authentication token for authorization purposes. Default is null.
397
+ *
398
+ * @param {number} Timeout
399
+ * Optional time in milliseconds to wait before the request times out. Default is 30000.
400
+ *
401
+ * @returns {BaseResponse<GetAssetListOutput[] | BaseErrorResponse>}
402
+ * An object containing the response from the GetAssetList API,
403
+ * including a success message, status code, and any additional data returned by the API.
404
+ * {
405
+ * Message: Success,
406
+ * StatusCode: 200,
407
+ * Result: GetAssetListOutput[],
408
+ * }
409
+ */
410
+ GetAssetList: (
411
+ Input: GetAssetListInput,
412
+ AuthToken?: string | null,
413
+ Timeout?: number | null
414
+ ) => BaseResponse<GetAssetListOutput[] | BaseErrorResponse>;
415
+ /**
416
+ * @description
417
+ * Submits a request to maintain a list of assets using the provided input data.
418
+ *
419
+ * @param {GetAssetListOutput[]} Input
420
+ * The list of assets to maintain.
421
+ *
422
+ * @param {string} AuthToken
423
+ * Optional authentication token for authorization purposes. Default is null.
424
+ *
425
+ * @param {number} Timeout
426
+ * Optional time in milliseconds to wait before the request times out. Default is 30000.
427
+ *
428
+ * @returns {BaseResponse<GetAssetListOutput[] | BaseErrorResponse>}
429
+ * An object containing the response from the MaintainAssetList API,
430
+ * including a success message, status code, and any additional data returned by the API.
431
+ * {
432
+ * Message: Success,
433
+ * StatusCode: 200,
434
+ * Result: GetAssetListOutput[],
435
+ * }
436
+ */
437
+ MaintainAssetList: (
438
+ Input: GetAssetListOutput[],
439
+ AuthToken?: string | null,
440
+ Timeout?: number | null
441
+ ) => BaseResponse<GetAssetListOutput[] | BaseErrorResponse>;
442
+ /**
443
+ * @description
444
+ * Submits a request to get a list of items using the provided input data.
445
+ *
446
+ * @param {GetItemListInput} Input
447
+ * The data required to process the request to get a list of items.
448
+ *
449
+ * @param {string} AuthToken
450
+ * Optional authentication token for authorization purposes. Default is null.
451
+ *
452
+ * @param {number} Timeout
453
+ * Optional time in milliseconds to wait before the request times out. Default is 30000.
454
+ *
455
+ * @returns {BaseResponse<GetItemListOutput[] | BaseErrorResponse>}
456
+ * An object containing the response from the GetItemList API,
457
+ * including a success message, status code, and any additional data returned by the API.
458
+ * {
459
+ * Message: Success,
460
+ * StatusCode: 200,
461
+ * Result: GetItemListOutput[],
462
+ * }
463
+ */
464
+ GetItemList: (
465
+ Input: GetItemListInput,
466
+ AuthToken?: string | null,
467
+ Timeout?: number | null
468
+ ) => BaseResponse<GetItemListOutput[] | BaseErrorResponse>;
469
+ /**
470
+ * @description
471
+ * Submits a request to maintain a list of items using the provided input data.
472
+ *
473
+ * @param {GetItemListOutput[]} Input
474
+ * The list of items to maintain.
475
+ *
476
+ * @param {string} AuthToken
477
+ * Optional authentication token for authorization purposes. Default is null.
478
+ *
479
+ * @param {number} Timeout
480
+ * Optional time in milliseconds to wait before the request times out. Default is 30000.
481
+ *
482
+ * @returns {BaseResponse<GetItemListOutput[] | BaseErrorResponse>}
483
+ * An object containing the response from the MaintainItemList API,
484
+ * including a success message, status code, and any additional data returned by the API.
485
+ * {
486
+ * Message: Success,
487
+ * StatusCode: 200,
488
+ * Result: GetItemListOutput[],
489
+ * }
490
+ */
491
+ MaintainItemList: (
492
+ Input: GetItemListOutput[],
493
+ AuthToken?: string | null,
494
+ Timeout?: number | null
495
+ ) => BaseResponse<GetItemListOutput[] | BaseErrorResponse>;
496
+ /**
497
+ * @description
498
+ * Submits a request to get a list of positions using the provided input data.
499
+ *
500
+ * @param {GetPositionsInput} Input
501
+ * The data required to process the request to get a list of positions.
502
+ *
503
+ * @param {string} AuthToken
504
+ * Optional authentication token for authorization purposes. Default is null.
505
+ *
506
+ * @param {number} Timeout
507
+ * Optional time in milliseconds to wait before the request times out. Default is 30000.
508
+ *
509
+ * @returns {BaseResponse<GetPositionsOutput[] | BaseErrorResponse>}
510
+ * An object containing the response from the GetPositionList API,
511
+ * including a success message, status code, and any additional data returned by the API.
512
+ * {
513
+ * Message: Success,
514
+ * StatusCode: 200,
515
+ * Result: GetPositionsOutput[],
516
+ * }
517
+ */
518
+ GetPositionList: (
519
+ Input: GetPositionsInput,
520
+ AuthToken?: string | null,
521
+ Timeout?: number | null
522
+ ) => BaseResponse<GetPositionsOutput[] | BaseErrorResponse>;
523
+ /**
524
+ * @description
525
+ * Submits a request to maintain a list of positions using the provided input data.
526
+ *
527
+ * @param {GetPositionsOutput[]} Input
528
+ * The list of positions to maintain.
529
+ *
530
+ * @param {string} AuthToken
531
+ * Optional authentication token for authorization purposes. Default is null.
532
+ *
533
+ * @param {number} Timeout
534
+ * Optional time in milliseconds to wait before the request times out. Default is 30000.
535
+ *
536
+ * @returns {BaseResponse<GetPositionsOutput[] | BaseErrorResponse>}
537
+ * An object containing the response from the MaintainPositionList API,
538
+ * including a success message, status code, and any additional data returned by the API.
539
+ * {
540
+ * Message: Success,
541
+ * StatusCode: 200,
542
+ * Result: GetPositionsOutput[],
543
+ * }
544
+ */
545
+ MaintainPositionList: (
546
+ Input: GetPositionsOutput[],
547
+ AuthToken?: string | null,
548
+ Timeout?: number | null
549
+ ) => BaseResponse<GetPositionsOutput[] | BaseErrorResponse>;
550
+ /**
551
+ * @description
552
+ * Submits a request to get a list of step types using the provided input data.
553
+ *
554
+ * @param {GetStepTypesInput} Input
555
+ * The data required to process the request to get a list of step types.
556
+ *
557
+ * @param {string} AuthToken
558
+ * Optional authentication token for authorization purposes. Default is null.
559
+ *
560
+ * @param {number} Timeout
561
+ * Optional time in milliseconds to wait before the request times out. Default is 30000.
562
+ *
563
+ * @returns {BaseResponse<GetStepTypesOutput[] | BaseErrorResponse>}
564
+ * An object containing the response from the GetStepTypeList API,
565
+ * including a success message, status code, and any additional data returned by the API.
566
+ * {
567
+ * Message: Success,
568
+ * StatusCode: 200,
569
+ * Result: GetStepTypesOutput[],
570
+ * }
571
+ */
572
+ GetStepTypeList: (
573
+ Input: GetStepTypesInput,
574
+ AuthToken?: string | null,
575
+ Timeout?: number | null
576
+ ) => BaseResponse<GetStepTypesOutput[] | BaseErrorResponse>;
577
+ /**
578
+ * @description
579
+ * Submits a request to maintain a list of step types using the provided input data.
580
+ *
581
+ * @param {GetStepTypesOutput[]} Input
582
+ * The list of step types to maintain.
583
+ *
584
+ * @param {string} AuthToken
585
+ * Optional authentication token for authorization purposes. Default is null.
586
+ *
587
+ * @param {number} Timeout
588
+ * Optional time in milliseconds to wait before the request times out. Default is 30000.
589
+ *
590
+ * @returns {BaseResponse<GetStepTypesOutput[] | BaseErrorResponse>}
591
+ * An object containing the response from the MaintainStepTypeList API,
592
+ * including a success message, status code, and any additional data returned by the API.
593
+ * {
594
+ * Message: Success,
595
+ * StatusCode: 200,
596
+ * Result: GetStepTypesOutput[],
597
+ * }
598
+ */
599
+ MaintainStepTypeList: (
600
+ Input: GetStepTypesOutput[],
601
+ AuthToken?: string | null,
602
+ Timeout?: number | null
603
+ ) => BaseResponse<GetStepTypesOutput[] | BaseErrorResponse>;
604
+ /**
605
+ * @description
606
+ * Submits a request to get a list of document types using the provided input data.
607
+ *
608
+ * @param {GetDocumentTypesInput} Input
609
+ * The data required to process the request to get a list of document types.
610
+ *
611
+ * @param {string} AuthToken
612
+ * Optional authentication token for authorization purposes. Default is null.
613
+ *
614
+ * @param {number} Timeout
615
+ * Optional time in milliseconds to wait before the request times out. Default is 30000.
616
+ *
617
+ * @returns {BaseResponse<GetDocumentTypesOutput[] | BaseErrorResponse>}
618
+ * An object containing the response from the GetDocumentTypeList API,
619
+ * including a success message, status code, and any additional data returned by the API.
620
+ * {
621
+ * Message: Success,
622
+ * StatusCode: 200,
623
+ * Result: GetDocumentTypesOutput[],
624
+ * }
625
+ */
626
+ GetDocumentTypeList: (
627
+ Input: GetDocumentTypesInput,
628
+ AuthToken?: string | null,
629
+ Timeout?: number | null
630
+ ) => BaseResponse<GetDocumentTypesOutput[] | BaseErrorResponse>;
631
+ /**
632
+ * @description
633
+ * Submits a request to maintain a list of document types using the provided input data.
634
+ *
635
+ * @param {GetDocumentTypesOutput[]} Input
636
+ * The list of document types to maintain.
637
+ *
638
+ * @param {string} AuthToken
639
+ * Optional authentication token for authorization purposes. Default is null.
640
+ *
641
+ * @param {number} Timeout
642
+ * Optional time in milliseconds to wait before the request times out. Default is 30000.
643
+ *
644
+ * @returns {BaseResponse<GetDocumentTypesOutput[] | BaseErrorResponse>}
645
+ * An object containing the response from the MaintainDocumentTypeList API,
646
+ * including a success message, status code, and any additional data returned by the API.
647
+ * {
648
+ * Message: Success,
649
+ * StatusCode: 200,
650
+ * Result: GetDocumentTypesOutput[],
651
+ * }
652
+ */
653
+ MaintainDocumentTypeList: (
654
+ Input: GetDocumentTypesOutput[],
655
+ AuthToken?: string | null,
656
+ Timeout?: number | null
657
+ ) => BaseResponse<GetDocumentTypesOutput[] | BaseErrorResponse>;
658
+ /**
659
+ * @description
660
+ * Submits a request to get a list of attribute types using the provided input data.
661
+ *
662
+ * @param {GetAttributeTypesInput} Input
663
+ * The data required to process the request to get a list of attribute types.
664
+ *
665
+ * @param {string} AuthToken
666
+ * Optional authentication token for authorization purposes. Default is null.
667
+ *
668
+ * @param {number} Timeout
669
+ * Optional time in milliseconds to wait before the request times out. Default is 30000.
670
+ *
671
+ * @returns {BaseResponse<GetAttributeTypesOutput[] | BaseErrorResponse>}
672
+ * An object containing the response from the GetAttributeTypeList API,
673
+ * including a success message, status code, and any additional data returned by the API.
674
+ * {
675
+ * Message: Success,
676
+ * StatusCode: 200,
677
+ * Result: GetAttributeTypesOutput[],
678
+ * }
679
+ */
680
+ GetAttributeTypeList: (
681
+ Input: GetAttributeTypesInput,
682
+ AuthToken?: string | null,
683
+ Timeout?: number | null
684
+ ) => BaseResponse<GetAttributeTypesOutput[] | BaseErrorResponse>;
685
+ /**
686
+ * @description
687
+ * Submits a request to maintain a list of attribute types using the provided input data.
688
+ *
689
+ * @param {MaintainAttributeTypeInput} Input
690
+ * The list of attribute types to maintain.
691
+ *
692
+ * @param {string} AuthToken
693
+ * Optional authentication token for authorization purposes. Default is null.
694
+ *
695
+ * @param {number} Timeout
696
+ * Optional time in milliseconds to wait before the request times out. Default is 30000.
697
+ *
698
+ * @returns {BaseResponse<GetAttributeTypesOutput[] | BaseErrorResponse>}
699
+ * An object containing the response from the MaintainAttributeTypeList API,
700
+ * including a success message, status code, and any additional data returned by the API.
701
+ * {
702
+ * Message: Success,
703
+ * StatusCode: 200,
704
+ * Result: GetAttributeTypesOutput[],
705
+ * }
706
+ */
707
+ MaintainAttributeTypeList: (
708
+ Input: MaintainAttributeTypeInput,
709
+ AuthToken?: string | null,
710
+ Timeout?: number | null
711
+ ) => BaseResponse<GetAttributeTypesOutput[] | BaseErrorResponse>;
712
+
713
+ GetDefaultConfigurationList: (
714
+ AuthToken?: string | null,
715
+ Timeout?: number | null
716
+ ) => BaseResponse<GetDefaultConfigurationOutput[] | BaseErrorResponse>;
717
+
718
+ GetInteractorTypeList: (
719
+ stakeholderId: number,
720
+ AuthToken?: string | null,
721
+ Timeout?: number | null
722
+ ) => BaseResponse<GetInteractorTypeListOutput[] | BaseErrorResponse>;
723
+
724
+ GetRoleListByPermission: (
725
+ Input: GetRoleListByPermissionInput,
726
+ AuthToken?: string | null,
727
+ Timeout?: number | null
728
+ ) => BaseResponse<GetRoleListByPermissionOutput[] | BaseErrorResponse>;
729
+
730
+ CreateWriteSAS: (
731
+ AuthToken?: string | null,
732
+ Timeout?: number | null
733
+ ) => BaseResponse<string | BaseErrorResponse>;
734
+
735
+ CreateNewCorrespondence: (
736
+ Input: CreateNewCorrespondenceInput,
737
+ AuthToken?: string | null,
738
+ Timeout?: number | null
739
+ ) => BaseResponse<GetServiceListOutput | BaseErrorResponse>;
740
+
741
+ getCorrespondenceList: (
742
+ AuthToken?: string | null,
743
+ Timeout?: number | null
744
+ ) => BaseResponse<GetServiceListOutput | BaseErrorResponse>;
745
+
746
+ GetUnitList: (
747
+ interactorTypeId: number,
748
+ AuthToken?: string | null,
749
+ Timeout?: number | null
750
+ ) => BaseResponse<GetUnitListOutput[] | BaseErrorResponse>;
751
+
752
+ GetInteractorList: (
753
+ Input: GetInteractorListInput,
754
+ AuthToken?: string | null,
755
+ Timeout?: number | null
756
+ ) => BaseResponse<GetInteractorListOutput[] | BaseErrorResponse>;
757
+ }
758
+
759
+ interface DABConfigurationServices {
760
+ GetEnglishNewsList: (
761
+ Input: GetDABAssetsInput,
762
+ AuthToken?: string | null,
763
+ Timeout?: number | null
764
+ ) => BaseResponse<GetAssetListOutput[] | BaseErrorResponse>;
765
+
766
+ GetArabicNewsList: (
767
+ Input: GetDABAssetsInput,
768
+ AuthToken?: string | null,
769
+ Timeout?: number | null
770
+ ) => BaseResponse<GetAssetListOutput[] | BaseErrorResponse>;
771
+
772
+ GetGeneralDonationsList: (
773
+ Input: GetDABAssetsInput,
774
+ AuthToken?: string | null,
775
+ Timeout?: number | null
776
+ ) => BaseResponse<GetAssetListOutput[] | BaseErrorResponse>;
777
+
778
+ GetQuickDonationsList: (
779
+ Input: GetDABAssetsInput,
780
+ AuthToken?: string | null,
781
+ Timeout?: number | null
782
+ ) => BaseResponse<GetAssetListOutput[] | BaseErrorResponse>;
783
+
784
+ GetCampaignsList: (
785
+ Input: GetDABAssetsInput,
786
+ AuthToken?: string | null,
787
+ Timeout?: number | null
788
+ ) => BaseResponse<GetAssetListOutput[] | BaseErrorResponse>;
789
+
790
+ GetBranchesList: (
791
+ Input: GetDABAssetsInput,
792
+ AuthToken?: string | null,
793
+ Timeout?: number | null
794
+ ) => BaseResponse<GetAssetListOutput[] | BaseErrorResponse>;
795
+
796
+ GetBanksAccountsList: (
797
+ Input: GetDABAssetsInput,
798
+ AuthToken?: string | null,
799
+ Timeout?: number | null
800
+ ) => BaseResponse<GetAssetListOutput[] | BaseErrorResponse>;
801
+
802
+ GetInteractorsList: (
803
+ Input: GetDABAssetsInput,
804
+ AuthToken?: string | null,
805
+ Timeout?: number | null
806
+ ) => BaseResponse<GetInteractorListOutput[] | BaseErrorResponse>;
807
+ }
808
+
809
+ interface ConfigurationSDKConfig {
810
+ /**
811
+ * Initializes the configuration with the specified API key and domain name.
812
+ *
813
+ * @param {string} APIKey - The API key to be used for configuration.
814
+ * @param {string} DomainName - The domain name to be used for configuration.
815
+ */
816
+ Init: (APIKey: string, DomainName: string) => void;
817
+ /**
818
+ * Sets the authentication token in the configuration.
819
+ *
820
+ * @param {string} Token - The authentication token to be set.
821
+ */
822
+ SetToken: (Token: string) => void;
823
+ }
824
+ // And so on for each service
825
+
826
+ // Export the modules
827
+ declare const ConfigurationServices: ConfigurationServices;
828
+ declare const ConfigurationSDKConfig: ConfigurationSDKConfig;
829
+ declare const DABConfigurationServices: DABConfigurationServices;
830
+
831
+ // Export the main module
832
+ export {
833
+ ConfigurationServices,
834
+ ConfigurationSDKConfig,
835
+ DABConfigurationServices,
836
+ BaseErrorResponse,
837
+ BaseResponse,
838
+ GetServiceListInput,
839
+ GetServiceStepListInput,
840
+ GetServiceAttributeListInput,
841
+ MaintainAttributeListInput,
842
+ GetServiceListOutput,
843
+ GetServiceStepListOutput,
844
+ GetServiceAttributeListOutput,
845
+ GetServiceCategoryInput,
846
+ GetServiceCategoryOutput,
847
+ GetServiceSubCategoryOutput,
848
+ MaintainSubCategoryInput,
849
+ GetServiceSubCategoryInput,
850
+ GetAssetListOutput,
851
+ GetAssetListInput,
852
+ GetItemListOutput,
853
+ GetItemListInput,
854
+ GetPositionsInput,
855
+ GetPositionsOutput,
856
+ LoginUserInput,
857
+ LoginUserOutput,
858
+ GetStepTypesInput,
859
+ GetStepTypesOutput,
860
+ GetDocumentTypesInput,
861
+ GetDocumentTypesOutput,
862
+ GetAttributeTypesInput,
863
+ GetAttributeTypesOutput,
864
+ MaintainAttributeTypeInput,
865
+ AttributeTypeSimpleIntegrationDto,
866
+ AttributeTypeValueDto,
867
+ AttributeTypeRecordDto,
868
+ AttributeTypeAssetListDto,
869
+ AttributeTypeItemListDto,
870
+ AttributeTypeAssetSubGroupListDto,
871
+ AttributeTypeItemSubGroupListDto,
872
+ AttributeTypeUnitListDto,
873
+ AttributeTypeInteractorListDto,
874
+ AttributeTypePositionListDto,
875
+ AttributeTypeDocumentDto,
876
+ AttributeTypePersonalUnitMemberDto,
877
+ CreateNewCorrespondenceInput,
878
+ GetRoleListByPermissionInput,
879
+ GetRoleListByPermissionOutput,
880
+ GetInteractorTypeListOutput,
881
+ GetDefaultConfigurationOutput,
882
+ GetCurrentUserPermissionOutputDto,
883
+ StakeholderDto,
884
+ AttributeTypeDto,
885
+ PositionTypeDto,
886
+ StepTypeDto,
887
+ AttributeSetDto,
888
+ FormatTypeDto,
889
+ RoleTypeDto,
890
+ CompanyLanguageDto,
891
+ IntegrationConnectionDto,
892
+ AttributeTypeValueTypeDto,
893
+ CompanyEncryptionCertificateDto,
894
+ QuestionnaireTemplateDto,
895
+ GroupDto,
896
+ CloudPrinterDto,
897
+ AccountingBookTypeDto,
898
+ RequestStatusDto,
899
+ CountryDto,
900
+ RoleDto,
901
+ PriceBookTypeDto,
902
+ UnitOfMeasureTypeDto,
903
+ NotificationMessageDto,
904
+ GetDABAssetsInput,
905
+ GetInteractorListInput,
906
+ GetUnitListOutput,
907
+ GetInteractorListOutput
908
+ };