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

package/dist/types/ixapi/resources/access-token.d.ts

@@ -12,6 +12,7 @@ export interface AccessToken {
     expiresOn?: string;
     geoLocation?: GeoLocation | null;
     publicId: string;
+    scope?: AccessTokenScopesUnion;
 }
 export interface AccessTokenCreate {
     /** In seconds. */
@@ -27,3 +28,24 @@ export interface AccessTokenCreateResponse {
     secretId: string;
     user: MyUser;
 }
+export interface AccessTokenScopeUnrestricted {
+    type?: 'unrestricted';
+}
+export interface AccessTokenScopeAllowList {
+    rels?: RelAffect[];
+    type?: 'allow';
+}
+export interface AccessTokenScopeDenyList {
+    rels?: RelAffect[];
+    type?: 'deny';
+}
+export type AccessTokenScopesUnion = AccessTokenScopeAllowList | AccessTokenScopeDenyList | AccessTokenScopeUnrestricted;
+interface RelAffect {
+    rel?: string;
+    get?: boolean | null;
+    post?: boolean | null;
+    patch?: boolean | null;
+    delete?: boolean | null;
+    put?: boolean | null;
+}
+export {};

package/dist/types/ixapi/resources/agent-config.d.ts

@@ -12,6 +12,7 @@ export interface AgentConfig {
     configsAreDifferent?: boolean;
     differentConfigs?: boolean;
     differentStewardConfigs?: boolean;
+    differentWanConfigs?: boolean;
     /** NOTE: This public ID is identical to the public ID of its linked agent. */
     publicId: string;
     routerAdditionalSubnets?: AgentRouterAdditionalSubnet[];

package/dist/types/ixapi/resources/agent-data-alarm-occurrence.d.ts

@@ -0,0 +1,19 @@
+import type { ResLink } from './res-link';
+export interface AgentDataAlarmOccurrence {
+    acknowledged?: boolean;
+    acknowledgedBy?: ResLink | null;
+    /** I.e. "2019-01-01T12:00:00Z" */
+    acknowledgedOn: string | null;
+    alarm?: ResLink;
+    comment?: string | null;
+    /** I.e. "2019-01-01T12:00:00Z" */
+    occurredOn?: string;
+    publicId: string;
+    /** I.e. "2019-01-01T12:00:00Z" */
+    rateLimitTill?: string | null;
+    /** I.e. "2019-01-01T12:00:00Z" */
+    rtnOn?: string | null;
+    silenced?: boolean;
+    /** I.e. "2019-01-01T12:00:00Z" */
+    stillActiveOn?: string | null;
+}

package/dist/types/ixapi/resources/agent-data-alarm.d.ts

@@ -1,5 +1,4 @@
 import type { ResLink } from './res-link';
-import type { User } from './user';
 export interface AgentDataAlarm {
     agent?: ResLink;
     audience?: ResLink | null;
@@ -24,21 +23,3 @@ export interface AgentDataAlarm {
     source?: ResLink;
     type?: 'unary' | 'boolean' | 'error_bits' | 'threshold' | 'rate_of_change' | 'bit_pattern';
 }
-export interface AgentDataAlarmOcc {
-    publicId: string;
-    alarm?: AgentDataAlarm;
-    occuredOn?: string;
-    acknowledged?: boolean | null;
-    acknowledgedOn?: string | null;
-    acknowledgedBy?: User | null;
-    comment?: string | null;
-    silenced?: boolean;
-    rtnOn?: string | null;
-    annunciations?: AgentDataAlarmOccAnn[];
-    stillActiveOn?: string | null;
-    rateLimitTill?: string | null;
-}
-export interface AgentDataAlarmOccAnn {
-    user?: User;
-    announcedOn?: string;
-}

package/dist/types/ixapi/resources/agent-data-tag.d.ts

@@ -1,22 +1,21 @@
-import type { AgentDataCondition } from './agent-data-condition';
 import type { AgentDataVariable } from './agent-data-variable';
 import type { ResLink } from './res-link';
 export interface AgentDataTag {
     agent?: ResLink;
     aggregators?: string[];
     device?: ResLink;
-    downsamplingInterval?: boolean;
-    /** When set to null will revert to "last", "shortest" and "longest". Only applicable to strings */
-    edgeAggregator?: 'min' | 'max' | 'shortest' | 'longest' | 'mean' | 'last' | 'increase' | null;
+    downsamplingInterval?: string | null;
+    /** When set to null will revert to "last", "shortest" and "longest" only applicable to strings */
+    edgeAggregator?: 'any' | 'avg' | 'min' | 'max' | 'first' | 'last' | 'shortest' | 'longest' | 'increase' | null;
     logEvent?: 'interval' | 'change' | 'trigger';
     loggingInterval?: string;
-    logTrigger?: AgentDataCondition | null;
+    logTrigger?: ResLink | null;
     name?: string;
+    onChangeExpiry?: string | null;
     publicId: string;
     retentionPolicy?: string;
     slug?: string | null;
     source?: ResLink;
-    onChangeExpiry?: string | null;
     tagId?: number;
     variable?: AgentDataVariable;
 }

package/dist/types/ixapi/resources/agent-data-variable.d.ts

@@ -2,6 +2,7 @@ import type { ResLink } from './res-link';
 export interface AgentDataVariable {
     address?: string;
     agent?: ResLink;
+    custom?: {};
     device?: ResLink;
     extraData?: any;
     factor?: number | null;

package/dist/types/ixapi/resources/agent-router-one-to-one-nat-rule.d.ts

@@ -0,0 +1,12 @@
+import type { ResLink } from './res-link';
+export interface AgentRouterOneToOneNatRule {
+    agent?: ResLink;
+    description?: string | null;
+    destinationIpAddress?: string | null;
+    port?: number | null;
+    protocol?: string;
+    publicId: string;
+    sourceIpAddress?: string | null;
+    type?: 'vpn' | 'wlan' | 'wan';
+    virtualIpAddress?: string | null;
+}

package/dist/types/ixapi/resources/agent-server.d.ts

@@ -2,10 +2,11 @@ import type { ResLink } from './res-link';
 export interface AgentServer {
     agent?: ResLink;
     audience?: ResLink | null;
-    connectionQuality?: 'high' | 'normal' | 'low' | null;
+    connectionQuality?: ConnectionQuality | null;
     custom?: {};
     device?: ResLink;
-    httpAuthenticationType?: 'ntlm' | 'basic' | 'digest' | null;
+    hasPassword?: boolean;
+    httpAuthenticationType?: HttpAuthenticationType | null;
     landingPage?: string;
     name?: string;
     password?: string | null;
@@ -13,10 +14,8 @@ export interface AgentServer {
     publicId: string;
     readOnly?: boolean | null;
     serviceGroup?: string | null;
-    template?: {
-        publicId?: string;
-    };
-    type?: 'http' | 'rdp' | 'vnc' | 'websocket';
+    template?: AgentServerTemplate;
+    type?: AgentServerType;
     username?: string | null;
     useSsl?: boolean;
     /** default: true */
@@ -24,3 +23,26 @@ export interface AgentServer {
     vncEncoding?: string | null;
     vncRightClickOnTouchHold?: boolean;
 }
+export interface AgentServerTemplate {
+    audience?: ResLink;
+    connectionQuality?: ConnectionQuality | null;
+    custom?: {};
+    hasPassword?: boolean;
+    httpAuthenticationType?: HttpAuthenticationType | null;
+    landingPage?: string;
+    name?: string;
+    password?: string | null;
+    port?: number;
+    publicId: string;
+    readOnly?: boolean | null;
+    type?: AgentServerType;
+    username?: string | null;
+    useSsl?: boolean;
+    visibleInMobileApp?: boolean;
+    vncEncoding?: string | null;
+    vncRightClickOnTouchHold?: boolean;
+}
+type AgentServerType = 'http' | 'rdp' | 'vnc' | 'websocket';
+type ConnectionQuality = 'high' | 'normal' | 'low';
+type HttpAuthenticationType = 'ntlm' | 'basic' | 'digest';
+export {};

package/dist/types/ixapi/resources/agent-type.d.ts

@@ -7,12 +7,14 @@ export interface AgentType {
     allowTemplating?: boolean;
     configPush?: boolean;
     configFileFormat?: number;
+    custom?: {};
     customServers?: boolean;
     deviceIdFormat?: string;
     httpProxyPort?: number;
     latestFirmwareFile?: any;
     name?: string;
     offlineConfiguration?: boolean;
+    openvpnConfigMultiUse?: boolean;
     publicId: string;
     purchasePrice?: {
         gratis?: boolean;

package/dist/types/ixapi/resources/agent.d.ts

@@ -4,6 +4,8 @@ import type { AgentDevice } from './agent-device';
 import type { AgentMdrServer } from './agent-mdr-server';
 import type { AgentMembership } from './agent-membership';
 import type { AgentNetworkValue } from './agent-network-value';
+import type { AgentRouterLanWanAccessRule } from './agent-router-lan-wan-access-rule';
+import type { AgentRouterVpnAccessRule } from './agent-router-vpn-access-rule';
 import type { AgentServer } from './agent-server';
 import type { AgentTemplate } from './agent-template';
 import type { AgentType } from './agent-type';
@@ -17,14 +19,13 @@ import type { GeoLocation, Location } from './location';
 import type { LoggingApp } from './logging-app';
 import type { PageLink } from './page-link';
 import type { ResLink } from './res-link';
-import type { RscServer } from './rsc-server';
 import type { User } from './user';
 import type { VpnProtocol } from './vpn-protocol';
-import type { AgentRouterVpnAccessRule } from './agent-router-vpn-access-rule';
+import type { VpnSession } from './vpn-session';
 export interface Agent extends AgentLike {
     activationLicence?: Licence | null;
     activeStatus?: 'active' | 'inactive';
-    activeVpnSession?: AgentVpnSession | null;
+    activeVpnSession?: VpnSession | null;
     alarmingApp?: AlarmingApp;
     assets?: ResLink[];
     company?: ResLink;
@@ -68,6 +69,7 @@ export interface AgentLike {
     dataSources?: AgentDataSource[];
     description?: string | null;
     devices?: AgentDevice[];
+    lanWanAccessRules?: AgentRouterLanWanAccessRule[];
     name?: string;
     pageLinks?: PageLink[];
     publicId: string;
@@ -90,20 +92,37 @@ export interface AgentLocalIp {
     gateways?: string[];
 }
 export interface AgentUserAgent {
+    alarming?: boolean;
     appName?: string;
     appVersion?: string | null;
     configName?: string | null;
     configVersion?: string | null;
+    dataMonitoring?: boolean;
     firmwareVersion?: string | null;
     hardware?: string | null;
     hardwareCode?: string | null;
     hardwareVersion?: string | null;
     libixagentVersion?: string;
     libixloggerVersion?: string;
+    logOnTrigger?: boolean;
+    multiWan?: boolean;
     opensslVersion?: string | null;
+    openvpnOccEnabled?: boolean;
+    openvpnOpensslVersion?: string | null;
+    openvpnVersion?: string | null;
     osName?: string | null;
     osVersion?: string | null;
+    packageName?: string | null;
+    packageVersion?: string | null;
     publicId: string;
+    remoteFirmwareUpgrade?: boolean;
+    staticMapping?: boolean;
+    stewardConfigPush?: boolean;
+    value?: string | null;
+    wanInterfaceCell0?: CellularType;
+    wanInterfaceEth0?: boolean;
+    wanInterfaceWifi0?: boolean;
+    wifi?: boolean;
 }
 export interface AgentRateLimiting {
     configMqttCommandCounter?: number;
@@ -123,14 +142,6 @@ export interface AgentRateLimiting {
  * - `"lock"` when it manually locked by R&D and the user unable to retry.
  */
 export type AgentRateLimitingStatus = null | 'soft' | 'hard' | 'lock';
-export interface AgentVpnSession {
-    bytesReceived?: number;
-    bytesSent?: number;
-    duration?: number;
-    startedOn?: number;
-    rscServer?: RscServer | null;
-    vpnAddress?: string;
-}
 export interface AgentFromTemplate {
     publicId: string;
     template: AgentTemplate;
@@ -150,3 +161,5 @@ export interface ShellAgentCreate {
     groups?: ResLink[];
     template?: ResLink | null;
 }
+type CellularType = '3G' | '4G' | 'neither';
+export {};

package/dist/types/ixapi/resources/audience.d.ts

@@ -1,4 +1,5 @@
 export interface Audience {
+    custom?: {};
     default?: boolean;
     description?: string | null;
     name?: string;

package/dist/types/ixapi/resources/component-input.d.ts

@@ -1,4 +1,4 @@
-type ComponentInputType = 'AggregatedMetric' | 'Checkbox' | 'Color' | 'File' | 'Group' | 'Image' | 'Icon' | 'MaterialIcon' | 'LiveMetric' | 'List' | 'Number' | 'RawMetric' | 'Selection' | 'String' | 'Text';
+type ComponentInputType = 'AggregatedMetric' | 'Checkbox' | 'Color' | 'Date' | 'File' | 'Group' | 'Image' | 'Icon' | 'MaterialIcon' | 'LiveMetric' | 'List' | 'Number' | 'RawMetric' | 'Selection' | 'String' | 'Text';
 export interface ComponentInputSummary {
     label?: string;
     colorField?: string;
@@ -7,6 +7,7 @@ export interface ComponentInput {
     children?: ComponentInput[];
     defaultValue?: any;
     description?: string;
+    disabled?: boolean;
     hint?: string;
     itemType?: ComponentInput;
     key: string;

package/dist/types/ixapi/resources/index.d.ts

@@ -4,6 +4,7 @@ export * from './agent';
 export * from './agent-activate';
 export * from './agent-config';
 export * from './agent-data-alarm';
+export * from './agent-data-alarm-occurrence';
 export * from './agent-data-alarming-app';
 export * from './agent-data-condition';
 export * from './agent-data-logging-app';
@@ -21,6 +22,7 @@ export * from './agent-queue-report';
 export * from './agent-registration-profile';
 export * from './agent-registration-profile-membership';
 export * from './agent-router-lan-wan-access-rule';
+export * from './agent-router-one-to-one-nat-rule';
 export * from './agent-router-vpn-access-rule';
 export * from './agent-router-vpn-config';
 export * from './agent-server';
@@ -100,6 +102,7 @@ export * from './user';
 export * from './user-membership';
 export * from './user-push-device';
 export * from './vpn-protocol';
+export * from './vpn-session';
 export * from './vpn-usage';
 export * from './web-access';
 export * from './webhook-subscription';

package/dist/types/ixapi/resources/licence.d.ts

@@ -3,9 +3,12 @@ import type { AgentType } from './agent-type';
 import type { LicenceBundle } from './licence-bundle';
 import type { LicenceType } from './licence-type';
 import type { ResLink } from './res-link';
+interface AgentBase extends Pick<Agent, 'custom' | 'deviceId' | 'geoLocation' | 'location' | 'name' | 'publicId'> {
+    type?: ResLink;
+}
 export interface Licence {
     activated?: boolean;
-    agent?: Agent | null;
+    agent?: AgentBase | null;
     agentType?: AgentType | null;
     bundle?: LicenceBundle | null;
     expiresOn?: string | null;
@@ -25,3 +28,4 @@ export interface LicenceExtend {
     licence?: ResLink;
     publicId: string;
 }
+export {};

package/dist/types/ixapi/resources/page.d.ts

@@ -13,5 +13,7 @@ export interface Page {
     publicId: string;
     published?: PageVersion | null;
     static?: boolean;
+    orientation?: PageOrientation | null;
 }
+export type PageOrientation = 'portrait' | 'landscape';
 export type PageApplicationType = 'sheet' | 'card' | 'report';

package/dist/types/ixapi/resources/user.d.ts

@@ -4,6 +4,7 @@ import type { OtpAuth } from './otp-auth';
 import type { TermsOfUsePolicy } from './policy';
 import type { UserMembership } from './user-membership';
 export interface User {
+    custom?: {};
     /** @changeNotification taint */
     emailAddress?: string;
     /** For example 2019-01-01T12:00:00Z */

package/dist/types/ixapi/resources/vpn-session.d.ts

@@ -0,0 +1,8 @@
+import type { RscServer } from './rsc-server';
+export interface VpnSession {
+    closed?: boolean;
+    rscServer?: RscServer | null;
+    sessionName?: string;
+    startedOn?: string;
+    vpnAddress?: string | null;
+}

package/dist/types/resource-data/index.d.ts

@@ -1,4 +1,5 @@
 export * from './resource-data-client';
 export * from './resource-data-query';
 export * from './resource-data-result';
+export * from './resource-data-update';
 export * from './resource-data';

package/dist/types/resource-data/resource-data-client.d.ts

@@ -2,9 +2,11 @@
 import type { ResourceDataQuery, ResourceDataQuerySelector, ResourceDataTemplateQuery } from './resource-data-query';
 import type { ResourceDataResult } from './resource-data-result';
 import type { ResourceData } from './resource-data';
+import type { ResourceDataUpdate, ResourceDataUpdateSelector } from './resource-data-update';
 interface ResultDataMap {
     Agent: ResourceData.Agent;
     Asset: ResourceData.Asset;
+    AssetAppConfig: ResourceData.AssetAppConfig;
     Branding: ResourceData.Branding;
     CustomPropertyList: ResourceData.CustomProperty[];
     GroupList: ResourceData.Group[];
@@ -59,5 +61,9 @@ export interface ResourceDataClient {
      * @returns {function()} Returns a deregistration function for the listener.
      */
     render(templates: ResourceDataTemplateQuery[], listener: (results: string[]) => void): () => void;
+    /**
+     * @returns {Promise} Returns a promise that resolves when the update succeeds.
+     */
+    update<T extends ResourceDataUpdateSelector>(update: ResourceDataUpdate<T>): Promise<void>;
 }
 export {};

package/dist/types/resource-data/resource-data-query.d.ts

@@ -1,5 +1,5 @@
 /** @module ResourceDataQuery */
-export type ResourceDataQuerySelector = 'Agent' | 'Asset' | 'Branding' | 'CustomPropertyList' | 'GroupList' | 'MyCompany' | 'MyUser' | 'PagePage' | 'PageVersion' | 'UserList';
+export type ResourceDataQuerySelector = 'Agent' | 'Asset' | 'AssetAppConfig' | 'Branding' | 'CustomPropertyList' | 'GroupList' | 'MyCompany' | 'MyUser' | 'PagePage' | 'PageVersion' | 'UserList';
 export interface ResourceDataQuery<T = ResourceDataQuerySelector> {
     /**
      * String reference unique to the query call made by the client

package/dist/types/resource-data/resource-data-update.d.ts

@@ -0,0 +1,11 @@
+import type { ResourceData } from './resource-data';
+type ResourceDataUpdateDataMap = {
+    AssetAppConfig: Partial<ResourceData.AssetAppConfig>;
+};
+export type ResourceDataUpdateSelector = keyof ResourceDataUpdateDataMap;
+export type ResourceDataUpdate<T extends ResourceDataUpdateSelector = ResourceDataUpdateSelector> = {
+    _clientRef?: string;
+    selector: T;
+    data: ResourceDataUpdateDataMap[T];
+};
+export {};

package/dist/types/resource-data/resource-data.d.ts

@@ -4,7 +4,7 @@ interface AgentResourceData {
             name?: string;
             publicId: string;
         } | null;
-        vpnAddress?: string;
+        vpnAddress?: string | null;
     } | null;
     connectedUsers?: {
         name?: string;
@@ -88,6 +88,11 @@ interface AssetResourceData {
         publicId: string;
     };
 }
+interface AssetAppConfigResourceData {
+    publicId: string;
+    stateValues?: object | null;
+    values?: object | null;
+}
 interface BrandingResourceData {
     logo?: string | null;
     publicId: string;
@@ -144,6 +149,7 @@ interface UserResourceData {
 export declare namespace ResourceData {
     type Agent = AgentResourceData;
     type Asset = AssetResourceData;
+    type AssetAppConfig = AssetAppConfigResourceData;
     type Branding = BrandingResourceData;
     type CustomProperty = CustomPropertyResourceData;
     type Group = GroupResourceData;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ixon-cdk/types",
-  "version": "1.3.0-next.2",
+  "version": "1.4.0-next.0",
   "description": "",
   "main": "./dist/component-devkit/src/types/src/index.d.ts",
   "author": "",