@springtree/eva-services-core-live-guard 3.0.0-beta.31 → 3.0.0-beta.33

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.
@@ -1,49 +1,49 @@
1
1
  import { ServiceError, ResponseMessageMetadata, PageConfig, DataModelsOrganizationUnitStatus, PagedResult, SchedulingTaskState, DevicesWatchtowerLog, UserTypes, SecurityFunctionalityScope, LiveGuardTOTPSecretWrapper, AddressesAddressDataDto, DataModelsInvoiceDocumentLedgerFormats, DataModelsInvoiceDocumentLedgerData, DataModelsInvoiceDocumentLedgerTypes, DataModelsInvoiceCalculationMethod, DataModelsInvoiceStatuses, DataModelsInvoiceTypes, DataModelsTaxRateCategory, DataModelsInvoiceLineTypes, CompaniesCompanyDto, DataModelsOrderBlobTypes, DataModelsReturnReasonType, AuditingAuditChainTypes } from '@springtree/eva-services-core';
2
2
  export declare const enum Errors {
3
3
  /**
4
- * You're not allowed to generate this liveguard api key.
4
+ * Could not determine a matching FleetManager.
5
5
  */
6
- LiveGuard_NotAllowedToGenerateApiKey = "LiveGuard:NotAllowedToGenerateApiKey",
6
+ FleetManager_UnableToDetermineFleetManager = "FleetManager:UnableToDetermineFleetManager",
7
7
  /**
8
- * You're not allowed to generate this liveguard secret.
8
+ * The FleetManager {:string} is not available.
9
9
  */
10
- LiveGuard_NotAllowedToGenerateSecret = "LiveGuard:NotAllowedToGenerateSecret",
10
+ FleetManager_FleetManagerNotAvailable = "FleetManager:FleetManagerNotAvailable",
11
11
  /**
12
- * This is a stub order for offline evapay payments, no mutations allowed.
12
+ * Device with HardwareID {hardwareID:string} was not found in FleetManager {fleetManager:string}.
13
13
  */
14
- LiveGuard_UnableToMutateEVAPayStub = "LiveGuard:UnableToMutateEVAPayStub",
14
+ FleetManager_DeviceNotInFleetManager = "FleetManager:DeviceNotInFleetManager",
15
15
  /**
16
- * Mender is not configured.
16
+ * Device is not valid for this FleetManager.
17
17
  */
18
- LiveGuardBoarding_MenderNotConfigured = "LiveGuardBoarding:MenderNotConfigured",
18
+ FleetManager_InvalidDevice = "FleetManager:InvalidDevice",
19
19
  /**
20
- * Device with HardwareID {:string} was not found in mender.
20
+ * Device was already boarded.
21
21
  */
22
- LiveGuardBoarding_DeviceNotInMender = "LiveGuardBoarding:DeviceNotInMender",
22
+ FleetManager_DeviceAlreadyBoarded = "FleetManager:DeviceAlreadyBoarded",
23
23
  /**
24
- * Device with HardwareID {:string} was already boarded in mender.
24
+ * Error while boarding the device: {:string}
25
25
  */
26
- LiveGuardBoarding_DeviceAlreadyBoarded = "LiveGuardBoarding:DeviceAlreadyBoarded",
26
+ FleetManager_BoardingFailed = "FleetManager:BoardingFailed",
27
27
  /**
28
28
  * Device with HardwareID {hardwareID:string} already exists with ID {deviceID:id}.
29
29
  */
30
- LiveGuardBoarding_DeviceAlreadyExists = "LiveGuardBoarding:DeviceAlreadyExists",
30
+ FleetManagerErrors_DeviceAlreadyExists = "FleetManagerErrors:DeviceAlreadyExists",
31
31
  /**
32
32
  * OrganizationUnit {organizationUnitID:id} already has a watchtower with ID {deviceID:id}.
33
33
  */
34
- LiveGuardBoarding_DuplicateOrganizationUnit = "LiveGuardBoarding:DuplicateOrganizationUnit",
34
+ FleetManagerErrors_DuplicateOrganizationUnit = "FleetManagerErrors:DuplicateOrganizationUnit",
35
35
  /**
36
- * No registration request found for this device. (Please reboot the device and try again)
36
+ * You're not allowed to generate this liveguard api key.
37
37
  */
38
- LiveGuardBoarding_NoRegistrationRequest = "LiveGuardBoarding:NoRegistrationRequest",
38
+ LiveGuard_NotAllowedToGenerateApiKey = "LiveGuard:NotAllowedToGenerateApiKey",
39
39
  /**
40
- * Error while accepting device keys.
40
+ * You're not allowed to generate this liveguard secret.
41
41
  */
42
- LiveGuardBoarding_AuthorizationFailed = "LiveGuardBoarding:AuthorizationFailed",
42
+ LiveGuard_NotAllowedToGenerateSecret = "LiveGuard:NotAllowedToGenerateSecret",
43
43
  /**
44
- * Error while boarding the device: {:string}
44
+ * This is a stub order for offline evapay payments, no mutations allowed.
45
45
  */
46
- LiveGuardBoarding_BoardingFailed = "LiveGuardBoarding:BoardingFailed",
46
+ LiveGuard_UnableToMutateEVAPayStub = "LiveGuard:UnableToMutateEVAPayStub",
47
47
  /**
48
48
  * The configuration is invalid.
49
49
  */
@@ -81,6 +81,10 @@ export declare const enum Errors {
81
81
  */
82
82
  LiveGuardLockStatus_UnlockFailed = "LiveGuardLockStatus:UnlockFailed",
83
83
  /**
84
+ * No registration request found for this device. (Please reboot the device and try again)
85
+ */
86
+ MenderClient_NoRegistrationRequest = "MenderClient:NoRegistrationRequest",
87
+ /**
84
88
  * There is no current connection to the selected device.
85
89
  */
86
90
  WatchtowerExecuteCommand_NoConnection = "WatchtowerExecuteCommand:NoConnection",
@@ -89,7 +93,7 @@ export declare const enum Errors {
89
93
  */
90
94
  WatchtowerIO_ConnectionFailed = "WatchtowerIO:ConnectionFailed"
91
95
  }
92
- export declare const enum MenderFleetManagerDeviceStatus {
96
+ export declare const enum ManagersFleetManagerDeviceStatus {
93
97
  Accepted = 1,
94
98
  Pending = 2,
95
99
  Rejected = 3,
@@ -99,66 +103,66 @@ export declare const enum MenderFleetManagerDeviceStatus {
99
103
  /**
100
104
  * Get an authentication token that's valid in the cloud for the current user
101
105
  */
102
- export interface LiveGuardGetCloudToken {
106
+ export interface LiveGuardGetCloudToken<ID_TYPE = string> {
103
107
  UseJwtTokens?: boolean;
104
108
  }
105
- export interface LiveGuardGetCloudTokenResponse {
109
+ export interface LiveGuardGetCloudTokenResponse<ID_TYPE = string> {
106
110
  AuthenticationToken: string;
107
- Error?: ServiceError;
108
- Metadata?: ResponseMessageMetadata;
111
+ Error?: ServiceError<ID_TYPE>;
112
+ Metadata?: ResponseMessageMetadata<ID_TYPE>;
109
113
  RefreshToken?: string;
110
114
  }
111
115
  /**
112
116
  * Returns id mapping for cloud vs liveguard entities
113
117
  */
114
- export interface LiveGuardGetMapping {
118
+ export interface LiveGuardGetMapping<ID_TYPE = string> {
115
119
  }
116
- export interface LiveGuardGetMappingResponse {
117
- Error?: ServiceError;
118
- Mapping?: Record<string, Record<string, string> | null>;
119
- Metadata?: ResponseMessageMetadata;
120
+ export interface LiveGuardGetMappingResponse<ID_TYPE = string> {
121
+ Error?: ServiceError<ID_TYPE>;
122
+ Mapping?: Record<string, Record<string, ID_TYPE> | null>;
123
+ Metadata?: ResponseMessageMetadata<ID_TYPE>;
120
124
  }
121
125
  /**
122
126
  * Create a new SSL certificate for a Watchtower device.
123
127
  */
124
- export interface CreateWatchtowerCertificate {
128
+ export interface CreateWatchtowerCertificate<ID_TYPE = string> {
125
129
  CertificateSigningRequest: string;
126
130
  }
127
- export interface CreateWatchtowerCertificateResponse {
131
+ export interface CreateWatchtowerCertificateResponse<ID_TYPE = string> {
128
132
  Certificate: string;
129
- Error?: ServiceError;
130
- Metadata?: ResponseMessageMetadata;
133
+ Error?: ServiceError<ID_TYPE>;
134
+ Metadata?: ResponseMessageMetadata<ID_TYPE>;
131
135
  }
132
136
  /**
133
137
  * Create a new watchtower device
134
138
  *
135
139
  * To create a device for fallback IO, leave the HardwareID null
136
- * When a HardwareID is set, the device will be boarded in mender and prepared for use.
140
+ * When a HardwareID is set, the device will be boarded and prepared for use.
137
141
  */
138
- export interface CreateWatchtowerDevice {
142
+ export interface CreateWatchtowerDevice<ID_TYPE = string> {
139
143
  HardwareID?: string;
140
144
  Name: string;
141
145
  /**
142
146
  * Entity type: OrganizationUnit
143
147
  */
144
- OrganizationUnitID: string;
148
+ OrganizationUnitID: ID_TYPE;
145
149
  }
146
- export interface CreateWatchtowerDeviceResponse {
150
+ export interface CreateWatchtowerDeviceResponse<ID_TYPE = string> {
147
151
  ApiKey?: string;
148
- Error?: ServiceError;
152
+ Error?: ServiceError<ID_TYPE>;
149
153
  /**
150
154
  * Entity type: Device
151
155
  */
152
- ID: string;
153
- Metadata?: ResponseMessageMetadata;
156
+ ID: ID_TYPE;
157
+ Metadata?: ResponseMessageMetadata<ID_TYPE>;
154
158
  }
155
159
  /**
156
160
  * List the configured watchtower devices with their status
157
161
  */
158
- export interface ListWatchtowerDevices {
159
- PageConfig?: PageConfig<ServicesManagementListWatchtowerDevicesFilter>;
162
+ export interface ListWatchtowerDevices<ID_TYPE = string> {
163
+ PageConfig?: PageConfig<ServicesManagementListWatchtowerDevicesFilter<ID_TYPE>, ID_TYPE>;
160
164
  }
161
- export interface ServicesManagementListWatchtowerDevicesFilter {
165
+ export interface ServicesManagementListWatchtowerDevicesFilter<ID_TYPE = string> {
162
166
  /**
163
167
  * Entity type: Country
164
168
  */
@@ -166,7 +170,7 @@ export interface ServicesManagementListWatchtowerDevicesFilter {
166
170
  /**
167
171
  * Entity type: Device
168
172
  */
169
- DeviceID?: string;
173
+ DeviceID?: ID_TYPE;
170
174
  FleetManagerID?: string;
171
175
  HardwareID?: string;
172
176
  IncludeChildOrganizationUnits?: boolean;
@@ -178,20 +182,20 @@ export interface ServicesManagementListWatchtowerDevicesFilter {
178
182
  /**
179
183
  * Entity type: OrganizationUnit
180
184
  */
181
- OrganizationUnitID?: string;
185
+ OrganizationUnitID?: ID_TYPE;
182
186
  OrganizationUnitStatus?: DataModelsOrganizationUnitStatus;
183
187
  }
184
- export interface ListWatchtowerDevicesResponse {
185
- Error?: ServiceError;
186
- Metadata?: ResponseMessageMetadata;
187
- Result?: PagedResult<ServicesManagementListWatchtowerDevicesResponse_Watchtower>;
188
+ export interface ListWatchtowerDevicesResponse<ID_TYPE = string> {
189
+ Error?: ServiceError<ID_TYPE>;
190
+ Metadata?: ResponseMessageMetadata<ID_TYPE>;
191
+ Result?: PagedResult<ServicesManagementListWatchtowerDevicesResponse_Watchtower<ID_TYPE>, ID_TYPE>;
188
192
  }
189
- export interface ServicesManagementListWatchtowerDevicesResponse_Watchtower {
193
+ export interface ServicesManagementListWatchtowerDevicesResponse_Watchtower<ID_TYPE = string> {
190
194
  HardwareID?: string;
191
195
  /**
192
196
  * Entity type: Device
193
197
  */
194
- ID: string;
198
+ ID: ID_TYPE;
195
199
  LastSeen?: string;
196
200
  Locked: boolean;
197
201
  Name?: string;
@@ -207,7 +211,7 @@ export interface ServicesManagementListWatchtowerDevicesResponse_Watchtower {
207
211
  /**
208
212
  * Entity type: OrganizationUnit
209
213
  */
210
- OrganizationUnitID: string;
214
+ OrganizationUnitID: ID_TYPE;
211
215
  OrganizationUnitName?: string;
212
216
  OrganizationUnitStatus: DataModelsOrganizationUnitStatus;
213
217
  WatchtowerConnected: boolean;
@@ -218,85 +222,85 @@ export interface ServicesManagementListWatchtowerDevicesResponse_Watchtower {
218
222
  /**
219
223
  * Execute a command on a device
220
224
  */
221
- export interface LiveGuardExecuteTask {
225
+ export interface LiveGuardExecuteTask<ID_TYPE = string> {
222
226
  Catalog?: boolean;
223
227
  /**
224
228
  * Entity type: Device
225
229
  */
226
- DeviceID: string;
230
+ DeviceID: ID_TYPE;
227
231
  General?: boolean;
228
232
  Users?: boolean;
229
233
  }
230
234
  /**
231
235
  * Push the current configuration for the given device to mender
232
236
  */
233
- export interface PushWatchtowerConfigurationToDevice {
237
+ export interface PushWatchtowerConfigurationToDevice<ID_TYPE = string> {
234
238
  /**
235
239
  * Entity type: Device
236
240
  */
237
- DeviceID: string;
241
+ DeviceID: ID_TYPE;
238
242
  }
239
243
  /**
240
244
  * Update the lock status of a watchtower device.
241
245
  *
242
246
  * This can only be done when the device is online
243
247
  */
244
- export interface ToggleLockStatusForWatchtowerDevice {
248
+ export interface ToggleLockStatusForWatchtowerDevice<ID_TYPE = string> {
245
249
  /**
246
250
  * Entity type: Device
247
251
  */
248
- DeviceID: string;
252
+ DeviceID: ID_TYPE;
249
253
  IsLocked?: boolean;
250
254
  }
251
255
  /**
252
256
  * Execute a command on a device
253
257
  */
254
- export interface WatchtowerExecuteCommand {
258
+ export interface WatchtowerExecuteCommand<ID_TYPE = string> {
255
259
  Address?: string;
256
260
  /**
257
261
  * Entity type: Device
258
262
  */
259
- DeviceID: string;
263
+ DeviceID: ID_TYPE;
260
264
  Port?: number;
261
265
  Type: string;
262
266
  }
263
- export interface WatchtowerExecuteCommandResponse {
264
- Error?: ServiceError;
265
- Metadata?: ResponseMessageMetadata;
267
+ export interface WatchtowerExecuteCommandResponse<ID_TYPE = string> {
268
+ Error?: ServiceError<ID_TYPE>;
269
+ Metadata?: ResponseMessageMetadata<ID_TYPE>;
266
270
  Output?: string;
267
271
  Success: boolean;
268
272
  }
269
273
  /**
270
274
  * Get details about the given device.
271
275
  */
272
- export interface WatchtowerGetDeviceDetails {
276
+ export interface WatchtowerGetDeviceDetails<ID_TYPE = string> {
273
277
  /**
274
278
  * Entity type: Device
275
279
  */
276
- DeviceID: string;
280
+ DeviceID: ID_TYPE;
277
281
  }
278
- export interface WatchtowerGetDeviceDetailsResponse {
282
+ export interface WatchtowerGetDeviceDetailsResponse<ID_TYPE = string> {
279
283
  CatalogTaskState?: SchedulingTaskState;
280
284
  CatalogTaskStateLastRunTime?: string;
281
285
  EVAVersion?: string;
282
286
  EVAVersionLastCheckinTime?: string;
283
- Error?: ServiceError;
287
+ Error?: ServiceError<ID_TYPE>;
284
288
  FleetManagerID?: string;
285
289
  FleetManagerLastCheckIn?: string;
286
- FleetManagerStatus?: MenderFleetManagerDeviceStatus;
290
+ FleetManagerStatus?: ManagersFleetManagerDeviceStatus;
287
291
  GeneralTaskState?: SchedulingTaskState;
288
292
  GeneralTaskStateLastRunTime?: string;
289
293
  HardwareID?: string;
290
- ID: string;
294
+ ID: ID_TYPE;
291
295
  IOVersion?: string;
292
296
  IOVersionLastCheckinTime?: string;
293
297
  LastSeen?: string;
294
298
  LiveGuardStateLastCheckinTime?: string;
295
299
  Locked: boolean;
296
- Logs?: DevicesWatchtowerLog[];
300
+ Logs?: DevicesWatchtowerLog<ID_TYPE>[];
297
301
  MenderID?: string;
298
- Metadata?: ResponseMessageMetadata;
299
- NetworkInterfaces?: ServicesManagementWatchtowerGetDeviceDetailsResponse_NetworkInterface[];
302
+ Metadata?: ResponseMessageMetadata<ID_TYPE>;
303
+ NetworkInterfaces?: ServicesManagementWatchtowerGetDeviceDetailsResponse_NetworkInterface<ID_TYPE>[];
300
304
  OSVersion?: string;
301
305
  OSVersionLastCheckinTime?: string;
302
306
  Online: boolean;
@@ -308,7 +312,7 @@ export interface WatchtowerGetDeviceDetailsResponse {
308
312
  /**
309
313
  * Entity type: OrganizationUnit
310
314
  */
311
- OrganizationUnitID: string;
315
+ OrganizationUnitID: ID_TYPE;
312
316
  OrganizationUnitName?: string;
313
317
  OrganizationUnitStatus: DataModelsOrganizationUnitStatus;
314
318
  PendingOrderExports?: number;
@@ -325,35 +329,35 @@ export interface WatchtowerGetDeviceDetailsResponse {
325
329
  WatchtowerIOLastSeen?: string;
326
330
  WatchtowerLastSeen?: string;
327
331
  }
328
- export interface ServicesManagementWatchtowerGetDeviceDetailsResponse_NetworkInterface {
332
+ export interface ServicesManagementWatchtowerGetDeviceDetailsResponse_NetworkInterface<ID_TYPE = string> {
329
333
  IPV4?: string;
330
334
  IPV6?: string;
331
335
  MacAddress?: string;
332
336
  Name?: string;
333
337
  }
334
- export interface EVAStatus {
338
+ export interface EVAStatus<ID_TYPE = string> {
335
339
  }
336
- export interface EVAStatusResponse {
337
- Error?: ServiceError;
338
- Metadata?: ResponseMessageMetadata;
340
+ export interface EVAStatusResponse<ID_TYPE = string> {
341
+ Error?: ServiceError<ID_TYPE>;
342
+ Metadata?: ResponseMessageMetadata<ID_TYPE>;
339
343
  Ready: boolean;
340
344
  }
341
345
  /**
342
346
  * Returns some basic information about the current state of the liveGuard
343
347
  */
344
- export interface LiveGuardGetInformation {
348
+ export interface LiveGuardGetInformation<ID_TYPE = string> {
345
349
  }
346
- export interface LiveGuardGetInformationResponse {
350
+ export interface LiveGuardGetInformationResponse<ID_TYPE = string> {
347
351
  CatalogTaskLastRun?: string;
348
352
  CatalogTaskState?: SchedulingTaskState;
349
- Error?: ServiceError;
353
+ Error?: ServiceError<ID_TYPE>;
350
354
  GeneralTaskLastRun?: string;
351
355
  GeneralTaskState?: SchedulingTaskState;
352
356
  HardwareID?: string;
353
357
  LastCatalogSync?: string;
354
358
  LastGeneralSync?: string;
355
359
  LastUserSync?: string;
356
- Metadata?: ResponseMessageMetadata;
360
+ Metadata?: ResponseMessageMetadata<ID_TYPE>;
357
361
  OrganizationUnitBackendID?: string;
358
362
  OrganizationUnitName?: string;
359
363
  PendingOrderExports: number;
@@ -367,20 +371,20 @@ export interface LiveGuardGetInformationResponse {
367
371
  /**
368
372
  * This service returns the operational flags for a liveguard instance.
369
373
  */
370
- export interface LiveGuardGetStatus {
374
+ export interface LiveGuardGetStatus<ID_TYPE = string> {
371
375
  }
372
- export interface LiveGuardGetStatusResponse {
376
+ export interface LiveGuardGetStatusResponse<ID_TYPE = string> {
373
377
  DisableCheckTask: boolean;
374
378
  EVACloudAvailable: boolean;
375
- Error?: ServiceError;
379
+ Error?: ServiceError<ID_TYPE>;
376
380
  InternetAvailable: boolean;
377
- Metadata?: ResponseMessageMetadata;
381
+ Metadata?: ResponseMessageMetadata<ID_TYPE>;
378
382
  RunningOnWatchtower: boolean;
379
383
  }
380
384
  /**
381
385
  * Push metrics of the watchtower device to the cloud.
382
386
  */
383
- export interface LiveGuardPushMetrics {
387
+ export interface LiveGuardPushMetrics<ID_TYPE = string> {
384
388
  AvgLatency?: number;
385
389
  CPUUsage?: number;
386
390
  DNSLatency?: number;
@@ -390,7 +394,7 @@ export interface LiveGuardPushMetrics {
390
394
  IOVersion?: string;
391
395
  LastBootTime?: string;
392
396
  Latency?: number;
393
- Logs?: DevicesWatchtowerLog[];
397
+ Logs?: DevicesWatchtowerLog<ID_TYPE>[];
394
398
  OSVersion?: string;
395
399
  RAMUsage?: number;
396
400
  State?: string;
@@ -401,7 +405,7 @@ export interface LiveGuardPushMetrics {
401
405
  *
402
406
  * This should never be used in production environments. This is used to mimick offline scenario's in liveguard deployments in the cloud.
403
407
  */
404
- export interface LiveGuardSetStatus {
408
+ export interface LiveGuardSetStatus<ID_TYPE = string> {
405
409
  /**
406
410
  * Disable the automatic task that checks for Internet/EVACloud. This should be set to true if these properties need to be managed by hand.
407
411
  */
@@ -422,16 +426,16 @@ export interface LiveGuardSetStatus {
422
426
  /**
423
427
  * Get user information to sync to LiveGuard
424
428
  */
425
- export interface GetUserForLiveGuard {
429
+ export interface GetUserForLiveGuard<ID_TYPE = string> {
426
430
  EmailAddress?: string;
427
431
  NickName?: string;
428
432
  /**
429
433
  * Entity type: User
430
434
  */
431
- UserID?: string;
435
+ UserID?: ID_TYPE;
432
436
  }
433
- export interface GetUserForLiveGuardResponse {
434
- AuthenticationData?: ServicesSyncGetUserForLiveGuardResponse_AuthenticationDataDto[];
437
+ export interface GetUserForLiveGuardResponse<ID_TYPE = string> {
438
+ AuthenticationData?: ServicesSyncGetUserForLiveGuardResponse_AuthenticationDataDto<ID_TYPE>[];
435
439
  BackendID?: string;
436
440
  BackendSystemID?: string;
437
441
  /**
@@ -439,114 +443,114 @@ export interface GetUserForLiveGuardResponse {
439
443
  */
440
444
  CountryID?: string;
441
445
  EmailAddress?: string;
442
- Error?: ServiceError;
446
+ Error?: ServiceError<ID_TYPE>;
443
447
  FirstName?: string;
444
448
  /**
445
449
  * Entity type: Language
446
450
  */
447
451
  LanguageID?: string;
448
452
  LastName?: string;
449
- Metadata?: ResponseMessageMetadata;
453
+ Metadata?: ResponseMessageMetadata<ID_TYPE>;
450
454
  Nickname?: string;
451
- Roles?: ServicesSyncGetUserForLiveGuardResponse_RoleDto[];
455
+ Roles?: ServicesSyncGetUserForLiveGuardResponse_RoleDto<ID_TYPE>[];
452
456
  TimeZone?: string;
453
457
  Type: UserTypes;
454
458
  }
455
- export interface ServicesSyncGetUserForLiveGuardResponse_AuthenticationDataDto {
459
+ export interface ServicesSyncGetUserForLiveGuardResponse_AuthenticationDataDto<ID_TYPE = string> {
456
460
  Data?: string;
457
461
  SearchKey?: string;
458
462
  Type?: string;
459
463
  }
460
- export interface ServicesSyncGetUserForLiveGuardResponse_FunctionalityDto {
464
+ export interface ServicesSyncGetUserForLiveGuardResponse_FunctionalityDto<ID_TYPE = string> {
461
465
  Functionality: string;
462
466
  FunctionalityScope: SecurityFunctionalityScope;
463
467
  RequiresElevation: boolean;
464
468
  }
465
- export interface ServicesSyncGetUserForLiveGuardResponse_RoleDto {
469
+ export interface ServicesSyncGetUserForLiveGuardResponse_RoleDto<ID_TYPE = string> {
466
470
  Code?: string;
467
471
  DeactivateUserAfterInactiveDays?: number;
468
- Functionalities: ServicesSyncGetUserForLiveGuardResponse_FunctionalityDto[];
472
+ Functionalities: ServicesSyncGetUserForLiveGuardResponse_FunctionalityDto<ID_TYPE>[];
469
473
  GlobalID?: string;
470
474
  Name?: string;
471
475
  UserType: UserTypes;
472
476
  }
473
- export interface LiveGuardGenerateApiKey {
477
+ export interface LiveGuardGenerateApiKey<ID_TYPE = string> {
474
478
  /**
475
479
  * Entity type: OrganizationUnit
476
480
  */
477
- OrganizationUnitID: string;
481
+ OrganizationUnitID: ID_TYPE;
478
482
  }
479
- export interface LiveGuardGenerateApiKeyResponse {
483
+ export interface LiveGuardGenerateApiKeyResponse<ID_TYPE = string> {
480
484
  ApiKey: string;
481
- Error?: ServiceError;
482
- Metadata?: ResponseMessageMetadata;
485
+ Error?: ServiceError<ID_TYPE>;
486
+ Metadata?: ResponseMessageMetadata<ID_TYPE>;
483
487
  }
484
488
  /**
485
489
  * Retreive current chain status for the connected watchtower
486
490
  */
487
- export interface LiveGuardGetAuditChains {
491
+ export interface LiveGuardGetAuditChains<ID_TYPE = string> {
488
492
  }
489
- export interface LiveGuardGetAuditChainsResponse {
490
- Chains?: TasksChainDto[];
491
- Error?: ServiceError;
492
- Metadata?: ResponseMessageMetadata;
493
+ export interface LiveGuardGetAuditChainsResponse<ID_TYPE = string> {
494
+ Chains?: TasksChainDto<ID_TYPE>[];
495
+ Error?: ServiceError<ID_TYPE>;
496
+ Metadata?: ResponseMessageMetadata<ID_TYPE>;
493
497
  }
494
498
  /**
495
499
  * Retreive current secret for TOTP token usage
496
500
  */
497
- export interface LiveGuardGetTOTPSecret {
501
+ export interface LiveGuardGetTOTPSecret<ID_TYPE = string> {
498
502
  }
499
- export interface LiveGuardGetTOTPSecretResponse {
500
- Error?: ServiceError;
501
- Metadata?: ResponseMessageMetadata;
502
- Secret: LiveGuardTOTPSecretWrapper;
503
+ export interface LiveGuardGetTOTPSecretResponse<ID_TYPE = string> {
504
+ Error?: ServiceError<ID_TYPE>;
505
+ Metadata?: ResponseMessageMetadata<ID_TYPE>;
506
+ Secret: LiveGuardTOTPSecretWrapper<ID_TYPE>;
503
507
  }
504
508
  /**
505
509
  * Service called by a liveguard instance to generate an authentication token for an authorized user on the liveguard
506
510
  *
507
511
  * Can only be called by the liveguard user
508
512
  */
509
- export interface LiveGuardGetTokenForUser {
513
+ export interface LiveGuardGetTokenForUser<ID_TYPE = string> {
510
514
  UseJwtTokens?: boolean;
511
515
  Username: string;
512
516
  }
513
- export interface LiveGuardGetTokenForUserResponse {
517
+ export interface LiveGuardGetTokenForUserResponse<ID_TYPE = string> {
514
518
  AuthenticationToken: string;
515
- Error?: ServiceError;
516
- Metadata?: ResponseMessageMetadata;
519
+ Error?: ServiceError<ID_TYPE>;
520
+ Metadata?: ResponseMessageMetadata<ID_TYPE>;
517
521
  RefreshToken?: string;
518
522
  }
519
523
  /**
520
524
  * Accepts an Order pushed from a LiveGuard instance
521
525
  */
522
- export interface LiveGuardPushOrder {
523
- BillingAddress?: AddressesAddressDataDto;
526
+ export interface LiveGuardPushOrder<ID_TYPE = string> {
527
+ BillingAddress?: AddressesAddressDataDto<ID_TYPE>;
524
528
  BlobID: string;
525
- Blobs?: ServicesSyncLiveGuardPushOrder_OrderBlobDto[];
526
- Chains?: TasksChainDto[];
529
+ Blobs?: ServicesSyncLiveGuardPushOrder_OrderBlobDto<ID_TYPE>[];
530
+ Chains?: TasksChainDto<ID_TYPE>[];
527
531
  CreationTime?: string;
528
- Customer?: ServicesSyncLiveGuardPushOrder_CustomerDto;
529
- CustomerIdentifiers?: ServicesSyncLiveGuardPushOrder_OrderCustomerIdentifiersDto;
532
+ Customer?: ServicesSyncLiveGuardPushOrder_CustomerDto<ID_TYPE>;
533
+ CustomerIdentifiers?: ServicesSyncLiveGuardPushOrder_OrderCustomerIdentifiersDto<ID_TYPE>;
530
534
  DisplayID?: string;
531
- Invoices?: ServicesSyncLiveGuardPushOrder_InvoiceDto[];
535
+ Invoices?: ServicesSyncLiveGuardPushOrder_InvoiceDto<ID_TYPE>[];
532
536
  IsPaid?: boolean;
533
537
  IsShipped?: boolean;
534
- Lines?: ServicesSyncLiveGuardPushOrder_OrderLineDto[];
538
+ Lines?: ServicesSyncLiveGuardPushOrder_OrderLineDto<ID_TYPE>[];
535
539
  LiveGuardOrderID?: string;
536
- Payments?: ServicesSyncLiveGuardPushOrder_PaymentDto[];
537
- PickupAddress?: AddressesAddressDataDto;
540
+ Payments?: ServicesSyncLiveGuardPushOrder_PaymentDto<ID_TYPE>[];
541
+ PickupAddress?: AddressesAddressDataDto<ID_TYPE>;
538
542
  Remark?: string;
539
- ShippingAddress?: AddressesAddressDataDto;
543
+ ShippingAddress?: AddressesAddressDataDto<ID_TYPE>;
540
544
  SoldBy?: string;
541
545
  }
542
- export interface ServicesSyncLiveGuardPushOrder_ChainLedgerDto {
546
+ export interface ServicesSyncLiveGuardPushOrder_ChainLedgerDto<ID_TYPE = string> {
543
547
  CreationTime: string;
544
548
  NewSequenceNumber?: number;
545
549
  NewSignature?: string;
546
550
  PreviousSequenceNumber?: number;
547
551
  PreviousSignature?: string;
548
552
  }
549
- export interface ServicesSyncLiveGuardPushOrder_CustomerDto {
553
+ export interface ServicesSyncLiveGuardPushOrder_CustomerDto<ID_TYPE = string> {
550
554
  CountryID?: string;
551
555
  EmailAddress?: string;
552
556
  FirstName?: string;
@@ -556,34 +560,34 @@ export interface ServicesSyncLiveGuardPushOrder_CustomerDto {
556
560
  /**
557
561
  * Entity type: User
558
562
  */
559
- LiveGuardID: string;
563
+ LiveGuardID: ID_TYPE;
560
564
  PhoneNumber?: string;
561
565
  }
562
- export interface ServicesSyncLiveGuardPushOrder_InvoiceBlobDto {
566
+ export interface ServicesSyncLiveGuardPushOrder_InvoiceBlobDto<ID_TYPE = string> {
563
567
  BackendID?: string;
564
568
  BlobID: string;
565
569
  Category?: string;
566
570
  MimeType?: string;
567
571
  OriginalName?: string;
568
572
  }
569
- export interface ServicesSyncLiveGuardPushOrder_InvoiceDataDto {
573
+ export interface ServicesSyncLiveGuardPushOrder_InvoiceDataDto<ID_TYPE = string> {
570
574
  Data?: string;
571
575
  SearchKey?: string;
572
576
  Type?: string;
573
577
  }
574
- export interface ServicesSyncLiveGuardPushOrder_InvoiceDocumentLedgerDto {
578
+ export interface ServicesSyncLiveGuardPushOrder_InvoiceDocumentLedgerDto<ID_TYPE = string> {
575
579
  /**
576
580
  * Entity type: AuditChain
577
581
  */
578
- ChainID?: string;
582
+ ChainID?: ID_TYPE;
579
583
  FailureReason?: string;
580
584
  Format?: DataModelsInvoiceDocumentLedgerFormats;
581
- InvoiceDocumentLedgerData?: DataModelsInvoiceDocumentLedgerData;
585
+ InvoiceDocumentLedgerData?: DataModelsInvoiceDocumentLedgerData<ID_TYPE>;
582
586
  IsSuccess?: boolean;
583
587
  /**
584
588
  * Entity type: Device
585
589
  */
586
- OriginalDeviceID?: string;
590
+ OriginalDeviceID?: ID_TYPE;
587
591
  PreviousSequenceNumber?: number;
588
592
  PreviousSignature?: string;
589
593
  ReportContentBlobID?: string;
@@ -592,30 +596,30 @@ export interface ServicesSyncLiveGuardPushOrder_InvoiceDocumentLedgerDto {
592
596
  Signature?: string;
593
597
  Type?: DataModelsInvoiceDocumentLedgerTypes;
594
598
  }
595
- export interface ServicesSyncLiveGuardPushOrder_InvoiceDto {
599
+ export interface ServicesSyncLiveGuardPushOrder_InvoiceDto<ID_TYPE = string> {
596
600
  AuditingProvider?: string;
597
601
  BackendID?: string;
598
602
  BackendSystemID?: string;
599
603
  BackendTypeID?: number;
600
- Blobs?: ServicesSyncLiveGuardPushOrder_InvoiceBlobDto[];
604
+ Blobs?: ServicesSyncLiveGuardPushOrder_InvoiceBlobDto<ID_TYPE>[];
601
605
  CalculationMethod?: DataModelsInvoiceCalculationMethod;
602
606
  /**
603
607
  * Entity type: AuditChain
604
608
  */
605
- ChainID?: string;
609
+ ChainID?: ID_TYPE;
606
610
  CurrencyID?: string;
607
611
  Description?: string;
608
- DocumentLedger?: ServicesSyncLiveGuardPushOrder_InvoiceDocumentLedgerDto[];
612
+ DocumentLedger?: ServicesSyncLiveGuardPushOrder_InvoiceDocumentLedgerDto<ID_TYPE>[];
609
613
  ExpirationDate?: string;
610
614
  FiscalID?: string;
611
615
  /**
612
616
  * Entity type: Invoice
613
617
  */
614
- ID: string;
615
- InvoiceData?: ServicesSyncLiveGuardPushOrder_InvoiceDataDto[];
618
+ ID: ID_TYPE;
619
+ InvoiceData?: ServicesSyncLiveGuardPushOrder_InvoiceDataDto<ID_TYPE>[];
616
620
  InvoiceDate?: string;
617
621
  InvoiceNumber?: string;
618
- Lines?: ServicesSyncLiveGuardPushOrder_InvoiceLineDto[];
622
+ Lines?: ServicesSyncLiveGuardPushOrder_InvoiceLineDto<ID_TYPE>[];
619
623
  PreviousSignature?: string;
620
624
  PrintCount?: number;
621
625
  ReferencedInvoice?: string;
@@ -629,29 +633,29 @@ export interface ServicesSyncLiveGuardPushOrder_InvoiceDto {
629
633
  TaxReverseCharge?: boolean;
630
634
  TotalAmount: number;
631
635
  Type?: DataModelsInvoiceTypes;
632
- UserData?: ServicesSyncLiveGuardPushOrder_InvoiceUserDataDto;
636
+ UserData?: ServicesSyncLiveGuardPushOrder_InvoiceUserDataDto<ID_TYPE>;
633
637
  VatNumber?: string;
634
638
  }
635
- export interface ServicesSyncLiveGuardPushOrder_InvoiceLineDiscountDetailDto {
639
+ export interface ServicesSyncLiveGuardPushOrder_InvoiceLineDiscountDetailDto<ID_TYPE = string> {
636
640
  Amount: number;
637
641
  BackendID?: string;
638
642
  Description?: string;
639
643
  }
640
- export interface ServicesSyncLiveGuardPushOrder_InvoiceLineDto {
644
+ export interface ServicesSyncLiveGuardPushOrder_InvoiceLineDto<ID_TYPE = string> {
641
645
  Description?: string;
642
646
  DiscountAmount: number;
643
- DiscountDetails?: ServicesSyncLiveGuardPushOrder_InvoiceLineDiscountDetailDto[];
644
- InvoiceData?: ServicesSyncLiveGuardPushOrder_InvoiceDataDto[];
647
+ DiscountDetails?: ServicesSyncLiveGuardPushOrder_InvoiceLineDiscountDetailDto<ID_TYPE>[];
648
+ InvoiceData?: ServicesSyncLiveGuardPushOrder_InvoiceDataDto<ID_TYPE>[];
645
649
  InvoicedBy?: string;
646
650
  NetTaxAmount: number;
647
651
  /**
648
652
  * Entity type: OrderLine
649
653
  */
650
- OrderLineID: string;
654
+ OrderLineID: ID_TYPE;
651
655
  Quantity?: number;
652
656
  TaxAmount?: number;
653
657
  TaxCode?: string;
654
- TaxDetails?: ServicesSyncLiveGuardPushOrder_InvoiceLineTaxDetailDto[];
658
+ TaxDetails?: ServicesSyncLiveGuardPushOrder_InvoiceLineTaxDetailDto<ID_TYPE>[];
655
659
  TaxRate: number;
656
660
  TaxRateCategory?: DataModelsTaxRateCategory;
657
661
  TotalAmountInvoiced: number;
@@ -662,7 +666,7 @@ export interface ServicesSyncLiveGuardPushOrder_InvoiceLineDto {
662
666
  UnitPrice?: number;
663
667
  UnitPriceInTax: number;
664
668
  }
665
- export interface ServicesSyncLiveGuardPushOrder_InvoiceLineTaxDetailDto {
669
+ export interface ServicesSyncLiveGuardPushOrder_InvoiceLineTaxDetailDto<ID_TYPE = string> {
666
670
  TaxAmount: number;
667
671
  TaxName?: string;
668
672
  TaxRate: number;
@@ -670,11 +674,11 @@ export interface ServicesSyncLiveGuardPushOrder_InvoiceLineTaxDetailDto {
670
674
  TaxSubTypeName?: string;
671
675
  TaxType?: string;
672
676
  }
673
- export interface ServicesSyncLiveGuardPushOrder_InvoiceUserDataDto {
677
+ export interface ServicesSyncLiveGuardPushOrder_InvoiceUserDataDto<ID_TYPE = string> {
674
678
  BackendRelationID?: string;
675
679
  BankAccount?: string;
676
- BillingAddress?: AddressesAddressDataDto;
677
- Company?: CompaniesCompanyDto;
680
+ BillingAddress?: AddressesAddressDataDto<ID_TYPE>;
681
+ Company?: CompaniesCompanyDto<ID_TYPE>;
678
682
  CountryID?: string;
679
683
  EmailAddress?: string;
680
684
  FirstName?: string;
@@ -689,7 +693,7 @@ export interface ServicesSyncLiveGuardPushOrder_InvoiceUserDataDto {
689
693
  OrganizationUnitBackendID?: string;
690
694
  OrganizationUnitBranchNumber?: string;
691
695
  OrganizationUnitCity?: string;
692
- OrganizationUnitCompany?: CompaniesCompanyDto;
696
+ OrganizationUnitCompany?: CompaniesCompanyDto<ID_TYPE>;
693
697
  OrganizationUnitCompanyVatNumber?: string;
694
698
  OrganizationUnitCountryID?: string;
695
699
  OrganizationUnitDistrict?: string;
@@ -703,57 +707,57 @@ export interface ServicesSyncLiveGuardPushOrder_InvoiceUserDataDto {
703
707
  OrganizationUnitWebsite?: string;
704
708
  OrganizationUnitZipCode?: string;
705
709
  PhoneNumber?: string;
706
- ShippingAddress?: AddressesAddressDataDto;
710
+ ShippingAddress?: AddressesAddressDataDto<ID_TYPE>;
707
711
  }
708
- export interface ServicesSyncLiveGuardPushOrder_OrderBlobDto {
712
+ export interface ServicesSyncLiveGuardPushOrder_OrderBlobDto<ID_TYPE = string> {
709
713
  BlobID: string;
710
714
  /**
711
715
  * Entity type: Invoice
712
716
  */
713
- InvoiceID?: string;
717
+ InvoiceID?: ID_TYPE;
714
718
  Name?: string;
715
719
  /**
716
720
  * Entity type: OrderLine
717
721
  */
718
- OrderLineID?: string;
722
+ OrderLineID?: ID_TYPE;
719
723
  Type?: DataModelsOrderBlobTypes;
720
724
  }
721
- export interface ServicesSyncLiveGuardPushOrder_OrderCustomerIdentifiersDto {
725
+ export interface ServicesSyncLiveGuardPushOrder_OrderCustomerIdentifiersDto<ID_TYPE = string> {
722
726
  EmailAddress?: string;
723
727
  UserBackendID?: string;
724
728
  UserCustomID?: string;
725
729
  UserID?: string;
726
730
  UserSubscriptionID?: string;
727
731
  }
728
- export interface ServicesSyncLiveGuardPushOrder_OrderLineDiscount {
732
+ export interface ServicesSyncLiveGuardPushOrder_OrderLineDiscount<ID_TYPE = string> {
729
733
  Amount: number;
730
734
  BackendID?: string;
731
735
  Description?: string;
732
736
  /**
733
737
  * Entity type: OrderLine
734
738
  */
735
- OrderLineID: string;
739
+ OrderLineID: ID_TYPE;
736
740
  }
737
- export interface ServicesSyncLiveGuardPushOrder_OrderLineDto {
741
+ export interface ServicesSyncLiveGuardPushOrder_OrderLineDto<ID_TYPE = string> {
738
742
  Amount: number;
739
743
  BackendID?: string;
740
744
  CustomID?: string;
741
745
  Description?: string;
742
- Discounts?: ServicesSyncLiveGuardPushOrder_OrderLineDiscount[];
746
+ Discounts?: ServicesSyncLiveGuardPushOrder_OrderLineDiscount<ID_TYPE>[];
743
747
  /**
744
748
  * Entity type: OrderLine
745
749
  */
746
- ID: string;
750
+ ID: ID_TYPE;
747
751
  Quantity?: number;
748
752
  ReturnReason?: string;
749
753
  ReturnReasonType?: DataModelsReturnReasonType;
750
754
  SerialNumber?: string;
751
- TaxDetails?: ServicesSyncLiveGuardPushOrder_OrderLineTaxDetail[];
755
+ TaxDetails?: ServicesSyncLiveGuardPushOrder_OrderLineTaxDetail<ID_TYPE>[];
752
756
  TaxRate: number;
753
757
  UnitPriceBeforeCorrection?: number;
754
758
  UnitPriceCorrectionReason?: string;
755
759
  }
756
- export interface ServicesSyncLiveGuardPushOrder_OrderLineTaxDetail {
760
+ export interface ServicesSyncLiveGuardPushOrder_OrderLineTaxDetail<ID_TYPE = string> {
757
761
  TaxAmount: number;
758
762
  TaxName?: string;
759
763
  TaxRate: number;
@@ -761,72 +765,72 @@ export interface ServicesSyncLiveGuardPushOrder_OrderLineTaxDetail {
761
765
  TaxSubTypeName?: string;
762
766
  TaxType?: string;
763
767
  }
764
- export interface ServicesSyncLiveGuardPushOrder_PaymentDto {
768
+ export interface ServicesSyncLiveGuardPushOrder_PaymentDto<ID_TYPE = string> {
765
769
  Amount: number;
766
770
  BackendID?: string;
767
771
  Data?: string;
768
772
  /**
769
773
  * Entity type: PaymentTransaction
770
774
  */
771
- ID: string;
775
+ ID: ID_TYPE;
772
776
  Method?: string;
773
777
  /**
774
778
  * Entity type: Device
775
779
  */
776
- OriginalDeviceID?: string;
780
+ OriginalDeviceID?: ID_TYPE;
777
781
  Type?: string;
778
782
  }
779
- export interface LiveGuardPushOrderResponse {
783
+ export interface LiveGuardPushOrderResponse<ID_TYPE = string> {
780
784
  AlreadyExists: boolean;
781
- Error?: ServiceError;
785
+ Error?: ServiceError<ID_TYPE>;
782
786
  /**
783
787
  * Entity type: Order
784
788
  */
785
- ID: string;
786
- Metadata?: ResponseMessageMetadata;
789
+ ID: ID_TYPE;
790
+ Metadata?: ResponseMessageMetadata<ID_TYPE>;
787
791
  }
788
- export interface LiveGuardSyncCatalogByBlob {
792
+ export interface LiveGuardSyncCatalogByBlob<ID_TYPE = string> {
789
793
  }
790
- export interface LiveGuardSyncCatalogByBlobResponse {
794
+ export interface LiveGuardSyncCatalogByBlobResponse<ID_TYPE = string> {
791
795
  Bundles?: string;
792
796
  EcoTaxPriceList?: string;
793
- Error?: ServiceError;
794
- Metadata?: ResponseMessageMetadata;
797
+ Error?: ServiceError<ID_TYPE>;
798
+ Metadata?: ResponseMessageMetadata<ID_TYPE>;
795
799
  PriceList?: string;
796
800
  Products?: string;
797
801
  PromotionPriceList?: string;
798
802
  }
799
- export interface LiveGuardSyncGeneralByBlob {
803
+ export interface LiveGuardSyncGeneralByBlob<ID_TYPE = string> {
800
804
  }
801
- export interface LiveGuardSyncGeneralByBlobResponse {
802
- Error?: ServiceError;
803
- Metadata?: ResponseMessageMetadata;
805
+ export interface LiveGuardSyncGeneralByBlobResponse<ID_TYPE = string> {
806
+ Error?: ServiceError<ID_TYPE>;
807
+ Metadata?: ResponseMessageMetadata<ID_TYPE>;
804
808
  Url?: string;
805
809
  }
806
- export interface LiveGuardSyncUsersByBlob {
810
+ export interface LiveGuardSyncUsersByBlob<ID_TYPE = string> {
807
811
  }
808
- export interface LiveGuardSyncUsersByBlobResponse {
809
- Error?: ServiceError;
810
- Metadata?: ResponseMessageMetadata;
812
+ export interface LiveGuardSyncUsersByBlobResponse<ID_TYPE = string> {
813
+ Error?: ServiceError<ID_TYPE>;
814
+ Metadata?: ResponseMessageMetadata<ID_TYPE>;
811
815
  Url?: string;
812
816
  }
813
817
  /**
814
818
  * Trigger a full sync on a liveguard instance, this has major performance impact for a while
815
819
  */
816
- export interface LiveGuardTriggerSync {
820
+ export interface LiveGuardTriggerSync<ID_TYPE = string> {
817
821
  }
818
- export interface TasksChainDto {
822
+ export interface TasksChainDto<ID_TYPE = string> {
819
823
  CurrentSequenceNumber?: number;
820
824
  CurrentSignature?: string;
821
825
  Discriminator?: number;
822
826
  /**
823
827
  * Entity type: AuditChain
824
828
  */
825
- ID: string;
829
+ ID: ID_TYPE;
826
830
  Identifier?: string;
827
831
  PreviousSequenceNumber?: number;
828
832
  PreviousSignature?: string;
829
- RecentLedgers?: ServicesSyncLiveGuardPushOrder_ChainLedgerDto[];
833
+ RecentLedgers?: ServicesSyncLiveGuardPushOrder_ChainLedgerDto<ID_TYPE>[];
830
834
  Type?: AuditingAuditChainTypes;
831
835
  Version?: number;
832
836
  }