@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)
89 lines (88 loc) • 2.06 kB
TypeScript
export declare namespace MessageBrokerModels {
/**
*
* @export
* @class RequiredError
* @extends {Error}
*/
class RequiredError extends Error {
field: string;
name: "RequiredError";
constructor(field: string, msg?: string);
}
/**
* Error response body model.
* @export
* @interface Errors
*/
interface Errors {
/**
* Concrete error codes and messages are defined at operation error response descriptions in this API specification.
* @type {Array<ErrorsErrors>}
* @memberof Errors
*/
errors?: Array<ErrorsErrors>;
}
/**
*
* @export
* @interface ErrorsErrors
*/
interface ErrorsErrors {
/**
* Unique error code. Every code is bound to one message.
* @type {string}
* @memberof ErrorsErrors
*/
code: string;
/**
* Logging correlation ID for debugging purposes.
* @type {string}
* @memberof ErrorsErrors
*/
logref: string;
/**
* Human readable error message in English.
* @type {string}
* @memberof ErrorsErrors
*/
message: string;
}
/**
*
* @export
* @interface Messages
*/
interface Messages {
/**
* Message to publish.
* @type {string}
* @memberof Messages
*/
content?: string;
[x: string]: any | undefined;
}
/**
*
* @export
* @interface SubscriberTopicInput
*/
interface SubscriberTopicInput {
/**
*
* @type {WebHookURL}
* @memberof SubscriberTopicInput
*/
uri: WebHookURL;
}
/**
* Id of the topic. Format: mdsp.{tenant}.{service}.v{version}.{type}.{additional}
* @export
*/
type TopicId = string;
/**
* Gateway uri on which the app will receive notifications.
* @export
*/
type WebHookURL = string;
}