@ixon-cdk/types 1.2.1 → 1.3.0-next.1

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,11 @@
+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 ManagedByGroup = Pick<Group, 'publicId' | 'name' | 'type'>;

package/dist/types/ixapi/resources/historical-data-usage.d.ts

@@ -0,0 +1,3 @@
+export interface HistoricalDataUsage {
+    storedBytes: number;
+}

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

@@ -0,0 +1,103 @@
+export * from './access-recover';
+export * from './access-token';
+export * from './agent';
+export * from './agent-activate';
+export * from './agent-config';
+export * from './agent-data-alarm';
+export * from './agent-data-alarming-app';
+export * from './agent-data-condition';
+export * from './agent-data-logging-app';
+export * from './agent-data-monitor';
+export * from './agent-data-report';
+export * from './agent-data-source';
+export * from './agent-data-tag';
+export * from './agent-data-variable';
+export * from './agent-device';
+export * from './agent-mdr-server';
+export * from './agent-membership';
+export * from './agent-network-value';
+export * from './agent-pull';
+export * from './agent-queue-report';
+export * from './agent-router-lan-wan-access-rule';
+export * from './agent-router-vpn-access-rule';
+export * from './agent-server';
+export * from './agent-template';
+export * from './agent-type';
+export * from './agent-type-file';
+export * from './alarming-app';
+export * from './app-config';
+export * from './asset';
+export * from './asset-app-config';
+export * from './asset-membership';
+export * from './asset-type';
+export * from './audience';
+export * from './audit-log';
+export * from './auth-token';
+export * from './backend-component-function';
+export * from './backend-component-template';
+export * from './backend-component-template-config';
+export * from './backend-component-template-share';
+export * from './backend-component-template-version';
+export * from './branding';
+export * from './company';
+export * from './component-input';
+export * from './custom-property';
+export * from './data';
+export * from './data-protocol';
+export * from './data-protocol-applied';
+export * from './demo-device';
+export * from './discovery';
+export * from './email-address-change';
+export * from './file';
+export * from './group';
+export * from './group-role';
+export * from './group-type';
+export * from './historical-data-usage';
+export * from './invite';
+export * from './label';
+export * from './licence';
+export * from './licence-bundle';
+export * from './licence-type';
+export * from './location';
+export * from './logging-app';
+export * from './lsi-server';
+export * from './menu-item';
+export * from './message';
+export * from './message-filter';
+export * from './mqtt-broker';
+export * from './mqtt-broker-client';
+export * from './object-storage';
+export * from './otp-auth';
+export * from './page';
+export * from './page-component';
+export * from './page-component-template';
+export * from './page-component-template-category';
+export * from './page-component-template-config';
+export * from './page-component-template-manifest';
+export * from './page-component-template-version';
+export * from './page-link';
+export * from './page-link-group';
+export * from './page-page';
+export * from './page-version';
+export * from './password-change';
+export * from './permission';
+export * from './platform-server';
+export * from './policy';
+export * from './registration';
+export * from './report-schedule';
+export * from './res-link';
+export * from './role';
+export * from './rsc-server';
+export * from './sector';
+export * from './sso-authentication';
+export * from './sso-identity-provider';
+export * from './support-access';
+export * from './translation';
+export * from './user';
+export * from './user-membership';
+export * from './user-push-device';
+export * from './vpn-protocol';
+export * from './vpn-usage';
+export * from './web-access';
+export * from './webhook-subscription';
+export * from './webhook-trigger';

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

@@ -0,0 +1,25 @@
+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/label.d.ts

@@ -0,0 +1,7 @@
+import type { ResLink } from './res-link';
+export interface Label {
+    color?: string;
+    company?: ResLink;
+    name?: string;
+    publicId: string;
+}

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

@@ -0,0 +1,10 @@
+import type { ResLink } from './res-link';
+export interface LicenceBundle {
+    name?: string;
+    publicId: string;
+}
+export interface LicenceBundleExtend {
+    couponCode?: string;
+    licenceBundle?: ResLink;
+    publicId: string;
+}

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

@@ -0,0 +1,13 @@
+import type { Company } from './company';
+import type { Sector } from './sector';
+export type LicenceTypeScope = 'agent' | 'company';
+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';
+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

@@ -0,0 +1,27 @@
+import type { Agent } from './agent';
+import type { AgentType } from './agent-type';
+import type { LicenceBundle } from './licence-bundle';
+import type { LicenceType } from './licence-type';
+import type { ResLink } from './res-link';
+export interface Licence {
+    activated?: boolean;
+    agent?: Agent | null;
+    agentType?: AgentType | null;
+    bundle?: LicenceBundle | 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

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

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

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

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

package/dist/types/ixapi/resources/menu-item.d.ts

@@ -0,0 +1,8 @@
+import type { Audience } from './audience';
+import type { Page } from './page';
+export interface MenuItem {
+    audience?: Audience | null;
+    order?: number;
+    page?: Page;
+    publicId: string;
+}

package/dist/types/ixapi/resources/message-filter.d.ts

@@ -0,0 +1,18 @@
+import type { MessageSystemLabel } from './message';
+import type { User } from './user';
+export interface MessageFilter {
+    actions?: MessageFilterAction[];
+    companyPublicIds?: string[];
+    contains?: string | null;
+    longContains?: string | null;
+    notCompanyPublicIds?: boolean;
+    notContains?: string | null;
+    notLongContains?: string | null;
+    notShortContains?: string | null;
+    notSystemLabels?: boolean;
+    publicId: string;
+    shortContains?: string | null;
+    systemLabels?: MessageSystemLabel[];
+    user?: User;
+}
+export type MessageFilterAction = 'delete' | 'dont-forward-to-mail' | 'dont-send-push-notification' | 'dont-send-webhook-trigger' | 'forward-to-mail' | 'mark-as-read';

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

@@ -0,0 +1,35 @@
+export interface Message {
+    company?: string;
+    createdOn?: string;
+    code?: string;
+    longContent?: MessageLongContent;
+    publicId: string;
+    read?: boolean;
+    shortContent?: MessageShortContent;
+    systemLabel?: MessageSystemLabel;
+    systemResult?: MessageSystemResult[];
+    userLabels?: any[];
+}
+export interface MessageShortContent {
+    code: string;
+    /** @deprecated */
+    message?: string;
+    toTranslate?: boolean;
+    [key: string]: any;
+}
+export interface MessageLongContent {
+    code: string;
+    extraInformation: MessageExtraInformation[];
+    /** @deprecated */
+    message?: string;
+    toTranslate?: boolean;
+    [key: string]: any;
+}
+export interface MessageExtraInformation {
+    key: string;
+    type: 'string' | 'date';
+    toTranslate?: boolean;
+    value: string;
+}
+export type MessageSystemLabel = 'alarm-low' | 'alarm-medium' | 'alarm-high' | 'router-pulled';
+export type MessageSystemResult = 'forward-to-mail' | 'send-push-notification' | 'send-webhook-trigger';

package/dist/types/ixapi/resources/mqtt-broker-client.d.ts

@@ -0,0 +1,11 @@
+import type { ResLink } from './res-link';
+export interface MqttBrokerClient {
+    clientCert?: string | null;
+    clientKey?: string | null;
+    company?: ResLink;
+    mqttBroker?: ResLink;
+    name?: string;
+    password?: string | null;
+    publicId: string;
+    username?: string | null;
+}

package/dist/types/ixapi/resources/mqtt-broker.d.ts

@@ -0,0 +1,12 @@
+import type { MqttBrokerClient } from './mqtt-broker-client';
+import type { ResLink } from './res-link';
+export interface MqttBroker {
+    certauth?: string | null;
+    clients?: MqttBrokerClient[];
+    company?: ResLink;
+    host?: string;
+    messageFormat?: 'sparkplug_b' | 'sparkplug_b_json';
+    name?: string;
+    port?: number;
+    publicId: string;
+}

package/dist/types/ixapi/resources/object-storage.d.ts

@@ -0,0 +1,40 @@
+import type { BackendComponentFunctionCallArgs } from './backend-component-function';
+import type { ResLink } from './res-link';
+export type ObjectStorageTags = Record<string, string>;
+export declare const enum ObjectStorageUploadUrlTypeEnum {
+    AzureBlobStorage = "azure-blob-storage"
+}
+export type ObjectStorageUploadUrlType = 'azure-blob-storage';
+export interface ObjectStorageUpload {
+    template?: ResLink;
+    uuid?: string;
+    arguments?: BackendComponentFunctionCallArgs | null;
+}
+export interface ObjectStorageDownload {
+    template?: ResLink;
+    uuid?: string;
+    arguments?: BackendComponentFunctionCallArgs | null;
+}
+export interface ObjectStorageList {
+    template?: ResLink;
+    arguments?: BackendComponentFunctionCallArgs | null;
+}
+export interface ObjectStorageDelete {
+    template?: ResLink;
+    uuid?: string;
+    arguments?: BackendComponentFunctionCallArgs | null;
+}
+export interface ObjectStorageUploadResponse {
+    type?: ObjectStorageUploadUrlType;
+    url?: string;
+}
+export interface ObjectStorageDownloadResponse {
+    url?: string;
+}
+export interface ObjectStorageObjectMeta {
+    uuid?: string;
+    size?: number;
+    agent?: ResLink | null;
+    asset?: ResLink | null;
+    tags?: ObjectStorageTags;
+}

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

@@ -0,0 +1,13 @@
+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-template-category.d.ts

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

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

@@ -0,0 +1,7 @@
+import type { ResLink } from './res-link';
+export interface PageComponentTemplateConfig {
+    allowDraft?: boolean;
+    pinnedVersion?: ResLink;
+    publicId: string;
+    template?: ResLink;
+}

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

@@ -0,0 +1,57 @@
+import type { ResLink } from './res-link';
+export interface PageComponentTemplateManifest {
+    /** @deprecated */
+    author?: string | null;
+    cardSettings?: PageComponentTemplateCardSettings | null;
+    /** @deprecated */
+    description?: string | null;
+    /** @deprecated i.e. `"ix-text-note"` */
+    id?: string;
+    inputs?: any[];
+    /** @deprecated */
+    license?: string | null;
+    /** i.e. `"ix-text-note.min.js"` */
+    main?: string;
+    /** @deprecated i.e. `"Text Note"` */
+    name?: string;
+    reportSettings?: PageComponentTemplateReportSettings | null;
+    sheetSettings?: PageComponentTemplateSheetSettings | null;
+    template: ResLink;
+    version?: string;
+}
+export interface PageComponentTemplateCardSettings {
+    /** In range 1-65535 */
+    defaultHeight?: number | null;
+    /** In range 1-65535 */
+    maxHeight?: number | null;
+    /** In range 1-65535 */
+    minHeight: number;
+}
+export interface PageComponentTemplateReportSettings {
+    /** In range 1-12 */
+    defaultCols: number | null;
+    /** In range 1-12 */
+    defaultRows: number | null;
+    /** In range 1-12 */
+    maxCols: number | null;
+    /** In range 1-12 */
+    maxRows: number | null;
+    /** In range 1-12 */
+    minCols: number;
+    /** In range 1-12 */
+    minRows: number;
+}
+export interface PageComponentTemplateSheetSettings {
+    /** In range 1-12 */
+    defaultCols?: number | null;
+    /** In range 1-12 */
+    defaultRows?: number | null;
+    /** In range 1-12 */
+    maxCols?: number | null;
+    /** In range 1-12 */
+    maxRows?: number | null;
+    /** In range 1-12 */
+    minCols: number;
+    /** In range 1-12 */
+    minRows: number;
+}

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

@@ -0,0 +1,10 @@
+import type { ResLink } from './res-link';
+export interface PageComponentTemplateVersion {
+    createdOn?: string | null;
+    mainPath?: string;
+    notes?: string | null;
+    number?: string;
+    publicId: string;
+    publishedOn?: string | null;
+    template?: ResLink;
+}

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

@@ -0,0 +1,25 @@
+import type { PageComponentTemplateCategory } from './page-component-template-category';
+import type { PageComponentTemplateCardSettings, PageComponentTemplateSheetSettings } from './page-component-template-manifest';
+import type { PageComponentTemplateVersion } from './page-component-template-version';
+import type { ResLink } from './res-link';
+export interface PageComponentTemplate {
+    backendComponent?: ResLink | null;
+    /** @deprecated Moved to PageComponentTemplateManifest */
+    cardSettings?: PageComponentTemplateCardSettings | null;
+    category?: PageComponentTemplateCategory;
+    company?: ResLink | null;
+    configuredVersion?: PageComponentTemplateVersion | null;
+    description?: string | null;
+    /** Reference to the 'draft' version of this template */
+    draft?: ResLink | null;
+    intent?: PageComponentTemplateIntent[];
+    name?: string;
+    publicId: string;
+    /** Reference to the 'published' version of this template */
+    published?: ResLink | null;
+    /** @deprecated Moved to PageComponentTemplateManifest */
+    sheetSettings?: PageComponentTemplateSheetSettings | null;
+    static?: boolean;
+    url?: string | null;
+}
+export type PageComponentTemplateIntent = 'asset-configuration';

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

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

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

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

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

@@ -0,0 +1,22 @@
+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/page.d.ts

@@ -0,0 +1,17 @@
+import type { Label } from './label';
+import type { PageVersion } from './page-version';
+import type { ResLink } from './res-link';
+export interface Page {
+    /** Defaults to "sheet" */
+    applicationType?: PageApplicationType;
+    company?: ResLink | null;
+    custom?: {};
+    default?: boolean;
+    draft?: PageVersion | null;
+    labels?: Label[];
+    name?: string;
+    publicId: string;
+    published?: PageVersion | null;
+    static?: boolean;
+}
+export type PageApplicationType = 'sheet' | 'card' | 'report';

package/dist/types/ixapi/resources/password-change.d.ts

@@ -0,0 +1,5 @@
+export interface PasswordChangeCreate {
+    deleteAccessTokens: boolean;
+    newPassword: string;
+    oldPassword: string;
+}

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

@@ -0,0 +1,3 @@
+export interface Permission {
+    publicId: string;
+}

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

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