@c8y/client 1018.487.7 → 1018.496.6

package/lib/cjs/src/tenant-options/TenantOptionsService.d.ts

@@ -0,0 +1,144 @@
+import { Service, IResultList, IResult, IIdentified } from '../core';
+import { ITenantOption } from './ITenantOption';
+import { ITenantOptionDetailParams } from './ITenantOptionDetailParams';
+/**
+ * @description
+ * This service allows for managing tenant's options.
+ */
+export declare class TenantOptionsService extends Service<ITenantOption> {
+    protected baseUrl: string;
+    protected listUrl: string;
+    protected propertyName: string;
+    private securityOptionsCategories;
+    private securityOptionsListUrl;
+    private systemOptions;
+    /**
+     * Get a representation of a tenant's option.
+     *
+     * @param entity Tenant option object.
+     * @param params Additional query parameters.
+     *
+     * @returns Returns promise object that is resolved with
+     * the ITenantOption wrapped by IResult.
+     *
+     * **Example**
+     * ```typescript
+     * const option: ITenantOption = {
+     *   category: 'access.control',
+     *   key: 'allow.origin'
+     * };
+     * const params: ITenantOptionDetailParams = {
+     *   evaluate: 'inherited'
+     * };
+     * (async () => {
+     *   const { data, res } = await tenantService.detail(option);
+     *   console.log('value inherited from parent tenant:', data.value);
+     * })();
+     * ```
+     *
+     * Required role: ROLE_OPTION_MANAGEMENT_READ
+     */
+    detail(entity: ITenantOption, params?: ITenantOptionDetailParams): Promise<IResult<ITenantOption>>;
+    /**
+     * Creates a new tenant's option.
+     *
+     * @param {ITenantOption} entity Tenant's Option object.
+     *
+     * @returns {IResult<IIdentified>} Returns promise object that is resolved with
+     * the details of newly created tenant option.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *  const tenantObject = {
+     *    id: "sample_tenant",
+     *    company: "sample_company",
+     *    domain: "sample_domain.com",
+     *    contactName: "Mr. Doe",
+     *    ...
+     *  };
+     *
+     *  (async () => {
+     *    const {data, res} = await tenantService.create(tenantObject);
+     *  })();
+     * ```
+     *
+     * Required role: ROLE_OPTION_MANAGEMENT_ADMIN<br><br>
+     * Options are category-key-value tuples, storing tenant configuration.Some categories of options
+     * allow creation of new one, other are limited to predefined set of keys.<br><br>
+     * Any option of any tenant can be defined as "non-editable" by "management" tenant. Afterwards, any PUT or DELETE
+     * requests made on that option by the owner tenant, will result in 403 error (Unauthorized).
+     */
+    create(entity: ITenantOption): Promise<IResult<ITenantOption>>;
+    /**
+     * Updates tenant's option data.
+     *
+     * @param {ITenantOption} entity Tenant option is partially updatable.
+     *
+     * @returns {IResult<ITenantOption>} Returns promise object that is resolved with the saved tenant option object.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *  const partialUpdateObject: IIdentified = {
+     *     value : "http://developer.cumulocity.com"
+     *     ...
+     *   }
+     *
+     *  (async () => {
+     *    const {data, res} = await tenantOptionsService.update(partialUpdateObject);
+     *  })();
+     * ```
+     *
+     * Required role: ROLE_OPTION_MANAGEMENT_ADMIN
+     */
+    update(entity: ITenantOption): Promise<IResult<ITenantOption>>;
+    /**
+     * Gets the list of tenant's options filtered by parameters.
+     *
+     * @param {object} filter Object containing filters for querying tenant options.
+     *
+     * @returns {IResultList<ITenantOption>} Returns promise object that is resolved
+     * with the ITenantOption wrapped by IResultList.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *  const filter: object = {
+     *     severity: Severity.MAJOR,
+     *     pageSize: 100,
+     *     withTotalPages: true
+     *   };
+     *
+     *   (async () => {
+     *     const {data, res, paging} = await tenantOptionsService.list(filter);
+     *   })();
+     * ```
+     *
+     * Required role: ROLE_OPTION_MANAGEMENT_READ
+     */
+    list(filter?: object): Promise<IResultList<ITenantOption>>;
+    /**
+     * Delete a representation of a tenant's option.
+     *
+     * @param {string|number|IIdentified} entityOrId Tenant's option id or tenant's option object.
+     *
+     * @returns Returns promise object that is resolved with the IResult.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *    const tenantOptionId: string = "uniqueTenantId";
+     *
+     *    (async () => {
+     *      const {data, res} = await tenantOptionsService.delete(tenantOptionId);
+     *   })();
+     * ```
+     *
+     * Required role: ROLE_TENANT_MANAGEMENT_ADMIN
+     */
+    delete(entityOrId: string | number | IIdentified): Promise<IResult<null>>;
+    protected getDetailUrl(entity: ITenantOption): string;
+    protected onBeforeCreate(obj: ITenantOption): any;
+}
+//# sourceMappingURL=TenantOptionsService.d.ts.map

package/lib/cjs/src/tenant-options/index.d.ts

@@ -0,0 +1,4 @@
+export * from './ITenantOption';
+export * from './ITenantOptionDetailParams';
+export * from './TenantOptionsService';
+//# sourceMappingURL=index.d.ts.map

package/lib/cjs/src/tenant-security-options/ITenantSecurityOption.d.ts

@@ -0,0 +1,8 @@
+/** Description of ITenantSecurityOption interface */
+export interface ITenantSecurityOption {
+    /** Key identifies the security option */
+    key: string;
+    /** Value of a security option */
+    value?: string;
+}
+//# sourceMappingURL=ITenantSecurityOption.d.ts.map

package/lib/cjs/src/tenant-security-options/TenantSecurityOptionsService.d.ts

@@ -0,0 +1,35 @@
+import { Service, IResult } from '../core';
+import { ITenantSecurityOption } from './ITenantSecurityOption';
+/**
+ * @description
+ * This service allows to get tenant security option.
+ */
+export declare class TenantSecurityOptionsService extends Service<ITenantSecurityOption> {
+    protected baseUrl: string;
+    protected listUrl: string;
+    protected category: string;
+    protected propertyName: string;
+    /**
+     * Get a specific tenant's security option.
+     *
+     * @param {ITenantSecurityOption} Tenant's security option object with key value.
+     *
+     * @returns Returns promise object that is resolved with the ITenantSecurityOption wrapped by IResult.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *     const option: ITenantSecurityOption = {
+     *        key: 'limit.validity'
+     *      };
+     *
+     *    (async () => {
+     *      const {data, res} = await tenantSecurityOptionsService.detail(option);
+     *   })();
+     * ```
+     */
+    detail(tenantSecurityOption: ITenantSecurityOption): Promise<IResult<ITenantSecurityOption>>;
+    protected getDetailUrl(tenantSecurityOption: ITenantSecurityOption): string;
+    protected onBeforeCreate(obj: ITenantSecurityOption): any;
+}
+//# sourceMappingURL=TenantSecurityOptionsService.d.ts.map

package/lib/cjs/src/tenant-security-options/index.d.ts

@@ -0,0 +1,3 @@
+export * from './ITenantSecurityOption';
+export * from './TenantSecurityOptionsService';
+//# sourceMappingURL=index.d.ts.map

package/lib/cjs/src/trusted-certificates/ITrustedCertificate.d.ts

@@ -0,0 +1,68 @@
+/**
+ * This interface holds all fragments that describe a certificate object
+ */
+export interface ITrustedCertificate {
+    /**
+     * Certificate validity end date and time
+     */
+    notAfter?: string;
+    /**
+     * Certificate validity start date and time
+     */
+    notBefore?: string;
+    /**
+     * Which X.509 version applies to the certificate
+     */
+    version?: any;
+    /**
+     * The algorithm used by the issuer to sign the certificate
+     */
+    algorithmName?: string;
+    /**
+     * The owner of the certificate
+     */
+    subject?: string;
+    /**
+     * Certificate serial number
+     */
+    serialNumber?: string;
+    /**
+     * The name of the entity issuing the certificate
+     */
+    issuer?: string;
+    /**
+     * Certificate fingerprint
+     * A unique identifier
+     */
+    fingerprint: string;
+    /**
+     * Certificate status
+     */
+    status: 'ENABLED' | 'DISABLED';
+    /**
+     * Certificate name
+     */
+    name: string;
+    /**
+     * Auto-registration flag
+     * All devices with credentials signed by this certificate will be able to communicate with the platform without a prior registration.
+     */
+    autoRegistrationEnabled?: boolean;
+    /**
+     * Certificate in PEM format
+     */
+    certInPemFormat: string;
+    /**
+     * True if user has proved to own the certificate.
+     */
+    proofOfPossessionValid?: boolean;
+    /**
+     * A random string which should be encrypted with the private key to prove the certificate's ownership.
+     */
+    proofOfPossessionUnsignedVerificationCode?: string;
+    /**
+     * A date until the unsigned verification code can be used to prove the certificate's ownership. After this date the code needs to be regenerated.
+     */
+    proofOfPossessionVerificationCodeUsableUntil?: string;
+}
+//# sourceMappingURL=ITrustedCertificate.d.ts.map

package/lib/cjs/src/trusted-certificates/TrustedCertificateService.d.ts

@@ -0,0 +1,146 @@
+import { IResult, Service } from '../core';
+import { ITrustedCertificate } from './ITrustedCertificate';
+/**
+ * This class allows for managing trusted certificates.
+ */
+export declare class TrustedCertificateService extends Service<ITrustedCertificate> {
+    protected get baseUrl(): string;
+    protected listUrl: string;
+    protected proofOfPossessionUrl: string;
+    protected propertyName: string;
+    /**
+     * Gets a list of trusted certificates.
+     *
+     * @returns Response wrapped in [[IResultList]].
+     *
+     * **Example**
+     * ```typescript
+     *
+     *   (async () => {
+     *     const {data, res} = await trustedCertificateService.list();
+     *   })();
+     * ```
+     */
+    list(filter?: object): Promise<import("../core").IResultList<ITrustedCertificate>>;
+    /**
+     * Gets the details of trusted certificate
+     *
+     * @param entityOrId Trusted certificate object or trusted certificate fingerprint.
+     *
+     * @returns Response wrapped in [[IResult]]
+     *
+     * **Example**
+     * ```typescript
+     *
+     *    const fingerprint: string = 'abc';
+     *
+     *    (async () => {
+     *      const {data, res} = await trustedCertificateService.detail(fingerprint);
+     *   })();
+     * ```
+     */
+    detail(entityOrId: string | ITrustedCertificate): Promise<IResult<ITrustedCertificate>>;
+    /**
+     * Removes a trusted certificate with given fingerprint.
+     *
+     * @returns Response wrapped in [[IResult]]
+     *
+     * @param entityOrId Trusted certificate object or trusted certificate fingerprint.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *   const fingerprint: string = 'abc';
+     *
+     *    (async () => {
+     *      const {data, res} = await trustedCertificateService.delete(fingerprint);
+     *   })();
+     * ```
+     */
+    delete(entityOrId: string | ITrustedCertificate): Promise<IResult<null>>;
+    /**
+     * Updates trusted certificate data.
+     *
+     * @param entity Trusted certificate partial object.
+     *
+     * @returns Response wrapped in [[IResult]]
+     *
+     * **Example**
+     * ```typescript
+     *
+     *  const certificate: Partial<ITrustedCertificate> = {
+     *    name: 'Name'
+     *  };
+     *
+     *  (async () => {
+     *    const {data, res} = await trustedCertificateService.update(certificate);
+     *  })();
+     * ```
+     */
+    update(entity: Partial<ITrustedCertificate>): Promise<IResult<ITrustedCertificate>>;
+    /**
+     * Creates a new trusted certificate.
+     *
+     * @param entity Trusted certificate object.
+     *
+     * @returns Response wrapped in [[IResult]]
+     *
+     * **Example**
+     * ```typescript
+     *
+     *  const certificate: Partial<ITrustedCertificate> = {
+     *    name: 'Name',
+     *    certInPemFormat: 'MIID+DCCAuCgAwIBAgIJAO1Q9t/M9gYlMA0GC...',
+     *    status: 'ENABLED'
+     *  };
+     *
+     *  (async () => {
+     *    const {data, res} = await trustedCertificateService.create(certificate);
+     *  })();
+     * ```
+     */
+    create(entity: Partial<ITrustedCertificate>): Promise<IResult<ITrustedCertificate>>;
+    /**
+     * Regenerates unsigned verification code for trusted certificate.
+     *
+     *
+     * @param entityOrId Trusted certificate object or finger print.
+     *
+     * @returns Certificate object with new verification code (wrapped in [[IResult]])
+     *
+     * **Example**
+     * ```typescript
+     *
+     *  (async () => {
+     *    const fingerPrint = '00a360973e3e8d61e05aedb32c72438e2442279e';
+     *    const {data, res} = await trustedCertificateService.regeneratePoPVerificationCode(fingerPrint);
+     *    const newProofOfPossessionUnsignedVerificationCode = data.proofOfPossessionUnsignedVerificationCode;
+     *  })();
+     * ```
+     */
+    regeneratePoPVerificationCode(entityOrId: string | ITrustedCertificate): Promise<IResult<ITrustedCertificate>>;
+    /**
+     * Verifies signed verification code for trusted certificate.
+     *
+     *
+     * @param entityOrId Trusted certificate object or finger print.
+     * @param proofOfPossessionSignedVerificationCode Unsigned verification code encrypted by the private key.
+     *
+     * @returns Certificate object with the result of verification (wrapped in [[IResult]]).
+     *
+     * **Example**
+     * ```typescript
+     *
+     *  (async () => {
+     *    const fingerPrint = '00a360973e3e8d61e05aedb32c72438e2442279e';
+     *    const encryptedVerificationCode ='fuvlVWLfXG3V3bJWAdEhPD0HFCrYo5';
+     *    const {data, res} = await trustedCertificateService.verifySignedVerificationCode(fingerPrint, encryptedVerificationCode);
+     *    const isCertificateVerified = data.proofOfPossessionValid;
+     *  })();
+     * ```
+     */
+    verifySignedVerificationCode(entityOrId: string | ITrustedCertificate, proofOfPossessionSignedVerificationCode: string): Promise<IResult<ITrustedCertificate>>;
+    protected getDetailUrl(entityOrId: string | ITrustedCertificate): string;
+    protected getEntityId(entityOrId: string | ITrustedCertificate): string;
+}
+//# sourceMappingURL=TrustedCertificateService.d.ts.map

package/lib/cjs/src/trusted-certificates/index.d.ts

@@ -0,0 +1,3 @@
+export * from './TrustedCertificateService';
+export * from './ITrustedCertificate';
+//# sourceMappingURL=index.d.ts.map

package/lib/cjs/src/user/ICurrentUser.d.ts

@@ -0,0 +1,35 @@
+import { INamed } from '../core';
+/** Description of ICurrenUser interface */
+export interface ICurrentUser {
+    /** Uniquely identifies a user */
+    id?: string;
+    /**
+     * User name, unique for a given domain.
+     * Max: 1000 characters. Whitespaces, slashes, +$: characters not allowed
+     */
+    userName: string;
+    /**
+     * User password. Min: 6, max: 32 characters.
+     * Only Latin1 chars allowed
+     */
+    password?: string;
+    /** Link to this Resource */
+    self?: string;
+    /** True if user should reset password */
+    shouldResetPassword?: boolean;
+    /** User email address. */
+    email?: string;
+    /** User first name. */
+    firstName?: string;
+    /** User last name. */
+    lastName?: string;
+    /** User phone number. */
+    phone?: string;
+    /** The date/time of last password change. */
+    lastPasswordChange?: string;
+    /** The password strength */
+    passwordStrength?: string;
+    /** List of all roles a current user has assigned (explicitly or implicitly via associated groups). */
+    effectiveRoles?: INamed[];
+}
+//# sourceMappingURL=ICurrentUser.d.ts.map

package/lib/cjs/src/user/IResetPassword.d.ts

@@ -0,0 +1,12 @@
+import { PasswordStrength } from './';
+export interface IResetPassword {
+    /** New password to be set. */
+    newPassword?: string;
+    /** New password's strength indicator. */
+    passwordStrength?: PasswordStrength;
+    /** Password reset token.  */
+    token?: string;
+    /** User's email address. */
+    email?: string;
+}
+//# sourceMappingURL=IResetPassword.d.ts.map

package/lib/cjs/src/user/ITotp.d.ts

@@ -0,0 +1,7 @@
+export interface ITotp {
+    /** The URL to the QR-code to display */
+    secretQrUrl: string;
+    /** The raw secret for the challenge */
+    rawSecret: string;
+}
+//# sourceMappingURL=ITotp.d.ts.map

package/lib/cjs/src/user/ITotpStatus.d.ts

@@ -0,0 +1,5 @@
+export interface ITotpStatus {
+    isForced: boolean;
+    isActive: boolean;
+}
+//# sourceMappingURL=ITotpStatus.d.ts.map

package/lib/cjs/src/user/IUser.d.ts

@@ -0,0 +1,72 @@
+import { IIdentified } from '../core';
+/** Description of IUser interface */
+export interface IUser {
+    /** Uniquely identifies a user */
+    id?: string;
+    /**
+     * User name, unique for a given domain.
+     * Max: 1000 characters. Whitespaces, slashes, +$: characters not allowed
+     */
+    userName: string;
+    /**
+     * The display name
+     */
+    displayName: string;
+    /**
+     * User password. Min: 6, max: 32 characters.
+     * Only Latin1 chars allowed
+     */
+    password?: string;
+    /** Link to this Resource */
+    self?: string;
+    /** True if user should reset password */
+    shouldResetPassword?: boolean;
+    /** Keeps a list of all user applications */
+    applications?: IIdentified[];
+    /** Keeps a list of custom properties */
+    customProperties?: any;
+    /** List of device permissions */
+    devicePermission?: any;
+    /** User email address. */
+    email?: string;
+    /** User activation status (true/false) */
+    enabled?: boolean;
+    /** User first name. */
+    firstName?: string;
+    /** User last name. */
+    lastName?: string;
+    /** User phone number. */
+    phone?: string;
+    /**  */
+    lastPasswordChange?: string;
+    /** The password strength */
+    passwordStrength?: string;
+    /**  */
+    twoFactorAuthenticationEnabled?: boolean;
+    /** List of role references */
+    roles?: IUserRoleReference;
+    supportUserEnabled?: boolean;
+    [key: string]: any;
+}
+/** Description of IUserRoleReference interface */
+export interface IUserRoleReference {
+    /** List of role references */
+    references: IIdentified[];
+    /** Link to this Resource */
+    self: string;
+}
+/** Description of IUserReferences interface */
+export interface IUserReferences {
+    /** List of user references */
+    references: IUserReference[];
+    /** Link to this Resource */
+    self: string;
+}
+/** Description of IUserReference interface */
+export interface IUserReference {
+    /** A user resource being referenced */
+    user: Partial<IUser>;
+    /** Link to this Resource */
+    self: string;
+}
+//# sourceMappingURL=IUser.d.ts.map

package/lib/cjs/src/user/IUserInventoryRole.d.ts

@@ -0,0 +1,13 @@
+import { IIdentified } from '../core';
+/** Description of IUserInventoryRole interface */
+export interface IUserInventoryRole {
+    /** UUniquely identifies a user inventory role */
+    id?: number;
+    /**  */
+    managedObject: string;
+    /** List of role references */
+    roles: IIdentified[];
+    /** Link to this Resource */
+    self?: string;
+}
+//# sourceMappingURL=IUserInventoryRole.d.ts.map

package/lib/cjs/src/user/PasswordStrength.d.ts

@@ -0,0 +1,6 @@
+export declare enum PasswordStrength {
+    GREEN = "GREEN",
+    RED = "RED",
+    YELLOW = "YELLOW"
+}
+//# sourceMappingURL=PasswordStrength.d.ts.map

package/lib/cjs/src/user/UserInventoryRoleService.d.ts

@@ -0,0 +1,101 @@
+import { IFetchClient, IIdentified, Service } from '../core';
+import { IUserInventoryRole } from './IUserInventoryRole';
+/**
+ * @description
+ * This service allows for managing current user's inventory roles.
+ */
+export declare class UserInventoryRoleService extends Service<IUserInventoryRole> {
+    protected baseUrl: any;
+    protected listUrl: string;
+    protected currenUserUrl: string;
+    protected propertyName: string;
+    constructor(userUrl: string, client: IFetchClient);
+    /**
+     * Get a representation of a concrete current user's inventory role.
+     *
+     * @param {string|number|IUserInventoryRole} entityOrId inventory role id or inventory role object.
+     *
+     * @returns Returns promise object that is resolved with the IUserInventoryRole wrapped by IResult.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *    const inventoryRoleId: number = 1;
+     *
+     *    (async () => {
+     *      const {data, res} = await userInventoryRoleService.detail(inventoryRoleId);
+     *   })();
+     * ```
+     *
+     * Required role: ROLE_TENANT_MANAGEMENT_READ<br><br>
+     * User password is never returned in GET response. Authentication mechanism is provided by another interface.
+     */
+    detail(entityOrId: string | number | IUserInventoryRole): Promise<import("../core").IResult<IUserInventoryRole>>;
+    /**
+     * Assign inventory role to current user.
+     *
+     * @param {IUserInventoryRole} entity Inventory Role object.
+     *
+     * @returns Returns promise object that is resolved with the details of newly assigned inventory role.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *  const inventoryRoleObject: IUserInventoryRole = {
+     *    ...
+     *  };
+     *
+     *    (async () => {
+     *      const {data, res} = await userInventoryRoleService.create(inventoryRoleObject);
+     *   })();
+     * ```
+     */
+    create(entity: IUserInventoryRole): Promise<import("../core").IResult<IUserInventoryRole>>;
+    /**
+     * Updates an inventory role.
+     *
+     * @param {Partial<IUserInventoryRole>} entity Inventory Role object.
+     */
+    update(entity: Partial<IUserInventoryRole>): Promise<import("../core").IResult<IUserInventoryRole>>;
+    /**
+     * Gets the list the inventory roles applied to a current user.
+     *
+     * @param {object} filter Object containing filters for querying inventory roles.
+     *
+     * @returns Returns promise object that is resolved with the IUserInventoryRole wrapped by IResultList.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *  const filter: object = {
+     *     severity: Severity.MAJOR,
+     *     pageSize: 100,
+     *     withTotalPages: true
+     *   };
+     *
+     *   (async () => {
+     *     const {data, res, paging} = await userInventoryRoleService.list(filter);
+     *   })();
+     * ```
+     */
+    list(filter?: object): Promise<import("../core").IResultList<IUserInventoryRole>>;
+    /**
+     * Unassign inventory role from current user
+     *
+     * @param {string|number|IIdentified} entityOrId Inventory Role id or Inventory Role object.
+     *
+     * @returns Returns promise object that is resolved with the IResult.
+     *
+     * **Example**
+     * ```typescript
+     *
+     *    const inventoryRoleId: number = 1;
+     *
+     *    (async () => {
+     *      const {data, res} = await userInventoryRoleService.delete(inventoryRoleId);
+     *   })();
+     * ```
+     */
+    delete(entityOrId: string | number | IIdentified): Promise<import("../core").IResult<null>>;
+}
+//# sourceMappingURL=UserInventoryRoleService.d.ts.map