@ixon-cdk/types 1.3.0-next.0 → 1.3.0-next.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.
Files changed (116) hide show
  1. package/README.md +1 -1
  2. package/dist/component-devkit/src/types/src/index.d.ts +2 -0
  3. package/dist/types/component-context/index.d.ts +20 -17
  4. package/dist/types/component-context/input.d.ts +4 -2
  5. package/dist/types/ixapi/resources/access-recover.d.ts +10 -0
  6. package/dist/types/ixapi/resources/access-token.d.ts +29 -0
  7. package/dist/types/ixapi/resources/agent-activate.d.ts +9 -0
  8. package/dist/types/ixapi/resources/agent-config.d.ts +127 -0
  9. package/dist/types/ixapi/resources/agent-data-alarm.d.ts +44 -0
  10. package/dist/types/ixapi/resources/agent-data-alarming-app.d.ts +7 -0
  11. package/dist/types/ixapi/resources/agent-data-condition.d.ts +11 -0
  12. package/dist/types/ixapi/resources/agent-data-logging-app.d.ts +7 -0
  13. package/dist/types/ixapi/resources/agent-data-monitor.d.ts +6 -0
  14. package/dist/types/ixapi/resources/agent-data-report.d.ts +8 -0
  15. package/dist/types/ixapi/resources/agent-data-source.d.ts +16 -0
  16. package/dist/types/ixapi/resources/agent-data-tag.d.ts +22 -0
  17. package/dist/types/ixapi/resources/agent-data-variable.d.ts +24 -0
  18. package/dist/types/ixapi/resources/agent-device.d.ts +11 -0
  19. package/dist/types/ixapi/resources/agent-mdr-server.d.ts +4 -0
  20. package/dist/types/ixapi/resources/agent-membership.d.ts +6 -0
  21. package/dist/types/ixapi/resources/agent-network-value.d.ts +5 -0
  22. package/dist/types/ixapi/resources/agent-pull.d.ts +4 -0
  23. package/dist/types/ixapi/resources/agent-queue-report.d.ts +17 -0
  24. package/dist/types/ixapi/resources/agent-registration-profile-membership.d.ts +7 -0
  25. package/dist/types/ixapi/resources/agent-registration-profile.d.ts +9 -0
  26. package/dist/types/ixapi/resources/agent-router-lan-wan-access-rule.d.ts +11 -0
  27. package/dist/types/ixapi/resources/agent-router-vpn-access-rule.d.ts +8 -0
  28. package/dist/types/ixapi/resources/agent-router-vpn-config.d.ts +5 -0
  29. package/dist/types/ixapi/resources/agent-server.d.ts +26 -0
  30. package/dist/types/ixapi/resources/agent-template.d.ts +4 -0
  31. package/dist/types/ixapi/resources/agent-type-file.d.ts +10 -0
  32. package/dist/types/ixapi/resources/agent-type.d.ts +24 -0
  33. package/dist/types/ixapi/resources/agent.d.ts +152 -0
  34. package/dist/types/ixapi/resources/alarming-app.d.ts +5 -0
  35. package/dist/types/ixapi/resources/app-config.d.ts +4 -0
  36. package/dist/types/ixapi/resources/asset-app-config.d.ts +8 -0
  37. package/dist/types/ixapi/resources/asset-membership.d.ts +6 -0
  38. package/dist/types/ixapi/resources/asset-type.d.ts +5 -0
  39. package/dist/types/ixapi/resources/asset.d.ts +22 -0
  40. package/dist/types/ixapi/resources/audience.d.ts +6 -0
  41. package/dist/types/ixapi/resources/audit-log.d.ts +20 -0
  42. package/dist/types/ixapi/resources/auth-token.d.ts +5 -0
  43. package/dist/types/ixapi/resources/backend-component-function.d.ts +10 -0
  44. package/dist/types/ixapi/resources/backend-component-template-config.d.ts +10 -0
  45. package/dist/types/ixapi/resources/backend-component-template-share.d.ts +5 -0
  46. package/dist/types/ixapi/resources/backend-component-template-version.d.ts +16 -0
  47. package/dist/types/ixapi/resources/backend-component-template.d.ts +11 -0
  48. package/dist/types/ixapi/resources/branding.d.ts +27 -0
  49. package/dist/types/ixapi/resources/company.d.ts +56 -0
  50. package/dist/types/ixapi/resources/component-input.d.ts +33 -0
  51. package/dist/types/ixapi/resources/custom-property.d.ts +47 -0
  52. package/dist/types/ixapi/resources/data-protocol-applied.d.ts +72 -0
  53. package/dist/types/ixapi/resources/data-protocol.d.ts +17 -0
  54. package/dist/types/ixapi/resources/data.d.ts +43 -0
  55. package/dist/types/ixapi/resources/demo-device.d.ts +8 -0
  56. package/dist/types/ixapi/resources/discovery.d.ts +4 -0
  57. package/dist/types/ixapi/resources/email-address-change.d.ts +9 -0
  58. package/dist/types/ixapi/resources/file.d.ts +4 -0
  59. package/dist/types/ixapi/resources/group-role.d.ts +6 -0
  60. package/dist/types/ixapi/resources/group-type.d.ts +6 -0
  61. package/dist/types/ixapi/resources/group.d.ts +12 -0
  62. package/dist/types/ixapi/resources/historical-data-usage.d.ts +3 -0
  63. package/dist/types/ixapi/resources/index.d.ts +106 -0
  64. package/dist/types/ixapi/resources/invite.d.ts +25 -0
  65. package/dist/types/ixapi/resources/label.d.ts +7 -0
  66. package/dist/types/ixapi/resources/licence-bundle.d.ts +10 -0
  67. package/dist/types/ixapi/resources/licence-type.d.ts +13 -0
  68. package/dist/types/ixapi/resources/licence.d.ts +27 -0
  69. package/dist/types/ixapi/resources/location.d.ts +11 -0
  70. package/dist/types/ixapi/resources/logging-app.d.ts +5 -0
  71. package/dist/types/ixapi/resources/lsi-server.d.ts +4 -0
  72. package/dist/types/ixapi/resources/menu-item.d.ts +8 -0
  73. package/dist/types/ixapi/resources/message-filter.d.ts +18 -0
  74. package/dist/types/ixapi/resources/message.d.ts +35 -0
  75. package/dist/types/ixapi/resources/mqtt-broker-client.d.ts +11 -0
  76. package/dist/types/ixapi/resources/mqtt-broker.d.ts +12 -0
  77. package/dist/types/ixapi/resources/object-storage.d.ts +40 -0
  78. package/dist/types/ixapi/resources/otp-auth.d.ts +13 -0
  79. package/dist/types/ixapi/resources/page-component-template-category.d.ts +5 -0
  80. package/dist/types/ixapi/resources/page-component-template-config.d.ts +7 -0
  81. package/dist/types/ixapi/resources/page-component-template-manifest.d.ts +57 -0
  82. package/dist/types/ixapi/resources/page-component-template-version.d.ts +10 -0
  83. package/dist/types/ixapi/resources/page-component-template.d.ts +25 -0
  84. package/dist/types/ixapi/resources/page-component.d.ts +44 -0
  85. package/dist/types/ixapi/resources/page-link-group.d.ts +7 -0
  86. package/dist/types/ixapi/resources/page-link.d.ts +12 -0
  87. package/dist/types/ixapi/resources/page-page.d.ts +6 -0
  88. package/dist/types/ixapi/resources/page-version.d.ts +22 -0
  89. package/dist/types/ixapi/resources/page.d.ts +17 -0
  90. package/dist/types/ixapi/resources/password-change.d.ts +5 -0
  91. package/dist/types/ixapi/resources/permission.d.ts +3 -0
  92. package/dist/types/ixapi/resources/platform-server.d.ts +8 -0
  93. package/dist/types/ixapi/resources/policy.d.ts +23 -0
  94. package/dist/types/ixapi/resources/registration.d.ts +26 -0
  95. package/dist/types/ixapi/resources/report-schedule.d.ts +38 -0
  96. package/dist/types/ixapi/resources/res-link.d.ts +6 -0
  97. package/dist/types/ixapi/resources/role.d.ts +9 -0
  98. package/dist/types/ixapi/resources/rsc-server.d.ts +6 -0
  99. package/dist/types/ixapi/resources/sector.d.ts +31 -0
  100. package/dist/types/ixapi/resources/sso-authentication.d.ts +12 -0
  101. package/dist/types/ixapi/resources/sso-identity-provider.d.ts +7 -0
  102. package/dist/types/ixapi/resources/support-access.d.ts +5 -0
  103. package/dist/types/ixapi/resources/translation.d.ts +7 -0
  104. package/dist/types/ixapi/resources/user-membership.d.ts +11 -0
  105. package/dist/types/ixapi/resources/user-push-device.d.ts +10 -0
  106. package/dist/types/ixapi/resources/user.d.ts +55 -0
  107. package/dist/types/ixapi/resources/vpn-protocol.d.ts +1 -0
  108. package/dist/types/ixapi/resources/vpn-usage.d.ts +11 -0
  109. package/dist/types/ixapi/resources/web-access.d.ts +3 -0
  110. package/dist/types/ixapi/resources/webhook-subscription.d.ts +7 -0
  111. package/dist/types/ixapi/resources/webhook-trigger.d.ts +12 -0
  112. package/dist/types/logging-data/logging-data-value.d.ts +1 -0
  113. package/dist/types/object-storage/index.d.ts +1 -0
  114. package/dist/types/object-storage/object-storage-client.d.ts +58 -0
  115. package/dist/types/resource-data/resource-data-client.d.ts +4 -0
  116. package/package.json +1 -1
package/README.md CHANGED
@@ -1,3 +1,3 @@
1
1
  # IXON Component Development Kit Types
2
2
 
3
- This package can be used with the IXON Component Development Kit (CDK). It contains Type Definitions that can be used when you develop custom components using [TypeScript](https://www.typescriptlang.org/).
3
+ This package can be used with the IXON Component Development Kit (CDK). It contains Type Definitions that can be used when you develop UI Components using [TypeScript](https://www.typescriptlang.org/).
@@ -2,6 +2,8 @@ export * from '../../../../types/component-context';
2
2
  export * from '../../../../types/backend-component';
3
3
  export * from '../../../../types/component-context';
4
4
  export * from '../../../../types/ixapi';
5
+ export * from '../../../../types/ixapi/resources';
5
6
  export * from '../../../../types/logging-data';
7
+ export * from '../../../../types/object-storage';
6
8
  export * from '../../../../types/resource-data';
7
9
  export * from '../../../../types/vpn-client';
@@ -1,6 +1,7 @@
1
1
  /** @module ComponentContext */
2
2
  import type { BackendComponentClient } from '../backend-component';
3
3
  import type { LoggingDataClient, LoggingDataTimeRange } from '../logging-data';
4
+ import type { ObjectStorageClient } from '../object-storage';
4
5
  import type { ResourceDataClient } from '../resource-data';
5
6
  import type { VpnClientStatus } from '../vpn-client';
6
7
  import type { ComponentContextAppData } from './app-data';
@@ -76,10 +77,6 @@ export interface ComponentContext<ComponentContextInputs extends object = {
76
77
  * Creates a client to call backend components.
77
78
  *
78
79
  * Every time this method is called, a new client is created.
79
- *
80
- * @experimental This feature is in development. It might not be supported in your environment
81
- * and might also be removed without prior notice.
82
- * @ignore
83
80
  */
84
81
  createBackendComponentClient(): BackendComponentClient;
85
82
  /**
@@ -88,6 +85,12 @@ export interface ComponentContext<ComponentContextInputs extends object = {
88
85
  * Every time this method is called, a new client is created.
89
86
  */
90
87
  createLoggingDataClient(): LoggingDataClient;
88
+ /**
89
+ * Creates a client to communicate with object storage.
90
+ *
91
+ * Every time this method is called, a new client is created.
92
+ */
93
+ createObjectStorageClient(): ObjectStorageClient;
91
94
  /**
92
95
  * Creates a client to retrieve resource data.
93
96
  *
@@ -100,8 +103,6 @@ export interface ComponentContext<ComponentContextInputs extends object = {
100
103
  * @param target the target element
101
104
  * @param options configures the tooltip message and other (optional) properties
102
105
  * @returns returns the tooltip instance
103
- *
104
- * @experimental
105
106
  */
106
107
  createTooltip(target: HTMLElement, options: TooltipOptions): Tooltip;
107
108
  /**
@@ -139,27 +140,18 @@ export interface ComponentContext<ComponentContextInputs extends object = {
139
140
  * Opens an alert dialog.
140
141
  *
141
142
  * @param options configures the alert dialog
142
- *
143
- * @experimental
144
- * @ignore
145
143
  */
146
144
  openAlertDialog(options: AlertDialogOptions): Promise<true | undefined>;
147
145
  /**
148
146
  * Opens a confirmation dialog.
149
147
  *
150
148
  * @param options configures the confirm dialog
151
- *
152
- * @experimental
153
- * @ignore
154
149
  */
155
150
  openConfirmDialog(options: ConfirmDialogOptions): Promise<boolean | undefined>;
156
151
  /**
157
152
  * Opens a form dialog.
158
153
  *
159
154
  * @param options configures the form dialog
160
- *
161
- * @experimental
162
- * @ignore
163
155
  */
164
156
  openFormDialog(options: FormDialogOptions): Promise<FormDialogResult | false | undefined>;
165
157
  /**
@@ -194,12 +186,23 @@ export interface ComponentContext<ComponentContextInputs extends object = {
194
186
  */
195
187
  toggleVpn(agentId: string): void;
196
188
  /**
197
- * Translate a key to the users language.
189
+ * Translate a key to the user's language.
198
190
  *
199
191
  * @param key
200
192
  * @param interpolateParams
193
+ * @param options
194
+ */
195
+ translate(key: string, interpolateParams?: Object, options?: TranslateOptions): string;
196
+ translate<T extends string>(key: T[], interpolateParams?: Object, options?: TranslateOptions): Record<T, string>;
197
+ translate<T extends string>(key: string | T[], interpolateParams?: Object, options?: TranslateOptions): string | Record<T, string>;
198
+ }
199
+ export interface TranslateOptions {
200
+ /**
201
+ * Indicates in which translation source or sources the translation will be looked up. When provided as a list, the order defines which source takes precedence over another.
202
+ *
203
+ * Defaults to `["custom", "global"]`
201
204
  */
202
- translate(key: string | Array<string>, interpolateParams?: Object): string | any;
205
+ source?: 'custom' | 'global' | ('custom' | 'global')[];
203
206
  }
204
207
  /**
205
208
  * A ComponentContext factory is injected into each component. Through this factory, a ComponentContext instance can be constructed.
@@ -1,11 +1,13 @@
1
- export interface ComponentContextAggregatedMetricInput {
2
- aggregator: string;
1
+ export interface ComponentContextRawMetricInput {
3
2
  decimals: number | null;
4
3
  factor: number | null;
5
4
  selector: string;
6
5
  transform: null;
7
6
  unit: string | null;
8
7
  }
8
+ export interface ComponentContextAggregatedMetricInput extends ComponentContextRawMetricInput {
9
+ aggregator: string;
10
+ }
9
11
  export interface ComponentContextLiveMetricInput {
10
12
  decimals: number | null;
11
13
  factor: number | null;
@@ -0,0 +1,10 @@
1
+ export interface AccessRecover {
2
+ emailAddress?: string;
3
+ }
4
+ export interface AccessRecoverCreate {
5
+ emailAddress: string;
6
+ }
7
+ export interface AccessRecoverFinish {
8
+ deleteAccessTokens: boolean;
9
+ newPassword: string;
10
+ }
@@ -0,0 +1,29 @@
1
+ import type { GeoLocation } from './location';
2
+ import type { SsoAuthentication } from './sso-authentication';
3
+ import type { MyUser } from './user';
4
+ export interface AccessToken {
5
+ created?: {
6
+ ip?: string;
7
+ /** I.e. "2019-01-01T12:00:00Z" */
8
+ on?: string;
9
+ userAgent?: string;
10
+ };
11
+ /** I.e. "2019-01-01T12:00:00Z" */
12
+ expiresOn?: string;
13
+ geoLocation?: GeoLocation | null;
14
+ publicId: string;
15
+ }
16
+ export interface AccessTokenCreate {
17
+ /** In seconds. */
18
+ expiresIn: number;
19
+ }
20
+ export interface AccessTokenSsoCreate extends AccessTokenCreate {
21
+ ssoAuthentication: SsoAuthentication;
22
+ }
23
+ export interface AccessTokenCreateResponse {
24
+ /** I.e. "2019-01-01T12:00:00Z" */
25
+ expiresOn: string;
26
+ publicId: string;
27
+ secretId: string;
28
+ user: MyUser;
29
+ }
@@ -0,0 +1,9 @@
1
+ import type { ResLink } from './res-link';
2
+ export interface AgentActivate {
3
+ couponCode?: string;
4
+ groups?: ResLink[];
5
+ licence?: ResLink;
6
+ name?: string;
7
+ publicId: string;
8
+ template?: ResLink;
9
+ }
@@ -0,0 +1,127 @@
1
+ import type { AgentRouterVpnConfig } from './agent-router-vpn-config';
2
+ import type { ResLink } from './res-link';
3
+ export interface AgentConfig {
4
+ agent?: ResLink;
5
+ configFileReported?: string | null;
6
+ configFileReportedCellularPasswordEnabled?: boolean;
7
+ configFileReportedWlanKeyEnabled?: boolean;
8
+ configFileServer?: string | null;
9
+ configPushedOn?: string | null;
10
+ configReportedOn?: string | null;
11
+ /** @deprecated */
12
+ configsAreDifferent?: boolean;
13
+ differentConfigs?: boolean;
14
+ differentStewardConfigs?: boolean;
15
+ /** NOTE: This public ID is identical to the public ID of its linked agent. */
16
+ publicId: string;
17
+ routerAdditionalSubnets?: AgentRouterAdditionalSubnet[];
18
+ routerDisplay?: AgentConfigRouterDisplay | null;
19
+ routerLan?: AgentConfigRouterLan | null;
20
+ routerPortForwards?: AgentRouterPortForward[];
21
+ routerVpn?: AgentRouterVpnConfig;
22
+ routerWan?: AgentConfigRouterWan | null;
23
+ stewardConfigFileReported?: string;
24
+ stewardConfigFileServer?: string;
25
+ stewardConfigReportedOn?: string | null;
26
+ /** @deprecated */
27
+ stewardConfigsAreDifferent?: boolean;
28
+ }
29
+ export interface AgentRouterAdditionalSubnet {
30
+ agent?: ResLink;
31
+ gatewayAddress?: string;
32
+ networkAddress?: string;
33
+ networkMask?: string;
34
+ publicId: string;
35
+ }
36
+ export interface AgentConfigRouterDisplay {
37
+ agent?: ResLink;
38
+ lockEnabled?: boolean;
39
+ lockCode?: string | null;
40
+ }
41
+ export interface AgentConfigRouterLan {
42
+ agent?: ResLink;
43
+ bacnetBbmd?: string[] | null;
44
+ dhcpServerEnabled?: boolean;
45
+ dhcpServerRangeFrom?: string;
46
+ dhcpServerRangeTo?: string;
47
+ forwardLanWan?: AgentConfigRouterForwardLanWan;
48
+ gatewayLessRouting?: boolean;
49
+ ipAddress?: string;
50
+ netMask?: string;
51
+ network?: string;
52
+ udpBroadcastRelayPort?: number[] | null;
53
+ wlanChannel?: number | null /** range between 1-14 */;
54
+ wlanEnable?: boolean | null;
55
+ wlanSsid?: string | null;
56
+ wlanKey?: string | null;
57
+ }
58
+ export type AgentConfigRouterForwardLanWan = 'both' | 'private' | 'public' | 'neither';
59
+ export interface AgentRouterPortForward {
60
+ agent?: ResLink;
61
+ externalPort?: number;
62
+ interface?: 'VPN' | 'WAN';
63
+ publicId: string;
64
+ targetIpAddress?: string;
65
+ targetPort?: number;
66
+ }
67
+ export interface AgentConfigRouterWan {
68
+ /** @deprecated */
69
+ '3gApn'?: string | null;
70
+ /** @deprecated */
71
+ '3gPincode'?: string | null;
72
+ /** @deprecated */
73
+ '3gTrackInterval'?: number;
74
+ /** @deprecated */
75
+ '3gTrackIps'?: string[];
76
+ agent?: ResLink;
77
+ cellularApn?: string | null;
78
+ cellularMtu?: number | null;
79
+ cellularPincode?: string | null;
80
+ cellularPassword?: string | null /** @hidden */;
81
+ cellularTrackInterval?: number;
82
+ cellularTrackIps?: string[];
83
+ cellularUsername?: string | null;
84
+ digitalInputMode?: AgentConfigRouterWanDigitalInputMode;
85
+ dnsServer?: string | null /** @depricated */;
86
+ dnsServers?: string[] | null;
87
+ httpProxyAddress?: string | null;
88
+ httpProxyAuthentication?: 'none' | 'basic' | 'ntlm' | null;
89
+ httpProxyIsSocks5?: boolean | null;
90
+ httpProxyPassword?: string | null /** @hidden */;
91
+ httpProxyPort?: number | null;
92
+ httpProxyUsername?: string | null;
93
+ ipAddress?: string | null;
94
+ ipGateway?: string | null;
95
+ ipNetMask?: string | null;
96
+ ipUseDhcp?: boolean;
97
+ multiwanPolicy?: AgentConfigRouterMultiwanPolicy;
98
+ wanTrackInterval?: number;
99
+ wanTrackIps?: string[];
100
+ wlanDnsServers?: string[] | null;
101
+ wlanIpAddress?: string | null;
102
+ wlanIpGateway?: string | null;
103
+ wlanIpNetMask?: string | null;
104
+ wlanIpUseDhcp?: boolean | null;
105
+ wlanKey?: string | null /** @hidden */;
106
+ wlanSsid?: string | null;
107
+ wlanTrackInterval?: number;
108
+ wlanTrackIps?: string[];
109
+ }
110
+ export interface AgentConfigRouterCellular {
111
+ cellularApn?: string;
112
+ cellularPincode?: string | null;
113
+ cellularMtu?: number | null;
114
+ cellularUsername?: string | null;
115
+ cellularPassword?: string | null;
116
+ }
117
+ export interface AgentConfigRouterWlan {
118
+ wlanKey?: string | null /** @hidden */;
119
+ wlanSsid?: string | null;
120
+ wlanDnsServers?: string[] | null;
121
+ wlanIpAddress?: string | null;
122
+ wlanIpGateway?: string | null;
123
+ wlanIpNetMask?: string | null;
124
+ wlanIpUseDhcp?: boolean | null;
125
+ }
126
+ export type AgentConfigRouterMultiwanPolicy = 'eth_cell_wifi' | 'cell_eth_wifi' | 'eth_wifi_cell' | 'wifi_eth_cell' | 'cell_wifi_eth' | 'wifi_cell_eth';
127
+ export type AgentConfigRouterWanDigitalInputMode = 'disable_vpn_high' | 'disable_vpn_low' | 'disable_wan_high' | 'disable_wan_low' | null;
@@ -0,0 +1,44 @@
1
+ import type { ResLink } from './res-link';
2
+ import type { User } from './user';
3
+ export interface AgentDataAlarm {
4
+ agent?: ResLink;
5
+ audience?: ResLink | null;
6
+ autoAcknowledge?: boolean | null;
7
+ booleanNormalValue?: boolean | null;
8
+ device?: ResLink;
9
+ /** For example: "$2 8 >=" (when variable 2 is greater than or equal to 8) */
10
+ formula?: string;
11
+ name?: string;
12
+ /** In milliseconds */
13
+ offDelay?: number | null;
14
+ /** In milliseconds */
15
+ offResetDelay?: number | null;
16
+ /** In milliseconds */
17
+ onDelay?: number | null;
18
+ /** In milliseconds */
19
+ onResetDelay?: number | null;
20
+ operatorInstructionRtn?: string | null;
21
+ outOfService?: boolean | null;
22
+ publicId: string;
23
+ severity?: 'low' | 'medium' | 'high' | null;
24
+ source?: ResLink;
25
+ type?: 'unary' | 'boolean' | 'error_bits' | 'threshold' | 'rate_of_change' | 'bit_pattern';
26
+ }
27
+ export interface AgentDataAlarmOcc {
28
+ publicId: string;
29
+ alarm?: AgentDataAlarm;
30
+ occuredOn?: string;
31
+ acknowledged?: boolean | null;
32
+ acknowledgedOn?: string | null;
33
+ acknowledgedBy?: User | null;
34
+ comment?: string | null;
35
+ silenced?: boolean;
36
+ rtnOn?: string | null;
37
+ annunciations?: AgentDataAlarmOccAnn[];
38
+ stillActiveOn?: string | null;
39
+ rateLimitTill?: string | null;
40
+ }
41
+ export interface AgentDataAlarmOccAnn {
42
+ user?: User;
43
+ announcedOn?: string;
44
+ }
@@ -0,0 +1,7 @@
1
+ import type { ResLink } from './res-link';
2
+ export interface AgentDataAlarmingAppActivate {
3
+ publicId: string;
4
+ couponCode?: string;
5
+ licence?: ResLink | null;
6
+ trial?: boolean;
7
+ }
@@ -0,0 +1,11 @@
1
+ import type { ResLink } from './res-link';
2
+ export interface AgentDataCondition {
3
+ agent?: ResLink;
4
+ description?: string | null;
5
+ device?: ResLink;
6
+ /** For example: "#2 8 >=" (when variable 2 is greater than or equal to 8) */
7
+ formula?: string;
8
+ name?: string;
9
+ publicId: string;
10
+ source?: ResLink;
11
+ }
@@ -0,0 +1,7 @@
1
+ import type { ResLink } from './res-link';
2
+ export interface AgentDataLoggingAppActivate {
3
+ publicId: string;
4
+ couponCode?: string;
5
+ licence?: ResLink | null;
6
+ trial?: boolean;
7
+ }
@@ -0,0 +1,6 @@
1
+ export interface AgentDataMonitor {
2
+ darkTheme?: boolean;
3
+ layout?: object;
4
+ name?: string;
5
+ publicId: string;
6
+ }
@@ -0,0 +1,8 @@
1
+ export interface AgentDataReport {
2
+ darkTheme?: boolean;
3
+ defaultTimePeriod?: string;
4
+ layout?: object;
5
+ name?: string;
6
+ publicId: string;
7
+ version?: string;
8
+ }
@@ -0,0 +1,16 @@
1
+ import type { DataProtocolAppliedUnion } from './data-protocol-applied';
2
+ import type { ResLink } from './res-link';
3
+ export interface AgentDataSource {
4
+ agent?: ResLink;
5
+ device?: ResLink;
6
+ disabled?: boolean;
7
+ mqttBrokerClient?: ResLink | null;
8
+ mqttTopic?: string | null;
9
+ name?: string | null;
10
+ port?: number | null;
11
+ protocol?: DataProtocolAppliedUnion;
12
+ publicId: string;
13
+ pullDelay?: number | null;
14
+ slug?: string | null;
15
+ valuesPerHour?: number;
16
+ }
@@ -0,0 +1,22 @@
1
+ import type { AgentDataCondition } from './agent-data-condition';
2
+ import type { AgentDataVariable } from './agent-data-variable';
3
+ import type { ResLink } from './res-link';
4
+ export interface AgentDataTag {
5
+ agent?: ResLink;
6
+ aggregators?: string[];
7
+ device?: ResLink;
8
+ downsamplingInterval?: boolean;
9
+ /** When set to null will revert to "last", "shortest" and "longest". Only applicable to strings */
10
+ edgeAggregator?: 'min' | 'max' | 'shortest' | 'longest' | 'mean' | 'last' | 'increase' | null;
11
+ logEvent?: 'interval' | 'change' | 'trigger';
12
+ loggingInterval?: string;
13
+ logTrigger?: AgentDataCondition | null;
14
+ name?: string;
15
+ publicId: string;
16
+ retentionPolicy?: string;
17
+ slug?: string | null;
18
+ source?: ResLink;
19
+ onChangeExpiry?: string | null;
20
+ tagId?: number;
21
+ variable?: AgentDataVariable;
22
+ }
@@ -0,0 +1,24 @@
1
+ import type { ResLink } from './res-link';
2
+ export interface AgentDataVariable {
3
+ address?: string;
4
+ agent?: ResLink;
5
+ device?: ResLink;
6
+ extraData?: any;
7
+ factor?: number | null;
8
+ forAlarming?: boolean;
9
+ forLogging?: boolean;
10
+ internalUse?: boolean;
11
+ maxStringLength?: number | null;
12
+ name?: string;
13
+ publicId: string;
14
+ signed?: boolean | null;
15
+ slug?: string | null;
16
+ source?: ResLink;
17
+ type?: AgentDataVariableType;
18
+ unit?: string | null;
19
+ updateable?: boolean;
20
+ variableId?: number;
21
+ width?: AgentDataVariableWidth | null;
22
+ }
23
+ export type AgentDataVariableType = 'bool' | 'int' | 'float' | 'str';
24
+ export type AgentDataVariableWidth = '8' | '16' | '32' | '64';
@@ -0,0 +1,11 @@
1
+ import type { ResLink } from './res-link';
2
+ import type { AgentDataSource } from './agent-data-source';
3
+ export interface AgentDevice {
4
+ agent?: ResLink;
5
+ customAddress?: string | null;
6
+ dataSources?: AgentDataSource[];
7
+ ipAddress?: string | null;
8
+ macAddress?: string | null;
9
+ name?: string | null;
10
+ publicId: string;
11
+ }
@@ -0,0 +1,4 @@
1
+ export interface AgentMdrServer {
2
+ name?: string;
3
+ publicId: string;
4
+ }
@@ -0,0 +1,6 @@
1
+ import type { ResLink } from './res-link';
2
+ export interface AgentMembership {
3
+ agent?: ResLink;
4
+ group?: ResLink;
5
+ publicId: string;
6
+ }
@@ -0,0 +1,5 @@
1
+ export interface AgentNetworkValue {
2
+ interface?: string;
3
+ name: string;
4
+ value: string[];
5
+ }
@@ -0,0 +1,4 @@
1
+ export interface AgentPull {
2
+ device: string;
3
+ pullCode: string;
4
+ }
@@ -0,0 +1,17 @@
1
+ import type { ResLink } from './res-link';
2
+ export interface QueueDraftReport {
3
+ agent?: ResLink | null;
4
+ asset?: ResLink | null;
5
+ end: string;
6
+ report: ResLink;
7
+ start: string;
8
+ timeZone: string;
9
+ }
10
+ export interface QueueReport {
11
+ end: string;
12
+ message?: string | null;
13
+ report: ResLink;
14
+ sendTo: string[];
15
+ start: string;
16
+ timeZone: string;
17
+ }
@@ -0,0 +1,7 @@
1
+ import type { AgentRegistrationProfileGroup } from "./group";
2
+ import type { ResLink } from "./res-link";
3
+ export interface AgentRegistrationProfileMembership {
4
+ group?: AgentRegistrationProfileGroup;
5
+ profile?: ResLink;
6
+ publicId: string;
7
+ }
@@ -0,0 +1,9 @@
1
+ import type { AgentRegistrationProfileMembership } from "./agent-registration-profile-membership";
2
+ import type { AgentRegistrationProfileAgentTemplate } from "./agent-template";
3
+ export interface AgentRegistrationProfile {
4
+ agentActivationName?: string | null;
5
+ memberships?: AgentRegistrationProfileMembership[];
6
+ name?: string | null;
7
+ publicId: string;
8
+ template?: AgentRegistrationProfileAgentTemplate | null;
9
+ }
@@ -0,0 +1,11 @@
1
+ import type { ResLink } from './res-link';
2
+ export interface AgentRouterLanWanAccessRule {
3
+ agent?: ResLink;
4
+ description?: string | null;
5
+ destinationPort?: number | null;
6
+ protocol?: AgentRouterTransportProtocol;
7
+ publicId: string;
8
+ sourceIpAddress?: string | null;
9
+ sourceMacAddress?: string | null;
10
+ }
11
+ export type AgentRouterTransportProtocol = 'all' | 'tcp' | 'udp' | 'icmp' | 'ah' | 'ax.25' | 'dccp' | 'ddp' | 'egp' | 'eigrp' | 'encap' | 'esp' | 'etherip' | 'fc' | 'ggp' | 'gre' | 'hmp' | 'idpr-cmtp' | 'idrp' | 'igmp' | 'igp' | 'ipcomp' | 'ipencap' | 'ipip' | 'ipv6' | 'ipv6-frag' | 'ipv6-icmp' | 'ipv6-nonxt' | 'ipv6-opts' | 'ipv6-route' | 'isis' | 'iso-tp4' | 'l2tp' | 'ospf' | 'pim' | 'pup' | 'rdp' | 'rspf' | 'rsvp' | 'sctp' | 'skip' | 'st' | 'vmtp' | 'vrrp' | 'xns-idp' | 'xtp';
@@ -0,0 +1,8 @@
1
+ import type { ResLink } from './res-link';
2
+ export interface AgentRouterVpnAccessRule {
3
+ agent?: ResLink;
4
+ audience?: ResLink;
5
+ ipAddress?: string;
6
+ netMask?: string;
7
+ publicId: string;
8
+ }
@@ -0,0 +1,5 @@
1
+ import type { ResLink } from "./res-link";
2
+ export interface AgentRouterVpnConfig {
3
+ agent?: ResLink;
4
+ sourceNatEnabled?: boolean;
5
+ }
@@ -0,0 +1,26 @@
1
+ import type { ResLink } from './res-link';
2
+ export interface AgentServer {
3
+ agent?: ResLink;
4
+ audience?: ResLink | null;
5
+ connectionQuality?: 'high' | 'normal' | 'low' | null;
6
+ custom?: {};
7
+ device?: ResLink;
8
+ httpAuthenticationType?: 'ntlm' | 'basic' | 'digest' | null;
9
+ landingPage?: string;
10
+ name?: string;
11
+ password?: string | null;
12
+ port?: number;
13
+ publicId: string;
14
+ readOnly?: boolean | null;
15
+ serviceGroup?: string | null;
16
+ template?: {
17
+ publicId?: string;
18
+ };
19
+ type?: 'http' | 'rdp' | 'vnc' | 'websocket';
20
+ username?: string | null;
21
+ useSsl?: boolean;
22
+ /** default: true */
23
+ visibleInMobileApp?: boolean;
24
+ vncEncoding?: string | null;
25
+ vncRightClickOnTouchHold?: boolean;
26
+ }
@@ -0,0 +1,4 @@
1
+ import type { AgentLike } from './agent';
2
+ export type AgentRegistrationProfileAgentTemplate = Pick<AgentTemplate, 'publicId' | 'name'>;
3
+ export interface AgentTemplate extends AgentLike {
4
+ }
@@ -0,0 +1,10 @@
1
+ export interface AgentTypeFile {
2
+ code?: string;
3
+ description?: string;
4
+ latest?: boolean;
5
+ name?: string;
6
+ notes?: string;
7
+ publicId: string;
8
+ size?: number;
9
+ type?: 'firmware';
10
+ }
@@ -0,0 +1,24 @@
1
+ import type { AgentServer } from './agent-server';
2
+ export interface AgentType {
3
+ additionalSubnets?: boolean;
4
+ allowDataPublishing?: boolean;
5
+ allowDemoDevice?: boolean;
6
+ allowReboot?: boolean;
7
+ allowTemplating?: boolean;
8
+ configPush?: boolean;
9
+ configFileFormat?: number;
10
+ customServers?: boolean;
11
+ deviceIdFormat?: string;
12
+ httpProxyPort?: number;
13
+ latestFirmwareFile?: any;
14
+ name?: string;
15
+ offlineConfiguration?: boolean;
16
+ publicId: string;
17
+ purchasePrice?: {
18
+ gratis?: boolean;
19
+ };
20
+ router?: boolean;
21
+ servers?: AgentServer[];
22
+ stunnelSupport?: boolean;
23
+ wanPortForwardings?: boolean;
24
+ }