@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)
604 lines (603 loc) • 12.1 kB
TypeScript
export declare namespace TenantManagementModels {
/**
*
* @export
* @class RequiredError
* @extends {Error}
*/
class RequiredError extends Error {
field: string;
name: "RequiredError";
constructor(field: string, msg?: string);
}
/**
*
* @export
* @interface ErrorResponse
*/
interface ErrorResponse {
/**
*
* @type {string}
* @memberof ErrorResponse
*/
errorMessage?: string;
/**
*
* @type {string}
* @memberof ErrorResponse
*/
errorType?: ErrorResponse.ErrorTypeEnum;
/**
*
* @type {Array<FieldError>}
* @memberof ErrorResponse
*/
fieldErrors?: Array<FieldError>;
/**
*
* @type {string}
* @memberof ErrorResponse
*/
logref?: string;
}
/**
* @export
* @namespace ErrorResponse
*/
namespace ErrorResponse {
/**
* @export
* @enum {string}
*/
enum ErrorTypeEnum {
FIELDERROR,
UNEXPECTEDERROR,
INVALIDSTATE,
PARSINGERROR
}
}
/**
*
* @export
* @interface FieldError
*/
interface FieldError {
/**
*
* @type {string}
* @memberof FieldError
*/
errorMessage?: string;
/**
*
* @type {string}
* @memberof FieldError
*/
errorType?: FieldError.ErrorTypeEnum;
/**
*
* @type {string}
* @memberof FieldError
*/
field?: string;
}
/**
* @export
* @namespace FieldError
*/
namespace FieldError {
/**
* @export
* @enum {string}
*/
enum ErrorTypeEnum {
INVALIDINPUT,
VALIDATIONERROR,
NOTALLOWED,
UNIQUECONSTRAINTERROR
}
}
/**
*
* @export
* @interface LegalConfiguration
*/
interface LegalConfiguration {
/**
*
* @type {Array<Region>}
* @memberof LegalConfiguration
*/
regions: Array<Region>;
}
/**
*
* @export
* @interface LegalConfigurationResource
*/
interface LegalConfigurationResource {
/**
*
* @type {Array<RegionResource>}
* @memberof LegalConfigurationResource
*/
regions?: Array<RegionResource>;
}
/**
*
* @export
* @interface Link
*/
interface Link {
/**
*
* @type {string}
* @memberof Link
*/
name: string;
/**
*
* @type {string}
* @memberof Link
*/
value: string;
}
/**
*
* @export
* @interface LinkCollection
*/
interface LinkCollection {
/**
*
* @type {string}
* @memberof LinkCollection
*/
id: string;
/**
*
* @type {string}
* @memberof LinkCollection
*/
type: LinkCollection.TypeEnum;
/**
*
* @type {number}
* @memberof LinkCollection
*/
sorting?: number;
/**
*
* @type {{ [key: string]: Link; }}
* @memberof LinkCollection
*/
languages: {
[key: string]: Link;
};
}
/**
* @export
* @namespace LinkCollection
*/
namespace LinkCollection {
/**
* @export
* @enum {string}
*/
enum TypeEnum {
Www,
Phone,
Mail
}
}
/**
* Legal Info
*
* ! Fix: This was manually created in 3.12.0 as MindSphere has a copy/paste error
* ! saying that LegalInfo methods return LegalConfiguration
*
* @export
* @interface LegalInfo
*/
interface LegalInfo {
[key: string]: LegalInfoLink[];
}
/**
* Legal Info Link
*
* ! Fix: This was manually created in 3.12.0 as MindSphere has a copy/paste error
* ! saying that LegalInfo methods return LegalConfiguration
*
* @export
* @interface LegalInfoLink
*/
interface LegalInfoLink {
id: string;
type: string;
name: string;
value: string;
}
/**
*
* @export
* @interface MdspError
*/
interface MdspError {
/**
*
* @type {string}
* @memberof MdspError
*/
code?: string;
/**
*
* @type {string}
* @memberof MdspError
*/
logref?: string;
/**
*
* @type {string}
* @memberof MdspError
*/
message?: string;
}
/**
*
* @export
* @interface MdspErrors
*/
interface MdspErrors {
/**
*
* @type {Array<MdspError>}
* @memberof MdspErrors
*/
errors?: Array<MdspError>;
}
/**
*
* @export
* @interface PageSubtenantResource
*/
interface PageSubtenantResource {
/**
*
* @type {Array<SubtenantResource>}
* @memberof PageSubtenantResource
*/
content?: Array<SubtenantResource>;
/**
*
* @type {boolean}
* @memberof PageSubtenantResource
*/
first?: boolean;
/**
*
* @type {boolean}
* @memberof PageSubtenantResource
*/
last?: boolean;
/**
*
* @type {number}
* @memberof PageSubtenantResource
*/
number?: number;
/**
*
* @type {number}
* @memberof PageSubtenantResource
*/
numberOfElements?: number;
/**
*
* @type {number}
* @memberof PageSubtenantResource
*/
size?: number;
/**
*
* @type {Sort}
* @memberof PageSubtenantResource
*/
sort?: Sort;
/**
*
* @type {number}
* @memberof PageSubtenantResource
*/
totalElements?: number;
/**
*
* @type {number}
* @memberof PageSubtenantResource
*/
totalPages?: number;
}
/**
*
* @export
* @interface Region
*/
interface Region {
/**
*
* @type {string}
* @memberof Region
*/
regionId?: string;
/**
*
* @type {string}
* @memberof Region
*/
regionName: string;
/**
*
* @type {Array<string>}
* @memberof Region
*/
regionCountries?: Array<string>;
/**
*
* @type {Array<LinkCollection>}
* @memberof Region
*/
links?: Array<LinkCollection>;
}
/**
*
* @export
* @interface RegionResource
*/
interface RegionResource {
/**
*
* @type {number}
* @memberof RegionResource
*/
ETag?: number;
/**
*
* @type {Array<LinkCollection>}
* @memberof RegionResource
*/
links?: Array<LinkCollection>;
/**
*
* @type {Array<string>}
* @memberof RegionResource
*/
regionCountries?: Array<string>;
/**
*
* @type {string}
* @memberof RegionResource
*/
regionId?: string;
/**
*
* @type {string}
* @memberof RegionResource
*/
regionName?: string;
}
/**
*
* @export
* @interface Sort
*/
interface Sort {
/**
*
* @type {boolean}
* @memberof Sort
*/
sorted?: boolean;
/**
*
* @type {boolean}
* @memberof Sort
*/
unsorted?: boolean;
/**
*
* @type {boolean}
* @memberof Sort
*/
empty?: boolean;
}
/**
*
* @export
* @interface Subtenant
*/
interface Subtenant {
/**
* A universally unique identifier.
* @type {string}
* @memberof Subtenant
*/
id: string;
/**
*
* @type {string}
* @memberof Subtenant
*/
displayName: string;
/**
*
* @type {string}
* @memberof Subtenant
*/
description: string;
}
/**
*
* @export
* @interface SubtenantResource
*/
interface SubtenantResource {
/**
*
* @type {number}
* @memberof SubtenantResource
*/
ETag?: number;
/**
*
* @type {string}
* @memberof SubtenantResource
*/
description?: string;
/**
*
* @type {string}
* @memberof SubtenantResource
*/
displayName?: string;
/**
*
* @type {string}
* @memberof SubtenantResource
*/
entityId?: string;
/**
*
* @type {string}
* @memberof SubtenantResource
*/
id?: string;
}
/**
*
* @export
* @interface SubtenantUpdateProperties
*/
interface SubtenantUpdateProperties {
/**
*
* @type {string}
* @memberof SubtenantUpdateProperties
*/
displayName?: string;
/**
*
* @type {string}
* @memberof SubtenantUpdateProperties
*/
description?: string;
}
/**
*
* @export
* @interface TenantInfo
*/
interface TenantInfo {
/**
*
* @type {number}
* @memberof TenantInfo
*/
ETag?: number;
/**
*
* @type {boolean}
* @memberof TenantInfo
*/
allowedToCreateSubtenant?: boolean;
/**
*
* @type {string}
* @memberof TenantInfo
*/
companyName?: string;
/**
*
* @type {string}
* @memberof TenantInfo
*/
country?: string;
/**
*
* @type {string}
* @memberof TenantInfo
*/
displayName?: string;
/**
*
* @type {string}
* @memberof TenantInfo
*/
name?: string;
/**
*
* @type {string}
* @memberof TenantInfo
*/
prefix?: string;
/**
*
* @type {string}
* @memberof TenantInfo
*/
type?: TenantInfo.TypeEnum;
}
/**
* @export
* @namespace TenantInfo
*/
namespace TenantInfo {
/**
* @export
* @enum {string}
*/
enum TypeEnum {
DEVELOPER,
OPERATOR,
USER,
CUSTOMER
}
}
/**
*
* @export
* @interface TenantInfoUpdateProperties
*/
interface TenantInfoUpdateProperties {
/**
*
* @type {string}
* @memberof TenantInfoUpdateProperties
*/
companyName?: string;
/**
*
* @type {string}
* @memberof TenantInfoUpdateProperties
*/
displayName?: string;
}
/**
*
* @export
* @interface UploadedFileResource
*/
interface UploadedFileResource {
/**
*
* @type {number}
* @memberof UploadedFileResource
*/
size?: number;
/**
*
* @type {string}
* @memberof UploadedFileResource
*/
name?: string;
}
}