@mindconnect/mindconnect-nodejs
Version:
NodeJS Library for Siemens Insights Hub Connectivity - TypeScript SDK for Insights Hub and Industrial IoT - Command Line Interface - Insights Hub Development Proxy (Siemens Insights Hub was formerly known as MindSphere)
982 lines (981 loc) • 22.7 kB
TypeScript
export declare namespace MindConnectApiModels {
/**
*
* @export
* @class RequiredError
* @extends {Error}
*/
class RequiredError extends Error {
field: string;
name: "RequiredError";
constructor(field: string, msg?: string);
}
/**
*
* @export
* @interface Ingestion
*/
interface Ingestion {
/**
* Timeseries data for each timestamp
* @type {Array<IngestionTimeseries>}
* @memberof Ingestion
*/
timeseries?: Array<IngestionTimeseries>;
}
/**
*
* @export
* @interface IngestionTimeseries
*/
interface IngestionTimeseries {
/**
* Timestamp of the data point
* @type {string}
* @memberof IngestionTimeseries
*/
timestamp: string;
/**
* List of datapoint(s)
* @type {Array<IngestionValues>}
* @memberof IngestionTimeseries
*/
values: Array<IngestionValues>;
}
/**
*
* @export
* @interface IngestionValues
*/
interface IngestionValues {
/**
* Unique identifier of the data point
* @type {string}
* @memberof IngestionValues
*/
dataPointId: string;
/**
* Timeseries data value for a given data point id
* @type {string}
* @memberof IngestionValues
*/
value: string;
/**
* Data Quality Code
* @type {string}
* @memberof IngestionValues
*/
qualityCode: string;
}
/**
*
* @export
* @interface Badrequest
*/
interface Badrequest {
/**
*
* @type {string}
* @memberof Badrequest
*/
id?: string;
/**
*
* @type {string}
* @memberof Badrequest
*/
message?: string;
}
/**
*
* @export
* @interface Conflict
*/
interface Conflict {
/**
*
* @type {string}
* @memberof Conflict
*/
id?: string;
/**
*
* @type {string}
* @memberof Conflict
*/
message?: string;
}
/**
*
* @export
* @interface DiagnosticActivation
*/
interface DiagnosticActivation {
/**
* Unique identifier of diagnostic activation resource
* @type {string}
* @memberof DiagnosticActivation
*/
id?: string;
/**
* Unique identifier of the agent
* @type {string}
* @memberof DiagnosticActivation
*/
agentId: string;
/**
* Status of the activation
* @type {string}
* @memberof DiagnosticActivation
*/
status?: DiagnosticActivation.StatusEnum;
}
/**
* @export
* @namespace DiagnosticActivation
*/
namespace DiagnosticActivation {
/**
* @export
* @enum {string}
*/
enum StatusEnum {
ACTIVE,
INACTIVE
}
}
/**
*
* @export
* @interface DiagnosticActivationStatus
*/
interface DiagnosticActivationStatus {
/**
* Status of the activation
* @type {string}
* @memberof DiagnosticActivationStatus
*/
status?: DiagnosticActivationStatus.StatusEnum;
}
/**
* @export
* @namespace DiagnosticActivationStatus
*/
namespace DiagnosticActivationStatus {
/**
* @export
* @enum {string}
*/
enum StatusEnum {
ACTIVE,
INACTIVE
}
}
/**
*
* @export
* @interface DiagnosticInformation
*/
interface DiagnosticInformation {
/**
*
* @type {string}
* @memberof DiagnosticInformation
*/
agentId?: string;
/**
*
* @type {string}
* @memberof DiagnosticInformation
*/
correlationId?: string;
/**
*
* @type {string}
* @memberof DiagnosticInformation
*/
severity?: DiagnosticInformation.SeverityEnum;
/**
*
* @type {string}
* @memberof DiagnosticInformation
*/
message?: string;
/**
* Source of diagnostic information.
* @type {string}
* @memberof DiagnosticInformation
*/
source?: string;
/**
* State of diagnostic information.
* @type {string}
* @memberof DiagnosticInformation
*/
state?: DiagnosticInformation.StateEnum;
/**
* Diagnostic information creation date.
* @type {Date}
* @memberof DiagnosticInformation
*/
timestamp?: Date;
}
/**
* @export
* @namespace DiagnosticInformation
*/
namespace DiagnosticInformation {
/**
* @export
* @enum {string}
*/
enum SeverityEnum {
INFO,
WARN,
ERROR
}
/**
* @export
* @enum {string}
*/
enum StateEnum {
ACCEPTED,
RETRYING,
DROPPED,
PROCESSING,
FINISHED
}
}
/**
*
* @export
* @interface DiagnosticInformationMessage
*/
interface DiagnosticInformationMessage {
/**
*
* @type {string}
* @memberof DiagnosticInformationMessage
*/
correlationId?: string;
/**
*
* @type {string}
* @memberof DiagnosticInformationMessage
*/
severity?: DiagnosticInformationMessage.SeverityEnum;
/**
*
* @type {string}
* @memberof DiagnosticInformationMessage
*/
message?: string;
/**
* Source of diagnostic information.
* @type {string}
* @memberof DiagnosticInformationMessage
*/
source?: string;
/**
* State of diagnostic information.
* @type {string}
* @memberof DiagnosticInformationMessage
*/
state?: DiagnosticInformationMessage.StateEnum;
/**
* Diagnostic information creation date.
* @type {Date}
* @memberof DiagnosticInformationMessage
*/
timestamp?: Date;
}
/**
* @export
* @namespace DiagnosticInformationMessage
*/
namespace DiagnosticInformationMessage {
/**
* @export
* @enum {string}
*/
enum SeverityEnum {
INFO,
WARN,
ERROR
}
/**
* @export
* @enum {string}
*/
enum StateEnum {
ACCEPTED,
RETRYING,
DROPPED,
PROCESSING,
FINISHED
}
}
/**
*
* @export
* @interface Error
*/
interface Error {
/**
*
* @type {string}
* @memberof Error
*/
id?: string;
/**
*
* @type {string}
* @memberof Error
*/
message?: string;
}
/**
*
* @export
* @interface Forbidden
*/
interface Forbidden {
/**
*
* @type {string}
* @memberof Forbidden
*/
id?: string;
/**
*
* @type {string}
* @memberof Forbidden
*/
message?: string;
}
/**
*
* @export
* @interface Mapping
*/
interface Mapping {
/**
* Unique identifier of the mapping resource
* @type {string}
* @memberof Mapping
*/
id?: string;
/**
* Unique identifier of the agent
* @type {string}
* @memberof Mapping
*/
agentId: string;
/**
* Unique identifier of the data point
* @type {string}
* @memberof Mapping
*/
dataPointId: string;
/**
* Unit of the data point
* @type {string}
* @memberof Mapping
*/
dataPointUnit?: string;
/**
* Type of the data point
* @type {string}
* @memberof Mapping
*/
dataPointType?: Mapping.DataPointTypeEnum;
/**
* Unique identifier of the entity
* @type {string}
* @memberof Mapping
*/
entityId: string;
/**
*
* @type {string}
* @memberof Mapping
*/
propertySetName: string;
/**
*
* @type {string}
* @memberof Mapping
*/
propertyName: string;
/**
*
* @type {string}
* @memberof Mapping
*/
propertyUnit?: string;
/**
*
* @type {string}
* @memberof Mapping
*/
propertyType?: Mapping.PropertyTypeEnum;
/**
*
* @type {boolean}
* @memberof Mapping
*/
qualityEnabled?: boolean;
/**
* Identifies auto deleting mapping or keeping mapping.
* @type {boolean}
* @memberof Mapping
*/
keepMapping?: boolean;
/**
*
* @type {any}
* @memberof Mapping
*/
validity?: any;
}
/**
* @export
* @namespace Mapping
*/
namespace Mapping {
/**
* @export
* @enum {string}
*/
enum DataPointTypeEnum {
INT,
LONG,
DOUBLE,
BOOLEAN,
STRING,
BIGSTRING,
TIMESTAMP
}
/**
* @export
* @enum {string}
*/
enum PropertyTypeEnum {
INT,
LONG,
DOUBLE,
BOOLEAN,
STRING,
BIGSTRING,
TIMESTAMP
}
}
/**
*
* @export
* @interface Notfound
*/
interface Notfound {
/**
*
* @type {string}
* @memberof Notfound
*/
id?: string;
/**
*
* @type {string}
* @memberof Notfound
*/
message?: string;
}
/**
*
* @export
* @interface Order
*/
interface Order {
/**
* The order the property shall be sorted for.
* @type {string}
* @memberof Order
*/
direction?: Order.DirectionEnum;
/**
* The property to order for.
* @type {string}
* @memberof Order
*/
property?: string;
/**
* Whether or not the sort will be case sensitive.
* @type {boolean}
* @memberof Order
*/
ignoreCase?: boolean;
/**
*
* @type {string}
* @memberof Order
*/
nullHandling?: Order.NullHandlingEnum;
/**
* Whether sorting for this property shall be descending.
* @type {boolean}
* @memberof Order
*/
descending?: boolean;
/**
* Whether sorting for this property shall be ascending.
* @type {boolean}
* @memberof Order
*/
ascending?: boolean;
}
/**
* @export
* @namespace Order
*/
namespace Order {
/**
* @export
* @enum {string}
*/
enum DirectionEnum {
ASC,
DESC
}
/**
* @export
* @enum {string}
*/
enum NullHandlingEnum {
NATIVE,
NULLSFIRST,
NULLSLAST
}
}
/**
*
* @export
* @interface PagedDiagnosticActivation
*/
interface PagedDiagnosticActivation {
/**
*
* @type {Array<DiagnosticActivation>}
* @memberof PagedDiagnosticActivation
*/
content: Array<DiagnosticActivation>;
/**
* Whether the current item is the last one.
* @type {boolean}
* @memberof PagedDiagnosticActivation
*/
last: boolean;
/**
* The number of total pages.
* @type {number}
* @memberof PagedDiagnosticActivation
*/
totalPages: number;
/**
* The total amount of elements.
* @type {number}
* @memberof PagedDiagnosticActivation
*/
totalElements: number;
/**
* The number of elements currently on this page.
* @type {number}
* @memberof PagedDiagnosticActivation
*/
numberOfElements: number;
/**
* Whether the current item is the first one.
* @type {boolean}
* @memberof PagedDiagnosticActivation
*/
first: boolean;
/**
* The sorting parameters for the page.
* @type {Array<Order>}
* @memberof PagedDiagnosticActivation
*/
sort: Array<Order>;
/**
* The size of the page.
* @type {number}
* @memberof PagedDiagnosticActivation
*/
size: number;
/**
* The number of the current item.
* @type {number}
* @memberof PagedDiagnosticActivation
*/
number: number;
}
/**
*
* @export
* @interface PagedDiagnosticInformation
*/
interface PagedDiagnosticInformation {
/**
*
* @type {Array<DiagnosticInformation>}
* @memberof PagedDiagnosticInformation
*/
content: Array<DiagnosticInformation>;
/**
* Whether the current item is the last one.
* @type {boolean}
* @memberof PagedDiagnosticInformation
*/
last: boolean;
/**
* The number of total pages.
* @type {number}
* @memberof PagedDiagnosticInformation
*/
totalPages: number;
/**
* The total amount of elements.
* @type {number}
* @memberof PagedDiagnosticInformation
*/
totalElements: number;
/**
* The number of elements currently on this page.
* @type {number}
* @memberof PagedDiagnosticInformation
*/
numberOfElements: number;
/**
* Whether the current item is the first one.
* @type {boolean}
* @memberof PagedDiagnosticInformation
*/
first: boolean;
/**
* The sorting parameters for the page.
* @type {Array<Order>}
* @memberof PagedDiagnosticInformation
*/
sort: Array<Order>;
/**
* The size of the page.
* @type {number}
* @memberof PagedDiagnosticInformation
*/
size: number;
/**
* The number of the current item.
* @type {number}
* @memberof PagedDiagnosticInformation
*/
number: number;
}
/**
*
* @export
* @interface PagedDiagnosticInformationMessages
*/
interface PagedDiagnosticInformationMessages {
/**
*
* @type {Array<DiagnosticInformationMessage>}
* @memberof PagedDiagnosticInformationMessages
*/
content: Array<DiagnosticInformationMessage>;
/**
* Whether the current item is the last one.
* @type {boolean}
* @memberof PagedDiagnosticInformationMessages
*/
last: boolean;
/**
* The number of total pages.
* @type {number}
* @memberof PagedDiagnosticInformationMessages
*/
totalPages: number;
/**
* The total amount of elements.
* @type {number}
* @memberof PagedDiagnosticInformationMessages
*/
totalElements: number;
/**
* The number of elements currently on this page.
* @type {number}
* @memberof PagedDiagnosticInformationMessages
*/
numberOfElements: number;
/**
* Whether the current item is the first one.
* @type {boolean}
* @memberof PagedDiagnosticInformationMessages
*/
first: boolean;
/**
* The sorting parameters for the page.
* @type {Array<Order>}
* @memberof PagedDiagnosticInformationMessages
*/
sort: Array<Order>;
/**
* The size of the page.
* @type {number}
* @memberof PagedDiagnosticInformationMessages
*/
size: number;
/**
* The number of the current item.
* @type {number}
* @memberof PagedDiagnosticInformationMessages
*/
number: number;
}
/**
*
* @export
* @interface PagedMapping
*/
interface PagedMapping {
/**
*
* @type {Array<Mapping>}
* @memberof PagedMapping
*/
content: Array<Mapping>;
/**
* Whether the current item is the last one.
* @type {boolean}
* @memberof PagedMapping
*/
last: boolean;
/**
* The number of total pages.
* @type {number}
* @memberof PagedMapping
*/
totalPages: number;
/**
* The total amount of elements.
* @type {number}
* @memberof PagedMapping
*/
totalElements: number;
/**
* The number of elements currently on this page.
* @type {number}
* @memberof PagedMapping
*/
numberOfElements: number;
/**
* Whether the current item is the first one.
* @type {boolean}
* @memberof PagedMapping
*/
first: boolean;
/**
* The sorting parameters for the page.
* @type {Array<Order>}
* @memberof PagedMapping
*/
sort: Array<Order>;
/**
* The size of the page.
* @type {number}
* @memberof PagedMapping
*/
size: number;
/**
* The number of the current item.
* @type {number}
* @memberof PagedMapping
*/
number: number;
}
/**
*
* @export
* @interface PagedRecoverableRecords
*/
interface PagedRecoverableRecords {
/**
*
* @type {Array<RecoverableRecords>}
* @memberof PagedRecoverableRecords
*/
content: Array<RecoverableRecords>;
/**
* Whether the current item is the last one.
* @type {boolean}
* @memberof PagedRecoverableRecords
*/
last: boolean;
/**
* The number of total pages.
* @type {number}
* @memberof PagedRecoverableRecords
*/
totalPages: number;
/**
* The total amount of elements.
* @type {number}
* @memberof PagedRecoverableRecords
*/
totalElements: number;
/**
* The number of elements currently on this page.
* @type {number}
* @memberof PagedRecoverableRecords
*/
numberOfElements: number;
/**
* Whether the current item is the first one.
* @type {boolean}
* @memberof PagedRecoverableRecords
*/
first: boolean;
/**
* The sorting parameters for the page.
* @type {Array<Order>}
* @memberof PagedRecoverableRecords
*/
sort: Array<Order>;
/**
* The size of the page.
* @type {number}
* @memberof PagedRecoverableRecords
*/
size: number;
/**
* The number of the current item.
* @type {number}
* @memberof PagedRecoverableRecords
*/
number: number;
}
/**
*
* @export
* @interface PayLoadTooLarge
*/
interface PayLoadTooLarge {
/**
*
* @type {string}
* @memberof PayLoadTooLarge
*/
id?: string;
/**
*
* @type {string}
* @memberof PayLoadTooLarge
*/
message?: string;
}
/**
*
* @export
* @interface RecoverableRecords
*/
interface RecoverableRecords {
/**
* Unique identifier of the record
* @type {string}
* @memberof RecoverableRecords
*/
id?: string;
/**
* Unique identifier of the record
* @type {string}
* @memberof RecoverableRecords
*/
correlationId?: string;
/**
* agentId
* @type {string}
* @memberof RecoverableRecords
*/
agentId?: string;
/**
* Ingestion date of the data.
* @type {Date}
* @memberof RecoverableRecords
*/
requestTime?: Date;
/**
* Drop reason of data
* @type {string}
* @memberof RecoverableRecords
*/
dropReason?: string;
}
/**
*
* @export
* @interface Unauthorized
*/
interface Unauthorized {
/**
*
* @type {string}
* @memberof Unauthorized
*/
id?: string;
/**
*
* @type {string}
* @memberof Unauthorized
*/
message?: string;
}
/**
*
* @export
* @interface Validity
*/
interface Validity {
/**
*
* @type {string}
* @memberof Validity
*/
status: Validity.StatusEnum;
/**
*
* @type {Array<string>}
* @memberof Validity
*/
reasons: Array<Validity.ReasonsEnum>;
}
/**
* @export
* @namespace Validity
*/
namespace Validity {
/**
* @export
* @enum {string}
*/
enum StatusEnum {
VALID,
INVALID
}
/**
* @export
* @enum {string}
*/
enum ReasonsEnum {
MISSINGDATAPOINT,
MISSINGPROPERTY,
INVALIDTYPE,
INVALIDUNIT
}
}
}