@ixon-cdk/types 1.2.1 → 1.3.0-next.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.
Files changed (117) 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/bottom-sheet.d.ts +14 -0
  4. package/dist/types/component-context/dialog.d.ts +48 -0
  5. package/dist/types/component-context/index.d.ts +64 -4
  6. package/dist/types/component-context/input.d.ts +4 -2
  7. package/dist/types/ixapi/resources/access-recover.d.ts +10 -0
  8. package/dist/types/ixapi/resources/access-token.d.ts +29 -0
  9. package/dist/types/ixapi/resources/agent-activate.d.ts +9 -0
  10. package/dist/types/ixapi/resources/agent-config.d.ts +125 -0
  11. package/dist/types/ixapi/resources/agent-data-alarm.d.ts +44 -0
  12. package/dist/types/ixapi/resources/agent-data-alarming-app.d.ts +7 -0
  13. package/dist/types/ixapi/resources/agent-data-condition.d.ts +11 -0
  14. package/dist/types/ixapi/resources/agent-data-logging-app.d.ts +7 -0
  15. package/dist/types/ixapi/resources/agent-data-monitor.d.ts +6 -0
  16. package/dist/types/ixapi/resources/agent-data-report.d.ts +8 -0
  17. package/dist/types/ixapi/resources/agent-data-source.d.ts +16 -0
  18. package/dist/types/ixapi/resources/agent-data-tag.d.ts +22 -0
  19. package/dist/types/ixapi/resources/agent-data-variable.d.ts +24 -0
  20. package/dist/types/ixapi/resources/agent-device.d.ts +11 -0
  21. package/dist/types/ixapi/resources/agent-mdr-server.d.ts +4 -0
  22. package/dist/types/ixapi/resources/agent-membership.d.ts +6 -0
  23. package/dist/types/ixapi/resources/agent-network-value.d.ts +5 -0
  24. package/dist/types/ixapi/resources/agent-pull.d.ts +4 -0
  25. package/dist/types/ixapi/resources/agent-queue-report.d.ts +16 -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-server.d.ts +26 -0
  29. package/dist/types/ixapi/resources/agent-template.d.ts +3 -0
  30. package/dist/types/ixapi/resources/agent-type-file.d.ts +10 -0
  31. package/dist/types/ixapi/resources/agent-type.d.ts +24 -0
  32. package/dist/types/ixapi/resources/agent.d.ts +151 -0
  33. package/dist/types/ixapi/resources/alarming-app.d.ts +5 -0
  34. package/dist/types/ixapi/resources/app-config.d.ts +4 -0
  35. package/dist/types/ixapi/resources/asset-app-config.d.ts +8 -0
  36. package/dist/types/ixapi/resources/asset-membership.d.ts +6 -0
  37. package/dist/types/ixapi/resources/asset-type.d.ts +5 -0
  38. package/dist/types/ixapi/resources/asset.d.ts +22 -0
  39. package/dist/types/ixapi/resources/audience.d.ts +6 -0
  40. package/dist/types/ixapi/resources/audit-log.d.ts +20 -0
  41. package/dist/types/ixapi/resources/auth-token.d.ts +5 -0
  42. package/dist/types/ixapi/resources/backend-component-function.d.ts +10 -0
  43. package/dist/types/ixapi/resources/backend-component-template-config.d.ts +10 -0
  44. package/dist/types/ixapi/resources/backend-component-template-share.d.ts +5 -0
  45. package/dist/types/ixapi/resources/backend-component-template-version.d.ts +16 -0
  46. package/dist/types/ixapi/resources/backend-component-template.d.ts +10 -0
  47. package/dist/types/ixapi/resources/branding.d.ts +27 -0
  48. package/dist/types/ixapi/resources/company.d.ts +56 -0
  49. package/dist/types/ixapi/resources/component-input.d.ts +32 -0
  50. package/dist/types/ixapi/resources/custom-property.d.ts +47 -0
  51. package/dist/types/ixapi/resources/data-protocol-applied.d.ts +72 -0
  52. package/dist/types/ixapi/resources/data-protocol.d.ts +17 -0
  53. package/dist/types/ixapi/resources/data.d.ts +43 -0
  54. package/dist/types/ixapi/resources/demo-device.d.ts +8 -0
  55. package/dist/types/ixapi/resources/discovery.d.ts +4 -0
  56. package/dist/types/ixapi/resources/email-address-change.d.ts +9 -0
  57. package/dist/types/ixapi/resources/file.d.ts +4 -0
  58. package/dist/types/ixapi/resources/group-role.d.ts +6 -0
  59. package/dist/types/ixapi/resources/group-type.d.ts +6 -0
  60. package/dist/types/ixapi/resources/group.d.ts +11 -0
  61. package/dist/types/ixapi/resources/historical-data-usage.d.ts +3 -0
  62. package/dist/types/ixapi/resources/index.d.ts +103 -0
  63. package/dist/types/ixapi/resources/invite.d.ts +25 -0
  64. package/dist/types/ixapi/resources/label.d.ts +7 -0
  65. package/dist/types/ixapi/resources/licence-bundle.d.ts +10 -0
  66. package/dist/types/ixapi/resources/licence-type.d.ts +13 -0
  67. package/dist/types/ixapi/resources/licence.d.ts +27 -0
  68. package/dist/types/ixapi/resources/location.d.ts +11 -0
  69. package/dist/types/ixapi/resources/logging-app.d.ts +5 -0
  70. package/dist/types/ixapi/resources/lsi-server.d.ts +4 -0
  71. package/dist/types/ixapi/resources/menu-item.d.ts +8 -0
  72. package/dist/types/ixapi/resources/message-filter.d.ts +18 -0
  73. package/dist/types/ixapi/resources/message.d.ts +35 -0
  74. package/dist/types/ixapi/resources/mqtt-broker-client.d.ts +11 -0
  75. package/dist/types/ixapi/resources/mqtt-broker.d.ts +12 -0
  76. package/dist/types/ixapi/resources/object-storage.d.ts +40 -0
  77. package/dist/types/ixapi/resources/otp-auth.d.ts +13 -0
  78. package/dist/types/ixapi/resources/page-component-template-category.d.ts +5 -0
  79. package/dist/types/ixapi/resources/page-component-template-config.d.ts +7 -0
  80. package/dist/types/ixapi/resources/page-component-template-manifest.d.ts +57 -0
  81. package/dist/types/ixapi/resources/page-component-template-version.d.ts +10 -0
  82. package/dist/types/ixapi/resources/page-component-template.d.ts +25 -0
  83. package/dist/types/ixapi/resources/page-component.d.ts +44 -0
  84. package/dist/types/ixapi/resources/page-link-group.d.ts +7 -0
  85. package/dist/types/ixapi/resources/page-link.d.ts +12 -0
  86. package/dist/types/ixapi/resources/page-page.d.ts +6 -0
  87. package/dist/types/ixapi/resources/page-version.d.ts +22 -0
  88. package/dist/types/ixapi/resources/page.d.ts +17 -0
  89. package/dist/types/ixapi/resources/password-change.d.ts +5 -0
  90. package/dist/types/ixapi/resources/permission.d.ts +3 -0
  91. package/dist/types/ixapi/resources/platform-server.d.ts +8 -0
  92. package/dist/types/ixapi/resources/policy.d.ts +23 -0
  93. package/dist/types/ixapi/resources/registration.d.ts +26 -0
  94. package/dist/types/ixapi/resources/report-schedule.d.ts +37 -0
  95. package/dist/types/ixapi/resources/res-link.d.ts +6 -0
  96. package/dist/types/ixapi/resources/role.d.ts +9 -0
  97. package/dist/types/ixapi/resources/rsc-server.d.ts +6 -0
  98. package/dist/types/ixapi/resources/sector.d.ts +31 -0
  99. package/dist/types/ixapi/resources/sso-authentication.d.ts +12 -0
  100. package/dist/types/ixapi/resources/sso-identity-provider.d.ts +7 -0
  101. package/dist/types/ixapi/resources/support-access.d.ts +5 -0
  102. package/dist/types/ixapi/resources/translation.d.ts +7 -0
  103. package/dist/types/ixapi/resources/user-membership.d.ts +11 -0
  104. package/dist/types/ixapi/resources/user-push-device.d.ts +10 -0
  105. package/dist/types/ixapi/resources/user.d.ts +55 -0
  106. package/dist/types/ixapi/resources/vpn-protocol.d.ts +1 -0
  107. package/dist/types/ixapi/resources/vpn-usage.d.ts +11 -0
  108. package/dist/types/ixapi/resources/web-access.d.ts +3 -0
  109. package/dist/types/ixapi/resources/webhook-subscription.d.ts +7 -0
  110. package/dist/types/ixapi/resources/webhook-trigger.d.ts +12 -0
  111. package/dist/types/logging-data/logging-data-value.d.ts +1 -0
  112. package/dist/types/object-storage/index.d.ts +1 -0
  113. package/dist/types/object-storage/object-storage-client.d.ts +58 -0
  114. package/dist/types/resource-data/resource-data-client.d.ts +6 -0
  115. package/dist/types/resource-data/resource-data-query.d.ts +1 -1
  116. package/dist/types/resource-data/resource-data.d.ts +14 -0
  117. 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';
@@ -0,0 +1,14 @@
1
+ export interface ActionBottomSheetOptions {
2
+ /** List of actions. */
3
+ actions: ActionBottomSheetAction[];
4
+ }
5
+ export interface ActionBottomSheetAction {
6
+ /** Title of the action. */
7
+ title: string;
8
+ /** Indicates that the action result is destructive. Defaults to false. */
9
+ destructive?: boolean;
10
+ }
11
+ export interface ActionBottomSheetResult {
12
+ /** The index of the action that was clicked (zero-based). */
13
+ index: number;
14
+ }
@@ -0,0 +1,48 @@
1
+ interface DialogOptions {
2
+ /** Message to show on the dialog. */
3
+ message: string;
4
+ /** Title of the dialog. */
5
+ title: string;
6
+ }
7
+ export interface AlertDialogOptions extends DialogOptions {
8
+ /** Text to use on the action button. Defaults to "Done". */
9
+ buttonText?: string;
10
+ }
11
+ export interface ConfirmDialogOptions extends DialogOptions {
12
+ /** Text to use on the cancelation action button. Defaults to "Cancel". */
13
+ cancelButtonText?: string;
14
+ /** Text to use on the confirmation action button. Defaults to "Confirm". */
15
+ confirmButtonText?: string;
16
+ /** Indicates whether a confirm checkbox must be shown. Defaults to false. */
17
+ confirmCheckbox?: boolean;
18
+ /** Text to use for the confirm checkbox. Defaults to "I am sure". */
19
+ confirmCheckboxText?: string;
20
+ /** Indicates that the confirmation result is destructive. Defaults to false. */
21
+ destructive?: boolean;
22
+ }
23
+ export interface FormDialogOptions {
24
+ /** Text to use on the cancelation action button. Defaults to "Cancel". */
25
+ cancelButtonText?: string;
26
+ /**
27
+ * Indicates whether a discard changes prompt is shown, when the form state is dirty and the user closes the form dialog by pressing
28
+ * escape, clicking on the backdrop or clicking on the cancel button.
29
+ *
30
+ * Defaults to false.
31
+ * */
32
+ discardChangesPrompt?: boolean;
33
+ /** Text to use on the submit action button. Defaults to "Submit". */
34
+ submitButtonText?: string;
35
+ /** Initial value for the form. */
36
+ initialValue?: any;
37
+ /** Inputs that will be rendered in the dialog content. */
38
+ inputs: any[];
39
+ /** Message to show on the dialog. */
40
+ message?: string;
41
+ /** Title of the dialog. */
42
+ title: string;
43
+ }
44
+ export interface FormDialogResult {
45
+ /** The form value that was submitted. */
46
+ value: any;
47
+ }
48
+ export {};
@@ -1,11 +1,16 @@
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';
8
+ import type { ActionBottomSheetOptions, ActionBottomSheetResult } from './bottom-sheet';
9
+ import type { AlertDialogOptions, ConfirmDialogOptions, FormDialogOptions, FormDialogResult } from './dialog';
7
10
  import type { Tooltip, TooltipOptions } from './tooltip';
8
11
  export type { ComponentContextAppData } from './app-data';
12
+ export type { ActionBottomSheetAction, ActionBottomSheetOptions, ActionBottomSheetResult } from './bottom-sheet';
13
+ export type { AlertDialogOptions, ConfirmDialogOptions, FormDialogOptions, FormDialogResult } from './dialog';
9
14
  export type { Tooltip, TooltipOptions } from './tooltip';
10
15
  export * from './input';
11
16
  /**
@@ -84,6 +89,16 @@ export interface ComponentContext<ComponentContextInputs extends object = {
84
89
  * Every time this method is called, a new client is created.
85
90
  */
86
91
  createLoggingDataClient(): LoggingDataClient;
92
+ /**
93
+ * Creates a client to communicate with object storage.
94
+ *
95
+ * Every time this method is called, a new client is created.
96
+ *
97
+ * @experimental This feature is in development. It might not be supported in your environment
98
+ * and might also be removed without prior notice.
99
+ * @ignore
100
+ */
101
+ createObjectStorageClient(): ObjectStorageClient;
87
102
  /**
88
103
  * Creates a client to retrieve resource data.
89
104
  *
@@ -96,8 +111,6 @@ export interface ComponentContext<ComponentContextInputs extends object = {
96
111
  * @param target the target element
97
112
  * @param options configures the tooltip message and other (optional) properties
98
113
  * @returns returns the tooltip instance
99
- *
100
- * @experimental
101
114
  */
102
115
  createTooltip(target: HTMLElement, options: TooltipOptions): Tooltip;
103
116
  /**
@@ -122,6 +135,42 @@ export interface ComponentContext<ComponentContextInputs extends object = {
122
135
  * @param url The URL to navigate to, don't include the host.
123
136
  */
124
137
  navigateByUrl(url: string): void;
138
+ /**
139
+ * Opens an action sheet from the bottom of the screen that displays actions a user can take.
140
+ *
141
+ * @param options configures the action sheet
142
+ *
143
+ * @experimental
144
+ * @ignore
145
+ */
146
+ openActionBottomSheet(options: ActionBottomSheetOptions): Promise<ActionBottomSheetResult>;
147
+ /**
148
+ * Opens an alert dialog.
149
+ *
150
+ * @param options configures the alert dialog
151
+ *
152
+ * @experimental
153
+ * @ignore
154
+ */
155
+ openAlertDialog(options: AlertDialogOptions): Promise<true | undefined>;
156
+ /**
157
+ * Opens a confirmation dialog.
158
+ *
159
+ * @param options configures the confirm dialog
160
+ *
161
+ * @experimental
162
+ * @ignore
163
+ */
164
+ openConfirmDialog(options: ConfirmDialogOptions): Promise<boolean | undefined>;
165
+ /**
166
+ * Opens a form dialog.
167
+ *
168
+ * @param options configures the form dialog
169
+ *
170
+ * @experimental
171
+ * @ignore
172
+ */
173
+ openFormDialog(options: FormDialogOptions): Promise<FormDialogResult | false | undefined>;
125
174
  /**
126
175
  * Save a file.
127
176
  *
@@ -154,12 +203,23 @@ export interface ComponentContext<ComponentContextInputs extends object = {
154
203
  */
155
204
  toggleVpn(agentId: string): void;
156
205
  /**
157
- * Translate a key to the users language.
206
+ * Translate a key to the user's language.
158
207
  *
159
208
  * @param key
160
209
  * @param interpolateParams
210
+ * @param options
211
+ */
212
+ translate(key: string, interpolateParams?: Object, options?: TranslateOptions): string;
213
+ translate<T extends string>(key: T[], interpolateParams?: Object, options?: TranslateOptions): Record<T, string>;
214
+ translate<T extends string>(key: string | T[], interpolateParams?: Object, options?: TranslateOptions): string | Record<T, string>;
215
+ }
216
+ export interface TranslateOptions {
217
+ /**
218
+ * 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.
219
+ *
220
+ * Defaults to `["custom", "global"]`
161
221
  */
162
- translate(key: string | Array<string>, interpolateParams?: Object): string | any;
222
+ source?: 'custom' | 'global' | ('custom' | 'global')[];
163
223
  }
164
224
  /**
165
225
  * 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,125 @@
1
+ import type { ResLink } from './res-link';
2
+ export interface AgentConfig {
3
+ agent?: ResLink;
4
+ configFileReported?: string | null;
5
+ configFileReportedCellularPasswordEnabled?: boolean;
6
+ configFileReportedWlanKeyEnabled?: boolean;
7
+ configFileServer?: string | null;
8
+ configPushedOn?: string | null;
9
+ configReportedOn?: string | null;
10
+ /** @deprecated */
11
+ configsAreDifferent?: boolean;
12
+ differentConfigs?: boolean;
13
+ differentStewardConfigs?: boolean;
14
+ /** NOTE: This public ID is identical to the public ID of its linked agent. */
15
+ publicId: string;
16
+ routerAdditionalSubnets?: AgentRouterAdditionalSubnet[];
17
+ routerDisplay?: AgentConfigRouterDisplay | null;
18
+ routerLan?: AgentConfigRouterLan | null;
19
+ routerPortForwards?: AgentRouterPortForward[];
20
+ routerWan?: AgentConfigRouterWan | null;
21
+ stewardConfigFileReported?: string;
22
+ stewardConfigFileServer?: string;
23
+ stewardConfigReportedOn?: string | null;
24
+ /** @deprecated */
25
+ stewardConfigsAreDifferent?: boolean;
26
+ }
27
+ export interface AgentRouterAdditionalSubnet {
28
+ agent?: ResLink;
29
+ gatewayAddress?: string;
30
+ networkAddress?: string;
31
+ networkMask?: string;
32
+ publicId: string;
33
+ }
34
+ export interface AgentConfigRouterDisplay {
35
+ agent?: ResLink;
36
+ lockEnabled?: boolean;
37
+ lockCode?: string | null;
38
+ }
39
+ export interface AgentConfigRouterLan {
40
+ agent?: ResLink;
41
+ bacnetBbmd?: string[] | null;
42
+ dhcpServerEnabled?: boolean;
43
+ dhcpServerRangeFrom?: string;
44
+ dhcpServerRangeTo?: string;
45
+ forwardLanWan?: AgentConfigRouterForwardLanWan;
46
+ gatewayLessRouting?: boolean;
47
+ ipAddress?: string;
48
+ netMask?: string;
49
+ network?: string;
50
+ udpBroadcastRelayPort?: number[] | null;
51
+ wlanChannel?: number | null /** range between 1-14 */;
52
+ wlanEnable?: boolean | null;
53
+ wlanSsid?: string | null;
54
+ wlanKey?: string | null;
55
+ }
56
+ export type AgentConfigRouterForwardLanWan = 'both' | 'private' | 'public' | 'neither';
57
+ export interface AgentRouterPortForward {
58
+ agent?: ResLink;
59
+ externalPort?: number;
60
+ interface?: 'VPN' | 'WAN';
61
+ publicId: string;
62
+ targetIpAddress?: string;
63
+ targetPort?: number;
64
+ }
65
+ export interface AgentConfigRouterWan {
66
+ /** @deprecated */
67
+ '3gApn'?: string | null;
68
+ /** @deprecated */
69
+ '3gPincode'?: string | null;
70
+ /** @deprecated */
71
+ '3gTrackInterval'?: number;
72
+ /** @deprecated */
73
+ '3gTrackIps'?: string[];
74
+ agent?: ResLink;
75
+ cellularApn?: string | null;
76
+ cellularMtu?: number | null;
77
+ cellularPincode?: string | null;
78
+ cellularPassword?: string | null /** @hidden */;
79
+ cellularTrackInterval?: number;
80
+ cellularTrackIps?: string[];
81
+ cellularUsername?: string | null;
82
+ digitalInputMode?: AgentConfigRouterWanDigitalInputMode;
83
+ dnsServer?: string | null /** @depricated */;
84
+ dnsServers?: string[] | null;
85
+ httpProxyAddress?: string | null;
86
+ httpProxyAuthentication?: 'none' | 'basic' | 'ntlm' | null;
87
+ httpProxyIsSocks5?: boolean | null;
88
+ httpProxyPassword?: string | null /** @hidden */;
89
+ httpProxyPort?: number | null;
90
+ httpProxyUsername?: string | null;
91
+ ipAddress?: string | null;
92
+ ipGateway?: string | null;
93
+ ipNetMask?: string | null;
94
+ ipUseDhcp?: boolean;
95
+ multiwanPolicy?: AgentConfigRouterMultiwanPolicy;
96
+ wanTrackInterval?: number;
97
+ wanTrackIps?: string[];
98
+ wlanDnsServers?: string[] | null;
99
+ wlanIpAddress?: string | null;
100
+ wlanIpGateway?: string | null;
101
+ wlanIpNetMask?: string | null;
102
+ wlanIpUseDhcp?: boolean | null;
103
+ wlanKey?: string | null /** @hidden */;
104
+ wlanSsid?: string | null;
105
+ wlanTrackInterval?: number;
106
+ wlanTrackIps?: string[];
107
+ }
108
+ export interface AgentConfigRouterCellular {
109
+ cellularApn?: string;
110
+ cellularPincode?: string | null;
111
+ cellularMtu?: number | null;
112
+ cellularUsername?: string | null;
113
+ cellularPassword?: string | null;
114
+ }
115
+ export interface AgentConfigRouterWlan {
116
+ wlanKey?: string | null /** @hidden */;
117
+ wlanSsid?: string | null;
118
+ wlanDnsServers?: string[] | null;
119
+ wlanIpAddress?: string | null;
120
+ wlanIpGateway?: string | null;
121
+ wlanIpNetMask?: string | null;
122
+ wlanIpUseDhcp?: boolean | null;
123
+ }
124
+ export type AgentConfigRouterMultiwanPolicy = 'eth_cell_wifi' | 'cell_eth_wifi' | 'eth_wifi_cell' | 'wifi_eth_cell' | 'cell_wifi_eth' | 'wifi_cell_eth';
125
+ 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,16 @@
1
+ import type { ResLink } from './res-link';
2
+ export interface AgentQueueReport extends QueueReport {
3
+ agent: ResLink;
4
+ message?: string;
5
+ report: ResLink;
6
+ sendTo: string[];
7
+ }
8
+ export interface QueueDraftReport extends QueueReport {
9
+ agent: ResLink;
10
+ }
11
+ interface QueueReport {
12
+ end: string;
13
+ start: string;
14
+ timeZone: string;
15
+ }
16
+ export {};
@@ -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,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,3 @@
1
+ import type { AgentLike } from './agent';
2
+ export interface AgentTemplate extends AgentLike {
3
+ }