@shi-corp/sdk-data-gateway/bin/sdk/models/telemetry/index.d.ts

SDK client used to interface with the SHI Data Gateway service.

import { type AdditionalDataHolder, type Guid, type Parsable, type ParseNode, type SerializationWriter } from '@microsoft/kiota-abstractions';
/**
 * Creates a new instance of the appropriate class based on discriminator value
 * @param parseNode The parse node to use to read the discriminator value and create the object
 * @returns {Shield}
 */
export declare function createShieldFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
/**
 * The deserialization information for the current model
 * @returns {Record<string, (node: ParseNode) => void>}
 */
export declare function deserializeIntoShield(shield?: Partial<Shield> | undefined): Record<string, (node: ParseNode) => void>;
/**
 * Serializes information the current object
 * @param writer Serialization writer to use to serialize this model
 */
export declare function serializeShield(writer: SerializationWriter, shield?: Partial<Shield> | undefined | null): void;
export interface Shield extends AdditionalDataHolder, Parsable {
    /**
     * Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
     */
    additionalData?: Record<string, unknown>;
    /**
     * Primary key for the table, used to correlate multiple telemetry records together.
     */
    correlationId?: Guid | null;
    /**
     * Timestamp on when the record was created. This is auto managed by sequelize.
     */
    createdAt?: Date | null;
    /**
     * Count of Enterprise Devices that are deployed in the CX environment.
     */
    enterpriseDeviceCount?: number | null;
    /**
     * Number of active Enterprise interfaces.
     */
    enterpriseInterfaceCount?: number | null;
    /**
     * Number of active Enterprise intermediaries.
     */
    enterpriseIntermediaryCount?: number | null;
    /**
     * Count of Enterprise Users that are deployed in the CX environment.
     */
    enterpriseUserCount?: number | null;
    /**
     * Number of active managed Enterprise users.
     */
    monthlyActiveEntUsers?: number | null;
    /**
     * Number of active managed privileged users.
     */
    monthlyActivePrivUsers?: number | null;
    /**
     * Number of active managed Specialized users.
     */
    monthlyActiveSpecUsers?: number | null;
    /**
     * Count of Privileged Devices (PAW) that are deployed in the CX environment.
     */
    privilegedDeviceCount?: number | null;
    /**
     * Number of active Privileged interfaces.
     */
    privilegedInterfaceCount?: number | null;
    /**
     * Number of active Privileged intermediaries.
     */
    privilegedIntermediaryCount?: number | null;
    /**
     * Count of Privileged Users that are deployed in the CX environment.
     */
    privilegedUserCount?: number | null;
    /**
     * Version number of the architecture that is deployed.
     */
    shieldArchitectureVersion?: string | null;
    /**
     * Version number of the product that the product is running.
     */
    shieldCoreVersion?: string | null;
    /**
     * Count of Specialized Devices that are deployed in the CX environment.
     */
    specializedDeviceCount?: number | null;
    /**
     * Number of active Specialized interfaces.
     */
    specializedInterfaceCount?: number | null;
    /**
     * Number of active Specialized intermediaries.
     */
    specializedIntermediaryCount?: number | null;
    /**
     * Count of Specialized Users that are deployed in the CX environment.
     */
    specializedUserCount?: number | null;
    /**
     * Tenant ID for the CX in question.
     */
    tenantId?: string | null;
    /**
     * Timestamp on when the record was last updated. This is auto managed by sequelize.
     */
    updatedAt?: Date | null;
}