@ixon-cdk/types 1.2.0-next.3 → 1.2.0-next.5

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

@@ -1,19 +0,0 @@
-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 {
-    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

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

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

@@ -1,27 +0,0 @@
-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

@@ -1,55 +0,0 @@
-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;
-}

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

@@ -1,47 +0,0 @@
-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

@@ -1,72 +0,0 @@
-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/demo-device.d.ts

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

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

@@ -1,9 +0,0 @@
-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/group-type.d.ts

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

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

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

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

@@ -1,25 +0,0 @@
-import type { Company } from './company';
-import type { ResLink } from './res-link';
-import type { User } from './user';
-import type { UserMembership } from './user-membership';
-export interface Invite {
-    company?: Company | null;
-    emailAddress?: string;
-    expiresOn?: string;
-    language?: string;
-    memberships?: UserMembership[];
-    publicId: string;
-    user?: User;
-}
-export interface InviteCreate {
-    emailAddress: string;
-    groupRoles: InviteCreateGroupRole[];
-    language?: string;
-    managedBy?: ResLink;
-    message?: string;
-}
-export interface InviteCreateGroupRole {
-    expiresOn?: string | null;
-    group: ResLink;
-    role: ResLink;
-}

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

@@ -1,13 +0,0 @@
-import type { Company } from './company';
-import type { Sector } from './sector';
-export type LicenceTypeScope = 'agent' | 'company';
-export type LicenceUsageType = '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' | 'premium-branding' | 'remote-access' | 'reporting' | 'sla' | 'temporary-access' | 'vpn-access-rule' | 'vpn-usage';
-export interface LicenceType {
-    bound?: boolean;
-    company?: Company;
-    companyLimit?: number;
-    publicId: string;
-    scope?: LicenceTypeScope;
-    sector?: Sector;
-    usageType?: LicenceUsageType;
-}

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

@@ -1,25 +0,0 @@
-import type { Agent } from './agent';
-import type { AgentType } from './agent-type';
-import type { LicenceType } from './licence-type';
-import type { ResLink } from './res-link';
-export interface Licence {
-    activated?: boolean;
-    agent?: Agent | null;
-    agentType?: AgentType | null;
-    expiresOn?: string | null;
-    hasAgent?: boolean;
-    isExpired?: boolean;
-    locked?: boolean | null;
-    maxRetentionPolicy?: string | null;
-    publicId: string;
-    serialNumber: string;
-    timeLeft?: number | null;
-    trial?: boolean;
-    type?: LicenceType;
-    value?: string | null;
-}
-export interface LicenceExtend {
-    couponCode?: string;
-    licence?: ResLink;
-    publicId: string;
-}

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

@@ -1,11 +0,0 @@
-export interface Location {
-    latitude?: string;
-    longitude?: string;
-    name?: string | null;
-}
-export interface GeoLocation {
-    city?: string;
-    country?: string | null;
-    latitude?: string;
-    longitude?: string;
-}

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

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

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

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

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

@@ -1,13 +0,0 @@
-export interface OtpAuth {
-    deviceName?: string | null;
-    registeredOn?: string | null;
-    required?: boolean;
-    tokenExpiresOn?: string | null;
-}
-export interface OtpAuthEnableResponse {
-    secret: string;
-}
-export interface OtpAuthVerify {
-    deviceName: string;
-    oneTimePassword: string;
-}

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

@@ -1,44 +0,0 @@
-import type { ResLink } from './res-link';
-export interface PageComponent {
-    boundVersion?: ResLink | null;
-    /** @deprecated Switch to dimensions! */
-    cols?: number;
-    dimensions?: PageComponentDimensionsUnion;
-    inputs?: string;
-    /** @deprecated Switch to dimensions! */
-    left?: number;
-    /** @deprecated Switch to dimensions! */
-    mobileHeight?: number | null;
-    pagePage?: ResLink;
-    pageVersion?: ResLink;
-    publicId: string;
-    /** @deprecated Switch to dimensions! */
-    rows?: number;
-    template?: ResLink | null;
-    /** @deprecated Switch to dimensions! */
-    top?: number;
-}
-export interface PageComponentDimensionsSheet {
-    cols?: number;
-    left?: number;
-    mobileCols?: number | null;
-    mobileHeight?: number | null;
-    mobileLeft?: number | null;
-    mobileOrder?: number | null;
-    rows?: number;
-    top?: number;
-    type?: 'sheet';
-}
-export interface PageComponentDimensionsCard {
-    height?: number;
-    order?: number;
-    type?: 'card';
-}
-export interface PageComponentDimensionsReport {
-    cols?: number;
-    left?: number;
-    rows?: number;
-    top?: number;
-    type?: 'report';
-}
-export type PageComponentDimensionsUnion = PageComponentDimensionsSheet | PageComponentDimensionsCard | PageComponentDimensionsReport;

package/dist/types/ixapi/resources/page-link-group.d.ts

@@ -1,7 +0,0 @@
-import type { ResLink } from './res-link';
-export interface PageLinkGroup {
-    agent?: ResLink | null;
-    asset?: ResLink | null;
-    name?: string;
-    publicId: string;
-}

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

@@ -1,12 +0,0 @@
-import type { Audience } from './audience';
-import type { PageLinkGroup } from './page-link-group';
-import type { ResLink } from './res-link';
-export interface PageLink {
-    agent?: ResLink | null;
-    asset?: ResLink | null;
-    audience?: Audience | null;
-    group?: PageLinkGroup | null;
-    order?: number;
-    page?: ResLink;
-    publicId: string;
-}

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

@@ -1,6 +0,0 @@
-import type { ResLink } from './res-link';
-export interface PagePage {
-    order?: number | null;
-    pageVersion?: ResLink;
-    publicId: string;
-}

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

@@ -1,22 +0,0 @@
-import type { PageComponent } from './page-component';
-import type { PagePage } from './page-page';
-import type { ResLink } from './res-link';
-export interface PageVersion {
-    components?: PageComponent[];
-    createdBy?: ResLink | null;
-    createdOn?: string;
-    custom?: {
-        /** String reference for a material design named icon. */
-        glbMatIcon?: string;
-    };
-    page?: ResLink;
-    periodSelectorEnabled?: boolean;
-    periodSpec?: string | null;
-    previewAgent?: ResLink | null;
-    previewAsset?: ResLink | null;
-    publicId: string;
-    pagePages?: PagePage[];
-    title?: string | null;
-    updatedBy?: ResLink | null;
-    updatedOn?: string | null;
-}

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

@@ -1,8 +0,0 @@
-import type { Location } from './location';
-export interface PlatformServer {
-    location?: Location;
-    name?: string;
-    publicId: string;
-    type?: string;
-    vpnRange?: string;
-}

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

@@ -1,23 +0,0 @@
-import type { ResLink } from './res-link';
-import type { Sector } from './sector';
-export interface PolicyLanguage {
-    body?: string;
-    languageCode?: string;
-    publicId: string;
-    policy?: ResLink;
-}
-export interface PolicyBase {
-    company?: ResLink | null;
-    createdOn?: string;
-    downloadUrl?: string;
-    latest?: boolean;
-    languages?: PolicyLanguage[];
-    publicId: string;
-    publishedOn?: string | null;
-    sector?: Sector;
-    version?: string;
-}
-export interface TermsOfUsePolicy extends PolicyBase {
-}
-export interface PrivacyStatement extends PolicyBase {
-}

package/dist/types/ixapi/resources/res-link.d.ts

@@ -1,6 +0,0 @@
-export interface ResLink {
-    publicId: string;
-    reference?: {
-        name: string;
-    };
-}

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

@@ -1,6 +0,0 @@
-import type { PlatformServer } from './platform-server';
-export interface RscServer extends PlatformServer {
-    entryPoint?: string;
-    supportedLayers?: NetworkLayer[];
-}
-export type NetworkLayer = 'tap' | 'tun';

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

@@ -1,31 +0,0 @@
-import type { Branding } from './branding';
-import type { PrivacyStatement } from './policy';
-export interface Sector {
-    allowCustomPrivacyStatement?: boolean;
-    allowCustomTermsOfUse?: boolean;
-    branding?: Branding | null;
-    corporateWebsite?: string | null;
-    custom?: {
-        glbRouterConfigName?: string;
-        glbShowCustomComponents?: boolean;
-        /** @deprecated */
-        glbSlaDownloadUrl?: string;
-        glbSupportedPlatforms?: string;
-        glbVpnClientReleaseNotesUrl?: string;
-    };
-    defaultCountry?: string;
-    emailFromAddress?: string;
-    feedbackTo?: string;
-    latestPrivacyStatement?: PrivacyStatement;
-    name?: string;
-    poweredBy?: SectorPoweredBy;
-    premiumBrandingDomain?: string;
-    publicId: string;
-    supportEmailAddress?: string | null;
-}
-export interface SectorPoweredBy {
-    hide?: boolean;
-    logo?: string;
-    name?: string;
-    url?: string;
-}

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

@@ -1,11 +0,0 @@
-import type { ResLink } from './res-link';
-export interface UserMembership {
-    expiresOn?: string | null;
-    group?: ResLink;
-    /** null for users */
-    invite?: ResLink | null;
-    publicId: string;
-    role?: ResLink | null;
-    /** null for invites */
-    user?: ResLink | null;
-}

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

@@ -1,55 +0,0 @@
-import type { EmailAddressChange } from './email-address-change';
-import type { Invite } from './invite';
-import type { OtpAuth } from './otp-auth';
-import type { TermsOfUsePolicy } from './policy';
-import type { UserMembership } from './user-membership';
-export interface User {
-    /** @changeNotification taint */
-    emailAddress?: string;
-    /** For example 2019-01-01T12:00:00Z */
-    lastSeenOn?: string;
-    memberships?: UserMembership[];
-    /** @changeNotification taint */
-    name?: string;
-    /** Whether the user has two-factor authentication activated for their account. */
-    otpauthRequired?: boolean;
-    publicId: string;
-    support?: boolean;
-}
-export interface MyUser {
-    custom?: {
-        /** JSON Object with user colomns per company, For example: { "1111-2222-3333-4444-5555": ["status", "name", "lastOnline"]} */
-        glbFltDeviceTableCols?: string;
-        /** JSON Object with user colomns per company, For example: { "1111-2222-3333-4444-5555": ["status", "name", "lastOnline"]} */
-        glbPrtDeviceTableCols?: string;
-        /** JSON Object with view settings per company,
-         * For example:
-         * {
-         *    "1111-2222-3333-4444-5555": {
-         *      "type": { "gtSm": "list", "ltSm": "card"}, cardSortBy: { "gtSm": "name;asc", "ltSm": "groupType.AAAAAAAAAAAA;desc" }, deviceMapState: { "gtSm": "closed", "ltSm": "open" }, deviceMapHeight: { "gtSm": "100" }
-         *    }
-         * }
-         */
-        glbPrtDeviceViewSettings?: string;
-        /** JSON Object with starred agents per company, For example: { "1111-2222-3333-4444-5555": ["ixagent00001", "ixagent00003"]} */
-        glbStarred?: string;
-    };
-    emailAddress?: string;
-    emailAddressChanges?: EmailAddressChange[];
-    invites?: Invite[];
-    language?: string;
-    /** For example 2019-01-01T12:00:00Z */
-    lastSeenOn?: string;
-    localisation?: string | null;
-    name?: string;
-    otpAuth?: OtpAuth | null;
-    publicId: string;
-    /** For example 2019-01-01T12:00:00Z */
-    registeredOn?: string;
-    support?: boolean;
-    termsOfUsePolicy?: TermsOfUsePolicy | null;
-    /** For example 2019-01-01T12:00:00Z */
-    termsOfUsePolicyAcceptedOn?: string | null;
-    timeZone?: string | null;
-    unreadMessagesCount?: number;
-}

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

@@ -1 +0,0 @@
-export type VpnProtocol = 'tcp' | 'udp';