@c8y/client 1018.487.7 → 1018.496.6

package/lib/esm2015/src/application/ApplicationService.d.ts

@@ -0,0 +1,325 @@
+import { IApplicationInstanceLog, IApplicationInstanceLogRequestParams, IApplicationManagedObject } from './IApplicationInstanceDetails';
+import { IFetchResponse, IResult, IResultList, Service } from '../core';
+import { ITenant } from '../tenant';
+import { IUser } from '../user';
+import { ApplicationBinaryService } from './ApplicationBinaryService';
+import { IApplication } from './IApplication';
+import { IApplicationVersionDeleteParams, IApplicationVersion } from './IApplicationVersion';
+import { IManifest } from './IManifest';
+import { ApplicationAvailability } from './ApplicationAvailability';
+export declare class ApplicationService extends Service<IApplication> {
+    protected baseUrl: string;
+    protected listUrl: string;
+    protected propertyName: string;
+    protected channel: string;
+    /**
+     * Creates a new application.
+     *
+     * @param {IIdentified} entity Application object.
+     *
+     * @returns Response wrapped in [[IResult]]
+     *
+     * **Example**
+     * ```typescript
+     *
+     *  const newApp = {
+     *    name: 'New application',
+     *    type: 'EXTERNAL',
+     *    key: 'new-app'
+     *  };
+     *
+     *  (async () => {
+     *    const {data, res} = await applicationService.create(newApp);
+     *  })();
+     * ```
+     */
+    create(entity: IApplication): Promise<IResult<IApplication>>;
+    /**
+     * Clones a given application. The application name, key, and context-path will be
+     * prefixed with `clone` and if necessary a number.
+     * @param entity The application to clone.
+     * @param version If a blueprint, you can define which version to clone. If not provided, it will always clone the latest version.
+     * @returns The application entity.
+     */
+    clone(entity: IApplication, version?: string): Promise<IResult<IApplication>>;
+    /**
+     * Gets the list of existing applications filtered by parameters.
+     *
+     * @returns Response wrapped in [[IResultList]]
+     *
+     * @param {object} filter Object containing filters for querying applications.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *  const filter: object = {
+     *     pageSize: 100,
+     *     withTotalPages: true
+     *   };
+     *
+     *   (async () => {
+     *     const {data, res, paging} = await applicationService.list(filter);
+     *   })();
+     * ```
+     */
+    list(filter?: object): Promise<IResultList<IApplication>>;
+    /**
+     * Gets the list of all application versions.
+     *
+     * @param {string|number|IIdentified} entityOrId Entity or Id of the entity.
+     *
+     * @param {object} params Additional request parameters.
+     *
+     * @returns Returns list of all application versions.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *    const applicationId: number = 1;
+     *
+     *    (async () => {
+     *      const {res, data} = await applicationService.listVersions(applicationId);
+     *   })();
+     * ```
+     */
+    listVersions(entityOrId: string | number | IApplication, params?: object): Promise<IResultList<IApplicationVersion>>;
+    /**
+     * Gets the details of selected application.
+     *
+     * @param {string|number|IIdentified} entityOrId Entity or Id of the entity.
+     *
+     * @returns Response wrapped in [[IResult]]
+     *
+     * **Example**
+     * ```typescript
+     *
+     *    const applicationId: number = 1;
+     *
+     *    (async () => {
+     *      const {data, res} = await applicationService.detail(applicationId);
+     *   })();
+     * ```
+     */
+    detail(entityOrId: string | number | IApplication): Promise<IResult<IApplication>>;
+    /**
+     * Updates existing application.
+     * Make sure that you specifiy the application id within the update object.
+     *
+     * @param {IIdentified} entity Application object.
+     *
+     * @returns Response wrapped in [[IResult]]
+     *
+     * **Example**
+     * ```typescript
+     *
+     *  const updateApp = {
+     *    id: 38
+     *    name: 'Updated application'
+     *  };
+     *
+     *  (async () => {
+     *    const {data, res} = await applicationService.update(updateApp);
+     *  })();
+     * ```
+     */
+    update(entity: IApplication): Promise<IResult<IApplication>>;
+    /**
+     * Removes an application with given id.
+     *
+     * @returns Response wrapped in [[IResult]]
+     *
+     * @param {string | number | IIdentified} entityOrId entity or id of the application.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *  const removeApp: object = {
+     *     id: 38
+     *   };
+     *
+     *   (async () => {
+     *     const {data, res} = await applicationService.delete(removeApp);
+     *     // data will be null
+     *   })();
+     * ```
+     */
+    delete(entityOrId: string | number | IApplication): Promise<IResult<null>>;
+    listByName(name: string): Promise<IResultList<IApplication>>;
+    listByTenant(tenantOrName?: string | ITenant, params?: object): Promise<IResultList<IApplication>>;
+    listByOwner(tenantOrName?: string | ITenant, params?: object): Promise<IResultList<IApplication>>;
+    listByUser(userOrId?: string | number | IUser, params?: object): Promise<IResultList<IApplication>>;
+    reactivateArchive(appId: number | string): Promise<IResult<null>>;
+    binary(application: string | number | IApplication): ApplicationBinaryService;
+    getHref(application: IApplication): string;
+    /**
+     * Checks if current user can access specified application.
+     *
+     * @returns Response wrapped in [[IResult]]
+     *
+     * @param {string | IApplication} application Application name or contextPath as a
+     * string or Application object.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *  const checkApp: object = {
+     *    name: 'myApplication'
+     *  };
+     *
+     *  (async () => {
+     *    const {data, res} = await applicationService.isAvailable(checkApp);
+     *  })();
+     * ```
+     */
+    isAvailable(application: string | Partial<IApplication>): Promise<IResult<boolean>>;
+    /**
+     * Gets instance details of the specified application (microservice).
+     *
+     * @param {string|number|IApplication} entityOrId Entity or Id of the application.
+     *
+     * @returns Response wrapped in [[IResultList]]
+     *
+     * **Example**
+     * ```typescript
+     *
+     *    const applicationId: number = 1;
+     *
+     *    (async () => {
+     *      const {data, res} = await applicationService.getStatusDetails(applicationId);
+     *   })();
+     * ```
+     */
+    getStatusDetails(entityOrId: string | number | IApplication): Promise<IResultList<IApplicationManagedObject>>;
+    /**
+     * Extracts instance names of the provided IApplicationManagedObject.
+     *
+     * @param {IApplicationManagedObject} appStatusDetails Application details managedObject.
+     *
+     * @returns instance names
+     *
+     * **Example**
+     * ```typescript
+     *
+     *    const applicationId: number = 1;
+     *
+     *    (async () => {
+     *      const {data, res} = await applicationService.getStatusDetails(applicationId);
+     *      const instances = data.map((appMO) => applicationService.getInstanceNames(appMO));
+     *   })();
+     * ```
+     */
+    getInstanceNames(appStatusDetails: IApplicationManagedObject): string[];
+    /**
+     * Get log for a specific application instance.
+     *
+     * @param {string|number|IApplication} entityOrId Entity or Id of the application.
+     *
+     * @param {string} instanceName instance name of the application.
+     *
+     * @param {IApplicationInstanceLogRequestParams} params Object containing parameters for querying the log file.
+     *
+     * @returns Response wrapped in [[IResult]]
+     *
+     * **Example**
+     * ```typescript
+     *
+     *    const applicationId: number = 1;
+     *    const applicationInstanceName: string = 'apama-ctrl-1c-4g-scope-t123456789-deployment-abcdefghij-abcde';
+     *
+     *    (async () => {
+     *      const {data, res} = await applicationService.getInstanceLog(applicationId, applicationInstanceName);
+     *   })();
+     * ```
+     */
+    getInstanceLog(entityOrId: string | number | IApplication, instanceName: string, params?: IApplicationInstanceLogRequestParams): Promise<IResult<IApplicationInstanceLog>>;
+    /**
+     * Dynamic options are stored on the API in a specific `config: {}` object. They can
+     * be used to configure the app dynamically.
+     *
+     * Note: To avoids conflicts with the default Config, it is recommended
+     * to use a certain namespace.
+     * @param entityOrId Entity or Id of the application.
+     * @param config Configuration to be updated.
+     * @returns Returns updated configuration.
+     */
+    updateApplicationConfig<T>(entityOrId: string | number | IApplication, config: T): Promise<IApplication & {
+        config: T;
+    }>;
+    /**
+     * Gets manifest (cumulocity.json file) of a given application.
+     *
+     * @param {IApplication} app Application entity.
+     *
+     * @param {string} app version
+     *
+     * @returns Application manifest object.
+     */
+    getAppManifest(app: IApplication, version?: string): Promise<IManifest>;
+    /**
+     * Updates manifest (cumulocity.json file) of a given application.
+     *
+     * @param {string|number|IApplication} entityOrId Entity or Id of the application.
+     *
+     * @param {any} manifestJSON Application manifest object to be stored.
+     *
+     * @returns Application manifest object.
+     */
+    storeAppManifest(entityOrId: string | number | IApplication, manifestJSON: any): Promise<{
+        res: IFetchResponse;
+        data: any;
+    }>;
+    /**
+     * Sets tags for specific application package version.
+     *
+     * @param {IApplication} app Application entity.
+     *
+     * @param {string} version Application package version which tags will be set.
+     *
+     * @param {string[]} tags Tags array to set on package version
+     *
+     * @returns Application version object.
+     */
+    setPackageVersionTag(app: IApplication, version: string, tags: string[]): Promise<{
+        res: IFetchResponse;
+        data: any;
+    }>;
+    /**
+     * Retrieves the manifest of the application behind the given context path.
+     * @param contextPath
+     */
+    getManifestOfContextPath(contextPath: string): Promise<IResult<Partial<IApplication>>>;
+    /**
+     * Removes package version.
+     *
+     * @param {IApplication} app Application entity.
+     *
+     * @param {IApplicationVersionDeleteParams} params Version or tag indication package to remove.
+     *
+     * @returns Request response.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *    const { res } = await applicationService.deleteVersionPackage(app, {version: '1.0.0'});
+     *
+     *    const { res } = await applicationService.deleteVersionPackage(app, {tag: 'next'});
+     *
+     * ```
+     */
+    deleteVersionPackage(app: IApplication, params: IApplicationVersionDeleteParams): Promise<{
+        res: IFetchResponse;
+        data: any;
+    }>;
+    /**
+     * Updates the availability of the given application to the provided value.
+     *
+     * @param {string|number|IApplication} entityOrId Entity or Id of the application.
+     *
+     * @param {any} availability The new application availability.
+     *
+     * @returns Updated application.
+     */
+    updateApplicationAvailability(entityOrId: string | number | IApplication, availability: ApplicationAvailability): Promise<IResult<IApplication>>;
+    private isMatch;
+}
+//# sourceMappingURL=ApplicationService.d.ts.map

package/lib/esm2015/src/application/ApplicationType.d.ts

@@ -0,0 +1,7 @@
+export declare enum ApplicationType {
+    EXTERNAL = "EXTERNAL",
+    HOSTED = "HOSTED",
+    MICROSERVICE = "MICROSERVICE",
+    FEATURE = "FEATURE"
+}
+//# sourceMappingURL=ApplicationType.d.ts.map

package/lib/esm2015/src/application/BillingMode.d.ts

@@ -0,0 +1,5 @@
+export declare enum BillingMode {
+    SUBSCRIPTION = "SUBSCRIPTION",
+    RESOURCES = "RESOURCES"
+}
+//# sourceMappingURL=BillingMode.d.ts.map

package/lib/esm2015/src/application/IApplication.d.ts

@@ -0,0 +1,22 @@
+import { ApplicationType, ApplicationAvailability, IManifest, IApplicationVersion } from './';
+import { ITenantReference } from '../tenant';
+export interface IApplication {
+    id?: number | string;
+    name?: string;
+    key?: string;
+    type?: ApplicationType;
+    availability?: ApplicationAvailability;
+    owner?: ITenantReference;
+    contextPath?: string;
+    externalUrl?: string;
+    manifest?: Partial<IManifest>;
+    activeVersionId?: string;
+    requiredRoles?: string[];
+    url?: string;
+    public?: boolean;
+    description?: string;
+    self?: string;
+    applicationVersions?: IApplicationVersion[];
+    [key: string]: any;
+}
+//# sourceMappingURL=IApplication.d.ts.map

package/lib/esm2015/src/application/IApplicationBinary.d.ts

@@ -0,0 +1,9 @@
+export interface IApplicationBinary {
+    contextPath: string;
+    id: number | string;
+    name: string;
+    description: string;
+    created: string;
+    length: number | string;
+}
+//# sourceMappingURL=IApplicationBinary.d.ts.map

package/lib/esm2015/src/application/IApplicationInstanceDetails.d.ts

@@ -0,0 +1,68 @@
+import { IManagedObject } from '../inventory';
+export declare enum InstanceStatus {
+    Up = "Up",
+    Unhealthy = "Unhealthy",
+    Down = "Down",
+    Unknown = "Unknown"
+}
+export interface ILastUpdated {
+    date: {
+        $date: string;
+    };
+    offset: number;
+    [key: string]: any;
+}
+export interface IInstanceDetails {
+    lastUpdated: ILastUpdated;
+    memoryInBytes: number;
+    scheduled: boolean;
+    restarts: number;
+    cpuInMillis: number;
+    [key: string]: any;
+}
+export interface IApplicationStatus {
+    lastUpdated: ILastUpdated;
+    instances: {
+        [instanceName: string]: IInstanceDetails;
+    };
+    details: {
+        desired: number;
+        aggregatedResources: {
+            memory: string;
+            cpu: string;
+        };
+        active: number;
+        restarts: number;
+    };
+    status: InstanceStatus;
+    [key: string]: any;
+}
+export interface IApplicationManagedObjectAdditions {
+    c8y_Status?: IApplicationStatus;
+    applicationOwner?: string;
+    c8y_Subscriptions?: {
+        [tenantId: string]: IApplicationStatus;
+    };
+    applicationId?: string;
+    name?: string;
+    c8y_SupportedLogs?: string[];
+    [key: string]: any;
+}
+export type IApplicationManagedObject = IManagedObject & IApplicationManagedObjectAdditions;
+export interface IApplicationInstanceLog {
+    dateFrom: string;
+    dateTo: string;
+    logs: string;
+    truncated: boolean;
+    [key: string]: any;
+}
+export interface IApplicationInstanceLogRequestParams {
+    dateFrom?: string;
+    dateTo?: string;
+    /**
+     * Limits the maximum number of lines to be returned by the backend.
+     */
+    limit?: number;
+    [key: string]: any;
+}
+//# sourceMappingURL=IApplicationInstanceDetails.d.ts.map

package/lib/esm2015/src/application/IApplicationReference.d.ts

@@ -0,0 +1,16 @@
+import { ISource } from '../core';
+import { IApplication } from './';
+export interface IApplicationReference {
+    application: Partial<IApplication> & ISource;
+}
+export interface IApplicationReferences {
+    /**
+     * References array of type [[IApplicationReference]]
+     */
+    references: IApplicationReference[];
+    /**
+     * Link to this resource
+     */
+    self?: string;
+}
+//# sourceMappingURL=IApplicationReference.d.ts.map

package/lib/esm2015/src/application/IApplicationVersion.d.ts

@@ -0,0 +1,15 @@
+export interface IApplicationVersion {
+    version: string;
+    tags?: string[];
+    binaryId: string;
+}
+export type IApplicationVersionDeleteParams = {
+    tag: string;
+    version?: never;
+    binaryId?: string;
+} | {
+    tag?: never;
+    version: string;
+    binaryId?: string;
+};
+//# sourceMappingURL=IApplicationVersion.d.ts.map

package/lib/esm2015/src/application/IDeviceRegistrationProvider.d.ts

@@ -0,0 +1,7 @@
+export interface IDeviceRegistrationProvider {
+    name: string;
+    contextPath: string;
+    priority: number;
+    description?: string;
+}
+//# sourceMappingURL=IDeviceRegistrationProvider.d.ts.map

package/lib/esm2015/src/application/IManifest.d.ts

@@ -0,0 +1,34 @@
+import { BillingMode, Isolation, IProvider, IApplication, IDeviceRegistrationProvider } from './';
+export interface IManifest {
+    id: number;
+    applicationId: number;
+    imports: string[];
+    contextPath: string;
+    version?: string;
+    versioningMatrix?: VersioningMatrix;
+    billingMode: BillingMode;
+    isolation: Isolation;
+    provider: IProvider;
+    providesDeviceRegistration?: IDeviceRegistrationProvider;
+    noAppSwitcher?: boolean;
+    exports?: any;
+    remotes?: ApplicationRemotePlugins;
+    isPackage?: boolean;
+    package?: 'blueprint' | 'plugin';
+    source?: string | number | IApplication;
+    name?: string;
+    description?: string;
+    requiredPlatformVersion?: string;
+    author?: string;
+    [key: string]: any;
+}
+export interface ApplicationRemotePlugins {
+    [key: string]: string[];
+}
+export interface VersioningMatrix {
+    [version: string]: {
+        sdk: string;
+        api: string;
+    };
+}
+//# sourceMappingURL=IManifest.d.ts.map

package/lib/esm2015/src/application/IProvider.d.ts

@@ -0,0 +1,6 @@
+export interface IProvider {
+    name: string;
+    domain: string;
+    support: string;
+}
+//# sourceMappingURL=IProvider.d.ts.map

package/lib/esm2015/src/application/IUploadParamsOverride.d.ts

@@ -0,0 +1,7 @@
+export interface IUploadParamsOverride {
+    listUrl: string;
+    headers: Record<string, string>;
+    bodyFileProperty: string;
+    requestBody: Record<string, unknown>;
+}
+//# sourceMappingURL=IUploadParamsOverride.d.ts.map

package/lib/esm2015/src/application/Isolation.d.ts

@@ -0,0 +1,5 @@
+export declare enum Isolation {
+    PER_TENANT = "PER_TENANT",
+    MULTI_TENANT = "MULTI_TENANT"
+}
+//# sourceMappingURL=Isolation.d.ts.map

package/lib/esm2015/src/application/index.d.ts

@@ -0,0 +1,16 @@
+export * from './ApplicationService';
+export * from './ApplicationBinaryService';
+export * from './IApplication';
+export * from './IApplicationBinary';
+export * from './IApplicationInstanceDetails';
+export * from './IApplicationReference';
+export * from './ApplicationType';
+export * from './BillingMode';
+export * from './Isolation';
+export * from './ApplicationAvailability';
+export * from './IManifest';
+export * from './IProvider';
+export * from './IUploadParamsOverride';
+export * from './IApplicationVersion';
+export * from './IDeviceRegistrationProvider';
+//# sourceMappingURL=index.d.ts.map

package/lib/esm2015/src/audit/AuditRecordType.d.ts

@@ -0,0 +1,19 @@
+/**
+ * A specific audit record can have one of the following types
+ */
+export declare enum AuditRecordType {
+    ALARM = "Alarm",
+    BULK_OPERATION = "BulkOperation",
+    CEP_MODULE = "CepModule",
+    EVENT = "Event",
+    INVENTORY = "Inventory",
+    INVENTORY_ROLE = "InventoryRole",
+    OPERATION = "Operation",
+    OPTION = "Option",
+    GROUP = "Group",
+    SMART_RULE = "SmartRule",
+    SYSTEM = "SYSTEM",
+    TENANT = "Tenant",
+    USER = "User"
+}
+//# sourceMappingURL=AuditRecordType.d.ts.map

package/lib/esm2015/src/audit/AuditService.d.ts

@@ -0,0 +1,72 @@
+import { Service, IResult, IResultList } from '../core';
+import { IAuditRecord } from './IAuditRecord';
+export declare class AuditService extends Service<IAuditRecord> {
+    protected baseUrl: string;
+    protected listUrl: string;
+    protected propertyName: string;
+    /**
+     * Gets the details of selected audit record.
+     *
+     * @param {string|number|IAuditRecord} entityOrId Entity or Id of the entity.
+     *
+     * @returns Response wrapped in [[IResult]]
+     *
+     * **Example**
+     * ```typescript
+     *
+     *    const auditId: number = 1;
+     *
+     *    (async () => {
+     *      const {data, res} = await auditService.detail(auditId);
+     *   })();
+     * ```
+     */
+    detail(entityOrId: string | number | IAuditRecord): Promise<IResult<IAuditRecord>>;
+    /**
+     * Creates a new audit record for a given source.
+     *
+     * @param {IAuditRecord} entity Audit record object with mandantory fragments.
+     * IAuditRecord implements the [[IEvent]] interface.
+     *
+     * @returns Response wrapped in [[IResult]]
+     *
+     * **Example**
+     * ```typescript
+     *
+     *  const mandantoryObject: IAuditRecord = {
+     *    type: AuditRecordType.ALARM,
+     *    time: '2018-05-02T10:08:00Z',
+     *    severity: Severity.MAJOR,
+     *    source: {id: 1}
+     *  };
+     *
+     *  (async () => {
+     *    const {data, res} = await auditService.create(mandantoryObject);
+     *  })();
+     * ```
+     */
+    create(entity: IAuditRecord): Promise<IResult<IAuditRecord>>;
+    /**
+     * Gets the list of audit records filtered by parameters.
+     *
+     * @returns Response wrapped in [[IResultList]]
+     *
+     * @param {object} filter Object containing filters for querying audit records.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *  const filter: object = {
+     *     severity: Severity.MAJOR,
+     *     pageSize: 100,
+     *     withTotalPages: true
+     *   };
+     *
+     *   (async () => {
+     *     const {data, res, paging} = await auditService.list(filter);
+     *   })();
+     * ```
+     */
+    list(filter?: object): Promise<IResultList<IAuditRecord>>;
+}
+//# sourceMappingURL=AuditService.d.ts.map

package/lib/esm2015/src/audit/ChangeType.d.ts

@@ -0,0 +1,9 @@
+/**
+ * An audit record can have one of the following change type
+ */
+export declare enum ChangeType {
+    ADDED,
+    REPLACED,
+    REMOVED
+}
+//# sourceMappingURL=ChangeType.d.ts.map