@ale-rainbow/web-sdk 5.1.0

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

@@ -0,0 +1 @@
+{"version":3,"file":"citrix.service.d.ts","sourceRoot":"","sources":["../../../src/services/citrix/citrix.service.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,uCAAuC,CAAC;AAUhE,eAAO,MAAM,UAAU,kBAAkB,CAAC;AAE1C,qBAAa,aAAc,SAAQ,OAAO;IACtC,OAAO,CAAC,MAAM,CAA8C;IAC5D,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,eAAe,CAAkD;IACzE,OAAO,CAAC,cAAc,CAAgD;IACtE,OAAO,CAAC,uBAAuB,CAA4B;IAC3D,OAAO,CAAC,oBAAoB,CAAuB;IACnD,OAAO,CAAC,kBAAkB,CAAC;IAEpB,OAAO,EAAE,OAAO,CAAS;IACzB,kBAAkB,EAAE,OAAO,CAAS;IACpC,SAAS,MAAC;IACjB,OAAO,CAAC,aAAa,CAAkB;IAEvC,OAAO,CAAC,UAAU,CAAM;IAExB,OAAO,CAAC,UAAU,CAAuB;WAE3B,WAAW;WAIX,KAAK;IAInB,SAAS;IAII,KAAK;IAKX,IAAI;IAUX,OAAO,CAAC,aAAa;IAmDrB,OAAO,CAAC,aAAa;IAOrB,OAAO,CAAC,mBAAmB;IAwI3B,OAAO,CAAC,eAAe;YA8BT,4BAA4B;IAiB1C,OAAO,CAAC,yBAAyB;CAWpC"}

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

@@ -0,0 +1,3 @@
+export type { CitrixService } from "./citrix.service";
+export { CITRIX_SVC } from "./citrix.service";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/services/citrix/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC"}

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

@@ -0,0 +1,222 @@
+import { DirectoryContact } from "../../models/directoryContact.model";
+import type { DirectoryInternalSearchResults, DirectorySearchOptions } from "../core/directorySearch.service";
+import type { Contact } from "../../models/contact.model";
+import { Company } from "../../models/company.model";
+import { Service } from "../../services/service";
+export declare const COMPANY_DIRECTORY_SVC = "CompanyDirectoryService";
+/**
+ * @enum {string}
+ * @public
+ * @readonly
+ * @description
+ *      Collection of events fired by {@link CompanyDirectoryService}
+ */
+export declare enum CompanyDirectoryEvent {
+    /**
+     * @public
+     * @event CompanyDirectoryEvent#ADMIN_DIRECTORY_CHANGE
+     * @description
+     *      This event is fired when directory changes
+     *      The event contains a {@link DirectoryContact} object
+     * @param {DirectoryContact} data containeing id: ID of invitation, action: action of invitation, status: status of invitation
+     */
+    ADMIN_DIRECTORY_CHANGE = "ADMIN_DIRECTORY_CHANGE",
+    /**
+     * @public
+     * @event CompanyDirectoryEvent#ON_COMPANY_BANNER_UPDATED
+     * @description
+     *      This event is fired when the banner of a company changes
+     *      The event contains the identifier of the company
+     * @param {string} id Identifier of company updated
+     */
+    ON_COMPANY_BANNER_UPDATED = "ON_COMPANY_BANNER_UPDATED"
+}
+export declare class CompanyDirectoryService extends Service {
+    private logger;
+    private authService;
+    private eventService;
+    private profileService;
+    private contactService;
+    private countryService;
+    private userInfoService;
+    private errorHelperService;
+    private companies;
+    static getInstance(): CompanyDirectoryService;
+    static build(): CompanyDirectoryService;
+    protected constructor();
+    /**
+     *  Get a list of directory entries data (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
+     *      Get a list of contacts from company's directory
+     * @param string - companyId Allows to filter the list of directory entries on the companyIds provided in this option
+     * @param page - Allow to specify the page number to retrieve
+     * @param pageSize - Allow to specify the number of phone book entries to retrieve
+     * @param searchPattern - Allows to filter the list of directory entries by the words provided in this option
+     * @param searchBy - Allows to filter the list of directory entries on the number provided in this option.
+     * @param format - Allows to retrieve more or less entry details in response. Possible values are:
+     *      - small: id, firstName, lastName
+     *      - medium: id, companyId, firstName, lastName, workPhoneNumbers
+     *      - full: all fields.
+     * @returns {Promise<{ contacts: DirectoryContact[]; limit: number; offset: number; total: number }>} object contaning result of search
+     * @memberof CompanyDirectoryService
+     */
+    getDirectoryContacts(companyId: string, page?: number, pageSize?: number, searchPattern?: string, searchBy?: "phoneNumbers" | "tags" | "name", format?: string): Promise<{
+        contacts: DirectoryContact[];
+        limit: number;
+        offset: number;
+        total: number;
+    }>;
+    /**
+     * This API allows administrators to create an entry in the directory of a company they administrate. (API request to {@link https://api.openrainbow.org/directory/#api-directory-PostDirectory Rainbow Company Directory portal - directory - Create a directory entry})
+     * @public
+     * @description
+     *      Creates a company directory contact
+     * @param {DirectoryContact} entry a {@link DirectoryContact} object to create on server
+     * @returns {Promise<DirectoryContact>} The created company directory contact
+     * @memberof CompanyDirectoryService
+     * @fires CompanyDirectoryEvent#ADMIN_DIRECTORY_CHANGE
+     */
+    createDirectoryContact(entry: DirectoryContact): Promise<DirectoryContact>;
+    /**
+     * This API allows users to get an entry of the directory of a company they administrate. (API request to {@link https://api.openrainbow.org/directory/#api-directory-GetDirectory Rainbow Company Directory portal - directory - Get a directory entry data})
+     * @public
+     * @description
+     *      Retrieve a company directory contact from its identifier
+     * @param {string} id Identifier of contact to retrieve
+     * @param {string} [format] Allows to retrieve more or less entry details in response. Possible values are:
+     *      - small: id, firstName, lastName
+     *      - medium: id, companyId, firstName, lastName, workPhoneNumbers
+     *      - full: all fields.
+     * @returns {Promise<DirectoryContact>} the {@link DirectoryContact} retrieved
+     * @memberof CompanyDirectoryService
+     */
+    getDirectoryContact(id: string, format?: string): Promise<DirectoryContact>;
+    /**
+     * This API allows administrators to update an entry in the directory of a company they administrate. (API request to {@link https://api.openrainbow.org/directory/#api-directory-PutDirectory Rainbow Company Directory portal - directory - Update a directory entry})
+     * @public
+     * @description
+     *  Updates a company directory contact
+     * @param {({ id: string; tags: string[] } | DirectoryContact)} entry of an existing company directory contact or a data object containing a company contact's ID and tags
+     * @returns {Promise<DirectoryContact>} the {@link DirectoryContact} updated
+     * @memberof CompanyDirectoryService
+     */
+    updateDirectoryContact(entry: {
+        id: string;
+        tags: string[];
+    } | DirectoryContact): Promise<DirectoryContact>;
+    /**
+     * This API allows administrators to delete an entry in the directory of a company they administrate. (API request to {@link https://api.openrainbow.org/directory/#api-directory-DeleteDirectory Rainbow Company Directory portal - directory - Delete a directory entry})
+     * @public
+     * @description
+     *  Deletes a company directory contact from comany's directory
+     * @param {string} id Identifier of contact to delete
+     * @returns {Promise<void>} resolves when delete is done
+     * @memberof CompanyDirectoryService
+     */
+    deleteDirectoryContact(id: string): Promise<void>;
+    /**
+     * This API allows users to search business 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 business directory of one or more companies by using a specified pattern to filter items.
+     * 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 CompanyDirectoryService
+     */
+    searchBusinessContacts(searchPattern: string, options?: DirectorySearchOptions): Promise<DirectoryInternalSearchResults>;
+    private createAndUpdateContact;
+    /**
+     *  Get a list of directory entries data (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 a company by name
+     * @param {string} searchPattern text to search
+     * @param {string} [companyId] If specified, search only in the given company
+     * @returns {Promise<Company[]>} Resolves with an array of {@link Company} results
+     * @memberof CompanyDirectoryService
+     */
+    searchCompanies(searchPattern: string, companyId?: string): Promise<Company[]>;
+    /**
+     *
+     * @public
+     * @description
+     *      Get the company's logo
+     * @param {Company} company for which we want the logo
+     * @returns {Promise<Company>} Resolves with the company with the logo
+     * @memberof CompanyDirectoryService
+     */
+    getCompanyLogo(company: Company): Promise<Company>;
+    /**
+     *
+     * @public
+     * @description
+     *      Get the company's banner
+     * @param {Company} company for which we want the banner
+     * @returns {Promise<Company>} Resolves with the company with the banner
+     * @memberof CompanyDirectoryService
+     */
+    getCompanyBanner(company: Company): Promise<Company>;
+    /**
+     *
+     * @public
+     * @description
+     *      Get a {@link Company} by its identifier
+     * @param {string} companyId ID of company to retrieve
+     * @returns {Company} Company found. undefined if none found
+     * @memberof CompanyDirectoryService
+     */
+    getCompanyById(companyId: string): Company;
+    /**
+     *
+     * @public
+     * @description
+     *      Method retrieve all  company's directory contact
+     * @param {string} companyId Identifier of company to retrieve
+     * @returns {Promise<{ contacts: DirectoryContact[]; limit: number }>} Resolves with object contaning result of search
+     * @memberof CompanyDirectoryService
+     */
+    getAllDirectoryContacts(companyId: string): Promise<{
+        contacts: DirectoryContact[];
+        limit: number;
+    }>;
+    buildDirectoryCsvBlob(companyId: string): Promise<Blob>;
+    /**
+     * @public
+     * @description
+     *      Methods exports a csv file from specified company directory
+     * @param {string} companyId identifier of company
+     * @returns {Promise<{fileBlob: Blob; fileName: string}>} Resolves with the file blob and name
+     * @memberof CompanyDirectoryService
+     */
+    exportDirectoryCsvFile(companyId: string): Promise<{
+        fileBlob: Blob;
+        fileName: string;
+    }>;
+    /**
+     * This API allows users to get an entry of the personal/business directory from its identifier
+     * @private
+     * @description
+     *      Retrieve a personal/business directory contact from its identifier AND store it in Contact database
+     * @memberof CompanyDirectoryService
+     * @param {string} id Identifier of contact to retrieve
+     * @param {boolean} forceServer Indicate if the contact must be retrieved from the server instead of the internal cache.
+     * Beware ! It may not be present in the latter and in this case, a request to server is still necessary.
+     * @returns {Promise<Contact>} Created contact or null if creation failed or Contact id not found
+     */
+    getDirectoryContactById(id: string, forceServer?: boolean): Promise<Contact | null>;
+    private createAndUpdateDirectoryContact;
+    getAvailableShortCodes(companyId: string, limit?: number, searchValue?: string): Promise<{
+        type: string;
+        code: string;
+    }[]>;
+}
+//# sourceMappingURL=company-directory.service.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"company-directory.service.d.ts","sourceRoot":"","sources":["../../../src/services/company/company-directory.service.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oDAAoD,CAAC;AACtF,OAAO,KAAK,EAAE,8BAA8B,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAK9G,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,2CAA2C,CAAC;AAEzE,OAAO,EAAE,OAAO,EAAE,MAAM,2CAA2C,CAAC;AAEpE,OAAO,EAAE,OAAO,EAAE,MAAM,uCAAuC,CAAC;AAIhE,eAAO,MAAM,qBAAqB,4BAA4B,CAAC;AAE/D;;;;;;GAMG;AACH,oBAAY,qBAAqB;IAE7B;;;;;;;OAOG;IACH,sBAAsB,2BAA2B;IAEjD;;;;;;;OAOG;IACH,yBAAyB,8BAA8B;CAC1D;AAED,qBAAa,uBAAwB,SAAQ,OAAO;IAIhD,OAAO,CAAC,MAAM,CAA8C;IAC5D,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,YAAY,CAA4C;IAChE,OAAO,CAAC,cAAc,CAAgD;IACtE,OAAO,CAAC,cAAc,CAAgD;IACtE,OAAO,CAAC,cAAc,CAAgD;IACtE,OAAO,CAAC,eAAe,CAAkD;IACzE,OAAO,CAAC,kBAAkB,CAAwD;IAElF,OAAO,CAAC,SAAS,CAAiB;WAEpB,WAAW;WAIX,KAAK;IAInB,SAAS;IAQT;;;;;;;;;;;;;;;;OAgBG;IACU,oBAAoB,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,GAAE,MAAa,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,MAAM,GAAG,MAAM,EAAE,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;IAyCpR;;;;;;;;;OASG;IACU,sBAAsB,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAyBvF;;;;;;;;;;;;OAYG;IACU,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,GAAE,MAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAkBhG;;;;;;;;OAQG;IACU,sBAAsB,CAAC,KAAK,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,EAAE,CAAC;KAAE,GAAG,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAqBzH;;;;;;;;OAQG;IACU,sBAAsB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB9D;;;;;;;;;;;;;;;;OAgBG;IACU,sBAAsB,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,8BAA8B,CAAC;IA0ErI,OAAO,CAAC,sBAAsB;IAwC9B;;;;;;;;;OASG;IACU,eAAe,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IA4B3F;;;;;;;;OAQG;IACU,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAc/D;;;;;;;;OAQG;IACU,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAgCjE;;;;;;;;OAQG;IACI,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAajD;;;;;;;;OAQG;IACU,uBAAuB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,QAAQ,EAAE,gBAAgB,EAAE,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;KAAE,CAAC;IAsCrG,qBAAqB,CAAC,SAAS,EAAE,MAAM;IAkIpD;;;;;;;OAOG;IACU,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,QAAQ,EAAE,IAAI,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;KAAE,CAAC;IAoBtG;;;;;;;;;;OAUG;IACU,uBAAuB,CAAC,EAAE,EAAE,MAAM,EAAE,WAAW,GAAE,OAAe,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IAsCvG,OAAO,CAAC,+BAA+B;IAmD1B,sBAAsB,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,GAAE,MAAY,EAAE,WAAW,GAAE,MAAkB,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;KAAE,EAAE,CAAC;CAoB3J"}