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

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

@@ -0,0 +1,152 @@
+import type { AgentConfig } from './agent-config';
+import type { AgentDataSource } from './agent-data-source';
+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 { AgentServer } from './agent-server';
+import type { AgentTemplate } from './agent-template';
+import type { AgentType } from './agent-type';
+import type { AlarmingApp } from './alarming-app';
+import type { Audience } from './audience';
+import type { DemoDevice } from './demo-device';
+import type { Invite } from './invite';
+import type { Licence } from './licence';
+import type { LsiServer } from './lsi-server';
+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';
+export interface Agent extends AgentLike {
+    activationLicence?: Licence | null;
+    activeStatus?: 'active' | 'inactive';
+    activeVpnSession?: AgentVpnSession | null;
+    alarmingApp?: AlarmingApp;
+    assets?: ResLink[];
+    company?: ResLink;
+    connectedUsers?: User[];
+    demoDevice?: DemoDevice | null;
+    deviceId?: string | null;
+    fixedVpnAddress?: string | null;
+    geoLocation?: GeoLocation | null;
+    invitesWithAccess?: Invite[];
+    lastSeenAgentUserAgent?: AgentUserAgent | null;
+    location?: Location | null;
+    loggingApp?: LoggingApp;
+    loggingMdrServer?: AgentMdrServer | null;
+    loggingMqttChangedOn?: string | null;
+    lsiServer?: LsiServer | null;
+    macAddress?: string | null;
+    mdrServer?: AgentMdrServer | null;
+    memberships?: AgentMembership[];
+    mqttChangedOn?: string | null;
+    networkReportedOn?: string | null;
+    networkValues?: AgentNetworkValue[] | null;
+    pendingRegistration?: boolean | null;
+    /** default: false */
+    preferLocationOverGeoip?: boolean;
+    pullCodeGeneratedOn?: string | null;
+    rateLimiting?: AgentRateLimiting;
+    replaceMacAddress?: string | null;
+    replaceRegistration?: boolean;
+    reRegistration?: boolean;
+    serialNumber?: string | null;
+    timeZone?: string | null;
+    valuesPerHour?: number;
+}
+export interface AgentLike {
+    card?: ResLink | null;
+    config?: AgentConfig | null;
+    custom?: {
+        [key: string]: any;
+    };
+    dataAudience?: Audience | null;
+    dataSources?: AgentDataSource[];
+    description?: string | null;
+    devices?: AgentDevice[];
+    name?: string;
+    pageLinks?: PageLink[];
+    publicId: string;
+    servers?: AgentServer[];
+    type?: AgentType;
+    /** default: false */
+    useStunnel?: boolean;
+    preferLocationOverGeoip?: boolean;
+    vpnAccessRules?: AgentRouterVpnAccessRule[];
+    vpnAudience?: Audience | null;
+    /** default: 'tcp' */
+    vpnProtocol?: VpnProtocol;
+    /** default: false */
+    vpnVisibleInMobileApp?: boolean;
+}
+export interface AgentLocalIp {
+    reportedOn?: string;
+    dnsServers?: string[];
+    addresses?: string[];
+    gateways?: string[];
+}
+export interface AgentUserAgent {
+    appName?: string;
+    appVersion?: string | null;
+    configName?: string | null;
+    configVersion?: string | null;
+    firmwareVersion?: string | null;
+    hardware?: string | null;
+    hardwareCode?: string | null;
+    hardwareVersion?: string | null;
+    libixagentVersion?: string;
+    libixloggerVersion?: string;
+    opensslVersion?: string | null;
+    osName?: string | null;
+    osVersion?: string | null;
+    publicId: string;
+}
+export interface AgentRateLimiting {
+    configMqttCommandCounter?: number;
+    configMqttCommandLastHit?: string;
+    configMqttCommandLimit?: AgentRateLimitingStatus;
+    configMqttDataCounter?: number;
+    configMqttDataLastHit?: string;
+    configMqttDataLimit?: AgentRateLimitingStatus;
+    configOpenvpnCounter?: number;
+    configOpenvpnLastHit?: string;
+    configOpenvpnLimit?: AgentRateLimitingStatus;
+}
+/**
+ * - `null` when ratelimiting is not applicable.
+ * - `"soft"` when it is periodically retrying.
+ * - `"hard"` when a user must manually force a retry.
+ * - `"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;
+    importLanSettings: boolean;
+    importFirewallSettings: boolean;
+    importVpnSettings: boolean;
+    importPageLinks: boolean;
+    importServices: boolean;
+    importDataSettings: boolean;
+    importCustomProperties: boolean;
+}
+export interface ShellAgentCreate {
+    registrationCode: string;
+    name?: string | null;
+    couponCode?: string | null;
+    licence?: ResLink | null;
+    groups?: ResLink[];
+    template?: ResLink | null;
+}

package/dist/types/ixapi/resources/alarming-app.d.ts

@@ -0,0 +1,5 @@
+import type { Licence } from './licence';
+export interface AlarmingApp {
+    enabled?: boolean;
+    licence?: Licence | null;
+}

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

@@ -0,0 +1,4 @@
+export interface AppConfigUpdate {
+    enabled?: boolean;
+    publicId: string;
+}

package/dist/types/ixapi/resources/asset-app-config.d.ts

@@ -0,0 +1,8 @@
+import type { ResLink } from './res-link';
+export interface AssetAppConfig {
+    app?: ResLink;
+    asset?: ResLink;
+    publicId: string;
+    stateValues?: string | null;
+    values?: string | null;
+}

package/dist/types/ixapi/resources/asset-membership.d.ts

@@ -0,0 +1,6 @@
+import type { ResLink } from './res-link';
+export interface AssetMembership {
+    asset?: ResLink;
+    group?: ResLink;
+    publicId: string;
+}

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

@@ -0,0 +1,5 @@
+export interface AssetType {
+    name?: string;
+    order?: number;
+    publicId: string;
+}

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

@@ -0,0 +1,22 @@
+import type { AssetAppConfig } from './asset-app-config';
+import type { AssetMembership } from './asset-membership';
+import type { AssetType } from './asset-type';
+import type { PageLink } from './page-link';
+import type { ResLink } from './res-link';
+export interface Asset {
+    agent?: ResLink | null;
+    appConfigs?: AssetAppConfig[];
+    card?: ResLink;
+    custom?: {
+        [key: string]: any;
+    };
+    description?: string | null;
+    enabled?: boolean;
+    memberships?: AssetMembership[];
+    name?: string;
+    order?: number;
+    pageLinks?: PageLink[];
+    parent?: ResLink | null;
+    publicId: string;
+    resourceVariant?: AssetType;
+}

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

@@ -0,0 +1,6 @@
+export interface Audience {
+    default?: boolean;
+    description?: string | null;
+    name?: string;
+    publicId: string;
+}

package/dist/types/ixapi/resources/audit-log.d.ts

@@ -0,0 +1,20 @@
+export interface AuditLog {
+    action: AuditLogAction;
+    actor: {
+        resource: any;
+        type: string;
+    };
+    after: any[];
+    application?: {
+        name: string;
+    };
+    before: any[];
+    publicId: string;
+    request?: {
+        fromName: string;
+    };
+    target: string;
+    time: string /** I.e. "2019-01-01T12:00:00.000000Z" */;
+    topic: any;
+}
+export type AuditLogAction = 'CREATE' | 'UPDATE' | 'DELETE' | 'TRIGGER';

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

@@ -0,0 +1,5 @@
+export interface AuthToken {
+    expiresOn: string;
+    publicId: string;
+    secretId: string;
+}

package/dist/types/ixapi/resources/backend-component-function.d.ts

@@ -0,0 +1,10 @@
+import type { ResLink } from './res-link';
+export type BackendComponentFunctionCallArgs = Record<string, string | boolean | number>;
+export interface BackendComponentFunctionCall {
+    template?: ResLink;
+    name?: string;
+    arguments?: BackendComponentFunctionCallArgs | null;
+}
+export interface BackendComponentFunctionResult {
+    value?: any;
+}

package/dist/types/ixapi/resources/backend-component-template-config.d.ts

@@ -0,0 +1,10 @@
+import type { ResLink } from './res-link';
+export interface BackendComponentTemplateConfig {
+    allowDraft?: boolean;
+    company?: ResLink;
+    enabled?: boolean;
+    pinnedVersion?: ResLink;
+    publicId: string;
+    template?: ResLink;
+    values?: string | null;
+}

package/dist/types/ixapi/resources/backend-component-template-share.d.ts

@@ -0,0 +1,5 @@
+import type { ResLink } from "./res-link";
+export interface BackendComponentTemplateShare {
+    company: ResLink;
+    template: ResLink;
+}

package/dist/types/ixapi/resources/backend-component-template-version.d.ts

@@ -0,0 +1,16 @@
+import type { ResLink } from './res-link';
+export interface BackendComponentTemplateConfiguredVersion {
+    publicId: string;
+    number?: string;
+}
+export interface BackendComponentTemplateVersion {
+    template?: ResLink;
+    publicId: string;
+    number?: string;
+    publishedOn?: string;
+    createdOn?: string;
+}
+export interface BackendComponentTemplateVersionUpdate {
+    publicId: string;
+    published?: boolean;
+}

package/dist/types/ixapi/resources/backend-component-template.d.ts

@@ -0,0 +1,11 @@
+import type { CompanyReference } from './company';
+import type { ResLink } from './res-link';
+export interface BackendComponentTemplate {
+    company?: CompanyReference | null;
+    description?: string | null;
+    draft?: ResLink | null;
+    name?: string;
+    ownerName?: string;
+    publicId: string;
+    published?: ResLink | null;
+}

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

@@ -0,0 +1,27 @@
+export interface Branding {
+    appleAppStoreLink?: string | null;
+    /** @deprecated */
+    appleTouchIcon?: string | null;
+    custom?: {
+        /** @deprecated */
+        glbAppleMobileWebAppTitle?: string | null;
+        glbBrowserTitle?: string | null;
+    };
+    favicon?: string | null;
+    fqdn?: string | null;
+    googlePlayStoreLink?: string | null;
+    logo?: string | null;
+    name?: string;
+    publicId: string;
+    theme?: BrandingTheme | null;
+}
+export interface BrandingTheme {
+    accentColor?: string;
+    accentTextColor?: string;
+    dark?: boolean;
+    headerColor?: string;
+    headerLineColor?: string;
+    logoHasBackgroundColor?: boolean;
+    primaryColor?: string;
+    primaryTextColor?: string;
+}

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

@@ -0,0 +1,56 @@
+import type { Branding } from './branding';
+import type { Licence } from './licence';
+import type { ResLink } from './res-link';
+export interface Company {
+    branding?: Branding | null;
+    custom?: {};
+    customPrivacyStatement?: 'sector' | 'company' | 'disabled';
+    customTermsOfUse?: 'sector' | 'company' | 'disabled';
+    name?: string;
+    publicId: string;
+}
+export interface MyCompany {
+    alarmingTrialUsed?: boolean;
+    /** @deprecated */
+    assetManagementLicence?: Licence | null;
+    branding?: Branding | null;
+    country?: string | null;
+    custom?: {
+        glbPrtDeviceTableColsDefault?: string | null;
+    };
+    customPrivacyStatement?: 'sector' | 'company' | 'disabled';
+    customTermsOfUse?: 'sector' | 'company' | 'disabled';
+    defaultUserInviteLanguage?: string;
+    licenceModel?: 'legacy' | 'modules';
+    loggingTrialUsed?: boolean;
+    /** @deprecated */
+    mobileAppLicence?: Licence | null;
+    mobileAppLicenceStatus?: 'not-configured' | 'pending' | 'activated' | null;
+    name?: string;
+    /** @deprecated */
+    reportingLicence?: Licence | null;
+    /** @deprecated */
+    premiumLicence?: Licence | null;
+    premiumLicenceStatus?: 'not-configured' | 'pending' | 'activated' | null;
+    publicId: string;
+    requireDedicatedRscServer?: boolean;
+    screensaver?: ResLink | null;
+    shellAgentLimit?: number | null;
+    /** @deprecated */
+    slaLicence?: Licence | null;
+    supportAccessExpiresOn?: string | null /** "2021-01-01T12:00:00Z" */;
+    /** @deprecated */
+    vpnAccessRuleLicence?: Licence | null;
+    /** @deprecated */
+    vpnUsageLicence?: Licence | null;
+}
+export interface LegacyCompany {
+    branding?: {
+        fqdn: null | string;
+    } | null;
+    name?: string;
+    parentCompany?: LegacyCompany | null;
+    publicId: string;
+    starred?: boolean;
+}
+export type CompanyReference = Pick<Company, 'publicId' | 'name'>;

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

@@ -0,0 +1,33 @@
+type ComponentInputType = 'AggregatedMetric' | 'Checkbox' | 'Color' | 'File' | 'Group' | 'Image' | 'Icon' | 'MaterialIcon' | 'LiveMetric' | 'List' | 'Number' | 'RawMetric' | 'Selection' | 'String' | 'Text';
+export interface ComponentInputSummary {
+    label?: string;
+    colorField?: string;
+}
+export interface ComponentInput {
+    children?: ComponentInput[];
+    defaultValue?: any;
+    description?: string;
+    hint?: string;
+    itemType?: ComponentInput;
+    key: string;
+    label?: string;
+    max?: number;
+    maxLength?: number;
+    min?: number;
+    minLength?: number;
+    options?: {
+        label: string;
+        value: any;
+    }[];
+    pattern?: RegExp;
+    placeholder?: string;
+    required?: boolean;
+    step?: number;
+    summary?: ComponentInputSummary;
+    size?: {
+        max: number;
+    };
+    translate?: boolean;
+    type?: ComponentInputType;
+}
+export {};

package/dist/types/ixapi/resources/custom-property.d.ts

@@ -0,0 +1,47 @@
+export interface CustomProperty {
+    description?: string | null;
+    flags?: string[];
+    name?: string;
+    publicId: string;
+    required?: boolean;
+    resourceType?: string;
+    resourceVariant?: string | null;
+    scopeType?: CustomPropertyScopeType;
+    slug?: string;
+    validation?: CustomPropertyValidationUnion;
+}
+export interface CustomPropertyValidationBool {
+    type: 'bool';
+}
+export interface CustomPropertyValidationDateTime {
+    type: 'datetime';
+}
+export interface CustomPropertyValidationEmailAddress {
+    type: 'emailaddress';
+}
+export interface CustomPropertyValidationInt {
+    type: 'int';
+    minValue?: number | null;
+    maxValue?: number | null;
+}
+export interface CustomPropertyValidationLocale {
+    type: 'locale';
+}
+export interface CustomPropertyValidationEnum {
+    type: 'enum';
+    options?: string[];
+}
+export interface CustomPropertyValidationStr {
+    type: 'str';
+    minLength?: number | null;
+    maxLength?: number | null;
+    regex?: string | null;
+}
+export interface CustomPropertyValidationTimeZone {
+    type: 'timezone';
+}
+export interface CustomPropertyValidationUrl {
+    type: 'url';
+}
+export type CustomPropertyScopeType = 'glb' | 'app' | 'sct' | 'usr' | 'com';
+export type CustomPropertyValidationUnion = CustomPropertyValidationBool | CustomPropertyValidationDateTime | CustomPropertyValidationEmailAddress | CustomPropertyValidationEnum | CustomPropertyValidationInt | CustomPropertyValidationLocale | CustomPropertyValidationStr | CustomPropertyValidationTimeZone | CustomPropertyValidationUrl;

package/dist/types/ixapi/resources/data-protocol-applied.d.ts

@@ -0,0 +1,72 @@
+export type EthernetIpCpu = 'compactlogix' | 'controllogix' | 'flexlogix' | 'micro800' | 'micrologix' | 'micrologix800';
+export type McProtocolAuthenticationType = 'none' | 'password';
+export type McProtocolCpu = 'FX5U' | 'IQR' | 'L' | 'Q' | 'QNUCPU';
+export type McProtocolProtocol = 'TCP' | 'UDP';
+export type ModbusFormat = 'ABCD' | 'BADC' | 'CDAB' | 'DCBA';
+export type OpcUaAuthenticationType = 'anonymous' | 'username' | 'certificate';
+export interface DataProtocolAppliedBacnetIp {
+    publicId: 'bacnet-ip';
+}
+export interface DataProtocolAppliedCustom {
+    password?: string | null;
+    publicId: 'custom';
+}
+export interface DataProtocolAppliedEthernetIp {
+    cpu: EthernetIpCpu | null;
+    publicId: 'ethernet-ip';
+    /** only used when cpu in [compactlogix|controllogix|flexlogix]. default is 0 */
+    rack?: number | null;
+    /** only used when cpu in [compactlogix|controllogix|flexlogix]. default is 0 */
+    slot?: number | null;
+}
+export interface DataProtocolAppliedHost {
+    publicId: 'host';
+}
+export interface DataProtocolAppliedMcProtocol {
+    authenticationType?: McProtocolAuthenticationType;
+    /** default is "Q" */
+    cpu?: McProtocolCpu | null;
+    /** default is 120 */
+    maxBlocks?: number;
+    /** default is 960 */
+    maxPoints?: number;
+    /** default is 0 */
+    networkNo?: number;
+    /** defualt is "" */
+    password?: string;
+    /** default is "FF" */
+    pcNo?: string;
+    /** default is "TCP" */
+    protocol?: McProtocolProtocol;
+    publicId: 'mc-protocol';
+    /** default is 500 */
+    reconnectDelay?: number;
+    /** default is "03FF" */
+    requestDestIoNr?: string;
+    /** default is 0 */
+    requestDestModuleStatNr?: number;
+}
+export interface DataProtocolAppliedModbus {
+    /** default is "CDAB" */
+    format?: ModbusFormat;
+    publicId: 'modbus';
+    /** default is 0 */
+    slave?: number;
+    readMode?: 'single_value' | 'consecutive_values' | 'gapped_values' | null;
+}
+export interface DataProtocolAppliedOpcUa {
+    authenticationType?: OpcUaAuthenticationType;
+    password?: string;
+    publicId: 'opc-ua';
+    username?: string;
+}
+export interface DataProtocolAppliedSiemensStep7 {
+    /** default is 0 */
+    pdu?: number;
+    publicId: 'siemens-step7';
+    /** range is 0-7. default is 0 */
+    rack?: number | null;
+    /** range is 0-31. default is 0 */
+    slot?: number | null;
+}
+export type DataProtocolAppliedUnion = DataProtocolAppliedBacnetIp | DataProtocolAppliedCustom | DataProtocolAppliedEthernetIp | DataProtocolAppliedHost | DataProtocolAppliedMcProtocol | DataProtocolAppliedModbus | DataProtocolAppliedOpcUa | DataProtocolAppliedSiemensStep7;

package/dist/types/ixapi/resources/data-protocol.d.ts

@@ -0,0 +1,17 @@
+export interface DataProtocol {
+    publicId: DataProtocolId;
+    name?: string;
+    defaultPort?: number;
+}
+export type DataProtocolId = 'bacnet-ip' | 'custom' | 'ethernet-ip' | 'host' | 'mc-protocol' | 'modbus' | 'opc-ua' | 'siemens-step7';
+export interface DataProtocolType {
+    code?: DataProtocolTypeCode;
+    description?: string;
+    signed?: boolean;
+    width?: string;
+}
+export type DataProtocolTypeCode = 'bool' | 'int' | 'float' | 'str';
+/** @deprecated */
+export interface DataProtocolOptions {
+    cpu?: string;
+}

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

@@ -0,0 +1,43 @@
+import type { ResLink } from './res-link';
+export interface Data {
+    points: DataPoint[];
+    end: string;
+    source: ResLink;
+    start: string;
+    timeZone: string;
+}
+export interface DataPoint {
+    values: {
+        [ref: string]: any;
+    };
+    /** "2019-01-01T12:00:00Z" */
+    time: string;
+}
+export interface DataQuery {
+    /** Defaults to 2 */
+    decimals?: number;
+    /** Defaults to false */
+    extendedBoundary?: boolean;
+    factor?: number;
+    /** Defaults to 5000 */
+    limit?: number;
+    postAggr: string;
+    ref: string;
+    step?: number;
+    offset?: number;
+    operator?: string;
+}
+export interface DataRequest {
+    source: ResLink;
+    start?: string;
+    end?: string;
+    tags: Tag[];
+}
+export type Tag = {
+    preAggr?: string;
+    queries: DataQuery[];
+} & ({
+    id: number;
+} | {
+    slug: string;
+});

package/dist/types/ixapi/resources/demo-device.d.ts

@@ -0,0 +1,8 @@
+import type { AgentType } from './agent-type';
+export interface DemoDevice {
+    agentType?: AgentType;
+    containerId?: string;
+    dmvServer?: any;
+    expiresOn?: string;
+    publicId: string;
+}

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

@@ -0,0 +1,4 @@
+export interface Discovery {
+    rel: string;
+    href: string;
+}

package/dist/types/ixapi/resources/email-address-change.d.ts

@@ -0,0 +1,9 @@
+export interface EmailAddressChange {
+    expiresOn?: string /** "2019-01-01T12:00:00Z" */;
+    newEmailAddress?: string;
+    oldEmailAddress?: string;
+    publicId: string;
+}
+export interface EmailAddressChangeCreate {
+    newEmailAddress: string;
+}

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

@@ -0,0 +1,4 @@
+export interface File {
+    contentType?: string;
+    publicId: string;
+}

package/dist/types/ixapi/resources/group-role.d.ts

@@ -0,0 +1,6 @@
+import type { ResLink } from './res-link';
+import type { Role } from './role';
+export interface GroupRole {
+    group: ResLink | null;
+    roles: Role[];
+}

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

@@ -0,0 +1,6 @@
+export interface GroupType {
+    description?: string | null;
+    name?: string;
+    order?: number;
+    publicId: string;
+}

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

@@ -0,0 +1,12 @@
+import type { GroupType } from './group-type';
+import type { ResLink } from './res-link';
+export interface Group {
+    agent?: ResLink | null;
+    isCompanyGroup?: boolean;
+    managedBy?: ManagedByGroup | null;
+    name?: string | null;
+    publicId: string;
+    type?: GroupType | null;
+}
+export type AgentRegistrationProfileGroup = Pick<Group, 'publicId' | 'name' | 'type'>;
+export type ManagedByGroup = Pick<Group, 'publicId' | 'name' | 'type'>;