@ixon-cdk/types 1.18.0-next.2 → 1.18.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/types/ixapi/resources/controlled-device.d.ts +1 -1
- package/dist/types/resource-data/resource-data-add.d.ts +17 -3
- package/dist/types/resource-data/resource-data-query.d.ts +6 -6
- package/dist/types/resource-data/resource-data-remove.d.ts +11 -2
- package/dist/types/resource-data/resource-data-result.d.ts +2 -2
- package/dist/types/resource-data/resource-data-update.d.ts +5 -5
- package/package.json +1 -1
|
@@ -8,7 +8,7 @@ export interface ControlledDevice {
|
|
|
8
8
|
publicId: string;
|
|
9
9
|
}
|
|
10
10
|
/** @check controlleddevice*/
|
|
11
|
-
export type ControlledDeviceAgentReference = Pick<Agent, 'activeVpnSession' | 'company' | 'config' | 'deviceId' | 'lastSeenAgentUserAgent' | 'macAddress' | 'mdrServer' | 'mqttChangedOn' | 'publicId' | 'serialNumber' | 'type' | 'vpnChangedOn' | 'vpnLocked' | 'webAccessLocked'>;
|
|
11
|
+
export type ControlledDeviceAgentReference = Pick<Agent, 'activeStatus' | 'activeVpnSession' | 'company' | 'config' | 'deviceId' | 'lastSeenAgentUserAgent' | 'macAddress' | 'mdrServer' | 'mqttChangedOn' | 'publicId' | 'serialNumber' | 'type' | 'vpnChangedOn' | 'vpnLocked' | 'webAccessLocked'>;
|
|
12
12
|
export interface ControlledDeviceCreate {
|
|
13
13
|
controlKey: string;
|
|
14
14
|
device: string;
|
|
@@ -4,9 +4,23 @@ type ResourceDataAddDataMap = {
|
|
|
4
4
|
AssetAppConfigResource: AtLeast<ResourceData.AssetAppConfigResource, 'resourceType' | 'resourcePublicId'>;
|
|
5
5
|
};
|
|
6
6
|
export type ResourceDataAddSelector = keyof ResourceDataAddDataMap;
|
|
7
|
-
export type ResourceDataAdd<
|
|
7
|
+
export type ResourceDataAdd<TSelector extends ResourceDataAddSelector = ResourceDataAddSelector> = {
|
|
8
|
+
/**
|
|
9
|
+
* String reference unique to the add call made by the client.
|
|
10
|
+
* @ignore
|
|
11
|
+
*/
|
|
8
12
|
_clientRef?: string;
|
|
9
|
-
|
|
10
|
-
|
|
13
|
+
/**
|
|
14
|
+
* The name of the resource, see the
|
|
15
|
+
* [developer documentation](https://developer.ixon.cloud/docs/using-the-resource-data-client#adding-resources) for
|
|
16
|
+
* supported resources.
|
|
17
|
+
*/
|
|
18
|
+
selector: TSelector;
|
|
19
|
+
/**
|
|
20
|
+
* The data to add the resource with, see the
|
|
21
|
+
* [developer documentation](https://developer.ixon.cloud/docs/using-the-resource-data-client#adding-resources) for
|
|
22
|
+
* supported fields.
|
|
23
|
+
*/
|
|
24
|
+
data: ResourceDataAddDataMap[TSelector];
|
|
11
25
|
};
|
|
12
26
|
export {};
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/** @module ResourceDataQuery */
|
|
2
2
|
export type ResourceDataQuerySelector = 'Agent' | 'AppConfig' | 'Asset' | 'AssetAppConfig' | 'AssetAppConfigList' | 'Branding' | 'CustomPropertyList' | 'GroupList' | 'LicenceList' | 'MyCompany' | 'MyUser' | 'PagePage' | 'PageVersion' | 'UserList';
|
|
3
|
-
export interface ResourceDataQuery<
|
|
3
|
+
export interface ResourceDataQuery<TSelector = ResourceDataQuerySelector> {
|
|
4
4
|
/**
|
|
5
|
-
* String reference unique to the query call made by the client
|
|
5
|
+
* String reference unique to the query call made by the client.
|
|
6
6
|
* @ignore
|
|
7
7
|
*/
|
|
8
8
|
_clientRef?: string;
|
|
@@ -15,13 +15,13 @@ export interface ResourceDataQuery<T = ResourceDataQuerySelector> {
|
|
|
15
15
|
/**
|
|
16
16
|
* The name of the resource, see the
|
|
17
17
|
* [developer documentation](https://developer.ixon.cloud/docs/using-the-resource-data-client) for
|
|
18
|
-
* supported resources
|
|
18
|
+
* supported resources.
|
|
19
19
|
*/
|
|
20
|
-
selector:
|
|
20
|
+
selector: TSelector;
|
|
21
21
|
}
|
|
22
22
|
export interface ResourceDataTemplateQuery {
|
|
23
23
|
/**
|
|
24
|
-
* String reference unique to the query call made by the client
|
|
24
|
+
* String reference unique to the query call made by the client.
|
|
25
25
|
* @ignore
|
|
26
26
|
*/
|
|
27
27
|
_clientRef?: string;
|
|
@@ -30,7 +30,7 @@ export interface ResourceDataTemplateQuery {
|
|
|
30
30
|
* [developer documentation](https://developer.ixon.cloud/docs/using-the-resource-data-client) for
|
|
31
31
|
* supported fields. Only 'agent' and 'asset' are supported at the moment.
|
|
32
32
|
*
|
|
33
|
-
* If omitted, an empty object is returned
|
|
33
|
+
* If omitted, an empty object is returned.
|
|
34
34
|
*/
|
|
35
35
|
template: string;
|
|
36
36
|
}
|
|
@@ -3,9 +3,18 @@ type ResourceDataRemoveDataMap = {
|
|
|
3
3
|
AssetAppConfigResource: Partial<ResourceData.AssetAppConfigResource>;
|
|
4
4
|
};
|
|
5
5
|
export type ResourceDataRemoveSelector = keyof ResourceDataRemoveDataMap;
|
|
6
|
-
export type ResourceDataRemove<
|
|
6
|
+
export type ResourceDataRemove<TSelector extends ResourceDataRemoveSelector = ResourceDataRemoveSelector> = {
|
|
7
|
+
/**
|
|
8
|
+
* String reference unique to the remove call made by the client.
|
|
9
|
+
* @ignore
|
|
10
|
+
*/
|
|
7
11
|
_clientRef?: string;
|
|
8
12
|
publicId: string;
|
|
9
|
-
|
|
13
|
+
/**
|
|
14
|
+
* The name of the resource, see the
|
|
15
|
+
* [developer documentation](https://developer.ixon.cloud/docs/using-the-resource-data-client#remove-resources) for
|
|
16
|
+
* supported resources.
|
|
17
|
+
*/
|
|
18
|
+
selector: TSelector;
|
|
10
19
|
};
|
|
11
20
|
export {};
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/** @module ResourceDataResult */
|
|
2
2
|
import type { ResourceDataQuery } from './resource-data-query';
|
|
3
|
-
export interface ResourceDataResult<
|
|
3
|
+
export interface ResourceDataResult<TData = any> {
|
|
4
4
|
query: ResourceDataQuery;
|
|
5
|
-
data:
|
|
5
|
+
data: TData | null;
|
|
6
6
|
}
|
|
@@ -5,23 +5,23 @@ type ResourceDataUpdateDataMap = {
|
|
|
5
5
|
AssetAppConfigResource: AtLeast<ResourceData.AssetAppConfigResource, 'publicId'>;
|
|
6
6
|
};
|
|
7
7
|
export type ResourceDataUpdateSelector = keyof ResourceDataUpdateDataMap;
|
|
8
|
-
export type ResourceDataUpdate<
|
|
8
|
+
export type ResourceDataUpdate<TSelector extends ResourceDataUpdateSelector = ResourceDataUpdateSelector> = {
|
|
9
9
|
/**
|
|
10
|
-
* String reference unique to the
|
|
10
|
+
* String reference unique to the update call made by the client.
|
|
11
11
|
* @ignore
|
|
12
12
|
*/
|
|
13
13
|
_clientRef?: string;
|
|
14
14
|
/**
|
|
15
15
|
* The name of the resource, see the
|
|
16
16
|
* [developer documentation](https://developer.ixon.cloud/docs/using-the-resource-data-client#updating-resources) for
|
|
17
|
-
* supported resources
|
|
17
|
+
* supported resources.
|
|
18
18
|
*/
|
|
19
|
-
selector:
|
|
19
|
+
selector: TSelector;
|
|
20
20
|
/**
|
|
21
21
|
* The data to update the resource with, see the
|
|
22
22
|
* [developer documentation](https://developer.ixon.cloud/docs/using-the-resource-data-client#updating-resources) for
|
|
23
23
|
* supported fields.
|
|
24
24
|
*/
|
|
25
|
-
data: ResourceDataUpdateDataMap[
|
|
25
|
+
data: ResourceDataUpdateDataMap[TSelector];
|
|
26
26
|
};
|
|
27
27
|
export {};
|