@sassoftware/vi-api/alert-reps/index.d.ts

Types used in the SAS Visual Investigator API

/* tslint:disable */
/* eslint-disable */
// Generated using typescript-generator version 2.15.527 on 2025-04-07 09:10:30.

export interface ActionRequestRep {
    version?: number;
    alertIds?: string[];
    userId?: string;
}

export interface ActionResponseRep {
    version?: number;
    alert?: AlertRep;
    alertId?: string;
    message?: string;
    success?: boolean;
    alertChanged?: boolean;
}

export interface AlertConstants {
}

export interface Length {
}

export interface LengthConstants {
}

export interface AlertDispositionRep extends BaseRep {
    alertDispositionDescription?: string;
    alertDispositionId?: string;
    alertDispositionName?: string;
    alertDispositionResolutionCode?: string;
    autoActivateDays?: number;
    autoActivateDelta?: number;
    autoActivateMinutes?: number;
    autoActivatePercent?: number;
    autoActivateScore?: number;
    autoCloseDays?: number;
    automationCompatible?: boolean;
    commentCategory?: string;
    commentTemplate?: string;
    displayOrder?: number;
    documentType?: string;
    documentTypeId?: number;
    generateCommentFlag?: boolean;
    gridDisplayFlag?: boolean;
    logicalDeleteFlag?: boolean;
    promptForNoteFlag?: boolean;
    promptForReasonFlag?: boolean;
    queues?: DispositionQueueRep[];
    relationshipName?: string;
    relationshipTypeId?: number;
    rerouteQueueId?: string;
    rerouteQueuePromptFlag?: boolean;
    restPageTemplate?: string;
    restUrl?: string;
    scenarioDispositionPromptFlag?: boolean;
    scenarioProductivityCode?: string;
    solutionId?: string;
    version?: number;
}

export interface AlertRep extends BaseRep {
    version?: number;
    domainId?: string;
    alertId?: string;
    alertVersion?: number;
    alertVersionTimeStamp?: string;
    actionableEntityType?: string;
    actionableEntityId?: string;
    actionableEntityLabel?: string;
    initialScore?: number;
    currentScore?: number;
    highScore?: number;
    alertOriginCode?: string;
    alertTypeCode?: string;
    alertTriggerText?: string;
    modelName?: string;
    statusTimeStamp?: string;
    enrichmentJson?: { [index: string]: any };
    alertDispositionCode?: string;
    dispositionTimeStamp?: string;
    dispositionReasonCode?: string;
    dispositionNote?: string;
    suppressFlag?: boolean;
    suppressDuration?: number;
    suppressionEndTimeStamp?: string;
    holdFlag?: boolean;
    holdDuration?: number;
    holdEndTimeStamp?: string;
    holdReasonCode?: string;
    routeFlag?: boolean;
    queueEntryTimeStamp?: string;
    assignedUserId?: string;
    assignmentTimeStamp?: string;
    checkoutUserId?: string;
    checkoutTimeStamp?: string;
    alertProductiveFlag?: boolean;
    alertServiceCount?: number;
    userServiceTimeStamp?: string;
    systemServiceTimeStamp?: string;
    dispositionDataJson?: { [index: string]: any };
    alertStatusId?: string;
    initialAlertingEventId?: string;
    currentAlertingEventId?: string;
    highAlertingEventId?: string;
    queueId?: string;
    lastUpdateNumber?: number;
    logicalDeleteFlag?: boolean;
    alertDispositionId?: string;
    alertDispositionResolutionCode?: string;
    autoCloseTimeStamp?: string;
    autoActivateTimeStamp?: string;
    autoActivateScore?: number;
    strategyRangeLow?: number;
    strategyRangeHigh?: number;
    dispositionTimestamp?: string;
    suppressionEndTimestamp?: string;
    holdEndTimestamp?: string;
    queueEntryTimestamp?: string;
    assignmentTimestamp?: string;
    checkoutTimestamp?: string;
    userServiceTimestamp?: string;
    systemServiceTimestamp?: string;
    autoCloseTimestamp?: string;
    autoActivateTimestamp?: string;
    alertVersionTimestamp?: string;
    statusTimestamp?: string;
}

export interface AlertVersionSummaryRep {
    version?: number;
    alertId?: string;
    alertVersion?: number;
    versionStatusId?: string;
    versionCreationTimeStamp?: string;
    versionDispositionId?: string;
    versionDispositionResolutionCode?: string;
    versionScore?: number;
    versionLastUpdateTimeStamp?: string;
    versionCreationTimestamp?: string;
    versionLastUpdateTimestamp?: string;
}

export interface AlertWorkflowRep {
    workflowProcessId?: string;
    labelKey?: string;
    labelOrder?: number;
    documentTypeName?: string;
}

export interface AlertingDataFlatRep extends TypedPayload {
    version?: number;
    jsonLayout?: string;
    alertingEvents?: AlertingEventRep[];
    scenarioFiredEvents?: ScenarioFiredEventFlatRep[];
    enrichment?: { [index: string]: any }[];
    contributingObjects?: ContributingObjectFlatRep[];
    workspaces?: WorkspaceFlatRep[];
    workspaceMembers?: WorkspaceMemberFlatRep[];
}

export interface AlertingDataNestedRep extends TypedPayload {
    version?: number;
    jsonLayout?: string;
    alertingEvents?: AlertingEventNestedRep<any>[];
}

export interface AlertingEventNestedRep<SFE> extends AlertingEventRep {
    scenarioFiredEvents?: SFE[];
    contributingObjects?: ContributingObjectRep[];
    workspaces?: WorkspaceNestedRep[];
}

export interface AlertingEventRep extends BaseRep {
    version?: number;
    domainId?: string;
    alertingEventId?: string;
    actionableEntityType?: string;
    actionableEntityId?: string;
    actionableEntityLabel?: string;
    score?: number;
    alertOriginCode?: string;
    alertTypeCode?: string;
    alertTriggerText?: string;
    modelName?: string;
    recommendedQueueId?: string;
    alertId?: string;
    alertVersionNumber?: number;
    enrichment?: { [index: string]: any };
    receivedScore?: number;
    receivedDomainId?: string;
    receivedRecommendedQueueId?: string;
    rollingCalculationTimeStamp?: string;
    scoreAggregationPolicy?: string;
    scoreDescription?: string;
    rollingCalculationTimestamp?: string;
}

export interface BaseRep extends TrackedResource {
    links?: Link[];
}

export interface BaseRepTest {
}

export interface BaseTDCRep extends Serializable {
    id?: string;
    fields?: { [index: string]: any };
    links?: Link[];
}

export interface ContributingObjectFlatRep extends ContributingObjectRep {
    alertingEventId?: string;
    scenarioFiredEventId?: string;
}

export interface ContributingObjectRep extends BaseRep {
    version?: number;
    contributingObjectType?: string;
    contributingObjectId?: string;
    workspaceFlag?: boolean;
    triggeringFlag?: boolean;
}

export interface CreationTrackedObjectRep {
    creationTimeStamp?: string;
    createdBy?: string;
}

export interface DispositionNotificationRep extends TypedPayload {
    version?: number;
    alert?: AlertRep;
    scenarioFiredEvents?: ScenarioFiredEventRep[];
}

export interface DispositionQueueRep extends BaseRep {
    displayCode?: string;
    dispositionAutoApplied?: boolean;
    dispositionId?: string;
    dispositionName?: string;
    groupId?: string;
    logicalDeleteFlag?: boolean;
    queueId?: string;
    queueName?: string;
    version?: number;
}

export interface DispositionResponseRep {
    version?: number;
    alert?: AlertRep;
    message?: string;
    alertChanged?: boolean;
    success?: boolean;
    alertId?: string;
}

export interface DomainRep extends BaseRep {
    assignmentEnabledFlag?: boolean;
    defaultAlertScore?: number;
    defaultManualAlertScore?: number;
    dispositionReasonReferenceTableName?: string;
    domainDescription?: string;
    domainId?: string;
    domainName?: string;
    promptForSFEReasonCode?: boolean;
    scoreAggregationPolicy?: string;
    sfeDispositionReasonProductivityMappingJson?: { [index: string]: any };
    solutionId?: string;
    suppressQueueId?: string;
    userCreatedDomain?: boolean;
    version?: number;
}

export interface EnrichmentFieldRep extends BaseRep {
    enrichmentFieldDataTypeCode?: string;
    enrichmentFieldDescription?: string;
    enrichmentFieldHeader?: string;
    enrichmentFieldId?: string;
    enrichmentFieldLabel?: string;
    enrichmentFieldName?: string;
    solutionId?: string;
    version?: number;
}

export interface EntityHandle {
    version?: number;
    entityType?: string;
    entityId?: string;
}

export interface EntityScenariosRep {
    version?: number;
    entityId?: string;
    entityLabel?: string;
    entityType?: string;
    scenarios?: ScenarioFiredEventRep[];
}

export interface ExtendedAlertRep extends AlertRep {
    applicableDispositionIds?: string[];
}

export interface ExtendedScenarioFiredEventRep extends ScenarioFiredEventRep {
    alertId?: string;
    alertVersionNumber?: number;
    alertingEventId?: string;
    modelName?: string;
    alertTypeCode?: string;
    alertTriggerText?: string;
    suppressedFlag?: boolean;
    reasonCode?: string;
}

export interface FieldDescriptionRep {
    version?: number;
    fieldName?: string;
    type?: string;
    size?: number;
    labelText?: string;
    headerText?: string;
    isEnrichment?: boolean;
}

export interface LogicExpressionRep extends BaseRep {
    conditionCode?: string;
    logicExpressionId?: string;
    propertyName?: string;
    routingRuleId?: string;
    valueText?: string;
    version?: number;
}

export interface MessageConstants {
}

export interface QueueRep extends BaseRep {
    acceptManualAlerts?: boolean;
    autoDispositionId?: string;
    defaultProcessId?: string;
    dispositions?: DispositionQueueRep[];
    domainId?: string;
    holdDefaultDuration?: number;
    queueAutoActivateDelta?: number;
    queueAutoActivateScore?: number;
    queueAutoCloseDays?: number;
    queueDescription?: string;
    queueId?: string;
    queueName?: string;
    queuePriority?: number;
    queueStatus?: string;
    queueSticky?: boolean;
    routingRule?: RoutingRuleRep;
    serviceSortField?: string;
    serviceSortOrder?: string;
    strategyId?: string;
    suppressDefaultDuration?: number;
    userCreatedQueue?: boolean;
    version?: number;
}

export interface RelationshipRep extends Serializable {
    relationshipType?: string;
    fields?: { [index: string]: any };
    links?: Link[];
}

export interface ReplicatedObjectRep extends BaseRep {
    version?: number;
    replicatedObjectId?: string;
    replicatedObjectEntityTypeName?: string;
    replicatedObjectEntityId?: string;
    replicatedObjectEntityLabel?: string;
    replicatedObjectJsonDoc?: { [index: string]: any };
    replicatedObjectValidTimeStamp?: string;
    scenarioFiredEventId?: string;
}

export interface RoutingRuleRep extends BaseRep {
    disjunctionFlag?: boolean;
    logicExpressions?: LogicExpressionRep[];
    queueId?: string;
    routingRuleDescription?: string;
    routingRuleId?: string;
    routingRuleName?: string;
    routingRulePriority?: number;
    routingRuleStatusCode?: string;
    userCreatedRoutingRuleFlag?: boolean;
    version?: number;
}

export interface ScenarioDispositionRep extends BaseRep {
    version?: number;
    scenarioId?: string;
    scenarioName?: string;
    dispositionId?: string;
    scenarioFiredEventId?: string;
    dispositionDefinitionId?: string;
    dispositionResolution?: string;
    alertId?: string;
    alertVersion?: number;
    displayOrder?: number;
    recencyRank?: number;
}

export interface ScenarioDispositionSummaryRep extends BaseRep {
    version?: number;
    scenarioId?: string;
    numberProductive?: number;
    numberNonProductive?: number;
    numberIndeterminate?: number;
    effectivenessRatio?: number;
    startDatetime?: string;
    endDateTime?: string;
}

export interface ScenarioDispositionSummaryRequestRep {
    scenarioIDs?: string[];
    endDateTime?: string;
    startDatetime?: string;
}

export interface ScenarioFiredEventDispositionRep extends BaseRep {
    version?: number;
    scenarioFiredEventDispositionId?: string;
    scenarioFiredEventId?: string;
    alertDispositionId?: string;
    resolutionCode?: string;
    resolutionComment?: string;
    reasonCode?: string;
    logicalDeleteFlag?: string;
}

export interface ScenarioFiredEventFlatRep extends ScenarioFiredEventRep {
    alertingEventId?: string;
}

export interface ScenarioFiredEventRep extends BaseRep {
    version?: number;
    scenarioFiredEventId?: string;
    scenarioFiredEntityType?: string;
    scenarioFiredEntityId?: string;
    scenarioId?: string;
    scenarioName?: string;
    scenarioDescription?: string;
    scenarioOriginCode?: string;
    ruleId?: string;
    deploymentId?: string;
    originDataText?: string;
    score?: number;
    minimumScore?: number;
    maximumScore?: number;
    meanScore?: number;
    displayFlag?: boolean;
    displayOrder?: number;
    displayTypeCode?: DisplayType;
    displayFormat?: string;
    messageTemplateText?: string;
    messageValuesJson?: { [index: string]: any };
    messageValuesJsonAsText?: string;
    weight?: number;
    recommendedQueueId?: string;
    contextRelationshipName?: string;
    contextTimeStampFieldName?: string;
    contextStartTimeStamp?: string;
    contextEndTimeStamp?: string;
    replicateFlag?: boolean;
    replicationPolicy?: ScenarioFiredEventReplicationPolicyType;
    externalReplicationEntityName?: string;
    externalReplicationEntitySFEIdFieldName?: string;
    contributingObjects?: ContributingObjectRep[];
    currentDispositionResolutionCode?: string;
    currentProductiveUserId?: string;
    currentProductiveTimeStamp?: string;
    currentDispositionComment?: string;
    receivedScenarioFiredEntityType?: string;
    receivedScenarioFiredEntityId?: string;
    valueText?: string;
    valueNumeric?: number;
    valueTimeStamp?: string;
    valueBoolean?: boolean;
    valueType?: ValueType;
    duplicatedFlag?: boolean;
    duplicatedFromId?: string;
    runStartTimeStamp?: string;
    segmentGroupId?: string;
    entitySegmentCode?: string;
    appliedSegmentCode?: string;
    currentProductiveTimestamp?: string;
    valueTimestamp?: string;
}

export interface ScenarioTagRep extends BaseRep {
    domainId?: string;
    logicalDeleteFlag?: boolean;
    scenarioTagId?: string;
    scenarioTagName?: string;
    version?: number;
}

export interface ScoreCardRep extends Serializable {
    version?: number;
    score?: number;
    scoreRangeHigh?: number;
    scoreRangeLow?: number;
    scoreDescription?: string;
    entityScenarios?: EntityScenariosRep[];
}

export interface ScoreRep extends BaseRep {
    scoreId?: string;
    alertingEventId?: string;
    score?: number;
    scenarioFiredEventIds?: string[];
    suppressedScenarioFiredEventIds?: string[];
    scoreCalculatedFlag?: boolean;
}

export interface StrategyRep extends BaseRep {
    allUsers?: boolean;
    autoServiceType?: string;
    dispDocumentTypeId?: number;
    dispDocumentTypeName?: string;
    dispUrlTemplate?: string;
    domainId?: string;
    generateWorkspace?: boolean;
    groupId?: string;
    presentationMode?: string;
    queues?: QueueRep[];
    scoreRangeHigh?: number;
    scoreRangeLow?: number;
    solutionId?: string;
    strategyDescription?: string;
    strategyId?: string;
    strategyName?: string;
    strategyPriority?: number;
    strategyStatus?: string;
    triageDefinition?: TriageDefinitionRep;
    triageDefinitionId?: string;
    userCreatedStrategy?: boolean;
    version?: number;
    workspaceLevel?: number;
}

export interface SubclassBaseRep extends BaseRep, Cloneable {
    int1?: number;
    integer1?: number;
    string1?: string;
    referencedObject?: any;
}

export interface SuppressedScenarioRep extends BaseRep {
    suppressedScenarioId?: string;
    domainId?: string;
    scenarioFiredEntityId?: string;
    scenarioFiredEntityType?: string;
    scenarioId?: string;
    alertId?: string;
    alertVersion?: number;
    suppressionComment?: string;
    recordCorrelator?: string;
    timeToRestore?: string;
}

export interface TDCAppDataRep extends BaseTDCRep {
    objectTypeCode?: string;
}

export interface TaskExecutionHistoryRep extends BaseRep {
    version?: number;
    name?: string;
    startedTimeStamp?: string;
    endedTimeStamp?: string;
    status?: string;
    recordsProcessed?: number;
    errorText?: string;
}

export interface TriageDefinitionRep extends BaseRep {
    columnDefinitionsJson?: any;
    defaultFilterText?: string;
    defaultSortFieldName?: string;
    defaultSortOrderCode?: string;
    triageDefinitionDescription?: string;
    triageDefinitionId?: string;
    triageDefinitionName?: string;
    version?: number;
}

export interface UpdateTrackedObjectRep extends CreationTrackedObjectRep {
    modifiedTimeStamp?: string;
    modifiedBy?: string;
}

export interface WorkspaceFlatRep {
    version?: number;
    alertingEventId?: string;
    workspaceId?: string;
    workspaceName?: string;
    visualizationType?: WorkspaceVisualizationType;
}

export interface WorkspaceFlatRepTest {
}

export interface WorkspaceMemberFlatRep extends EntityHandle {
    workspaceId?: string;
}

export interface WorkspaceNestedRep {
    version?: number;
    workspaceName?: string;
    visualizationType?: WorkspaceVisualizationType;
    members?: EntityHandle[];
}

export interface MapAdapter extends XmlAdapter<MapType, { [index: string]: any }> {
}

export interface MapEntryType {
    key?: string;
    value?: any;
}

export interface MapType {
    entry?: MapEntryType[];
}

export interface Link extends Serializable, Comparable<Link> {
    method?: string;
    rel?: string;
    href?: string;
    uri?: string;
    type?: string;
    responseType?: string;
    itemType?: string;
    responseItemType?: string;
    title?: string;
}

export interface TypedPayload {
    payloadType?: string;
    eventType?: string;
}

export interface TrackedResource extends Serializable, ETaggable, TimeTrackedResource, ETagAndLastModifiedProvider {
    createdBy?: string;
    modifiedBy?: string;
}

export interface Serializable {
}

export interface Cloneable {
}

export interface ETaggable extends Preconditionable {
    etag?: string;
}

export interface TimeTrackedResource extends LastModifiedProviderFromModifiedTimeStamp {
    creationTimeStamp?: string;
}

export interface ETagAndLastModifiedProvider extends ETaggable, LastModifiedProvider {
}

export interface XmlAdapter<ValueType, BoundType> {
}

export interface Comparable<T> {
}

export interface Preconditionable {
}

export interface LastModifiedProviderFromModifiedTimeStamp extends LastModifiedProvider {
    modifiedTimeStamp?: string;
}

export interface LastModifiedProvider extends Preconditionable {
    lastModifiedHeaderDate?: string;
}

export type DisplayType = 'TEXT' | 'VARIABLE';

export type DispositionResolutionCode = 'PRODUCTIVE' | 'NON_PRODUCTIVE' | 'INDETERMINATE';

export type ScenarioFiredEventReplicationPolicyType = 'INTERNAL' | 'EXTERNAL';

export type ValueType = 'TEXT' | 'NUMERIC' | 'TIMESTAMP' | 'BOOLEAN';

export type WorkspaceVisualizationType = 'Map' | 'Summary' | 'Table' | 'Timeline' | 'Network';