@ale-rainbow/web-sdk 5.1.0

package/lib/models/userProfileTemplate.model.d.ts

@@ -0,0 +1,735 @@
+/**
+ * This type defines a string union of all feature customization property names.
+ */
+type UserProfileFeatureCustomizationProperty = keyof IUserProfileFeatureCustomizationDTO;
+/**
+ *  Collection of User Profile template's type values.
+ */
+export declare enum UserProfileTemplateType {
+    /**
+     * This is the unique public template named "Same as company" used to reset user with "same_as_company" values.
+     */
+    SAME_AS_COMPANY = "default_user",
+    /**
+     * This is the unique pulic template named "Full".
+     */
+    FULL = "default_company",
+    /**
+     * This is the unique private template belonging to a standalone company
+     */
+    PRIVATE = "private_default_company",
+    /**
+     * This is a public or private template belonging to a company (standalone or BP).
+     *
+     * @remarks
+     *  A public template can be shared when owned by a BP.
+     */
+    OTHER = "other"
+}
+/**
+ *  Collection of User Profile template's visibility values.
+ */
+export declare enum UserProfileTemplateVisibility {
+    /**
+     * This is a predefined template designed by Rainbow Team.
+     */
+    PUBLIC = "public",
+    /**
+     * This is a private template as defined by 'ownedByCompany' and 'visibleBy' field.
+     */
+    PRIVATE = "private"
+}
+/**
+ * Collection of User Profile feature permission values.
+ *
+ * @remarks
+ *  Other values are possible.
+ */
+export declare enum UserProfilePermission {
+    /**
+     * The feature permission is as defined at the company level.
+     *
+     * @remarks
+     *  Only for user settings.
+     */
+    SAME_AS_COMPANY = "same_than_company",
+    /**
+     * The feature is enabled.
+     */
+    ENABLED = "enabled",
+    /**
+     * The feature is disabled.
+     */
+    DISABLED = "disabled"
+}
+/**
+ * Collection of User Profile feature customization's permission values.
+ */
+export declare enum UserProfileTemplatePermission {
+    /**
+     * The customizable permission is enabled.
+     */
+    ENABLED = "enabled",
+    /**
+     * The customizable permission is disabled.
+     */
+    DISABLED = "disabled"
+}
+/**
+ * Data Transfer Object (DTO) for transferring required data that represents set of customizable user's feature permissions {@link https://api.openrainbow.org/admin/#api-companies}.
+ */
+export interface IUserProfileFeatureCustomizationDTO {
+    /**
+     * The capability for a user to use and receive instant messages.
+     */
+    instantMessagesCustomisation: "enabled" | "disabled";
+    /**
+     * The ability for a user to use GIFs in conversations.
+     */
+    useGifCustomisation: "enabled" | "disabled";
+    /**
+     * The file sharing capability per company.
+     */
+    fileSharingCustomisation: "enabled" | "disabled";
+    /**
+     * The file transfer capability per company.
+     */
+    fileTransferCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to access to Rainbow file storage
+     */
+    fileStorageCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to use phone meetings (PSTN conference).
+     */
+    phoneMeetingCustomisation: "enabled" | "disabled";
+    /**
+     *  The capability for a user to use dial out in phone meetings.
+     */
+    useDialOutCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to use and join a channel.
+     */
+    useChannelCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to create a channel.
+     */
+    createChannelCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to use bubbles.
+     */
+    useRoomCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to share a screen.
+     */
+    useScreenSharingCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to switch to a Web RTC audio conversation.
+     */
+    useWebRTCAudioCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to receive web RTC call if mobile app is signed in.
+     */
+    useWebRTCOnlyIfMobileLoggedCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to switch to a Web RTC video conversation.
+     */
+    useWebRTCVideoCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to record a conversation.
+     */
+    recordingConversationCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to change manually his presence.
+     */
+    overridePresenceCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to modify his profile.
+     */
+    userProfileCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to modify his profile (title, firstName, lastName) per company.
+     */
+    userTitleNameCustomisation: "enabled" | "disabled";
+    /**
+     * The ability for a user to modify telephony settings.
+     */
+    changeTelephonyCustomisation: "enabled" | "disabled";
+    /**
+     * The ability for a user to change all client general settings.
+     */
+    changeSettingsCustomisation: "enabled" | "disabled";
+    /**
+     * The ability for a user to allow a sender to check if a chat message is read.
+     */
+    readReceiptsCustomisation: "enabled" | "disabled";
+    /**
+     * The capability to protect content (screen capture, copy/paste, hyperlink navigation).
+     */
+    protectedContentCustomisation: "enabled" | "disabled";
+    /**
+     * The ability for a user to see speaking time statistics.
+     */
+    useSpeakingTimeStatistics: "enabled" | "disabled";
+    /**
+     * The ability for a user to participate on an e-learning training.
+     */
+    eLearningCustomisation: "enabled" | "disabled";
+    /**
+     * The ability for a user to earn badges for Elearning progress.
+     */
+    eLearningGamificationCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to record a meeting.
+     */
+    meetingRecordingCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to require an explicit consent before the recording begins.
+     */
+    recordingConsentModeCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to be on other phone mode.
+     */
+    useOtherPhoneMode: "enabled" | "disabled";
+    /**
+     * The capability for a user to be on computer mode.
+     */
+    useComputerMode: "enabled" | "disabled";
+    /**
+     * The capability for a user to be on softphone mode.
+     */
+    useSoftPhoneMode: "enabled" | "disabled" | "forced";
+    /**
+     * The capability for a user to be on Teams mode.
+     */
+    useTeamsMode: "enabled" | "disabled";
+    /**
+     * Defines the IM popup duration.
+     */
+    imPopupDuration: number;
+    /**
+     * The capability for a user to access to what's new.
+     */
+    canAccessWhatsNew: "enabled" | "disabled";
+    /**
+     * The capability for a user to access to FAQ.
+     */
+    canAccessFaqCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to access to help center.
+     */
+    canAccessHelpCenterCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to access to Rainbow store.
+     */
+    canAccessStoreCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to download Rainbow application.
+     */
+    canDownloadAppCustomisation: "enabled" | "disabled";
+    /**
+     * The ability for a user to test the configuration.
+     */
+    canUseTestConfigCustomisation: "enabled" | "disabled";
+    /**
+     * The ability for a user to send anomaly reports.
+     */
+    canUseSendReportCustomisation: "enabled" | "disabled";
+    /**
+     * The ability for a user to create and use tasks.
+     */
+    canUseTaskCustomisation: "enabled" | "disabled";
+    /**
+     * Select the kind of call participant number.
+     */
+    canCallParticipantPbxNumberCustomisation: "enabled" | "disabled" | "internal" | "national";
+    /**
+     * The capability for a user to set invisible presence
+     */
+    canSetInvisiblePresenceCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to restrict the receiving of files to protect from data coming from a foreign user of the company
+     */
+    receivedFileCustomisation: "enabled" | "disabled" | "internalOnly";
+    /**
+     * The capability for a user to add or change avatar.
+     */
+    userAvatarCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to synchronize the calendar
+     */
+    canSynchCalendar: "enabled" | "disabled";
+    /**
+     * The capability for a user to enable transcript in a meeting
+     */
+    canUseTranscriptionCustomisation: "enabled" | "disabled";
+    /**
+     * The capability to hide the user's Offline/Away presence duration
+     */
+    hidePresenceDurationCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to set DND on Rainbow phone call.
+     */
+    canSetDNDinTeams: "enabled" | "disabled";
+    /**
+     * The capability for a user to change the order between rainbow calls and phone calls
+     */
+    showFirstPhoneCalls: "enabled" | "disabled";
+    /**
+     * The capability to disable the ringing when a conference call starts
+     */
+    noRingingConferenceStartCustomisation: "enabled" | "disabled";
+    /**
+     * The ability for a user to change to DND in full screen mode.
+     */
+    changeDNDFullScreen: "enabled" | "disabled";
+    /**
+     * The ability for a user to set presence to DND in calendar appointment.
+     */
+    setDNDAppointment: "enabled" | "disabled";
+    /**
+     * The ability for a user to ignore VOIP call in DND.
+     */
+    ignoreVoipCallInDND: "enabled" | "disabled";
+    /**
+     * The ability for a user to auto-accept for external applications (CPasS).
+     */
+    autoAcceptExternalApp: "enabled" | "disabled";
+    /**
+     * The ability for a user to manage customization file (CPasS).
+     */
+    manageCustomizationFile: "enabled" | "disabled";
+    /**
+     * The ability for a user to use personal access tokens (CPasS).
+     */
+    usePersonalAccessTokens: "enabled" | "disabled";
+}
+/**
+ * Data Transfer Object (DTO) for transferring required data that represents a User Profile template defining user's feature permissions.
+ */
+export interface IUserProfileTemplateDTO extends IUserProfileFeatureCustomizationDTO {
+    /**
+     * The unique identifier of the template.
+     * @readonly
+     */
+    readonly id?: string;
+    /**
+     * The name of the template.
+     */
+    name: string;
+    /**
+     * The identifier of the company owning the template.
+     * @readonly
+     */
+    readonly ownedByCompany: string;
+    /**
+     * The template's type.
+     * @readonly
+     */
+    readonly type: UserProfileTemplateType;
+    /**
+     * The template's visibility.
+     * @readonly
+     */
+    readonly visibility: UserProfileTemplateVisibility;
+    /**
+     * The list of company identifiers that can access the template (other than the 'ownedByCompany' one), if visibility is private.
+     */
+    visibleBy?: string[];
+    /**
+     * The identifier of the user who created the template.
+     * @readonly
+     */
+    readonly createdBy?: string;
+    /**
+     * The date when the template has been created.
+     * @readonly
+     */
+    readonly creationDate?: string;
+}
+/**
+ *  This class is used to represent a customization template in Rainbow.
+ *  - A template is a set of key feature controlled by permission.
+ *  - A template can be applied to a company, to a user.
+ *  - Custom templates may be created.
+ */
+export declare class UserProfileTemplate implements IUserProfileTemplateDTO {
+    /**
+     * The unique identifier of the template.
+     * @readonly
+     */
+    id: string;
+    /**
+     * The name of the template.
+     */
+    name: string;
+    /**
+     * The identifier of the company owning the template.
+     * @readonly
+     */
+    ownedByCompany: string;
+    /**
+     * The template's type.
+     * @readonly
+     */
+    type: UserProfileTemplateType;
+    /**
+     * The template's visibility.
+     * @readonly
+     */
+    visibility: UserProfileTemplateVisibility;
+    /**
+     * The list of company identifiers that can access the template (other than the 'ownedByCompany' one), if visibility is private.
+     */
+    visibleBy: string[];
+    /**
+     * The identifier of the user who created the template.
+     * @readonly
+     */
+    createdBy: string;
+    /**
+     * The date when the template has been created.
+     * @readonly
+     */
+    creationDate: string;
+    /**
+     * The template's display name (translated).
+     */
+    displayName: string;
+    /**
+     * The template's display description (translated).
+     */
+    displayDescription: string;
+    /**
+     * The capability for a user to use and receive instant messages.
+     */
+    instantMessagesCustomisation: "enabled" | "disabled";
+    /**
+     * The ability for a user to use GIFs in conversations.
+     */
+    useGifCustomisation: "enabled" | "disabled";
+    /**
+     * The file sharing capability per company.
+     */
+    fileSharingCustomisation: "enabled" | "disabled";
+    /**
+     * The file transfer capability per company.
+     */
+    fileTransferCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to access to Rainbow file storage
+     */
+    fileStorageCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to use phone meetings (PSTN conference).
+     */
+    phoneMeetingCustomisation: "enabled" | "disabled";
+    /**
+     *  The capability for a user to use dial out in phone meetings.
+     */
+    useDialOutCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to use a channel.
+     */
+    useChannelCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to create a channel.
+     */
+    createChannelCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to use bubbles.
+     */
+    useRoomCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to share a screen.
+     */
+    useScreenSharingCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to switch to a Web RTC audio conversation.
+     */
+    useWebRTCAudioCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to receive web RTC call if mobile app is signed in.
+     */
+    useWebRTCOnlyIfMobileLoggedCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to switch to a Web RTC video conversation.
+     */
+    useWebRTCVideoCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to record a conversation.
+     */
+    recordingConversationCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to change manually his presence.
+     */
+    overridePresenceCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to modify his profile.
+     */
+    userProfileCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to modify his profile (title, firstName, lastName) per company.
+     */
+    userTitleNameCustomisation: "enabled" | "disabled";
+    /**
+     * The ability for a user to modify telephony settings.
+     */
+    changeTelephonyCustomisation: "enabled" | "disabled";
+    /**
+     * The ability for a user to change all client general settings.
+     */
+    changeSettingsCustomisation: "enabled" | "disabled";
+    /**
+     * The ability for a user to allow a sender to check if a chat message is read.
+     */
+    readReceiptsCustomisation: "enabled" | "disabled";
+    /**
+     * The capability to protect content (screen capture, copy/paste, hyperlink navigation).
+     */
+    protectedContentCustomisation: "enabled" | "disabled";
+    /**
+     * The ability for a user to see speaking time statistics.
+     */
+    useSpeakingTimeStatistics: "enabled" | "disabled";
+    /**
+     * The ability for a user to participate on an e-learning training.
+     */
+    eLearningCustomisation: "enabled" | "disabled";
+    /**
+     * The ability for a user to earn badges for Elearning progress.
+     */
+    eLearningGamificationCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to record a meeting.
+     */
+    meetingRecordingCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to require an explicit consent before the recording begins.
+     */
+    recordingConsentModeCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to be on other phone mode.
+     */
+    useOtherPhoneMode: "enabled" | "disabled";
+    /**
+     * The capability for a user to be on computer mode.
+     */
+    useComputerMode: "enabled" | "disabled";
+    /**
+     * The capability for a user to be on softphone mode.
+     */
+    useSoftPhoneMode: "enabled" | "disabled" | "forced";
+    /**
+     * The capability for a user to be on Teams mode.
+     */
+    useTeamsMode: "enabled" | "disabled";
+    /**
+     * Defines the IM popup duration.
+     */
+    imPopupDuration: number;
+    /**
+     * The capability for a user to access to what's new.
+     */
+    canAccessWhatsNew: "enabled" | "disabled";
+    /**
+     * The capability for a user to access to FAQ.
+     */
+    canAccessFaqCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to access to help center.
+     */
+    canAccessHelpCenterCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to access to Rainbow store.
+     */
+    canAccessStoreCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to download Rainbow application.
+     */
+    canDownloadAppCustomisation: "enabled" | "disabled";
+    /**
+     * The ability for a user to test the configuration.
+     */
+    canUseTestConfigCustomisation: "enabled" | "disabled";
+    /**
+     * The ability for a user to send anomaly reports.
+     */
+    canUseSendReportCustomisation: "enabled" | "disabled";
+    /**
+     * The ability for a user to create and use tasks.
+     */
+    canUseTaskCustomisation: "enabled" | "disabled";
+    /**
+     * Select the kind of call participant number.
+     */
+    canCallParticipantPbxNumberCustomisation: "enabled" | "disabled" | "internal" | "national";
+    /**
+     * The capability for a user to set invisible presence
+     */
+    canSetInvisiblePresenceCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to restrict the receiving of files to protect from data coming from a foreign user of the company
+     */
+    receivedFileCustomisation: "enabled" | "disabled" | "internalOnly";
+    /**
+     * The capability for a user to add or change avatar.
+     */
+    userAvatarCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to synchronize the calendar
+     */
+    canSynchCalendar: "enabled" | "disabled";
+    /**
+     * The capability for a user to enable transcript in a meeting
+     */
+    canUseTranscriptionCustomisation: "enabled" | "disabled";
+    /**
+     * The capability to hide the user's Offline/Away presence duration
+     */
+    hidePresenceDurationCustomisation: "enabled" | "disabled";
+    /**
+     * The capability for a user to set DND on Rainbow phone call.
+     */
+    canSetDNDinTeams: "enabled" | "disabled";
+    /**
+     * The capability for a user to change the order between rainbow calls and phone calls.
+     */
+    showFirstPhoneCalls: "enabled" | "disabled";
+    /**
+     * The capability to disable the ringing when a conference call starts.
+     */
+    noRingingConferenceStartCustomisation: "enabled" | "disabled";
+    /**
+     * The ability for a user to change to DND in full screen mode.
+     */
+    changeDNDFullScreen: "enabled" | "disabled";
+    /**
+     * The ability for a user to set presence to DND in calendar appointment.
+     */
+    setDNDAppointment: "enabled" | "disabled";
+    /**
+     * The ability for a user to ignore VOIP call in DND.
+     */
+    ignoreVoipCallInDND: "enabled" | "disabled";
+    /**
+     * The ability for a user to auto-accept for external applications (CPasS).
+     */
+    autoAcceptExternalApp: "enabled" | "disabled";
+    /**
+     * The ability for a user to manage customization file (CPasS).
+     */
+    manageCustomizationFile: "enabled" | "disabled";
+    /**
+     * The ability for a user to use personal access tokens (CPasS).
+     */
+    usePersonalAccessTokens: "enabled" | "disabled";
+    /**
+     * The list of Feature Customization property names.
+     *
+     * @privateRemarks
+     *  See comments about {@link TupleOfUnion}.
+     */
+    private static features;
+    /**
+     * Constructor.
+     *
+     * @param attributes - the information about the template.
+     */
+    private constructor();
+    /**
+     * Gets the value of a feature customization property of this template.
+     *
+     * @param name - the name of the feature customization property.
+     * @returns the value of the property if exists, otherwise undefined.
+     */
+    getValue(name: UserProfileFeatureCustomizationProperty): any;
+    /**
+     * Determines if this template can be edited by the specified company.
+     *
+     * @param companyId - the company identifier for which the edition is requested.
+     * @returns true if the template can be edited by the company, otherwise false.
+     */
+    isEditable(companyId: string): boolean;
+    /**
+     * Indicates if this template can be applied to a company.
+     *
+     * @returns true if the template can be applied to a company, otherwise false.
+     */
+    isApplyAllowedToCompany(): boolean;
+    /**
+     * Indicates if this template is used to reset company permissions with default values.
+     *
+     * @returns true if the template is used to reset company permissions with default values, otherwise false.
+     */
+    isCompanyDefault(): boolean;
+    /**
+     * Indicates if this template is used to reset user permissions with default values.
+     *
+     * @returns true if the template is used to reset user permissions with default values, otherwise false.
+     */
+    isUserDefault(): boolean;
+    /**
+     * Indicates if this template can be applied to a user.
+     *
+     * @returns true if the template can be applied to a user, otherwise false.
+     */
+    isApplyAllowedToUser(): boolean;
+    /**
+     * Determines if the feature customization is the same than the customization of this template.
+     *
+     * @param data - the object containing the customization data to compare
+     * @returns true if the specified customization is equal to the template's customization, otherwise false.
+     */
+    isEqual(data: IUserProfileFeatureCustomizationDTO): boolean;
+    /**
+     * Copies all the feature customization properties of this template in the specified object.
+     *
+     * @param data - the object where all the feature customization properties of the template must be copied.
+     */
+    copyTo(data: unknown): void;
+    /**
+     * Removes all the feature customization properties from the specified object.
+     *
+     * @param data - the object where the customization properties must be removed.
+     */
+    static removeFrom(data: unknown): void;
+    /**
+     * Gets the list feature names managed by the User Profile templates.
+     *
+     * @returns an array of feature names managed by the User Profile templates.
+     */
+    static keys(): string[];
+    /**
+     * Determines if the specified feature property name is managed by a User Profile template.
+     *
+     * @param name - The name of the feature property to check.
+     * @returns true if the name is a feature customization property a User Profile template, otherwise false.
+     */
+    static contains(name: any): boolean;
+    /**
+     * Comparator to sort templates.
+     */
+    static sortComparator(template1: UserProfileTemplate, template2: UserProfileTemplate): 0 | 1 | -1;
+    static getUserProfileTemplateNameLabel(template: IUserProfileTemplateDTO): string;
+    static getUserProfileTemplateDescriptionLabel(template: IUserProfileTemplateDTO): string;
+    /**
+     * Creates an instance of {@link UserProfileTemplate}.
+     *
+     * @param data - the object containing the attributes of the user profile template.
+     * @returns the created {@link UserProfileTemplate} object.
+     */
+    static createFromData(data: IUserProfileTemplateDTO): UserProfileTemplate;
+    /**
+     * Creates an instance of {@link UserProfileTemplate} with a default customization.
+     *
+     * @param name - the name of the template.
+     * @param companyId - the identifier of the company owning the template.
+     * @param type - the type of the template.
+     * @param visibility - the type of the template.
+     * @returns the created {@link UserProfileTemplate} object.
+     */
+    static create(name: string, companyId: string, type?: UserProfileTemplateType, visibility?: UserProfileTemplateVisibility): UserProfileTemplate;
+}
+export {};
+//# sourceMappingURL=userProfileTemplate.model.d.ts.map