@vc-shell/framework 1.0.128 → 1.0.130

package/dist/core/api/platform.d.ts

@@ -58,7 +58,6 @@ export declare class AppsClient extends AuthApiBase {
         fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
     });
     /**
-     * Gets the list of available apps, filtered by user permissions.
      * @return Success
      */
     getApps(): Promise<AppDescriptor[]>;
@@ -72,7 +71,6 @@ export declare class ChangeLogClient extends AuthApiBase {
         fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
     });
     /**
-     * Force set changes last modified date
      * @param scope (optional)
      * @return Success
      */
@@ -84,11 +82,9 @@ export declare class ChangeLogClient extends AuthApiBase {
     resetPlatformCache(): Promise<void>;
     protected processResetPlatformCache(response: Response): Promise<void>;
     /**
-       * Get last modified date for given scope
-      Used for signal of what something changed and for cache invalidation in external platform clients
-       * @param scope (optional)
-       * @return Success
-       */
+     * @param scope (optional)
+     * @return Success
+     */
     getLastModifiedDate(scope?: string | undefined): Promise<LastModifiedResponse>;
     protected processGetLastModifiedDate(response: Response): Promise<LastModifiedResponse>;
     /**
@@ -130,7 +126,6 @@ export declare class DiagnosticsClient extends AuthApiBase {
     getSystemInfo(): Promise<SystemInfo>;
     protected processGetSystemInfo(response: Response): Promise<SystemInfo>;
     /**
-     * Get installed modules with errors
      * @return Success
      */
     getModulesErrors(): Promise<ModuleDescriptor[]>;
@@ -144,62 +139,53 @@ export declare class DynamicPropertiesClient extends AuthApiBase {
         fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
     });
     /**
-     * Get object types which support dynamic properties
      * @return Success
      */
     getObjectTypes(): Promise<string[]>;
     protected processGetObjectTypes(response: Response): Promise<string[]>;
     /**
-     * Get dynamic properties registered for object type
      * @param body (optional)
      * @return Success
      */
     searchDynamicProperties(body?: DynamicPropertySearchCriteria | undefined): Promise<DynamicPropertySearchResult>;
     protected processSearchDynamicProperties(response: Response): Promise<DynamicPropertySearchResult>;
     /**
-     * Add new dynamic property
      * @param body (optional)
      * @return Success
      */
     createProperty(body?: DynamicProperty | undefined): Promise<DynamicProperty>;
     protected processCreateProperty(response: Response): Promise<DynamicProperty>;
     /**
-     * Update existing dynamic property
      * @param body (optional)
      * @return Success
      */
     updateProperty(body?: DynamicProperty | undefined): Promise<void>;
     protected processUpdateProperty(response: Response): Promise<void>;
     /**
-     * Delete dynamic property
      * @param propertyIds (optional)
      * @return Success
      */
     deleteProperty(propertyIds?: string[] | undefined): Promise<void>;
     protected processDeleteProperty(response: Response): Promise<void>;
     /**
-     * Does nothing. Just a way to expose DynamicObjectProperty thru Swagger.
      * @return Success
      */
     exposeDynamicObjectProperty(): Promise<DynamicObjectProperty>;
     protected processExposeDynamicObjectProperty(response: Response): Promise<DynamicObjectProperty>;
     /**
-     * Get dictionary items
      * @param body (optional)
      * @return Success
      */
     searchDictionaryItems(body?: DynamicPropertyDictionaryItemSearchCriteria | undefined): Promise<DynamicPropertyDictionaryItemSearchResult>;
     protected processSearchDictionaryItems(response: Response): Promise<DynamicPropertyDictionaryItemSearchResult>;
     /**
-     * Add or update dictionary items
      * @param body (optional)
      * @return Success
      */
     saveDictionaryItems(body?: DynamicPropertyDictionaryItem[] | undefined): Promise<void>;
     protected processSaveDictionaryItems(response: Response): Promise<void>;
     /**
-     * Delete dictionary items
-     * @param ids (optional) IDs of dictionary items to delete.
+     * @param ids (optional)
      * @return Success
      */
     deleteDictionaryItem(ids?: string[] | undefined): Promise<void>;
@@ -213,13 +199,41 @@ export declare class JobsClient extends AuthApiBase {
         fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
     });
     /**
-     * Get background job status
-     * @param id Job ID.
      * @return Success
      */
     getStatus(id: string): Promise<Job>;
     protected processGetStatus(response: Response): Promise<Job>;
 }
+export declare class LocalizableSettingsClient extends AuthApiBase {
+    private http;
+    private baseUrl;
+    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
+    constructor(baseUrl?: string, http?: {
+        fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
+    });
+    /**
+     * @return Success
+     */
+    getSettingsAndLanguages(): Promise<LocalizableSettingsAndLanguages>;
+    protected processGetSettingsAndLanguages(response: Response): Promise<LocalizableSettingsAndLanguages>;
+    /**
+     * @return Success
+     */
+    getDictionaryValues(name: string, language: string): Promise<KeyValue[]>;
+    protected processGetDictionaryValues(response: Response): Promise<KeyValue[]>;
+    /**
+     * @param body (optional)
+     * @return Success
+     */
+    saveDictionaryItems(name: string, body?: DictionaryItem[] | undefined): Promise<void>;
+    protected processSaveDictionaryItems(response: Response): Promise<void>;
+    /**
+     * @param values (optional)
+     * @return Success
+     */
+    deleteDictionaryItems(name: string, values?: string[] | undefined): Promise<void>;
+    protected processDeleteDictionaryItems(response: Response): Promise<void>;
+}
 export declare class ModulesClient extends AuthApiBase {
     private http;
     private baseUrl;
@@ -228,59 +242,50 @@ export declare class ModulesClient extends AuthApiBase {
         fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
     });
     /**
-     * Reload  modules
      * @return Success
      */
     reloadModules(): Promise<void>;
     protected processReloadModules(response: Response): Promise<void>;
     /**
-     * Get installed modules
      * @return Success
      */
     getModules(): Promise<ModuleDescriptor[]>;
     protected processGetModules(response: Response): Promise<ModuleDescriptor[]>;
     /**
-     * Get all dependent modules for module
-     * @param body (optional) modules descriptors
+     * @param body (optional)
      * @return Success
      */
     getDependingModules(body?: ModuleDescriptor[] | undefined): Promise<ModuleDescriptor[]>;
     protected processGetDependingModules(response: Response): Promise<ModuleDescriptor[]>;
     /**
-     * Returns a flat expanded  list of modules that depend on passed modules
-     * @param body (optional) modules descriptors
+     * @param body (optional)
      * @return Success
      */
     getMissingDependencies(body?: ModuleDescriptor[] | undefined): Promise<ModuleDescriptor[]>;
     protected processGetMissingDependencies(response: Response): Promise<ModuleDescriptor[]>;
     /**
-     * Upload module package for installation or update
      * @return Success
      */
     uploadModuleArchive(): Promise<ModuleDescriptor>;
     protected processUploadModuleArchive(response: Response): Promise<ModuleDescriptor>;
     /**
-     * Install modules
-     * @param body (optional) modules for install
+     * @param body (optional)
      * @return Success
      */
     installModules(body?: ModuleDescriptor[] | undefined): Promise<ModulePushNotification>;
     protected processInstallModules(response: Response): Promise<ModulePushNotification>;
     /**
-     * Uninstall module
-     * @param body (optional) modules
+     * @param body (optional)
      * @return Success
      */
     uninstallModule(body?: ModuleDescriptor[] | undefined): Promise<ModulePushNotification>;
     protected processUninstallModule(response: Response): Promise<ModulePushNotification>;
     /**
-     * Restart web application
      * @return Success
      */
     restart(): Promise<void>;
     protected processRestart(response: Response): Promise<void>;
     /**
-     * Auto-install modules with specified groups
      * @return Success
      */
     tryToAutoInstallModules(): Promise<ModuleAutoInstallPushNotification>;
@@ -325,14 +330,12 @@ export declare class PushNotificationClient extends AuthApiBase {
         fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
     });
     /**
-     * SearchAsync push notifications
-     * @param body (optional) SearchAsync parameters.
+     * @param body (optional)
      * @return Success
      */
     searchPushNotification(body?: PushNotificationSearchCriteria | undefined): Promise<PushNotificationSearchResult>;
     protected processSearchPushNotification(response: Response): Promise<PushNotificationSearchResult>;
     /**
-     * Mark all notifications as read
      * @return Success
      */
     markAllAsRead(): Promise<PushNotificationSearchResult>;
@@ -346,20 +349,17 @@ export declare class SecurityClient extends AuthApiBase {
         fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
     });
     /**
-     * Sign in with user name and password
-     * @param body (optional) Login request.
+     * @param body (optional)
      * @return Success
      */
     login(body?: LoginRequest | undefined): Promise<SignInResult>;
     protected processLogin(response: Response): Promise<SignInResult>;
     /**
-     * Sign out
      * @return Success
      */
     logout(): Promise<void>;
     protected processLogout(response: Response): Promise<void>;
     /**
-     * Get current user details
      * @return Success
      */
     getCurrentUser(): Promise<UserDetail>;
@@ -370,114 +370,96 @@ export declare class SecurityClient extends AuthApiBase {
     userinfo(): Promise<Claim[]>;
     protected processUserinfo(response: Response): Promise<Claim[]>;
     /**
-     * Get all registered permissions
      * @return Success
      */
     getAllRegisteredPermissions(): Promise<Permission[]>;
     protected processGetAllRegisteredPermissions(response: Response): Promise<Permission[]>;
     /**
-     * SearchAsync roles by keyword
-     * @param body (optional) SearchAsync parameters.
+     * @param body (optional)
      * @return Success
      */
     searchRoles(body?: RoleSearchCriteria | undefined): Promise<RoleSearchResult>;
     protected processSearchRoles(response: Response): Promise<RoleSearchResult>;
     /**
-     * Get role by ID
      * @return Success
      */
     getRole(roleName: string): Promise<Role>;
     protected processGetRole(response: Response): Promise<Role>;
     /**
-     * Delete roles by ID
-     * @param ids (optional) An array of role IDs.
+     * @param ids (optional)
      * @return Success
      */
     deleteRoles(ids?: string[] | undefined): Promise<void>;
     protected processDeleteRoles(response: Response): Promise<void>;
     /**
-     * Update an existing role or create new
      * @param body (optional)
      * @return Success
      */
     updateRole(body?: Role | undefined): Promise<SecurityResult>;
     protected processUpdateRole(response: Response): Promise<SecurityResult>;
     /**
-     * SearchAsync users by keyword
-     * @param body (optional) Search criteria.
+     * @param body (optional)
      * @return Success
      */
     searchUsers(body?: UserSearchCriteria | undefined): Promise<UserSearchResult>;
     protected processSearchUsers(response: Response): Promise<UserSearchResult>;
     /**
-     * Get user details by user name
      * @return Success
      */
     getUserByName(userName: string): Promise<ApplicationUser>;
     protected processGetUserByName(response: Response): Promise<ApplicationUser>;
     /**
-     * Get user details by user ID
      * @return Success
      */
     getUserById(id: string): Promise<ApplicationUser>;
     protected processGetUserById(response: Response): Promise<ApplicationUser>;
     /**
-     * Get user details by user email
      * @return Success
      */
     getUserByEmail(email: string): Promise<ApplicationUser>;
     protected processGetUserByEmail(response: Response): Promise<ApplicationUser>;
     /**
-     * Get user details by external login provider
      * @return Success
      */
     getUserByLogin(loginProvider: string, providerKey: string): Promise<ApplicationUser>;
     protected processGetUserByLogin(response: Response): Promise<ApplicationUser>;
     /**
-     * Create new user
      * @param body (optional)
      * @return Success
      */
     create(body?: ApplicationUser | undefined): Promise<SecurityResult>;
     protected processCreate(response: Response): Promise<SecurityResult>;
     /**
-     * Change password for current user.
-     * @param body (optional) Old and new passwords.
+     * @param body (optional)
      * @return Success
      */
     changeCurrentUserPassword(body?: ChangePasswordRequest | undefined): Promise<SecurityResult>;
     protected processChangeCurrentUserPassword(response: Response): Promise<SecurityResult>;
     /**
-     * Change password
-     * @param userName user name
-     * @param body (optional) Old and new passwords.
+     * @param body (optional)
      * @return Success
      */
     changePassword(userName: string, body?: ChangePasswordRequest | undefined): Promise<SecurityResult>;
     protected processChangePassword(response: Response): Promise<SecurityResult>;
     /**
-     * Reset password confirmation
-     * @param body (optional) Password reset information containing new password.
+     * @param body (optional)
      * @return Success
      */
     resetPassword(userName: string, body?: ResetPasswordConfirmRequest | undefined): Promise<SecurityResult>;
     protected processResetPassword(response: Response): Promise<SecurityResult>;
     /**
-     * Reset password confirmation
-     * @param body (optional) New password.
+     * @param body (optional)
      * @return Success
      */
     resetPasswordByToken(userId: string, body?: ResetPasswordConfirmRequest | undefined): Promise<SecurityResult>;
     protected processResetPasswordByToken(response: Response): Promise<SecurityResult>;
     /**
-     * Validate password reset token
      * @param body (optional)
      * @return Success
      */
     validatePasswordResetToken(userId: string, body?: ValidatePasswordResetTokenRequest | undefined): Promise<boolean>;
     protected processValidatePasswordResetToken(response: Response): Promise<boolean>;
     /**
-     * Send email with instructions on how to reset user password.
      * @return Success
      */
     requestPasswordReset(loginOrEmail: string): Promise<void>;
@@ -495,42 +477,33 @@ export declare class SecurityClient extends AuthApiBase {
     validateUserPassword(body?: ChangePasswordRequest | undefined): Promise<IdentityResult>;
     protected processValidateUserPassword(response: Response): Promise<IdentityResult>;
     /**
-     * Update user details by user ID
-     * @param body (optional) User details.
+     * @param body (optional)
      * @return Success
      */
     update(body?: ApplicationUser | undefined): Promise<SecurityResult>;
     protected processUpdate(response: Response): Promise<SecurityResult>;
     /**
-     * Delete users by name
-     * @param names (optional) An array of user names.
+     * @param names (optional)
      * @return Success
      */
     delete(names?: string[] | undefined): Promise<void>;
     protected processDelete(response: Response): Promise<void>;
     /**
-     * Checks if user locked
-     * @param id User id
      * @return Success
      */
     isUserLocked(id: string): Promise<UserLockedResult>;
     protected processIsUserLocked(response: Response): Promise<UserLockedResult>;
     /**
-     * Checks if manual password change is enabled
      * @return Success
      */
     passwordChangeEnabled(): Promise<UserLockedResult>;
     protected processPasswordChangeEnabled(response: Response): Promise<UserLockedResult>;
     /**
-     * Lock user
-     * @param id >User id
      * @return Success
      */
     lockUser(id: string): Promise<SecurityResult>;
     protected processLockUser(response: Response): Promise<SecurityResult>;
     /**
-     * Unlock user
-     * @param id >User id
      * @return Success
      */
     unlockUser(id: string): Promise<SecurityResult>;
@@ -559,13 +532,11 @@ export declare class SecurityClient extends AuthApiBase {
     deleteUserApiKeys(ids?: string[] | undefined): Promise<UserApiKey[]>;
     protected processDeleteUserApiKeys(response: Response): Promise<UserApiKey[]>;
     /**
-     * Get allowed login types
      * @return Success
      */
     getLoginTypes(): Promise<LoginType[]>;
     protected processGetLoginTypes(response: Response): Promise<LoginType[]>;
     /**
-     * Verify user email
      * @return Success
      */
     sendVerificationEmail(userId: string): Promise<void>;
@@ -614,34 +585,27 @@ export declare class SettingClient extends AuthApiBase {
         fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
     });
     /**
-     * Get all settings
      * @return Success
      */
-    getAllGlobalSettings(): Promise<ObjectSettingEntry>;
-    protected processGetAllGlobalSettings(response: Response): Promise<ObjectSettingEntry>;
+    getAllGlobalSettings(): Promise<ObjectSettingEntry[]>;
+    protected processGetAllGlobalSettings(response: Response): Promise<ObjectSettingEntry[]>;
     /**
-     * Update settings values
      * @param body (optional)
      * @return Success
      */
     update(body?: ObjectSettingEntry[] | undefined): Promise<void>;
     protected processUpdate(response: Response): Promise<void>;
     /**
-     * Get settings registered by specific module
-     * @param id Module ID.
      * @return Success
      */
     getGlobalModuleSettings(id: string): Promise<ObjectSettingEntry[]>;
     protected processGetGlobalModuleSettings(response: Response): Promise<ObjectSettingEntry[]>;
     /**
-     * Get setting details by name
-     * @param name Setting system name.
      * @return Success
      */
     getGlobalSetting(name: string): Promise<ObjectSettingEntry>;
     protected processGetGlobalSetting(response: Response): Promise<ObjectSettingEntry>;
     /**
-     * Get UI customization setting
      * @return Success
      */
     getUICustomizationSetting(): Promise<ObjectSettingEntry>;
@@ -920,6 +884,18 @@ export declare class ConfirmEmailRequest implements IConfirmEmailRequest {
 export interface IConfirmEmailRequest {
     token?: string | undefined;
 }
+export declare class DictionaryItem implements IDictionaryItem {
+    alias?: string | undefined;
+    localizedValues?: LocalizedValue[] | undefined;
+    constructor(data?: IDictionaryItem);
+    init(_data?: any): void;
+    static fromJS(data: any): DictionaryItem;
+    toJSON(data?: any): any;
+}
+export interface IDictionaryItem {
+    alias?: string | undefined;
+    localizedValues?: LocalizedValue[] | undefined;
+}
 export declare class DynamicObjectProperty implements IDynamicObjectProperty {
     objectId?: string | undefined;
     values?: DynamicPropertyObjectValue[] | undefined;
@@ -1181,6 +1157,7 @@ export declare enum EntryState {
 export declare class ExternalSignInProviderInfo implements IExternalSignInProviderInfo {
     authenticationType?: string | undefined;
     displayName?: string | undefined;
+    logoUrl?: string | undefined;
     constructor(data?: IExternalSignInProviderInfo);
     init(_data?: any): void;
     static fromJS(data: any): ExternalSignInProviderInfo;
@@ -1189,6 +1166,7 @@ export declare class ExternalSignInProviderInfo implements IExternalSignInProvid
 export interface IExternalSignInProviderInfo {
     authenticationType?: string | undefined;
     displayName?: string | undefined;
+    logoUrl?: string | undefined;
 }
 export declare class IdentityError implements IIdentityError {
     code?: string | undefined;
@@ -1248,6 +1226,18 @@ export declare enum JsonValueKind {
     False = "False",
     Null = "Null"
 }
+export declare class KeyValue implements IKeyValue {
+    key?: string | undefined;
+    value?: string | undefined;
+    constructor(data?: IKeyValue);
+    init(_data?: any): void;
+    static fromJS(data: any): KeyValue;
+    toJSON(data?: any): any;
+}
+export interface IKeyValue {
+    key?: string | undefined;
+    value?: string | undefined;
+}
 export declare class LastModifiedResponse implements ILastModifiedResponse {
     scope?: string | undefined;
     lastModifiedDate?: Date;
@@ -1278,6 +1268,42 @@ export interface ILicense {
     expirationDate?: Date;
     rawLicense?: string | undefined;
 }
+export declare class LocalizableSetting implements ILocalizableSetting {
+    name?: string | undefined;
+    items?: DictionaryItem[] | undefined;
+    constructor(data?: ILocalizableSetting);
+    init(_data?: any): void;
+    static fromJS(data: any): LocalizableSetting;
+    toJSON(data?: any): any;
+}
+export interface ILocalizableSetting {
+    name?: string | undefined;
+    items?: DictionaryItem[] | undefined;
+}
+export declare class LocalizableSettingsAndLanguages implements ILocalizableSettingsAndLanguages {
+    settings?: LocalizableSetting[] | undefined;
+    languages?: string[] | undefined;
+    constructor(data?: ILocalizableSettingsAndLanguages);
+    init(_data?: any): void;
+    static fromJS(data: any): LocalizableSettingsAndLanguages;
+    toJSON(data?: any): any;
+}
+export interface ILocalizableSettingsAndLanguages {
+    settings?: LocalizableSetting[] | undefined;
+    languages?: string[] | undefined;
+}
+export declare class LocalizedValue implements ILocalizedValue {
+    languageCode?: string | undefined;
+    value?: string | undefined;
+    constructor(data?: ILocalizedValue);
+    init(_data?: any): void;
+    static fromJS(data: any): LocalizedValue;
+    toJSON(data?: any): any;
+}
+export interface ILocalizedValue {
+    languageCode?: string | undefined;
+    value?: string | undefined;
+}
 export declare class LoginRequest implements ILoginRequest {
     userName?: string | undefined;
     password?: string | undefined;
@@ -1496,6 +1522,7 @@ export declare class ObjectSettingEntry implements IObjectSettingEntry {
     allowedValues?: any[] | undefined;
     defaultValue?: any | undefined;
     isDictionary?: boolean;
+    isLocalizable?: boolean;
     constructor(data?: IObjectSettingEntry);
     init(_data?: any): void;
     static fromJS(data: any): ObjectSettingEntry;
@@ -1519,6 +1546,7 @@ export interface IObjectSettingEntry {
     allowedValues?: any[] | undefined;
     defaultValue?: any | undefined;
     isDictionary?: boolean;
+    isLocalizable?: boolean;
 }
 export declare class OpenIddictApplicationDescriptor implements IOpenIddictApplicationDescriptor {
     clientId?: string | undefined;
@@ -1919,6 +1947,7 @@ export declare class SystemInfo implements ISystemInfo {
     is64BitOperatingSystem?: boolean;
     is64BitProcess?: boolean;
     databaseProvider?: string | undefined;
+    environmentName?: string | undefined;
     constructor(data?: ISystemInfo);
     init(_data?: any): void;
     static fromJS(data: any): SystemInfo;
@@ -1932,6 +1961,7 @@ export interface ISystemInfo {
     is64BitOperatingSystem?: boolean;
     is64BitProcess?: boolean;
     databaseProvider?: string | undefined;
+    environmentName?: string | undefined;
 }
 export declare class UserApiKey implements IUserApiKey {
     apiKey?: string | undefined;
@@ -1965,6 +1995,8 @@ export declare class UserDetail implements IUserDetail {
     isAdministrator?: boolean;
     passwordExpired?: boolean;
     daysTillPasswordExpiry?: number;
+    authenticationMethod?: string | undefined;
+    isSsoAuthenticationMethod?: boolean;
     id?: string | undefined;
     constructor(data?: IUserDetail);
     init(_data?: any): void;
@@ -1977,6 +2009,8 @@ export interface IUserDetail {
     isAdministrator?: boolean;
     passwordExpired?: boolean;
     daysTillPasswordExpiry?: number;
+    authenticationMethod?: string | undefined;
+    isSsoAuthenticationMethod?: boolean;
     id?: string | undefined;
 }
 export declare class UserLockedResult implements IUserLockedResult {
@@ -1994,6 +2028,8 @@ export declare class UserSearchCriteria implements IUserSearchCriteria {
     memberIds?: string[] | undefined;
     modifiedSinceDate?: Date | undefined;
     roles?: string[] | undefined;
+    lasLoginDate?: Date | undefined;
+    onlyUnlocked?: boolean;
     responseGroup?: string | undefined;
     objectType?: string | undefined;
     objectTypes?: string[] | undefined;
@@ -2015,6 +2051,8 @@ export interface IUserSearchCriteria {
     memberIds?: string[] | undefined;
     modifiedSinceDate?: Date | undefined;
     roles?: string[] | undefined;
+    lasLoginDate?: Date | undefined;
+    onlyUnlocked?: boolean;
     responseGroup?: string | undefined;
     objectType?: string | undefined;
     objectTypes?: string[] | undefined;