@ixon-cdk/types 1.4.0-next.2 → 1.4.0

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 (46) hide show
  1. package/dist/types/ixapi/resources/access-recover.d.ts +1 -2
  2. package/dist/types/ixapi/resources/access-token.d.ts +2 -2
  3. package/dist/types/ixapi/resources/agent-activate.d.ts +1 -1
  4. package/dist/types/ixapi/resources/agent-config.d.ts +19 -19
  5. package/dist/types/ixapi/resources/agent-data-alarm.d.ts +1 -1
  6. package/dist/types/ixapi/resources/agent-data-tag.d.ts +2 -2
  7. package/dist/types/ixapi/resources/agent-data-variable.d.ts +1 -2
  8. package/dist/types/ixapi/resources/agent-pull.d.ts +2 -0
  9. package/dist/types/ixapi/resources/agent-registration-profile-membership.d.ts +2 -2
  10. package/dist/types/ixapi/resources/agent-registration-profile.d.ts +3 -2
  11. package/dist/types/ixapi/resources/agent-router-vpn-config.d.ts +1 -1
  12. package/dist/types/ixapi/resources/agent-server.d.ts +1 -1
  13. package/dist/types/ixapi/resources/agent-type.d.ts +1 -1
  14. package/dist/types/ixapi/resources/agent.d.ts +10 -10
  15. package/dist/types/ixapi/resources/api-application.d.ts +5 -0
  16. package/dist/types/ixapi/resources/app-config.d.ts +1 -1
  17. package/dist/types/ixapi/resources/audit-log.d.ts +30 -13
  18. package/dist/types/ixapi/resources/auth-token.d.ts +13 -1
  19. package/dist/types/ixapi/resources/backend-component-template-share.d.ts +1 -1
  20. package/dist/types/ixapi/resources/backend-component-template-version.d.ts +2 -5
  21. package/dist/types/ixapi/resources/backend-component-template.d.ts +7 -1
  22. package/dist/types/ixapi/resources/branding.d.ts +1 -1
  23. package/dist/types/ixapi/resources/component-input.d.ts +1 -0
  24. package/dist/types/ixapi/resources/demo-device.d.ts +0 -1
  25. package/dist/types/ixapi/resources/index.d.ts +1 -2
  26. package/dist/types/ixapi/resources/invite.d.ts +7 -3
  27. package/dist/types/ixapi/resources/licence-type.d.ts +1 -6
  28. package/dist/types/ixapi/resources/licence.d.ts +0 -2
  29. package/dist/types/ixapi/resources/message-filter.d.ts +0 -2
  30. package/dist/types/ixapi/resources/mqtt-broker-client.d.ts +1 -0
  31. package/dist/types/ixapi/resources/object-storage.d.ts +13 -13
  32. package/dist/types/ixapi/resources/page-component-template.d.ts +9 -0
  33. package/dist/types/ixapi/resources/page-component.d.ts +0 -10
  34. package/dist/types/ixapi/resources/platform-server.d.ts +1 -1
  35. package/dist/types/ixapi/resources/policy.d.ts +5 -7
  36. package/dist/types/ixapi/resources/registration.d.ts +3 -4
  37. package/dist/types/ixapi/resources/rsc-server.d.ts +3 -3
  38. package/dist/types/ixapi/resources/sso-identity-provider.d.ts +1 -1
  39. package/dist/types/ixapi/resources/user-push-device.d.ts +1 -2
  40. package/dist/types/ixapi/resources/user.d.ts +8 -4
  41. package/dist/types/resource-data/resource-data-client.d.ts +1 -0
  42. package/dist/types/resource-data/resource-data-query.d.ts +1 -1
  43. package/dist/types/resource-data/resource-data.d.ts +6 -6
  44. package/package.json +1 -1
  45. package/dist/types/ixapi/resources/agent-data-monitor.d.ts +0 -6
  46. package/dist/types/ixapi/resources/agent-data-report.d.ts +0 -8
@@ -1,8 +1,7 @@
1
1
  export interface AccessRecover {
2
2
  emailAddress?: string;
3
3
  }
4
- export interface AccessRecoverCreate {
5
- emailAddress: string;
4
+ export interface AccessRecoverCreate extends Required<Pick<AccessRecover, 'emailAddress'>> {
6
5
  }
7
6
  export interface AccessRecoverFinish {
8
7
  deleteAccessTokens: boolean;
@@ -3,10 +3,10 @@ import type { SsoAuthentication } from './sso-authentication';
3
3
  import type { MyUser } from './user';
4
4
  export interface AccessToken {
5
5
  created?: {
6
- ip?: string;
6
+ ip?: string | null;
7
7
  /** I.e. "2019-01-01T12:00:00Z" */
8
8
  on?: string;
9
- userAgent?: string;
9
+ userAgent?: string | null;
10
10
  };
11
11
  /** I.e. "2019-01-01T12:00:00Z" */
12
12
  expiresOn?: string;
@@ -5,5 +5,5 @@ export interface AgentActivate {
5
5
  licence?: ResLink;
6
6
  name?: string;
7
7
  publicId: string;
8
- template?: ResLink;
8
+ template?: ResLink | null;
9
9
  }
@@ -8,8 +8,6 @@ export interface AgentConfig {
8
8
  configFileServer?: string | null;
9
9
  configPushedOn?: string | null;
10
10
  configReportedOn?: string | null;
11
- /** @deprecated */
12
- configsAreDifferent?: boolean;
13
11
  differentConfigs?: boolean;
14
12
  differentStewardConfigs?: boolean;
15
13
  differentWanConfigs?: boolean;
@@ -21,11 +19,9 @@ export interface AgentConfig {
21
19
  routerPortForwards?: AgentRouterPortForward[];
22
20
  routerVpn?: AgentRouterVpnConfig;
23
21
  routerWan?: AgentConfigRouterWan | null;
24
- stewardConfigFileReported?: string;
25
- stewardConfigFileServer?: string;
22
+ stewardConfigFileReported?: string | null;
23
+ stewardConfigFileServer?: string | null;
26
24
  stewardConfigReportedOn?: string | null;
27
- /** @deprecated */
28
- stewardConfigsAreDifferent?: boolean;
29
25
  }
30
26
  export interface AgentRouterAdditionalSubnet {
31
27
  agent?: ResLink;
@@ -43,8 +39,8 @@ export interface AgentConfigRouterLan {
43
39
  agent?: ResLink;
44
40
  bacnetBbmd?: string[] | null;
45
41
  dhcpServerEnabled?: boolean;
46
- dhcpServerRangeFrom?: string;
47
- dhcpServerRangeTo?: string;
42
+ dhcpServerRangeFrom?: string | null;
43
+ dhcpServerRangeTo?: string | null;
48
44
  forwardLanWan?: AgentConfigRouterForwardLanWan;
49
45
  gatewayLessRouting?: boolean;
50
46
  ipAddress?: string;
@@ -78,35 +74,39 @@ export interface AgentConfigRouterWan {
78
74
  cellularApn?: string | null;
79
75
  cellularMtu?: number | null;
80
76
  cellularPincode?: string | null;
81
- cellularPassword?: string | null /** @hidden */;
82
- cellularTrackInterval?: number;
77
+ /** @hidden */
78
+ cellularPassword?: string | null;
79
+ cellularTrackInterval?: number | null;
83
80
  cellularTrackIps?: string[];
84
81
  cellularUsername?: string | null;
85
- digitalInputMode?: AgentConfigRouterWanDigitalInputMode;
82
+ digitalInputMode?: AgentConfigRouterWanDigitalInputMode | null;
86
83
  dnsRebindProtectionEnabled?: boolean | null;
87
- dnsServer?: string | null /** @depricated */;
84
+ /** @deprecated */
85
+ dnsServer?: string | null;
88
86
  dnsServers?: string[] | null;
89
87
  httpProxyAddress?: string | null;
90
88
  httpProxyAuthentication?: 'none' | 'basic' | 'ntlm' | null;
91
89
  httpProxyIsSocks5?: boolean | null;
92
- httpProxyPassword?: string | null /** @hidden */;
90
+ /** @hidden */
91
+ httpProxyPassword?: string | null;
93
92
  httpProxyPort?: number | null;
94
93
  httpProxyUsername?: string | null;
95
94
  ipAddress?: string | null;
96
95
  ipGateway?: string | null;
97
96
  ipNetMask?: string | null;
98
- ipUseDhcp?: boolean;
99
- multiwanPolicy?: AgentConfigRouterMultiwanPolicy;
100
- wanTrackInterval?: number;
97
+ ipUseDhcp?: boolean | null;
98
+ multiwanPolicy?: AgentConfigRouterMultiwanPolicy | null;
99
+ wanTrackInterval?: number | null;
101
100
  wanTrackIps?: string[];
102
101
  wlanDnsServers?: string[] | null;
103
102
  wlanIpAddress?: string | null;
104
103
  wlanIpGateway?: string | null;
105
104
  wlanIpNetMask?: string | null;
106
105
  wlanIpUseDhcp?: boolean | null;
107
- wlanKey?: string | null /** @hidden */;
106
+ /** @hidden */
107
+ wlanKey?: string | null;
108
108
  wlanSsid?: string | null;
109
- wlanTrackInterval?: number;
109
+ wlanTrackInterval?: number | null;
110
110
  wlanTrackIps?: string[];
111
111
  }
112
112
  export interface AgentConfigRouterCellular {
@@ -126,4 +126,4 @@ export interface AgentConfigRouterWlan {
126
126
  wlanIpUseDhcp?: boolean | null;
127
127
  }
128
128
  export type AgentConfigRouterMultiwanPolicy = 'eth_cell_wifi' | 'cell_eth_wifi' | 'eth_wifi_cell' | 'wifi_eth_cell' | 'cell_wifi_eth' | 'wifi_cell_eth';
129
- export type AgentConfigRouterWanDigitalInputMode = 'disable_vpn_high' | 'disable_vpn_low' | 'disable_wan_high' | 'disable_wan_low' | null;
129
+ export type AgentConfigRouterWanDigitalInputMode = 'disable_vpn_high' | 'disable_vpn_low' | 'disable_wan_high' | 'disable_wan_low';
@@ -4,7 +4,7 @@ export interface AgentDataAlarm {
4
4
  audience?: ResLink | null;
5
5
  autoAcknowledge?: boolean | null;
6
6
  booleanNormalValue?: boolean | null;
7
- device?: ResLink;
7
+ device?: ResLink | null;
8
8
  /** For example: "$2 8 >=" (when variable 2 is greater than or equal to 8) */
9
9
  formula?: string;
10
10
  name?: string;
@@ -8,12 +8,12 @@ export interface AgentDataTag {
8
8
  /** When set to null will revert to "last", "shortest" and "longest" only applicable to strings */
9
9
  edgeAggregator?: 'any' | 'avg' | 'min' | 'max' | 'first' | 'last' | 'shortest' | 'longest' | 'increase' | null;
10
10
  logEvent?: 'interval' | 'change' | 'trigger';
11
- loggingInterval?: string;
11
+ loggingInterval?: string | null;
12
12
  logTrigger?: ResLink | null;
13
13
  name?: string;
14
14
  onChangeExpiry?: string | null;
15
15
  publicId: string;
16
- retentionPolicy?: string;
16
+ retentionPolicy?: string | null;
17
17
  slug?: string | null;
18
18
  source?: ResLink;
19
19
  tagId?: number;
@@ -4,8 +4,7 @@ export interface AgentDataVariable {
4
4
  agent?: ResLink;
5
5
  custom?: {};
6
6
  device?: ResLink;
7
- extraData?: any;
8
- factor?: number | null;
7
+ factor?: string | null;
9
8
  forAlarming?: boolean;
10
9
  forLogging?: boolean;
11
10
  internalUse?: boolean;
@@ -1,4 +1,6 @@
1
+ import type { ResLink } from './res-link';
1
2
  export interface AgentPull {
2
3
  device: string;
4
+ groups?: ResLink[];
3
5
  pullCode: string;
4
6
  }
@@ -1,5 +1,5 @@
1
- import type { AgentRegistrationProfileGroup } from "./group";
2
- import type { ResLink } from "./res-link";
1
+ import type { AgentRegistrationProfileGroup } from './group';
2
+ import type { ResLink } from './res-link';
3
3
  export interface AgentRegistrationProfileMembership {
4
4
  group?: AgentRegistrationProfileGroup;
5
5
  profile?: ResLink;
@@ -1,5 +1,5 @@
1
- import type { AgentRegistrationProfileMembership } from "./agent-registration-profile-membership";
2
- import type { AgentRegistrationProfileAgentTemplate } from "./agent-template";
1
+ import type { AgentRegistrationProfileMembership } from './agent-registration-profile-membership';
2
+ import type { AgentRegistrationProfileAgentTemplate } from './agent-template';
3
3
  export interface AgentRegistrationProfile {
4
4
  agentActivationName?: string | null;
5
5
  memberships?: AgentRegistrationProfileMembership[];
@@ -7,3 +7,4 @@ export interface AgentRegistrationProfile {
7
7
  publicId: string;
8
8
  template?: AgentRegistrationProfileAgentTemplate | null;
9
9
  }
10
+ export type AgentRegistrationProfileReference = Pick<AgentRegistrationProfile, 'publicId' | 'name' | 'agentActivationName'>;
@@ -1,4 +1,4 @@
1
- import type { ResLink } from "./res-link";
1
+ import type { ResLink } from './res-link';
2
2
  export interface AgentRouterVpnConfig {
3
3
  agent?: ResLink;
4
4
  sourceNatEnabled?: boolean;
@@ -14,7 +14,7 @@ export interface AgentServer {
14
14
  publicId: string;
15
15
  readOnly?: boolean | null;
16
16
  serviceGroup?: string | null;
17
- template?: AgentServerTemplate;
17
+ template?: AgentServerTemplate | null;
18
18
  type?: AgentServerType;
19
19
  username?: string | null;
20
20
  useSsl?: boolean;
@@ -10,7 +10,7 @@ export interface AgentType {
10
10
  custom?: {};
11
11
  customServers?: boolean;
12
12
  deviceIdFormat?: string;
13
- httpProxyPort?: number;
13
+ httpProxyPort?: number | null;
14
14
  latestFirmwareFile?: any;
15
15
  name?: string;
16
16
  offlineConfiguration?: boolean;
@@ -4,6 +4,7 @@ import type { AgentDevice } from './agent-device';
4
4
  import type { AgentMdrServer } from './agent-mdr-server';
5
5
  import type { AgentMembership } from './agent-membership';
6
6
  import type { AgentNetworkValue } from './agent-network-value';
7
+ import type { AgentRegistrationProfileReference } from './agent-registration-profile';
7
8
  import type { AgentRouterLanWanAccessRule } from './agent-router-lan-wan-access-rule';
8
9
  import type { AgentRouterOneToOneNatRule } from './agent-router-one-to-one-nat-rule';
9
10
  import type { AgentRouterVpnAccessRule } from './agent-router-vpn-access-rule';
@@ -13,11 +14,10 @@ import type { AgentType } from './agent-type';
13
14
  import type { AlarmingApp } from './alarming-app';
14
15
  import type { Audience } from './audience';
15
16
  import type { DemoDevice } from './demo-device';
16
- import type { Invite } from './invite';
17
17
  import type { Licence } from './licence';
18
- import type { LsiServer } from './lsi-server';
19
18
  import type { GeoLocation, Location } from './location';
20
19
  import type { LoggingApp } from './logging-app';
20
+ import type { LsiServer } from './lsi-server';
21
21
  import type { PageLink } from './page-link';
22
22
  import type { ResLink } from './res-link';
23
23
  import type { User } from './user';
@@ -35,7 +35,6 @@ export interface Agent extends AgentLike {
35
35
  deviceId?: string | null;
36
36
  fixedVpnAddress?: string | null;
37
37
  geoLocation?: GeoLocation | null;
38
- invitesWithAccess?: Invite[];
39
38
  lastSeenAgentUserAgent?: AgentUserAgent | null;
40
39
  location?: Location | null;
41
40
  loggingApp?: LoggingApp;
@@ -53,6 +52,7 @@ export interface Agent extends AgentLike {
53
52
  preferLocationOverGeoip?: boolean;
54
53
  pullCodeGeneratedOn?: string | null;
55
54
  rateLimiting?: AgentRateLimiting;
55
+ registrationProfile?: AgentRegistrationProfileReference | null;
56
56
  replaceMacAddress?: string | null;
57
57
  replaceRegistration?: boolean;
58
58
  reRegistration?: boolean;
@@ -71,7 +71,7 @@ export interface AgentLike {
71
71
  description?: string | null;
72
72
  devices?: AgentDevice[];
73
73
  lanWanAccessRules?: AgentRouterLanWanAccessRule[];
74
- name?: string;
74
+ name?: string | null;
75
75
  oneToOneNatRules?: AgentRouterOneToOneNatRule[];
76
76
  pageLinks?: PageLink[];
77
77
  publicId: string;
@@ -127,14 +127,14 @@ export interface AgentUserAgent {
127
127
  wifi?: boolean;
128
128
  }
129
129
  export interface AgentRateLimiting {
130
- configMqttCommandCounter?: number;
131
- configMqttCommandLastHit?: string;
130
+ configMqttCommandCounter?: number | null;
131
+ configMqttCommandLastHit?: string | null;
132
132
  configMqttCommandLimit?: AgentRateLimitingStatus;
133
- configMqttDataCounter?: number;
134
- configMqttDataLastHit?: string;
133
+ configMqttDataCounter?: number | null;
134
+ configMqttDataLastHit?: string | null;
135
135
  configMqttDataLimit?: AgentRateLimitingStatus;
136
- configOpenvpnCounter?: number;
137
- configOpenvpnLastHit?: string;
136
+ configOpenvpnCounter?: number | null;
137
+ configOpenvpnLastHit?: string | null;
138
138
  configOpenvpnLimit?: AgentRateLimitingStatus;
139
139
  }
140
140
  /**
@@ -0,0 +1,5 @@
1
+ export interface ApiApplication {
2
+ custom?: {};
3
+ name?: string;
4
+ publicId: string;
5
+ }
@@ -1,4 +1,4 @@
1
1
  export interface AppConfigUpdate {
2
- enabled?: boolean;
2
+ enabled: boolean;
3
3
  publicId: string;
4
4
  }
@@ -1,20 +1,37 @@
1
1
  export interface AuditLog {
2
2
  action: AuditLogAction;
3
- actor: {
4
- resource: any;
5
- type: string;
6
- };
7
- after: any[];
8
- application?: {
3
+ actor: AuditLogActor;
4
+ after: any[] | null;
5
+ application: {
9
6
  name: string;
10
- };
11
- before: any[];
7
+ } | null;
8
+ before: any[] | null;
12
9
  publicId: string;
13
- request?: {
14
- fromName: string;
15
- };
10
+ request?: AuditLogRequest;
16
11
  target: string;
17
- time: string /** I.e. "2019-01-01T12:00:00.000000Z" */;
18
- topic: any;
12
+ /** I.e. "2019-01-01T12:00:00Z" */
13
+ time: string;
14
+ topic: AuditLogTopic;
19
15
  }
20
16
  export type AuditLogAction = 'CREATE' | 'UPDATE' | 'DELETE' | 'TRIGGER';
17
+ interface AuditLogRequest {
18
+ fromName: string | null;
19
+ ipAddress: string;
20
+ }
21
+ interface AuditLogActor {
22
+ resource: AuditLogActorResource;
23
+ type: AuditLogActorType;
24
+ }
25
+ interface AuditLogActorResource {
26
+ name: string;
27
+ publicId: string;
28
+ type: string;
29
+ }
30
+ type AuditLogActorType = 'agent' | 'client' | 'support' | 'webshopintegration';
31
+ interface AuditLogTopic {
32
+ agent?: string | null;
33
+ asset?: string | null;
34
+ company?: string;
35
+ user?: string | null;
36
+ }
37
+ export {};
@@ -1,5 +1,17 @@
1
+ export type AuthTokenPurpose = 'change-notifications' | 'data';
1
2
  export interface AuthToken {
2
- expiresOn: string;
3
+ created?: {
4
+ ip?: string | null;
5
+ /** I.e. "2019-01-01T12:00:00Z" */
6
+ on?: string;
7
+ userAgent?: string | null;
8
+ };
9
+ expiresOn?: string;
10
+ publicId: string;
11
+ purpose?: AuthTokenPurpose;
12
+ }
13
+ export interface AuthTokenCreateResponse {
14
+ expiresOn?: string;
3
15
  publicId: string;
4
16
  secretId: string;
5
17
  }
@@ -1,4 +1,4 @@
1
- import type { ResLink } from "./res-link";
1
+ import type { ResLink } from './res-link';
2
2
  export interface BackendComponentTemplateShare {
3
3
  company: ResLink;
4
4
  template: ResLink;
@@ -1,15 +1,12 @@
1
1
  import type { ResLink } from './res-link';
2
- export interface BackendComponentTemplateConfiguredVersion {
3
- publicId: string;
4
- number?: string;
5
- }
6
2
  export interface BackendComponentTemplateVersion {
7
3
  template?: ResLink;
8
4
  publicId: string;
9
5
  number?: string;
10
- publishedOn?: string;
6
+ publishedOn?: string | null;
11
7
  createdOn?: string;
12
8
  }
9
+ export type BackendComponentTemplateConfiguredVersion = Pick<BackendComponentTemplateVersion, 'number' | 'publicId'>;
13
10
  export interface BackendComponentTemplateVersionUpdate {
14
11
  publicId: string;
15
12
  published?: boolean;
@@ -1,11 +1,17 @@
1
+ import type { ApiApplication } from './api-application';
2
+ import type { BackendComponentTemplateConfiguredVersion } from './backend-component-template-version';
1
3
  import type { CompanyReference } from './company';
2
4
  import type { ResLink } from './res-link';
3
5
  export interface BackendComponentTemplate {
6
+ accessTokenScope?: string | null;
7
+ apiApplication?: ApiApplication;
4
8
  company?: CompanyReference | null;
9
+ configuredVersion?: BackendComponentTemplateConfiguredVersion | null;
5
10
  description?: string | null;
6
11
  draft?: ResLink | null;
7
12
  name?: string;
8
- ownerName?: string;
13
+ ownerName?: string | null;
14
+ private?: boolean;
9
15
  publicId: string;
10
16
  published?: ResLink | null;
11
17
  }
@@ -11,7 +11,7 @@ export interface Branding {
11
11
  fqdn?: string | null;
12
12
  googlePlayStoreLink?: string | null;
13
13
  logo?: string | null;
14
- name?: string;
14
+ name?: string | null;
15
15
  publicId: string;
16
16
  theme?: BrandingTheme | null;
17
17
  }
@@ -18,6 +18,7 @@ export interface ComponentInput {
18
18
  minLength?: number;
19
19
  options?: {
20
20
  label: string;
21
+ shortLabel?: string;
21
22
  value: any;
22
23
  }[];
23
24
  pattern?: RegExp;
@@ -1,7 +1,6 @@
1
1
  import type { AgentType } from './agent-type';
2
2
  export interface DemoDevice {
3
3
  agentType?: AgentType;
4
- containerId?: string;
5
4
  dmvServer?: any;
6
5
  expiresOn?: string;
7
6
  publicId: string;
@@ -8,8 +8,6 @@ export * from './agent-data-alarm-occurrence';
8
8
  export * from './agent-data-alarming-app';
9
9
  export * from './agent-data-condition';
10
10
  export * from './agent-data-logging-app';
11
- export * from './agent-data-monitor';
12
- export * from './agent-data-report';
13
11
  export * from './agent-data-source';
14
12
  export * from './agent-data-tag';
15
13
  export * from './agent-data-variable';
@@ -30,6 +28,7 @@ export * from './agent-template';
30
28
  export * from './agent-type';
31
29
  export * from './agent-type-file';
32
30
  export * from './alarming-app';
31
+ export * from './api-application';
33
32
  export * from './app-config';
34
33
  export * from './asset';
35
34
  export * from './asset-app-config';
@@ -1,7 +1,11 @@
1
1
  import type { Company } from './company';
2
2
  import type { ResLink } from './res-link';
3
- import type { User } from './user';
3
+ import type { MyUser } from './user';
4
4
  import type { UserMembership } from './user-membership';
5
+ interface UserBase extends Pick<MyUser, 'emailAddress' | 'language' | 'localisation' | 'name' | 'publicId' | 'timeZone'> {
6
+ custom?: Record<string, unknown>;
7
+ }
8
+ /** @check Invite&MyInvite&MyUserInvite */
5
9
  export interface Invite {
6
10
  company?: Company | null;
7
11
  emailAddress?: string;
@@ -9,13 +13,12 @@ export interface Invite {
9
13
  language?: string;
10
14
  memberships?: UserMembership[];
11
15
  publicId: string;
12
- user?: User;
16
+ user?: UserBase;
13
17
  }
14
18
  export interface InviteCreate {
15
19
  emailAddress: string;
16
20
  groupRoles: InviteCreateGroupRole[];
17
21
  language?: string;
18
- managedBy?: ResLink;
19
22
  message?: string;
20
23
  }
21
24
  export interface InviteCreateGroupRole {
@@ -23,3 +26,4 @@ export interface InviteCreateGroupRole {
23
26
  group: ResLink;
24
27
  role: ResLink;
25
28
  }
29
+ export {};
@@ -1,13 +1,8 @@
1
- import type { Company } from './company';
2
- import type { Sector } from './sector';
3
1
  export type LicenceTypeScope = 'agent' | 'company';
4
2
  export type LicenceUsageType = 'advanced-user-management' | 'agent-registration-profile' | 'alarming' | 'api-integrations' | 'app-engine-level-1' | 'app-engine-level-2' | 'asset-management' | 'card-view' | 'connection-monitoring' | 'custom-branding' | 'custom-domain' | 'custom-fields' | 'custom-legal' | 'custom-legal-legacy' | 'custom-sso' | 'ixagent' | 'live-data' | 'logging' | 'main-pages' | 'm2m-cloud-cluster' | 'mobile-app' | 'mqtt-device' | 'object-storage' | 'premium-branding' | 'remote-access' | 'reporting' | 'sla' | 'temporary-access' | 'vpn-access-rule' | 'vpn-usage';
5
3
  export interface LicenceType {
6
- bound?: boolean;
7
- company?: Company;
8
- companyLimit?: number;
4
+ companyLimit?: number | null;
9
5
  publicId: string;
10
6
  scope?: LicenceTypeScope;
11
- sector?: Sector;
12
7
  usageType?: LicenceUsageType;
13
8
  }
@@ -13,12 +13,10 @@ export interface Licence {
13
13
  bundle?: LicenceBundle | null;
14
14
  expiresOn?: string | null;
15
15
  hasAgent?: boolean;
16
- isExpired?: boolean;
17
16
  locked?: boolean | null;
18
17
  maxRetentionPolicy?: string | null;
19
18
  publicId: string;
20
19
  serialNumber: string;
21
- timeLeft?: number | null;
22
20
  trial?: boolean;
23
21
  type?: LicenceType;
24
22
  value?: string | null;
@@ -1,5 +1,4 @@
1
1
  import type { MessageSystemLabel } from './message';
2
- import type { User } from './user';
3
2
  export interface MessageFilter {
4
3
  actions?: MessageFilterAction[];
5
4
  companyPublicIds?: string[];
@@ -13,6 +12,5 @@ export interface MessageFilter {
13
12
  publicId: string;
14
13
  shortContains?: string | null;
15
14
  systemLabels?: MessageSystemLabel[];
16
- user?: User;
17
15
  }
18
16
  export type MessageFilterAction = 'delete' | 'dont-forward-to-mail' | 'dont-send-push-notification' | 'dont-send-webhook-trigger' | 'forward-to-mail' | 'mark-as-read';
@@ -1,4 +1,5 @@
1
1
  import type { ResLink } from './res-link';
2
+ /** @check MqttBrokerClient&MqttBrokerClientCreate */
2
3
  export interface MqttBrokerClient {
3
4
  clientCert?: string | null;
4
5
  clientKey?: string | null;
@@ -6,35 +6,35 @@ export declare const enum ObjectStorageUploadUrlTypeEnum {
6
6
  }
7
7
  export type ObjectStorageUploadUrlType = 'azure-blob-storage';
8
8
  export interface ObjectStorageUpload {
9
- template?: ResLink;
10
- uuid?: string;
11
9
  arguments?: BackendComponentFunctionCallArgs | null;
10
+ template: ResLink;
11
+ uuid: string;
12
12
  }
13
13
  export interface ObjectStorageDownload {
14
- template?: ResLink;
15
- uuid?: string;
16
14
  arguments?: BackendComponentFunctionCallArgs | null;
15
+ template: ResLink;
16
+ uuid: string;
17
17
  }
18
18
  export interface ObjectStorageList {
19
- template?: ResLink;
20
19
  arguments?: BackendComponentFunctionCallArgs | null;
20
+ template: ResLink;
21
21
  }
22
22
  export interface ObjectStorageDelete {
23
- template?: ResLink;
24
- uuid?: string;
25
23
  arguments?: BackendComponentFunctionCallArgs | null;
24
+ template: ResLink;
25
+ uuid: string;
26
26
  }
27
27
  export interface ObjectStorageUploadResponse {
28
- type?: ObjectStorageUploadUrlType;
29
- url?: string;
28
+ type: ObjectStorageUploadUrlType;
29
+ url: string;
30
30
  }
31
31
  export interface ObjectStorageDownloadResponse {
32
- url?: string;
32
+ url: string;
33
33
  }
34
34
  export interface ObjectStorageObjectMeta {
35
- uuid?: string;
36
- size?: number;
37
35
  agent?: ResLink | null;
38
36
  asset?: ResLink | null;
39
- tags?: ObjectStorageTags;
37
+ size: number;
38
+ tags: ObjectStorageTags;
39
+ uuid: string;
40
40
  }
@@ -3,6 +3,8 @@ import type { PageComponentTemplateCardSettings, PageComponentTemplateSheetSetti
3
3
  import type { PageComponentTemplateVersion } from './page-component-template-version';
4
4
  import type { ResLink } from './res-link';
5
5
  export interface PageComponentTemplate {
6
+ /** @deprecated */
7
+ author?: string | null;
6
8
  backendComponent?: ResLink | null;
7
9
  /** @deprecated Moved to PageComponentTemplateManifest */
8
10
  cardSettings?: PageComponentTemplateCardSettings | null;
@@ -13,7 +15,12 @@ export interface PageComponentTemplate {
13
15
  /** Reference to the 'draft' version of this template */
14
16
  draft?: ResLink | null;
15
17
  intent?: PageComponentTemplateIntent[];
18
+ /** @deprecated */
19
+ inputs?: string | null;
20
+ /** @deprecated */
21
+ licence?: string | null;
16
22
  name?: string;
23
+ private?: boolean;
17
24
  publicId: string;
18
25
  /** Reference to the 'published' version of this template */
19
26
  published?: ResLink | null;
@@ -21,5 +28,7 @@ export interface PageComponentTemplate {
21
28
  sheetSettings?: PageComponentTemplateSheetSettings | null;
22
29
  static?: boolean;
23
30
  url?: string | null;
31
+ /** @deprecated */
32
+ version?: string | null;
24
33
  }
25
34
  export type PageComponentTemplateIntent = 'asset-configuration';
@@ -3,22 +3,12 @@ import type { PagePage } from './page-page';
3
3
  import type { ResLink } from './res-link';
4
4
  export interface PageComponent {
5
5
  boundVersion?: PageComponentTemplateVersion | null;
6
- /** @deprecated Switch to dimensions! */
7
- cols?: number;
8
6
  dimensions?: PageComponentDimensionsUnion;
9
7
  inputs?: string;
10
- /** @deprecated Switch to dimensions! */
11
- left?: number;
12
- /** @deprecated Switch to dimensions! */
13
- mobileHeight?: number | null;
14
8
  pagePage?: PagePage | null;
15
9
  pageVersion?: ResLink;
16
10
  publicId: string;
17
- /** @deprecated Switch to dimensions! */
18
- rows?: number;
19
11
  template?: ResLink | null;
20
- /** @deprecated Switch to dimensions! */
21
- top?: number;
22
12
  }
23
13
  export interface PageComponentDimensionsSheet {
24
14
  cols?: number;
@@ -4,5 +4,5 @@ export interface PlatformServer {
4
4
  name?: string;
5
5
  publicId: string;
6
6
  type?: string;
7
- vpnRange?: string;
7
+ vpnRange?: string | null;
8
8
  }
@@ -1,5 +1,4 @@
1
1
  import type { ResLink } from './res-link';
2
- import type { Sector } from './sector';
3
2
  export interface PolicyLanguage {
4
3
  body?: string;
5
4
  languageCode?: string;
@@ -8,17 +7,15 @@ export interface PolicyLanguage {
8
7
  updateSummary?: string | null;
9
8
  }
10
9
  export type PolicyType = 'privacystatement' | 'termsofuse';
11
- export interface PolicyBase {
10
+ interface PolicyBase {
12
11
  company?: ResLink | null;
13
- createdOn?: string;
14
- downloadUrl?: string;
15
- latest?: boolean;
12
+ downloadUrl?: string | null;
13
+ latest?: boolean | null;
16
14
  languages?: PolicyLanguage[];
17
15
  publicId: string;
18
16
  publishedOn?: string | null;
19
- sector?: Sector;
20
17
  type?: PolicyType;
21
- version?: string;
18
+ version?: string | null;
22
19
  }
23
20
  export interface TermsOfUsePolicy extends PolicyBase {
24
21
  }
@@ -30,3 +27,4 @@ export interface AcceptedTermsOfUsePolicy {
30
27
  policy?: TermsOfUsePolicy;
31
28
  publicId: string;
32
29
  }
30
+ export {};
@@ -1,17 +1,16 @@
1
+ import type { ResLink } from './res-link';
1
2
  import type { SsoAuthentication } from './sso-authentication';
2
3
  interface RegistrationBaseCreate {
3
4
  companyName: string;
4
5
  language?: string;
5
6
  localisation?: string;
6
- termsOfUsePolicy: {
7
- publicId: string;
8
- } | null;
7
+ termsOfUsePolicy: ResLink | null;
9
8
  timeZone?: string;
10
9
  }
11
10
  export interface MyRegistration {
12
11
  companyName?: string;
13
12
  emailAddress?: string;
14
- language?: string;
13
+ language?: string | null;
15
14
  name?: string;
16
15
  publicId: string;
17
16
  }
@@ -1,6 +1,6 @@
1
1
  import type { PlatformServer } from './platform-server';
2
- export interface RscServer extends PlatformServer {
3
- entryPoint?: string;
2
+ type NetworkLayer = 'tap' | 'tun';
3
+ export interface RscServer extends Omit<PlatformServer, 'type'> {
4
4
  supportedLayers?: NetworkLayer[];
5
5
  }
6
- export type NetworkLayer = 'tap' | 'tun';
6
+ export {};
@@ -1,7 +1,7 @@
1
1
  import type { ResLink } from './res-link';
2
2
  export interface SsoIdentityProvider {
3
3
  company?: ResLink | null;
4
- logo?: string;
4
+ logo?: string | null;
5
5
  name?: string;
6
6
  publicId: string;
7
7
  }
@@ -1,10 +1,9 @@
1
+ /** @check userpushdevice:UserPushDevice&UserPushDeviceActivate */
1
2
  export interface UserPushDevice {
2
3
  createdOn?: string;
3
4
  deactivated?: boolean;
4
5
  deviceId: string;
5
- name?: string;
6
6
  publicId: string;
7
7
  token?: string;
8
- user?: string;
9
8
  userAgent?: string;
10
9
  }
@@ -1,7 +1,9 @@
1
1
  import type { EmailAddressChange } from './email-address-change';
2
2
  import type { Invite } from './invite';
3
3
  import type { OtpAuth } from './otp-auth';
4
- import type { AcceptedTermsOfUsePolicy, TermsOfUsePolicy } from './policy';
4
+ import type { AcceptedTermsOfUsePolicy } from './policy';
5
+ import type { ResLink } from './res-link';
6
+ import type { SsoAuthentication } from './sso-authentication';
5
7
  import type { UserMembership } from './user-membership';
6
8
  export interface User {
7
9
  custom?: {};
@@ -59,9 +61,11 @@ export interface MyUser {
59
61
  /** For example 2019-01-01T12:00:00Z */
60
62
  registeredOn?: string;
61
63
  support?: boolean;
62
- termsOfUsePolicy?: TermsOfUsePolicy | null;
63
- /** For example 2019-01-01T12:00:00Z */
64
- termsOfUsePolicyAcceptedOn?: string | null;
65
64
  timeZone?: string | null;
66
65
  unreadMessagesCount?: number;
67
66
  }
67
+ export interface MyUserCreate extends Pick<MyUser, 'name' | 'language' | 'localisation' | 'timeZone'> {
68
+ password?: string;
69
+ ssoAuthentication?: SsoAuthentication;
70
+ termsOfUsePolicy?: ResLink | null;
71
+ }
@@ -7,6 +7,7 @@ interface ResultDataMap {
7
7
  Agent: ResourceData.Agent;
8
8
  Asset: ResourceData.Asset;
9
9
  AssetAppConfig: ResourceData.AssetAppConfig;
10
+ AssetAppConfigList: ResourceData.AssetAppConfig[];
10
11
  Branding: ResourceData.Branding;
11
12
  CustomPropertyList: ResourceData.CustomProperty[];
12
13
  GroupList: ResourceData.Group[];
@@ -1,5 +1,5 @@
1
1
  /** @module ResourceDataQuery */
2
- export type ResourceDataQuerySelector = 'Agent' | 'Asset' | 'AssetAppConfig' | 'Branding' | 'CustomPropertyList' | 'GroupList' | 'MyCompany' | 'MyUser' | 'PagePage' | 'PageVersion' | 'UserList';
2
+ export type ResourceDataQuerySelector = 'Agent' | 'Asset' | 'AssetAppConfig' | 'AssetAppConfigList' | 'Branding' | 'CustomPropertyList' | 'GroupList' | 'MyCompany' | 'MyUser' | 'PagePage' | 'PageVersion' | 'UserList';
3
3
  export interface ResourceDataQuery<T = ResourceDataQuerySelector> {
4
4
  /**
5
5
  * String reference unique to the query call made by the client
@@ -47,14 +47,14 @@ interface AgentResourceData {
47
47
  permissions?: string[];
48
48
  publicId: string;
49
49
  rateLimiting?: {
50
- configMqttCommandCounter?: number;
51
- configMqttCommandLastHit?: string;
50
+ configMqttCommandCounter?: number | null;
51
+ configMqttCommandLastHit?: string | null;
52
52
  configMqttCommandLimit?: 'soft' | 'hard' | 'lock' | null;
53
- configMqttDataCounter?: number;
54
- configMqttDataLastHit?: string;
53
+ configMqttDataCounter?: number | null;
54
+ configMqttDataLastHit?: string | null;
55
55
  configMqttDataLimit?: 'soft' | 'hard' | 'lock' | null;
56
- configOpenvpnCounter?: number;
57
- configOpenvpnLastHit?: string;
56
+ configOpenvpnCounter?: number | null;
57
+ configOpenvpnLastHit?: string | null;
58
58
  configOpenvpnLimit?: 'soft' | 'hard' | 'lock' | null;
59
59
  };
60
60
  serialNumber?: string | null;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ixon-cdk/types",
3
- "version": "1.4.0-next.2",
3
+ "version": "1.4.0",
4
4
  "description": "",
5
5
  "main": "./dist/component-devkit/src/types/src/index.d.ts",
6
6
  "author": "",
@@ -1,6 +0,0 @@
1
- export interface AgentDataMonitor {
2
- darkTheme?: boolean;
3
- layout?: object;
4
- name?: string;
5
- publicId: string;
6
- }
@@ -1,8 +0,0 @@
1
- export interface AgentDataReport {
2
- darkTheme?: boolean;
3
- defaultTimePeriod?: string;
4
- layout?: object;
5
- name?: string;
6
- publicId: string;
7
- version?: string;
8
- }