@ale-rainbow/web-sdk 5.1.0

package/lib/services/directory/directory.service.d.ts

@@ -0,0 +1,108 @@
+import type { Subscription } from "rxjs";
+import type { Contact } from "../../models/contact.model";
+import { Service } from "../../services/service";
+import type { DirectoryInternalSearchResults, DirectorySearchOptions } from "../core/directorySearch.service";
+export declare const DIRECTORY_SVC = "DirectoryService";
+declare class SdkApis {
+    searchUserByLogin: any;
+    searchUserByJid: any;
+    searchUserByPhoneNumber: any;
+    searchAllContacts: any;
+    constructor(searchUserByLogin?: any, searchUserByJid?: any, searchUserByPhoneNumber?: any, searchAllContacts?: any);
+}
+/**
+ * Rainbow Directory service allows access to contacts search
+ * SDK supports only the APIs listed in the _sdkApis array (you can access it through i.e. rainbowSDK.directoryService._sdkApis)
+ */
+export declare class DirectoryService extends Service implements SdkApis {
+    private centralizedService;
+    private authService;
+    private profileService;
+    private contactService;
+    private conversationService;
+    private logger;
+    private errorHelperService;
+    private mainService;
+    _sdkApis: any[];
+    private rxSubject;
+    static getInstance(): DirectoryService;
+    static build(): DirectoryService;
+    private constructor();
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    subscribe(observer: any): Subscription;
+    searchRainbowUsers(searchPattern: string, options?: DirectorySearchOptions, filterOwnUser?: boolean): Promise<DirectoryInternalSearchResults>;
+    /**
+     * Method searchUserByLogin
+     * @description Search for a contact through its email address (used for login).
+     * @memberof DirectoryService
+     * @public
+     * @async
+     * @param {string} loginEmail User email address (used for login) used as search criteria
+     * @returns {Promise} Promise that resolves with a contact matching the provided loginEmail or rejects with an Error
+     */
+    searchUserByLogin(loginEmail: string): Promise<Contact>;
+    /**
+     * Method searchUserByJid
+     * @description Search for a contact through its jid.
+     * @memberof DirectoryService
+     * @public
+     * @async
+     * @param {string} jid User jid_im used as search criteria
+     * @returns {Promise} Promise that resolves with a contact matching the jid provided or rejects with an Error
+     */
+    searchUserByJid(jid: string): Promise<Contact>;
+    /**
+     * Method searchUserByPhoneNumber
+     * @description Search for a contact being associated to the requested phone number.
+     * @memberof DirectoryService
+     * @public
+     * @async
+     * @param {string} phoneNumber Phone number to search used as search criteria
+     * @returns {Promise} Promise that resolves with a contact matching the phoneNumber provided or rejects with an Error
+     */
+    searchUserByPhoneNumber(phoneNumber: string): Promise<Contact>;
+    /**
+     * Method searchAllContacts
+     * @description Search for a contact matching a string.
+     * @memberof DirectoryService
+     * @public
+     * @async
+     * @param {string} searchText text to search
+     * @param {number} [limit]  Max number of result. Default: 20
+     * @param {string} [companyId] ID of the company on which users are searched. Default = ""
+     * companyId and excludeCompanyId parameters are exclusives, companyId parameter can only be set if excludeCompanyId parameter is not provided.
+     * @param {boolean} [addRosters] whether or not to include our contact roster in the search. Default: true
+     * @param {boolean} [addOutlook] whether or not to include our outlook contacts in the search. Default: true
+     * @param {string} [excludeCompanyId] Exclude users being in the requested company ID from the search results. Default = null
+     * companyId and excludeCompanyId parameters are exclusives, excludeCompanyId parameter can only be set if companyId parameter is not provided.
+     * @returns {Promise} Promise that resolves with an array containing a list of contacts matching the searchText or rejects with an Error
+     */
+    searchAllContacts(searchText: string, limit?: number, companyId?: string, addRosters?: boolean, addOutlook?: boolean, excludeCompanyId?: string, filterOwnUser?: boolean): Promise<any[]>;
+    /**
+     * Search Microsoft Outlook personal contacts through the desktop "centralized service".
+     *
+     * Desktop client only: returns an empty array when not running in the desktop app or when
+     * the centralized Outlook service is unavailable.
+     *
+     * Runs two independent, fault-tolerant lookups (by name, then by email); if either Outlook
+     * service is down it is logged and skipped. Both result sets are merged and de-duplicated
+     * by `contactID` (see `mergeOutlookContact`).
+     *
+     * @param searchPattern - The text to search Outlook contacts for (name / email).
+     * @param rawResults - When `true` (default), returns raw Outlook data adapted for display
+     *   (avatars, phone numbers…) as `any[]`. When `false`, returns SDK `Contact[]` instances
+     *   built via `createDirectoryContact` + `updateContactWithOutlookData`.
+     * @returns Merged, de-duplicated Outlook contacts, or `[]` when unavailable.
+     */
+    searchOutlookContactsForDesktopApp(searchPattern: string, rawResults?: boolean): Promise<Contact[] | any[]>;
+    /**
+     * Update the specified RB contact instance with the provided Microsoft Outlook contact data.
+     */
+    private updateContactWithOutlookData;
+    private adaptOutlookContacts;
+    private searchOutlookUsersByName;
+    private searchOutlookUsersByEmail;
+}
+export {};
+//# sourceMappingURL=directory.service.d.ts.map

package/lib/services/directory/directory.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"directory.service.d.ts","sourceRoot":"","sources":["../../../src/services/directory/directory.service.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAIzC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,2CAA2C,CAAC;AASzE,OAAO,EAAE,OAAO,EAAE,MAAM,uCAAuC,CAAC;AAChE,OAAO,KAAK,EAAE,8BAA8B,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAG9G,eAAO,MAAM,aAAa,qBAAqB,CAAC;AAGhD,cAAM,OAAO;IAGE,iBAAiB,EAAE,GAAG;IACtB,eAAe,EAAE,GAAG;IACpB,uBAAuB,EAAE,GAAG;IAC5B,iBAAiB,EAAE,GAAG;gBAHtB,iBAAiB,GAAE,GAAU,EAC7B,eAAe,GAAE,GAAU,EAC3B,uBAAuB,GAAE,GAAU,EACnC,iBAAiB,GAAE,GAAU;CAE3C;AAGD;;;GAGG;AACH,qBAAa,gBAAiB,SAAQ,OAAQ,YAAW,OAAO;IAG5D,OAAO,CAAC,kBAAkB,CAAM;IAChC,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,cAAc,CAAgD;IACtE,OAAO,CAAC,cAAc,CAAgD;IACtE,OAAO,CAAC,mBAAmB,CAA8D;IACzF,OAAO,CAAC,MAAM,CAA8C;IAC5D,OAAO,CAAC,kBAAkB,CAAwD;IAClF,OAAO,CAAC,WAAW,CAA0C;IACtD,QAAQ,EAAE,GAAG,EAAE,CAA8B;IAKpD,OAAO,CAAC,SAAS,CAAmB;WAEtB,WAAW;WAIX,KAAK;IAInB,OAAO;IASM,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAYtB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAM3B,SAAS,CAAC,QAAQ,EAAE,GAAG,GAAG,YAAY;IAShC,kBAAkB,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,sBAAsB,EAAE,aAAa,GAAE,OAAc,GAAG,OAAO,CAAC,8BAA8B,CAAC;IAkIhK;;;;;;;;OAQG;IACU,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAgCpE;;;;;;;;OAQG;IACU,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IA8B3D;;;;;;;;OAQG;IACU,uBAAuB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IA8B3E;;;;;;;;;;;;;;;OAeG;IACU,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,GAAE,MAAW,EAAE,SAAS,GAAE,MAAW,EAAE,UAAU,GAAE,OAAc,EAAE,UAAU,GAAE,OAAc,EAAE,gBAAgB,GAAE,MAAa,EAAE,aAAa,GAAE,OAAc,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAqDtO;;;;;;;;;;;;;;;OAeG;IACU,kCAAkC,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,GAAE,OAAc,GAAG,OAAO,CAAC,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC;IA6C9H;;OAEG;IACH,OAAO,CAAC,4BAA4B;IAoEpC,OAAO,CAAC,oBAAoB;YA4Bd,wBAAwB;YAYxB,yBAAyB;CAW1C"}

package/lib/services/directory/index.d.ts

@@ -0,0 +1,3 @@
+export type { DirectorySearchService, DirectorySearchOptions, CompanyOptions, DirectorySearchResults } from "../core/directorySearch.service";
+export { DIRECTORY_SEARCH_SVC, DirectoryType, CompanyScopeType } from "../core/directorySearch.service";
+//# sourceMappingURL=index.d.ts.map

package/lib/services/directory/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/services/directory/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAC9I,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC"}

package/lib/services/directory/office365ad.service.d.ts

@@ -0,0 +1,74 @@
+import type { Contact } from "../../models/contact.model";
+import { Service } from "../../services/service";
+import type { DirectoryInternalSearchResults, DirectorySearchOptions } from "../core/directorySearch.service";
+export declare const OFFICE365_AD_SVC = "Office365AdService";
+export declare class Office365AdService extends Service {
+    private logger;
+    private authService;
+    private errorHelperService;
+    private profileService;
+    private contactService;
+    static getInstance(): Office365AdService;
+    static build(): Office365AdService;
+    private constructor();
+    /**
+     * Search contacts in the Microsoft O365/Azure AD directories configured for the user's company by using a specified pattern to filter items.
+     * This search is only available if the user has the feature MSO365_DIRECTORY_SEARCH in its profile.
+     * Concerning 'extendedMode' in 'options' parameter:
+     * If requested and the user has the feature SEARCH_BY_TAGS in its profile, a multi-criteria search will then be performed.
+     * The multi-criteria search applies on fields firstName, lastName, jobTitle, companyName, department and tags.
+     * If this option is not specified or the user does not have the feature SEARCH_BY_TAGS in his profile,
+     * the search is based on names only (first name, last name and company name).
+     * Returns the results and the total number of directory items matching the criteria.
+     * @param searchPattern - Pattern to search
+     * @param DirectorySearchOptions - Search options
+     */
+    searchO365usersADcontacts(searchPattern: string, options?: DirectorySearchOptions): Promise<DirectoryInternalSearchResults>;
+    getUserDetails(contact: any): Promise<void>;
+    /**
+     * This API allows users to retrieve from server one Microsoft Office 365 Azure contact card from its identifier
+     * (API request to {@link https://api.openrainbow.org/office365/#api-users-getOffice365UserDetailsByOid Office365 portal - users - Get user details.
+     * A new contact based on Contact model is created for the found contact.
+     * @param oid - Office 365 Azure directory object identifier of the contact to retrieve
+     */
+    getO365ContactFromServer(oid: any): Promise<Contact | null>;
+    getO365DirectoryContactById(oid: string): Promise<Contact>;
+    private updateContactWithData;
+    private updateContactWithOffice365Data;
+    /**
+     * Method updateContactWithOffice365Details
+     * @description Update an existing o365 contact with o365 complete data retrieved from the server
+     * @memberof Office365AdService
+     * @public
+     * @param {Contact} contact The contact The o365 contact to update
+     * @param {any} data  The o365 complete data retrieved from the server
+     */
+    private updateContactWithOffice365Details;
+    /**
+     * Update the specified exisitng RB contact instance with some provided Microsoft Outlook contact data.
+     */
+    private updateContactWithOutlookSearchData;
+    /**
+     * This API allows users to retrieve from server one Microsoft Outlook contact card from its identifier
+     * and update the given contact. No new contact instance is created.
+     * Retrieving an Outloo personal contact is available only if the user has the feature MSO365_DIRECTORY_SEARCH in its profile.
+     * @param contact - The internal contact to update with additional or last Outlook contact data.
+     */
+    getOutlookContactDetails(contact: Contact): Promise<Contact | null>;
+    /**
+     * This API allows users to retrieve from server one Microsoft Outlook contact card from its identifier.
+     * Retrieving an Outloo personal contact is available only if the user has the feature MSO365_DIRECTORY_SEARCH in its profile.
+     * A new contact based on Contact model is created for the found contact.
+     * @param oid - Identifier of the Outlook contact to retrieve
+     */
+    getOutlookContactById(oid: string): Promise<Contact>;
+    /**
+     * Search personal contacts in the Microsoft Outlook directory by specifying a string pattern to filter items.
+     * The pattern is the beginning of a name or a phone number.
+     * This search is only available if the user has the feature MSO365_DIRECTORY_SEARCH in its profile.
+     * Returns the results items matching the criteria.
+     * @param searchPattern - Pattern to search
+     */
+    searchOutlookPersonalcontacts(searchPattern: string): Promise<DirectoryInternalSearchResults>;
+}
+//# sourceMappingURL=office365ad.service.d.ts.map

package/lib/services/directory/office365ad.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"office365ad.service.d.ts","sourceRoot":"","sources":["../../../src/services/directory/office365ad.service.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,2CAA2C,CAAC;AACzE,OAAO,EAAE,OAAO,EAAE,MAAM,uCAAuC,CAAC;AAChE,OAAO,KAAK,EAAE,8BAA8B,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAE9G,eAAO,MAAM,gBAAgB,uBAAuB,CAAC;AAErD,qBAAa,kBAAmB,SAAQ,OAAO;IAC3C,OAAO,CAAC,MAAM,CAA8C;IAC5D,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,kBAAkB,CAAwD;IAClF,OAAO,CAAC,cAAc,CAAgD;IACtE,OAAO,CAAC,cAAc,CAAgD;WAExD,WAAW;WAIX,KAAK;IAInB,OAAO;IAEP;;;;;;;;;;;OAWG;IACU,yBAAyB,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,8BAA8B,CAAC;IA2E3H,cAAc,CAAC,OAAO,EAAE,GAAG;IA4BxC;;;;;OAKG;IACU,wBAAwB,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IAyC3D,2BAA2B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAavE,OAAO,CAAC,qBAAqB;IAa7B,OAAO,CAAC,8BAA8B;IAgEtC;;;;;;;OAOG;IACH,OAAO,CAAC,iCAAiC;IAoEzC;;OAEG;IACH,OAAO,CAAC,kCAAkC;IAyE1C;;;;;OAKG;IACU,wBAAwB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IAwChF;;;;;OAKG;IACU,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAyCjE;;;;;;OAMG;IACU,6BAA6B,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,8BAA8B,CAAC;CA+C7G"}

package/lib/services/directory/personal-directory.service.d.ts

@@ -0,0 +1,425 @@
+import type { Subscription } from "rxjs";
+import { BehaviorSubject } from "rxjs";
+import { DirectoryContact } from "../../models/directoryContact.model";
+import type { Contact } from "../../models/contact.model";
+import type { DirectoryInternalSearchResults, DirectorySearchOptions } from "../core/directorySearch.service";
+import { Service } from "../../services/service";
+export declare const PERSONAL_DIRECTORY_SVC = "PersonalDirectoryService";
+/**
+ * @enum {string}
+ * @public
+ * @readonly
+ * @description
+ *      Collection of events fired by {@link PersonalDirectoryService} regarding the Personal Directory
+ */
+export declare enum PersonalDirectoryEvent {
+    /**
+     * @public
+     * @event PersonalDirectoryEvent#PERSONAL_DIRECTORY_ADD
+     * @description
+     *      This event is fired when a new contact is added in the personal directory
+     *      The event contains a Contact object
+     * @param {Contact} data containing the information of the personal contact
+     */
+    PERSONAL_DIRECTORY_ADD = "PERSONAL_DIRECTORY_ADD",
+    /**
+     * @public
+     * @event PersonalDirectoryEvent#PERSONAL_DIRECTORY_DELETE
+     * @description
+     *      This event is fired when a contact is deleted from the personal directory
+     *      The event contains the id of the deleted contact
+     * @param {string} id containing the id of the deleted contact
+     */
+    PERSONAL_DIRECTORY_DELETE = "PERSONAL_DIRECTORY_DELETE",
+    /**
+     * @public
+     * @event PersonalDirectoryEvent#PERSONAL_DIRECTORY_UPDATE
+     * @description
+     *      This event is fired when a contact is updated in the personal directory
+     *      The event contains a Contact object
+     * @param {Contact} data containing the information of the personal contact
+     */
+    PERSONAL_DIRECTORY_UPDATE = "PERSONAL_DIRECTORY_UPDATE",
+    /**
+     * @public
+     * @event PersonalDirectoryEvent#PERSONAL_DIRECTORY_IMPORT_PROGRESS
+     * @description
+     *      This event is fired when import of personal directory is progressing
+     *      The event contains a number
+     * @param {number} percent containing the percent of the import
+     */
+    PERSONAL_DIRECTORY_IMPORT_PROGRESS = "PERSONAL_DIRECTORY_IMPORT_PROGRESS",
+    /**
+     * @public
+     * @event PersonalDirectoryEvent#PERSONAL_DIRECTORY_IMPORT_COMPLETION
+     * @description
+     *      This event is fired when import of personal directory is completed
+     */
+    PERSONAL_DIRECTORY_IMPORT_COMPLETION = "PERSONAL_DIRECTORY_IMPORT_COMPLETION",
+    /**
+     * @public
+     * @event PersonalDirectoryEvent#PERSONAL_DIRECTORY_DELETE_ALL
+     * @description
+     *      This event is fired when all contacts are removed from the personal directory of the user
+     */
+    PERSONAL_DIRECTORY_DELETE_ALL = "PERSONAL_DIRECTORY_DELETE_ALL",
+    /**
+     * @public
+     * @event PersonalDirectoryEvent#PERSONAL_DIRECTORY_TAG_DELETE
+     * @description
+     *      This event is fired when a tag is removed from all the personal directory entries
+     *      The event contains the name of the removed tag
+     * @param {string} name of the removed tag
+     */
+    PERSONAL_DIRECTORY_TAG_DELETE = "PERSONAL_DIRECTORY_TAG_DELETE",
+    /**
+     * @public
+     * @event PersonalDirectoryEvent#PERSONAL_DIRECTORY_TAG_RENAME
+     * @description
+     *      This event is fired when a tag is renamed inside all personal directory entries
+     *      The event contains the old anf the new name of the tag
+     * @param {string} Old name of the removed tag
+     * @param {string} New name of the removed tag
+     */
+    PERSONAL_DIRECTORY_TAG_RENAME = "PERSONAL_DIRECTORY_TAG_RENAME",
+    /**
+     * @public
+     * @event PersonalDirectoryEvent#PERSONAL_DIRECTORY_UPDATE_ALL
+     * @description
+     *      This event is fired when all personal directory contacts stored in internal cache have been updated.
+     *      This happens for example after a XMPP reconnection, these contacts must be updated again
+     *      (thanks to a new 'getPersonalContacts') as during the time of disconnection such contacts may have been
+     *      added, updated or deleted by the end-user through another Rainbow client.
+     */
+    PERSONAL_DIRECTORY_UPDATE_ALL = "PERSONAL_DIRECTORY_UPDATE_ALL"
+}
+export declare class PersonalDirectoryService extends Service {
+    private logger;
+    private authService;
+    private eventService;
+    private xmppService;
+    private profileService;
+    private contactService;
+    private countryService;
+    private userInfoService;
+    private errorHelperService;
+    private favoritesService;
+    private rxSubject;
+    xmppManagementHandler: any;
+    serviceReady: BehaviorSubject<boolean>;
+    startupFailed: BehaviorSubject<boolean>;
+    private directoryPortalURL;
+    private massProPortalURL;
+    private personalDirectoryEnabled;
+    private deleteAllInProgress;
+    private DEFAULT_CSV_BOM;
+    private DEFAULT_CSV_TYPE;
+    static getInstance(): PersonalDirectoryService;
+    static build(): PersonalDirectoryService;
+    private constructor();
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    reconnect(): Promise<void>;
+    init(): void;
+    private attachXMPPListeners;
+    private removeXMPPListeners;
+    subscribe(handler: any): Subscription;
+    private onDirectoryManagementReceived;
+    private onPersonalDirectoryImportInitializing;
+    private onPersonalDirectoryImportDeletion;
+    private onPersonalDirectoryImportCreation;
+    private onPersonalDirectoryImportSuccess;
+    private onPersonalDirectyDeletion;
+    private buildContactCardFromXmpp;
+    private onPersonalDirectoryCreation;
+    private onPersonalDirectoryUpdate;
+    /**
+     * Method createPersonalContact
+     * @description This API allows users to create a contact in its personal directory
+     * (API request to {@link https://api.openrainbow.org/directory/#api-directory-PostDirectory Rainbow Company Directory portal - directory - Create a directory entry})
+     * @memberof PersonalDirectoryService
+     * @public
+     * @param {DirectoryContact} persDirContact a {@link DirectoryContact} The personal contact to create on server
+     * @returns {Promise<Contact>} The created personal directory contact as a Contact model
+     * @memberof PersonalDirectoryService
+     * @fires PersonalDirectoryEvent#PERSONAL_DIRECTORY_ADD
+     */
+    createPersonalContact(persDirContact: DirectoryContact): Promise<Contact | null>;
+    /**
+     * Method deletePersonalContact
+     * @description This API allows users to delete a personal directory contact
+     * (API request to {@link https://api.openrainbow.org/directory/#api-directory-DeleteDirectory Rainbow Company Directory portal - directory - Delete a directory entry})
+     * @memberof PersonalDirectoryService
+     * @public
+     * @param {Contact} contact Contact instance associated to the personal directory contact to delete
+     * @returns {Promise<void>} resolves when deletion is done
+     * @fires PersonalDirectoryEvent#PERSONAL_DIRECTORY_DELETE
+     */
+    deletePersonalContact(contact: Contact): Promise<void>;
+    /**
+     * Method deletePersonalContactById
+     * @description This API allows users to delete a personal directory contact
+     * (API request to {@link https://api.openrainbow.org/directory/#api-directory-DeleteDirectory Rainbow Company Directory portal - directory - Delete a directory entry})
+     * @memberof PersonalDirectoryService
+     * @public
+     * @param {string} id Identifier of the personal directory contact to delete
+     * @returns {Promise<void>} resolves when deletion is done
+     * @fires PersonalDirectoryEvent#PERSONAL_DIRECTORY_DELETE
+     */
+    deletePersonalContactById(id: string): Promise<void>;
+    /**
+     * Method deleteAllContacts
+     * @description This API allows users to delete all the contacts present in its personal directory
+     * @memberof PersonalDirectoryService
+     * @public
+     * @returns {Promise<void>} resolves when deletion is done
+     * @fires PersonalDirectoryEvent#PERSONAL_DIRECTORY_DELETE_ALL
+     */
+    deleteAllPersonalContacts(): Promise<void>;
+    /**
+     * Method updatePersonalContactFromUserData
+     * @description This API allows users to update a personal contact present in its personal directory
+     * (API request to {@link https://api.openrainbow.org/directory/#api-directory-PutDirectory Rainbow Company Directory portal - directory - Update a directory entry})
+     * @memberof PersonalDirectoryService
+     * @public
+     * @param {Contact} contact Contact instance associated to the personal directory contact to update
+     * @returns {Promise<Contact>} The created personal directory contact as a Contact model
+     * @fires PersonalDirectoryEvent#PERSONAL_DIRECTORY_UPDATE
+     */
+    updatePersonalContactFromUserData(contact: Contact): Promise<Contact | null>;
+    /**
+     * Method updatePersonalContact
+     * @description This API allows users to update an contact present in its personal directory.
+     * (API request to {@link https://api.openrainbow.org/directory/#api-directory-PutDirectory Rainbow Company Directory portal - directory - Update a directory entry})
+     * @memberof PersonalDirectoryService
+     * @public
+     * @param {Contact} persDirContact Contact instance associated to the personal directory contact to update
+     * @returns {Promise<Contact>} The created personal directory contact as a Contact model
+     * @fires PersonalDirectoryEvent#PERSONAL_DIRECTORY_UPDATE
+     */
+    updatePersonalContact(persDirContact: DirectoryContact): Promise<Contact | null>;
+    /**
+     * Method getPersonalContacts
+     * @description This API allows users to retrieve the list of the personal directory contacts of the user with full information pour each of them
+     * (API request to {@link https://api.openrainbow.org/directory/#api-directory-GetDirectoryList Rainbow Company Directory portal - directory - Get a list of directory entries data})
+     * @memberof PersonalDirectoryService
+     * @public
+     * @param {string} [format] Allows to retrieve more or less contact details in response.
+     *      - small: id, directoryType, firstName, lastName
+     *      - medium: id, directoryType, firstName, lastName, workPhoneNumbers
+     *      - full: all fields.
+     * @returns {Promise<{ contacts: DirectoryContact[]; limit: number; offset: number; total: number }>} object contaning result of search with
+     * {
+     *   contacts :  {array}     // Found personal directory contacts
+     *   limit :     {number}    // Limit specified at the search request, fix in our case by default to max possible.
+     *   offset :    {number}    // The position of first retrieved contact entry
+     *   total :     {number}    // Total number of available personal directory contacts (May be different from the number of returned contacts)
+     * }
+     */
+    getPersonalContacts(format?: string): Promise<{
+        contacts: DirectoryContact[];
+        limit: number;
+        offset: number;
+        total: number;
+    }>;
+    /**
+     * Method getPersonalContactsByCriteria
+     * @description This API allows users to get a list of personal directory contacts data by optionally specifying
+     * - Data format
+     * - Pagination criteria (offset, limit)
+     * - Search criteria (mode, pattern)
+     * (API request to {@link https://api.openrainbow.org/directory/#api-directory-GetDirectoryList Rainbow Company Directory portal - directory - Get a list of directory entries data})
+     * @memberof PersonalDirectoryService
+     * @public
+     * @param {object} [options] Search filter and criteria specified via the Option object
+     * @property {string} options Option object that may contain the following properties:
+     * @property {string} [options.format='full'] Allows to retrieve more or less contact details in response.
+     *      - small: id, directoryType, firstName, lastName
+     *      - medium: id, directoryType, firstName, lastName, workPhoneNumbers
+     *      - full: all fields.
+     * @property {number} [options.limit] Allows to specify the number personal directory contacts to retrieve.
+     * Default value: 100
+     * @property {number} [options.offset] Allows to specify the position of first personal directory contact to retrieve
+     * If not specified, the search begins at the beginning, from the the first personal directory contact.
+     * Warning: if offset > total, no results are returned.
+     * @property {string} [options.searchBy] Allows to filter the list of directory entries on phone number or on the name provided in this option.
+     * @property {string} [options.searchPattern] Allows to filter the list of directory entries by the words provided in this option
+     * @returns {Promise<{ contacts: DirectoryContact[]; limit: number; offset: number; total: number }>} object contaning result of search with
+     * {
+     *   contacts :  {array}     // Found personal directory contacts
+     *   limit :     {number}    // Limit specified at the search request
+     *   offset :    {number}    // The position of first retrieved contact entry
+     *   total :     {number}    // Total number of available personal directory contacts (May be different from the number of returned contacts)
+     * }
+     */
+    getPersonalContactsByCriteria(options?: any): Promise<{
+        contacts: DirectoryContact[];
+        limit: number;
+        offset: number;
+        total: number;
+    }>;
+    /**
+     * Method getPersonalContactCardById
+     * @description This API allows users to retrieve from server one contact card in the users's personal directory from its identifier
+     * API request to {@link https://api.openrainbow.org/directory/#api-directory-GetDirectory Rainbow Company Directory portal - directory - Get a directory entry data})
+     * @memberof PersonalDirectoryService
+     * @public
+     * @param {string} id Identifier of contact to retrieve
+     * @param {string} [format] Allows to retrieve more or less contact details in response.
+     *      - small: id, directoryType, firstName, lastName
+     *      - medium: id, directoryType, firstName, lastName, workPhoneNumbers
+     *      - full: all fields.
+     * @returns {Promise<DirectoryContact>} the {@link DirectoryContact} retrieved
+     */
+    getPersonalContactCardById(id: string, format?: string): Promise<DirectoryContact | null>;
+    /**
+     * Method getPersonalContactById
+     * @description This API allows users to retrieve from server a contact in the users's personal directory from its identifier
+     * API request to {@link https://api.openrainbow.org/directory/#api-directory-GetDirectory Rainbow Company Directory portal - directory - Get a directory entry data})
+     * @memberof PersonalDirectoryService
+     * @public
+     * @param {string} id Identifier of contact to retrieve
+     * @param {string} [format] Allows to retrieve more or less contact details in response.
+     *      - small: id, directoryType, firstName, lastName
+     *      - medium: id, directoryType, firstName, lastName, workPhoneNumbers
+     *      - full: all fields.
+     * @returns {Promise<Contact>} the retrieved contact
+     */
+    getPersonalContactById(id: string, format?: string): Promise<Contact | null>;
+    /**
+     * Method getNumberPersonalContact
+     * @description This API allows users to retrieve from Contact internal database the personal contacts created by the user
+     * @memberof PersonalDirectoryService
+     * @public
+     * @returns {Contact[]} the retrieved personal contacts
+     */
+    getMyContacts(): Contact[];
+    /**
+     * This API allows users to search personal directory contacts by specifying a pattern
+     * (API request to {@link https://api.openrainbow.org/directory/#api-directory-GetDirectoryList Rainbow Company Directory portal - directory - Get a list of directory entries data})
+     * @public
+     * @description
+     * Search contacts in the personal directory of the user by using a specified pattern to filter items.
+     * This search is only available if the user has the feature PERSONAL_DIRECTORY in its profile.
+     * Concerning 'extendedMode' in 'options' parameter:
+     * If requested and the user has the feature SEARCH_BY_TAGS in its profile, a multi-criteria search will then be performed.
+     * The multi-criteria search applies on fields firstName, lastName, jobTitle, companyName, department and tags.
+     * If this option is not specified or the user does not have the feature SEARCH_BY_TAGS in his profile,
+     * the search is based on names only (first name, last name and company name).
+     * @param {string} searchPattern Pattern to search
+     * @param {DirectorySearchOptions} [options] Search options {@link DirectorySearchOptions}
+     * @returns {Promise<DirectoryInternalSearchResults[]>} Resolves with an array of {@link DirectoryInternalSearchResults} results and
+     * the total number of directory items matching the criteria.
+     * @memberof PersonalDirectoryService
+     */
+    searchPersonalContacts(searchPattern: string, options?: DirectorySearchOptions): Promise<DirectoryInternalSearchResults>;
+    /**
+     * Method getPersonalDirectoryContactFromNumber
+     * @memberof PersonalDirectoryService
+     * @public
+     * @param {string} phoneNumber The number
+     * @returns {Contact} Found contact or null otherwise
+     */
+    getPersonalDirectoryContactFromNumber(phoneNumber: string): Contact | null;
+    /**
+     * Method getPersonalDirectoryTags
+     * @description This API allows users to retrieve from server all the tags assigned to the personal directory entries
+     * (API request to {@link https://api.openrainbow.org/directory/#api-personal_directory_tags-GetPersonalDirectoryTags Rainbow Company Directory portal - personal directory tags - List all tags assigned to personal directory entries
+     * @memberof PersonalDirectoryService
+     * @public
+     * @returns {Promise<string[]>} tags Array of tags
+     */
+    getPersonalDirectoryTags(): Promise<string[]>;
+    /**
+     * Method deletePersonalDirectoryTag
+     * @description This API allows users to delete from server the specified tag assigned to the personal directory entries
+     * (API request to {@link https://api.openrainbow.org/directory/#api-personal_directory_tags-DelPersonalDirectoryTags Rainbow Company Directory portal - personal directory tags - Remove a given tag from all the personal directory entries
+     * @memberof PersonalDirectoryService
+     * @public
+     * @param {string} tag Name of tag to remove
+     * @returns {Promise<void>} Resolves when deletion operation is done
+     */
+    deletePersonalDirectoryTag(tag: string): Promise<void>;
+    /**
+     * Method renamePersonalDirectoryTag
+     * @description This API allows users to rename a tag for all assigned personal directory entries
+     * (API request to {@link https://api.openrainbow.org/directory/#api-personal_directory_tags-PutPersonalDirectoryTags personal directory tags - Rename a tag for all assigned directory entries
+     * @memberof PersonalDirectoryService
+     * @public
+     * @param {string} tag Name of the tag to be renamed
+     * @param {string} newTagName New name of the tag
+     * @returns {Promise<void>} Resolves when rename operation is done
+     */
+    renamePersonalDirectoryTag(tag: string, newTagName: string): Promise<void>;
+    /**
+     * Method getPersonalDirectoryTagsStats
+     * @description This API can be used to list all the tags being assigned to the personal directory entries of the logged in user, with the number of directory entries for each tags.
+     * (API request to {@linkhttps://api.openrainbow.org/directory/#api-personal_directory_tags-GetPersonalDirectoryTagsStats personal directory tags - Return stats regarding tags of personal directory entries
+     * @memberof PersonalDirectoryService
+     * @public
+     * @returns {Promise<{ count: number; tag: string }[]>} Array of stats with the number of use (count) and the tag name
+     */
+    getPersonalDirectoryTagsStats(): Promise<{
+        count: number;
+        tag: string;
+    }[]>;
+    /**
+     * Method createContactFromPersonalDirectoryData
+     * @description Create a new contact based on Contact model from a personal directory object (DirectoryContact)
+     * @memberof PersonalDirectoryService
+     * @private
+     * @param {DirectoryContact} persDirContact The created personal directory contact
+     * @returns {Contact} Created contact or null if creation failed
+     */
+    private createContactFromPersonalDirectoryData;
+    /**
+     * Method updateContactFromPersonalDirectoryData
+     * @description Update an existing contact with a personal directory object (DirectoryContact)
+     * @memberof PersonalDirectoryService
+     * @private
+     * @param {DirectoryContact} persDirContact The updated personal directory object
+     * @returns {Contact} Updated contact or null if update failed
+     */
+    private updateContactFromPersonalDirectoryData;
+    /**
+     * Method createOrUpdateContact
+     * @description Create or update an existing contact with a personal directory object (DirectoryContact)
+     * @memberof PersonalDirectoryService
+     * @private
+     * @param {DirectoryContact} persDirContact A personal directory object just retrieved from server
+     * @returns {Contact} Created or Updated contact
+     */
+    private createOrUpdateContact;
+    /**
+     * Method createPersonalDirectoryDataFromContact
+     *
+     * Create a personal directory object (DirectoryContact) from a contact based on Contact model
+     * Useful to update on server side a personal directory contact from data stored in a contact
+     * @memberof PersonalDirectoryService
+     * @private
+     * @param {Contact} contactData The contact associated to the given personal directory
+     * @returns {DirectoryContact} Personal directory contact object used for update on server side
+     */
+    private createPersonalDirectoryDataFromContact;
+    /** ******************************************************/
+    /** DOWNLOAD CSV TEMPLATE                              **/
+    /** ******************************************************/
+    downloadCsvTemplateFile(): Promise<any>;
+    /** ******************************************************/
+    /** CHECK CSV FILE CONTENT                             **/
+    /** ******************************************************/
+    checkDirectoryImportCsvContent(csvContent: any): Promise<any>;
+    /** ******************************************************/
+    /** GET CSV FILE IMPORTS HISTORY                       **/
+    /** ******************************************************/
+    getDirectoryImportReport(): Promise<any>;
+    /** ******************************************************/
+    /** IMPORT CSV FILE PERSONAL DIRECTORY                 **/
+    /** ******************************************************/
+    importPersonalDirectory(csvContent: any): Promise<any>;
+    /** ******************************************************/
+    /** EXPORT CSV FILE PERSONAL DIRECTORY                 **/
+    /** ******************************************************/
+    exportPersonalDirectory(): Promise<any>;
+}
+//# sourceMappingURL=personal-directory.service.d.ts.map

package/lib/services/directory/personal-directory.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"personal-directory.service.d.ts","sourceRoot":"","sources":["../../../src/services/directory/personal-directory.service.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AACzC,OAAO,EAAE,eAAe,EAAW,MAAM,MAAM,CAAC;AAEhD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oDAAoD,CAAC;AACtF,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,2CAA2C,CAAC;AACzE,OAAO,KAAK,EAAE,8BAA8B,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAY9G,OAAO,EAAE,OAAO,EAAE,MAAM,uCAAuC,CAAC;AAIhE,eAAO,MAAM,sBAAsB,6BAA6B,CAAC;AAEjE;;;;;;GAMG;AACH,oBAAY,sBAAsB;IAE9B;;;;;;;OAOG;IACH,sBAAsB,2BAA2B;IAEjD;;;;;;;OAOG;IACH,yBAAyB,8BAA8B;IAEvD;;;;;;;OAOG;IACH,yBAAyB,8BAA8B;IAEvD;;;;;;;OAOG;IACH,kCAAkC,uCAAuC;IAEzE;;;;;OAKG;IACH,oCAAoC,yCAAyC;IAE7E;;;;;OAKG;IACH,6BAA6B,kCAAkC;IAE/D;;;;;;;OAOG;IACH,6BAA6B,kCAAkC;IAE/D;;;;;;;;OAQG;IACH,6BAA6B,kCAAkC;IAE/D;;;;;;;;OAQG;IACH,6BAA6B,kCAAkC;CAElE;AAED,qBAAa,wBAAyB,SAAQ,OAAO;IAIjD,OAAO,CAAC,MAAM,CAA8C;IAC5D,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,YAAY,CAA4C;IAChE,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,cAAc,CAAgD;IACtE,OAAO,CAAC,cAAc,CAAgD;IACtE,OAAO,CAAC,cAAc,CAAgD;IACtE,OAAO,CAAC,eAAe,CAAkD;IACzE,OAAO,CAAC,kBAAkB,CAAwD;IAClF,OAAO,CAAC,gBAAgB,CAAwD;IAEhF,OAAO,CAAC,SAAS,CAAoC;IAC9C,qBAAqB,EAAE,GAAG,CAAQ;IAIlC,YAAY,2BAAuC;IAKnD,aAAa,2BAAuC;IAE3D,OAAO,CAAC,kBAAkB,CAAS;IACnC,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,wBAAwB,CAAkB;IAClD,OAAO,CAAC,mBAAmB,CAAkB;IAE7C,OAAO,CAAC,eAAe,CAAY;IACnC,OAAO,CAAC,gBAAgB,CAAiC;WAE3C,WAAW;WAIX,KAAK;IAInB,OAAO;IAEM,KAAK;IA4BL,IAAI;IAMJ,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAShC,IAAI,IAAI,IAAI;IAgBnB,OAAO,CAAC,mBAAmB;IAM3B,OAAO,CAAC,mBAAmB;IAIpB,SAAS,CAAC,OAAO,EAAE,GAAG,GAAG,YAAY;IAS5C,OAAO,CAAC,6BAA6B;IA2DrC,OAAO,CAAC,qCAAqC;IAO7C,OAAO,CAAC,iCAAiC;IAiBzC,OAAO,CAAC,iCAAiC;YAkB3B,gCAAgC;IAU9C,OAAO,CAAC,yBAAyB;IAgBjC,OAAO,CAAC,wBAAwB;IAkDhC,OAAO,CAAC,2BAA2B;IA4BnC,OAAO,CAAC,yBAAyB;IAiCjC;;;;;;;;;;OAUG;IACU,qBAAqB,CAAC,cAAc,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IAiD7F;;;;;;;;;OASG;IACU,qBAAqB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBnE;;;;;;;;;OASG;IACU,yBAAyB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAoCjE;;;;;;;OAOG;IACU,yBAAyB,IAAI,OAAO,CAAC,IAAI,CAAC;IA2BvD;;;;;;;;;OASG;IACU,iCAAiC,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IAyCzF;;;;;;;;;OASG;IACU,qBAAqB,CAAC,cAAc,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IA2C7F;;;;;;;;;;;;;;;;;OAiBG;IACU,mBAAmB,CAAC,MAAM,GAAE,MAAe,GAAG,OAAO,CAAC;QAAE,QAAQ,EAAE,gBAAgB,EAAE,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;KAAE,CAAC;IAsCnJ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACU,6BAA6B,CAAC,OAAO,GAAE,GAAU,GAAG,OAAO,CAAC;QAAE,QAAQ,EAAE,gBAAgB,EAAE,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;KAAE,CAAC;IAuEzJ;;;;;;;;;;;;OAYG;IACU,0BAA0B,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,GAAE,MAAe,GAAG,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC;IA4B9G;;;;;;;;;;;;OAYG;IACU,sBAAsB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,GAAE,MAAe,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IA4BjG;;;;;;OAMG;IACI,aAAa,IAAI,OAAO,EAAE;IAUjC;;;;;;;;;;;;;;;;;OAiBG;IACU,sBAAsB,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,8BAA8B,CAAC;IA6ErI;;;;;;OAMG;IACI,qCAAqC,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,GAAG,IAAI;IAuBjF;;;;;;;OAOG;IACU,wBAAwB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAqB1D;;;;;;;;OAQG;IACU,0BAA0B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBnE;;;;;;;;;OASG;IACU,0BAA0B,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBvF;;;;;;;OAOG;IACU,6BAA6B,IAAI,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;KAAE,EAAE,CAAC;IA0BxF;;;;;;;OAOG;IACH,OAAO,CAAC,sCAAsC;IA8C9C;;;;;;;OAOG;IACH,OAAO,CAAC,sCAAsC;IA2C9C;;;;;;;OAOG;IACH,OAAO,CAAC,qBAAqB;IAa7B;;;;;;;;;OASG;IACH,OAAO,CAAC,sCAAsC;IAgC9C,2DAA2D;IAC3D,0DAA0D;IAC1D,2DAA2D;IAE9C,uBAAuB,IAAI,OAAO,CAAC,GAAG,CAAC;IA2BpD,2DAA2D;IAC3D,0DAA0D;IAC1D,2DAA2D;IAE9C,8BAA8B,CAAC,UAAU,KAAA,GAAG,OAAO,CAAC,GAAG,CAAC;IA0BrE,2DAA2D;IAC3D,0DAA0D;IAC1D,2DAA2D;IAE9C,wBAAwB,IAAI,OAAO,CAAC,GAAG,CAAC;IA0BrD,2DAA2D;IAC3D,0DAA0D;IAC1D,2DAA2D;IAE9C,uBAAuB,CAAC,UAAU,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IA0BnE,2DAA2D;IAC3D,0DAA0D;IAC1D,2DAA2D;IAE9C,uBAAuB,IAAI,OAAO,CAAC,GAAG,CAAC;CAqDvD"}