@springtree/eva-services-core-live-guard 10.0.0 → 10.0.2
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/lib/eva-services-core-live-guard.d.ts +227 -227
- package/lib/eva-services-core-live-guard.d.ts.map +1 -1
- package/lib/eva-services-core-live-guard.js +66 -66
- package/lib/eva-services-core-live-guard.js.map +1 -1
- package/lib/eva-services-core-live-guard.services.d.ts +2 -2
- package/lib/eva-services-core-live-guard.services.d.ts.map +1 -1
- package/lib/eva-services-core-live-guard.services.js +66 -66
- package/lib/eva-services-core-live-guard.services.js.map +1 -1
- package/lib/index.d.ts +2 -2
- package/lib/index.js +2 -2
- package/package.json +3 -3
|
@@ -1,136 +1,136 @@
|
|
|
1
|
-
import { ServiceError, ResponseMessageMetadata, PageTokenConfig, PageConfig, DataModelsOrganizationUnitStatus, PagedResult, SchedulingTaskState, DevicesWatchtowerLog, UserTypes, SecurityElevationType, SecurityFunctionalityScope, LiveGuardTOTPSecretWrapper, AddressesAddressDataDto, DataModelsInvoiceDocumentLedgerFormats, DataModelsInvoiceDocumentLedgerData, DataModelsInvoiceDocumentLedgerTypes, DataModelsInvoiceCalculationMethod, DataModelsInvoiceStatuses, DataModelsInvoiceTypes, DataModelsTaxRateCategory, DataModelsInvoiceLineTypes, CompaniesCompanyDto, DataModelsOrderBlobTypes, DataModelsReturnReasonType, DataModelsPaymentStatuses, AuditingAuditChainTypes } from
|
|
1
|
+
import { ServiceError, ResponseMessageMetadata, PageTokenConfig, PageConfig, DataModelsOrganizationUnitStatus, PagedResult, SchedulingTaskState, DevicesWatchtowerLog, UserTypes, SecurityElevationType, SecurityFunctionalityScope, LiveGuardTOTPSecretWrapper, AddressesAddressDataDto, DataModelsInvoiceDocumentLedgerFormats, DataModelsInvoiceDocumentLedgerData, DataModelsInvoiceDocumentLedgerTypes, DataModelsInvoiceCalculationMethod, DataModelsInvoiceStatuses, DataModelsInvoiceTypes, DataModelsTaxRateCategory, DataModelsInvoiceLineTypes, CompaniesCompanyDto, DataModelsOrderBlobTypes, DataModelsReturnReasonType, DataModelsPaymentStatuses, AuditingAuditChainTypes } from '@springtree/eva-services-core';
|
|
2
2
|
export declare enum Errors {
|
|
3
3
|
/**
|
|
4
|
-
|
|
5
|
-
|
|
4
|
+
* The uploaded file is not a valid .p7m token.
|
|
5
|
+
*/
|
|
6
6
|
ABMEnrollment_InvalidABMTokenFile = "ABMEnrollment:InvalidABMTokenFile",
|
|
7
7
|
/**
|
|
8
|
-
|
|
9
|
-
|
|
8
|
+
* Failed to upload the ABM token to JAMF. Please verify the token file and try again.
|
|
9
|
+
*/
|
|
10
10
|
ABMEnrollment_ABMTokenUploadFailed = "ABMEnrollment:ABMTokenUploadFailed",
|
|
11
11
|
/**
|
|
12
|
-
|
|
13
|
-
|
|
12
|
+
* An ABM token already exists in JAMF. Use renewal instead of uploading a new token.
|
|
13
|
+
*/
|
|
14
14
|
ABMEnrollment_ABMTokenAlreadyExists = "ABMEnrollment:ABMTokenAlreadyExists",
|
|
15
15
|
/**
|
|
16
|
-
|
|
17
|
-
|
|
16
|
+
* Could not determine a matching FleetManager.
|
|
17
|
+
*/
|
|
18
18
|
FleetManager_UnableToDetermineFleetManager = "FleetManager:UnableToDetermineFleetManager",
|
|
19
19
|
/**
|
|
20
|
-
|
|
21
|
-
|
|
20
|
+
* The FleetManager {0:string} is not available.
|
|
21
|
+
*/
|
|
22
22
|
FleetManager_FleetManagerNotAvailable = "FleetManager:FleetManagerNotAvailable",
|
|
23
23
|
/**
|
|
24
|
-
|
|
25
|
-
|
|
24
|
+
* Device with HardwareID {hardwareID:string} was not found in FleetManager {fleetManager:string}. Make sure it's online and try again
|
|
25
|
+
*/
|
|
26
26
|
FleetManager_DeviceNotInFleetManager = "FleetManager:DeviceNotInFleetManager",
|
|
27
27
|
/**
|
|
28
|
-
|
|
29
|
-
|
|
28
|
+
* Device is not valid for this FleetManager.
|
|
29
|
+
*/
|
|
30
30
|
FleetManager_InvalidDevice = "FleetManager:InvalidDevice",
|
|
31
31
|
/**
|
|
32
|
-
|
|
33
|
-
|
|
32
|
+
* Device was already boarded.
|
|
33
|
+
*/
|
|
34
34
|
FleetManager_DeviceAlreadyBoarded = "FleetManager:DeviceAlreadyBoarded",
|
|
35
35
|
/**
|
|
36
|
-
|
|
37
|
-
|
|
36
|
+
* Error while boarding the device: {0:string}
|
|
37
|
+
*/
|
|
38
38
|
FleetManager_BoardingFailed = "FleetManager:BoardingFailed",
|
|
39
39
|
/**
|
|
40
|
-
|
|
41
|
-
|
|
40
|
+
* After 2026-04-01 it's not allowed to board new legacy devices in EVA.
|
|
41
|
+
*/
|
|
42
42
|
FleetManager_BoardingDisabled = "FleetManager:BoardingDisabled",
|
|
43
43
|
/**
|
|
44
|
-
|
|
45
|
-
|
|
44
|
+
* This operation is not supported because NewBlack manages the ABM token for this deployment.
|
|
45
|
+
*/
|
|
46
46
|
FleetManager_NotSupportedForNewBlackManagedABM = "FleetManager:NotSupportedForNewBlackManagedABM",
|
|
47
47
|
/**
|
|
48
|
-
|
|
49
|
-
|
|
48
|
+
* Device with HardwareID {hardwareID:string} already exists with ID {deviceID:id}.
|
|
49
|
+
*/
|
|
50
50
|
FleetManagerErrors_DeviceAlreadyExists = "FleetManagerErrors:DeviceAlreadyExists",
|
|
51
51
|
/**
|
|
52
|
-
|
|
53
|
-
|
|
52
|
+
* OrganizationUnit {organizationUnitID:id} already has a watchtower with ID {deviceID:id}.
|
|
53
|
+
*/
|
|
54
54
|
FleetManagerErrors_DuplicateOrganizationUnit = "FleetManagerErrors:DuplicateOrganizationUnit",
|
|
55
55
|
/**
|
|
56
|
-
|
|
57
|
-
|
|
56
|
+
* You're not allowed to generate this liveguard api key.
|
|
57
|
+
*/
|
|
58
58
|
LiveGuard_NotAllowedToGenerateApiKey = "LiveGuard:NotAllowedToGenerateApiKey",
|
|
59
59
|
/**
|
|
60
|
-
|
|
61
|
-
|
|
60
|
+
* You're not allowed to generate this liveguard secret.
|
|
61
|
+
*/
|
|
62
62
|
LiveGuard_NotAllowedToGenerateSecret = "LiveGuard:NotAllowedToGenerateSecret",
|
|
63
63
|
/**
|
|
64
|
-
|
|
65
|
-
|
|
64
|
+
* This is a stub order for offline evapay payments, no mutations allowed.
|
|
65
|
+
*/
|
|
66
66
|
LiveGuard_UnableToMutateEVAPayStub = "LiveGuard:UnableToMutateEVAPayStub",
|
|
67
67
|
/**
|
|
68
|
-
|
|
69
|
-
|
|
68
|
+
* The configuration is invalid.
|
|
69
|
+
*/
|
|
70
70
|
LiveGuardCertificate_InvalidConfiguration = "LiveGuardCertificate:InvalidConfiguration",
|
|
71
71
|
/**
|
|
72
|
-
|
|
73
|
-
|
|
72
|
+
* No valid Watchtower for this request.
|
|
73
|
+
*/
|
|
74
74
|
LiveGuardCertificate_NoValidWatchtower = "LiveGuardCertificate:NoValidWatchtower",
|
|
75
75
|
/**
|
|
76
|
-
|
|
77
|
-
|
|
76
|
+
* CSR could not be parsed.
|
|
77
|
+
*/
|
|
78
78
|
LiveGuardCertificate_CsrInvalid = "LiveGuardCertificate:CsrInvalid",
|
|
79
79
|
/**
|
|
80
|
-
|
|
81
|
-
|
|
80
|
+
* Failed to generate the certificate.
|
|
81
|
+
*/
|
|
82
82
|
LiveGuardCertificate_CertificateGenerationFailed = "LiveGuardCertificate:CertificateGenerationFailed",
|
|
83
83
|
/**
|
|
84
|
-
|
|
85
|
-
|
|
84
|
+
* Hostname for this Watchtower does not match the hostname in the CSR.
|
|
85
|
+
*/
|
|
86
86
|
LiveGuardCertificate_HostnameMismatch = "LiveGuardCertificate:HostnameMismatch",
|
|
87
87
|
/**
|
|
88
|
-
|
|
89
|
-
|
|
88
|
+
* There is no current connection to the selected device.
|
|
89
|
+
*/
|
|
90
90
|
LiveGuardExecuteTask_NoConnection = "LiveGuardExecuteTask:NoConnection",
|
|
91
91
|
/**
|
|
92
|
-
|
|
93
|
-
|
|
92
|
+
* This watchtower is not connected.
|
|
93
|
+
*/
|
|
94
94
|
LiveGuardLockStatus_NotConnected = "LiveGuardLockStatus:NotConnected",
|
|
95
95
|
/**
|
|
96
|
-
|
|
97
|
-
|
|
96
|
+
* Failed to lock the device.
|
|
97
|
+
*/
|
|
98
98
|
LiveGuardLockStatus_LockFailed = "LiveGuardLockStatus:LockFailed",
|
|
99
99
|
/**
|
|
100
|
-
|
|
101
|
-
|
|
100
|
+
* Failed to unlock the device.
|
|
101
|
+
*/
|
|
102
102
|
LiveGuardLockStatus_UnlockFailed = "LiveGuardLockStatus:UnlockFailed",
|
|
103
103
|
/**
|
|
104
|
-
|
|
105
|
-
|
|
104
|
+
* The configuration is invalid.
|
|
105
|
+
*/
|
|
106
106
|
LiveGuardVPN_InvalidConfiguration = "LiveGuardVPN:InvalidConfiguration",
|
|
107
107
|
/**
|
|
108
|
-
|
|
109
|
-
|
|
108
|
+
* No valid Watchtower for this request.
|
|
109
|
+
*/
|
|
110
110
|
LiveGuardVPN_NoValidWatchtower = "LiveGuardVPN:NoValidWatchtower",
|
|
111
111
|
/**
|
|
112
|
-
|
|
113
|
-
|
|
112
|
+
* Failed to check for existing config.
|
|
113
|
+
*/
|
|
114
114
|
LiveGuardVPN_ExistsCheckFailed = "LiveGuardVPN:ExistsCheckFailed",
|
|
115
115
|
/**
|
|
116
|
-
|
|
117
|
-
|
|
116
|
+
* Failed to create new config.
|
|
117
|
+
*/
|
|
118
118
|
LiveGuardVPN_CreateFailed = "LiveGuardVPN:CreateFailed",
|
|
119
119
|
/**
|
|
120
|
-
|
|
121
|
-
|
|
120
|
+
* You can only force local mode on shops.
|
|
121
|
+
*/
|
|
122
122
|
LocalModeManager_CanForceLocalModeOnlyOnShop = "LocalModeManager:CanForceLocalModeOnlyOnShop",
|
|
123
123
|
/**
|
|
124
|
-
|
|
125
|
-
|
|
124
|
+
* No registration request found for this device. (Please reboot the device and try again)
|
|
125
|
+
*/
|
|
126
126
|
MenderClient_NoRegistrationRequest = "MenderClient:NoRegistrationRequest",
|
|
127
127
|
/**
|
|
128
|
-
|
|
129
|
-
|
|
128
|
+
* There is no current connection to the selected device.
|
|
129
|
+
*/
|
|
130
130
|
WatchtowerExecuteCommand_NoConnection = "WatchtowerExecuteCommand:NoConnection",
|
|
131
131
|
/**
|
|
132
|
-
|
|
133
|
-
|
|
132
|
+
* Failed to connect to the device.
|
|
133
|
+
*/
|
|
134
134
|
WatchtowerIO_ConnectionFailed = "WatchtowerIO:ConnectionFailed"
|
|
135
135
|
}
|
|
136
136
|
export declare enum ManagersFleetManagerDeviceStatus {
|
|
@@ -141,8 +141,8 @@ export declare enum ManagersFleetManagerDeviceStatus {
|
|
|
141
141
|
Noauth = 5
|
|
142
142
|
}
|
|
143
143
|
/**
|
|
144
|
-
|
|
145
|
-
|
|
144
|
+
* Get an authentication token that's valid in the cloud for the current user
|
|
145
|
+
*/
|
|
146
146
|
export interface LiveGuardGetCloudToken<ID_TYPE = string> {
|
|
147
147
|
UseJwtTokens?: boolean;
|
|
148
148
|
}
|
|
@@ -153,26 +153,26 @@ export interface LiveGuardGetCloudTokenResponse<ID_TYPE = string> {
|
|
|
153
153
|
RefreshToken?: string;
|
|
154
154
|
}
|
|
155
155
|
/**
|
|
156
|
-
|
|
157
|
-
|
|
156
|
+
* Returns the blob url where the LiveGuard data can be downloaded from.
|
|
157
|
+
*/
|
|
158
158
|
export interface LiveGuardGetData<ID_TYPE = string> {
|
|
159
159
|
}
|
|
160
160
|
/**
|
|
161
|
-
|
|
162
|
-
|
|
161
|
+
* Returns id mapping for cloud vs liveguard entities
|
|
162
|
+
*/
|
|
163
163
|
export interface LiveGuardGetMapping<ID_TYPE = string> {
|
|
164
164
|
}
|
|
165
165
|
export interface LiveGuardGetMappingResponse<ID_TYPE = string> {
|
|
166
166
|
Error?: ServiceError<ID_TYPE>;
|
|
167
167
|
/**
|
|
168
|
-
|
|
169
|
-
|
|
168
|
+
* For each datatype a mapping from CloudID -> LiveGuardID
|
|
169
|
+
*/
|
|
170
170
|
Mapping?: Record<string, Record<string, ID_TYPE> | null>;
|
|
171
171
|
Metadata?: ResponseMessageMetadata<ID_TYPE>;
|
|
172
172
|
}
|
|
173
173
|
/**
|
|
174
|
-
|
|
175
|
-
|
|
174
|
+
* Get a trust token that needs to be provided in the Login call to the cloud to verify local presence
|
|
175
|
+
*/
|
|
176
176
|
export interface LiveGuardGetTrustToken<ID_TYPE = string> {
|
|
177
177
|
}
|
|
178
178
|
export interface LiveGuardGetTrustTokenResponse<ID_TYPE = string> {
|
|
@@ -187,8 +187,8 @@ export declare enum ServicesManagementABMConnectionStatus {
|
|
|
187
187
|
Expired = 3
|
|
188
188
|
}
|
|
189
189
|
/**
|
|
190
|
-
|
|
191
|
-
|
|
190
|
+
* Create a new SSL certificate for a Watchtower device.
|
|
191
|
+
*/
|
|
192
192
|
export interface CreateWatchtowerCertificate<ID_TYPE = string> {
|
|
193
193
|
CertificateSigningRequest: string;
|
|
194
194
|
}
|
|
@@ -198,31 +198,31 @@ export interface CreateWatchtowerCertificateResponse<ID_TYPE = string> {
|
|
|
198
198
|
Metadata?: ResponseMessageMetadata<ID_TYPE>;
|
|
199
199
|
}
|
|
200
200
|
/**
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
201
|
+
* Create a new watchtower device
|
|
202
|
+
*
|
|
203
|
+
* To create a device for fallback IO, leave the HardwareID null
|
|
204
|
+
* When a HardwareID is set, the device will be boarded and prepared for use.
|
|
205
|
+
*/
|
|
206
206
|
export interface CreateWatchtowerDevice<ID_TYPE = string> {
|
|
207
207
|
HardwareID?: string;
|
|
208
208
|
Name: string;
|
|
209
209
|
/**
|
|
210
|
-
|
|
211
|
-
|
|
210
|
+
* Entity type: OrganizationUnit
|
|
211
|
+
*/
|
|
212
212
|
OrganizationUnitID: ID_TYPE;
|
|
213
213
|
}
|
|
214
214
|
export interface CreateWatchtowerDeviceResponse<ID_TYPE = string> {
|
|
215
215
|
ApiKey?: string;
|
|
216
216
|
Error?: ServiceError<ID_TYPE>;
|
|
217
217
|
/**
|
|
218
|
-
|
|
219
|
-
|
|
218
|
+
* Entity type: Device
|
|
219
|
+
*/
|
|
220
220
|
ID: ID_TYPE;
|
|
221
221
|
Metadata?: ResponseMessageMetadata<ID_TYPE>;
|
|
222
222
|
}
|
|
223
223
|
/**
|
|
224
|
-
|
|
225
|
-
|
|
224
|
+
* Create a new VPN Configuration for a Watchtower device.
|
|
225
|
+
*/
|
|
226
226
|
export interface CreateWatchtowerVPNConfiguration<ID_TYPE = string> {
|
|
227
227
|
}
|
|
228
228
|
export interface CreateWatchtowerVPNConfigurationResponse<ID_TYPE = string> {
|
|
@@ -231,8 +231,8 @@ export interface CreateWatchtowerVPNConfigurationResponse<ID_TYPE = string> {
|
|
|
231
231
|
Metadata?: ResponseMessageMetadata<ID_TYPE>;
|
|
232
232
|
}
|
|
233
233
|
/**
|
|
234
|
-
|
|
235
|
-
|
|
234
|
+
* Returns the current ABM device enrollment status, including organization details and token expiration.
|
|
235
|
+
*/
|
|
236
236
|
export interface GetABMEnrollmentDetails<ID_TYPE = string> {
|
|
237
237
|
}
|
|
238
238
|
export interface GetABMEnrollmentDetailsResponse<ID_TYPE = string> {
|
|
@@ -247,8 +247,8 @@ export interface GetABMEnrollmentDetailsResponse<ID_TYPE = string> {
|
|
|
247
247
|
TokenExpirationDate?: string;
|
|
248
248
|
}
|
|
249
249
|
/**
|
|
250
|
-
|
|
251
|
-
|
|
250
|
+
* Downloads the JAMF device enrollment public key (PEM). Upload this key to Apple Business Manager to obtain a .p7m token.
|
|
251
|
+
*/
|
|
252
252
|
export interface GetABMPublicKey<ID_TYPE = string> {
|
|
253
253
|
}
|
|
254
254
|
export interface GetABMPublicKeyResponse<ID_TYPE = string> {
|
|
@@ -257,40 +257,40 @@ export interface GetABMPublicKeyResponse<ID_TYPE = string> {
|
|
|
257
257
|
PublicKey?: string;
|
|
258
258
|
}
|
|
259
259
|
/**
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
260
|
+
* List the configured watchtower devices with their status
|
|
261
|
+
*
|
|
262
|
+
* Sorting is supported on the following properties:
|
|
263
|
+
* - ID
|
|
264
|
+
* - Name
|
|
265
|
+
* - HardwareID
|
|
266
|
+
* - OrganizationUnitID
|
|
267
|
+
* - OrganizationUnitBackendID
|
|
268
|
+
* - OrganizationUnitName
|
|
269
|
+
* - OrganizationUnitCountryID
|
|
270
|
+
* - OrganizationUnitStatus
|
|
271
|
+
* - WatchtowerIOConnected
|
|
272
|
+
* - WatchtowerIOLastSeen
|
|
273
|
+
* - ForceLocalMode
|
|
274
|
+
*/
|
|
275
275
|
export interface ListWatchtowerDevices<ID_TYPE = string> {
|
|
276
276
|
/**
|
|
277
|
-
|
|
278
|
-
|
|
277
|
+
* The initial page configuration. This is only used when requesting the first page of results. Subsequent pages are requested using the `PageToken` property.
|
|
278
|
+
*/
|
|
279
279
|
InitialPageConfig?: PageTokenConfig<ServicesManagementListWatchtowerDevicesFilter<ID_TYPE>, ID_TYPE>;
|
|
280
280
|
PageConfig?: PageConfig<ServicesManagementListWatchtowerDevicesFilter<ID_TYPE>, ID_TYPE>;
|
|
281
281
|
/**
|
|
282
|
-
|
|
283
|
-
|
|
282
|
+
* The page token from a previous response. This is used to request subsequent pages of results.
|
|
283
|
+
*/
|
|
284
284
|
PageToken?: string;
|
|
285
285
|
}
|
|
286
286
|
export interface ServicesManagementListWatchtowerDevicesFilter<ID_TYPE = string> {
|
|
287
287
|
/**
|
|
288
|
-
|
|
289
|
-
|
|
288
|
+
* Entity type: Country
|
|
289
|
+
*/
|
|
290
290
|
CountryID?: string;
|
|
291
291
|
/**
|
|
292
|
-
|
|
293
|
-
|
|
292
|
+
* Entity type: Device
|
|
293
|
+
*/
|
|
294
294
|
DeviceID?: ID_TYPE;
|
|
295
295
|
FleetManagerID?: string;
|
|
296
296
|
ForceLocalMode?: boolean;
|
|
@@ -301,8 +301,8 @@ export interface ServicesManagementListWatchtowerDevicesFilter<ID_TYPE = string>
|
|
|
301
301
|
IsWatchtowerIOConnected?: boolean;
|
|
302
302
|
IsWatchtowerOnline?: boolean;
|
|
303
303
|
/**
|
|
304
|
-
|
|
305
|
-
|
|
304
|
+
* Entity type: OrganizationUnit
|
|
305
|
+
*/
|
|
306
306
|
OrganizationUnitID?: ID_TYPE;
|
|
307
307
|
OrganizationUnitStatus?: DataModelsOrganizationUnitStatus;
|
|
308
308
|
}
|
|
@@ -318,24 +318,24 @@ export interface ServicesManagementListWatchtowerDevicesResponse_Watchtower<ID_T
|
|
|
318
318
|
ForceLocalMode: boolean;
|
|
319
319
|
HardwareID?: string;
|
|
320
320
|
/**
|
|
321
|
-
|
|
322
|
-
|
|
321
|
+
* Entity type: Device
|
|
322
|
+
*/
|
|
323
323
|
ID: ID_TYPE;
|
|
324
324
|
LastSeen?: string;
|
|
325
325
|
Locked: boolean;
|
|
326
326
|
Name?: string;
|
|
327
327
|
Online: boolean;
|
|
328
328
|
/**
|
|
329
|
-
|
|
330
|
-
|
|
329
|
+
* Entity type: OrganizationUnit
|
|
330
|
+
*/
|
|
331
331
|
OrganizationUnitBackendID?: string;
|
|
332
332
|
/**
|
|
333
|
-
|
|
334
|
-
|
|
333
|
+
* Entity type: Country
|
|
334
|
+
*/
|
|
335
335
|
OrganizationUnitCountryID?: string;
|
|
336
336
|
/**
|
|
337
|
-
|
|
338
|
-
|
|
337
|
+
* Entity type: OrganizationUnit
|
|
338
|
+
*/
|
|
339
339
|
OrganizationUnitID: ID_TYPE;
|
|
340
340
|
OrganizationUnitName?: string;
|
|
341
341
|
OrganizationUnitStatus: DataModelsOrganizationUnitStatus;
|
|
@@ -345,41 +345,41 @@ export interface ServicesManagementListWatchtowerDevicesResponse_Watchtower<ID_T
|
|
|
345
345
|
WatchtowerLastSeen?: string;
|
|
346
346
|
}
|
|
347
347
|
/**
|
|
348
|
-
|
|
349
|
-
|
|
348
|
+
* Execute a command on a device
|
|
349
|
+
*/
|
|
350
350
|
export interface LiveGuardExecuteTask<ID_TYPE = string> {
|
|
351
351
|
Catalog?: boolean;
|
|
352
352
|
/**
|
|
353
|
-
|
|
354
|
-
|
|
353
|
+
* Entity type: Device
|
|
354
|
+
*/
|
|
355
355
|
DeviceID: ID_TYPE;
|
|
356
356
|
General?: boolean;
|
|
357
357
|
Users?: boolean;
|
|
358
358
|
}
|
|
359
359
|
/**
|
|
360
|
-
|
|
361
|
-
|
|
360
|
+
* Push the current configuration for the given device to mender
|
|
361
|
+
*/
|
|
362
362
|
export interface PushWatchtowerConfigurationToDevice<ID_TYPE = string> {
|
|
363
363
|
/**
|
|
364
|
-
|
|
365
|
-
|
|
364
|
+
* Entity type: Device
|
|
365
|
+
*/
|
|
366
366
|
DeviceID: ID_TYPE;
|
|
367
367
|
}
|
|
368
368
|
/**
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
369
|
+
* Update the lock status of a watchtower device.
|
|
370
|
+
*
|
|
371
|
+
* This can only be done when the device is online
|
|
372
|
+
*/
|
|
373
373
|
export interface ToggleLockStatusForWatchtowerDevice<ID_TYPE = string> {
|
|
374
374
|
/**
|
|
375
|
-
|
|
376
|
-
|
|
375
|
+
* Entity type: Device
|
|
376
|
+
*/
|
|
377
377
|
DeviceID: ID_TYPE;
|
|
378
378
|
IsLocked?: boolean;
|
|
379
379
|
}
|
|
380
380
|
/**
|
|
381
|
-
|
|
382
|
-
|
|
381
|
+
* Uploads a .p7m token file from Apple Business Manager to JAMF. Creates a new enrollment or renews an existing one.
|
|
382
|
+
*/
|
|
383
383
|
export interface UploadABMToken<ID_TYPE = string> {
|
|
384
384
|
Data: string;
|
|
385
385
|
}
|
|
@@ -389,13 +389,13 @@ export interface UploadABMTokenResponse<ID_TYPE = string> {
|
|
|
389
389
|
Status: ServicesManagementABMConnectionStatus;
|
|
390
390
|
}
|
|
391
391
|
/**
|
|
392
|
-
|
|
393
|
-
|
|
392
|
+
* Execute a command on a device
|
|
393
|
+
*/
|
|
394
394
|
export interface WatchtowerExecuteCommand<ID_TYPE = string> {
|
|
395
395
|
Address?: string;
|
|
396
396
|
/**
|
|
397
|
-
|
|
398
|
-
|
|
397
|
+
* Entity type: Device
|
|
398
|
+
*/
|
|
399
399
|
DeviceID: ID_TYPE;
|
|
400
400
|
Port?: number;
|
|
401
401
|
Type: string;
|
|
@@ -407,12 +407,12 @@ export interface WatchtowerExecuteCommandResponse<ID_TYPE = string> {
|
|
|
407
407
|
Success: boolean;
|
|
408
408
|
}
|
|
409
409
|
/**
|
|
410
|
-
|
|
411
|
-
|
|
410
|
+
* Get details about the given device.
|
|
411
|
+
*/
|
|
412
412
|
export interface WatchtowerGetDeviceDetails<ID_TYPE = string> {
|
|
413
413
|
/**
|
|
414
|
-
|
|
415
|
-
|
|
414
|
+
* Entity type: Device
|
|
415
|
+
*/
|
|
416
416
|
DeviceID: ID_TYPE;
|
|
417
417
|
}
|
|
418
418
|
export interface WatchtowerGetDeviceDetailsResponse<ID_TYPE = string> {
|
|
@@ -442,12 +442,12 @@ export interface WatchtowerGetDeviceDetailsResponse<ID_TYPE = string> {
|
|
|
442
442
|
Online: boolean;
|
|
443
443
|
OrganizationUnitBackendID?: string;
|
|
444
444
|
/**
|
|
445
|
-
|
|
446
|
-
|
|
445
|
+
* Entity type: Country
|
|
446
|
+
*/
|
|
447
447
|
OrganizationUnitCountryID?: string;
|
|
448
448
|
/**
|
|
449
|
-
|
|
450
|
-
|
|
449
|
+
* Entity type: OrganizationUnit
|
|
450
|
+
*/
|
|
451
451
|
OrganizationUnitID: ID_TYPE;
|
|
452
452
|
OrganizationUnitName?: string;
|
|
453
453
|
OrganizationUnitStatus: DataModelsOrganizationUnitStatus;
|
|
@@ -479,8 +479,8 @@ export interface EVAStatusResponse<ID_TYPE = string> {
|
|
|
479
479
|
Ready: boolean;
|
|
480
480
|
}
|
|
481
481
|
/**
|
|
482
|
-
|
|
483
|
-
|
|
482
|
+
* Returns some basic information about the current state of the liveGuard
|
|
483
|
+
*/
|
|
484
484
|
export interface LiveGuardGetInformation<ID_TYPE = string> {
|
|
485
485
|
}
|
|
486
486
|
export interface LiveGuardGetInformationResponse<ID_TYPE = string> {
|
|
@@ -505,8 +505,8 @@ export interface LiveGuardGetInformationResponse<ID_TYPE = string> {
|
|
|
505
505
|
Version?: string;
|
|
506
506
|
}
|
|
507
507
|
/**
|
|
508
|
-
|
|
509
|
-
|
|
508
|
+
* This service returns the operational flags for a liveguard instance.
|
|
509
|
+
*/
|
|
510
510
|
export interface LiveGuardGetStatus<ID_TYPE = string> {
|
|
511
511
|
}
|
|
512
512
|
export interface LiveGuardGetStatusResponse<ID_TYPE = string> {
|
|
@@ -518,8 +518,8 @@ export interface LiveGuardGetStatusResponse<ID_TYPE = string> {
|
|
|
518
518
|
RunningOnWatchtower: boolean;
|
|
519
519
|
}
|
|
520
520
|
/**
|
|
521
|
-
|
|
522
|
-
|
|
521
|
+
* Push metrics of the watchtower device to the cloud.
|
|
522
|
+
*/
|
|
523
523
|
export interface LiveGuardPushMetrics<ID_TYPE = string> {
|
|
524
524
|
AvgLatency?: number;
|
|
525
525
|
CPUUsage?: number;
|
|
@@ -537,14 +537,14 @@ export interface LiveGuardPushMetrics<ID_TYPE = string> {
|
|
|
537
537
|
Temperature?: number;
|
|
538
538
|
}
|
|
539
539
|
/**
|
|
540
|
-
|
|
541
|
-
|
|
540
|
+
* Get user information to sync to LiveGuard
|
|
541
|
+
*/
|
|
542
542
|
export interface GetUserForLiveGuard<ID_TYPE = string> {
|
|
543
543
|
EmailAddress?: string;
|
|
544
544
|
NickName?: string;
|
|
545
545
|
/**
|
|
546
|
-
|
|
547
|
-
|
|
546
|
+
* Entity type: User
|
|
547
|
+
*/
|
|
548
548
|
UserID?: ID_TYPE;
|
|
549
549
|
}
|
|
550
550
|
export interface GetUserForLiveGuardResponse<ID_TYPE = string> {
|
|
@@ -552,19 +552,19 @@ export interface GetUserForLiveGuardResponse<ID_TYPE = string> {
|
|
|
552
552
|
BackendID?: string;
|
|
553
553
|
BackendSystemID?: string;
|
|
554
554
|
/**
|
|
555
|
-
|
|
556
|
-
|
|
555
|
+
* Entity type: User
|
|
556
|
+
*/
|
|
557
557
|
CloudIDs?: ID_TYPE[];
|
|
558
558
|
/**
|
|
559
|
-
|
|
560
|
-
|
|
559
|
+
* Entity type: Country
|
|
560
|
+
*/
|
|
561
561
|
CountryID?: string;
|
|
562
562
|
EmailAddress?: string;
|
|
563
563
|
Error?: ServiceError<ID_TYPE>;
|
|
564
564
|
FirstName?: string;
|
|
565
565
|
/**
|
|
566
|
-
|
|
567
|
-
|
|
566
|
+
* Entity type: Language
|
|
567
|
+
*/
|
|
568
568
|
LanguageID?: string;
|
|
569
569
|
LastName?: string;
|
|
570
570
|
Metadata?: ResponseMessageMetadata<ID_TYPE>;
|
|
@@ -593,8 +593,8 @@ export interface ServicesSyncGetUserForLiveGuardResponse_RoleDto<ID_TYPE = strin
|
|
|
593
593
|
}
|
|
594
594
|
export interface LiveGuardGenerateApiKey<ID_TYPE = string> {
|
|
595
595
|
/**
|
|
596
|
-
|
|
597
|
-
|
|
596
|
+
* Entity type: OrganizationUnit
|
|
597
|
+
*/
|
|
598
598
|
OrganizationUnitID: ID_TYPE;
|
|
599
599
|
}
|
|
600
600
|
export interface LiveGuardGenerateApiKeyResponse<ID_TYPE = string> {
|
|
@@ -603,8 +603,8 @@ export interface LiveGuardGenerateApiKeyResponse<ID_TYPE = string> {
|
|
|
603
603
|
Metadata?: ResponseMessageMetadata<ID_TYPE>;
|
|
604
604
|
}
|
|
605
605
|
/**
|
|
606
|
-
|
|
607
|
-
|
|
606
|
+
* Generate a trust token that needs to be provided in the Login call to the cloud to verify local presence
|
|
607
|
+
*/
|
|
608
608
|
export interface LiveGuardGenerateTrustToken<ID_TYPE = string> {
|
|
609
609
|
}
|
|
610
610
|
export interface LiveGuardGenerateTrustTokenResponse<ID_TYPE = string> {
|
|
@@ -613,8 +613,8 @@ export interface LiveGuardGenerateTrustTokenResponse<ID_TYPE = string> {
|
|
|
613
613
|
TrustToken: string;
|
|
614
614
|
}
|
|
615
615
|
/**
|
|
616
|
-
|
|
617
|
-
|
|
616
|
+
* Retreive current chain status for the connected watchtower
|
|
617
|
+
*/
|
|
618
618
|
export interface LiveGuardGetAuditChains<ID_TYPE = string> {
|
|
619
619
|
}
|
|
620
620
|
export interface LiveGuardGetAuditChainsResponse<ID_TYPE = string> {
|
|
@@ -623,8 +623,8 @@ export interface LiveGuardGetAuditChainsResponse<ID_TYPE = string> {
|
|
|
623
623
|
Metadata?: ResponseMessageMetadata<ID_TYPE>;
|
|
624
624
|
}
|
|
625
625
|
/**
|
|
626
|
-
|
|
627
|
-
|
|
626
|
+
* Retreive current secret for TOTP token usage
|
|
627
|
+
*/
|
|
628
628
|
export interface LiveGuardGetTOTPSecret<ID_TYPE = string> {
|
|
629
629
|
}
|
|
630
630
|
export interface LiveGuardGetTOTPSecretResponse<ID_TYPE = string> {
|
|
@@ -633,10 +633,10 @@ export interface LiveGuardGetTOTPSecretResponse<ID_TYPE = string> {
|
|
|
633
633
|
Secret: LiveGuardTOTPSecretWrapper<ID_TYPE>;
|
|
634
634
|
}
|
|
635
635
|
/**
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
636
|
+
* Service called by a liveguard instance to generate an authentication token for an authorized user on the liveguard
|
|
637
|
+
*
|
|
638
|
+
* Can only be called by the liveguard user
|
|
639
|
+
*/
|
|
640
640
|
export interface LiveGuardGetTokenForUser<ID_TYPE = string> {
|
|
641
641
|
UseJwtTokens?: boolean;
|
|
642
642
|
Username: string;
|
|
@@ -648,8 +648,8 @@ export interface LiveGuardGetTokenForUserResponse<ID_TYPE = string> {
|
|
|
648
648
|
RefreshToken?: string;
|
|
649
649
|
}
|
|
650
650
|
/**
|
|
651
|
-
|
|
652
|
-
|
|
651
|
+
* Accepts an Order pushed from a LiveGuard instance
|
|
652
|
+
*/
|
|
653
653
|
export interface LiveGuardPushOrder<ID_TYPE = string> {
|
|
654
654
|
BillingAddress?: AddressesAddressDataDto<ID_TYPE>;
|
|
655
655
|
BlobID: string;
|
|
@@ -704,8 +704,8 @@ export interface ServicesSyncLiveGuardPushOrder_CustomerDto<ID_TYPE = string> {
|
|
|
704
704
|
LanguageID?: string;
|
|
705
705
|
LastName?: string;
|
|
706
706
|
/**
|
|
707
|
-
|
|
708
|
-
|
|
707
|
+
* Entity type: User
|
|
708
|
+
*/
|
|
709
709
|
LiveGuardID: ID_TYPE;
|
|
710
710
|
PhoneNumber?: string;
|
|
711
711
|
}
|
|
@@ -723,16 +723,16 @@ export interface ServicesSyncLiveGuardPushOrder_InvoiceDataDto<ID_TYPE = string>
|
|
|
723
723
|
}
|
|
724
724
|
export interface ServicesSyncLiveGuardPushOrder_InvoiceDocumentLedgerDto<ID_TYPE = string> {
|
|
725
725
|
/**
|
|
726
|
-
|
|
727
|
-
|
|
726
|
+
* Entity type: AuditChain
|
|
727
|
+
*/
|
|
728
728
|
ChainID?: ID_TYPE;
|
|
729
729
|
FailureReason?: string;
|
|
730
730
|
Format?: DataModelsInvoiceDocumentLedgerFormats;
|
|
731
731
|
InvoiceDocumentLedgerData?: DataModelsInvoiceDocumentLedgerData<ID_TYPE>;
|
|
732
732
|
IsSuccess?: boolean;
|
|
733
733
|
/**
|
|
734
|
-
|
|
735
|
-
|
|
734
|
+
* Entity type: Device
|
|
735
|
+
*/
|
|
736
736
|
OriginalDeviceID?: ID_TYPE;
|
|
737
737
|
PreviousSequenceNumber?: number;
|
|
738
738
|
PreviousSignature?: string;
|
|
@@ -750,8 +750,8 @@ export interface ServicesSyncLiveGuardPushOrder_InvoiceDto<ID_TYPE = string> {
|
|
|
750
750
|
Blobs?: ServicesSyncLiveGuardPushOrder_InvoiceBlobDto<ID_TYPE>[];
|
|
751
751
|
CalculationMethod?: DataModelsInvoiceCalculationMethod;
|
|
752
752
|
/**
|
|
753
|
-
|
|
754
|
-
|
|
753
|
+
* Entity type: AuditChain
|
|
754
|
+
*/
|
|
755
755
|
ChainID?: ID_TYPE;
|
|
756
756
|
CurrencyID?: string;
|
|
757
757
|
Description?: string;
|
|
@@ -759,8 +759,8 @@ export interface ServicesSyncLiveGuardPushOrder_InvoiceDto<ID_TYPE = string> {
|
|
|
759
759
|
ExpirationDate?: string;
|
|
760
760
|
FiscalID?: string;
|
|
761
761
|
/**
|
|
762
|
-
|
|
763
|
-
|
|
762
|
+
* Entity type: Invoice
|
|
763
|
+
*/
|
|
764
764
|
ID: ID_TYPE;
|
|
765
765
|
InvoiceData?: ServicesSyncLiveGuardPushOrder_InvoiceDataDto<ID_TYPE>[];
|
|
766
766
|
InvoiceDate?: string;
|
|
@@ -772,8 +772,8 @@ export interface ServicesSyncLiveGuardPushOrder_InvoiceDto<ID_TYPE = string> {
|
|
|
772
772
|
SequenceNumber?: number;
|
|
773
773
|
Signature?: string;
|
|
774
774
|
/**
|
|
775
|
-
|
|
776
|
-
|
|
775
|
+
* Entity type: Station
|
|
776
|
+
*/
|
|
777
777
|
StationID?: string;
|
|
778
778
|
Status?: DataModelsInvoiceStatuses;
|
|
779
779
|
TaxReverseCharge?: boolean;
|
|
@@ -796,8 +796,8 @@ export interface ServicesSyncLiveGuardPushOrder_InvoiceLineDto<ID_TYPE = string>
|
|
|
796
796
|
InvoicedBy?: string;
|
|
797
797
|
NetTaxAmount: number;
|
|
798
798
|
/**
|
|
799
|
-
|
|
800
|
-
|
|
799
|
+
* Entity type: OrderLine
|
|
800
|
+
*/
|
|
801
801
|
OrderLineID: ID_TYPE;
|
|
802
802
|
Quantity?: number;
|
|
803
803
|
TaxAmount?: number;
|
|
@@ -859,13 +859,13 @@ export interface ServicesSyncLiveGuardPushOrder_InvoiceUserDataDto<ID_TYPE = str
|
|
|
859
859
|
export interface ServicesSyncLiveGuardPushOrder_OrderBlobDto<ID_TYPE = string> {
|
|
860
860
|
BlobID: string;
|
|
861
861
|
/**
|
|
862
|
-
|
|
863
|
-
|
|
862
|
+
* Entity type: Invoice
|
|
863
|
+
*/
|
|
864
864
|
InvoiceID?: ID_TYPE;
|
|
865
865
|
Name?: string;
|
|
866
866
|
/**
|
|
867
|
-
|
|
868
|
-
|
|
867
|
+
* Entity type: OrderLine
|
|
868
|
+
*/
|
|
869
869
|
OrderLineID?: ID_TYPE;
|
|
870
870
|
Type?: DataModelsOrderBlobTypes;
|
|
871
871
|
}
|
|
@@ -882,8 +882,8 @@ export interface ServicesSyncLiveGuardPushOrder_OrderLineDiscount<ID_TYPE = stri
|
|
|
882
882
|
CloudID?: ID_TYPE;
|
|
883
883
|
Description?: string;
|
|
884
884
|
/**
|
|
885
|
-
|
|
886
|
-
|
|
885
|
+
* Entity type: OrderLine
|
|
886
|
+
*/
|
|
887
887
|
OrderLineID: ID_TYPE;
|
|
888
888
|
}
|
|
889
889
|
export interface ServicesSyncLiveGuardPushOrder_OrderLineDto<ID_TYPE = string> {
|
|
@@ -895,8 +895,8 @@ export interface ServicesSyncLiveGuardPushOrder_OrderLineDto<ID_TYPE = string> {
|
|
|
895
895
|
Description?: string;
|
|
896
896
|
Discounts?: ServicesSyncLiveGuardPushOrder_OrderLineDiscount<ID_TYPE>[];
|
|
897
897
|
/**
|
|
898
|
-
|
|
899
|
-
|
|
898
|
+
* Entity type: OrderLine
|
|
899
|
+
*/
|
|
900
900
|
ID: ID_TYPE;
|
|
901
901
|
LocalID?: string;
|
|
902
902
|
Quantity?: number;
|
|
@@ -925,13 +925,13 @@ export interface ServicesSyncLiveGuardPushOrder_PaymentDto<ID_TYPE = string> {
|
|
|
925
925
|
Data?: string;
|
|
926
926
|
DataObjects?: string;
|
|
927
927
|
/**
|
|
928
|
-
|
|
929
|
-
|
|
928
|
+
* Entity type: PaymentTransaction
|
|
929
|
+
*/
|
|
930
930
|
ID: ID_TYPE;
|
|
931
931
|
Method?: string;
|
|
932
932
|
/**
|
|
933
|
-
|
|
934
|
-
|
|
933
|
+
* Entity type: Device
|
|
934
|
+
*/
|
|
935
935
|
OriginalDeviceID?: ID_TYPE;
|
|
936
936
|
Status?: DataModelsPaymentStatuses;
|
|
937
937
|
Type?: string;
|
|
@@ -940,8 +940,8 @@ export interface LiveGuardPushOrderResponse<ID_TYPE = string> {
|
|
|
940
940
|
AlreadyExists: boolean;
|
|
941
941
|
Error?: ServiceError<ID_TYPE>;
|
|
942
942
|
/**
|
|
943
|
-
|
|
944
|
-
|
|
943
|
+
* Entity type: Order
|
|
944
|
+
*/
|
|
945
945
|
ID: ID_TYPE;
|
|
946
946
|
Metadata?: ResponseMessageMetadata<ID_TYPE>;
|
|
947
947
|
}
|
|
@@ -972,13 +972,13 @@ export interface LiveGuardSyncUsersByBlobResponse<ID_TYPE = string> {
|
|
|
972
972
|
Url?: string;
|
|
973
973
|
}
|
|
974
974
|
/**
|
|
975
|
-
|
|
976
|
-
|
|
975
|
+
* Trigger a full sync on a liveguard instance, this has major performance impact for a while
|
|
976
|
+
*/
|
|
977
977
|
export interface LiveGuardTriggerSync<ID_TYPE = string> {
|
|
978
978
|
}
|
|
979
979
|
/**
|
|
980
|
-
|
|
981
|
-
|
|
980
|
+
* Accepts an Order pushed from a local device
|
|
981
|
+
*/
|
|
982
982
|
export interface LiveGuardUpsertOrder<ID_TYPE = string> {
|
|
983
983
|
ClientOrderID: string;
|
|
984
984
|
CreationTime: string;
|
|
@@ -1000,8 +1000,8 @@ export interface ServicesSyncLiveGuardUpsertOrder_OrderLineDto<ID_TYPE = string>
|
|
|
1000
1000
|
Identifier?: string;
|
|
1001
1001
|
LocalID?: string;
|
|
1002
1002
|
/**
|
|
1003
|
-
|
|
1004
|
-
|
|
1003
|
+
* Entity type: Product
|
|
1004
|
+
*/
|
|
1005
1005
|
ProductID: ID_TYPE;
|
|
1006
1006
|
Quantity?: number;
|
|
1007
1007
|
SerialNumber?: string;
|
|
@@ -1009,14 +1009,14 @@ export interface ServicesSyncLiveGuardUpsertOrder_OrderLineDto<ID_TYPE = string>
|
|
|
1009
1009
|
export interface LiveGuardUpsertOrderResponse<ID_TYPE = string> {
|
|
1010
1010
|
Error?: ServiceError<ID_TYPE>;
|
|
1011
1011
|
/**
|
|
1012
|
-
|
|
1013
|
-
|
|
1012
|
+
* Entity type: Order
|
|
1013
|
+
*/
|
|
1014
1014
|
ID: ID_TYPE;
|
|
1015
1015
|
Metadata?: ResponseMessageMetadata<ID_TYPE>;
|
|
1016
1016
|
}
|
|
1017
1017
|
/**
|
|
1018
|
-
|
|
1019
|
-
|
|
1018
|
+
* Validate the given token with the cloud, and if valid, trust the chain.
|
|
1019
|
+
*/
|
|
1020
1020
|
export interface LiveGuardValidateToken<ID_TYPE = string> {
|
|
1021
1021
|
AuthenticationToken?: string;
|
|
1022
1022
|
CloudChainID?: string;
|
|
@@ -1029,8 +1029,8 @@ export interface LiveGuardValidateTokenResponse<ID_TYPE = string> {
|
|
|
1029
1029
|
Metadata?: ResponseMessageMetadata<ID_TYPE>;
|
|
1030
1030
|
Nickname?: string;
|
|
1031
1031
|
/**
|
|
1032
|
-
|
|
1033
|
-
|
|
1032
|
+
* Entity type: User
|
|
1033
|
+
*/
|
|
1034
1034
|
UserID?: ID_TYPE;
|
|
1035
1035
|
}
|
|
1036
1036
|
export interface TasksChainDto<ID_TYPE = string> {
|
|
@@ -1038,8 +1038,8 @@ export interface TasksChainDto<ID_TYPE = string> {
|
|
|
1038
1038
|
CurrentSignature?: string;
|
|
1039
1039
|
Discriminator: ID_TYPE;
|
|
1040
1040
|
/**
|
|
1041
|
-
|
|
1042
|
-
|
|
1041
|
+
* Entity type: AuditChain
|
|
1042
|
+
*/
|
|
1043
1043
|
ID: ID_TYPE;
|
|
1044
1044
|
Identifier?: string;
|
|
1045
1045
|
PreviousSequenceNumber?: number;
|