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

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

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

@@ -0,0 +1,26 @@
+import type { SsoAuthentication } from './sso-authentication';
+interface RegistrationBaseCreate {
+    companyName: string;
+    language?: string;
+    localisation?: string;
+    termsOfUsePolicy: {
+        publicId: string;
+    } | null;
+    timeZone?: string;
+}
+export interface MyRegistration {
+    companyName?: string;
+    emailAddress?: string;
+    language?: string;
+    name?: string;
+    publicId: string;
+}
+export interface RegistrationCreate extends RegistrationBaseCreate {
+    emailAddress: string;
+    name: string;
+    password: string;
+}
+export interface RegistrationSsoCreate extends RegistrationBaseCreate {
+    ssoAuthentication: SsoAuthentication;
+}
+export {};

package/dist/types/ixapi/resources/report-schedule.d.ts

@@ -0,0 +1,37 @@
+import type { ResLink } from './res-link';
+export interface ReportSchedule {
+    agent?: ResLink;
+    /** I.e. "12:00:00" */
+    deliveryTime?: string;
+    publicId: string;
+    recurrence?: ReportRecurrenceUnion;
+    report?: ResLink;
+    /** I.e. "2019-01-01T12:00:00Z" */
+    start?: string;
+    timeZone?: string;
+}
+export interface ReportRecurrenceWeekly {
+    frequency?: 'weekly';
+    interval?: number;
+    monday?: boolean;
+    tuesday?: boolean;
+    wednesday?: boolean;
+    thursday?: boolean;
+    friday?: boolean;
+    saturday?: boolean;
+    sunday?: boolean;
+}
+export interface ReportRecurrenceMonthly {
+    frequency?: 'monthly';
+    interval?: number;
+    occurrence?: number;
+    monday?: boolean;
+    tuesday?: boolean;
+    wednesday?: boolean;
+    thursday?: boolean;
+    friday?: boolean;
+    saturday?: boolean;
+    sunday?: boolean;
+}
+export type ReportRecurrenceUnion = ReportRecurrenceWeekly | ReportRecurrenceMonthly;
+export type ReportRecurrenceFrequency = 'weekly' | 'monthly';

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

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

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

@@ -0,0 +1,9 @@
+import type { Audience } from './audience';
+import type { Permission } from './permission';
+export interface Role {
+    audiences?: Audience[];
+    enforce2fa?: boolean;
+    name?: string;
+    permissions?: Permission[];
+    publicId: string;
+}

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

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

@@ -0,0 +1,31 @@
+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/sso-authentication.d.ts

@@ -0,0 +1,12 @@
+import type { ResLink } from './res-link';
+export interface SsoAuthenticationRequest {
+    url: string;
+}
+export interface SsoAuthenticationRequestCreate {
+    identityProvider: ResLink;
+    redirectUrl: string;
+}
+export interface SsoAuthentication {
+    code: string;
+    state: string;
+}

package/dist/types/ixapi/resources/sso-identity-provider.d.ts

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

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

@@ -0,0 +1,5 @@
+export interface SupportAccess {
+    expiresOn?: string /** "2021-01-01T12:00:00Z" */;
+    caseNumber?: string;
+    message?: string;
+}

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

@@ -0,0 +1,7 @@
+export interface Translation {
+    publicId: string;
+    key?: string;
+    languages?: {
+        [languageCode: string]: string;
+    };
+}

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

@@ -0,0 +1,11 @@
+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-push-device.d.ts

@@ -0,0 +1,10 @@
+export interface UserPushDevice {
+    createdOn?: string;
+    deactivated?: boolean;
+    deviceId: string;
+    name?: string;
+    publicId: string;
+    token?: string;
+    user?: string;
+    userAgent?: string;
+}

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

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

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

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

@@ -0,0 +1,11 @@
+export interface VpnUsage {
+    bytesReceived: number;
+    bytesSent: number;
+    /** value between 1-31 */
+    day?: number;
+    /** value between 0-23 */
+    hour?: number;
+    year: number;
+    /** value between 1-12 */
+    month?: number;
+}

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

@@ -0,0 +1,3 @@
+export interface WebAccess {
+    url: string;
+}

package/dist/types/ixapi/resources/webhook-subscription.d.ts

@@ -0,0 +1,7 @@
+export interface WebhookSubscription {
+    callbackUrl?: string;
+    createdOn?: string;
+    name?: string | null;
+    publicId: string;
+    timeout?: number;
+}

package/dist/types/ixapi/resources/webhook-trigger.d.ts

@@ -0,0 +1,12 @@
+import type { ResLink } from './res-link';
+export interface WebhookTrigger {
+    ok?: boolean;
+    retrying?: boolean;
+    tryCount?: number;
+    lastTry?: string;
+    nextTry?: string;
+    publicId: string;
+    status?: WebhookTriggerStatus;
+    subscription?: ResLink;
+}
+export type WebhookTriggerStatus = 'ok' | 'timeout' | 'could-not-connect' | 'invalid-https' | 'too-many-redirects' | 'non-ok-response-code';

package/dist/types/logging-data/logging-data-value.d.ts

@@ -4,6 +4,7 @@ export interface LoggingDataValue {
     /** @deprecated */
     setFactor(newFactor: number): void;
     setUnit(newUnit: string): void;
+    getUnit(): string;
     getValue(): boolean | number | string | null;
     toString(): string;
 }

package/dist/types/object-storage/index.d.ts

@@ -0,0 +1 @@
+export * from './object-storage-client';

package/dist/types/object-storage/object-storage-client.d.ts

@@ -0,0 +1,58 @@
+/** @module ObjectStorageClient */
+import type { BackendComponentFunctionCallArgs, ObjectStorageObjectMeta, ObjectStorageTags } from '../ixapi/resources';
+/**
+ * Client to store and retrieve Objects
+ */
+export interface ObjectStorageClient {
+    /**
+     * Get a list of object in the store
+     *
+     * @param options Request options
+     */
+    getList(options?: ObjectStorageOptions): Promise<ObjectStorageListResponse>;
+    /**
+     * Get an Object
+     *
+     * @param objectMeta Object meta information
+     * @param options Request options
+     */
+    getBlob(objectMeta: ObjectStorageObjectMeta, options?: ObjectStorageGetBlobOptions): Promise<Blob>;
+    /**
+     * Store an object in storage
+     *
+     * @param object The contents of the object to store
+     * @param options Request options
+     */
+    store(object: Blob, options?: ObjectStorageStoreOptions): Promise<ObjectStorageResponse>;
+    /**
+     * Delete an object
+     *
+     * @param objectMeta Object meta information
+     * @param options Request options
+     */
+    delete(objectMeta: ObjectStorageObjectMeta, options?: ObjectStorageOptions): Promise<void>;
+    /**
+     * Destroy the client. Always call this when the client is not used anymore. When the context is
+     * destroyed, this is called automatically
+     */
+    destroy(): void;
+}
+export interface ObjectStorageOptions {
+    /**
+     * Extra arguments for Cloud Functions.
+     */
+    args?: BackendComponentFunctionCallArgs;
+}
+export interface ObjectStorageStoreOptions extends ObjectStorageOptions {
+    abortSignal?: AbortSignal;
+    tags?: ObjectStorageTags;
+}
+export interface ObjectStorageGetBlobOptions extends ObjectStorageOptions {
+    abortSignal?: AbortSignal;
+}
+export interface ObjectStorageResponse {
+    identifier: string;
+}
+export interface ObjectStorageListResponse {
+    entries: Array<ObjectStorageObjectMeta>;
+}

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

@@ -8,11 +8,17 @@ interface ResultDataMap {
     Branding: ResourceData.Branding;
     CustomPropertyList: ResourceData.CustomProperty[];
     GroupList: ResourceData.Group[];
+    MyCompany: ResourceData.MyCompany;
     MyUser: ResourceData.MyUser;
     PagePage: ResourceData.PagePage;
     PageVersion: ResourceData.PageVersion;
+    UserList: ResourceData.User[];
 }
 export interface ResourceDataClient {
+    /**
+     * Destroy the client. Always call this when the client is not used anymore. When the context is
+     * destroyed, this is called automatically
+     */
     destroy(): void;
     /**
      * @returns {function()} Returns a deregistration function for the listener.

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

@@ -1,5 +1,5 @@
 /** @module ResourceDataQuery */
-export type ResourceDataQuerySelector = 'Agent' | 'Asset' | 'Branding' | 'CustomPropertyList' | 'GroupList' | 'MyUser' | 'PagePage' | 'PageVersion';
+export type ResourceDataQuerySelector = 'Agent' | 'Asset' | '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.d.ts

@@ -44,6 +44,7 @@ interface AgentResourceData {
     }[];
     mqttChangedOn?: string | null;
     name?: string;
+    permissions?: string[];
     publicId: string;
     rateLimiting?: {
         configMqttCommandCounter?: number;
@@ -81,6 +82,7 @@ interface AssetResourceData {
         publicId: string;
     }[];
     name?: string;
+    permissions?: string[];
     publicId: string;
     resourceVariant?: {
         publicId: string;
@@ -111,10 +113,16 @@ interface GroupResourceData {
         publicId: string;
     } | null;
 }
+interface MyCompanyResourceData {
+    name?: string;
+    permissions?: string[];
+    publicId: string;
+}
 interface MyUserResourceData {
     custom?: Record<string, any>;
     name?: string;
     publicId: string;
+    support?: boolean;
     unreadMessagesCount?: number;
 }
 interface PagePageResourceData {
@@ -129,14 +137,20 @@ interface PageVersionResourceData {
     publicId: string;
     title?: string | null;
 }
+interface UserResourceData {
+    name?: string;
+    publicId: string;
+}
 export declare namespace ResourceData {
     type Agent = AgentResourceData;
     type Asset = AssetResourceData;
     type Branding = BrandingResourceData;
     type CustomProperty = CustomPropertyResourceData;
     type Group = GroupResourceData;
+    type MyCompany = MyCompanyResourceData;
     type MyUser = MyUserResourceData;
     type PagePage = PagePageResourceData;
     type PageVersion = PageVersionResourceData;
+    type User = UserResourceData;
 }
 export {};

package/package.json

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