export declare namespace DeviceManagementModels { /** * * @export * @class RequiredError * @extends {Error} */ class RequiredError extends Error { field: string; name: "RequiredError"; constructor(field: string, msg?: string); } /** * * @export * @interface Device */ interface Device { /** * id of the device * @type {string} * @memberof Device */ id?: string; /** * id of the Device Type this device belongs to * @type {string} * @memberof Device */ deviceTypeId?: string; /** * serial number of the device * @type {string} * @memberof Device */ serialNumber?: string; /** * creation date of the device * @type {string} * @memberof Device */ createdAt?: string; /** * id of the Asset that created Device will be mapped to * @type {string} * @memberof Device */ assetId?: string; /** * list of ids referring to the Agent(s) that are responsible for this device * @type {Array} * @memberof Device */ agents?: Array; /** * free json block for storing additional properties / characteristics of the device * @type {any} * @memberof Device */ properties?: any; } /** * * @export * @interface DeviceCreation */ interface DeviceCreation { /** * id of the Device Type this device belongs to * @type {string} * @memberof DeviceCreation */ deviceTypeId: string; /** * serial number of the device * @type {string} * @memberof DeviceCreation */ serialNumber?: string; /** * id of the Asset that created Device will be mapped to * @type {string} * @memberof DeviceCreation */ assetId?: string; /** * list of ids referring to the Agent(s) that are responsible for this device * @type {Array} * @memberof DeviceCreation */ agents?: Array; /** * free json block for storing additional properties / characteristics of the device * @type {any} * @memberof DeviceCreation */ properties?: any; } /** * * @export * @interface DeviceType */ interface DeviceType { /** * * @type {string} * @memberof DeviceType */ id?: string; /** * Owner tenant of the device type * @type {string} * @memberof DeviceType */ owner?: string; /** * Unique, user defined text to reference a device type * @type {string} * @memberof DeviceType */ code: string; /** * Unique, Id of the mapped assetTypeId * @type {string} * @memberof DeviceType */ assetTypeId: string; /** * * @type {string} * @memberof DeviceType */ name: string; /** * * @type {string} * @memberof DeviceType */ description: string; /** * creation date of the device type * @type {string} * @memberof DeviceType */ createdAt?: string; /** * free json block for storing additional properties / characteristics of the device type * @type {any} * @memberof DeviceType */ properties?: any; } /** * * @export * @interface DeviceTypeUpdate */ interface DeviceTypeUpdate { /** * * @type {string} * @memberof DeviceTypeUpdate */ name?: string; /** * * @type {string} * @memberof DeviceTypeUpdate */ description?: string; /** * free json block for storing additional properties / characteristics of the device type * @type {any} * @memberof DeviceTypeUpdate */ properties?: any; } /** * * @export * @interface DeviceUpdate */ interface DeviceUpdate { /** * serial number of the device * @type {string} * @memberof DeviceUpdate */ serialNumber?: string; /** * list of ids referring to the Agent(s) that are responsible for this device * @type {Array} * @memberof DeviceUpdate */ agents?: Array; /** * free json block for storing additional properties / characteristics of the device * @type {any} * @memberof DeviceUpdate */ properties?: any; } /** * * @export * @interface ErrorResponse */ interface ErrorResponse { /** * * @type {Array} * @memberof ErrorResponse */ errors?: Array; } /** * * @export * @interface ModelError */ interface ModelError { /** * identifier code for the reason of the error * @type {string} * @memberof ModelError */ code?: string; /** * log correlation ID * @type {string} * @memberof ModelError */ logref?: string; /** * error message * @type {string} * @memberof ModelError */ message?: string; } /** * paginated list of devices * @export * @interface PaginatedDevice */ interface PaginatedDevice { /** * * @type {Array} * @memberof PaginatedDevice */ content?: Array; /** * * @type {any} * @memberof PaginatedDevice */ page?: any; } /** * paginated list of device types * @export * @interface PaginatedDeviceType */ interface PaginatedDeviceType { /** * * @type {Array} * @memberof PaginatedDeviceType */ content?: Array; /** * * @type {any} * @memberof PaginatedDeviceType */ page?: any; } } export declare namespace DeviceStatusModels { /** * * @export * @class RequiredError * @extends {Error} */ class RequiredError extends Error { field: string; name: "RequiredError"; constructor(field: string, msg?: string); } /** * * @export * @interface DataConfigHealth */ interface DataConfigHealth { /** * * @type {Date} * @memberof DataConfigHealth */ lastUpdate?: Date; /** * * @type {string} * @memberof DataConfigHealth */ configurationId: string; /** * * @type {Array} * @memberof DataConfigHealth */ dataSources: Array; } /** * * @export * @interface DataConfigHealthInput */ interface DataConfigHealthInput { /** * * @type {Date} * @memberof DataConfigHealthInput */ lastUpdate?: Date; /** * * @type {string} * @memberof DataConfigHealthInput */ configurationId: string; /** * * @type {Array} * @memberof DataConfigHealthInput */ dataSources: Array; } /** * * @export * @interface DataConfigHealthNestedInput */ interface DataConfigHealthNestedInput { /** * * @type {Date} * @memberof DataConfigHealthNestedInput */ lastUpdate?: Date; /** * * @type {string} * @memberof DataConfigHealthNestedInput */ configurationId: string; /** * * @type {Array} * @memberof DataConfigHealthNestedInput */ dataSources: Array; } /** * * @export * @interface DataPointHealth */ interface DataPointHealth { /** * * @type {Date} * @memberof DataPointHealth */ lastUpdate?: Date; /** * * @type {string} * @memberof DataPointHealth */ dataPointId: string; /** * * @type {HealthStatus} * @memberof DataPointHealth */ health: HealthStatus; /** * * @type {string} * @memberof DataPointHealth */ message?: string; /** * * @type {Date} * @memberof DataPointHealth */ lastErrorTime?: Date; /** * * @type {string} * @memberof DataPointHealth */ lastErrorMessage?: string; /** * * @type {string} * @memberof DataPointHealth */ lastErrorCode?: string; /** * * @type {Date} * @memberof DataPointHealth */ lastSuccessfulReadTime?: Date; } /** * * @export * @interface DataPointHealthNestedInput */ interface DataPointHealthNestedInput { /** * * @type {Date} * @memberof DataPointHealthNestedInput */ lastUpdate?: Date; /** * * @type {string} * @memberof DataPointHealthNestedInput */ dataPointId: string; /** * * @type {HealthStatus} * @memberof DataPointHealthNestedInput */ health: HealthStatus; /** * * @type {string} * @memberof DataPointHealthNestedInput */ message?: string; /** * * @type {string} * @memberof DataPointHealthNestedInput */ errorCode?: string; } /** * * @export * @interface DataSourceHealth */ interface DataSourceHealth { /** * * @type {Date} * @memberof DataSourceHealth */ lastUpdate?: Date; /** * * @type {string} * @memberof DataSourceHealth */ name: string; /** * * @type {string} * @memberof DataSourceHealth */ dataSourceId?: string; /** * * @type {HealthStatus} * @memberof DataSourceHealth */ health: HealthStatus; /** * * @type {string} * @memberof DataSourceHealth */ message?: string; /** * * @type {Array} * @memberof DataSourceHealth */ dataPoints?: Array; } /** * * @export * @interface DataSourceHealthNestedInput */ interface DataSourceHealthNestedInput { /** * * @type {Date} * @memberof DataSourceHealthNestedInput */ lastUpdate?: Date; /** * * @type {string} * @memberof DataSourceHealthNestedInput */ name: string; /** * * @type {string} * @memberof DataSourceHealthNestedInput */ dataSourceId?: string; /** * * @type {HealthStatus} * @memberof DataSourceHealthNestedInput */ health: HealthStatus; /** * * @type {string} * @memberof DataSourceHealthNestedInput */ message?: string; /** * * @type {Array} * @memberof DataSourceHealthNestedInput */ dataPoints?: Array; } /** * * @export * @interface DeviceHealthStatusReport */ interface DeviceHealthStatusReport { /** * * @type {Date} * @memberof DeviceHealthStatusReport */ lastUpdate?: Date; /** * * @type {OverallDeviceHealth} * @memberof DeviceHealthStatusReport */ overall?: OverallDeviceHealth; /** * * @type {DataConfigHealth} * @memberof DeviceHealthStatusReport */ dataConfigHealth?: DataConfigHealth; /** * * @type {{ [key: string]: any; }} * @memberof DeviceHealthStatusReport */ customConfigHealth?: { [key: string]: any; }; } /** * * @export * @interface DeviceHealthStatusReportInput */ interface DeviceHealthStatusReportInput { /** * * @type {OverallDeviceHealth} * @memberof DeviceHealthStatusReportInput */ overall?: OverallDeviceHealth; /** * * @type {DataConfigHealthNestedInput} * @memberof DeviceHealthStatusReportInput */ dataConfigHealth?: DataConfigHealthNestedInput; /** * * @type {{ [key: string]: any; }} * @memberof DeviceHealthStatusReportInput */ customConfigHealth?: { [key: string]: any; }; } /** * * @export * @interface ErrorResponse */ interface ErrorResponse { /** * * @type {Array} * @memberof ErrorResponse */ errors?: Array; } /** * * @export * @enum {string} */ enum HealthStatus { OK, WARNING, ERROR } /** * * @export * @interface Heartbeat */ interface Heartbeat { /** * * @type {Date} * @memberof Heartbeat */ lastUpdate: Date; /** * * @type {boolean} * @memberof Heartbeat */ online: boolean; } /** * collection of installation records for software installed on a device * @export * @interface InventoryApplicationArray */ interface InventoryApplicationArray extends Array { } /** * installation record for a single edge application installed on a device * @export * @interface InventoryApplicationEntry */ interface InventoryApplicationEntry { /** * unique, version independent id of the edge application product * @type {string} * @memberof InventoryApplicationEntry */ softwareId: string; /** * the version of the software; uniquely identifies a edge application release in combination with softwareId * @type {string} * @memberof InventoryApplicationEntry */ version: string; /** * * @type {SoftwareTypeApplication} * @memberof InventoryApplicationEntry */ type: SoftwareTypeApplication; /** * optional; short, human readable description of the edge application, will be displayed directly to end user if the installed edge application is not known to the backend * @type {string} * @memberof InventoryApplicationEntry */ description?: string; /** * optional; time of installation; current time will be used if omitted * @type {Date} * @memberof InventoryApplicationEntry */ installedAt: Date; } /** * collection of installation records for software installed on a device * @export * @interface InventoryArray */ interface InventoryArray extends Array { } /** * installation record for a single software installed on a device * @export * @interface InventoryEntry */ interface InventoryEntry { /** * unique, version independent id of the software product * @type {string} * @memberof InventoryEntry */ softwareId: string; /** * the version of the software; uniquely identifies a software release in combination with softwareId * @type {string} * @memberof InventoryEntry */ version: string; /** * * @type {SoftwareType} * @memberof InventoryEntry */ type: SoftwareType; /** * optional; short, human readable description of the software, will be displayed directly to end user if the installed software is not known to the backend * @type {string} * @memberof InventoryEntry */ description?: string; /** * optional; time of installation; current time will be used if omitted * @type {Date} * @memberof InventoryEntry */ installedAt: Date; } /** * installation record for a single firmware installed on a device * @export * @interface InventoryFirmwareEntry */ interface InventoryFirmwareEntry { /** * unique, version independent id of the firmware product * @type {string} * @memberof InventoryFirmwareEntry */ softwareId: string; /** * the version of the software; uniquely identifies a firmware release in combination with softwareId * @type {string} * @memberof InventoryFirmwareEntry */ version: string; /** * * @type {SoftwareTypeFirmware} * @memberof InventoryFirmwareEntry */ type: SoftwareTypeFirmware; /** * optional; short, human readable description of the firmware, will be displayed directly to end user if the installed firmware is not known to the backend * @type {string} * @memberof InventoryFirmwareEntry */ description?: string; /** * optional; time of installation; current time will be used if omitted * @type {Date} * @memberof InventoryFirmwareEntry */ installedAt: Date; } /** * * @export * @interface ModelError */ interface ModelError { /** * identifier code for the reason of the error * @type {string} * @memberof ModelError */ code?: string; /** * log correlation ID * @type {string} * @memberof ModelError */ logref?: string; /** * error message * @type {string} * @memberof ModelError */ message?: string; } /** * * @export * @interface OnlineStatus */ interface OnlineStatus { /** * * @type {Heartbeat} * @memberof OnlineStatus */ heartbeat: Heartbeat; } /** * * @export * @interface OverallDeviceHealth */ interface OverallDeviceHealth { /** * * @type {Date} * @memberof OverallDeviceHealth */ lastUpdate?: Date; /** * * @type {HealthStatus} * @memberof OverallDeviceHealth */ health: HealthStatus; /** * * @type {string} * @memberof OverallDeviceHealth */ message?: string; } /** * * @export * @interface PaginatedSoftwareInventoryRecord */ interface PaginatedSoftwareInventoryRecord { /** * * @type {Array} * @memberof PaginatedSoftwareInventoryRecord */ content?: Array; /** * * @type {any} * @memberof PaginatedSoftwareInventoryRecord */ page?: any; } /** * information about a software release installed on a device * @export * @interface SoftwareInventoryRecord */ interface SoftwareInventoryRecord { /** * id of the inventory record * @type {string} * @memberof SoftwareInventoryRecord */ id?: string; /** * * @type {string} * @memberof SoftwareInventoryRecord */ deviceId?: string; /** * * @type {string} * @memberof SoftwareInventoryRecord */ softwareType?: SoftwareInventoryRecord.SoftwareTypeEnum; /** * id of the software \"product\" (version independent id) * @type {string} * @memberof SoftwareInventoryRecord */ softwareId?: string; /** * id of the software release (version dependent id) * @type {string} * @memberof SoftwareInventoryRecord */ softwareReleaseId?: string; /** * version number of the software release * @type {string} * @memberof SoftwareInventoryRecord */ version?: string; /** * installation time (accuracy depends on device side implementation) * @type {Date} * @memberof SoftwareInventoryRecord */ installedAt?: Date; /** * source of information, `MANUAL` indicated the device notified the backend that the software is present; SWDEPLOY indicated the software was installed via the software deployment service of the backend * @type {string} * @memberof SoftwareInventoryRecord */ installedBy?: SoftwareInventoryRecord.InstalledByEnum; } /** * @export * @namespace SoftwareInventoryRecord */ namespace SoftwareInventoryRecord { /** * @export * @enum {string} */ enum SoftwareTypeEnum { FIRMWARE, APP } /** * @export * @enum {string} */ enum InstalledByEnum { MANUAL, SWDEPLOY } } /** * the type of software, will be extended over time with new values * @export * @enum {string} */ enum SoftwareType { FIRMWARE, APP } /** * the type representation of edge applications * @export * @enum {string} */ enum SoftwareTypeApplication { APP } /** * the type representation of firmware * @export * @enum {string} */ enum SoftwareTypeFirmware { FIRMWARE } } export declare namespace DeviceConfigurationModels { /** * * @export * @class RequiredError * @extends {Error} */ class RequiredError extends Error { field: string; name: "RequiredError"; constructor(field: string, msg?: string); } /** * * @export * @interface ConfigurationFile */ interface ConfigurationFile { /** * unique \"path\" of the file * @type {string} * @memberof ConfigurationFile */ path: string; /** * optional description of the file's content or purpose * @type {string} * @memberof ConfigurationFile */ description?: string; } /** * * @export * @interface ConfigurationFileReference */ interface ConfigurationFileReference { /** * name of the file * @type {string} * @memberof ConfigurationFileReference */ name: string; /** * download URI * @type {string} * @memberof ConfigurationFileReference */ uri: string; /** * hash of the file in format `:` * @type {string} * @memberof ConfigurationFileReference */ checksum: string; } /** * information about a single state of the state machine * @export * @interface ConfigurationStateInfo */ interface ConfigurationStateInfo { /** * date and time when the state was first entered * @type {Date} * @memberof ConfigurationStateInfo */ entered?: Date; /** * date and time the state was last updated, will differ from \"entered\" if state is updated repeatedly * @type {Date} * @memberof ConfigurationStateInfo */ updated?: Date; /** * progress in current state as value in [0.0, 1.0] * @type {number} * @memberof ConfigurationStateInfo */ progress?: number; /** * status message / info, free text from device * @type {string} * @memberof ConfigurationStateInfo */ message?: string; /** * arbitrary block of json data, should be used to report additional information such as error details, stack traces, etc; max size in string representation is 20k * @type {any} * @memberof ConfigurationStateInfo */ details?: any; /** * name of the state * @type {string} * @memberof ConfigurationStateInfo */ state?: ConfigurationStateInfo.StateEnum; } /** * @export * @namespace ConfigurationStateInfo */ namespace ConfigurationStateInfo { /** * @export * @enum {string} */ enum StateEnum { CREATED, CONFIGURE, CONFIGURING, CONFIGURED, CANCELED, FAILED } } /** * a configuration update task * @export * @interface ConfigurationTask */ interface ConfigurationTask { /** * unique id of the task * @type {string} * @memberof ConfigurationTask */ id?: string; /** * unique id of the device owning the task * @type {string} * @memberof ConfigurationTask */ deviceId?: string; /** * list of files to be updated as part of this task * @type {Array} * @memberof ConfigurationTask */ files?: Array; /** * optional; arbitrary, user defined block of json containing additional information for the device * @type {any} * @memberof ConfigurationTask */ customData?: any; /** * creation time of the task * @type {Date} * @memberof ConfigurationTask */ createdAt?: Date; /** * * @type {ConfigurationStateInfo} * @memberof ConfigurationTask */ currentState?: ConfigurationStateInfo; /** * * @type {Target} * @memberof ConfigurationTask */ target?: Target; /** * list of history to be updated as part of this task * @type {Array} * @memberof ConfigurationTask */ history?: Array; /** * list of history to be updated as part of this task * @type {Array} * @memberof ConfigurationTask */ transitions?: Array; } /** * * @export * @interface ErrorResponse */ interface ErrorResponse { /** * * @type {Array} * @memberof ErrorResponse */ errors?: Array; } /** * * @export * @interface FileMetaData */ interface FileMetaData { /** * * @type {string} * @memberof FileMetaData */ description?: string; /** * * @type {string} * @memberof FileMetaData */ head?: string; /** * * @type {string} * @memberof FileMetaData */ id?: string; /** * * @type {string} * @memberof FileMetaData */ path?: string; } /** * paginated list of files meta data * @export * @interface PaginatedFileMetaData */ interface PaginatedFileMetaData { /** * * @type {Array} * @memberof PaginatedFileMetaData */ content?: Array; /** * * @type {any} * @memberof PaginatedFileMetaData */ page?: any; } /** * * @export * @interface ModelError */ interface ModelError { /** * identifier code for the reason of the error * @type {string} * @memberof ModelError */ code?: string; /** * log correlation ID * @type {string} * @memberof ModelError */ logref?: string; /** * error message * @type {string} * @memberof ModelError */ message?: string; } /** * paginated list of configuration update tasks * @export * @interface PaginatedConfigurationTask */ interface PaginatedConfigurationTask { /** * * @type {Array} * @memberof PaginatedConfigurationTask */ content?: Array; /** * * @type {any} * @memberof PaginatedConfigurationTask */ page?: any; } /** * Content of the file * @export * @interface Payload */ interface Payload { } /** * * @export * @interface RevisionMetaData */ interface RevisionMetaData { /** * the hash of the file revision, also serves as unique identifier of the revision (content based addressing) * @type {string} * @memberof RevisionMetaData */ hash?: string; /** * the id of the file this revision belongs to * @type {string} * @memberof RevisionMetaData */ fileId?: string; /** * length of the content (=file size in bytes) * @type {number} * @memberof RevisionMetaData */ contentLength?: number; /** * content type of the content as used by http (MIME type + charset or other attributes) * @type {string} * @memberof RevisionMetaData */ contentType?: string; } /** * paginated list of files meta data * @export * @interface PaginatedRevisionMetaData */ interface PaginatedRevisionMetaData { /** * * @type {Array} * @memberof PaginatedRevisionMetaData */ content?: Array; /** * * @type {any} * @memberof PaginatedRevisionMetaData */ page?: any; } /** * target of the task in the device * @export * @interface Target */ interface Target { /** * target address of the task in the device * @type {string} * @memberof Target */ address?: string; } /** * * @export * @interface TaskDefinition */ interface TaskDefinition { /** * * @type {Array} * @memberof TaskDefinition */ files: Array; /** * optional; arbitrary, user defined block of json containing additional information for the device * @type {{ [key: string]: any; }} * @memberof TaskDefinition */ customData?: { [key: string]: any; }; /** * optional; arbitrary, user defined block of json containing target * @type {any} * @memberof TaskDefinition */ target?: any; } /** * a transition state * @export * @interface Transition */ interface Transition { /** * current transition of the task * @type {string} * @memberof Transition */ from?: string; /** * next transition of the task * @type {string} * @memberof Transition */ to?: string; } /** * * @export * @interface Updatetask */ interface Updatetask { /** * * @type {string} * @memberof Updatetask */ state: Updatetask.StateEnum; /** * progress in current state as value in [0.0, 1.0] * @type {number} * @memberof Updatetask */ progress: number; /** * optional; status message / info, free text from device * @type {string} * @memberof Updatetask */ message?: string; /** * optional; arbitrary block of json data, should be used to report additional information such as error details, stack traces, etc; max size in string representation is 20k * @type {any} * @memberof Updatetask */ details?: any; } /** * @export * @namespace Updatetask */ namespace Updatetask { /** * @export * @enum {string} */ enum StateEnum { CONFIGURING, CONFIGURED, CANCELED, FAILED } } } export declare namespace DeploymentWorkflowModels { /** * * @export * @class RequiredError * @extends {Error} */ class RequiredError extends Error { field: string; name: "RequiredError"; constructor(field: string, msg?: string); } /** * * @export * @interface CustomTransition */ interface CustomTransition { /** * * @type {string} * @memberof CustomTransition */ from: string; /** * * @type {string} * @memberof CustomTransition */ to: string; /** * * @type {TransitionType} * @memberof CustomTransition */ type: TransitionType; /** * * @type {{ [key: string]: any; }} * @memberof CustomTransition */ details?: { [key: string]: any; }; } /** * * @export * @interface ErrorResponse */ interface ErrorResponse { /** * * @type {Array} * @memberof ErrorResponse */ errors?: Array; } /** * * @export * @interface Instance */ interface Instance { /** * * @type {string} * @memberof Instance */ id?: string; /** * * @type {string} * @memberof Instance */ deviceId?: string; /** * date and time when the instance was created * @type {Date} * @memberof Instance */ createdAt?: Date; /** * * @type {StateInfo} * @memberof Instance */ currentState?: StateInfo; /** * * @type {Array} * @memberof Instance */ history?: Array; /** * * @type {InstanceModel} * @memberof Instance */ model?: InstanceModel; /** * * @type {{ [key: string]: any; }} * @memberof Instance */ data?: { [key: string]: any; }; } /** * * @export * @interface InstanceModel */ interface InstanceModel { /** * * @type {string} * @memberof InstanceModel */ key?: string; /** * * @type {Array} * @memberof InstanceModel */ states?: Array; /** * * @type {Array} * @memberof InstanceModel */ transitions?: Array; /** * * @type {Array} * @memberof InstanceModel */ stateGroups?: Array; } /** * * @export * @interface InstanceRequest */ interface InstanceRequest { /** * * @type {string} * @memberof InstanceRequest */ deviceId?: string; /** * * @type {ModelCustomization} * @memberof InstanceRequest */ model?: ModelCustomization; /** * * @type {{ [key: string]: any; }} * @memberof InstanceRequest */ data?: { [key: string]: any; }; } /** * * @export * @interface Model */ interface Model { /** * User provided unique model name * @type {string} * @memberof Model */ key?: string; /** * * @type {Array} * @memberof Model */ states?: Array; /** * * @type {Array} * @memberof Model */ transitions?: Array; /** * * @type {Array} * @memberof Model */ groups?: Array; } /** * * @export * @interface ModelCustomization */ interface ModelCustomization { /** * * @type {string} * @memberof ModelCustomization */ key?: string; /** * * @type {Array} * @memberof ModelCustomization */ customTransitions?: Array; } /** * * @export * @interface ModelError */ interface ModelError { /** * identifier code for the reason of the error * @type {string} * @memberof ModelError */ code?: string; /** * log correlation ID * @type {string} * @memberof ModelError */ logref?: string; /** * error message * @type {string} * @memberof ModelError */ message?: string; } /** * paginated list of instances * @export * @interface PaginatedInstanceList */ interface PaginatedInstanceList { /** * * @type {Array} * @memberof PaginatedInstanceList */ content?: Array; /** * * @type {any} * @memberof PaginatedInstanceList */ page?: any; } /** * * @export * @interface State */ interface State { /** * * @type {string} * @memberof State */ name: string; /** * * @type {string} * @memberof State */ description: string; /** * * @type {boolean} * @memberof State */ initial?: boolean; /** * * @type {boolean} * @memberof State */ _final?: boolean; /** * * @type {boolean} * @memberof State */ cancel?: boolean; } /** * * @export * @interface StateGroup */ interface StateGroup { /** * * @type {string} * @memberof StateGroup */ name?: string; /** * * @type {Array} * @memberof StateGroup */ states?: Array; } /** * information about a single state of the state machine * @export * @interface StateInfo */ interface StateInfo { /** * date and time when the state was first entered * @type {Date} * @memberof StateInfo */ entered?: Date; /** * date and time the state was last updated, will differ from \"entered\" if state is updated repeatedly * @type {Date} * @memberof StateInfo */ updated?: Date; /** * progress in current state as value in [0.0, 1.0] * @type {number} * @memberof StateInfo */ progress?: number; /** * status message / info, free text from device * @type {string} * @memberof StateInfo */ message?: string; /** * arbitrary block of json data, should be used to report additional information such as error details, stack traces, etc; max size in string representation is 20k * @type {{ [key: string]: any; }} * @memberof StateInfo */ details?: { [key: string]: any; }; /** * name of the state * @type {string} * @memberof StateInfo */ state?: string; } /** * * @export * @interface Transition */ interface Transition { /** * * @type {string} * @memberof Transition */ from: string; /** * * @type {string} * @memberof Transition */ to: string; /** * * @type {TransitionType} * @memberof Transition */ type: TransitionType; /** * * @type {Array} * @memberof Transition */ allowedTypes?: Array; } /** * * @export * @enum {string} */ enum TransitionType { INSTANTANEOUS, BACKENDTRIGGER, DEVICETRIGGER, BACKENDTIMETRIGGER, DEVICETIMETRIGGER } } export declare namespace EdgeAppInstanceModels { /** * * @export * @class RequiredError * @extends {Error} */ class RequiredError extends Error { field: string; name: "RequiredError"; constructor(field: string, msg?: string); } /** * * @export * @interface ApplicationInstance */ interface ApplicationInstance { /** * * @type {string} * @memberof ApplicationInstance */ name: string; /** * * @type {string} * @memberof ApplicationInstance */ appInstanceId: string; /** * * @type {string} * @memberof ApplicationInstance */ deviceId: string; /** * * @type {string} * @memberof ApplicationInstance */ releaseId: string; /** * * @type {string} * @memberof ApplicationInstance */ applicationId: string; } /** * paginated list of app instance configurations * @export * @interface PaginatedApplicationInstance */ interface PaginatedApplicationInstance { /** * * @type {Array} * @memberof PaginatedApplicationInstance */ content?: Array; /** * * @type {any} * @memberof PaginatedApplicationInstance */ page?: any; } /** * * @export * @interface ApplicationInstanceLifeCycleResource */ interface ApplicationInstanceLifeCycleResource { /** * * @type {string} * @memberof ApplicationInstanceLifeCycleResource */ id?: string; /** * * @type {string} * @memberof ApplicationInstanceLifeCycleResource */ status?: ApplicationInstanceLifeCycleResource.StatusEnum; } /** * @export * @namespace ApplicationInstanceLifeCycleResource */ namespace ApplicationInstanceLifeCycleResource { /** * @export * @enum {string} */ enum StatusEnum { STOPPED, RUNNING } } /** * * @export * @interface ApplicationInstanceLifeCycleStatus */ interface ApplicationInstanceLifeCycleStatus { /** * * @type {string} * @memberof ApplicationInstanceLifeCycleStatus */ status?: ApplicationInstanceLifeCycleStatus.StatusEnum; } /** * @export * @namespace ApplicationInstanceLifeCycleStatus */ namespace ApplicationInstanceLifeCycleStatus { /** * @export * @enum {string} */ enum StatusEnum { STOPPED, RUNNING } } /** * * @export * @interface ApplicationInstanceResource */ interface ApplicationInstanceResource { /** * * @type {string} * @memberof ApplicationInstanceResource */ id?: string; /** * * @type {string} * @memberof ApplicationInstanceResource */ name?: string; /** * * @type {string} * @memberof ApplicationInstanceResource */ deviceId?: string; /** * * @type {string} * @memberof ApplicationInstanceResource */ releaseId?: string; /** * * @type {string} * @memberof ApplicationInstanceResource */ applicationId?: string; /** * * @type {string} * @memberof ApplicationInstanceResource */ status?: ApplicationInstanceResource.StatusEnum; } /** * @export * @namespace ApplicationInstanceResource */ namespace ApplicationInstanceResource { /** * @export * @enum {string} */ enum StatusEnum { STOPPED, RUNNING } } /** * * @export * @interface ErrorResponse */ interface ErrorResponse { /** * * @type {Array} * @memberof ErrorResponse */ errors?: Array; } /** * * @export * @interface InstanceConfiguration */ interface InstanceConfiguration { /** * ID of the device * @type {string} * @memberof InstanceConfiguration */ deviceId: string; /** * ID of the application product * @type {string} * @memberof InstanceConfiguration */ appId: string; /** * ID of the application release * @type {string} * @memberof InstanceConfiguration */ appReleaseId: string; /** * ID of the application instance * @type {string} * @memberof InstanceConfiguration */ appInstanceId: string; /** * User defined custom properties * @type {{ [key: string]: any; }} * @memberof InstanceConfiguration */ configuration: { [key: string]: any; }; } /** * * @export * @interface InstanceConfigurationResource */ interface InstanceConfigurationResource { /** * ID of the device * @type {string} * @memberof InstanceConfigurationResource */ deviceId?: string; /** * ID of the application product * @type {string} * @memberof InstanceConfigurationResource */ appId?: string; /** * ID of the application release * @type {string} * @memberof InstanceConfigurationResource */ appReleaseId?: string; /** * ID of the application instance * @type {string} * @memberof InstanceConfigurationResource */ appInstanceId?: string; /** * User defined custom properties * @type {{ [key: string]: any; }} * @memberof InstanceConfigurationResource */ configuration?: { [key: string]: any; }; } /** * paginated list of app instance configurations * @export * @interface PaginatedInstanceConfigurationResource */ interface PaginatedInstanceConfigurationResource { /** * * @type {Array} * @memberof PaginatedInstanceConfigurationResource */ content?: Array; /** * * @type {any} * @memberof PaginatedInstanceConfigurationResource */ page?: any; } /** * * @export * @interface ProcessInstanceConfiguration */ interface ProcessInstanceConfiguration { /** * * @type {Array} * @memberof ProcessInstanceConfiguration */ instanceConfigurations?: Array; } } export declare namespace EdgeAppDeploymentModels { /** * * @export */ const COLLECTION_FORMATS: { csv: string; ssv: string; tsv: string; pipes: string; }; /** * * @export * @class RequiredError * @extends {Error} */ class RequiredError extends Error { field: string; name: "RequiredError"; constructor(field: string, msg?: string); } /** * * @export * @interface ErrorResponse */ interface ErrorResponse { /** * * @type {Array} * @memberof ErrorResponse */ errors?: Array; } /** * * @export * @interface Task */ interface Task { /** * ID of the device (Will be taken from path if omitted) * @type {string} * @memberof Task */ deviceId: string; /** * Globally unique ID of the software product (Version independent) * @type {string} * @memberof Task */ softwareId: string; /** * Globally unique ID of the release (Version dependent) * @type {string} * @memberof Task */ softwareReleaseId: string; /** * Arbitrary, user defined block of json contaning additional information for the device * @type {{ [key: string]: any; }} * @memberof Task */ customData?: { [key: string]: any; }; } /** * * @export * @interface TaskResource */ interface TaskResource { /** * ID of the task * @type {string} * @memberof TaskResource */ id?: string; /** * ID of the device owning the task * @type {string} * @memberof TaskResource */ deviceId?: string; /** * Type of software artifact * @type {string} * @memberof TaskResource */ softwareType?: TaskResource.SoftwareTypeEnum; /** * Globally unique ID of the software product (Version independent) * @type {string} * @memberof TaskResource */ softwareId?: string; /** * Globally unique ID of the software release (Version dependent) * @type {string} * @memberof TaskResource */ softwareReleaseId?: string; /** * The version of the software release as human readable string * @type {string} * @memberof TaskResource */ softwareVersion?: string; /** * * @type {any} * @memberof TaskResource */ transitions?: any; /** * * @type {any} * @memberof TaskResource */ history?: any; /** * * @type {Array} * @memberof TaskResource */ artifacts?: Array; /** * Arbitrary, user defined block of json containing additional information for the device * @type {{ [key: string]: any; }} * @memberof TaskResource */ customData?: { [key: string]: any; }; /** * Datetime when the task was created * @type {Date} * @memberof TaskResource */ createdAt?: Date; /** * * @type {any} * @memberof TaskResource */ currentState?: any; } /** * paginated list of task ressources * @export * @interface PaginatedTaskResource */ interface PaginatedTaskResource { /** * * @type {Array} * @memberof PaginatedTaskResource */ content?: Array; /** * * @type {any} * @memberof PaginatedTaskResource */ page?: any; } /** * @export * @namespace TaskResource */ namespace TaskResource { /** * @export * @enum {string} */ enum SoftwareTypeEnum { APP } } /** * * @export * @interface TaskStatus */ interface TaskStatus { /** * The new state of the task (might be same as current state) * @type {string} * @memberof TaskStatus */ state: TaskStatus.StateEnum; /** * Progress in current state as value in [0.0, 1.0] * @type {number} * @memberof TaskStatus */ progress: number; /** * Status message * @type {string} * @memberof TaskStatus */ message?: string; /** * Arbitrary block of json data, should be used to report additional information such as error details, stack traces and etc * @type {{ [key: string]: any; }} * @memberof TaskStatus */ details?: { [key: string]: any; }; } /** * @export * @namespace TaskStatus */ namespace TaskStatus { /** * @export * @enum {string} */ enum StateEnum { DOWNLOAD, INSTALL, ACTIVATE, CANCELED, FAILED } } /** * * @export * @interface TermsAndConditions */ interface TermsAndConditions { /** * ID of the device * @type {string} * @memberof TermsAndConditions */ deviceId: string; /** * ID of the application release * @type {string} * @memberof TermsAndConditions */ releaseId: string; } /** * * @export * @interface TermsAndConditionsResource */ interface TermsAndConditionsResource { /** * ID of the device * @type {string} * @memberof TermsAndConditionsResource */ deviceId?: string; /** * ID of the application release * @type {string} * @memberof TermsAndConditionsResource */ releaseId?: string; /** * * @type {Date} * @memberof TermsAndConditionsResource */ firstAccepted?: Date; } } export declare namespace FirmwareDeploymentModels { /** * * @export */ const COLLECTION_FORMATS: { csv: string; ssv: string; tsv: string; pipes: string; }; /** * * @export * @class RequiredError * @extends {Error} */ class RequiredError extends Error { field: string; name: "RequiredError"; constructor(field: string, msg?: string); } /** * * @export * @interface ErrorResponse */ interface ErrorResponse { /** * * @type {Array} * @memberof ErrorResponse */ errors?: Array; } /** * * @export * @interface InstallationArtifact */ interface InstallationArtifact { /** * name of the file * @type {string} * @memberof InstallationArtifact */ name: string; /** * download URI * @type {string} * @memberof InstallationArtifact */ uri: string; /** * hash of the file in format `:` * @type {string} * @memberof InstallationArtifact */ checksum: string; /** * expiry time for `uri` * @type {Date} * @memberof InstallationArtifact */ validUntil?: Date; } /** * information about a single state of the state machine * @export * @interface InstallationStateInfo */ interface InstallationStateInfo { /** * date and time when the state was first entered * @type {Date} * @memberof InstallationStateInfo */ entered?: Date; /** * date and time the state was last updated, will differ from \"entered\" if state is updated repeatedly * @type {Date} * @memberof InstallationStateInfo */ updated?: Date; /** * progress in current state as value in [0.0, 1.0] * @type {number} * @memberof InstallationStateInfo */ progress?: number; /** * status message / info, free text from device * @type {string} * @memberof InstallationStateInfo */ message?: string; /** * arbitrary block of json data, should be used to report additional information such as error details, stack traces, etc; max size in string representation is 20k * @type {any} * @memberof InstallationStateInfo */ details?: any; /** * name of the state * @type {string} * @memberof InstallationStateInfo */ state?: InstallationStateInfo.StateEnum; } /** * @export * @namespace InstallationStateInfo */ namespace InstallationStateInfo { /** * @export * @enum {string} */ enum StateEnum { CREATED, DOWNLOAD, DOWNLOADING, DOWNLOADED, INSTALL, INSTALLING, INSTALLED, ACTIVATE, ACTIVATING, ACTIVATED, CANCELED, FAILED } } /** * single task * @export * @interface InstallationTask */ interface InstallationTask { /** * globally unique id of the task * @type {string} * @memberof InstallationTask */ id?: string; /** * id of the device owning the task * @type {string} * @memberof InstallationTask */ deviceId?: string; /** * type of software artifact: firmware, app, etc; list will be extended in future releases * @type {string} * @memberof InstallationTask */ softwareType?: InstallationTask.SoftwareTypeEnum; /** * globally unique id of the software product (version independent id) * @type {string} * @memberof InstallationTask */ softwareId?: string; /** * globally unique id of the specific release (version dependent) * @type {string} * @memberof InstallationTask */ softwareReleaseId?: string; /** * the version of the software as human readable string * @type {string} * @memberof InstallationTask */ softwareVersion?: string; /** * Indicates whether to install or remove the software * @type {string} * @memberof InstallationTask */ actionType?: InstallationTask.ActionTypeEnum; /** * if set to true, task is going to be cancelled * @type {boolean} * @memberof InstallationTask */ shouldCancel?: boolean; /** * possible set of transitions * @type {Array} * @memberof InstallationTask */ transitions?: Array; /** * previously passed states of task * @type {Array} * @memberof InstallationTask */ history?: Array; /** * * @type {Array} * @memberof InstallationTask */ artifacts?: Array; /** * optional; arbitrary, user defined block of json containing additional information for the device * @type {{ [key: string]: any; }} * @memberof InstallationTask */ customData?: { [key: string]: any; }; /** * date and time when the task was created * @type {Date} * @memberof InstallationTask */ createdAt?: Date; /** * * @type {InstallationStateInfo} * @memberof InstallationTask */ currentState?: InstallationStateInfo; } /** * @export * @namespace InstallationTask */ namespace InstallationTask { /** * @export * @enum {string} */ enum SoftwareTypeEnum { FIRMWARE, APP } /** * @export * @enum {string} */ enum ActionTypeEnum { INSTALL, REMOVE } } /** * * @export * @interface InstallationTaskInfo */ interface InstallationTaskInfo { /** * optional, id of the device; will be taken from path if omitted * @type {string} * @memberof InstallationTaskInfo */ deviceId?: string; /** * type of software artifact (firmware, app, etc); list will be extended in future releases * @type {string} * @memberof InstallationTaskInfo */ softwareType: InstallationTaskInfo.SoftwareTypeEnum; /** * globally unique id of the software product (version independent id) * @type {string} * @memberof InstallationTaskInfo */ softwareId: string; /** * globally unique id of the specific release (version dependent) * @type {string} * @memberof InstallationTaskInfo */ softwareReleaseId: string; /** * custom transitions * @type {Array} * @memberof InstallationTaskInfo */ transitions?: Array; /** * optional; arbitrary, user defined block of json containing additional information for the device * @type {{ [key: string]: any; }} * @memberof InstallationTaskInfo */ customData?: { [key: string]: any; }; } /** * @export * @namespace InstallationTaskInfo */ namespace InstallationTaskInfo { /** * @export * @enum {string} */ enum SoftwareTypeEnum { FIRMWARE, APP } } /** * * @export * @interface ModelError */ interface ModelError { /** * identifier code for the reason of the error * @type {string} * @memberof ModelError */ code?: string; /** * log correlation ID * @type {string} * @memberof ModelError */ logref?: string; /** * error message * @type {string} * @memberof ModelError */ message?: string; } /** * paginated list of configuration update tasks * @export * @interface PaginatedInstallationTask */ interface PaginatedInstallationTask { /** * * @type {Array} * @memberof PaginatedInstallationTask */ content?: Array; /** * * @type {any} * @memberof PaginatedInstallationTask */ page?: any; } /** * backend sent progress update * @export * @interface TaskUpdate */ interface TaskUpdate { /** * the new state of the task (might be same as current state) * @type {string} * @memberof TaskUpdate */ state: TaskUpdate.StateEnum; /** * progress in current state as value in [0.0, 1.0] * @type {number} * @memberof TaskUpdate */ progress: number; /** * optional; status message / info, free text from backend * @type {string} * @memberof TaskUpdate */ message?: string; /** * arbitrary block of json data, should be used to report additional information such as error details, stack traces, etc; max size in string representation is 20k * @type {any} * @memberof TaskUpdate */ details?: any; } /** * @export * @namespace TaskUpdate */ namespace TaskUpdate { /** * @export * @enum {string} */ enum StateEnum { CREATED, DOWNLOAD, DOWNLOADING, DOWNLOADED, INSTALL, INSTALLING, INSTALLED, ACTIVATE, ACTIVATING, ACTIVATED, CANCELED, FAILED } } /** * * @export * @interface TermsAndConditionsAcceptance */ interface TermsAndConditionsAcceptance { /** * * @type {string} * @memberof TermsAndConditionsAcceptance */ deviceId?: string; /** * * @type {string} * @memberof TermsAndConditionsAcceptance */ releaseId?: string; } /** * * @export * @interface TermsAndConditionsRecord */ interface TermsAndConditionsRecord { /** * * @type {string} * @memberof TermsAndConditionsRecord */ deviceId?: string; /** * * @type {string} * @memberof TermsAndConditionsRecord */ releaseId?: string; /** * * @type {Date} * @memberof TermsAndConditionsRecord */ firstAccepted?: Date; /** * * @type {string} * @memberof TermsAndConditionsRecord */ softwareId?: string; /** * * @type {string} * @memberof TermsAndConditionsRecord */ bundleId?: string; } /** * Information about the transition status * @export * @interface Transition */ interface Transition { /** * type of the transition * @type {string} * @memberof Transition */ type?: string; /** * name of the state * @type {string} * @memberof Transition */ from?: Transition.FromEnum; /** * name of the state * @type {string} * @memberof Transition */ to?: Transition.ToEnum; /** * * @type {any} * @memberof Transition */ details?: any; } /** * @export * @namespace Transition */ namespace Transition { /** * @export * @enum {string} */ enum FromEnum { CREATED, DOWNLOAD, DOWNLOADING, DOWNLOADED, INSTALL, INSTALLING, INSTALLED, ACTIVATE, ACTIVATING, ACTIVATED, CANCELED, FAILED } /** * @export * @enum {string} */ enum ToEnum { CREATED, DOWNLOAD, DOWNLOADING, DOWNLOADED, INSTALL, INSTALLING, INSTALLED, ACTIVATE, ACTIVATING, ACTIVATED, CANCELED, FAILED } } }