@webex/internal-plugin-dss 2.26.1 → 2.27.0

package/README.md

@@ -48,6 +48,12 @@ webex.internal.dss.lookupDetail({id: <entity-uuid>}).then((results) => {})
 // Get information on multiple identities
 webex.internal.dss.lookup({ids: [<entity-uuid-1>, <entity-uuid-2>]}).then((results) => {})
 
+// If you know the entity provider, you can speed up the query
+webex.internal.dss.lookup({
+  ids: [<entity-uuid-1>, <entity-uuid-2>],
+  entityProviderType: 'CI_USER'
+}).then((results) => {})
+
 // Get information on entities by querying their email addresses
 webex.internal.dss.lookupByEmail(
   {emails: ['email1@example.com', 'email2@example.com']}

package/dist/dss.js

@@ -231,13 +231,16 @@ var DSS = _webexCore.WebexPlugin.extend({
    * Retrieves basic information about a list entities within an organization
    * @param {Object} options
    * @param {UUID} options.ids the id of the entity to lookup
+   * @param {UUID} options.entityProviderType the provider to query (optional)
    * @returns {Promise} Resolves with an array of entities found
    */
   lookup: function lookup(options) {
-    var ids = options.ids;
+    var ids = options.ids,
+        entityProviderType = options.entityProviderType;
+    var resource = entityProviderType ? "/lookup/orgid/".concat(this.webex.internal.device.orgId, "/entityprovidertype/").concat(entityProviderType) : "/lookup/orgid/".concat(this.webex.internal.device.orgId, "/identities");
     return this._request({
       dataPath: 'lookupResult.entities',
-      resource: "/lookup/orgid/".concat(this.webex.internal.device.orgId, "/identities"),
+      resource: resource,
       params: {
         lookupValues: ids
       }
@@ -283,7 +286,7 @@ var DSS = _webexCore.WebexPlugin.extend({
       }
     });
   },
-  version: "2.26.1"
+  version: "2.27.0"
 });
 
 var _default = DSS;

package/dist/dss.js.map

@@ -1 +1 @@
-{"version":3,"names":["DSS","WebexPlugin","extend","namespace","registered","register","webex","canAuthorize","logger","error","reject","Error","info","resolve","internal","mercury","connect","then","listenForEvents","trigger","DSS_REGISTERED","catch","message","unregister","stopListeningForEvents","disconnect","DSS_UNREGISTERED","on","DSS_LOOKUP_MERCURY_EVENT","envelope","_handleEvent","data","DSS_SEARCH_MERCURY_EVENT","off","_getResultEventName","requestId","DSS_RESULT","DSS_LOOKUP_RESULT","_request","options","resource","params","dataPath","uuid","v4","eventName","result","expectedSeqNums","listenTo","resultData","sequence","finished","map","String","done","resultArray","forEach","index","seqResult","push","stopListening","request","service","DSS_SERVICE_NAME","method","contentType","body","lookupDetail","id","device","orgId","lookup","ids","lookupValues","lookupByEmail","emails","search","requestedTypes","resultSize","queryString"],"sources":["dss.ts"],"sourcesContent":["/* eslint-disable no-underscore-dangle */\n/*!\n * Copyright (c) 2015-2022 Cisco Systems, Inc. See LICENSE file.\n */\nimport uuid from 'uuid';\nimport {WebexPlugin} from '@webex/webex-core';\nimport '@webex/internal-plugin-mercury';\nimport {range, isEqual, get} from 'lodash';\nimport type {SearchOptions, LookupDetailOptions, LookupOptions, LookupByEmailOptions} from './types';\n\nimport {\n  DSS_REGISTERED,\n  DSS_UNREGISTERED,\n  DSS_LOOKUP_MERCURY_EVENT,\n  DSS_LOOKUP_RESULT,\n  DSS_SERVICE_NAME,\n  DSS_SEARCH_MERCURY_EVENT,\n  DSS_RESULT,\n} from './constants';\n\nconst DSS = WebexPlugin.extend({\n  namespace: 'DSS',\n\n  /**\n   * registered value indicating events registration is successful\n   * @instance\n   * @type {Boolean}\n   * @memberof DSS\n   */\n  registered: false,\n\n  /**\n   * Explicitly sets up the DSS plugin by connecting to mercury, and listening for DSS events.\n   * @returns {Promise}\n   * @public\n   * @memberof DSS\n   */\n  register() {\n    if (!this.webex.canAuthorize) {\n      this.logger.error('DSS->register#ERROR, Unable to register, SDK cannot authorize');\n\n      return Promise.reject(new Error('SDK cannot authorize'));\n    }\n\n    if (this.registered) {\n      this.logger.info('dss->register#INFO, DSS plugin already registered');\n\n      return Promise.resolve();\n    }\n\n    return this.webex.internal.mercury.connect()\n      .then(() => {\n        this.listenForEvents();\n        this.trigger(DSS_REGISTERED);\n        this.registered = true;\n      })\n      .catch((error) => {\n        this.logger.error(`DSS->register#ERROR, Unable to register, ${error.message}`);\n\n        return Promise.reject(error);\n      });\n  },\n\n  /**\n   * Explicitly tears down the DSS plugin by disconnecting from mercury, and stops listening to DSS events\n   * @returns {Promise}\n   * @public\n   * @memberof DSS\n   */\n  unregister() {\n    if (!this.registered) {\n      this.logger.info('DSS->unregister#INFO, DSS plugin already unregistered');\n\n      return Promise.resolve();\n    }\n\n    this.stopListeningForEvents();\n\n    return this.webex.internal.mercury.disconnect()\n      .then(() => {\n        this.trigger(DSS_UNREGISTERED);\n        this.registered = false;\n      });\n  },\n\n  /**\n   * registers for DSS events through mercury\n   * @returns {undefined}\n   * @private\n   */\n  listenForEvents() {\n    this.webex.internal.mercury.on(DSS_LOOKUP_MERCURY_EVENT, (envelope) => {\n      this._handleEvent(envelope.data);\n    });\n    this.webex.internal.mercury.on(DSS_SEARCH_MERCURY_EVENT, (envelope) => {\n      this._handleEvent(envelope.data);\n    });\n  },\n\n  /**\n   * unregisteres all the DSS events from mercury\n   * @returns {undefined}\n   * @private\n   */\n  stopListeningForEvents() {\n    this.webex.internal.mercury.off(DSS_LOOKUP_MERCURY_EVENT);\n    this.webex.internal.mercury.off(DSS_SEARCH_MERCURY_EVENT);\n  },\n\n  /**\n   * @param {UUID} requestId the id of the request\n   * @returns {string}\n   */\n  _getResultEventName(requestId) {\n    return `${DSS_RESULT}${requestId}`;\n  },\n\n  /**\n   * @param {Object} data the event data\n   * @returns {undefined}\n   */\n  _handleEvent(data) {\n    this.trigger(this._getResultEventName(data.requestId), data);\n    this.trigger(DSS_LOOKUP_RESULT, data);\n  },\n\n  /**\n    * Makes the request to the directory service\n    * @param {Object} options\n    * @param {string} options.resource the URL to query\n    * @param {string} options.params additional params for the body of the request\n    * @param {string} options.dataPath to path to get the data in the result object\n    * @returns {Promise} Resolves with an array of entities found\n  */\n  _request(options) {\n    const {resource, params, dataPath} = options;\n\n    const requestId = uuid.v4();\n    const eventName = this._getResultEventName(requestId);\n    const result = {};\n    let expectedSeqNums;\n\n    return new Promise((resolve) => {\n      this.listenTo(this, eventName, (data) => {\n        const resultData = get(data, dataPath);\n\n        result[data.sequence] = resultData;\n\n        if (data.finished) {\n          expectedSeqNums = range(data.sequence + 1).map(String);\n        }\n\n        const done = isEqual(expectedSeqNums, Object.keys(result));\n\n        if (done) {\n          const resultArray = [];\n          expectedSeqNums.forEach((index) => {\n            const seqResult = result[index];\n            if (seqResult) {\n              resultArray.push(...seqResult);\n            }\n          })\n\n          resolve(resultArray);\n          this.stopListening(this, eventName);\n        }\n      });\n      this.webex.request({\n        service: DSS_SERVICE_NAME,\n        resource,\n        method: 'POST',\n        contentType: 'application/json',\n        body: {requestId, ...params}\n      });\n    });\n  },\n\n  /**\n   * Retrieves detailed information about an entity\n   * @param {Object} options\n   * @param {UUID} options.id the id of the entity to lookup\n   * @returns {Promise} Resolves with an array of entities found\n   */\n  lookupDetail(options: LookupDetailOptions) {\n    const {id} = options;\n\n    return this._request({\n      dataPath: 'lookupResult.entities',\n      resource: `/lookup/orgid/${this.webex.internal.device.orgId}/identity/${id}/detail`\n    });\n  },\n\n  /**\n   * Retrieves basic information about a list entities within an organization\n   * @param {Object} options\n   * @param {UUID} options.ids the id of the entity to lookup\n   * @returns {Promise} Resolves with an array of entities found\n   */\n  lookup(options: LookupOptions) {\n    const {ids} = options;\n\n    return this._request({\n      dataPath: 'lookupResult.entities',\n      resource: `/lookup/orgid/${this.webex.internal.device.orgId}/identities`,\n      params: {\n        lookupValues: ids,\n      }\n    });\n  },\n\n  /**\n   * Retrieves basic information about a list entities within an organization\n   * @param {Object} options\n   * @param {UUID} options.emails the emails of the entities to lookup\n   * @returns {Promise} Resolves with an array of entities found\n   */\n  lookupByEmail(options: LookupByEmailOptions) {\n    const {emails} = options;\n\n    return this._request({\n      dataPath: 'lookupResult.entities',\n      resource: `/lookup/orgid/${this.webex.internal.device.orgId}/emails`,\n      params: {\n        lookupValues: emails,\n      }\n    });\n  },\n\n  /**\n   * Search for information about entities\n   * @param {Object} options\n   * @param {SearchType[]} options.requestedTypes an array of search types from: PERSON, CALLING_SERVICE, EXTERNAL_CALLING, ROOM, ROBOT\n   * @param {string[]} options.queryString A query string that will be transformed into a Directory search filter query. It is used to search the following fields: username, givenName, familyName, displayName and email\n   * @param {number} options.resultSize The maximum number of results returned from each provider\n   * @returns {Promise} Resolves with an array of entities found\n   */\n  search(options: SearchOptions) {\n    const {\n      requestedTypes, resultSize, queryString\n    } = options;\n\n    return this._request({\n      dataPath: 'directoryEntities',\n      resource: `/search/orgid/${this.webex.internal.device.orgId}/entities`,\n      params: {\n        queryString,\n        resultSize,\n        requestedTypes\n      }\n    });\n  }\n\n});\n\nexport default DSS;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA;;AACA;;AACA;;AAIA;;;;;;AAUA,IAAMA,GAAG,GAAGC,sBAAA,CAAYC,MAAZ,CAAmB;EAC7BC,SAAS,EAAE,KADkB;;EAG7B;AACF;AACA;AACA;AACA;AACA;EACEC,UAAU,EAAE,KATiB;;EAW7B;AACF;AACA;AACA;AACA;AACA;EACEC,QAjB6B,sBAiBlB;IAAA;;IACT,IAAI,CAAC,KAAKC,KAAL,CAAWC,YAAhB,EAA8B;MAC5B,KAAKC,MAAL,CAAYC,KAAZ,CAAkB,+DAAlB;MAEA,OAAO,iBAAQC,MAAR,CAAe,IAAIC,KAAJ,CAAU,sBAAV,CAAf,CAAP;IACD;;IAED,IAAI,KAAKP,UAAT,EAAqB;MACnB,KAAKI,MAAL,CAAYI,IAAZ,CAAiB,mDAAjB;MAEA,OAAO,iBAAQC,OAAR,EAAP;IACD;;IAED,OAAO,KAAKP,KAAL,CAAWQ,QAAX,CAAoBC,OAApB,CAA4BC,OAA5B,GACJC,IADI,CACC,YAAM;MACV,KAAI,CAACC,eAAL;;MACA,KAAI,CAACC,OAAL,CAAaC,yBAAb;;MACA,KAAI,CAAChB,UAAL,GAAkB,IAAlB;IACD,CALI,EAMJiB,KANI,CAME,UAACZ,KAAD,EAAW;MAChB,KAAI,CAACD,MAAL,CAAYC,KAAZ,oDAA8DA,KAAK,CAACa,OAApE;;MAEA,OAAO,iBAAQZ,MAAR,CAAeD,KAAf,CAAP;IACD,CAVI,CAAP;EAWD,CAzC4B;;EA2C7B;AACF;AACA;AACA;AACA;AACA;EACEc,UAjD6B,wBAiDhB;IAAA;;IACX,IAAI,CAAC,KAAKnB,UAAV,EAAsB;MACpB,KAAKI,MAAL,CAAYI,IAAZ,CAAiB,uDAAjB;MAEA,OAAO,iBAAQC,OAAR,EAAP;IACD;;IAED,KAAKW,sBAAL;IAEA,OAAO,KAAKlB,KAAL,CAAWQ,QAAX,CAAoBC,OAApB,CAA4BU,UAA5B,GACJR,IADI,CACC,YAAM;MACV,MAAI,CAACE,OAAL,CAAaO,2BAAb;;MACA,MAAI,CAACtB,UAAL,GAAkB,KAAlB;IACD,CAJI,CAAP;EAKD,CA/D4B;;EAiE7B;AACF;AACA;AACA;AACA;EACEc,eAtE6B,6BAsEX;IAAA;;IAChB,KAAKZ,KAAL,CAAWQ,QAAX,CAAoBC,OAApB,CAA4BY,EAA5B,CAA+BC,mCAA/B,EAAyD,UAACC,QAAD,EAAc;MACrE,MAAI,CAACC,YAAL,CAAkBD,QAAQ,CAACE,IAA3B;IACD,CAFD;IAGA,KAAKzB,KAAL,CAAWQ,QAAX,CAAoBC,OAApB,CAA4BY,EAA5B,CAA+BK,mCAA/B,EAAyD,UAACH,QAAD,EAAc;MACrE,MAAI,CAACC,YAAL,CAAkBD,QAAQ,CAACE,IAA3B;IACD,CAFD;EAGD,CA7E4B;;EA+E7B;AACF;AACA;AACA;AACA;EACEP,sBApF6B,oCAoFJ;IACvB,KAAKlB,KAAL,CAAWQ,QAAX,CAAoBC,OAApB,CAA4BkB,GAA5B,CAAgCL,mCAAhC;IACA,KAAKtB,KAAL,CAAWQ,QAAX,CAAoBC,OAApB,CAA4BkB,GAA5B,CAAgCD,mCAAhC;EACD,CAvF4B;;EAyF7B;AACF;AACA;AACA;EACEE,mBA7F6B,+BA6FTC,SA7FS,EA6FE;IAC7B,iBAAUC,qBAAV,SAAuBD,SAAvB;EACD,CA/F4B;;EAiG7B;AACF;AACA;AACA;EACEL,YArG6B,wBAqGhBC,IArGgB,EAqGV;IACjB,KAAKZ,OAAL,CAAa,KAAKe,mBAAL,CAAyBH,IAAI,CAACI,SAA9B,CAAb,EAAuDJ,IAAvD;IACA,KAAKZ,OAAL,CAAakB,4BAAb,EAAgCN,IAAhC;EACD,CAxG4B;;EA0G7B;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEO,QAlH6B,oBAkHpBC,OAlHoB,EAkHX;IAAA;;IAChB,IAAOC,QAAP,GAAqCD,OAArC,CAAOC,QAAP;IAAA,IAAiBC,MAAjB,GAAqCF,OAArC,CAAiBE,MAAjB;IAAA,IAAyBC,QAAzB,GAAqCH,OAArC,CAAyBG,QAAzB;;IAEA,IAAMP,SAAS,GAAGQ,aAAA,CAAKC,EAAL,EAAlB;;IACA,IAAMC,SAAS,GAAG,KAAKX,mBAAL,CAAyBC,SAAzB,CAAlB;;IACA,IAAMW,MAAM,GAAG,EAAf;IACA,IAAIC,eAAJ;IAEA,OAAO,qBAAY,UAAClC,OAAD,EAAa;MAC9B,MAAI,CAACmC,QAAL,CAAc,MAAd,EAAoBH,SAApB,EAA+B,UAACd,IAAD,EAAU;QACvC,IAAMkB,UAAU,GAAG,mBAAIlB,IAAJ,EAAUW,QAAV,CAAnB;QAEAI,MAAM,CAACf,IAAI,CAACmB,QAAN,CAAN,GAAwBD,UAAxB;;QAEA,IAAIlB,IAAI,CAACoB,QAAT,EAAmB;UACjBJ,eAAe,GAAG,qBAAMhB,IAAI,CAACmB,QAAL,GAAgB,CAAtB,EAAyBE,GAAzB,CAA6BC,MAA7B,CAAlB;QACD;;QAED,IAAMC,IAAI,GAAG,uBAAQP,eAAR,EAAyB,mBAAYD,MAAZ,CAAzB,CAAb;;QAEA,IAAIQ,IAAJ,EAAU;UACR,IAAMC,WAAW,GAAG,EAApB;UACAR,eAAe,CAACS,OAAhB,CAAwB,UAACC,KAAD,EAAW;YACjC,IAAMC,SAAS,GAAGZ,MAAM,CAACW,KAAD,CAAxB;;YACA,IAAIC,SAAJ,EAAe;cACbH,WAAW,CAACI,IAAZ,OAAAJ,WAAW,mCAASG,SAAT,EAAX;YACD;UACF,CALD;UAOA7C,OAAO,CAAC0C,WAAD,CAAP;;UACA,MAAI,CAACK,aAAL,CAAmB,MAAnB,EAAyBf,SAAzB;QACD;MACF,CAvBD;;MAwBA,MAAI,CAACvC,KAAL,CAAWuD,OAAX,CAAmB;QACjBC,OAAO,EAAEC,2BADQ;QAEjBvB,QAAQ,EAARA,QAFiB;QAGjBwB,MAAM,EAAE,MAHS;QAIjBC,WAAW,EAAE,kBAJI;QAKjBC,IAAI;UAAG/B,SAAS,EAATA;QAAH,GAAiBM,MAAjB;MALa,CAAnB;IAOD,CAhCM,CAAP;EAiCD,CA3J4B;;EA6J7B;AACF;AACA;AACA;AACA;AACA;EACE0B,YAnK6B,wBAmKhB5B,OAnKgB,EAmKc;IACzC,IAAO6B,EAAP,GAAa7B,OAAb,CAAO6B,EAAP;IAEA,OAAO,KAAK9B,QAAL,CAAc;MACnBI,QAAQ,EAAE,uBADS;MAEnBF,QAAQ,0BAAmB,KAAKlC,KAAL,CAAWQ,QAAX,CAAoBuD,MAApB,CAA2BC,KAA9C,uBAAgEF,EAAhE;IAFW,CAAd,CAAP;EAID,CA1K4B;;EA4K7B;AACF;AACA;AACA;AACA;AACA;EACEG,MAlL6B,kBAkLtBhC,OAlLsB,EAkLE;IAC7B,IAAOiC,GAAP,GAAcjC,OAAd,CAAOiC,GAAP;IAEA,OAAO,KAAKlC,QAAL,CAAc;MACnBI,QAAQ,EAAE,uBADS;MAEnBF,QAAQ,0BAAmB,KAAKlC,KAAL,CAAWQ,QAAX,CAAoBuD,MAApB,CAA2BC,KAA9C,gBAFW;MAGnB7B,MAAM,EAAE;QACNgC,YAAY,EAAED;MADR;IAHW,CAAd,CAAP;EAOD,CA5L4B;;EA8L7B;AACF;AACA;AACA;AACA;AACA;EACEE,aApM6B,yBAoMfnC,OApMe,EAoMgB;IAC3C,IAAOoC,MAAP,GAAiBpC,OAAjB,CAAOoC,MAAP;IAEA,OAAO,KAAKrC,QAAL,CAAc;MACnBI,QAAQ,EAAE,uBADS;MAEnBF,QAAQ,0BAAmB,KAAKlC,KAAL,CAAWQ,QAAX,CAAoBuD,MAApB,CAA2BC,KAA9C,YAFW;MAGnB7B,MAAM,EAAE;QACNgC,YAAY,EAAEE;MADR;IAHW,CAAd,CAAP;EAOD,CA9M4B;;EAgN7B;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEC,MAxN6B,kBAwNtBrC,OAxNsB,EAwNE;IAC7B,IACEsC,cADF,GAEItC,OAFJ,CACEsC,cADF;IAAA,IACkBC,UADlB,GAEIvC,OAFJ,CACkBuC,UADlB;IAAA,IAC8BC,WAD9B,GAEIxC,OAFJ,CAC8BwC,WAD9B;IAIA,OAAO,KAAKzC,QAAL,CAAc;MACnBI,QAAQ,EAAE,mBADS;MAEnBF,QAAQ,0BAAmB,KAAKlC,KAAL,CAAWQ,QAAX,CAAoBuD,MAApB,CAA2BC,KAA9C,cAFW;MAGnB7B,MAAM,EAAE;QACNsC,WAAW,EAAXA,WADM;QAEND,UAAU,EAAVA,UAFM;QAGND,cAAc,EAAdA;MAHM;IAHW,CAAd,CAAP;EASD,CAtO4B;EAAA;AAAA,CAAnB,CAAZ;;eA0Oe7E,G"}
+{"version":3,"names":["DSS","WebexPlugin","extend","namespace","registered","register","webex","canAuthorize","logger","error","reject","Error","info","resolve","internal","mercury","connect","then","listenForEvents","trigger","DSS_REGISTERED","catch","message","unregister","stopListeningForEvents","disconnect","DSS_UNREGISTERED","on","DSS_LOOKUP_MERCURY_EVENT","envelope","_handleEvent","data","DSS_SEARCH_MERCURY_EVENT","off","_getResultEventName","requestId","DSS_RESULT","DSS_LOOKUP_RESULT","_request","options","resource","params","dataPath","uuid","v4","eventName","result","expectedSeqNums","listenTo","resultData","sequence","finished","map","String","done","resultArray","forEach","index","seqResult","push","stopListening","request","service","DSS_SERVICE_NAME","method","contentType","body","lookupDetail","id","device","orgId","lookup","ids","entityProviderType","lookupValues","lookupByEmail","emails","search","requestedTypes","resultSize","queryString"],"sources":["dss.ts"],"sourcesContent":["/* eslint-disable no-underscore-dangle */\n/*!\n * Copyright (c) 2015-2022 Cisco Systems, Inc. See LICENSE file.\n */\nimport uuid from 'uuid';\nimport {WebexPlugin} from '@webex/webex-core';\nimport '@webex/internal-plugin-mercury';\nimport {range, isEqual, get} from 'lodash';\nimport type {SearchOptions, LookupDetailOptions, LookupOptions, LookupByEmailOptions} from './types';\n\nimport {\n  DSS_REGISTERED,\n  DSS_UNREGISTERED,\n  DSS_LOOKUP_MERCURY_EVENT,\n  DSS_LOOKUP_RESULT,\n  DSS_SERVICE_NAME,\n  DSS_SEARCH_MERCURY_EVENT,\n  DSS_RESULT,\n} from './constants';\n\nconst DSS = WebexPlugin.extend({\n  namespace: 'DSS',\n\n  /**\n   * registered value indicating events registration is successful\n   * @instance\n   * @type {Boolean}\n   * @memberof DSS\n   */\n  registered: false,\n\n  /**\n   * Explicitly sets up the DSS plugin by connecting to mercury, and listening for DSS events.\n   * @returns {Promise}\n   * @public\n   * @memberof DSS\n   */\n  register() {\n    if (!this.webex.canAuthorize) {\n      this.logger.error('DSS->register#ERROR, Unable to register, SDK cannot authorize');\n\n      return Promise.reject(new Error('SDK cannot authorize'));\n    }\n\n    if (this.registered) {\n      this.logger.info('dss->register#INFO, DSS plugin already registered');\n\n      return Promise.resolve();\n    }\n\n    return this.webex.internal.mercury.connect()\n      .then(() => {\n        this.listenForEvents();\n        this.trigger(DSS_REGISTERED);\n        this.registered = true;\n      })\n      .catch((error) => {\n        this.logger.error(`DSS->register#ERROR, Unable to register, ${error.message}`);\n\n        return Promise.reject(error);\n      });\n  },\n\n  /**\n   * Explicitly tears down the DSS plugin by disconnecting from mercury, and stops listening to DSS events\n   * @returns {Promise}\n   * @public\n   * @memberof DSS\n   */\n  unregister() {\n    if (!this.registered) {\n      this.logger.info('DSS->unregister#INFO, DSS plugin already unregistered');\n\n      return Promise.resolve();\n    }\n\n    this.stopListeningForEvents();\n\n    return this.webex.internal.mercury.disconnect()\n      .then(() => {\n        this.trigger(DSS_UNREGISTERED);\n        this.registered = false;\n      });\n  },\n\n  /**\n   * registers for DSS events through mercury\n   * @returns {undefined}\n   * @private\n   */\n  listenForEvents() {\n    this.webex.internal.mercury.on(DSS_LOOKUP_MERCURY_EVENT, (envelope) => {\n      this._handleEvent(envelope.data);\n    });\n    this.webex.internal.mercury.on(DSS_SEARCH_MERCURY_EVENT, (envelope) => {\n      this._handleEvent(envelope.data);\n    });\n  },\n\n  /**\n   * unregisteres all the DSS events from mercury\n   * @returns {undefined}\n   * @private\n   */\n  stopListeningForEvents() {\n    this.webex.internal.mercury.off(DSS_LOOKUP_MERCURY_EVENT);\n    this.webex.internal.mercury.off(DSS_SEARCH_MERCURY_EVENT);\n  },\n\n  /**\n   * @param {UUID} requestId the id of the request\n   * @returns {string}\n   */\n  _getResultEventName(requestId) {\n    return `${DSS_RESULT}${requestId}`;\n  },\n\n  /**\n   * @param {Object} data the event data\n   * @returns {undefined}\n   */\n  _handleEvent(data) {\n    this.trigger(this._getResultEventName(data.requestId), data);\n    this.trigger(DSS_LOOKUP_RESULT, data);\n  },\n\n  /**\n    * Makes the request to the directory service\n    * @param {Object} options\n    * @param {string} options.resource the URL to query\n    * @param {string} options.params additional params for the body of the request\n    * @param {string} options.dataPath to path to get the data in the result object\n    * @returns {Promise} Resolves with an array of entities found\n  */\n  _request(options) {\n    const {resource, params, dataPath} = options;\n\n    const requestId = uuid.v4();\n    const eventName = this._getResultEventName(requestId);\n    const result = {};\n    let expectedSeqNums;\n\n    return new Promise((resolve) => {\n      this.listenTo(this, eventName, (data) => {\n        const resultData = get(data, dataPath);\n\n        result[data.sequence] = resultData;\n\n        if (data.finished) {\n          expectedSeqNums = range(data.sequence + 1).map(String);\n        }\n\n        const done = isEqual(expectedSeqNums, Object.keys(result));\n\n        if (done) {\n          const resultArray = [];\n          expectedSeqNums.forEach((index) => {\n            const seqResult = result[index];\n            if (seqResult) {\n              resultArray.push(...seqResult);\n            }\n          })\n\n          resolve(resultArray);\n          this.stopListening(this, eventName);\n        }\n      });\n      this.webex.request({\n        service: DSS_SERVICE_NAME,\n        resource,\n        method: 'POST',\n        contentType: 'application/json',\n        body: {requestId, ...params}\n      });\n    });\n  },\n\n  /**\n   * Retrieves detailed information about an entity\n   * @param {Object} options\n   * @param {UUID} options.id the id of the entity to lookup\n   * @returns {Promise} Resolves with an array of entities found\n   */\n  lookupDetail(options: LookupDetailOptions) {\n    const {id} = options;\n\n    return this._request({\n      dataPath: 'lookupResult.entities',\n      resource: `/lookup/orgid/${this.webex.internal.device.orgId}/identity/${id}/detail`\n    });\n  },\n\n  /**\n   * Retrieves basic information about a list entities within an organization\n   * @param {Object} options\n   * @param {UUID} options.ids the id of the entity to lookup\n   * @param {UUID} options.entityProviderType the provider to query (optional)\n   * @returns {Promise} Resolves with an array of entities found\n   */\n  lookup(options: LookupOptions) {\n    const {ids, entityProviderType} = options;\n\n    const resource = entityProviderType ? `/lookup/orgid/${this.webex.internal.device.orgId}/entityprovidertype/${entityProviderType}` : `/lookup/orgid/${this.webex.internal.device.orgId}/identities`;\n\n    return this._request({\n      dataPath: 'lookupResult.entities',\n      resource,\n      params: {\n        lookupValues: ids,\n      }\n    });\n  },\n\n  /**\n   * Retrieves basic information about a list entities within an organization\n   * @param {Object} options\n   * @param {UUID} options.emails the emails of the entities to lookup\n   * @returns {Promise} Resolves with an array of entities found\n   */\n  lookupByEmail(options: LookupByEmailOptions) {\n    const {emails} = options;\n\n    return this._request({\n      dataPath: 'lookupResult.entities',\n      resource: `/lookup/orgid/${this.webex.internal.device.orgId}/emails`,\n      params: {\n        lookupValues: emails,\n      }\n    });\n  },\n\n  /**\n   * Search for information about entities\n   * @param {Object} options\n   * @param {SearchType[]} options.requestedTypes an array of search types from: PERSON, CALLING_SERVICE, EXTERNAL_CALLING, ROOM, ROBOT\n   * @param {string[]} options.queryString A query string that will be transformed into a Directory search filter query. It is used to search the following fields: username, givenName, familyName, displayName and email\n   * @param {number} options.resultSize The maximum number of results returned from each provider\n   * @returns {Promise} Resolves with an array of entities found\n   */\n  search(options: SearchOptions) {\n    const {\n      requestedTypes, resultSize, queryString\n    } = options;\n\n    return this._request({\n      dataPath: 'directoryEntities',\n      resource: `/search/orgid/${this.webex.internal.device.orgId}/entities`,\n      params: {\n        queryString,\n        resultSize,\n        requestedTypes\n      }\n    });\n  }\n\n});\n\nexport default DSS;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA;;AACA;;AACA;;AAIA;;;;;;AAUA,IAAMA,GAAG,GAAGC,sBAAA,CAAYC,MAAZ,CAAmB;EAC7BC,SAAS,EAAE,KADkB;;EAG7B;AACF;AACA;AACA;AACA;AACA;EACEC,UAAU,EAAE,KATiB;;EAW7B;AACF;AACA;AACA;AACA;AACA;EACEC,QAjB6B,sBAiBlB;IAAA;;IACT,IAAI,CAAC,KAAKC,KAAL,CAAWC,YAAhB,EAA8B;MAC5B,KAAKC,MAAL,CAAYC,KAAZ,CAAkB,+DAAlB;MAEA,OAAO,iBAAQC,MAAR,CAAe,IAAIC,KAAJ,CAAU,sBAAV,CAAf,CAAP;IACD;;IAED,IAAI,KAAKP,UAAT,EAAqB;MACnB,KAAKI,MAAL,CAAYI,IAAZ,CAAiB,mDAAjB;MAEA,OAAO,iBAAQC,OAAR,EAAP;IACD;;IAED,OAAO,KAAKP,KAAL,CAAWQ,QAAX,CAAoBC,OAApB,CAA4BC,OAA5B,GACJC,IADI,CACC,YAAM;MACV,KAAI,CAACC,eAAL;;MACA,KAAI,CAACC,OAAL,CAAaC,yBAAb;;MACA,KAAI,CAAChB,UAAL,GAAkB,IAAlB;IACD,CALI,EAMJiB,KANI,CAME,UAACZ,KAAD,EAAW;MAChB,KAAI,CAACD,MAAL,CAAYC,KAAZ,oDAA8DA,KAAK,CAACa,OAApE;;MAEA,OAAO,iBAAQZ,MAAR,CAAeD,KAAf,CAAP;IACD,CAVI,CAAP;EAWD,CAzC4B;;EA2C7B;AACF;AACA;AACA;AACA;AACA;EACEc,UAjD6B,wBAiDhB;IAAA;;IACX,IAAI,CAAC,KAAKnB,UAAV,EAAsB;MACpB,KAAKI,MAAL,CAAYI,IAAZ,CAAiB,uDAAjB;MAEA,OAAO,iBAAQC,OAAR,EAAP;IACD;;IAED,KAAKW,sBAAL;IAEA,OAAO,KAAKlB,KAAL,CAAWQ,QAAX,CAAoBC,OAApB,CAA4BU,UAA5B,GACJR,IADI,CACC,YAAM;MACV,MAAI,CAACE,OAAL,CAAaO,2BAAb;;MACA,MAAI,CAACtB,UAAL,GAAkB,KAAlB;IACD,CAJI,CAAP;EAKD,CA/D4B;;EAiE7B;AACF;AACA;AACA;AACA;EACEc,eAtE6B,6BAsEX;IAAA;;IAChB,KAAKZ,KAAL,CAAWQ,QAAX,CAAoBC,OAApB,CAA4BY,EAA5B,CAA+BC,mCAA/B,EAAyD,UAACC,QAAD,EAAc;MACrE,MAAI,CAACC,YAAL,CAAkBD,QAAQ,CAACE,IAA3B;IACD,CAFD;IAGA,KAAKzB,KAAL,CAAWQ,QAAX,CAAoBC,OAApB,CAA4BY,EAA5B,CAA+BK,mCAA/B,EAAyD,UAACH,QAAD,EAAc;MACrE,MAAI,CAACC,YAAL,CAAkBD,QAAQ,CAACE,IAA3B;IACD,CAFD;EAGD,CA7E4B;;EA+E7B;AACF;AACA;AACA;AACA;EACEP,sBApF6B,oCAoFJ;IACvB,KAAKlB,KAAL,CAAWQ,QAAX,CAAoBC,OAApB,CAA4BkB,GAA5B,CAAgCL,mCAAhC;IACA,KAAKtB,KAAL,CAAWQ,QAAX,CAAoBC,OAApB,CAA4BkB,GAA5B,CAAgCD,mCAAhC;EACD,CAvF4B;;EAyF7B;AACF;AACA;AACA;EACEE,mBA7F6B,+BA6FTC,SA7FS,EA6FE;IAC7B,iBAAUC,qBAAV,SAAuBD,SAAvB;EACD,CA/F4B;;EAiG7B;AACF;AACA;AACA;EACEL,YArG6B,wBAqGhBC,IArGgB,EAqGV;IACjB,KAAKZ,OAAL,CAAa,KAAKe,mBAAL,CAAyBH,IAAI,CAACI,SAA9B,CAAb,EAAuDJ,IAAvD;IACA,KAAKZ,OAAL,CAAakB,4BAAb,EAAgCN,IAAhC;EACD,CAxG4B;;EA0G7B;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEO,QAlH6B,oBAkHpBC,OAlHoB,EAkHX;IAAA;;IAChB,IAAOC,QAAP,GAAqCD,OAArC,CAAOC,QAAP;IAAA,IAAiBC,MAAjB,GAAqCF,OAArC,CAAiBE,MAAjB;IAAA,IAAyBC,QAAzB,GAAqCH,OAArC,CAAyBG,QAAzB;;IAEA,IAAMP,SAAS,GAAGQ,aAAA,CAAKC,EAAL,EAAlB;;IACA,IAAMC,SAAS,GAAG,KAAKX,mBAAL,CAAyBC,SAAzB,CAAlB;;IACA,IAAMW,MAAM,GAAG,EAAf;IACA,IAAIC,eAAJ;IAEA,OAAO,qBAAY,UAAClC,OAAD,EAAa;MAC9B,MAAI,CAACmC,QAAL,CAAc,MAAd,EAAoBH,SAApB,EAA+B,UAACd,IAAD,EAAU;QACvC,IAAMkB,UAAU,GAAG,mBAAIlB,IAAJ,EAAUW,QAAV,CAAnB;QAEAI,MAAM,CAACf,IAAI,CAACmB,QAAN,CAAN,GAAwBD,UAAxB;;QAEA,IAAIlB,IAAI,CAACoB,QAAT,EAAmB;UACjBJ,eAAe,GAAG,qBAAMhB,IAAI,CAACmB,QAAL,GAAgB,CAAtB,EAAyBE,GAAzB,CAA6BC,MAA7B,CAAlB;QACD;;QAED,IAAMC,IAAI,GAAG,uBAAQP,eAAR,EAAyB,mBAAYD,MAAZ,CAAzB,CAAb;;QAEA,IAAIQ,IAAJ,EAAU;UACR,IAAMC,WAAW,GAAG,EAApB;UACAR,eAAe,CAACS,OAAhB,CAAwB,UAACC,KAAD,EAAW;YACjC,IAAMC,SAAS,GAAGZ,MAAM,CAACW,KAAD,CAAxB;;YACA,IAAIC,SAAJ,EAAe;cACbH,WAAW,CAACI,IAAZ,OAAAJ,WAAW,mCAASG,SAAT,EAAX;YACD;UACF,CALD;UAOA7C,OAAO,CAAC0C,WAAD,CAAP;;UACA,MAAI,CAACK,aAAL,CAAmB,MAAnB,EAAyBf,SAAzB;QACD;MACF,CAvBD;;MAwBA,MAAI,CAACvC,KAAL,CAAWuD,OAAX,CAAmB;QACjBC,OAAO,EAAEC,2BADQ;QAEjBvB,QAAQ,EAARA,QAFiB;QAGjBwB,MAAM,EAAE,MAHS;QAIjBC,WAAW,EAAE,kBAJI;QAKjBC,IAAI;UAAG/B,SAAS,EAATA;QAAH,GAAiBM,MAAjB;MALa,CAAnB;IAOD,CAhCM,CAAP;EAiCD,CA3J4B;;EA6J7B;AACF;AACA;AACA;AACA;AACA;EACE0B,YAnK6B,wBAmKhB5B,OAnKgB,EAmKc;IACzC,IAAO6B,EAAP,GAAa7B,OAAb,CAAO6B,EAAP;IAEA,OAAO,KAAK9B,QAAL,CAAc;MACnBI,QAAQ,EAAE,uBADS;MAEnBF,QAAQ,0BAAmB,KAAKlC,KAAL,CAAWQ,QAAX,CAAoBuD,MAApB,CAA2BC,KAA9C,uBAAgEF,EAAhE;IAFW,CAAd,CAAP;EAID,CA1K4B;;EA4K7B;AACF;AACA;AACA;AACA;AACA;AACA;EACEG,MAnL6B,kBAmLtBhC,OAnLsB,EAmLE;IAC7B,IAAOiC,GAAP,GAAkCjC,OAAlC,CAAOiC,GAAP;IAAA,IAAYC,kBAAZ,GAAkClC,OAAlC,CAAYkC,kBAAZ;IAEA,IAAMjC,QAAQ,GAAGiC,kBAAkB,2BAAoB,KAAKnE,KAAL,CAAWQ,QAAX,CAAoBuD,MAApB,CAA2BC,KAA/C,iCAA2EG,kBAA3E,4BAAmH,KAAKnE,KAAL,CAAWQ,QAAX,CAAoBuD,MAApB,CAA2BC,KAA9I,gBAAnC;IAEA,OAAO,KAAKhC,QAAL,CAAc;MACnBI,QAAQ,EAAE,uBADS;MAEnBF,QAAQ,EAARA,QAFmB;MAGnBC,MAAM,EAAE;QACNiC,YAAY,EAAEF;MADR;IAHW,CAAd,CAAP;EAOD,CA/L4B;;EAiM7B;AACF;AACA;AACA;AACA;AACA;EACEG,aAvM6B,yBAuMfpC,OAvMe,EAuMgB;IAC3C,IAAOqC,MAAP,GAAiBrC,OAAjB,CAAOqC,MAAP;IAEA,OAAO,KAAKtC,QAAL,CAAc;MACnBI,QAAQ,EAAE,uBADS;MAEnBF,QAAQ,0BAAmB,KAAKlC,KAAL,CAAWQ,QAAX,CAAoBuD,MAApB,CAA2BC,KAA9C,YAFW;MAGnB7B,MAAM,EAAE;QACNiC,YAAY,EAAEE;MADR;IAHW,CAAd,CAAP;EAOD,CAjN4B;;EAmN7B;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEC,MA3N6B,kBA2NtBtC,OA3NsB,EA2NE;IAC7B,IACEuC,cADF,GAEIvC,OAFJ,CACEuC,cADF;IAAA,IACkBC,UADlB,GAEIxC,OAFJ,CACkBwC,UADlB;IAAA,IAC8BC,WAD9B,GAEIzC,OAFJ,CAC8ByC,WAD9B;IAIA,OAAO,KAAK1C,QAAL,CAAc;MACnBI,QAAQ,EAAE,mBADS;MAEnBF,QAAQ,0BAAmB,KAAKlC,KAAL,CAAWQ,QAAX,CAAoBuD,MAApB,CAA2BC,KAA9C,cAFW;MAGnB7B,MAAM,EAAE;QACNuC,WAAW,EAAXA,WADM;QAEND,UAAU,EAAVA,UAFM;QAGND,cAAc,EAAdA;MAHM;IAHW,CAAd,CAAP;EASD,CAzO4B;EAAA;AAAA,CAAnB,CAAZ;;eA6Oe9E,G"}

package/dist/types.js

@@ -6,7 +6,17 @@ _Object$defineProperty(exports, "__esModule", {
   value: true
 });
 
-exports.SearchType = void 0;
+exports.SearchType = exports.EntityProviderType = void 0;
+var EntityProviderType;
+exports.EntityProviderType = EntityProviderType;
+
+(function (EntityProviderType) {
+  EntityProviderType["CI_USER"] = "CI_USER";
+  EntityProviderType["CI_MACHINE"] = "CI_MACHINE";
+  EntityProviderType["CONTACTS"] = "CONTACTS";
+  EntityProviderType["CSDM"] = "CSDM";
+})(EntityProviderType || (exports.EntityProviderType = EntityProviderType = {}));
+
 var SearchType;
 exports.SearchType = SearchType;
 

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"names":["SearchType"],"sources":["types.ts"],"sourcesContent":["export interface LookupDetailOptions {\n  id: string;\n}\n\nexport interface LookupOptions {\n  ids: string[];\n}\n\nexport interface LookupByEmailOptions {\n  emails: string[];\n}\n\nexport enum SearchType {\n  PERSON = 'PERSON', \n  CALLING_SERVICE = 'CALLING_SERVICE',\n  EXTERNAL_CALLING = 'EXTERNAL_CALLING',\n  ROOM = 'ROOM',\n  ROBOT = 'ROBOT'\n}\n\nexport interface SearchOptions {\n  requestedTypes: SearchType[],\n  resultSize: number,\n  queryString: string,\n}\n"],"mappings":";;;;;;;;;IAYYA,U;;;WAAAA,U;EAAAA,U;EAAAA,U;EAAAA,U;EAAAA,U;EAAAA,U;GAAAA,U,0BAAAA,U"}
+{"version":3,"names":["EntityProviderType","SearchType"],"sources":["types.ts"],"sourcesContent":["export interface LookupDetailOptions {\n  id: string;\n}\n\nexport enum EntityProviderType {\n  CI_USER = 'CI_USER',\n  CI_MACHINE ='CI_MACHINE',\n  CONTACTS = 'CONTACTS',\n  CSDM = 'CSDM'\n}\n\nexport interface LookupOptions {\n  ids: string[];\n  entityProviderType?: EntityProviderType;\n}\n\nexport interface LookupByEmailOptions {\n  emails: string[];\n}\n\nexport enum SearchType {\n  PERSON = 'PERSON', \n  CALLING_SERVICE = 'CALLING_SERVICE',\n  EXTERNAL_CALLING = 'EXTERNAL_CALLING',\n  ROOM = 'ROOM',\n  ROBOT = 'ROBOT'\n}\n\nexport interface SearchOptions {\n  requestedTypes: SearchType[],\n  resultSize: number,\n  queryString: string,\n}\n"],"mappings":";;;;;;;;;IAIYA,kB;;;WAAAA,kB;EAAAA,kB;EAAAA,kB;EAAAA,kB;EAAAA,kB;GAAAA,kB,kCAAAA,kB;;IAgBAC,U;;;WAAAA,U;EAAAA,U;EAAAA,U;EAAAA,U;EAAAA,U;EAAAA,U;GAAAA,U,0BAAAA,U"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/internal-plugin-dss",
-  "version": "2.26.1",
+  "version": "2.27.0",
   "description": "",
   "license": "MIT",
   "author": "Colin Read <coread@cisco.com>",
@@ -17,10 +17,10 @@
   },
   "dependencies": {
     "@babel/runtime-corejs2": "^7.14.8",
-    "@webex/webex-core": "2.26.1",
+    "@webex/webex-core": "2.27.0",
     "lodash": "^4.17.21",
     "uuid": "^3.3.2",
-    "@webex/internal-plugin-mercury": "2.26.1",
+    "@webex/internal-plugin-mercury": "2.27.0",
     "envify": "^4.1.0"
   }
 }

package/src/dss.ts

@@ -194,14 +194,17 @@ const DSS = WebexPlugin.extend({
    * Retrieves basic information about a list entities within an organization
    * @param {Object} options
    * @param {UUID} options.ids the id of the entity to lookup
+   * @param {UUID} options.entityProviderType the provider to query (optional)
    * @returns {Promise} Resolves with an array of entities found
    */
   lookup(options: LookupOptions) {
-    const {ids} = options;
+    const {ids, entityProviderType} = options;
+
+    const resource = entityProviderType ? `/lookup/orgid/${this.webex.internal.device.orgId}/entityprovidertype/${entityProviderType}` : `/lookup/orgid/${this.webex.internal.device.orgId}/identities`;
 
     return this._request({
       dataPath: 'lookupResult.entities',
-      resource: `/lookup/orgid/${this.webex.internal.device.orgId}/identities`,
+      resource,
       params: {
         lookupValues: ids,
       }

package/src/types.ts

@@ -2,8 +2,16 @@ export interface LookupDetailOptions {
   id: string;
 }
 
+export enum EntityProviderType {
+  CI_USER = 'CI_USER',
+  CI_MACHINE ='CI_MACHINE',
+  CONTACTS = 'CONTACTS',
+  CSDM = 'CSDM'
+}
+
 export interface LookupOptions {
   ids: string[];
+  entityProviderType?: EntityProviderType;
 }
 
 export interface LookupByEmailOptions {

package/test/unit/spec/dss.ts

@@ -195,6 +195,25 @@ describe("plugin-dss", () => {
         expect(result).to.equal("some return value");
       });
 
+      it("calls _request correctly with entityProviderType", async () => {
+        webex.internal.device.orgId = "userOrgId";
+        webex.internal.dss._request = sinon
+          .stub()
+          .returns(Promise.resolve("some return value"));
+
+        const result = await webex.internal.dss.lookup({ ids: ["id1", "id2"], entityProviderType: 'CI_USER' });
+        expect(webex.internal.dss._request.getCall(0).args).to.deep.equal([
+          {
+            dataPath: "lookupResult.entities",
+            resource: '/lookup/orgid/userOrgId/entityprovidertype/CI_USER',
+            params: {
+              lookupValues: ["id1", "id2"],
+            },
+          },
+        ]);
+        expect(result).to.equal("some return value");
+      });
+
       it("works correctly", async () => {
         await testRequest({
           method: "lookup",